Find inventories of specific items

Authorizations

Authorization

string

header

required

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

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-request-id

string

Unique request ID

x-fabric-channel-id

string

x-fabric-channel-ids

string

x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is an optional field. The default US channel is 12 while the default Canada channel is 13. This field is optional. Note: Use xFabricChannelIds for multiple channels, and xFabricChannelId for a single channel.

Query Parameters

offset

integer

default:

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

limit

integer

default:

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.

Required range: 1 < x < 100

Body

application/json

Find inventory request

itemIds

integer[]

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

locationNumbers

integer[]

Location numbers

locationTypes

string[]

Location types

networkCodes

string[]

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

region

string

Region

segments

string[]

Segments

skus

string[]

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

Response

200 - application/json

Find inventory response

data

object[]

data.backorderLimit

integer

Maximum restock inventory quantity

data.backorderShipmentAt

string

Time when backorder is shipped

data.channelId

string

Sales channel ID; identifies business operations location.

data.counters

object

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

data.createdAt

string

Time of inventory creation

data.customAttributes

object

Placeholder for additional info

data.hasInfiniteInventory

boolean

default:

false

Infinite inventory flag. true: Inventory can be used any number of times and does not have any consumption limit. false: Inventory can't be used infinitely, and has a consumption limit.

data.inventoryId

string

The fabric system-generated inventory ID. This ID is generated during inventory creation.

data.isNoStock

boolean

An attribute used to indicate that a SKU is out of stock.

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.leadTime

string

The time between when an order is placed to replenish inventory and when the order is received at warehouse.

data.locationNumber

integer

Represents the warehouse or store location where the inventory is stored. The locationNumber is crucial for inventory management. When creating or updating inventory, you need to include the locationNumber to specify which location the inventory belongs to.

data.lowStock

integer

The lowStock parameter is used to alert low stock at a location when inventory is below a set number.

data.networkCode

string

Code of the network to which the inventory belongs

data.networkCounters

object

Indicates inventory positions at network

data.preorderLimit

integer

Maximum first-shipping inventory quantity

data.preorderShipmentAt

string

Time when preorder is shipped

data.region

string

Region where inventory is managed

data.safetyStock

integer

Reserved inventory quantity at the location

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.status

enum<string>

Inventory status IN_STOCK, LOW_STOCK, etc.

Available options:

IN_STOCK,

LOW_STOCK,

OUT_OF_STOCK,

BACKORDER_STOCK,

PREORDER_STOCK

data.type

string

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

data.updatedAt

string

Time when inventory was last updated

data.vendorId

string

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

data.virtualCounters

object

Virtual counters are calculated at run time from counters

data.virtualCountersStatus

object

Virtual counters are calculated at run time from counters

pagination

object

Pagination response

Order User Guides

Inventory User Guides

Orders API Endpoints

Inventory API Endpoints

Find inventories of specific items

Authorizations

Headers

Query Parameters

Body

Response