get https://{shopdomain}.myshoplaza.com/openapi/2022-01/center/transfer_orders
Requires
read_inventoryaccess scope.More access scope
The Transfer Order List API retrieves a paginated list of transfer orders. It supports filtering by various parameters such as status, creation date, update date, and specific transfer order IDs.
This API is especially useful for:
- Managing transfer orders efficiently by filtering based on custom parameters.
- Fetching detailed information about transfer orders for reporting and analysis.
- Tracking transfer quantities and statuses between different locations.
Request Parameters
Public Request Parameters
Query Parameters
| Field | Type | Description | Required | Example |
|---|---|---|---|---|
status | int32 | Transfer order status. | No | 4 |
created_at_min | string | Filter transfer orders created at or after this date (ISO 8601 format). | No | 2016-01-18T23:41:00Z |
created_at_max | string | Filter transfer orders created at or before this date (ISO 8601 format). | No | 2016-01-18T23:41:00Z |
updated_at_min | string | Filter transfer orders last updated at or after this date (ISO 8601 format). | No | 2016-01-18T23:41:00Z |
updated_at_max | string | Filter transfer orders last updated at or before this date (ISO 8601 format). | No | 2016-01-18T23:41:00Z |
page | string | Page number for pagination. Defaults to 1 if not specified. | No | 1 |
limit | string | Limit per page for pagination. Defaults to 20. | No | 20 |
ids | string | Comma-separated transfer order IDs to filter specific orders. | No | "372226531310714835,371900642131722195" |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
count | int32 | Total number of transfer orders retrieved. | 1 |
transferOrders | array | List of transfer orders. | Array of objects |
transferOrders.id | int64 | The unique identifier for the transfer order. | 372226531310714800 |
transferOrders.order_no | string | Transfer order number. | "TF202404230001" |
transferOrders.source_location_id | int64 | The unique identifier of the source location. | 333849256890743900 |
transferOrders.source_location_name | string | Name of the source location. | "Warehouse A" |
transferOrders.target_location_id | int64 | The unique identifier of the target location. | 278480468976865150 |
transferOrders.target_location_name | string | Name of the target location. | "Warehouse B" |
transferOrders.status | int32 | Status of the transfer order. Refer to the status enum for possible values. | 4 |
transferOrders.note | string | Additional notes for the transfer order. | "Urgent Transfer" |
transferOrders.finished_at | string | Timestamp when the transfer order was finished. | "2024-04-23T05:43:03Z" |
transferOrders.created_at | string | Timestamp when the transfer order was created. | "2024-04-23T03:35:21Z" |
transferOrders.updated_at | string | Timestamp when the transfer order was last updated. | "2024-05-20T15:59:30Z" |
transferOrders.reject_note | string | Notes explaining the rejection of the transfer order, if applicable. | "" |
transferOrders.total_quantity | int32 | Total quantity of items in the transfer order. | 100 |
transferOrders.shipped_quantity | int32 | Quantity of items that have been shipped. | 20 |
transferOrders.received_quantity | int32 | Quantity of items that have been received. | 20 |
transferOrders.transfer_at | string | Timestamp when the transfer order was initiated. | "2024-04-23T03:35:21Z" |
transferOrders.transfer_quantity | int32 | Quantity of items transferred in the order. | 20 |
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 |