Inventory List

Retrieve the inventory list for a partner. Supports optional filtering by partner SKU and pagination.

POST /procurement/v1/inventory/list

Authentication

Include your API key in the X-API-KEY header.

Request example

{
  "filterBy": {
    "partnerSku": ["SKU-001", "SKU-002"]
  },
  "pagination": {
    "pageNumber": 1,
    "perPage": 20
  }
}

Success response example

{
  "inventoryItem": [
    {
      "partnerSku": "SKU-001",
      "alertUid": null,
      "quantity": 70,
      "minStock": 50,
      "maxStock": 150,
      "quantityOrdered": 0
    },
    {
      "partnerSku": "SKU-002",
      "alertUid": "out_of_stock",
      "quantity": 0,
      "minStock": 50,
      "maxStock": 55,
      "quantityOrdered": 0
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "perPage": 20,
    "totalPages": 1,
    "totalItems": 2
  }
}

Error response example

{
  "error": "Invalid credentials"
}

Request

Parameter	Type	Description
filterBy (optional)	object	Filter criteria for the inventory list.
filterBy.partnerSku (optional)	array	Array of partner SKUs to filter by. If empty or omitted, returns all items.
pagination (optional)	object	Pagination parameters.
pagination.pageNumber	integer	Page number (1-based). Sample: 1.
pagination.perPage	integer	Number of items per page. Sample: 20.

Success response

Parameter	Type	Description
inventoryItem	array	Array of inventory items.
inventoryItem[].partnerSku	string	The partner SKU. Sample: SKU-001.
inventoryItem[].alertUid	string	Alert status: null, out_of_stock, back_order, etc. Sample: null.
inventoryItem[].quantity	integer	Current stock quantity. Sample: 70.
inventoryItem[].minStock	integer	Minimum stock threshold. Sample: 50.
inventoryItem[].maxStock	integer	Maximum stock threshold. Sample: 150.
inventoryItem[].quantityOrdered	integer	Quantity currently on order. Sample: 0.
pagination	object	Pagination info. null if no pagination was requested.

HTTP Status Codes

Status	Description
200	Inventory list returned successfully
400	Validation error
403	Invalid or missing API key