GET
/
inventory
/
geography
curl --request GET \
  --url https://prod01.oms.fabric.inc/api/v2/inventory/geography \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "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
      }
    }
  ],
  "locations": [
    {
      "locationNum": 473746,
      "distance": 4.5
    }
  ]
}

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

​
InventoryGeoSearchModel
object
required

For better and accurate inventory search, provide either of the following values along with skus: <br /> city and state, or <br /> postal code, or<br /> latitude and longitude

Response

200
application/json
OK
​
inventory
object[]
​
locations
object[]

Was this page helpful?

Get inventory of specific itemOverview