get
https://{subdomain}.myshoplaza.com/openapi/2025-06/procurements//items
Retrieves the items associated with a given procurement ID.
Requiresread_inventoryaccess scope. More access scope
The Get Procurement Item List API allows users to retrieves a paginated list of all items associated with a specific procurement order.
This API is especially useful for:
- Reviewing all products included in a procurement order.
- Tracking quantities (pending, received, rejected) for inventory management.
- Auditing procurement fulfillment status.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
procurement_id | string | Yes | Unique identifier of the procurement order | "proc_123456789" |
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
cursor | string | No | Pagination cursor for next page | "eyJpZCI6IjEyMzQ1Njc4OSI=" |
page_size | int32 | No | Number of items per page (1-100) | 25 |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "200" | HTTP status code |
message | string | "Success" | Operation result message |
data.items | array of objects | - | List of procurement items |
data.items.id | string | "item_987654" | Unique item identifier |
data.items.procurement_id | string | "proc_123456789" | Parent procurement ID |
data.items.pending_quantity | int32 | 50 | Quantity awaiting fulfillment |
data.items.received_quantity | int32 | 30 | Quantity successfully received |
data.items.rejected_quantity | int32 | 5 | Quantity rejected/returned |
data.items.transfer_quantity | int32 | 15 | Quantity in transit |
data.items.variant_id | string | "var_456789" | Product variant ID |
data.items.product_id | string | "prod_123456" | Parent product ID |
data.items.product_title | string | "Wireless Headphones" | Product display name |
data.items.variant_title | string | "Black Edition" | Variant display name |
data.items.variant_sku | string | "WH-BLK-2025" | Stock keeping unit |
data.items.created_at | string | "2025-06-01T09:00:00Z" | Item creation timestamp |
data.items.updated_at | string | "2025-06-15T14:30:00Z" | Last update timestamp |
data.items.product_image | object | - | Product image details |
data.items.product_image.src | string | "https://example.com/image.jpg" | Image URL |
data.items.product_image.width | int32 | 800 | Image width in pixels |
data.items.product_image.height | int32 | 600 | Image height in pixels |
data.items.product_image.alt | string | "Wireless Headphones Black" | Image alt text |
data.cursor | string | "eyJpZCI6IjEyMzQ1Njc4O" | Next page cursor |
data.has_more | boolean | true | Whether more items exist |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |