This endpoint enables submission of a customer order details. The customer order data should be provided as a json object in the request body as described below. If the customer order is accepted a 202 response code will be sent back, along with a UUID that uniquely identifies this request.

❗️

This functionality is enabled only for some organisations. Please contact support if you need to enable it.

JSON Body Attributes

AttributeRequirementDescription
trkrefmandatoryTracking reference of the organisation. Required capital letters.
Examples: "ABC", "ABC-XYZ"
order_refmandatoryUnique identifier of order
order_dateoptional only if fulfilment_date presentDate when the order was created. Optional if fulfilment_date present. Valid format: dd-mm-yyyy.
Example: "25-09-2021"
fulfilment_dateoptional only if order_date presentOptional if order_date present. Date when the order was fulfilled. Format: dd-mm-yyyy.
Example: "25-09-2021"
languageoptionalLanguage of the purchaser: Two letter code as per ISO 639-1.
Examples: "en", "de".
localeoptionalThe locale associated to the order. The language codes are two-letter lowercase ISO language codes (such as “en”) as defined by ISO 639-1. The country codes are two-letter uppercase ISO country codes (such as “GB”) as defined by ISO 3166-1.
Examples: “en-GB”, "de-DE"
customermandatory
emailmandatoryThe email address of the ordering customer
customer_refoptionalThe unique identifier of the customer
titleoptionalCustomer title as in Mr/Ms/Doctor, etc.
first_nameoptionalCustomer first name
countryoptionalCustomer Country. Two letter code of the country as per ISO 3166-1.
order_itemsmandatoryArray of items ordered by the customer
skumandatoryThe unique identifier of the product
priceoptionalThe price of this order item. A string containing just digits and a comma to separate the decimals.
currencyoptionalThe currency in which the price for this order_item is specified. Use the ISO 4217 code.
metadataoptionalList of any other fields that will be linked to the order_item. Field names can contain only [a-z0-9] characters. There is not limit to the number of metadata items that you can have.
key_with_underscoreoptionalAny value you want to send
{
  "trkref":"TRKREF123",
  "order_ref": "ABC123",
  "order_date": "10-12-2014",
  "fulfilment_date": "24-12-2014",
  "language": "en",
  "locale": "en-GB",
  "customer": {
    "email": "[email protected]",
    "cutomer_ref": "1122",
    "title": "MR",
    "first_name": "John",
    "country": "GB"
  },
  "order_items": [
    {
      "sku": "PROD1",
      "price": "55,99",
      "currency": "GBP",
      "metadata": {
        "field_1": "Value 1",
        "field_2": "Value 2"
      }
    },
    {
      "sku": "PROD2",
      "price": "10",
      "currency": "GBP",
      "metadata": {
        "field_1": "Value 1",
        "field_2": "Value 2"
      }
    }
  ]
}
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!