Skip to main content

List Inventory Items

Retrieve a paginated list of inventory items for an item-tracked store product.

Endpointโ€‹

GET /v1/store-products/{id}/inventory-items

Authenticationโ€‹

Requires an API key with the store:read scope.

Parametersโ€‹

ParameterTypeLocationDescription
idintegerpathThe store product ID

Query Parametersโ€‹

ParameterTypeDefaultDescription
pageinteger1Page number
per_pageinteger15Items per page (max 100)
searchstring-Search by identifier or unique identifier
variation_idinteger-Filter by product variation ID
location_idinteger-Filter by supplier location ID (see Locations)

Responseโ€‹

Success (200 OK)โ€‹

{
"data": [
{
"id": 1,
"store_product_id": 5,
"store_product_variation_id": null,
"identifier": "WIDGET-1",
"unique_identifier": "INV-00001",
"total_quantity": 1,
"supplier_location": {
"id": 1,
"name": "Main Store"
},
"has_barcode": true,
"created_at": "2026-02-13T12:00:00+00:00",
"updated_at": "2026-02-13T12:00:00+00:00"
},
{
"id": 2,
"store_product_id": 5,
"store_product_variation_id": 3,
"identifier": "WIDGET-2",
"unique_identifier": "INV-00002",
"total_quantity": 1,
"supplier_location": null,
"has_barcode": false,
"created_at": "2026-02-13T12:00:00+00:00",
"updated_at": "2026-02-13T12:00:00+00:00"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 2,
"total_pages": 1,
"request_id": "req_abc123",
"timestamp": "2026-02-13T12:00:00+00:00"
}
}

Response Fieldsโ€‹

Inventory Itemโ€‹

FieldTypeDescription
idintegerUnique inventory item identifier
store_product_idintegerThe parent store product ID
store_product_variation_idinteger|nullAssociated product variation ID (null if not variation-specific)
identifierstring|nullItem identifier (e.g., serial number, asset tag)
unique_identifierstring|nullSystem-generated unique identifier
total_quantityintegerAlways 1 for item-tracked products
supplier_locationobject|nullSupplier location (id, name) if assigned
has_barcodebooleanWhether this item has a barcode attached
created_atstringISO 8601 datetime
updated_atstringISO 8601 datetime

Errorsโ€‹

StatusCodeDescription
401authentication_requiredNo API key provided
401invalid_api_keyInvalid API key
403insufficient_scopeAPI key lacks store:read scope
404resource_not_foundStore product does not exist
422not_item_trackedProduct does not use item-level inventory tracking

Example Requestโ€‹

curl -X GET "https://app.equipdash.com/api/v1/store-products/5/inventory-items?per_page=25" \
-H "Authorization: Bearer eqd_live_abc123xyz789..."