Inventory Restock List
GET
{{api_url}}/shop/inventory/restockReturns every parent product and child SKU whose total on-hand inventory, summed across all warehouses, is at or below its reorder point.
Results include both parent products and child SKUs, identified by item_type, and are sorted by item_type and then item_id, so pages stay consistent between calls.
Query parameters
| Parameter | Type | Description |
|---|---|---|
limit | integer | Number of items to return. Maximum 100. |
limit_start | integer | Number of items to skip before returning results. Use it with limit to page: limit=100&limit_start=100 returns items 101 through 200. |
just_count | integer | Set to 1 to return only the number of items that need restocking instead of the items themselves. |
Response fields
| Field | Description |
|---|---|
item_type | parent for a parent product, child for a child SKU. |
sku | The parent's base SKU, or the child's SKU. |
item_id | The InfiPlex product ID for parents, or the SKU ID for children. |
restock_delivery_lead_time | The restock delivery lead time set on the item. |
restock_safety_stock_level | The safety stock level set on the item. |
reorder_point | The inventory level at or below which the item needs restocking. |
total_inventory | Total on-hand quantity across all warehouses. |
Items with no warehouse inventory records are not returned.
Count response
With just_count=1, the response contains a single field, restock_skus_count: the total number of parent products and child SKUs that need restocking, returned as a string.
{
"restock_skus_count": "16"
}
Authorization
Bearer token, sent in the Authorization header. Inherited from the collection.
Query Parameters
| Key | Value | Description |
|---|---|---|
just_count optional | 1 | Set to 1 if you want a count of restock skus found |
limit optional | If this is set, then only this number of results will be returned | |
limit_start optional | If 100 results are returned and this is set to 25, the first 25 results will be omitted |
Example Request
curl --location --request GET '{{api_url}}/shop/inventory/restock' \
--header 'Authorization: Bearer {{auth_token}}'Example Responses
Inventory Restock List
Request
curl --location --request GET '{{api_url}}/shop/inventory/restock?just_count=0&limit=50&limit_start=0' \
--header 'Authorization: Bearer YOUR_API_KEY'Response 200 OK
{
"restock_skus": [
{
"item_type": "child",
"sku": "A76_R_S_R",
"item_id": "252",
"restock_delivery_lead_time": "9",
"restock_safety_stock_level": "1",
"reorder_point": "1",
"total_inventory": "-5"
},
{
"item_type": "child",
"sku": "VadorTee-4",
"item_id": "334",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "-4"
},
{
"item_type": "child",
"sku": "A76_R_X_B_f_R_S_B",
"item_id": "427",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "0"
},
{
"item_type": "child",
"sku": "A76_R_X_N",
"item_id": "453",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "0"
},
{
"item_type": "parent",
"sku": "L0818",
"item_id": "31",
"restock_delivery_lead_time": "3",
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "-1"
},
{
"item_type": "parent",
"sku": "VadorTee-1",
"item_id": "42",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "4"
},
{
"item_type": "parent",
"sku": "VadorTee-2",
"item_id": "43",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "0"
},
{
"item_type": "parent",
"sku": "VadorTee-3",
"item_id": "44",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "0"
},
{
"item_type": "parent",
"sku": "E038",
"item_id": "108",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "-6"
},
{
"item_type": "parent",
"sku": "08756-1",
"item_id": "116",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "-1"
},
{
"item_type": "parent",
"sku": "SKU_NO_STOCK1",
"item_id": "203",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "-320"
},
{
"item_type": "parent",
"sku": "SKU_EOL_STOCK1",
"item_id": "204",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "-143"
},
{
"item_type": "parent",
"sku": "4056",
"item_id": "206",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "-2"
},
{
"item_type": "parent",
"sku": "1234567891234",
"item_id": "209",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "-13"
},
{
"item_type": "parent",
"sku": "SKU_INVALID_STOCK1",
"item_id": "210",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "-98"
},
{
"item_type": "parent",
"sku": "781975411992",
"item_id": "226",
"restock_delivery_lead_time": null,
"restock_safety_stock_level": null,
"reorder_point": "5",
"total_inventory": "-26"
}
],
"restock_skus_count": "16"
}