Skip to content

POST /2025-07/cloud/inbound

Method: POST

URL:

Sandbox URL:

Description: Create inbound order.

Parameters required to be sent

ParameterDescriptionType
carrierCarrier. The maximum length is 32.String
tracking_noTracking No.String
expected_inbound_dateExpected inbound date, format (yyyy-MM-dd).String
itemsObject, Required
  quantityQuantity for the product.Number, Required
  sku_numberSKU No. for the product.String, Required
package_numberPackage number. 0 means "I'm not sure yet".Number, Required
referenceReference of the inbound order. The maximum length is 47.String
remarksRemarks.String
shipperShipper address.Object
  first_nameFirst name. The maximum length is 64.String
  last_nameLast name. The maximum length is 64.String, Required
  emailEmail. The maximum length is 128.String, must have @
  phonePhone number. The maximum length is 32.String, Required
  address1Address. The maximum length is 256.String, Required
  address2Address 2. The maximum length is 256.String
  zip_codeZip code. The maximum length is 15.String
  districtDistrict. The maximum length is 60.String
  cityCity. The maximum length is 60.String, Required
  provinceProvince. The maximum length is 60.String, Required
  countryCountry. The maximum length is 60.String, Required
  company_nameCompany name.String, Required
warehouse_codeWarehouse code.String, Required

Body

json
{
  "carrier": "sf-express",
  "tracking_no": "SF7444400088263",
  "expected_inbound_date": "2019-06-03",
  "items": [
    {
      "quantity": 2,
      "sku_number": "iphone-4"
    },
    {
      "quantity": 1,
      "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"
}

Response

Response payload.

Payload return an error with the description and data = empty. If the request is successful, the data contains an object with the result.

json
{
  "code": 200,
  "message": "Successful!",
  "data": 443513787594258323
}