Find inventories of specific items

curl --request POST \
  --url https://api.fabric.inc/v3/inventories/actions/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "skus": [
    "SKU1"
  ],
  "itemIds": [
    127122871
  ],
  "locationNumbers": [
    12
  ],
  "locationTypes": [
    "DC"
  ],
  "segments": [
    "B2B_Special"
  ],
  "region": "North America",
  "networkCodes": [
    "4"
  ]
}'

{
  "pagination": {
    "limit": 10,
    "offset": 1,
    "count": 1000
  },
  "data": [
    {
      "inventoryId": "723910d81723",
      "sku": "SKU1",
      "itemId": 12345,
      "locationNumber": 12345,
      "region": "North America",
      "channelId": "channel_xyz",
      "vendorId": "vendor1",
      "createdAt": "2022-08-01T18:03:28.483Z",
      "updatedAt": "2022-08-01T20:03:28.483Z",
      "leadTime": "5 days",
      "type": "primary",
      "hasInfiniteInventory": true,
      "backorderShipmentAt": "2022-08-01T20:03:28.483Z",
      "preorderShipmentAt": "2022-08-01T20:03:28.483Z",
      "backorderLimit": 50,
      "preorderLimit": 40,
      "safetyStock": 10,
      "lowStock": 10,
      "networkCode": "ShipToHome",
      "counters": {
        "onHand": 100,
        "allocated": 10,
        "shipped": 20
      },
      "customAttributes": {
        "isBopis": true
      },
      "networkCounters": {
        "softReserve": 10
      },
      "virtualCounters": {
        "availableToPurchase": 60
      }
    }
  ]
}

Authorizations

Authorization

string

headerrequired

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

Headers

x-fabric-tenant-id

string

required

Merchant's 24-character tenant ID

x-fabric-request-id

string

Unique request ID

x-fabric-channel-id

string

Sales channel ID

x-fabric-channel-ids

string

Sales channel IDs.<br />Note: Use xFabricChannelIds for multiple channels, and xFabricChannelId for single channel

Query Parameters

offset

integer

default: 0

Number of records to be skipped before returning all records. Default is 0 when no value is specified.

limit

integer

default: 10

Maximum number of records to be returned on a single page. For example, when offset=20 and limit=10, it returns records 21-30 on a single page. Default is 10 when no value is specified.

Body

application/json

skus

string[]

List of SKUs for which the inventories are to be searched within the specified region

itemIds

integer[]

List of item IDs for which the inventories are to be searched

locationNumbers

integer[]

Location numbers

locationTypes

string[]

Location types

segments

string[]

Segments

region

string

Region

networkCodes

string[]

Codes associated with networks in which inventory of the SKUs are maintained

Response

200 - application/json

pagination

object

Pagination response

data

object[]

data.inventoryId

string

System-generated inventory ID. This ID is generated during inventory creation.

data.sku

string

Product SKU (Stock Keeping Unit) identifier. It serves as the primary reference key for the inventory and provides uniqueness to the item.

data.itemId

integer

Merchant-defined item ID whose inventory is created or updated. If omitted, fabric Inventory service generates the itemId. If you choose to use the itemId in your environment, you must include it in all inventory Write requests.

data.locationNumber

integer

Represents the warehouse or store location where the inventory is stored. It is recommended to link locationNumber to the corresponding value in the fabric Locations service.

data.region

string

Region where inventory is managed

data.channelId

string

Sales channel ID; identifies business operations location.

data.vendorId

string

ID of the vendor who will replenish the inventory for the retailer

data.createdAt

string

Time of inventory creation

data.updatedAt

string

Time when inventory was last updated

data.leadTime

string

Time between when an order is placed to replenish inventory and when the order is received at warehouse

data.type

string

Inventory type - a classifier attribute that provides flexibility to define inventory types

data.hasInfiniteInventory

boolean

default: false

Infinite inventory flag.<br />true: Inventory can be used any number of times and does not have any consumption limit.<br />false: Inventory cannot be used infinitely, and has a consumption limit.

data.backorderShipmentAt

string

Time when backorder is shipped

data.preorderShipmentAt

string

Time when preorder is shipped

data.backorderLimit

integer

Maximum restock inventory quantity

data.preorderLimit

integer

Maximum first-shipping inventory quantity

data.safetyStock

integer

Reserved inventory quantity at the location

data.lowStock

integer

Inventory quantity below which consumer service wants to be alerted as low stock at the location

data.networkCode

string

Code of the network to which the inventory belongs

data.counters

object

Merchant-defined inventory counter (also known as inventory position)

data.customAttributes

object

Placeholder for additional info

data.networkCounters

object

Indicates inventory positions at network

data.virtualCounters

object

Virtual counters are calculated at run time from counters

Was this page helpful?

Update inventory by adding new property Search for inventories

curl --request POST \
  --url https://api.fabric.inc/v3/inventories/actions/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '{
  "skus": [
    "SKU1"
  ],
  "itemIds": [
    127122871
  ],
  "locationNumbers": [
    12
  ],
  "locationTypes": [
    "DC"
  ],
  "segments": [
    "B2B_Special"
  ],
  "region": "North America",
  "networkCodes": [
    "4"
  ]
}'

{
  "pagination": {
    "limit": 10,
    "offset": 1,
    "count": 1000
  },
  "data": [
    {
      "inventoryId": "723910d81723",
      "sku": "SKU1",
      "itemId": 12345,
      "locationNumber": 12345,
      "region": "North America",
      "channelId": "channel_xyz",
      "vendorId": "vendor1",
      "createdAt": "2022-08-01T18:03:28.483Z",
      "updatedAt": "2022-08-01T20:03:28.483Z",
      "leadTime": "5 days",
      "type": "primary",
      "hasInfiniteInventory": true,
      "backorderShipmentAt": "2022-08-01T20:03:28.483Z",
      "preorderShipmentAt": "2022-08-01T20:03:28.483Z",
      "backorderLimit": 50,
      "preorderLimit": 40,
      "safetyStock": 10,
      "lowStock": 10,
      "networkCode": "ShipToHome",
      "counters": {
        "onHand": 100,
        "allocated": 10,
        "shipped": 20
      },
      "customAttributes": {
        "isBopis": true
      },
      "networkCounters": {
        "softReserve": 10
      },
      "virtualCounters": {
        "availableToPurchase": 60
      }
    }
  ]
}