Skip to content
Fulfilment
/
/
Get Inventory

Get Inventory

Request

Lists the stock of every SKU on your account, one page at a time. Filter by sku, product_name or vendor. A page holds 20 items unless you send limit.

Security
BearerAuth or OAuth2
Query
limitinteger, (int64)

Items per page, 1 to 100. Defaults to 20.

pageinteger, (int64)

Page number, starting at 1. Defaults to 1.

skustring

Return only this SKU.

product_namestring

Filter inventory by product name.

vendorstring

Filter inventory by vendor name.

sortstring

Field to sort by.

sort_descboolean

Sort in descending order when true.

curl -i -X GET \
  'https://platform-api.quiqup.com/api/fulfilment/inventory?limit=&page=&sku=&product_name=&vendor=&sort=&sort_desc=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success response

Bodyapplication/json
inventoryArray of objects(InventoryItem)required

Array of inventory items.

paginationobject(PaginationMeta)required

Where this page sits in the full list.

Response
{
  "inventory": [
    { … }
  ],
  "pagination": {
    "next": { … },
    "next_url": "string",
    "prev": { … },
    "prev_url": "string",
    "total": 0
  }
}