Sign in
Shipment

Get detailed shipment by given ID.

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

Path parameters

idstring required

Shipment ID

Response

Detailed shipment object

statusDatestring date-time nullable

Status change date

statusDescriptionstring nullable

Status description

statusCheckTimestampstring date-time nullable

Status check date

receivedDatestring date-time nullable

Received date

receivedDaysinteger

Number of business days in which the parcel was received

idinteger

Internal shipment ID

carrierAccountIdinteger

Carrier account ID

carrierBrokerIdinteger

Carrier broker ID

externalIdstring nullable

External unique ID of the shipment

orderIdstring

Internal order ID

createdAtstring date-time nullable

Date the document was created in Apilo

postDatestring date-time nullable

Date of shipment

statusstring

Shipment tracking status if is present or NULL

methodstring nullable

External unique ID of the shipment method

mediastring

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

Example response

{
  "statusDate": "2023-11-24T08:33:07+0100",
  "statusDescription": "readyToSend",
  "statusCheckTimestamp": "2023-11-24T08:33:07+0100",
  "receivedDate": "2023-11-24T08:33:07+0100",
  "receivedDays": 2,
  "externalId": "312",
  "orderId": "123",
  "createdAt": "2023-11-24T08:33:07+0100",
  "postDate": "2022-06-09T10:59:12+0100",
  "method": "312",
  "media": "2ed996a6-0b91-529c-9728-f2e59532e7bc"
}

Changes

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