1.1. Query Inbound orders

post {HTTP(S)host}/api/{version}/asn

1.1.1. SERVICE_TYPE

QUERY_ASN_LIST

1.1.2. Request

Params Require DataType Sample Description
warehouseName N String Malay warehouse Warehouse name
type N String PURCHASE Business order type
status N String NEW Inbound order status
tag N AsnTag(Object) Send status object, seeAsnTag
skuKeyWord N String S90/toilet water Multi-field search, product SKU/name
number N String 2011asd Multi-field search, inbound order number, business order number, reference number
trackNumber N String 2011asd Tracking number
page Y Number 1 Page number, default 1
pageSize Y Number 100 Number of records per page. no more than 200; Default is 100
timeType N String CREATE_TIME timeFrom、timeEnd、timeType,Either field has a value, and the rest must have a value Time Type: Created CREATE_TIME, Inbound Time STOCK_IN_TIME, Completed Time, FINISH_TIME, update time UPDATE_TIME
timeFrom N String 2022-09-26 Start time
timeEnd N String 2022-09-26 End time
returnBatchInfo N boolean false Whether to return batch information (only effective for Qianyi WMS)

AsnTag(Asn send status)

Params Require DataType Sample Description
sendWms N int 1 Sended
sendFailed N int 1 Send faild
receiveException N int 1 Receipt exception

1.1.3. Reponse

Params Require DataType Sample Description
errorCode Y String “DATA_INPUT_ERROR” Error Code
errorMsg Y String “The input of Params is incorrect” Business Error Messages
state Y String success Response State
total Y Number 100 Total num
result Y List<Asn> See Asn

Asn( Inbound order )

Params Require DataType Sample Description
asnNumber Y String A20220905 Inbound order number
businessNumber Y String B20220905 businessNumber
customNumber N String C20220905 Reference number
trackNumber N String T20220905 Tracking number
warehouseName Y String Malay warehouse Receiving Warehouse name
type Y String PURCHASE Business order type
status Y String NEW Inbound order status
remark N String Quick Description
createTime Y String 2022-09-05 15:27:18 Creation time
updateTime N String 2022-09-05 15:27:18 Update time
stockInTime N String 2022-09-05 15:27:18 The most recent put-away time
finishTime N String 2022-09-05 15:27:18 Completion time
purchasePriceCurrency Y String CNY purchasePriceCurrency
firstLegPriceCurrency Y String CNY firstLegPriceCurrency
transferPriceCurrency Y String CNY transferPriceCurrency
asnSkuVOList Y List<AsnSku> see AsnSku
asnCustomFieldValueVOList N List<SkuCustomFieldValueVO>
asnMarkVOList N List<OpenAsnMarkDTO> Box mark information list

SkuCustomFieldValueVO(Customize the field information)

Params Require DataType Sample Description
tableName Y String SYS_ITEM SYS_ITEM:Custom fields for system products; SYS_ORDER: Order custom fields; SYS_ODO: Custom columns for outbound orders; SYS_ASN: Custom columns for inbound orders.
columType Y String NUMBER Filter custom fields for different fill types NUMBER,DATE,STRING,,SELECT.
columName Y String Date of manufacture The name of the field defined by the user
defaultValue N String 1970/01/01 Customize the column defaults
candidateValue N String ["1970/01/01","1970/01/02"] Candidate value for the drop-down box
remark N String The shelf date is distinguished from the date of manufacture Description
required N Integer 1 Whether to query only the required fields 1:true;0:false
isQuery N Integer 1 Whether to query only the columns that support the query 1:true;0:false
isShow N Integer 1 Specifies whether to query only the columns that support column configurations 1:true;0:false

AsnSku(Inbound list items)

Params Require DataType Sample Description
sku Y String S90 sku
title Y String Product title Product title
purchasePrice Y BigDecimal 100.0000 Purchase price, 4 decimal places
firstLegPrice Y BigDecimal 100.00 The first trip is to 2 decimal places
transferPrice Y BigDecimal 100.0000 Transfer, 4 decimal places
expectQuantity Y Long 100 Quantity purchased
receiveQuantity Y Long 10 Quantity received
goodNum Y Long 10 Received good product
damageNum Y Long 0 Received defective products
mfgDate N String 2025-12-12 Production date (Only applicable to Qianyi WMS)
expDate N String 2025-12-12 Expiration date (Only applicable to Qianyi WMS)
batchNo N String 1354134563 Batch number (Only applicable to Qianyi WMS)
originCountry N String CN Country of origin (Only applicable to Qianyi WMS)
skuNotes N String ABC Product notes

OpenAsnMarkDTO (Box Mark Information)

Parameter Required Type Example Remarks
boxNumber Y Int 1 Box number must be a positive integer, the value range must not exceed the length of asnMarkSkuList; the first box number starts from 1 and increments sequentially.
asnMarkSkuVOList Y List<AsnMarkSkuVO> SKU packing information for the box
length Y Double 3.00 Box length, unit: cm
width Y Double 3.00 Box width, unit: cm
height Y Double 3.00 Box height, unit: cm
weight Y Double 4.00 Weight, unit: kg

AsnMarkSkuVO (Box Mark SKU Information)

Parameter Required Type Example Remarks
sku Y String ABC SKU code
quantity Y Int 10 Quantity

Request example:

curl --location --request POST 'https://gerp-test1.800best.com/api/v1/asn' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_ASN_LIST"' \
--form 'bizParam="{\"page\":1,\"pageSize\":3}"' \
--form 'timestamp="1756865700001"' \
--form 'sign="72309a741bb0b39db6a8a1144bf1c9d9"'

Response example:

{
    "state": "success",
    "errorCode": "",
    "errorMsg": "",
    "bizContent": "{\"notSuccess\":false,\"result\":[{\"asnNumber\":\"A250903149242\",\"asnSkuVOList\":[{\"damageNum\":0,\"expectBadQuantity\":0,\"expectQuantity\":30,\"firstLegPrice\":10.00,\"goodNum\":0,\"isDeleted\":0,\"perBoxQuantity \":1,\"purchasePrice\":100.0000,\"receiveQuantity\":0,\"sku\":\"sea002\",\"title\":\"海仓测试商品\",\"transferPrice\":10.0000}],\"containerNumber\":\"12112\",\"createTime\":\"2025-09-03 14:12:52\",\"customNumber\":\"111\",\"firstLegPriceCurrency\":\"CNY\",\"isDeleted\":0,\"logisticsName\":\"0724-BEST_ChannelName\",\"purchasePriceCurrency\":\"CNY\",\"remark\":\"111\",\"status\":\"SHIPPING\",\"tag\":{\"boxedNeedSend\":0,\"comparedTagValue\":63,\"fullTagValue\":2,\"overcharge\":0,\"receiveException\":0,\"relation\":0,\"sendFailed\":1,\"sendWms\":0,\"waitBoxing\":0},\"trackNumber\":\"1121211\",\"transferPriceCurrency\":\"CNY\",\"type\":\"MANUAL\",\"updateTime\":\"2025-09-03 14:18:38\",\"warehouseName\":\"泰国演示1仓\"},{\"asnNumber\":\"A250903149241\",\"asnSkuVOList\":[{\"damageNum\":0,\"expectBadQuantity\":0,\"expectQuantity\":1,\"firstLegPrice\":1.00,\"goodNum\":0,\"isDeleted\":0,\"purchasePrice\":1.0000,\"receiveQuantity\":0,\"sku\":\"testgg01\",\"title\":\"Uji nama bahasa Cina\",\"transferPrice\":1.0000}],\"createTime\":\"2025-09-03 13:43:29\",\"customNumber\":\"1\",\"firstLegPriceCurrency\":\"CNY\",\"isDeleted\":0,\"logisticsName\":\"-1-1-1-1-1-1-1-1-1-1-1-1-1-1-1-1-1-1-1-1-1-1\",\"purchasePriceCurrency\":\"CNY\",\"remark\":\"\",\"status\":\"SHIPPING\",\"tag\":{\"boxedNeedSend\":0,\"comparedTagValue\":63,\"fullTagValue\":2,\"overcharge\":0,\"receiveException\":0,\"relation\":0,\"sendFailed\":1,\"sendWms\":0,\"waitBoxing\":0},\"transferPriceCurrency\":\"CNY\",\"type\":\"MANUAL\",\"updateTime\":\"2025-09-03 13:43:37\",\"warehouseName\":\"best warehouse(测试用)\"},{\"asnNumber\":\"A250903149240\",\"asnSkuVOList\":[{\"damageNum\":0,\"expectBadQuantity\":0,\"expectQuantity\":200,\"goodNum\":200,\"isDeleted\":0,\"purchasePrice\":0.0100,\"receiveQuantity\":200,\"sku\":\"hmsku0903-02\",\"title\":\"黑咪sku0903-02\"},{\"damageNum\":0,\"expectBadQuantity\":0,\"expectQuantity\":200,\"goodNum\":200,\"isDeleted\":0,\"purchasePrice\":8.0000,\"receiveQuantity\":200,\"sku\":\"hmsku0903-01\",\"title\":\"黑咪sku0903-01\"}],\"createTime\":\"2025-09-03 13:35:59\",\"finishTime\":\"2025-09-03 13:36:16\",\"firstLegPriceCurrency\":\"CNY\",\"isDeleted\":0,\"purchasePriceCurrency\":\"CNY\",\"status\":\"FINISHED\",\"stockInTime\":\"2025-09-03 13:36:16\",\"tag\":{\"boxedNeedSend\":0,\"comparedTagValue\":63,\"fullTagValue\":0,\"overcharge\":0,\"receiveException\":0,\"relation\":0,\"sendFailed\":0,\"sendWms\":0,\"waitBoxing\":0},\"transferPriceCurrency\":\"CNY\",\"type\":\"MANUAL\",\"updateTime\":\"2025-09-03 13:36:16\",\"warehouseName\":\"自定义仓库1\"}],\"state\":\"success\",\"total\":10009}",
    "requestId": "690772b1-4306-4bae-97a5-0c33db24ee68"
}

1.2. Create Inbound order

1.2.1. SERVICE_TYPE

CREATE_ASN_ORDER

1.2.2. Request

Params Require DataType Sample Description
warehouseName Y String Malay warehouse Warehouse name
customNumber N String C20220905 Reference number (no value: can create an inbound order repeatedly, with value: the value is bound to the inbound order number to ensure uniqueness)
trackNumber N String T20220905 Tracking number
remark N String Quick Description
purchasePriceCurrency Y String CNY purchasePriceCurrency
firstLegPriceCurrency N String CNY firstLegPriceCurrency
transferPriceCurrency N String CNY transferPriceCurrency
asnSkuVOList Y List<AsnSku> see AsnSku
sendWarehouseFlag N String Y Whether to issue the warehouse. (Y: delivered, null or N: not delivered.) Case-insensitive)
preArriveTime N Date Estimated time of arrival
shippingType N String 01 Shipping Methods The optional values are as follows: 01 (sea), 02 (air), 03 (express), 04 (land), 05 (special car), 06 (rail), 07 (font), 08 (other) Transmit the number code
containerModel N String 20DC Container type The optional values are as follows:20’, 20DC, 20FR, 20GP, 20HQ, 20OT, 40‘, 40DC, 40FR, 40GOH, 40HC, 40HQ, 40HR, 40OT, 40RQ, 45‘, 45HC, 45HQ, 53HQ, 53 DRY VAN, 40GP, 45GP
packageType N String ASSEMBLY Product packing method The optional values are as follows: ASSEMBLY, MIXING
boxCount N Int 5 Total number of boxes
customerType N String Customer identification, do not fill in without cooperation. Shipper customer, please pass on SHIPPER
asnCustomFieldValueVOList N SkuCustomFieldValueVO
isSpecifyBatch N boolean false Whether to specify the batch of goods
snInfo N SNInfo SN Information
asnMarkVOList N List<OpenAsnMarkDTO> Box mark information
mergeDuplicateSkuLines N Boolean Business meaning: whether to merge duplicate SKU codes. true means merge duplicate SKU codes, false means do not merge duplicate SKU codes. 1. For Shipper customers: default is false, and modification is not supported; 2. For non-Shipper customers: default is true, setting to false only takes effect in Qiancang 1.0, Best Express Warehouse, and Xiyunda Warehouse scenarios, modification is not supported in other scenarios

AsnSku(Inbound list items)

Params Require DataType Sample Description
sku Y String S90 sku
purchasePrice Y BigDecimal 100.0000 Purchase price, 4 decimal places
firstLegPrice N BigDecimal 100.00 The first trip is to 2 decimal places
transferPrice N BigDecimal 100.0000 Transfer, 4 decimal places
expectQuantity Y Long 100 Inventory quantity
skuStatus N String GOOD Goods status: Good (GOOD), Damage (DAMAGE) default Good
perBoxQuantity N Int 3 Box gauge
apiCustom N String
batchNo N String(255) Batch number, only applicable to Qianyi WMS
mfgDate N String 2025-10-01 Production date, only applicable to Qianyi WMS
expDate N String 2025-10-01 Expiration date, only applicable to Qianyi WMS
originCountry N String CN Country of production, only applicable to Qianyi WMS
skuNotes N String ABC Product notes

SkuCustomFieldValueVO(Customize the columns)

Params Require DataType Sample Description
customFieldId Y Long 3 SERVICE_TYPE中的CUSTOMER_FIELD_QUERYID returned by the interface
value Y String zhangsan Customize the value of the column

SNInfo(SN Information)

Params Require DataType Sample Description
customerCode N String 123 Customer Code
orderType N String OrderType Order Type(Enum)
orderDate N String 2024-01-15 14:30:45 Order Date(yyyy-MM-dd HH:mm:ss)
snUrl N String Excel Attachment URL
agentWarehouseCode N String Agent Warehouse Code
agentWarehouseName N String Agent Warehouse Name
storeCode N String Downstream customer code
storeName N String Downstream customer name

OpenAsnMarkDTO (Box Mark Information)

Parameter Required Type Example Remarks
boxNumber Y Int 1 Box number must be a positive integer, the value range must not exceed the length of asnMarkSkuList; the first box number starts from 1 and increments sequentially.
asnMarkSkuVOList Y List<AsnMarkSkuVO> SKU packing information for the box
length Y Double 3.00 Box length, unit: cm
width Y Double 3.00 Box width, unit: cm
height Y Double 3.00 Box height, unit: cm
weight Y Double 4.00 Weight, unit: kg

AsnMarkSkuVO (Box Mark SKU Information)

Parameter Required Type Example Remarks
sku Y String ABC SKU code
quantity Y Int 10 Quantity

Request example:

curl --location --request POST 'https://gerp-test1.800best.com/api/v1/asn' \
--form 'appId="TEST"' \
--form 'serviceType="CREATE_ASN_ORDER"' \
--form 'bizParam="{\"warehouseName\":\"台湾(名字不要瞎改)\",\"purchasePriceCurrency\":\"CNY\",\"firstLegPriceCurrency\":\"CNY\",\"transferPriceCurrency\":\"CNY\",\"asnSkuVOList\":[{
\"sku\":\"SKU0425007\",
\"purchasePrice\":10,
\"firstLegPrice\":0,
\"transferPrice\":0,
\"expectQuantity\":2,
\"skuStatus\":\"GOOD\"
},
{
\"sku\":\"SKU0425007\",
\"purchasePrice\":20,
\"firstLegPrice\":0,
\"transferPrice\":0,
\"expectQuantity\":3,
\"skuStatus\":\"GOOD\",
\"batchNo\":\"12345678911\",
\"mfgDate\":\"2025-05-31\",
\"expDate\":\"2025-06-31\",
\"originCountry\":\"CN\"
}]}"' \
--form 'timestamp="1731742317"' \
--form 'sign="14fbbedea8cb29fe3142d6853b257367"'

Response example:

{
    "state": "success",
    "errorCode": "",
    "errorMsg": "",
    "bizContent": "{\"notSuccess\":false,\"result\":{\"arrivalStatus\":\"ARRIVED\",\"arrivedSkuQuantity\":0,\"arrivedTotalQuantity\":0,\"asnExtraJsonVO\":{},
    \"asnNumber\":\"A250623145669\",\"asnSkuVOList\":[{\"arrived\":false,\"arrivedQuantity\":0,\"asnId\":44917,\"customFieldValueVOList\":[],\"customerId\":3,
    \"customerIdForUser\":3,\"dimensionUnit\":\"cm\",\"dltQuantity\":0,\"expectBadQuantity\":0,\"expectGoodQuantity\":5,\"expectQuantity\":5,\"firstLegPrice\":0,
    \"firstLegQuantity\":0,\"height\":9.0,\"id\":194757,\"isDeleted\":0,\"itemInfoVO\":{\"bizItemId\":194757,\"bizType\":\"ASN\",\"cartonDimensionUnit\":\"cm\",
    \"cartonHeight\":9.0,\"cartonLength\":1.0,\"cartonWidth\":2.0,\"ccPriceUnit\":\"USD\",\"cdNetWeight\":1.0,\"cdPriceUnit\":\"USD\",\"cdWeight\":2.0,
    \"cdWeightUnit\":\"KG\",\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3},\"length\":1.0,\"needQualityInspection\":false,\"purchasePrice\":10,
    \"receiveBoxQuantity\":0,\"receiveQuantity\":0,\"serialEnable\":0,\"sku\":\"SKU0425007\",\"skuId\":10007387,\"status\":\"RECEIVING\",\"title\":\"SKU0425007\",
    \"transferPrice\":0,\"version\":1,\"weight\":2.0,\"weightUnit\":\"KG\",\"width\":2.0,\"wmsSkuCode\":\"SKU0425007\"}],\"asnTypeFlag\":false,\"autoCommit\":false,
    \"businessRemarkVOList\":[],\"closeWms\":false,\"customerId\":3,\"customerIdForUser\":3,\"extraJson\":\"{}\",\"firstLegPriceCurrency\":\"CNY\",\"firstLegTotal\":0,
    \"firstLegUnit\":\"CNY\",\"firstLegWithdrawShipped\":false,\"flashId\":1,\"fromApi\":true,\"id\":44917,\"purchasePriceCurrency\":\"CNY\",\"receiveGoods\":true,
    \"receivedSkuQuantity\":0,\"receivedTotalQuantity\":0,\"skuQuantity\":1,\"status\":\"NEW\",\"tag\":{\"comparedTagValue\":0,\"fullTagValue\":0,\"overcharge\":0,
    \"receiveException\":0,\"relation\":0,\"sendFailed\":0,\"sendWms\":0,\"waitBoxing\":0},\"tags\":0,\"timezoneId\":\"Asia/Shanghai\",\"totalPurchasePrice\":50,
    \"totalQuantity\":5,\"transferPriceCurrency\":\"CNY\",\"type\":\"MANUAL\",\"useNewBestNumber\":false,\"version\":0,\"warehouseId\":12565,
    \"warehouseName\":\"台湾(名字不要瞎改)\",\"warehouseVO\":{\"address\":\"华星C\",\"address2\":\"XXX\",\"addressName\":\"华星现代产业园1\",\"asnEnable\":false,
    \"autoAdjStorage\":true,\"autoAdjustment\":false,\"autoCreateProduct\":1,\"autoSendOnReturnCreate\":0,\"autoSendWmsSku\":0,\"autoSynStorage\":false,
    \"city\":\"杭州\",\"code\":\"TOPMART\",\"configFileId\":\"\",\"contacts\":\"ZZ\",\"countTag\":0,\"country\":\"CN\",\"creatSource\":\"NORMAL\",
    \"cusAsnMark\":0,\"customCacheKey\":\"3\",\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"district\":\"西湖1\",\"email\":\"123456@qq.com\",
    \"extraType\":\"TOPMART\",\"forceRefreshSkuMapping\":false,\"fromOpenApi\":false,\"id\":12565,\"isDeleted\":0,\"kind\":\"COMPLEX\",\"locationConfigIds\":\"\",
    \"name\":\"台湾(名字不要瞎改)\",\"phone\":\"18368093711\",\"postCode\":\"317500\",\"providerId\":4247,\"province\":\"浙江1\",\"selfSupport\":false,
    \"sendAttachment\":0,\"sendBigstockAsDraft\":false,\"sendItemAsDraft\":true,\"sendItemImageFlag\":false,\"sendOdoAsDraft\":false,\"sendPlatformInfo\":false,
    \"sendReferenceNoFlag\":0,\"splitGrade\":1,\"status\":\"UNLOCK\",\"supportLazadaJit\":false,\"syncSkuInfo\":1,\"timezoneId\":\"Asia/Shanghai\",\"type\":\"BEST_GO\",
    \"typeName\":\"综合仓\",\"useBestWarehouseType\":false,\"useNewApiAndMethodForQianCangV1\":false}},\"state\":\"success\"}",
    "requestId": "6167c819-a604-465c-a7a7-8c838574c113"
}

1.3. Cancel inbound order

1.3.1. SERVICE_TYPE

1.3.2. CANCEL_ASN_ORDER

1.3.3. Request

Params Require DataType Sample Description
asnNumber Y String Inbound order number A230109129883

1.3.4. Reponse

Params Require DataType Sample Description
errorCode Y String “DATA_INPUT_ERROR” Error Code
errorMsg Y String “The input of Params is incorrect” Business Error Messages
state Y String success Response State

Request example:

curl --location --request POST 'https://gerp-test1.800best.com/api/v1/asn' \
--form 'appId="TEST"' \
--form 'serviceType="CANCEL_ASN_ORDER"' \
--form 'bizParam="{    \"asnNumber\":\"A250910149553\"}"' \
--form 'timestamp="1731742317"' \
--form 'sign="d44fcd6f24ef97c0178a402d99ee22eb"'

Response example:

{
    "state": "success",
    "errorCode": "",
    "errorMsg": "",
    "bizContent": "{\"notSuccess\":false,\"state\":\"success\"}",
    "requestId": "60525b5b-577e-4342-840b-f3c2a2d01f2a"
}

1.4. Inbound order message push

1.4.1. SERVICE_TYPE

PUSH_ASN_ORDER

1.4.2. Push message content

Params Require DataType Sample Description
asnNumber Y String “A230109129883” Inbound order number
trackNumber N String Tracking number
skuList Y List<Sku> SKU receipt data
status Y String Inbound order status FINISHED or CLOSED or RECEIVING:The goods are being received and the quantity received is greater than 0
finishedTime Y Date The condition of the completion time of the inbound order must be passed, and the value is passed only when status=FINISHED
customNumber N String Reference number
snInfo N SNInfo SN Information

Sku

Params Require DataType Sample Description
quantity Y Number 100 The quantity received
sku Y String Sku sku
batchNo N String Batch number, only applicable to Qianyi WMS
mfgDate N String 2025-10-01 Production date, only applicable to Qianyi WMS
expDate N String 2025-10-01 Expiration date, only applicable to Qianyi WMS
originCountry N String CN Country of production, only applicable to Qianyi WMS
barcode N String CN barcode
apiCustom N String apiCustom

SNInfo(SN Information)

Params Require DataType Sample Description
snUrl N String SN Excel Attachment URL

example(default form-data type):

JSON type:
{"appId":"TEST","bizParam":"{\"asnNumber\":\"A250619145545\",\"customNumber\":\"2025061900007\",\"status\":\"RECEIVING\",\"trackNumber\":\"CGDD0000787\",\"setSkuList\":[{\"sku\":\"LIP005\",\"quantity\":1},{\"quantity\":1,\"sku\":\"LIP005\"}]}","serviceType":"PUSH_ASN_ORDER","timestamp":"1754016113505","sign":"77fd745547a99d46cf5d2f17697a7c6e"}

FORM-DATA type:
{appId=1111-3, bizParam={"asnNumber":"A250731147584","customNumber":"1000832922","finishedTime":1753942939000,"skuList":[{"damageNum":0,"goodNum":9,"quantity":9,"sku":"PPB24700027"}],"status":"FINISHED","trackNumber":"4700041511"}, serviceType=PUSH_ASN_ORDER, timestamp=1753942939728, sign=8f40f3de6778c990bc7b762314b182ac}
© Copyright QianYi Team 2025 All Rights Reserved            Updated 2026-02-02 05:53:56

results matching ""

    No results matching ""