Explore

Create a new POS order

POST/pos/orders

Posts a new POS order to your store configuration.

Request body

Example request

Content-Type: application/json; charset=utf-8

{
  "transactionid": "TRANS123",
  "location": "421",
  "customer": {
    "name": {
      "title": "Mr",
      "firstname": "Test",
      "surname": "Customer"
    },
    "company": "",
    "address": {
      "addressline1": "20-22 Wenlock Road",
      "addressline2": "",
      "addressline3": "",
      "towncity": "",
      "stateprovince": "London",
      "postalcode": "N1 7GU",
      "country": "GB"
    },
    "email": "[email protected]",
    "emailoptin": true,
    "numbers": [
      "02030869860"
    ]
  },
  "shipping": {
    "name": {
      "title": "Mr",
      "firstname": "Test",
      "surname": "Customer"
    },
    "company": "",
    "address": {
      "addressline1": "20-22 Wenlock Road",
      "addressline2": "",
      "addressline3": "",
      "towncity": "",
      "stateprovince": "London",
      "postalcode": "N1 7GU",
      "country": "GB"
    },
    "method": "NEXTDAY",
    "cost": 5.00
  },
  "items": [
    {
      "sku": "200099-0536",
      "quantity": 1,
      "unitprice": 54.17,
      "unittax": 10.83
    }
  ],
  "notes": "Sample Notes",
  "totalpaid": 70.00,
  "paymentreference": "RECEIPT123"
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5c0fc014fd56221ba0215a2a",
  "ordernumber": "UK078767"
}