Skip to content
/
Get Inventory

Fulfilment API (1.0.0)

This is the API documentation for the Fulfilment API.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer-docs.quiqup.com/_mock/openapi/
Production
https://platform-api.quiqup.com/
Staging
https://platform-api.staging.quiqup.com/

Fulfilment Inbound

Operations

Fulfilment Inventory

Operations

Get Inventory

Request

List All Inventory

📌 Description

This endpoint retrieves a list of all inventory items stored in the fulfilment centre under your account. Clients can filter the results using query parameters such as SKU or product ID.

🔹 Use Cases

  • Checking stock levels before placing new orders.
  • Filtering inventory to track specific products.
  • Verifying stock availability for customer fulfilment.
Security
OAuth2
Query
limitinteger(int64)

Maximum number of items to return per page (1-100)

pageinteger(int64)

Page number to return (starts at 1)

skustring

Filter inventory by product SKU

product_namestring

Filter inventory by product name

sortstring

Field to sort results by

sort_descboolean

Sort in descending order if true

curl -i -X GET \
  'https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/inventory?limit=0&page=0&sku=string&product_name=string&sort=string&sort_desc=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success response

Bodyapplication/json
inventoryArray of objects(Array of inventory items )required
inventory[].​availableinteger(int64)(Current available quantity )
inventory[].​coststring(Cost of the inventory item )
inventory[].​created_atstring(date-time)(Timestamp when the record was created )
inventory[].​expiry_groupsArray of objects(Groups of inventory by expiry date )
inventory[].​inbound_statestring(InboundState represents the current state of inbound inventory )
inventory[].​productobject(Detailed product information )
inventory[].​product_idstring(Reference to the associated product )
inventory[].​trackedboolean(Whether inventory tracking is enabled )
inventory[].​updated_atstring(date-time)(Timestamp when the record was last updated )
paginationobject(pagination.PaginationMeta)required
pagination.​nextobject(pagination.PaginationRequest)
pagination.​next_urlstring
pagination.​prevobject(pagination.PaginationRequest)
pagination.​prev_urlstring
pagination.​totalinteger(int64)required
Response
application/json
{
  "inventory": [
    { … }
  ],
  "pagination": {
    "next": { … },
    "next_url": "string",
    "prev": { … },
    "prev_url": "string",
    "total": 0
  }
}

Get Inventory By SKU

Request

Get Inventory for a Specific Product

📌 Description

This endpoint retrieves inventory details for a specific product using its unique productId. The response includes stock availability, storage location, and last update timestamp.

🔹 Use Cases

  • Checking real-time stock levels for a specific product.
  • Verifying if a product is available in a fulfilment centre.
  • Monitoring stock movements to optimise replenishment.
Security
OAuth2
Path
skustringrequired
curl -i -X GET \
  'https://developer-docs.quiqup.com/_mock/openapi/api/fulfilment/inventory/{sku}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success response

Bodyapplication/json
availableinteger(int64)(Current available quantity in stock )
coststring(Cost of the inventory item )
created_atstring(date-time)(Timestamp when the inventory record was created )
expiry_groupsArray of objects(Groups of inventory by expiry date )
inbound_statestring(InboundState represents the current state of inbound inventory )
productobject(types.Product)
product_idstring(Reference to the associated product )
trackedboolean(Whether inventory tracking is enabled for this item )
updated_atstring(date-time)(Timestamp when the inventory record was last updated )
Response
application/json
{
  "available": 0,
  "cost": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "expiry_groups": [
    { … }
  ],
  "inbound_state": "string",
  "product": {
    "availability_status": 0,
    "barcode": "string",
    "cost_price": 0,
    "country_code_of_origin": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "currency": "AED",
    "description": "string",
    "dimensions": {},
    "harmonized_system_code": "string",
    "id": "string",
    "image": "string",
    "inventory_tracked": true,
    "name": "string",
    "partner_product_id": "string",
    "platform_price": 0,
    "requires_shipping": true,
    "retail_price": 0,
    "selling_price": 0,
    "sku": "string",
    "status": "active",
    "total_sales": 0,
    "track_expiry": true,
    "type": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "vendor": "string",
    "weight": 0,
    "weight_unit": "string"
  },
  "product_id": "string",
  "tracked": true,
  "updated_at": "2019-08-24T14:15:22Z"
}

Fulfilment Orders

Operations

Fulfilment Products

Operations