POST
/
api-order
/
pos
/
orders
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 '{
  "channel": 12,
  "orderReference": 1234,
  "locationId": "5efcc26a5ee50d00079ca2ab",
  "orderTotal": 125.33,
  "taxTotal": 5.23,
  "orderCurrency": "USD",
  "status": "ORDER_CREATED",
  "statusLog": "Order has been Shipped",
  "customerUserId": "5e3598e3007c5e00080d2bb8",
  "customerAccountId": "5e3598e3007c5e00080d2bb8",
  "customerEmail": "ino@fabric.inc",
  "customerPhone": {
    "number": "555-555-5555",
    "kind": "mobile"
  },
  "shipTo": [
    {
      "shipToId": 1000001,
      "shipToType": "SHIP_TO_ADDRESS",
      "address": {
        "name": {
          "first": "Mark",
          "middle": "p",
          "last": "styler"
        },
        "email": "mark@google.com",
        "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": [
        "<any>"
      ],
      "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": "mark@google.com",
            "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"
          }
        }
      ]
    }
  ]
}'
{
  "tags": [
    "<any>"
  ],
  "_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": "ino@fabric.inc",
  "customerPhone": {
    "number": "555-555-5555",
    "kind": "mobile"
  },
  "orderId": "7998-1161-63560",
  "shipTo": [
    {
      "address": {
        "name": {
          "first": "Mark",
          "middle": "p",
          "last": "styler"
        },
        "phone": {
          "number": "555-555-5555",
          "kind": "mobile"
        },
        "email": "mark@google.com",
        "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": [
        "<any>"
      ],
      "attributes": [
        "<any>"
      ]
    }
  ],
  "shipments": [
    "<any>"
  ],
  "payments": [
    {
      "billToAddress": {
        "name": {
          "first": "Marl",
          "middle": "p",
          "last": "styler"
        },
        "phone": {
          "number": "555-555-5555",
          "kind": "mobile"
        },
        "email": "mark@google.com",
        "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": [
    "<any>"
  ],
  "events": [
    "<any>"
  ],
  "pickups": [
    "<any>"
  ],
  "attributes": [
    "<any>"
  ],
  "createdAt": "2021-05-06T20:00:30.143Z",
  "updatedAt": "2021-05-06T20:00:30.143Z"
}

Headers

​
x-api-key
string
​
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.

Body

application/json
​
orderReference
string
required
​
locationId
string
required
​
status
string
required
​
channel
number
​
orderTotal
number
​
taxTotal
number
​
orderCurrency
string
​
statusLog
string
​
customerUserId
string
​
customerAccountId
string
​
customerEmail
string
​
customerPhone
object
​
shipTo
object[]

Response

200
application/json
Created POS order
​
tags
any[]
​
_id
string
​
channel
number
​
orderReference
string
​
orderTotal
number
​
taxTotal
number
​
orderCurrency
string
​
status
string
​
statusLog
string
​
customerUserId
string
​
customerAccountId
string
​
customerEmail
string
​
customerPhone
object
​
orderId
string
​
shipTo
object[]
​
items
object[]
​
shipments
any[]
​
payments
object[]
​
revision
number
​
totalQuantity
number
​
statusDescriptions
any[]
​
events
any[]
​
pickups
any[]
​
attributes
any[]
​
createdAt
string
​
updatedAt
string

Was this page helpful?

Bulk return ordersGet order by email