Shipment

Get list of shipment carrier documents.

List of carrier documents for carrier accounts

get/rest/api/shipping/carrier-document/

Query parameters

carrierAccountId[]integer[]

Carrier account IDs

createdAtAfterstring date-time

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

createdAtBeforestring date-time

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

Response

Returns list of shipment carrier documents

totalCountinteger

Number of matching results

currentOffsetinteger

Current list offset

pageResultCountinteger

Number of results per page

Example response

{
  "documents": [
    {
      "createdAt": "2023-11-24T08:33:07+0100",
      "type": 16,
      "media": "2ed996a6-0b91-529c-9728-f2e59532e7bc"
    }
  ],
  "totalCount": 7398,
  "pageResultCount": 64
}

Changes

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