modifyInboundInfo

Request

Body Params application/json

appKey

string

required

The value of app key

accessToken

string

required

The value of access token

timestamp

integer

required

Request timestamp:The timestamp is in UNIX time format (seconds) and must be a 10-digit integer.
The valid range for the input timestamp is:
current_time - 300 seconds <= input_time <= current_time + 300 seconds.

sign

string

required

Request sign：The supported signature algorithm is MD5 (sign_method=md5). The signature process is as follows:
Sort Parameters:
Sort all request parameters (including both public and business parameters) in ascending ASCII order by their first letter.
If two parameters share the same first letter, use the second letter for secondary sorting, and so on, proceeding left to right.
Concatenate Key-Value Pairs:
After sorting, concatenate the parameters into a single string in the order of key1value1key2value2...keyNvalueN.
No separators are included between key-value pairs.
Add app_secret:
Append the app_secret at both the beginning and end of the concatenated string to form the final signature string.
Generate MD5 Hash:
Encrypt the final signature string using the MD5 algorithm. Convert the resulting MD5 hash to uppercase to obtain the sign value.
This method ensures a consistent and secure signature generation process.

modifyInbound

object (ModifyInbound)

required

User name

applyAsnNo

string

required

Application ASN (Advance Shipping Notice) Number

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);

expectedShipmentTime

string

required

Expected Arrival time,Date format: yyyy-MM-dd,The timezone requirement is Eastern Standard Time (EST)-America/Toronto.

customerId

string

required

todo 联系admin支持注释
Ship from id

customerAddressId

integer

required

Ship from address id

carrierId

string

optional

Carrier id

carrierOrderNo

string

optional

Carrier order No.

details

array[object (ModifyInboundDetail) {6}]

required

Inbound order detail parameter information entity

Example

{
    "appKey": "string",
    "accessToken": "string",
    "timestamp": 0,
    "sign": "string",
    "modifyInbound": {
        "applyAsnNo": "string",
        "warehouseId": "string",
        "expectedShipmentTime": "string",
        "customerId": "string",
        "customerAddressId": 0,
        "carrierId": "string",
        "carrierOrderNo": "string",
        "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

curl --location --request POST '/inbound/modify' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appKey": "string",
    "accessToken": "string",
    "timestamp": 0,
    "sign": "string",
    "modifyInbound": {
        "applyAsnNo": "string",
        "warehouseId": "string",
        "expectedShipmentTime": "string",
        "customerId": "string",
        "customerAddressId": 0,
        "carrierId": "string",
        "carrierOrderNo": "string",
        "details": [
            {
                "sku": "string",
                "unit": "string",
                "unitQty": 0,
                "batchNo": "string",
                "productionDate": "string",
                "expirationDate": "string"
            }
        ]
    }
}'

Responses

🟢200Success

application/json

Body

操作消息提醒

key

object

optional

Example

{
  "": {}
}