April 14, 2026

Breaking change — Order payload update

Affected: All Create Order API customers.

1. customerReference at the root of the payload is no longer in use. You can submit it, but the API will drop the value when processing your order. Instead you should only use externalDocumentNumber for your internal reference.
2. The company name located at shipping.companyName is now a required field as carriers require it to fulfil deliveries.
3. Starting from this release, postal code/zip code validation is enforced on shipping data. You will receive an HTTP 422 status if the entered postal code does not match the expected format for the provided ship-to country.

An example of the validation response for an invalid postal code format:

{
  "success": false,
  "data": null,
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "One or more validation errors occurred.",
    "details": {
      "Shipping.ZipCode": [
        "'12345' is not a valid postal code for country 'GB'. Expected format(s): AN NAA, ANN NAA, AAN NAA, AANN NAA, ANA NAA, AANA NAA."
      ]
    }
  },
  "meta": {
    "timestamp": "2026-03-24T10:30:00+00:00",
    "correlationId": "ada0301a-3128-4690-a44b-a268d07e36d3"
  }
}

Action required: Update your services to ensure these details are provided in the correct format.