Open Api
  1. Inbound order API
Open Api
  • Inbound order API
    • queryInboundListDetail
      POST
    • queryInventoryList
      POST
    • Inventory list
      POST
    • queryInboundList
      POST
    • queryInboundDetail
      POST
    • saveInboundInfo
      POST
    • modifyInboundInfo
      POST
    • inboundSubmit
      POST
    • Inbound order cancel
      POST
  • API service controller
    • Generate appKey and appSecret credentials.
      POST
    • Get appKey and appSecret information
      GET
    • Get app information list
      POST
    • Create API access token
      POST
    • Get API access token
      POST
  • Outbound order API
    • modifyOutbound
      POST
    • saveInboundInfo
      POST
  • Sku API
    • order list
      POST
  • Return order API
    • Untitled Endpoint
      POST
    • Untitled Endpoint
      POST
  1. Inbound order API

saveInboundInfo

POST
/inbound/save

Request

Body Params application/json
appKey
string 
required
appKey (8位)
The value of app key
accessToken
string 
required
The value of access token
timestamp
integer 
required
Request timestamp
sign
string 
required
Request sign
saveInbound
object (SaveInbound) 
required
Inbound entity
expectedShipmentTime
string 
required
todo 时间校验?
Expected Arrival time,Date format: yyyy-MM-dd,The timezone requirement is Eastern Standard Time (EST)-America/Toronto.
warehouseId
string 
required
Warehouse ID:
WH02001 - 02001 (Toronto PROD);
WH02002 - 02002 (Calgary PROD);
WH02003 - 02003 (Montreal PROD);
WH02004 - 02004 (Vancouver PROD);
WS02001 - S02001 (Toronto Network PROD);
WS02002 - S02002 (Toronto Network PROD);
WS02003 - S02003 (Calgary Network PROD);
WS02004 - S02004 (Oshawa Network PROD);
WS02005 - S02005 (Vancouver Network PROD);
fromOrderNo
string 
optional
From order No.
carrierId
string 
optional
Carrier id
carrierOrderNo
string 
optional
Carrier tracking No.
customerId
string 
required
Ship from id
customerAddressId
integer 
required
Ship from address id
details
array[object (SaveInboundDetail) {6}] 
required
Inbound order parameter information entity
Example
{
    "appKey": "string",
    "accessToken": "string",
    "timestamp": 0,
    "sign": "string",
    "saveInbound": {
        "expectedShipmentTime": "string",
        "warehouseId": "string",
        "fromOrderNo": "string",
        "carrierId": "string",
        "carrierOrderNo": "string",
        "customerId": "string",
        "customerAddressId": 0,
        "details": [
            {
                "sku": "string",
                "unit": "string",
                "unitQty": 0,
                "batchNo": "string",
                "productionDate": "string",
                "expirationDate": "string"
            }
        ]
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/inbound/save' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appKey": "string",
    "accessToken": "string",
    "timestamp": 0,
    "sign": "string",
    "saveInbound": {
        "expectedShipmentTime": "string",
        "warehouseId": "string",
        "fromOrderNo": "string",
        "carrierId": "string",
        "carrierOrderNo": "string",
        "customerId": "string",
        "customerAddressId": 0,
        "details": [
            {
                "sku": "string",
                "unit": "string",
                "unitQty": 0,
                "batchNo": "string",
                "productionDate": "string",
                "expirationDate": "string"
            }
        ]
    }
}'

Responses

🟢200Success
application/json
Body
操作消息提醒
key
object 
optional
Example
{
  "": {}
}
Previous
queryInboundDetail
Next
modifyInboundInfo
Built with