get https://{shopdomain}.myshoplaza.com/openapi/2022-01/center/transfer_orders//items
Requires
read_inventoryaccess scope.More access scope
The Transfer Order Product List API retrieves a detailed list of products associated with a specific transfer order based on the provided transfer_order_id. This API provides key product-level information such as quantities, product details, and related transfer information.
This API is especially useful for:
- Tracking products in a specific transfer order.
- Integrating detailed transfer product data into inventory or ERP systems.
- Auditing product-level details for a transfer order.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Description | Required | Example |
|---|---|---|---|---|
transfer_order_id | string | Transfer order ID to retrieve its product details. | Yes | "3951260339771676100" |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
count | int32 | Total number of products in the transfer order. | 1 |
products | array | List of product objects in the transfer order. | Array of objects |
products[].id | int64 | The unique identifier of the product in the transfer order. | 385728377899726800 |
products[].product_id | string | The unique identifier of the product. | "26a57e11-7d72-4d18-a139-e3a1985" |
products[].variant_id | string | The unique identifier of the product variant. | "f219bdf8-cff3-4ea7-99da-31597fa" |
products[].product_title | string | Title of the product. | "test1" |
products[].variant_title | string | Title of the product variant. | "1" |
products[].variant_image | object | Details of the product variant image. | Object |
products[].variant_image.src | string | URL of the product variant image. | "//img.staticdj.com/9fc005b037f5ac942fa..." |
products[].variant_image.alt | string | Alternate text for the image. | "" |
products[].variant_image.width | int32 | Width of the image in pixels. | 275 |
products[].variant_image.height | int32 | Height of the image in pixels. | 183 |
products[].variant_image.path | string | Path of the image file. | "9fc005b037f5ac942faabf06d2db9b0a.jpg" |
products[].variant_sku | string | SKU (Stock Keeping Unit) of the product variant. | "-1-A001111" |
products[].quantity | int32 | Total quantity of the product in the transfer order. | 1 |
products[].approved_quantity | int32 | Quantity of the product that has been approved for transfer. | 1 |
products[].shipped_quantity | int32 | Quantity of the product that has been shipped. | 1 |
products[].received_quantity | int32 | Quantity of the product that has been received. | 1 |
products[].requesting_warehouse_quantity | int32 | Quantity requested by the receiving warehouse. | 195 |
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 |