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

Attribute

Requirement

Description

trkref

mandatory

Tracking reference of the organisation. Required capital letters.
Examples: "ABC", "ABC-XYZ"

order_ref

mandatory

Unique identifier of order

order_date

optional only if fulfilment_date present

Date when the order was created. Optional if fulfilment_date present. Valid format: dd-mm-yyyy.
Example: "25-09-2021"

fulfilment_date

optional only if order_date present

Optional if order_date present. Date when the order was fulfilled. Format: dd-mm-yyyy.
Example: "25-09-2021"

language

optional

Language of the purchaser: Two letter code as per ISO 639-1.
Examples: "en", "de".

locale

optional

The 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"

customer

mandatory

email

mandatory

The email address of the ordering customer

customer_ref

optional

The unique identifier of the customer

title

optional

Customer title as in Mr/Ms/Doctor, etc.

first_name

optional

Customer first name

country

optional

Customer Country. Two letter code of the country as per ISO 3166-1.

order_items

mandatory

Array of items ordered by the customer

sku

mandatory

The unique identifier of the product

price

optional

The price of this order item. A string containing just digits and a comma to separate the decimals.

currency

optional

The currency in which the price for this order_item is specified. Use the ISO 4217 code.

metadata

optional

List 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_underscore

optional

Any 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!