GET /2025-07/cloud/inbound/{inbound_id}
Method: GET
URL:
Sandbox URL:
Description: Get inbound order details.
Parameters required to be sent
| Parameter | Description | Type |
|---|---|---|
inbound_id | Inbound ID. | Long, Required |
Submit a "GET" request to above endpoint
Result object contains:
| Parameter | Description | Type |
|---|---|---|
id | Inbound ID. | Long |
carrier | Carrier. The maximum length is 32. | String |
tracking_no | Tracking No. | String |
expected_inbound_date | Expected inbound date. | Date Time |
actual_inbound_at | Actual inbound time. | Date Time |
items | Object | |
expect_quantity | Expect quantity. | Number |
actual_quantity | Actual quantity. | Number |
still_need_quantity | Still need quantity. | Number |
sku_number | SKU No. for the product. | String |
package_number | Package number. | Number |
reference | Reference of the inbound order. The maximum length is 47. | String |
remarks | Remarks. | String |
shipper | Shipper address. | Object |
first_name | First name. The maximum length is 64. | String |
last_name | Last name. The maximum length is 64. | String |
email | Email. The maximum length is 128. | String |
phone | Phone number. The maximum length is 32. | String |
address1 | Address. The maximum length is 256. | String |
address2 | Address 2. The maximum length is 256. | String |
zip_code | Zip code. The maximum length is 15. | String |
district | District. The maximum length is 60. | String |
city | City. The maximum length is 60. | String |
province | Province. The maximum length is 60. | String |
country | Country. The maximum length is 60. | String |
company_name | Company name. | String |
status | Status: Pending, Partial, Completed, Cancelled, Failure. | String |
warehouse_code | Warehouse code. | String |
exceptional | Exceptional. | Boolean |
feedback | eg:sku Toy Bird: expect quantity is 100, but actual quantity is 103. | String |
print_times | Print times. | Number |
Response
json
{
"code": 200,
"message": "Successful",
"data": {
"id": 443513787594258312,
"carrier": "sf-express",
"tracking_no": "SF7444400088263",
"expected_inbound_date": "2019-06-03",
"actual_inbound_at": null,
"items": [
{
"expect_quantity": 10,
"actual_quantity": 0,
"still_need_quantity": 10,
"sku_number": "iphone-4"
},
{
"expect_quantity": 20,
"actual_quantity": 0,
"still_need_quantity": 20,
"sku_number": "iphone-5"
}
],
"package_number": 1,
"reference": "#20190603001",
"remarks": "Please take it lightly, thank you!",
"shipper": {
"address1": "3131 Las Vegas Blvd. South",
"address2": "",
"city": "Shenzhen",
"country": "China",
"district": "Nanshan",
"email": "arthur@zhenhub.com",
"first_name": "Arthur",
"last_name": "Chen",
"phone": "+852 3152xxxx",
"province": "Guangdong",
"zip_code": "518000",
"company_name": "Testing Company"
},
"warehouse_code": "warehouse01",
"status": "Pending",
"exceptional": false,
"feedback": null,
"print_times": 0
}
}