get https://{shopdomain}.myshoplaza.com/openapi/2022-01/center/transfer_orders/
Requires
read_inventoryaccess scope.More access scope
The Transfer Order Detail API retrieves detailed information about a specific transfer order based on the transfer_order_id. This API provides key details such as transfer status, quantities, timestamps, and associated location information.
This API is especially useful for:
- Viewing detailed transfer order information for auditing or tracking purposes.
- Integrating transfer order details into inventory management systems.
- Verifying transfer quantities and statuses.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Description | Required | Example |
|---|---|---|---|---|
transfer_order_id | string | Transfer order ID to retrieve its details. | Yes | "3951260339771676100" |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
transfer_order | object | The transfer order object containing detailed information. | Object |
transfer_order.id | int64 | The unique identifier for the transfer order. | 3951260339771676100 |
transfer_order.order_no | string | Transfer order number. | "TF2024062500005" |
transfer_order.source_location_id | int64 | The unique identifier of the source location. | 328078441158026100 |
transfer_order.source_location_name | string | Name of the source location. | "Warehouse A" |
transfer_order.target_location_id | int64 | The unique identifier of the target location. | 329153840243645400 |
transfer_order.target_location_name | string | Name of the target location. | "Warehouse B" |
transfer_order.status | int32 | Status of the transfer order. Refer to the status enum for possible values. | 4 |
transfer_order.note | string | Additional notes for the transfer order. | "Urgent Transfer" |
transfer_order.finished_at | string | Timestamp when the transfer order was finished. | "2024-06-25T08:07:01Z" |
transfer_order.created_at | string | Timestamp when the transfer order was created. | "2024-06-25T08:05:49Z" |
transfer_order.updated_at | string | Timestamp when the transfer order was last updated. | "2024-06-25T08:07:01Z" |
transfer_order.reject_note | string | Notes explaining the rejection of the transfer order, if applicable. | "" |
transfer_order.total_quantity | int32 | Total quantity of items in the transfer order. | 0 |
transfer_order.shipped_quantity | int32 | Quantity of items that have been shipped. | 0 |
transfer_order.received_quantity | int32 | Quantity of items that have been received. | 0 |
transfer_order.transfer_at | string | Timestamp when the transfer order was initiated. | "2024-06-25T08:05:49Z" |
transfer_order.transfer_quantity | int32 | Quantity of items transferred in the order. | 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 |