POST
/
api-inventory
/
inventory
/
pos
curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-inventory/inventory/pos \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "itemId": 1000001,
  "stockQuantity": 5,
  "channelId": 12,
  "warehouseId": "5e4b0a8cef94d00b11acc382"
}'
{
  "itemId": 1000000033,
  "inlocations": [
    {
      "location": "60ac42ecc956070008e15ea6",
      "_id": "60f5c3666a04ef0008b702f4",
      "inStock": 1000,
      "channel": [
        {
          "quantityReserved": 0,
          "_id": "60f5c3666a04ef0008b702f5",
          "channelId": 12,
          "allocation": {
            "mou": "ABSOLUTE",
            "unit": 1000
          },
          "id": "60f5c3666a04ef0008b702f5"
        }
      ],
      "inTransit": [
        {
          "_id": "60f5c3666a04ef0008b702f6",
          "inTransitRef": "WO-20000",
          "orderQuantity": 10000,
          "quantityReserved": 0,
          "orderDate": "2020-05-05T00:00:00.000Z",
          "stockDate": "2020-05-05T00:00:00.000Z",
          "id": "60f5c3666a04ef0008b702f6"
        }
      ],
      "id": "60f5c3666a04ef0008b702f4"
    }
  ],
  "sku": "SHIRT001",
  "title": "Shirt",
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z"
}

Headers

​
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\"}"

​
x-api-key
string
Example:

"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

Body

application/json
​
itemId
number
required
Example:

1000001

​
stockQuantity
number
required
Required range: x >= 0
Example:

5

​
channelId
number
required
Example:

12

​
warehouseId
string
required
Required string length: 24
Example:

"5e4b0a8cef94d00b11acc382"

Response

200
application/json
Inventory POS
​
itemId
number
Example:

1000000033

​
inlocations
object[]
​
sku
string
Example:

"SHIRT001"

​
title
string
Example:

"Shirt"

​
_id
string
Example:

"5fee9d59f2f08a1b3cbdea08"

​
createdAt
string
Example:

"2020-12-31T02:09:53.914Z"

​
updatedAt
string
Example:

"2020-12-31T02:09:53.914Z"