Get Inventory By SKU

Request

Returns the stock of one SKU, split into buckets. Sell against available: total also counts stock that is reserved, damaged or on QC hold. For a product with expiry management, expiry_groups groups the quantity by expiry date.

Security

BearerAuth or OAuth2

Path

skustringrequired

The product SKU.

curl -i -X GET \
  'https://platform-api.quiqup.com/api/fulfilment/inventory/{sku}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success response

Bodyapplication/json

availableinteger, (int64)

On the shelf and sellable. Sell against this number.

coststring

Unit cost on the inventory record, as a decimal string.

created_atstring, (date-time)

Timestamp when the inventory record was created.

damagedinteger, (int64)

Quantity of damaged items.

expiry_groupsArray of objects(ExpiryGroup)

Quantity grouped by expiry date, for products with expiry management.

inbound_statestring(InboundState)

active or inactive.

Enum:"active""inactive"

productobject(Product)

A product.

product_idstring

Quiqup's id for the product.

qc_holdinteger, (int64)

Quantity of items on QC hold.

reservedinteger, (int64)

Committed to orders being picked.

totalinteger, (int64)

Sum of available, damaged, reserved and qc_hold.

trackedboolean

Whether inventory tracking is enabled for this item.

updated_atstring, (date-time)

Timestamp when the inventory record was last updated.

vendorstring

Vendor or brand name of the product.

Response

{
  "available": 180,
  "cost": "22.50",
  "damaged": 2,
  "expiry_groups": [],
  "inbound_state": "active",
  "product_id": "10432",
  "qc_hold": 0,
  "reserved": 10,
  "total": 192,
  "vendor": "Example Brand"
}