Appearance

Shipments Endpoint ​

The Shipments endpoint contains information about the dispatch of placed orders so that you can find out about the current status of the parcels.

What the shipments endpoint can do ​

Using the Merchrocket API, you can perform the following actions on shipments endpoints:

Shipment-Properties ​

id ​

  • Type: string

The unique identifier of a shipment.

json
[
  {
    "id": "018f6152-9fd4-7a09-b130-3362e2bc6c11",  
    "carrier": "string",
    "service": "DHL",
    "shipmentStatus": "shipped",
    "shippedAt": "2024-09-03T12:06:46.650Z",
    "trackingUrl": "https://myorders.com/tracking/663dc7547d7fe6.77121852",
    "trackingId": "663dc7547d7fe6.77121852"
  }
]

carrier ​

  • Type: string

The carrier of the shipment. Possible values include:

json
[
  {
    "id": "018f6152-9fd4-7a09-b130-3362e2bc6c11", 
    "carrier": "DHL",  
    "service": "DHL_EXPRESS",
    "shipmentStatus": "shipped",
    "shippedAt": "2024-09-03T12:06:46.650Z",
    "trackingUrl": "https://myorders.com/tracking/663dc7547d7fe6.77121852",
    "trackingId": "663dc7547d7fe6.77121852"
  }
]

service ​

  • Type: string

The subservice of the carrier. Which shipping type (service) was used for the shipment:

  • STANDARD: Standard shipping
  • DHL_EXPRESS: DHL Express shipping
json
[
  {
    "id": "018f6152-9fd4-7a09-b130-3362e2bc6c11", 
    "carrier": "DHL",  
    "service": "DHL_EXPRESS", 
    "shipmentStatus": "shipped",
    "shippedAt": "2024-09-03T12:06:46.650Z",
    "trackingUrl": "https://myorders.com/tracking/663dc7547d7fe6.77121852",
    "trackingId": "663dc7547d7fe6.77121852"
  }
]

shipmentStatus ​

  • Type: string

The status of the shipment. Possible values include:

  • pending - The shipment label is created but the package not labelled.
  • canceled - The shipment was canceled.
  • packaged - The shipment is packed and labelled with the shipment label.
  • shipped - The shipment is on its way to the customer and has been handed over to the service provider (carrier).
  • returned - The parcel could not be delivered and has been returned to Merchrocket.
json
[
  {
    "id": "018f6152-9fd4-7a09-b130-3362e2bc6c11", 
    "carrier": "DHL",  
    "service": "DHL_EXPRESS", 
    "shipmentStatus": "shipped", 
    "shippedAt": "2024-09-03T12:06:46.650Z",
    "trackingUrl": "https://myorders.com/tracking/663dc7547d7fe6.77121852",
    "trackingId": "663dc7547d7fe6.77121852"
  }
]

shippedAt ​

  • Type: string

The date on which the shipment was dispatched.

json
[
  {
    "id": "018f6152-9fd4-7a09-b130-3362e2bc6c11", 
    "carrier": "string",
    "service": "DHL",
    "shipmentStatus": "shipped",
    "shippedAt": "2024-09-03T12:06:46.650Z",  
    "trackingUrl": "https://myorders.com/tracking/663dc7547d7fe6.77121852",
    "trackingId": "663dc7547d7fe6.77121852"
  }
]

trackingUrl ​

  • Type: string

The trackingUrl of the specific service provider (carrier) where you can find delivery information about your shipment.

json
[
  {
    "id": "018f6152-9fd4-7a09-b130-3362e2bc6c11", 
    "carrier": "string",
    "service": "DHL",
    "shipmentStatus": "shipped",
    "shippedAt": "2024-09-03T12:06:46.650Z",  
    "trackingUrl": "https://myorders.com/tracking/663dc7547d7fe6.77121852", 
    "trackingId": "663dc7547d7fe6.77121852"
  }
]

trackingId ​

  • Type: string

The trackingId of the shipment. You can use it on the shipment information pages of the service provider to get details about your shipment.

json
[
  {
    "id": "018f6152-9fd4-7a09-b130-3362e2bc6c11", 
    "carrier": "string",
    "service": "DHL",
    "shipmentStatus": "shipped",
    "shippedAt": "2024-09-03T12:06:46.650Z",  
    "trackingUrl": "https://myorders.com/tracking/663dc7547d7fe6.77121852", 
    "trackingId": "663dc7547d7fe6.77121852"
  }
]