trackingEvent

An trackingEvent is a single event emitted by the carrier that provides information about the current status of a shipment.

idstring

Example: 98c2a4fa-9a1e-4c2e-8e9b-2b0a3d7e9d31

type

Constant value: trackingEvent

Default value: trackingEvent

attributes object

carriercarrierCode

Unique code defining the carrier, for example FEDEX, DPD, POSTNL, BPOST, ROYAL_MAIL, etc.

Examples:

Example 1

Example: AMAZON

Example 2

Example: BPOST

Example 3

Example: BRING

Example 4

Example: BUDBEE

Example 5

Example: CHRONOPOST

Example 6

Example: COLIS_PRIVE

Example 7

Example: CORREOS

Example 8

Example: CYCLOON

Example 9

Example: DHL

Example 10

Example: DPD

Example 11

Example: DX

Example 12

Example: EVRI

Example 13

Example: FEDEX

Example 14

Example: GLS

Example 15

Example: INPOST

Example 16

Example: LA_POSTE

Example 17

Example: POSTNL

Example 18

Example: POSTNORD

Example 19

Example: ROYAL_MAIL

Example 20

Example: SDA

Example 21

Example: SWISS_POINT

Example 22

Example: UPS

Example 23

Example: YAMATO

externalOrderNumberexternalOrderNumber

The externalOrderNumber as specified during creation of the order.

Possible values: <= 50 characters

Example: #1003-UK

statustrackingStatusrequired

The current status of the shipment as reported by the carrier. This is a normalized value.

Possible values: [LABELLED, ACCEPTED, SORTED, IN_TRANSIT, CUSTOMS, IN_DELIVERY, ATTEMPTED, DELIVERED, EXCEPTION]

subStatusstring

Optional. A more detailed status describing the current shipment status reported by the carrier. This is not a noramlized value and could change drastically.

timestampstring<date-time>required

The date and time when the carrier reported the (new) tracking status.

Examples:

Example 1

Example: 2020-06-20T12:00:00Z

Example 2

Example: 2021-03-15T08:30:00+01:00

trackingNumberstringrequired

The tracking number provided by the carrier.

Examples:

Example 1

Example: Q75002062014

Example 2

Example: PKACCA0711753490103728A

Example 3

Example: 3SIIIJ376192501

Example 4

Example: H05WYA0000438166

relationships object

shipment object

Represents a relationship to a shipment resource.

data object

Represents a self-link of a shipment resource.

idinteger

Example: 68076953

type

Constant value: shipment

Example: shipment

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/shipments/68076953

order object

Represents a relationship to an order resource.

data object

Represents a self-link of an order resource.

idinteger

The id is an internally assigned id of an order. Only during and POST v3/orders is it possible to use arbitrary integer value which might be used to cross-reference within the message itself. However the system will not honour any value assigned by external systems.

Example: 24006341

type

Constant value: order

Default value: order

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/orders/24006341

trackingEvent

{
  "id": "98c2a4fa-9a1e-4c2e-8e9b-2b0a3d7e9d31",
  "attributes": {
    "carrier": "AMAZON",
    "externalOrderNumber": "#1003-UK",
    "status": "LABELLED",
    "subStatus": "string",
    "timestamp": "2020-06-20T12:00:00Z",
    "trackingNumber": "Q75002062014"
  },
  "relationships": {
    "shipment": {
      "data": {
        "id": 68076953,
        "type": "shipment",
        "links": {
          "self": "https://shopapi.activeants.nl/v3/shipments/68076953"
        }
      }
    },
    "order": {
      "data": {
        "id": 24006341,
        "links": {
          "self": "https://shopapi.activeants.nl/v3/orders/24006341"
        }
      }
    }
  }
}