queryInboundList - Open Api

Request

Body Params application/json

pageNum

integer

required

Page Number

>= 1<= 100

Default:

pageSize

integer

required

Items Per Page (default 10, max 100)

>= 1<= 100

Default:

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.

ownerIds

array[string]

optional

OwnerId Collection

condition

string

optional

Input: ASN No, OMS ASN, Order No, or Product SKU

state

string

optional

ASN Status:
0 - Create;
10 - Submitted;
20 - Reviewing;
60 - Notification to Storage;
90 - Cancelled;
100 - Completed;

warehouseId

string

optional

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

Example

{
    "pageNum": 1,
    "pageSize": 10,
    "appKey": "string",
    "accessToken": "string",
    "timestamp": 0,
    "sign": "string",
    "ownerIds": [
        "string"
    ],
    "condition": "string",
    "state": "string",
    "warehouseId": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

表格分页数据对象

total

integer

optional

总记录数

rows

array[object (Warehousing) {44}]

optional

列表数据

applyAsnNo

string

optional

Application ASN (Advance Shipping Notice) Number

omsAsnNo

string

optional

OMS (Order Management System) ASN Number

asnState

string

optional

ASN State

processState

string

optional

Process State

executeState

string

optional

Execution State

receivedState

string

optional

Received State

fromOrderNo

string

optional

Source Order Number

fromPlatCode

string

optional

Source Platform Code

totalPrice

number

optional

Total Price

totalWeight

number

optional

Total Weight

totalVolume

number

optional

Total Volume

totalQuantity

integer

optional

Total Quantity

warehouseId

string

optional

Warehouse ID

warehouseName

string

optional

Warehouse Name

warehouseAddress

string

optional

Warehouse Address

asnCreationTime

string

optional

ASN Creation Time

orderDueDate

string

optional

Order Due Date

expectedShipmentTime

string

optional

Expected Shipment Time

carrierId

string

optional

Carrier ID

carrierName

string

optional

Carrier Name

carrierOrderNo

string

optional

Carrier Order Number

customerId

string

optional

Customer ID

customerAddressId

integer

optional

Customer Address ID

customerName

string

optional

Customer Name

customerContact

string

optional

Customer Contact Person

customerPhone

string

optional

Customer Phone Number

customerAddress1

string

optional

Customer Address Line 1

customerAddress2

string

optional

Customer Address Line 2

customerCity

string

optional

Customer City

customerProvince

string

optional

Customer Province

customerCountry

string

optional

Customer Country

customerZipcode

string

optional

Customer Zip Code

cityCode

string

optional

City Code

provinceCode

string

optional

Province Code

countryCode

string

optional

Country Code

createSource

string

optional

Source of Creation

urgentOrder

string

optional

Urgent Order Flag

asnReference1

string

optional

ASN Reference 1

asnReference2

string

optional

ASN Reference 2

asnReference3

string

optional

ASN Reference 3

noteText

string

optional

Note or Remark

skus

string

optional

SKUs (Stock Keeping Units)

addTime

string

optional

Time when the Record was Added

editTime

string

optional

Time when the Record was Edited

code

integer

optional

消息状态码

msg

string

optional

消息内容

Example

{
  "total": 0,
  "rows": [],
  "code": 0,
  "msg": "",
  "admin": false
}