Shipping order create draft

This endpoint allows to create and store a shipping order as a draft. The draft shipping order can contain incomplete or missing data and is not yet ready for shipping label creation or submission to the carrier. It enables to save a shipping order in progress and complete the necessary details later before finalizing the shipment.

POST /v1/shipping-orders/drafts

Request example

{
  "orderReferenceId": "EXMPL0001234",
  "currency": "EUR",
  "options": {
    "weightUnit": "g",
    "dimensionUnit": "mm",
    "label": {
      "format": "pdf"
    }
  },
  "partner": {
    "clientName": "ExampleCustomer"
  },
  "shippingMethod": {
    "uid": "",
    "carrier": "",
    "tier": "standard"
  },
  "receiver": {
    "person": {
      "firstName": "Foo",
      "lastName": "Bar",
      "company": "",
      "email": "[email protected]",
      "phone": "01273552886"
    },
    "address": {
      "country": "GB",
      "state": "East Sussex",
      "city": "Brighton",
      "postcode": "BN1 8YQ",
      "addressLine1": "11 London Rd",
      "addressLine2": "",
      "addressLine3": "",
      "street": "London Rd",
      "houseNumber": "11",
      "suburb": null
    },
    "customs": {
      "vatNumber": null
    }
  },
  "sender": {
    "person": {
      "firstName": "",
      "lastName": "",
      "company": "Example Company",
      "email": "[email protected]",
      "phone": "01666 123456"
    },
    "address": {
      "country": "DE",
      "state": "",
      "city": "Donauwörth",
      "postcode": "86609",
      "addressLine1": "Am Wassergraben 11",
      "addressLine2": null,
      "addressLine3": null,
      "street": "Am Wassergraben",
      "houseNumber": "11",
      "suburb": null
    },
    "customs": {
      "vatNumber": "DE123456789000",
      "iossNumber": null,
      "eoriNumber": "GB987654321000",
      "pcccNumber": null,
      "australianBusinessNumber": null
    }
  },
  "packages": [
    {
      "packageReferenceId": "EXMPL0001234-0-1",
      "grossWeight": null,
      "netWeight": null,
      "length": null,
      "width": null,
      "height": null,
      "boxType": "rectangle",
      "volumetricWeight": 700,
      "items": [
        {
          "itemReferenceId": "EXMPL0001234-0-1-ITEM1",
          "description": "Mug",
          "value": 18.42,
          "quantity": 4,
          "weight": null,
          "hsCode": "44199090",
          "countryOfOrigin": "DE"
        }
      ]
    }
  ]
}

Successful response example

201 Created

{
  "draftShippingOrderId": "c913e6a7-66c3-4ed2-b450-485f50edc395"
}