Search for inventories

curl --request POST \
  --url https://api.fabric.inc/v3/inventories/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "filters": [
    {
      "condition": "EQ",
      "field": "inventory.sku",
      "value": "*V3"
    },
    {
      "condition": "IN",
      "field": "inventory.locationNumber",
      "values": [
        "3173*",
        "45213"
      ]
    }
  ],
  "sort": "-inventory.createdAt"
}
'

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

POST

inventories

curl --request POST \
  --url https://api.fabric.inc/v3/inventories/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "filters": [
    {
      "condition": "EQ",
      "field": "inventory.sku",
      "value": "*V3"
    },
    {
      "condition": "IN",
      "field": "inventory.locationNumber",
      "values": [
        "3173*",
        "45213"
      ]
    }
  ],
  "sort": "-inventory.createdAt"
}
'

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

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-channel-id

string

required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id

string

Unique request ID

Query Parameters

fetchOnlyIds

boolean

default:false

Body

application/json

Sample request to search inventory

filters

object[]

required

Maximum array length: 50

Criteria to find inventories by a single value. Condition between field and value is anything except IN and NIN when valueSearchFilter is used. Criteria to find inventory. To search using a single value, valueSearchFilter is considered. To search using multiple values, valuesSearchFilter is considered.

Option 1
Option 2

Show child attributes

filters.condition

enum<string>

default:EQ

required

Filter conditions. EQ (Equal to): Searches for exact match. NEQ (Not equal to): Searches by excluding the specified value. IN: Search for multiple values. NIN (Not IN): Excludes the specified values in the search. LT (Less than): Searches for values that are less than the specified value. GT (Greater than): Search for values that are greater than the specified value. LTE (Less than or equal to): Searches for values that are less than or equal to the specified value. GTE (Greater than or equal to): Searches for values that are greater than or equal to the specified value.

Available options:

EQ,

NEQ,

IN,

NIN,

LT,

GT,

LTE,

GTE

Example:

"EQ"

filters.field

string

required

Field name

Example:

"inventory.sku"

filters.group

string

default:Default

Group name

Example:

"GroupA"

filters.value

A single value to search inventory

Example:

"SKU"

sort

string

default:-inventory.createdAt

Property by which data is sorted

Example:

"+inventory.createdAt"

Response

Inventory search response sample

data

object[]

Show child attributes

data.backorderLimit

integer<int32>

Maximum restock inventory quantity

Example:

50

data.backorderShipmentAt

string<date-time>

Time when backorder is shipped

Example:

"2022-08-01T20:03:28.483Z"

data.channelId

string

Sales channel ID; identifies business operations location.

Example:

"channel_xyz"

data.counters

object

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

Show child attributes

data.counters.{key}

integer<int32>

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

Example:

{
  "allocated": 10,
  "onHand": 100,
  "shipped": 20
}

data.createdAt

string<date-time>

Time of inventory creation

Example:

"2022-08-01T18:03:28.483Z"

data.customAttributes

object

Placeholder for additional info

Show child attributes

data.customAttributes.{key}

string

Placeholder for additional info

Example:

"{\"isBopis\":true}"

Example:

{ "isBopis": true }

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.

Example:

false

data.inventoryId

string

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

Example:

"723910d81723"

data.isNoStock

boolean

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

Example:

false

data.itemId

integer<int32>

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.

Example:

12345

data.leadTime

string

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

Example:

"5 days"

data.locationNumber

integer<int32>

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.

Example:

12345

data.lowStock

integer<int32>

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

Example:

10

data.networkCode

string

Code of the network to which the inventory belongs

Example:

"ShipToHome"

data.preorderLimit

integer<int32>

Maximum first-shipping inventory quantity

Example:

40

data.preorderShipmentAt

string<date-time>

Time when preorder is shipped

Example:

"2022-08-01T20:03:28.483Z"

data.region

string

Region where inventory is managed

Example:

"North America"

data.safetyStock

integer<int32>

Reserved inventory quantity at the location

Example:

10

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.

Example:

"SKU1"

data.status

enum<string>

Inventory status IN_STOCK, LOW_STOCK, etc.

Available options:

IN_STOCK,

LOW_STOCK,

OUT_OF_STOCK,

BACKORDER_STOCK,

PREORDER_STOCK

Example:

" IN_STOCK"

data.type

string

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

Example:

"primary"

data.updatedAt

string<date-time>

Time when inventory was last updated

Example:

"2022-08-01T20:03:28.483Z"

data.vendorId

string

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

Example:

"vendor1"

data.virtualCounters

object

Virtual counters are calculated at run time from counters

Show child attributes

data.virtualCounters.availableBackorder

string

data.virtualCounters.availablePreorder

string

data.virtualCounters.availableToPurchase

string

data.virtualCountersStatus

object

Virtual counters are calculated at run time from counters

Show child attributes

data.virtualCountersStatus.availableBackorder

string

data.virtualCountersStatus.availablePreorder

string

data.virtualCountersStatus.availableToPurchase

string

pagination

object

Pagination response

Show child attributes

pagination.count

integer<int32>

Total number of search results

Example:

1000

pagination.limit

integer<int32>

default:10

Maximum number of records per page

Required range: 1 <= x <= 100

Example:

10

pagination.offset

integer<int32>

default:0

Number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.

Required range: x >= 0

Example:

1

Find inventories of specific items Adjust inventory counters

⌘I

Orders & Inventory

Order User Guides

Inventory User Guides

Orders API Endpoints

Inventory API Endpoints

Search for inventories

Authorizations

Headers

Query Parameters

Body

Response