Order User Guides
- Overview
- Order Management
- Order Fulfillment Logic
- Activity Log
- Settings
Inventory User Guides
Orders API Endpoints
- Orders (3.0.0)
- Developer Guide
- Orders FAQ
- Shopping Lists
- Shipping Methods
- Imports
- Exports
- Orders
- Frauds
- Notifications
- Backorders Preorders
- Cancellations
- Allocations
- Shipments
- Inventory Transfers
- Tracking
- Invoices
- Payments
- Credits
- Appeasements
- Returns
Inventory API Endpoints
Search for inventories
Search for inventories based on filter criteria.
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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 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.
Unique request ID
Query Parameters
Body
Sample request to search inventory
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.
EQ, NEQ, IN, NIN, LT, GT, LTE, GTE Field name
Group name
A single value to search inventory
Property by which data is sorted
Response
Inventory search response sample
Maximum restock inventory quantity
Time when backorder is shipped
Sales channel ID; identifies business operations location.
Merchant-defined inventory counter (also known as inventory position)
Merchant-defined inventory counter (also known as inventory position)
Time of inventory creation
Placeholder for additional info
Placeholder for additional info
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.
The fabric system-generated inventory ID. This ID is generated during inventory creation.
An attribute used to indicate that a SKU is out of stock.
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.
The time between when an order is placed to replenish inventory and when the order is received at warehouse.
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.
The lowStock parameter is used to alert low stock at a location when inventory is below a set number.
Code of the network to which the inventory belongs
Maximum first-shipping inventory quantity
Time when preorder is shipped
Region where inventory is managed
Reserved inventory quantity at the location
Product SKU (Stock Keeping Unit) identifier. It serves as the primary reference key for the inventory and provides uniqueness to the item.
Inventory status IN_STOCK, LOW_STOCK, etc.
IN_STOCK, LOW_STOCK, OUT_OF_STOCK, BACKORDER_STOCK, PREORDER_STOCK Inventory type - a classifier attribute that provides flexibility to define inventory types
Time when inventory was last updated
ID of the vendor who will replenish the inventory for the retailer
Pagination response
Total number of search results
Maximum number of records per page
1 < x < 100Number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.
x > 0Was this page helpful?
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
}
}