v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Delivery

View delivery

Returns details of a delivery aka shipment

get/api/v1/deliveries/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The resource's identifier.

Response

Operation completed successfully.

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"
      }
    ]
  }
}