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 | Example | Description |
|---|---|---|---|
count |
int32 | 1 |
Total number of products in the transfer order. |
products |
array | Array of objects | List of product objects in the transfer order. |
products[]. |
int64 | 385728377899726800 |
The unique identifier of the product in the transfer order. |
products[]. |
string | "26a57e11-7d72-4d18-a139-e3a1985" |
The unique identifier of the product. |
products[]. |
string | "f219bdf8-cff3-4ea7-99da-31597fa" |
The unique identifier of the product variant. |
products[]. |
string | "test1" |
Title of the product. |
products[]. |
string | "1" |
Title of the product variant. |
products[]. |
object | Object | Details of the product variant image. |
products[]. |
string | "//img.staticdj.com/9fc005b037f5ac942fa..." |
URL of the product variant image. |
products[]. |
string | "" |
Alternate text for the image. |
products[]. |
int32 | 275 |
Width of the image in pixels. |
products[]. |
int32 | 183 |
Height of the image in pixels. |
products[]. |
string | "9fc005b037f5ac942faabf06d2db9b0a.jpg" |
Path of the image file. |
products[]. |
string | "-1-A001111" |
SKU (Stock Keeping Unit) of the product variant. |
products[]. |
int32 | 1 |
Total quantity of the product in the transfer order. |
products[]. |
int32 | 1 |
Quantity of the product that has been approved for transfer. |
products[]. |
int32 | 1 |
Quantity of the product that has been shipped. |
products[]. |
int32 | 1 |
Quantity of the product that has been received. |
products[]. |
int32 | 195 |
Quantity requested by the receiving warehouse. |
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 |