1. Outbound order

API URL

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

1.1. Query Outbound order list

1.1.1. SERVICE_TYPE

QUERY_ODO_LIST

1.1.2. Request

Params Require DataType Sample Description
warehouseName N String Malay warehouse Warehouse name
type N String MANUAL Outbound order type
status N String WAIT_OUTBOUND Outbound order status
createTimeFrom N String 2022-09-05 Creation time start
createTimeTo N String 2022-09-05 Creation time end
shipTimeFrom N String 2022-09-05 shipping time start
shipTimeTo N String 2022-09-05 shipping time end
updateTimeFrom N String 2022-09-05 update time start
updateTimeTo N String 2022-09-05 update time end
numberParam N String 2011asd Multi-field search， Outbound order number ，Reference number
skuParam N String 2011asd Multi-field search, product code，The title of the product
orderNumberList N List<String> Outbound order number List (no more than 200 entries)
customNumberList N List<String> Reference number List (no more than 200 entries)
page Y Number 1 Page number, default 1
pageSize Y Number 100 Number of records per page. no more than 200; Default is 100
calculateCost N boolean true default false, return Outbound cost when set to 'true'(currency is CNY)
(When set to true, there may be performance issues)

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

Odo( Outbound order )

Params Require DataType Sample Description
number Y String A20220905 Outbound order number
customNumber N String C20220905 Reference number
trackNumber Y String T20220905 Tracking number
warehouseName Y String Malay warehouse outbound Warehouse name
type Y String MANUAL Outbound order type
status Y String WAIT_OUTBOUND Outbound order status
remark N String Quick Description
createTime Y String 2022-09-05 15:27:18 Creation time
finishTime N String 2022-09-05 15:27:18 Completion time
odoSkuVOList Y List<OdoSku> Outbound order details
odoCustomFieldValueVOList N List<SkuCustomFieldValueVO>

SkuCustomFieldValueVO(Custom Field info)

Params Require DataType Sample Description
tableName Y String SYS_ITEM SYS_ITEM： System sku Custom Field ； SYS_ORDER： Order Custom Field ； SYS_ODO： Outbound order Custom Field ； SYS_ASN： Inbound order Custom Field 。
columType Y String NUMBER Filter for different fill types Custom Field 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 Custom Field Default value
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

OdoSku( Outbound order 商品)

Params Require DataType Sample Description
sku Y String S90 sku
title Y String Product title Product title
storageLocationCode Y String SYS LOC Bin location code
receiveNumber Y String A20220905 Inbound batches
quantity Y Long 100 Good Outbound quantity
unavailableQuantity N Long 50 Damage Outbound quantity(only warehouseType yunlu+GWMS)

request example

curl --location --request POST 'http://gerp-test1.800best.com/api/v1/odo' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_ODO_LIST"' \
--form 'bizParam="{\"page\":1,\"pageSize\":2}"' \
--form 'timestamp="1741593077529"' \
--form 'sign="02115b923d11d12736d711fbebc69f3e"'

return example

{
"state": "success",
"errorCode": "",
"errorMsg": "",
"bizContent": "{\"notSuccess\":false,\"result\":[{\"createTime\":\"2025-03-06 16:33:22\",\"number\":
\"TF250306161898\",\"odoCustomFieldValueVOList\":[{\"candidateValue\":[],\"columCode\":3,\"columName\":
\"自定义日期栏位\",\"columType\":\"DATE\",\"customFieldId\":41,\"customFieldValueVOList\":[],\"customerId\":
3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":41,\"isQuery\":0,\"isShow\":0,\"required\":0}]
,\"odoSkuVOList\":[{\"quantity\":2,\"receiveNumber\":\"A240329156179_1\",\"sku\":\"mcdull-s12\",\"skuId\":10003366,\"storageLocationCode\":\"SYS LOC\",\"title\":\"mcdull-s12\"}]
,\"status\":\"WAIT_OUTBOUND\",\"type\":\"TRANSFER\",\"warehouseId\":106,\"warehouseName\":\"customer\"},{\"createTime\":
\"2025-03-06 16:28:04\",\"number\":\"TF250306161897\",\"odoCustomFieldValueVOList\":[{\"candidateValue\":[],\"columCode\":
3,\"columName\":\"自定义日期栏位\",\"columType\":\"DATE\",\"customFieldId\":41,\"customFieldValueVOList\":[],\"customerId\":
3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":41,\"isQuery\":0,\"isShow\":0,\"required\":0}]
,\"odoSkuVOList\":[{\"quantity\":10,\"unavailableQuantity\":10\",receiveNumber\":\"A240329156179_1\",\"sku\":\"mcdull-s12\",\"skuId\":10003366,\"storageLocationCode\":\"SYS LOC\",\"title\":\"mcdull-s12\"}]
,\"status\":\"WAIT_OUTBOUND\",\"type\":\"TRANSFER\",\"warehouseId\":106,\"warehouseName\":\"customer\"}],\"state\":
\"success\",\"total\":1812}",
"requestId": "50e85d2d-09e1-452e-9459-b8485dc136b7"
}

1.2. create Outbound order

1.2.1. SERVICE_TYPE

CREATE_ODO_ORDER

1.2.2. Request

Params Require DataType Sample Description
warehouseName Y String Malay warehouse Warehouse name
customNumber Y String 12345 Outbound order number , the customer dimension is unique
remark N String Description Description
carrier N String Lex th carrier
carrierService N String Lex th Logistics Name
secondaryType N String MANUAL Can be empty; External Order subtype (only supports Qianyi wms) MANUAL；PURCHASE_RETURN
trackingNumber N String 1234 trackingNumber
receiver N receiverVO Recipient Information，QWMS is required
odoSkuVOList Y List<odoSkuVO> Outbound order details
odoCustomFieldValueVOList N List<SkuCustomFieldValueVO>
isSpecifyBatch N boolean false Whether to specify the batch of goods
customerType N String Customer identification, do not fill in without cooperation. Shipper customer, please pass on SHIPPER
snInfo N SNInfo SN Information
shippingMethod N String freight/parcel Shipping Method
shippingLabelSource N String ●ATTACHMENT: Comes with a waybill and provides information such as the waybill to Qianyi WMS through attachments. When transmitting this value, the shipping label number and carrier information must be provided, and only one shipping label waybill attachment must be issued.
● API: Retrieve numbers from the courier system through GWMS.
● WMS-GEN: If this value is passed, the waybill will be generated by the GWMS configuration template		 Source of shipping label
files N List<FileInfoVO> Attachment information

receiverVO

Params Require DataType Sample Description
name Y String Name Recipient name
streetLine1 Y String Address address
postalCode Y String 600514 Postal code
countryCode Y String US Countries
city Y String Mai city
mobileNumber Y String 12223334 mobile number
state Y String Mai Province/State
shopCode N String code Shop code (Currently only used in J&T warehouse)

odoSkuVO

Params Require DataType Sample Description
sku Y String S90 System sku
quantity Y Long 100 Good Outbound quantity(Condition required, fill in at least one of quantity and unavailable quantity )
unavailableQuantity N Long 50 Damage Outbound quantity(effective only for J&T warehouse and QIANYI wms)
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(Custom Field )

Params Require DataType Sample Description
customFieldId Y Long 3 The ID returned by the CUSTOMER_FIELD_QUERY interface in the SERVICE_TYPE
value Y String “张三” The value of Custom Field

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

FileInfoVO(Attachment information)

Params Require DataType Sample Description
fileType N String file type
fileUrl N String file URL
fileName N String file name

Request example:

curl --location --request POST 'https://gerp-test1.800best.com/api/v1/odo' \
--form 'appId="TEST"' \
--form 'serviceType="CREATE_ODO_ORDER"' \
--form 'bizParam="{
\"warehouseName\": \"台湾（名字不要瞎改）\",
\"customNumber\": \"S13232417\",
\"carrier\": \"FedEx\",
\"carrierService\": \"FedEx\",
\"trackingNumber\": \"1234446\",
\"isSpecifyBatch\": true,
\"customerType\": \"SHIPPER\",
\"remark\":\"bugfix2\",
\"receiver\": {
\"name\": \"ceshi\",
\"streetLine1\": \"124124\",
\"postalCode\": \"600514\",
\"countryCode\": \"CN\",
\"city\": \"yuenna\",
\"mobileNumber\": \"1111\",
\"state\": \"1111\"
},
\"odoSkuVOList\": [
{
\"sku\": \"SKU0425007\",
\"quantity\": 2,
\"unavailableQuantity\": 0
},
{
\"sku\": \"SKU0425007\",
\"quantity\": 0,
\"unavailableQuantity\": 2
},
{
\"sku\": \"SKU0425007\",
\"quantity\": 0,
\"unavailableQuantity\": 2
}
]
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="1ed2fa62dce18742b899be7f74bba322"'

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

1.3.1. SERVICE_TYPE

1.3.2. CANCEL_ODO_ORDER

1.3.3. Request

Params Require DataType Sample Description
customNumber Y String Outbound order number 12345

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

curl --location --request POST 'https://gerp-test1.800best.com/api/v1/odo' \
--form 'appId="TEST"' \
--form 'serviceType="CANCEL_ODO_ORDER"' \
--form 'bizParam="{
\"customNumber\": \"S13232417\"
}"' \
--form 'timestamp="1731742317"' \
--form 'sign="cee42989a6ffaa2bb63d9ac9325a1cf3"'

Reponse

{
    "state": "success",
    "errorCode": "",
    "errorMsg": "",
    "bizContent": "{\"errorCode\":\"odo.status.can.not.operate\",\"errorMsg\":\"This status of the outbound order does not support operations\",\"notSuccess\":true,\"state\":\"failure\"}",
    "requestId": "81c4d623-4eec-420a-9741-8751d5741144"
}

1.4. Query sales Outbound order

1.4.1. SERVICE_TYPE

QUERY_SALES_ODO_LIST

1.4.2. Request

Params Require DataType Sample Description
warehouseName N String Malay warehouse Warehouse name
status N String WAIT_OUTBOUND Outbound order status
createTimeFrom Y String 2022-09-05 Creation time The starting time, the range cannot exceed three days
createTimeTo Y String 2022-09-05 Creation time end, the range cannot exceed three days
numberParam N String 2011asd Multi-field search， Outbound order number ，Reference number
skuParam N String 2011asd Multi-field search, sku code ，The title of the product
orderNumberList N List<String> Outbound order number List (no more than 200 entries)
customNumberList N List<String> Reference number (no more than 200 entries)
page Y Number 1 Page number, default 1
pageSize Y Number 100 Number of records per page. no more than 200; Default is 100

1.4.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<Odo> See Odo

Request example:

curl --location --request POST 'https://gerp-test1.800best.com/api/v1/odo' \
--form 'appId="TEST"' \
--form 'serviceType="QUERY_SALES_ODO_LIST"' \
--form 'bizParam="{\"page\":1,\"pageSize\":3, \"createTimeFrom\":\"2025-09-02\",\"createTimeTo\":\"2025-09-05\",\"numberParam\":\"W250903149235\"}"' \
--form 'timestamp="1756865700001"' \
--form 'sign="d302e01ee0f7f7c0a4dc9c2b8f3e4530"'

Response example:

{
    "state": "success",
    "errorCode": "",
    "errorMsg": "",
    "bizContent": "{\"notSuccess\":false,\"result\":[{\"createTime\":\"2025-09-03 11:42:43\",\"number\":\"W250903149235\",
    \"odoCustomFieldValueVOList\":[{\"candidateValue\":[],\"columCode\":1,\"columName\":\"测试栏位1\",\"columType\":\"STRING\",\"customFieldId\":35,
    \"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":35,\"isQuery\":0,\"isShow\":0,\"required\":0},
    {\"candidateValue\":[],\"columCode\":3,\"columName\":\"自定义栏3\",\"columType\":\"NUMBER\",\"customFieldId\":37,\"customFieldValueVOList\":[],
    \"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":37,\"isQuery\":0,\"isShow\":0,\"required\":0},{\"candidateValue\":[],
    \"columCode\":5,\"columName\":\"XXX的测试\",\"columType\":\"DATE\",\"customFieldId\":14,\"customFieldValueVOList\":[],\"customerId\":3,\"customerIdForUser\":3,
    \"defaultValue\":\"2024-06-19\",\"id\":14,\"isQuery\":0,\"isShow\":0,\"remark\":\"为啥没有显示\",\"required\":0,\"value\":\"2024/06/19\"},
    {\"candidateValue\":[],\"columCode\":7,\"columName\":\"出库人\",\"columType\":\"STRING\",\"customFieldId\":41,\"customFieldValueVOList\":[],
    \"customerId\":3,\"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":41,\"isQuery\":0,\"isShow\":0,\"required\":0},{\"candidateValue\":[\"自定栏是否出库\"],
    \"columCode\":8,\"columName\":\"测试栏4\",\"columType\":\"SELECT\",\"customFieldId\":36,\"customFieldValueVOList\":[],\"customerId\":3,
    \"customerIdForUser\":3,\"defaultValue\":\"\",\"id\":36,\"isQuery\":0,\"isShow\":0,\"required\":0}],\"odoPackageVOList\":[],
    \"odoSkuVOList\":[{\"quantity\":1,\"receiveNumber\":\"A250903149222_1\",\"sku\":\"ABSAR078205440\",\"skuId\":10008317,\"storageLocationCode\":\"SYS LOC\",
    \"title\":\"BBCOOL Popok Bayi Tipe Perekat – Lembut Daya Serap Tinggi Desain Pull-Up yang Nyaman untuk Bayi & Balita. M*34pcs\",
    \"unavailableQuantity\":0}],\"status\":\"WAIT_OUTBOUND\",\"type\":\"MANUAL\",\"warehouseId\":13275,\"warehouseName\":\"yqn_uat_001\",\"yunluFlag\":false}],
    \"state\":\"success\",\"total\":1}",
    "requestId": "d142863d-1b0a-4ce9-972c-b1d03c9039af"
}

1.5. Outbound feedback push interface

1.5.1. SERVICE_TYPE

PUSH_ODO_ORDER

1.5.2. Request

Params Require DataType Sample Description
number Y String A20220905 Delivery Order Number
customNumber N String C20220905 Reference Number
trackNumber Y String T20220905 Tracking Number
warehouseName Y String 马来仓库 Name of the warehouse for outbound shipments
type Y String MANUAL Outbound order type
shippingTime N Date shippingTime(yyyy-MM-dd HH:mm:ss)
carrier N String carrier
status Y String WAIT_OUTBOUND Outbound order status
skuList Y List<Sku> Sku Data
snInfo N SNInfo SN Information

Sku

Params Require DataType Sample Description
sku Y String S90 Product Sku
title Y String 商品标题 Product Title
storageLocationCode Y String SYS LOC Location Code
receiveNumber Y String A20220905 Batch number
quantity Y Long 100 The quantity of good products out of the warehouse
unavailableQuantity N Long 50 Outbound quantity of defective products (only Jietu warehouse + Qianyi WMS)
apiCustom N String apiCustom

SNInfo(SN Information)

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

Request example：

JSON Format：
{"number":"A20220905","customNumber":"C20220905","trackNumber":"T20220905","warehouseName":"马来仓库","type":"MANUAL","status":"WAIT_OUTBOUND","skuList":[{"sku":"S90","title":"商品标题","storageLocationCode":"SYS LOC","receiveNumber":"A20220905","quantity":100,"unavailableQuantity":50}],"snInfo":{"snUrl":"https://oss.com"}}
© Copyright QianYi Team 2025 All Rights Reserved            Updated 2025-12-12 09:42:51

results matching ""

    No results matching ""