Order

Shipment detail.

Detail of specific shipment belongs to given order

get/rest/api/orders/{id}/shipment/{shipment}/

Path parameters

idstring required

order number in Apilo system, e.g. <code>AL0012345</code>

shipmentstring required

ID of the shipment belongs to the Apilo order

Response

Shipment model

idinteger

Internal ID of the shipment

idExternalstring nullable

External unique ID of the shipment

trackingstring required

Shipment tracking number

carrierProviderIdinteger required

ID of <a href='#tag/Order/operation/get_rest_orders_carrier_map'>Carrier ID</a>. If you specify a value equal to 'manual carrier', there might be problems in passing the tracking number to the external integration.

postDatestring date-time nullable

Date of shipment

mediastring

Null or media UUID - <a href='#tag/Media/operation/post_rest_media_new'>media attachment endpoint</a>

statusstring

Shipment tracking status if is present or NULL

Example response

{
  "id": 1,
  "idExternal": "312",
  "tracking": "005842792564T",
  "carrierProviderId": 1,
  "postDate": "2022-06-09T10:59:12+0100",
  "media": "2ed996a6-0b91-529c-9728-f2e59532e7bc"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.