curl --request GET \
--url https://services.leadconnectorhq.com/products/inventory \
--header 'Authorization: Bearer <token>' \
--header 'Version: <version>'{
"inventory": [
{
"_id": "6241712be68f7a98102ba272",
"name": "Medium T-shirt",
"availableQuantity": 50,
"sku": "TSHIRT-MED-001",
"allowOutOfStockPurchases": false,
"product": "6241712be68f7a98102ba270",
"updatedAt": "2023-12-12T09:27:42.355Z",
"image": "https://example.com/images/product.jpg",
"productName": "T-shirt"
}
],
"total": {
"total": 100
}
}The “List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters.
curl --request GET \
--url https://services.leadconnectorhq.com/products/inventory \
--header 'Authorization: Bearer <token>' \
--header 'Version: <version>'{
"inventory": [
{
"_id": "6241712be68f7a98102ba272",
"name": "Medium T-shirt",
"availableQuantity": 50,
"sku": "TSHIRT-MED-001",
"allowOutOfStockPurchases": false,
"product": "6241712be68f7a98102ba270",
"updatedAt": "2023-12-12T09:27:42.355Z",
"image": "https://example.com/images/product.jpg",
"productName": "T-shirt"
}
],
"total": {
"total": 100
}
}Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
API Version
2021-07-28 The maximum number of items to be included in a single page of results
20
The starting index of the page, indicating the position from which the results should be retrieved.
0
Location Id or Agency Id
"6578278e879ad2646715ba9c"
location Search string for Variant Search
"Product Name"
Filter by track inventory status
true
Filter by allow out of stock purchases status
true
Filter by digital product status
false
Filter by minimum available quantity
10
Filter by maximum available quantity
100
Filter by collection IDs (comma-separated)
"64a1b2c3d4e5f6789abcdef0,64a1b2c3d4e5f6789abcdef1"
Was this page helpful?