Shipment

Get a list of shipments tracking information for given filters.

List of shipments tracking

get/rest/api/shipping/shipment/tracking/

Query parameters

carrierAccountId[]integer[]

Carrier account IDs

carrierBrokerId[]integer[]

Carrier broker IDs

postDateAfterstring date-time

Date of shipment creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200</code>

postDateBeforestring date-time

Date of shipment creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200</code>

receivedDateAfterstring date-time

Date by which the shipment was delivered, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200</code>

receivedDateBeforestring date-time

Date from which the shipment was delivered, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200</code>

status[]integer[]

Status of shipment (0 - New parcel, not yet shipped, 1 - The parcel is waiting in the waiting room, it has not been sent, 2 - A new parcel, registered in the courier's system but does not have a status yet, 21 - Package in delivery, 9 - Package removed, 31 - The parcel is waiting for collection (collection point, notice), 32 - Return of the parcel to the sender, other error, 100 - Parcel received, 101 - Return parcel delivered)

Response

Returns list of shipments

totalCountinteger

Number of matching results

currentOffsetinteger

Current list offset

pageResultCountinteger

Number of results per page

Example response

{
  "shipments": [
    {
      "externalId": "312",
      "statusDate": "2023-11-24T08:33:07+0100",
      "statusDescription": "Handed over to the courier",
      "statusCheckTimestamp": "2023-11-24T08:33:07+0100",
      "receivedDate": "2022-06-09T10:59:12+0100"
    }
  ],
  "totalCount": 7398,
  "pageResultCount": 64
}

Changes

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