shipment

Represents a single shipment from a single warehouse that was generated for an order.

idinteger

Example: 68076953

type

Constant value: shipment

Example: shipment

attributes object

statusshipmentStatus

The shipmentStatus provides insight into the step in the process of fulfilling a shipment within a warehouse.

status	Description
`READY_TO_PICK`	The `shipment` has been fully planned and awaits the picking by an operator.
`READY_TO_SORT`	The `shipment` has been picked and packed and awaits sorting for the carrier.
`READY_TO_SHIP`	The `shipment` has been sorted and awaits pick-up by the carrier.
`SHIPPED`	The `shipment` has been handed over to the carrier and has dispatched from the warehouse.
`ERROR`	An issue with the `shipment` has occurred, for example some labelling issue. The `shipments` is awaiting intervention from an operator.

Possible values: [READY_TO_PICK, READY_TO_SORT, READY_TO_SHIP, SHIPPED, ERROR]

readyToPickOnstring<date>

Indicates the date the shipment was fully planned and ready to be picked in a warehouse of Paxon.

readyToShipOnstring<date>

Indicates the date the shipment was fully picked and packed in a warehouse of Paxon, awaiting dispatch.

shippedOnstring<date>

Indicates the date the shipment has shipped from the warehouse of Paxon.

warehouseCodewarehouseCode

The code for the warehouse used to uniquely refer to an Paxon warehouse.

The following warehouses are currently defined:

code	country	city	customs region	remarks
BW	Belgium	Willebroek	EU - Common Customs Tariff
DD	Germany	Dorsten	EU - Common Customs Tariff
FL	France	Lyon	EU - Common Customs Tariff
FP	France	Pantin	EU - Common Customs Tariff	return hub only
GN	Great Brittain	Northampton	GB - UK Global Tariff
NN	The Netherlands	Nieuwegein	EU - Common Customs Tariff	discontinued
NR	The Netherlands	Roosendaal	EU - Common Customs Tariff

Possible values: [BW, DD, FL, FP, GN, NR]

weightinteger

The (actual) weight of the shipment in grams. This weight includes the products, packing materials and inserts.

invoicingWeightinteger

The weight used to calculate the tariff for this shipment. For some carriers this deviates from the (actual) weight as these carriers apply a 'volumetric' or 'dimensional' weight which is the largest of the actual weight and the dimensional weight of the shipment.

basketPicturestring<uri>

Example: https://basketpic.activeants.nl/images/scale/23588151e05e44c9-5138-469e-a1cf-5ab137d4bcd7.jpg

shipmentTrackingUrlstring<uri>

SOON Contains the tracking url of the shipment. Depending on the type of the shipping method chosen, this url may point to an intermediary track-and-trace site. In case of multi-colli this link points to the first of the colli.

Examples:

Example 1
Example 2

Example: https://trackandtrace.activeants.com/shipment/d3cf048d-68aa-4a50-b6c5-3feb9795802f

Example: https://www.postnord.se/en/our-tools/track-and-trace?shipmentId=00023213400716747157

tracking objectdeprecated

DEPRECATED

warning

The tracking information will soon be removed from the GET v3/shipments and GET v3/shipments/:id endpoints. To receive tracking information use the EVENT tracking.updated.3 webhook instead.

carrierstring

Provides insight into which carrier is providing the transport of the shipment to the deliveryAddress or pickUpPointAddress. For example FEDEX, POSTNL, BPOST, DHL, CORREOS, POSTE ITALIANE, SPARQLE, ROYAL MAIL, and many more.

Examples:

Example: FEDEX

Example: POSTNL

Example: BPOST

Example: DHL

Example: CORREOS

Example: POSTE ITALIANE

Example: SPARQLE

Example: ROYAL MAIL

numberinteger

stageshipmentTrackingStage

The shipmentTrackingStage provide a generalized set of tracking well-defined stages for shipments.

The shipmentTrackingStage are generalized over all carriers. Each carrier can and has defined their own set of stages for tracking their consignments. To accommodate the main stages that are supported by most carriers the shipmentTrackingStages generalizes the carrier-specific stages. This could mean that some details of a particular carrier are not reflected by this enumeration.

stage	id	Description
`NEW`	0	The shipment is newly created and has not been assigned to a carrier yet.
`LABELED`	1	A label has created for the shipment.
`ACCEPTED`	2	The shipment has been accepted, received and scanned by the carrier.
`SORTED`	3	The shipment is been sorted before delivery.
`IN_TRANSIT`	4	The shipment is being delivered, but has not been delivered yet.
`ATTEMPTED`	8 or 10	An unsuccessful attempt to deliver the shipment has been made.
`AVAILABLE_FOR_PICKUP`	5	The shipment has been delivered to the pick up point for the recipient to collect.
`DELIVERED`	7	The shipment has been delivered.
`RETURNED`	19	The shipment has been returned to the sender after a failing be delivered.
`TRACKED_EXTERNALLY`	18	There is no tracking information being shared with Paxon for this shipment.

Note the id column corresponds to the v2 endpoint values for the stage

Possible values: [LABELLED, ACCEPTED, SORTED, IN_DELIVERY, AT_PUP, DELIVERED, 1ST_ATTEMPT]

statusstring

Possible values: [OK, ERROR, WARNING]

Example: OK

urlstring<uri>

colli object[]

Array [

numberstring

parcelNumberstring

The parcel number as assigned by the carrier

trackingUrlstring<uri>

A tracking url specific to this collo

]

returnLabelstring

metadata object

Repeats the metadata as specified on the order.

extra1string

extra2string

extra3string

extra4string

extra5string

relationships object

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

orderType object

Represents a relationship to an orderType resource.

data object

Represents a self-link of an orderType resource.

idinteger

Example: 10045

typestring

Possible values: Value must match regular expression orderType

Default value: orderType

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/orderTypes/10045

shipmentItems object

Represents a relationship to multiple shipmentItem resources.

data object[]

Array [

idinteger

Example: 15368865

type

Constant value: shipmentItem

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/shipmentItem/15368865

]

shippingMethod object

Represents a relationship to a shippingMethod resource.

data object

Represents a self-link of a shippingMethod resource.

idinteger

Example: 12

type

Constant value: shippingMethod

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/shippingMethod/12

included object[]

Array [

anyOf

shipmentItemRelationships

Identifies a resource as a shipmentItem.

idinteger

Example: 15368865

type

Constant value: shipmentItem

attributes object

skuproductSku

SKU (stock keeping unit) of a product used to identify products.

Possible values: >= 2 characters and <= 80 characters, Value must match regular expression ^[\x21-\x7E][\x20-\x7E]*[\x21-\x7E]$

Examples:

Example 1
Example 2
Example 3
Example 4
Example 5

Example: TSH-000-S

Example: 8720874770299

Example: HK-HNTSSTNG 6X

Example: BK-14-LARGE: 31x41x14

Example: TRRE-PSU6*003;2023-10:special

quantityinteger

Possible values: >= 0

Example: 2

lotNumberlotNumber

A lot number is a unique identification number assigned to a specific batch or lot of a product during the manufacturing process. It is used to track and trace the product's manufacturing and distribution history, including when and where it was produced, which raw materials were used, and to which customers it was shipped.

Lot numbers can be alphanumeric and may include information such as the date and time of production, the location of production, and the machine or equipment used. They are often printed on the product's packaging or label, as well as on associated documentation such as batch records and certificates of analysis.

Possible values: Value must match regular expression ^[\x21-\x7E][\x20-\x7E]*[\x21-\x7E]$

Examples:

Example 1
Example 2

Example: M008686

Example: M-45/61 21-190

expirationDatestring<date>

Example: 2028-10-14

serialNumbersstring[]

Possible values: non-empty

relationships object

orderItem object

Represents a relationship to an orderItem resource.

data object

Represents a self-link of an orderItem resource.

idinteger

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

Example: 52008118

typerequired

Constant value: orderItem

Default value: orderItem

Example: orderItem

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/orderItems/634006341

product object

Represents a relationship to a product resource.

data object

Represents a self-link of a product resource.

idinteger

The id is an internally assigned id of a product. It is possible to assign an arbitrary value in a POST request to cross-reference within the message itself. However the system will not honour any value assigned by external systems.

Example: 1267733

type

Constant value: product

Default value: product

links object

selfstring<uri>

Example: https://shopapi.activeants.nl/v3/products/1267733

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

]

links object

selfstring<uri>

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

shipment
{
  "id": 68076953,
  "type": "shipment",
  "attributes": {
    "status": "READY_TO_PICK",
    "readyToPickOn": "2024-07-29",
    "readyToShipOn": "2024-07-29",
    "shippedOn": "2024-07-29",
    "warehouseCode": "BW",
    "weight": 0,
    "invoicingWeight": 0,
    "basketPicture": "https://basketpic.activeants.nl/images/scale/23588151e05e44c9-5138-469e-a1cf-5ab137d4bcd7.jpg",
    "shipmentTrackingUrl": "https://trackandtrace.activeants.com/shipment/d3cf048d-68aa-4a50-b6c5-3feb9795802f",
    "colli": [
      {
        "number": "string",
        "parcelNumber": "string",
        "trackingUrl": "string"
      }
    ],
    "returnLabel": "string",
    "metadata": {
      "extra1": "string",
      "extra2": "string",
      "extra3": "string",
      "extra4": "string",
      "extra5": "string"
    }
  },
  "relationships": {
    "order": {
      "data": {
        "id": 24006341,
        "links": {
          "self": "https://shopapi.activeants.nl/v3/orders/24006341"
        }
      }
    },
    "orderType": {
      "data": {
        "id": 10045,
        "type": "orderType",
        "links": {
          "self": "https://shopapi.activeants.nl/v3/orderTypes/10045"
        }
      }
    },
    "shipmentItems": {
      "data": [
        {
          "id": 15368865,
          "links": {
            "self": "https://shopapi.activeants.nl/v3/shipmentItem/15368865"
          }
        }
      ]
    },
    "shippingMethod": {
      "data": {
        "id": 12,
        "links": {
          "self": "https://shopapi.activeants.nl/v3/shippingMethod/12"
        }
      }
    }
  },
  "included": [
    {
      "id": 15368865,
      "attributes": {
        "sku": "TSH-000-S",
        "quantity": 2,
        "lotNumber": "M008686",
        "expirationDate": "2028-10-14",
        "serialNumbers": [
          "2204190861003991"
        ]
      },
      "relationships": {
        "orderItem": {
          "data": {
            "id": 52008118,
            "type": "orderItem",
            "links": {
              "self": "https://shopapi.activeants.nl/v3/orderItems/634006341"
            }
          }
        },
        "product": {
          "data": {
            "id": 1267733,
            "links": {
              "self": "https://shopapi.activeants.nl/v3/products/1267733"
            }
          }
        },
        "shipment": {
          "data": {
            "id": 68076953,
            "type": "shipment",
            "links": {
              "self": "https://shopapi.activeants.nl/v3/shipments/68076953"
            }
          }
        }
      }
    }
  ],
  "links": {
    "self": "https://shopapi.activeants.nl/v3/shipments/68076953"
  }
}