🔒
Requires read_product access scope. More access scope

The List Procurement Items API retrieves the items associated with a given procurement ID.

Use Cases

Fetching all items under a specific procurement.
Checking the quantity and details of items in procurement.
Managing and tracking procurement inventory.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Path Parameters

Parameter	Type	Required	Example	Description
`id`	`string`	Yes	`"38270644320102839"`	The unique identifier of the procurement.

Body Parameters

Parameter	Type	Required	Example	Description
`page`	`integer`	No	`1`	The page number for pagination. Default: `1`.
`limit`	`integer`	No	`10`	The number of records per page (Min: `1`, Max: `100`).

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Success Response

Field	Type	Example	Description
`id`	`string`	`"38276477 153919276"`	Unique identifier for the procurement item.
`procurement_id`	`string`	`"382706443 20102839"`	ID of the procurement to which this item belongs.
`pending_quantity`	`integer`	`100`	Number of units pending in the procurement.
`received_quantity`	`integer`	`0`	Number of units received in the procurement.
`rejected_quantity`	`integer`	`0`	Number of units rejected in the procurement.
`transfer_quantity`	`integer`	`100`	Number of units transferred.
`variant_id`	`string`	`"4f442546-3a6 0-43b2-ba..."`	Unique identifier of the product variant.
`product_id`	`string`	`"cbf9e2d2-7f2 c-4881-ab..."`	Unique identifier of the product.
`product_title`	`string`	`"Test"`	The title of the product.
`variant_sku`	`string`	`""`	The SKU of the variant (if available).
`created_at`	`string`	`"2024-05-22T 01:38:54Z"`	Timestamp when the item was created.
`updated_at`	`string`	`"2024-05-22T01 :38:54Z"`	Timestamp when the item was last updated.
`product_image.src`	`string`	`"//img.staticdj .com/c8bf56..."`	URL of the product image.
`product_image.width`	`integer`	`710`	Width of the product image.
`product_image.height`	`integer`	`799`	Height of the product image.

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

Field	Type	Example	Description
`error`	Array	`"store is not active"`	Indicates an error encountered during the process.

Error Details

Status Code	Message	Possible Reason	Example Response
400	Bad Request	Invalid input format or request structure (e.g., missing required fields or incorrect data types).	`{ "errors": [ "invalid procurement_id"]}`
	Unauthorized	The request is missing valid authentication credentials or the credentials provided are invalid.	`Unauthorized`

API Structure Overview