get https://{shopdomain}.myshoplaza.com/openapi/2022-01/center/procurements//items
Requires
read_inventoryaccess scope.
The Procurement Order Product List API retrieves the list of products associated with a specific procurement order. This API provides details about the items, including their quantities, variants, and other related metadata.
This API is especially useful for:
- Viewing the products included in a procurement order.
- Tracking the quantities and status of specific items in the procurement process.
- Managing product-level details for inventory or logistics purposes.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Description | Required | Example |
|---|---|---|---|---|
procurement_id | string | Unique identifier of the procurement order. | Yes | "385070142252984200" |
limit | string | Limit per page for the number of items returned. | Yes | "10" |
page | string | Page number for pagination. | Yes | "1" |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
count | int32 | Total number of items in the procurement order. | 1 |
items | array | List of items in the procurement order. | |
items[].procurement_item_id | int64 | Unique identifier for the procurement item. | 385700142268825400 |
items[].transfer_quantity | int32 | Quantity of the item transferred. | 10 |
items[].pending_quantity | int32 | Quantity of the item pending procurement. | 0 |
items[].received_quantity | int32 | Quantity of the item received. | 10 |
items[].rejected_quantity | int32 | Quantity of the item rejected. | 0 |
items[].variant_id | string | Unique identifier of the product variant. | "1c5b9912-42af-41cb-bf7d-df609be87d20" |
items[].product_id | string | Unique identifier of the product. | "ac0b5372-4396-4415-979a-64e835abfd5b" |
items[].product_image | object | Metadata about the product's image. | |
items[].product_image.src | string | Source URL of the product image. | "//cdn.shoplazza.com/e1d7b475be103047d49d63c521ed0305.jpeg" |
items[].product_image.alt | string | Alt text for the product image. | "" |
items[].product_image.width | int32 | Width of the product image. | 780 |
items[].product_image.height | int32 | Height of the product image. | 780 |
items[].product_image.path | string | Path of the product image in the storage system. | "e1d7b475be103047d49d63c521ed0305.jpeg" |
items[].product_title | string | Title of the product. | "0415" |
items[].variant_title | string | Title of the product variant. | "" |
items[].created_at | string | Timestamp indicating when the procurement item was created. | "2024-05-30T07:54:40Z" |
items[].updated_at | string | Timestamp indicating when the procurement item was last updated. | "2024-05-30T07:55:03Z" |
items[].variant_delete | int32 | Indicator if the variant is deleted. | 0 |
items[].purchase_price | int32 | Purchase price of the item. | 0 |
items[].variant_sku | string | SKU of the product variant. | "--A001125" |
items[].lot_number | string | Lot number of the item. | "20240530" |
items[].expiration_date | string | Expiration date of the item, if applicable. | "2026-05-29T17:00:00Z" |
items[].shipped_quantity | int32 | Quantity of the item shipped. | 0 |
items[].shipped_received_quantity | int32 | Quantity of the item shipped and received. | 0 |
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 | String | "page not found" | Indicates an error encountered during the process |
Error Detail
| 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). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized |