1.1. Inbound order message push

1.1.1. push message url config

img.png
img_1.png

1.1.2. SERVICE_TYPE

PUSH_ASN_ORDER

1.1.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 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
remark N String Remark

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

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}

1.2. Outbound feedback push interface

When the order and issue order undergo status transitions in the ERP system, or when an issue callback is received from the warehouse (even if no status change occurs), this interface will be invoked. It is necessary to configure the feedback address in the third-party application and check the "Issue Feedback Push" option

Outer fields are the same as other Webhooks: appId, serviceType, timestamp, sign, bizParam. Default format is form-data; null fields are omitted. Contact Qianyi to enable JSON. Webhook URL configuration is the same as “Inbound order message push”.

1.2.1. SERVICE_TYPE

PUSH_ODO_ORDER

1.2.2. Push message content (bizParam)

Params Require DataType Sample Description
orderNumber Y String A20220905 Outbound order number; same as number
customNumber N String C20220905 Customer reference number
trackNumber N String T20220905 Waybill number; omitted when empty
warehouseName Y String malai warehouse Warehouse name (system value, not translated)
type Y String MANUAL Outbound type as stored (not the query-API display type). Common values: ORDER, MANUAL, TRANSFER (includes first-leg plans; FIRST_LEG is not pushed), PURCHASE_RETURN, LABEL_REPLACEMENT, OTHER, ASSEMBLY, RESTORE, SHIP_ORDER, MANUAL_TOB, DIR_STORE_TRANSFER
status Y String SHIPPED WMS status uppercased, not query-API WAIT_OUTBOUND / FINISHED. Common values: SHIPPED, PACKED, DELIVERED (WMS 2.0 shipped), WMS_PICK / WMS_PACKAGE / WMS_WEIGH, VOIDED / CANCELED, ERROR / EXCEPTION
erpStatus Y String SHIPPED erp status SENDING/SUCCESS/CANCEL/FAILED
shippingTime N Number 1662364800000 Shipping time as millisecond timestamp; omitted when empty
carrier N String J&T Express Carrier
skuList Y List<Sku> see example SKU lines
snInfo N SNInfo see example Present when SN information exists

Sku

Params Require DataType Sample Description
sku Y String S90 Product SKU
title Y String 商品标题 Product title (system value)
quantity Y Long 100 real outbound Good-product qty
unavailableQuantity N Long 50 real outbound Defective qty
apiCustom N String Passthrough from create; omitted when empty

SNInfo(SN Information)

Params Require DataType Sample Description
snUrl N String https://oss.example.com/sn/A20220905.xlsx SN Excel URL from WMS
orderType N String SN order type, omitted when empty

bizParam decoded example:

{
  "orderNumber": "A20220905",
  "number": "A20220905",
  "customNumber": "C20220905",
  "trackNumber": "T20220905",
  "warehouseName": "马来仓库",
  "type": "MANUAL",
  "status": "SHIPPED",
  "shippingTime": 1662364800000,
  "carrier": "J&T Express",
  "skuList": [
    {
      "sku": "S90",
      "title": "商品标题",
      "quantity": 100,
      "unavailableQuantity": 50
    }
  ],
  "snInfo": {
    "snUrl": "https://oss.example.com/sn/A20220905.xlsx"
  }
}

example(default form-data type):

JSON type:
{"appId":"TEST","bizParam":"{\"orderNumber\":\"A20220905\",\"number\":\"A20220905\",\"customNumber\":\"C20220905\",\"trackNumber\":\"T20220905\",\"warehouseName\":\"马来仓库\",\"type\":\"MANUAL\",\"status\":\"SHIPPED\",\"shippingTime\":1662364800000,\"carrier\":\"J&T Express\",\"skuList\":[{\"sku\":\"S90\",\"title\":\"商品标题\",\"quantity\":100,\"unavailableQuantity\":50}],\"snInfo\":{\"snUrl\":\"https://oss.example.com/sn/A20220905.xlsx\"}}","serviceType":"PUSH_ODO_ORDER","timestamp":"1662364800000","sign":"sample-sign"}


FORM-DATA type:
{appId=TEST, bizParam={"orderNumber":"A20220905","number":"A20220905","customNumber":"C20220905","trackNumber":"T20220905","warehouseName":"马来仓库","type":"MANUAL","status":"SHIPPED","shippingTime":1662364800000,"carrier":"J&T Express","skuList":[{"sku":"S90","title":"商品标题","quantity":100,"unavailableQuantity":50}],"snInfo":{"snUrl":"https://oss.example.com/sn/A20220905.xlsx"}}, serviceType=PUSH_ODO_ORDER, timestamp=1662364800000, sign=sample-sign}

1.3. Push tracking status sepc

1.3.1. SERVICE_TYPE

PUSH_TRACKING_PACKAGE

1.3.2. Request

Base

Params Require DataType Sample Description
orderNumber Y String “S230109129883” System order number
onlineOrderId Y String xsasx online Order number
trackingNumber Y String trackingNumber 11111
carrier Y String carrier LEX TH
status Y String CREATED Logistics tracking status

example(default form-data type):

JSON type:
{"appId":"1751530655877-10658", "bizParam":"{\"carrier\":\"J&T Express\",\"onlineOrderId\":\"579877366324626911\",\"orderNumber\":\"S2508053858595\",\"status\":\"CREATED\",\"trackingNumber\":\"762388742732\"}", "serviceType":"PUSH_TRACKING_PACKAGE", "timestamp":1754373394777, "sign":"c0fe6c3ab1a92831dffa5796fbf08a27"}


FORM-DATA type:
{appId=1751530655877-10658, bizParam={"carrier":"J&T Express","onlineOrderId":"579877366324626911","orderNumber":"S2508053858595","status":"CREATED","trackingNumber":"762388742732"}, serviceType=PUSH_TRACKING_PACKAGE, timestamp=1754373394777, sign=c0fe6c3ab1a92831dffa5796fbf08a27}

1.4. Order Shipping info

1.4.1. SERVICE_TYPE

PUSH_SALES_ORDER_SHIPPING_INFO

1.4.2. request

Params Require DataType Sample Description
orderNumber Y String “S200222115613” System Order number
onlineOrderNumber Y String platform order number
trackingNumber Y String trackingNumber
carrier Y String carrier
shippingTime Y Datetime Shipping time,"yyyy-MM-dd hh:mm:ss SSS"
status Y String Sales order status

example(default form-data type):

JSON type:
{"appId":"TEST","bizParam":"{\"carrier\":\"SHIPDOC\",\"onlineOrderNumber\":\"2507311347270601016525823\",\"orderNumber\":\"S250731147586\",\"shippingTime\":1754014435000,\"status\":\"WAIT_SHIP\",\"trackingNumber\":\"223243444\"}","serviceType":"PUSH_SALES_ORDER_SHIPPING_INFO","timestamp":"1754272685482","sign":"7cbc7305af85fb2eed308866c4fbaf89"}


FORM-DATA type:
{appId=1111-3, bizParam={"carrier":"SHIPDOC","onlineOrderNumber":"2507311347270601016525823","orderNumber":S250731147586,"shippingTime":1754014435000,"status":"WAIT_SHIP","trackingNumber":"223243444"}, serviceType=PUSH_SALES_ORDER_SHIPPING_INFO, timestamp=1754272685482, sign=7cbc7305af85fb2eed308866c4fbaf89}

1.5. Refund process info

1.5.1. SERVICE_TYPE

PUSH_RETURN_ORDER_INFO

1.5.2. request

Params Require DataType Sample Description
returnNumber Y String “B200308115691” refund order number
orderNumber Y String “S200222115613” sales Order number
onlineOrderNumber Y String “DA200221115559” ref online number
status Y String “FINISH” Refund order status
returnSkuList Y List<ReturnSku> See ReturnSKU

ReturnSku(refund sku details)

Params Require DataType Sample Description
sku Y String “abc” sku
orderSkuId Y Number orderSkuId
quantity Y Number 1 The actual number of returns

example(default form-data type):

JSON type:
{"serviceType":"PUSH_RETURN_ORDER_INFO","appId":"15167732016","sign":"b55826f1b417bd398aacf61aaa8abe23","bizParam":"{\"orderNumber\":\"THTZD000859\",\"returnSkuList\":[{\"orderSkuId\":45,\"quantity\":1,\"sku\":\"JCDF692024YH002\"}],\"onlineOrderNumber\":\"THTZD000859\",\"returnNumber\":\"B250801537077\",\"status\":\"WAIT_STORAGE\"}","timestamp":"1754033260116"}


FORM-DATA type:
{serviceType=PUSH_RETURN_ORDER_INFO,appId=15167732016,sign=b55826f1b417bd398aacf61aaa8abe23,bizParam={\"orderNumber\":\"THTZD000859\",\"returnSkuList\":[{\"orderSkuId\":45,\"quantity\":1,\"sku\":\"JCDF692024YH002\"}],\"onlineOrderNumber\":\"THTZD000859\",\"returnNumber\":\"B250801537077\",\"status\":\"WAIT_STORAGE\"},timestamp=1754033260116}

1.6. subscribe order status

1.6.1. SERVICE_TYPE

SUBSCRIBE_ORDER

1.6.2. 请求参数

字段名 字段描述 类型 必填 备注
orderType order type String Y inbound order:ASN
orderList order list Array Y
└ orderNumber number String Y

1.6.3. 返回参数

参数 是否必须 类型 示例 备注
orderList Y Array fail list
└ orderNumber Y String order number
└ errorMessage Y String error message
© Copyright QianYi Team 2025 All Rights Reserved            Updated 2026-11-09 01:28:38

results matching ""

    No results matching ""