De locatiecode ophalen uit gebeurtenissen met de nShift ShipmentData API – nShift Help Center

Dit artikel legt uit hoe u een locatiecode (bijvoorbeeld terminal- of sitecode zoals 9010 of 0705) kunt ophalen uit zendinggebeurtenissen bij het werken met de ShipmentData API. Het richt zich op het identificeren waar de gegevens zich bevinden in de respons en hoe deze te interpreteren.

Authenticatievereisten

Voordat u de ShipmentData API aanroept, heeft u een toegangstoken nodig:

Auth URL: https://account.nshiftportal.com/idp/connect/token
Grant type: client_credentials
Scope: public_api_portal_shipment_data

Zodra u uw client_id en client_secret heeft ingewisseld voor een token, gebruikt u dat token in de Authorization: Bearer header voor uw API-aanroepen.

Stap 1: Verkrijg een toegangstoken

Gebruik cURL om uw toegangstoken te verkrijgen:

curl -X POST 'https://account.nshiftportal.com/idp/connect/token'   
   -H 'Content-Type: application/x-www-form-urlencoded'   
   -d 'grant_type=client_credentials'   
   -d 'client_id=<YOUR_CLIENT_ID>'   
   -d 'client_secret=<YOUR_CLIENT_SECRET>'

Voorbeeldrespons:

{
  "access_token": "<JWT>",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": "public_api_portal_shipment_data"
}

Stap 2: Vraag zendinggegevens op via barcode

Om gebeurtenissen op te halen die locatiecodes kunnen bevatten, gebruikt u de Aggregated-by-Barcode endpoint.

curl -X POST 'https://api.nshiftportal.com/track/shipmentdata/Operational/Shipments/Aggregated/ByBarcode'   
-H "Authorization: Bearer <ACCESS_TOKEN>"   
-H "Content-Type: application/json"   
-d '{
    "query": "<BARCODE>",
    "startDate": "2025-08-24T00:00:00Z",
    "endDate": "2025-08-26T23:59:59Z",
    "pageSize": 20,
    "pageIndex": 0,
    "installationTags": [],
    "actorTags": [],
    "carrierTags": [],
    "dateRangeSource": 1
}'

De respons bevat informatie op zending- en pakketniveau, inclusief gebeurtenissen.

Waar de locatiecode verschijnt

Het location veld is opgenomen in sommige gebeurtenissen op pakketniveau. Het vertegenwoordigt meestal een interne site- of terminalcode van een vervoerder.

Gebeurtenissen op pakketniveau: shipment.lines[].packages[].events[].location (voorkeur)

Wanneer aanwezig, verschijnt location samen met:

cityName
postalCode
country
Optioneel, coordinates met breedte- en lengtegraad

Voorbeeld: fragment van respons

Hieronder een vereenvoudigd voorbeeld van een respons die een pakketgebeurtenis met een locatiecode toont:

[
  {
    "shipment": {
      "lines": [
        {
          "packages": [
            {
              "number": "00073123400271295954",
              "events": [
                {
                  "uuid": "b4e5a99b-0aee-41a2-11dd-b1e539a1a4d1",
                  "configurationName": "The delivery of the shipment item is in progress",
                  "normalizedStatusId": 2001,
                  "normalizedStatusName": "Out for delivery",
                  "date": "2025-08-26T09:16:14+02:00",
                  "cityName": "Aalborg",
                  "postalCode": "9000",
                  "country": "Denmark",
                  "location": "9010"
                }
              ]
            }
          ]
        }
      ]
    }
  }
]

In dit voorbeeld:

De location code is 9010
De gebeurtenisstatus is Out for delivery
Stad en postcode geven extra context (Aalborg, 9000)

De locatiecode interpreteren

De location waarde is specifiek voor de vervoerder, niet een postcode.
Codes zoals 9010 of 0705 zijn identificaties voor terminals of sorteerknooppunten.
Combineer met cityName en postalCode om gebruikers een duidelijker beeld te geven.

nShift Help Center