Skip to main content
POST
/
inventories
/
actions
/
find
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 '
{
  "itemIds": [
    127122871
  ],
  "locationNumbers": [
    12
  ],
  "locationTypes": [
    "DC"
  ],
  "networkCodes": [
    "4"
  ],
  "region": "North America",
  "segments": [
    "B2B_Special"
  ],
  "skus": [
    "SKU1"
  ]
}
'
{
  "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",
      "networkCounters": {
        "softReserve": 10
      },
      "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-request-id
string

Unique request ID

​
x-fabric-channel-id
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.

​
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<int32>
default:0

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

Example:

0

​
limit
integer<int32>
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.

Required range: 1 <= x <= 100
Example:

10

Body

application/json

Find inventory request

​
itemIds
integer<int64>[]

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

Item ID

​
locationNumbers
integer<int32>[]

Location numbers

Location number

​
locationTypes
string[]

Location types

Location type

​
networkCodes
string[]

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

Network code

​
region
string

Region

Example:

"North America"

​
segments
string[]

Segments

Segment

​
skus
string[]

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

SKU

Response

OK

Find inventory response

​
data
object[]
​
pagination
object

Pagination response