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

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>

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

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 Y String CNY firstLegPriceCurrency
transferPriceCurrency Y 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

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

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

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

1.4. Update inbound result

1.4.1. SERVICE_TYPE

1.4.2. PUSH_ASN_ORDER

1.4.3. 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
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

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
© Copyright QianYi Team 2025 All Rights Reserved            Updated 2025-06-13 09:54:22

results matching ""

    No results matching ""