Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Delivery

List deliveries

Lists existing deliveries

get/api/v1/deliveries

Query parameters

numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

field'salesOrderId'
dir'asc' | 'desc'
key'salesOrderId' | 'shippingMethodId' | 'deliveryNoteId' | 'trackingNumber' | 'carrier' | 'sentAt' | 'sentAtTimestamp' required

Field to filter by.

op'equals' | 'notEquals' | 'in' | 'notIn' | 'lessThan' | 'lessThanOrEquals' | 'greaterThan' | 'greaterThanOrEquals' | 'startsWith' | 'endsWith' required

Operator to use for filtering.

Response

Delivery list

Example response

{
  "data": [
    {
      "id": "DEL-12345",
      "tracking": {
        "number": "101010101010101",
        "link": "https://carrier.example.com/track/101010101010101",
        "carrier": "DHL"
      },
      "deliveryNote": {
        "id": "DN-54321"
      },
      "salesOrder": {
        "id": "SO-98765"
      },
      "shippingMethod": {
        "id": "SM-12345"
      },
      "sentAt": "2022-01-07",
      "sentAtTimestamp": "2022-01-07 00:00:00",
      "label": {
        "fileType": "image/gif",
        "fileContent": "R0lGODlhAQABAPAAAAAAAAAAACH5BAEAAAAALAAAAAABAAEAAAICRAEAOw=="
      },
      "additionalPackages": [
        {
          "id": "123",
          "trackingNumber": "ABC123123123",
          "weight": 2.25,
          "createdAt": "2024-09-18T14:30:00Z",
          "updatedAt": "2024-09-18T14:30:00Z"
        }
      ]
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}