Create POS order

Create POS order

POST /api-order/pos/orders

Create POS order

cURL

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/pos/orders \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "orderReference": 1234,
  "locationId": "5efcc26a5ee50d00079ca2ab",
  "status": "ORDER_CREATED",
  "channel": 12,
  "orderTotal": 125.33,
  "taxTotal": 5.23,
  "orderCurrency": "USD",
  "statusLog": "Order has been Shipped",
  "customerUserId": "5e3598e3007c5e00080d2bb8",
  "customerAccountId": "5e3598e3007c5e00080d2bb8",
  "customerEmail": "[e-mail]",
  "customerPhone": {
    "number": "555-555-5555",
    "kind": "mobile"
  },
  "shipTo": [
    {
      "shipToId": 1000001,
      "shipToType": "SHIP_TO_ADDRESS",
      "address": {
        "name": {
          "first": "Mark",
          "middle": "p",
          "last": "styler"
        },
        "email": "[e-mail]",
        "phone": {
          "number": "555-555-5555",
          "kind": "mobile"
        },
        "street1": "10400 NE 4th St",
        "street2": "Suite 500",
        "city": "Bellevue",
        "state": "WA",
        "country": "USA",
        "zipCode": 98004,
        "kind": "Ship to address"
      },
      "price": 24.8723423,
      "currency": "USD",
      "estimatedTax": 10,
      "committedTax": 10,
      "promosApplied": [
        {
          "name": "test1"
        }
      ],
      "total": 34.87,
      "taxCode": "FR020000",
      "shipmentCarrier": "Fedex",
      "shipmentMethod": "Express",
      "shipmentMethodId": 10000001,
      "promisedDeliveryDate": "2021-02-14",
      "shipmentInstructions": "Leave at back door",
      "shipmentStatus": "Delivered",
      "items": [
        {
          "lineItemId": 1,
          "itemId": 1000011127,
          "sku": 1538910,
          "group": [
            "Group1"
          ],
          "title": "Luminous Cushion Lagoon",
          "quantity": 10,
          "price": 4.5,
          "discount": 1,
          "currency": "USD",
          "shipToId": 1000001,
          "estimatedTax": 10.25,
          "committedTax": 10.25,
          "promosApplied": [
            {
              "name": "test"
            }
          ],
          "total": 4.54234234,
          "taxCode": "FR020000",
          "weight": 10,
          "weightUnit": "lb"
        }
      ],
      "shipments": "<array>",
      "payments": [
        {
          "billToId": 1000001,
          "shipToId": [
            1000001
          ],
          "paymentIdentifier": {
            "cardIdentifier": 4242
          },
          "paymentMethod": "Visa",
          "paymentToken": {
            "token": 12345689
          },
          "paymentKind": "Default payment",
          "amount": 533.33,
          "currency": "USD",
          "conversion": 1,
          "paymentStatus": "Pending",
          "billToAddress": {
            "name": {
              "first": "Marl",
              "middle": "p",
              "last": "styler"
            },
            "email": "[e-mail]",
            "phone": {
              "number": "555-555-5555",
              "kind": "mobile"
            },
            "street1": "10400 NE 4th St",
            "street2": "Suite 500",
            "city": "Bellevue",
            "state": "WA",
            "country": "USA",
            "zipCode": 98004,
            "kind": "Ship to address"
          }
        }
      ]
    }
  ]
}
'

200

{
  "tags": "<array>",
  "_id": "60944ade71cdfc0008a621a2",
  "channel": 12,
  "orderReference": "testorder",
  "orderTotal": 125.33,
  "taxTotal": 5.23,
  "orderCurrency": "USD",
  "status": "ORDER_CREATED",
  "statusLog": "Order has been created",
  "customerUserId": "5e3598e3007c5e00080d2bb8",
  "customerAccountId": "5e3598e3007c5e00080d2bb8",
  "customerEmail": "[e-mail]",
  "customerPhone": {
    "number": "555-555-5555",
    "kind": "mobile"
  },
  "orderId": "7998-1161-63560",
  "shipTo": [
    {
      "address": {
        "name": {
          "first": "Mark",
          "middle": "p",
          "last": "styler"
        },
        "email": "[e-mail]",
        "phone": {
          "number": "555-555-5555",
          "kind": "mobile"
        },
        "street1": "10400 NE 4th St",
        "street2": "Suite 500",
        "city": "Bellevue",
        "state": "WA",
        "country": "USA",
        "zipCode": 98004,
        "kind": "Ship to address"
      },
      "promosApplied": [
        {
          "name": "test1"
        }
      ],
      "_id": "60944ade71cdfc0008a621a3",
      "shipToId": 1000001,
      "shipToType": "SHIP_TO_ADDRESS",
      "price": 24.87,
      "currency": "USD",
      "estimatedTax": 10,
      "committedTax": 10,
      "total": 34.87,
      "taxCode": "FR020000",
      "shipmentCarrier": "Fedex",
      "shipmentMethod": "Express",
      "shipmentMethodId": 10000001,
      "promisedDeliveryDate": "2021-02-14T00:00:00.000Z",
      "shipmentInstructions": "Leave at back door",
      "shipmentStatus": "Delivered"
    }
  ],
  "items": [
    {
      "group": [
        "Group1"
      ],
      "promosApplied": [
        {
          "name": "test"
        }
      ],
      "_id": "60944ade71cdfc0008a621a4",
      "lineItemId": 1,
      "itemId": 1000000051,
      "priceListId": 100003,
      "sku": 1538910,
      "title": "Luminous Cushion Lagoon",
      "quantity": 10,
      "price": 4.5,
      "discount": 1,
      "currency": "USD",
      "shipToId": 1000001,
      "estimatedTax": 10.25,
      "committedTax": 10.25,
      "total": 4.54,
      "taxCode": "FR020000",
      "weight": 10,
      "weightUnit": "lb",
      "reservedLocation": "<array>",
      "attributes": "<array>"
    }
  ],
  "shipments": "<array>",
  "payments": [
    {
      "billToAddress": {
        "name": {
          "first": "Marl",
          "middle": "p",
          "last": "styler"
        },
        "email": "[e-mail]",
        "phone": {
          "number": "555-555-5555",
          "kind": "mobile"
        },
        "street1": "10400 NE 4th St",
        "street2": "Suite 500",
        "city": "Bellevue",
        "state": "WA",
        "country": "USA",
        "zipCode": 98004,
        "kind": "Ship to address"
      },
      "shipToId": [
        1000001
      ],
      "_id": "60944ade71cdfc0008a621a5",
      "billToId": 1000001,
      "paymentIdentifier": {
        "cardIdentifier": 4242
      },
      "paymentMethod": "Visa",
      "paymentToken": {
        "token": 12345689
      },
      "paymentKind": "Default payment",
      "amount": 533.33,
      "currency": "USD",
      "conversion": 1,
      "paymentStatus": "Pending"
    }
  ],
  "revision": 0,
  "totalQuantity": 10,
  "statusDescriptions": "<array>",
  "events": "<array>",
  "pickups": "<array>",
  "attributes": "<array>",
  "createdAt": "2021-05-06T20:00:30.143Z",
  "updatedAt": "2021-05-06T20:00:30.143Z"
}

Headers

x-api-key · string

Example:

"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

x-site-context · string · required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json

orderReference · string · required

Example:

1234

locationId · string · required

Example:

"5efcc26a5ee50d00079ca2ab"

status · string · required

Example:

"ORDER_CREATED"

channel · number

Example:

12

orderTotal · number

Example:

125.33

taxTotal · number

Example:

5.23

orderCurrency · string

Example:

"USD"

statusLog · string

Example:

"Order has been Shipped"

customerUserId · string

Example:

"5e3598e3007c5e00080d2bb8"

customerAccountId · string

Example:

"5e3598e3007c5e00080d2bb8"

customerEmail · string

Example:

"[e-mail]"

customerPhone · object

Show child attributes

shipTo · object[]

Show child attributes

Response

200

application/json

Created POS order

tags · array

_id · string

Example:

"60944ade71cdfc0008a621a2"

channel · number

Example:

12

orderReference · string

Example:

"testorder"

orderTotal · number

Example:

125.33

taxTotal · number

Example:

5.23

orderCurrency · string

Example:

"USD"

status · string

Example:

"ORDER_CREATED"

statusLog · string

Example:

"Order has been created"

customerUserId · string

Example:

"5e3598e3007c5e00080d2bb8"

customerAccountId · string

Example:

"5e3598e3007c5e00080d2bb8"

customerEmail · string

Example:

"[e-mail]"

customerPhone · object

Show child attributes

orderId · string

Example:

"7998-1161-63560"

shipTo · object[]

Show child attributes

items · object[]

Show child attributes

shipments · array

payments · object[]

Show child attributes

revision · number

Example:

0

totalQuantity · number

Example:

10

statusDescriptions · array

events · array

pickups · array

attributes · array

createdAt · string

Example:

"2021-05-06T20:00:30.143Z"

updatedAt · string

Example:

"2021-05-06T20:00:30.143Z"