Inventory Consumption List

Retrieve a list of consumption inventory updates per printJob for a partner. Supports optional filtering by date range, partner SKU, and print job IDs.

POST /procurement/v1/inventory/consumption/list

Authentication

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

Request example

{
  "filterBy": {
    "dateFrom": "2026-01-01T00:00:00Z",
    "dateTo": "2026-03-31T23:59:59Z",
    "partnerSku": ["SKU-001"],
    "printJobId": [12345, 67890]
  },
  "pagination": {
    "pageNumber": 1,
    "perPage": 100
  }
}

Success response example

{
  "items": [
    {
      "printJobId": 12345,
      "partnerSku": "SKU-001",
      "productName": "Cotton T-Shirt White L",
      "quantity": 5,
      "createdAt": "2026-03-14 10:00:00+00:00"
    }
  ],
  "pagination": {
    "pageNumber": 1,
    "perPage": 100,
    "totalResult": 1
  }
}

Error response example

{
  "error": "Invalid credentials"
}

Request

Parameter	Type	Description
filterBy (optional)	object	Filter criteria for the update list.
filterBy.dateFrom (optional)	string	Start date in ISO 8601 format. Sample: 2026-01-01T00:00:00Z.
filterBy.dateTo (optional)	string	End date in ISO 8601 format. Defaults to now if dateFrom is set.
filterBy.partnerSku (optional)	array	Array of partner SKUs to filter by.
filterBy.printJobId (optional)	array	Array of print job IDs to filter by.
pagination (optional)	object	Pagination parameters.
pagination.pageNumber	integer	Page number (1-based). Sample: 1.
pagination.perPage	integer	Number of items per page. Default: 1000. Sample: 100.

Success response

Parameter	Type	Description
items	array	Array of inventory update items.
items[].printJobId	integer	Print job ID. Sample: 12345.
items[].partnerSku	string	Partner SKU. Sample: SKU-001.
items[].productName	string	Product name (nullable). Sample: Cotton T-Shirt White L.
items[].quantity	integer	Quantity reserved. Sample: 5.
items[].createdAt	string	Created at in ISO 8601 format.
pagination	object	Pagination info.
pagination.pageNumber	integer	Current page number. Sample: 1.
pagination.perPage	integer	Number of items per page. Sample: 100.
pagination.totalResult	integer	Total number of matching items. Sample: 1.

HTTP Status Codes

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