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) |
request example curl --location --request POST 'http://gerp-test1.800best.com/api/v1/odo' \ --form 'appId="CSBD_TEST"' \ --form 'serviceType="QUERY_ODO_LIST"' \ --form 'bizParam="{\"page\":1,\"pageSize\":2}"' \ --form 'timestamp="1741593077529"' \ --form 'sign="2b81c103e96180ba9d438140f3ca5b79"'
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 | Y | String | Lex th | carrier |
| carrierService | Y | String | Lex th | Logistics Name |
| secondaryType | N | String | MANUAL | Can be empty; External Order subtype (only supports Qianyi wms) MANUAL；PURCHASE_RETURN |
| trackingNumber | Y | 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 |
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 |
| unavailableQuantity | N | Long | 50 | Damage Outbound quantity(effective only for J&T warehouse and QIANYI wms) |
| apiCustom | N | String | ||
| batchNo | N | String(255) | 批次号，仅对千易wms生效 | |
| mfgDate | N | String | 2025-10-01 | 生产日期，仅对千易wms生效 |
| expDate | N | String | 2025-10-01 | 失效日期，仅对千易wms生效 |
| originCountry | N | String | CN | 生产地国家，仅对千易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 |
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 |
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 |