GET
/
inventory
curl --request GET \
  --url https://prod01.oms.fabric.inc/api/v2/inventory \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "pagination": {
    "total": 100,
    "limit": 10,
    "offset": 0
  },
  "inventory": [
    {
      "virtualCounters": {
        "availableToPurchase": 10
      },
      "id": "62272e917b12209e68751d94",
      "sku": "SKU00025",
      "itemId": 4225678911,
      "locationNum": 473746,
      "channelId": 12,
      "vendorId": "vendor123",
      "leadTime": 1234,
      "inventoryType": "Safety stock",
      "infiniteInventory": true,
      "counters": {
        "on-hand": 10
      },
      "attributes": {
        "buy online, pick up in-store (bopis)": true
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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.

Query Parameters

​
inventorySearchModel
object

This object contains all the filtering criteria based on which inventories are searched

​
inventoryNetworkSearchModel
object

This object contains filtering criteria that help to search inventory by network

​
paginationQueryModel
object

This object represents the process of separating data into different pages

Response

200
application/json
OK
​
pagination
object

This object represents the process of separating data into different pages

​
inventory
object[]

Was this page helpful?

OverviewCreate inventory