1. Order
API URL
post {HTTP(S)host} /api/{version}/salesOrder
1.1. Create Order
1.1.1. SERVICE_TYPE
CREATE_SALES_ORDER
1.1.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| shop | Y | String | “Amazon America” | Shop |
| onlineOrderNumber | Y | String | “ALI1238901” | online number, up to 50 characters |
| paymentMethod | Y | String | “Transfer” | Payment method |
| codPayAmount | N | Decimal | 10.02 | the amount of COD; Required only if the payment method is cash on delivery, 4 decimal places |
| freight | N | Decimal | 0 | Shipping cost, default is 0 4 decimal places |
| currency | Y | String | USD | See Monetary unit |
| buyerMessage | N | String | Message, up to 1024 characters | |
| sellerRemarks | N | String | Description，Maximum 1024 characters | |
| logisticsSelected | N | String | The logistics chosen by the buyer | |
| payTime | Y | String | Order Payment time (format: YYYY-MM-DD) | |
| buyer | Y | Buyer | See recipient details | |
| skuList | Y | List<Sku> | See product details | |
| orderCustomFieldValueVOList | N | List <SkuCustomFieldValueVO> |
Custom Field info |
Sku(Sku)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| sku | Y | String | “abc” | SKU，Maximum 255 characters |
| payAmount | Y | Decimal | 1.1 | Actual price (including freight), 4 decimal places Unit price of the product * quantity + freight of the product (calculated according to the allocation of Order freight) = actual price of the product (including freight) paymentPrice and payAmount are required to fill in one, if both are passed, the panAmount shall prevail |
| paymentPrice | Y | Decimal | 1.1 | Unit price of the product (excluding shipping fee), 4 decimal places |
| quantity | Y | Number | 1 | quantity |
| shippingPrice | N | Decimal | 0.1 | Shipping costs for goods |
| promotionDiscount | N | Decimal | 0.1 | Discounts for sellers |
Buyer(Receiver)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| buyerId | N | String | “sanzhang” | Buyer ID, up to 255 characters |
| receiverName | Y | String | “张三” | Recipient's name, up to 255 characters |
| phone | N | String | 1571234567 | Mobile/phone, up to 50 characters |
| N | String | E-mail address, maximum 255 characters | ||
| country | Y | String | US | Country |
| province | Y | String | Province/State , up to 100 characters | |
| city | Y | String | city , up to 50 characters | |
| district | N | String | District/county, up to 50 characters | |
| postCode | Y | String | Zip code, up to 50 characters | |
| address1 | Y | String | address 1, up to 255 characters | |
| address2 | N | String | address 2, up to 255 characters |
SkuCustomFieldValueVO(Custom Field )
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| customFieldId | Y | Long | 3 | ID returned by the interface SERVICE_TYPE = CUSTOMER_FIELD_QUERY |
| value | Y | String | “张三” | The value of Custom Field |
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 |
| result | Y | Order | see Order details |
1.2. Cancel Order
1.2.1. SERVICE_TYPE
CLOSE_SALES_ORDER
1.2.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| onlineOrderNumber | Y | String | online Order number | |
| shop | Y | String | Shop |
1.2.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 |
1.3. Order Query List
1.3.1. SERVICE_TYPE
QUERY_SALES_ORDER_LIST
PS：Due to data changes, there may be missing orders when paging this interface. It is recommended to first call QUERY_SALES_ORDER_NUMBER_LIST to obtain the order number, and then call this interface to achieve high query efficiency and avoid missing orders
1.3.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| status | N | String | Order status | |
| shop | N | String | Amazon美国 | Shop ，Maximum 255 characters |
| includesSoftDel | N | Number | 1 | Whether to include soft-deleted data in the returned result, which is not included by default, 1: contains; 0: Not included. conflicting orderTag, do not send it at the same time |
| orderNumber | N | String | S200222115613 | System Order number , up to 50 characters |
| orderNumbers | N | String | S200222115613, S200222115614 | Multiple Order number Separated by commas, the maximum number of characters cannot exceed 2000, and the maximum number of query orders should not exceed 200 |
| onlineOrderNumber | N | String | 20200119000035 | online Order number , up to 500 characters, multiple comma separations are supported |
| fuzzyOnlineOrderNumber | N | String | 20200119000035 | online Order number ，模糊查询，最大500字符 |
| orderTag | N | Number | 0;1 | Whether it is a regular system order 0: Regular system order 1: The original order number before the split order. conflicting with includesSoftDel, please do not send it at the same time |
| shopIdList | N | List<Long> | [1,2,3] | Shop id list |
| shopGroupIdList | N | List<Long> | [1,2,3] | Shop Group id list |
| fromPayTime | N | String | 2020-03-06 00:00:00 | Start payment time |
| toPayTime | N | String | 2020-03-07 00:00:00 | End of payment time， default fromPayTime +1 day |
| updateTimeFrom | N | String | 2020-03-07 00:00:00 | Order Update start time |
| updateTimeTo | N | String | 2020-03-07 00:00:00 | Order Update end time |
| shippingTimeFrom | N | String | 2020-03-07 00:00:00 | Shipping time starts |
| shippingTimeTo | N | String | 2020-03-07 00:00:00 | Shipping deadline +1 day by default |
| page | Y | Number | 1 | Page number, default 1 |
| pageSize | Y | Number | 50 | Number of records per page. no more than 200; Default is 100 |
| orderNumber orderNumbers onlineOrderNumber [fromPayTime,toPayTime] [updateTimeFrom, updateTimeTo] [latestShipTimeFrom, latestShipTimeTo] [shippingTimeFrom, shippingTimeTo] One of the 11 query conditions must be specified, and the time range cannot exceed 30 days If only one time range field is specified, the other time range field is +/- 30 days by default | ||||
| orderByParam | N | String | update_time | Currently, it is only supportedupdate_time |
| orderByOrder | N | String | desc | The enumeration value is： 1.desc 2.asc |
| combineSku | N | Boolean | true | true/false/null true：merger lazada Order details |
| siteCodeList | N | List<String> | [“SG”,”ID”] | Used to filter the shop have site code ，then filter Order |
| isAfn | N | Number | 1 | Inquire about the official warehouse delivery Order, pass 1 to take effect |
| excludeCombineSkuList | N | Boolean | true | true/false/null Only the details of the combination will be removed, and only the details of the single product and sub-products will be retained |
| orderCustomFieldValueSoList | N | List<SkuCustomFieldValueSO> | Custom Field Search criteria | |
| returnSnList | N | Boolean | true | Whether to return the product serial number, involving the business of scanning product serial numbers, pass true |
SkuCustomFieldValueSO(Custom Field search)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| customFieldId | Y | Long | 3 | request SERVICE_TYPE中=CUSTOMER_FIELD_QUERY return id |
| value | N | String | “张三” | Custom Field value STRING,SELECT |
| from | N | String | "1970/01/01" | Range query left interval : NUMBER, DATE。 |
| to | N | String | "1971/01/01" | The range query is the right interval : NUMBER, DATE。 |
1.3.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<Order> | Order details |
Order( Order )
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| orderNumber | Y | String | System order number | |
| parentOrderNumber | N | String | The parent order corresponds to the child order after the order split System order number | |
| subOrderNumberList | N | List <String> |
The parent order corresponding to the child order after the order is closed System order number | |
| isOriginalOrder | N | Boolean | Whether it is original or not Order | |
| onlineOrderNumber | N | String | online order number | |
| shop | Y | String | Shop name | |
| warehouse | N | String | Warehouse | |
| status | Y | String | CLOSE | Order |
| wmsStatus | Y | String | picking | Currently, only 1,000 warehouses are supported |
| currency | Y | String | ”USD“ | Monetary unit |
| totalAmount | Y | Decimal | 20.1 | The total amount |
| freight | Y | Decimal | 2.1 | Carriage |
| buyerMessage | N | String | Buyer's message | |
| sellerRemarks | N | String | Seller's message | |
| carrier | N | String | carrier | |
| platform | Y | String | LAZADA | Platform |
| updateTime | Y | Date | Recently Updated time | |
| trackingNumber | N | String | trackingNumber | |
| payTime | N | Datetime | Payment time | |
| shippingTime | N | Datetime | Shipping time | |
| createTime | Y | Datetime | Creation time | |
| buyer | Y | Buyer | See Buyer | |
| estimateFulfillmentFee | N | Decimal | 0.1 | Estimated shipping costs |
| totalDiscount | N | Decimal | 0.1 | Order Total Offer |
| sellerDiscount | N | Decimal | 0.1 | Order Seller Offers |
| platformRebate | N | Decimal | 0.1 | Order Platform subsidy |
| buyerPaidShippingFee | N | Decimal | 0.1 | The buyer pays for shipping |
| finalProductProtection | N | Decimal | 0.1 | Protection fee |
| sellerDiscountForWook | N | Decimal | 0.1 | Coupons, wook customization |
| platformRebateForWook | N | Decimal | 0.1 | Platform subsidy, wook customization |
| auditTime | Y | Datetime | Review time | |
| latestShipDate | N | Datetime | Latest shipping time | |
| skuList | Y | List<Sku> | See Sku | |
| tag | N | Tag | Order tag | |
| platformReturnToSeller | N | Decimal | 0.1 | The platform will refund the seller's amount |
| isBusinessOrder | N | Boolean | true | Whether it is a business buyer |
| salesRecordNumber | N | String | Seller's sales record ID, short tracking number of the Shopify platform (customer-defined tracking number) | |
| siteCode | N | String | SG | Site code of Shop |
| isAfn | Y | Number | 1 | Whether the official warehouse is shipped, just Amazon order |
| platformShippingTime | N | Datetime | Platform shipping time | |
| paymentMethod | Y | String | PAY_ONLINE | Payment Methods，COD、PAY_ONLINE、OPEN_ACCOUNT. |
| isDeleted | Y | Number | 1 | Whether it is a soft-deleted order, 0 is not soft-deleted, !0 is soft-deleted |
| orderCustomFieldValueVOList | N | SkuCustomFieldValueVO | Custom Field info | |
| subOrderNumberList | N | List <String> |
The parent order corresponding to the child order after the order is closed System order number | |
| onlineStatus | N | String | Online order status |
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 |
Tag( Order tag)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| hasRefund | N | Number | 0 | There is a refund (1: Yes, 0 No) |
| itemReturned | N | Number | 0 | There are refund |
| consolidated | N | Number | 0 | Merged |
| split | N | Number | 0 | Splited |
| locked | N | Number | 0 | Locked |
| sendWms | N | Number | 0 | Sended |
| sendFailed | N | Number | 0 | Send falid |
| onlineShipFeedbackAlready | N | Number | 0 | Platform shipment has been marked |
| onlineShipFeedbackFailed | N | Number | 0 | Flag platform fulfillment failed |
| outOfStock | N | Number | 0 | lack of inventory |
| preSale | N | Number | 0 | pre-sale |
| onlineShipped | N | Number | 0 | Order Shipped tag |
| platformFulfillment | N | Number | 0 | Whether the official warehouse is shipped, 1: Yes;0: No, except Amazon order |
| partRefund | N | Number | 0 | Part Refund (1: Yes, 0 No) |
| allRefund | N | Number | 0 | All Refund (1: Yes, 0 No) |
| allReturned | N | Number | 0 | All Returned (1: Yes, 0 No) |
| partReturned | N | Number | 0 | Part Returned (1: Yes, 0 No) |
Buyer(Receiver)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| buyerId | N | String | “sanzhang” | Buyer ID |
| receiverName | Y | String | “张三” | Recipient's name |
| phone | N | String | mobile number 1 | |
| N | String | |||
| country | Y | String | US | Country |
| province | Y | String | Province/State | |
| city | Y | String | city | |
| postCode | N | String | Zip | |
| address1 | Y | String | address 1 | |
| address2 | N | String | address 2 |
Sku( Order details)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| orderSkuId | Y | Number | 11 | sales Order sku ID |
| sku | Y | String | “abc” | SKU |
| sourceCombinedSku | N | String | “abc” | If the detail line is a sub-item that is taken out of the assembly, this field displays the product code of the combination from which it originated |
| quantity | Y | String | 1 | The number of sku |
| onlineItemId | Y | String | online sku ID | |
| payAmount | Y | Decimal | Actual price | |
| totalTax | Y | Decimal | Taxation | |
| totalDiscount | Y | Decimal | discount | |
| platformDiscount | N | Decimal | 0.1 | Commodity platform discounts |
| originalPrice | N | Decimal | 0.1 | The original unit price of the item |
| paymentPrice | N | Decimal | 0.1 | The actual unit price of the product |
| shippingPrice | N | Decimal | 0.1 | Shipping costs for goods |
| promotionDiscount | N | Decimal | 0.1 | Discounts for sellers |
| discountPrice | N | Decimal | 0.1 | Discounted price |
| subSkuList | N | List<Sku> | List of child products | |
| tag | N | SkuTag | Order sku tags | |
| points | N | String | 500 | Amazon Order Credits for the product |
| onlineProductCode | N | String | 10011 | online sku code |
| onlineProductTitle | N | String | Floral dress | online The title of the product |
| onlineProductPicUrl | N | String | https://www.test.com/aaa.png | online sku images address |
| onlineTransactionId | N | String | "1111111111" | onlineTransactionId |
| snList | N | List |
["111","222"] | List of Product Serial Numbers |
SkuTag ( Order detail tag)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| isGift | N | Number | 0 | Giveaway (1: Yes, 0 No) |
| preSale | N | Number | 0 | Pre-sale |
| hasRefund | N | Number | 0 | Has Refund (1: Yes, 0 No) |
| allReturned | N | Number | 0 | All Returned (1: Yes, 0 No) |
1.4. Order number Query List
1.4.1. SERVICE_TYPE
QUERY_SALES_ORDER_NUMBER_LIST
PS：request is same as query Order list
1.4.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| status | N | String | Order status | |
| shop | N | String | Amazon美国 | Shop ，Maximum 255 characters |
| includesSoftDel | N | Number | 1 | Whether to include soft-deleted data in the returned result, which is not included by default, 1: contains; 0: Not included. conflicting orderTag, do not send it at the same time |
| orderNumber | N | String | S200222115613 | System Order number , up to 50 characters |
| orderNumbers | N | String | S200222115613, S200222115614 | Multiple Order number Separated by commas, the maximum number of characters cannot exceed 2000, and the maximum number of query orders should not exceed 200 |
| onlineOrderNumber | N | String | 20200119000035 | online Order number , up to 500 characters, multiple comma separations are supported |
| fuzzyOnlineOrderNumber | N | String | 20200119000035 | online Order number ，模糊查询，最大500字符 |
| orderTag | N | Number | 0;1 | Whether it is a regular system order 0: Regular system order 1: The original order number before the split order. conflicting with includesSoftDel, please do not send it at the same time |
| shopIdList | N | List<Long> | [1,2,3] | Shop id list |
| shopGroupIdList | N | List<Long> | [1,2,3] | Shop Group id list |
| fromPayTime | N | String | 2020-03-06 00:00:00 | Start payment time |
| toPayTime | N | String | 2020-03-07 00:00:00 | End of payment time， default fromPayTime +1 day |
| updateTimeFrom | N | String | 2020-03-07 00:00:00 | Order Update start time |
| updateTimeTo | N | String | 2020-03-07 00:00:00 | Order Update end time |
| shippingTimeFrom | N | String | 2020-03-07 00:00:00 | Shipping time starts |
| shippingTimeTo | N | String | 2020-03-07 00:00:00 | Shipping deadline +1 day by default |
| page | N | Number | 1 | Page number, default 1 |
| pageSize | N | Number | 50 | Number of recordper page. no more than 200; Default is 100 |
| orderNumber orderNumbers onlineOrderNumber [fromPayTime,toPayTime] [updateTimeFrom, updateTimeTo] [latestShipTimeFrom, latestShipTimeTo] [shippingTimeFrom, shippingTimeTo] One of the 11 query conditions must be specified, and the time range cannot exceed 30 days If only one time range field is specified, the other time range field is +/- 30 days by default | ||||
| orderByParam | N | String | update_time | Currently, it is only supportedupdate_time |
| orderByOrder | N | String | desc | The enumeration value is： 1.desc 2.asc |
| combineSku | N | Boolean | true | true/false/null true：merger lazada Order details |
| siteCodeList | N | List<String> | [“SG”,”ID”] | Used to filter the shop have site code ，then filter Order |
| isAfn | N | Number | 1 | Inquire about the official warehouse delivery Order, pass 1 to take effect |
| excludeCombineSkuList | N | Boolean | true | true/false/null Only the details of the combination will be removed, and only the details of the single product and sub-products will be retained |
| orderCustomFieldValueSoList | N | List<SkuCustomFieldValueSO> | Custom Field Search criteria |
SkuCustomFieldValueSO(Custom Field search)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| customFieldId | Y | Long | 3 | request SERVICE_TYPE中=CUSTOMER_FIELD_QUERY return id |
| value | N | String | “张三” | Custom Field value STRING,SELECT |
| from | N | String | "1970/01/01" | Range query left interval : NUMBER, DATE。 |
| to | N | String | "1971/01/01" | The range query is the right interval : NUMBER, DATE。 |
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<String> | Order number list |
1.5. Order Shipping info
1.5.1. SERVICE_TYPE
PUSH_SALES_ORDER_SHIPPING_INFO
1.5.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 |
1.6. create Order
1.6.1. SERVICE_TYPE
CREATE_AND_AUDIT_SALES_ORDER
1.6.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| shop | Y | String | “Amazona merica” | Shop |
| onlineOrderNumber | Y | String | “ALI1238901” | online number, up to 50 characters |
| paymentMethod | Y | String | “在线支付” | Payment method |
| codPayAmount | N | Decimal | 10.02 | the amount of COD; Required only if the payment method is cash on delivery, 4 decimal places |
| freight | N | Decimal | 0 | Shipping cost, default is 0 4 decimal places |
| currency | Y | String | USD | See Monetary unit |
| buyerMessage | N | String | Message, up to 1024 characters | |
| sellerRemarks | N | String | Description，Maximum 1024 characters | |
| logisticsSelected | N | String | The logistics chosen by the buyer | |
| payTime | Y | Timestamp | Order Payment time | |
| buyer | Y | Buyer | See recipient details | |
| skuList | Y | List<Sku> | See order details | |
| warehouse | Y | String | “BEST泰国仓” | Order Shipping warehouse |
| logistics | Y | String | “AUTO” | Order Logistics Name |
Sku(order details)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| sku | Y | String | “abc” | SKU, up to 255 characters |
| payAmount | Y | Decimal | 1.1 | The actual price (including shipping fee), 4 decimal places |
| quantity | Y | Number | 1 | quantity |
Buyer(Receiver)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| buyerId | N | String | “sanzhang” | Buyer ID |
| receiverName | Y | String | “张三” | Recipient's name |
| phone | N | String | mobile number 1 | |
| N | String | |||
| country | Y | String | US | Country |
| province | Y | String | Province/State | |
| city | Y | String | city | |
| postCode | N | String | Zip | |
| address1 | Y | String | address 1 | |
| address2 | N | String | address 2 |
1.6.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 |
| result | Y | Order | Please refer to Order for details |
1.7. Audit Order
1.7.1. SERVICE_TYPE
AUDIT_SALES_ORDER
1.7.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| shop | Y | String | “Amazon美国” | Shop |
| onlineOrderNumber | Y | String | “ALI1238901” | online number, up to 50 characters |
| warehouse | Y | String | “BEST泰国仓” | Order Shipping warehouse |
| logistics | Y | String | “AUTO” | Order shipping Logistics Name |
1.7.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 |
1.8. Send Order to wms
1.8.1. SERVICE_TYPE
SEND_SALES_ORDER
1.8.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| onlineOrderNumber | Y | String | online Order number | |
| shop | Y | String | Shop |
1.8.3. Reponse
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| errorCode | Y | String | “DATA_INPUT_ERROR” | [Error Code](/commons/errors.md#Error Code |
| errorMsg | Y | String | “The input of Params is incorrect” | Business Error Messages |
| state | Y | String | success | Response State |
1.9. Query original Order
1.9.1. SERVICE_TYPE
QUERY_SKU_SOURCE_ORDER
1.9.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| orderNumbers | Y | String | O123,O456 | Multiple Order number Separated by commas, the maximum number of characters cannot exceed 2000, and the maximum number of query orders cannot exceed 50 |
1.9.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<Order> | Order For list information, see Order details for details |
Order( Order )
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| orderNumber | Y | String | System order number | |
| parentOrderNumber | N | String | The parent order corresponds to the child order after the order split System order number | |
| subOrderNumberList | N | List <String> |
The parent order corresponding to the child order after the order is closed System order number | |
| isOriginalOrder | N | Boolean | Whether it is original or not Order | |
| onlineOrderNumber | N | String | online order number | |
| shop | Y | String | Shop name | |
| warehouse | N | String | Warehouse | |
| status | Y | String | CLOSE | Order |
| wmsStatus | Y | String | picking | Currently, only 1,000 warehouses are supported |
| currency | Y | String | ”USD“ | Monetary unit |
| totalAmount | Y | Decimal | 20.1 | The total amount |
| freight | Y | Decimal | 2.1 | Carriage |
| buyerMessage | N | String | Buyer's message | |
| sellerRemarks | N | String | Seller's message | |
| carrier | N | String | carrier | |
| platform | Y | String | LAZADA | Platform |
| updateTime | Y | Date | Recently Updated time | |
| trackingNumber | N | String | trackingNumber | |
| payTime | N | Datetime | Payment time | |
| shippingTime | N | Datetime | Shipping time | |
| createTime | Y | Datetime | Creation time | |
| buyer | Y | Buyer | See Buyer | |
| estimateFulfillmentFee | N | Decimal | 0.1 | Estimated shipping costs |
| totalDiscount | N | Decimal | 0.1 | Order Total Offer |
| sellerDiscount | N | Decimal | 0.1 | Order Seller Offers |
| platformRebate | N | Decimal | 0.1 | Order Platform subsidy |
| buyerPaidShippingFee | N | Decimal | 0.1 | The buyer pays for shipping |
| finalProductProtection | N | Decimal | 0.1 | Protection fee |
| sellerDiscountForWook | N | Decimal | 0.1 | Coupons, wook customization |
| platformRebateForWook | N | Decimal | 0.1 | Platform subsidy, wook customization |
| auditTime | Y | Datetime | Review time | |
| latestShipDate | N | Datetime | Latest shipping time | |
| skuList | Y | List<Sku> | See Sku | |
| tag | N | Tag | Order tag | |
| platformReturnToSeller | N | Decimal | 0.1 | The platform will refund the seller's amount |
| isBusinessOrder | N | Boolean | true | Whether it is a business buyer |
| salesRecordNumber | N | String | Seller's sales record ID, short tracking number of the Shopify platform (customer-defined tracking number) | |
| siteCode | N | String | SG | Site code of Shop |
| isAfn | Y | Number | 1 | Whether the official warehouse is shipped |
| platformShippingTime | N | Datetime | Platform shipping time | |
| paymentMethod | Y | String | PAY_ONLINE | Payment Methods，COD、PAY_ONLINE、OPEN_ACCOUNT. |
| isDeleted | Y | Number | 1 | Whether it is a soft-deleted order, 0 is not soft-deleted, !0 is soft-deleted |
| orderCustomFieldValueVOList | N | SkuCustomFieldValueVO | Custom Field info | |
| subOrderNumberList | N | List <String> |
The parent order corresponding to the child order after the order is closed System order number |
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 |
Tag( Order tag)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| hasRefund | N | Number | 0 | There is a refund (1: Yes, 0 No) |
| itemReturned | N | Number | 0 | There are refund |
| consolidated | N | Number | 0 | Merged |
| split | N | Number | 0 | Splited |
| locked | N | Number | 0 | Locked |
| sendWms | N | Number | 0 | Sended |
| sendFailed | N | Number | 0 | Send falid |
| onlineShipFeedbackAlready | N | Number | 0 | Platform shipment has been marked |
| onlineShipFeedbackFailed | N | Number | 0 | Flag platform fulfillment failed |
| outOfStock | N | Number | 0 | lack of inventory |
| preSale | N | Number | 0 | pre-sale |
| onlineShipped | N | Number | 0 | Order Shipped tag |
Buyer(Receiver)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| buyerId | N | String | “sanzhang” | Buyer ID |
| receiverName | Y | String | “张三” | Recipient's name |
| phone | N | String | mobile number 1 | |
| N | String | |||
| country | Y | String | US | Country |
| province | Y | String | Province/State | |
| city | Y | String | city | |
| postCode | N | String | Zip | |
| address1 | Y | String | address 1 | |
| address2 | N | String | address 2 |
Sku( Order details)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| orderSkuId | Y | Number | 11 | sales Order sku ID |
| sku | Y | String | “abc” | SKU |
| sourceCombinedSku | N | String | “abc” | If the detail line is a sub-item that is taken out of the assembly, this field displays the product code of the combination from which it originated |
| quantity | Y | String | 1 | The number of sku |
| onlineItemId | Y | String | online sku ID | |
| payAmount | Y | Decimal | Actual price | |
| totalTax | Y | Decimal | Taxation | |
| totalDiscount | Y | Decimal | discount | |
| platformDiscount | N | Decimal | 0.1 | Commodity platform discounts |
| originalPrice | N | Decimal | 0.1 | The original unit price of the item |
| paymentPrice | N | Decimal | 0.1 | The actual unit price of the product |
| shippingPrice | N | Decimal | 0.1 | Shipping costs for goods |
| promotionDiscount | N | Decimal | 0.1 | Discounts for sellers |
| discountPrice | N | Decimal | 0.1 | Discounted price |
| subSkuList | N | List<Sku> | List of child products | |
| tag | N | SkuTag | Order sku tags | |
| points | N | String | 500 | Amazon Order Credits for the product |
| onlineProductCode | N | String | 10011 | online sku code |
| onlineProductTitle | N | String | Floral dress | online The title of the product |
| onlineProductPicUrl | N | String | https://www.test.com/aaa.png | online sku images address |
| onlineTransactionId | N | String | "1111111111" | onlineTransactionId |
SkuTag ( Order detail tag)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| isGift | N | Number | 0 | Giveaway (1: Yes, 0 No) |
| preSale | N | Number | 0 | Pre-sale |
SourceOrderList(Original business order)
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| type | Y | String | PURCHASE | Business order type |
| businessNumber | Y | String | P123456 | businessNumber |
| purchasePrice | Decimal | 0.1 | Procurement Fee (Single Piece) | |
| purchasePriceUnit | String | CNY | The currency of the purchase fee | |
| firstLegPrice | Decimal | 0.1 | Headway fee (single piece) | |
| firstLegPriceUnit | String | CNY | The currency of the first-mile fee | |
| transferPrice | Decimal | 0.1 | Transfers (single item) | |
| transferPriceUnit | String | CNY | The currency in which the transfer fee is transferred | |
| quantity | Number | 1 | The number of items per business of that type occupied by the Order item |
1.10. Query Order pickup status
1.10.1. SERVICE_TYPE
QUERY_ORDER_PICK_UP_STATUS
1.10.2. Request
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| orderNumbers | Y | List<String> | ["order001", "order002"] | Order number list |
1.10.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 |
| result | Y | List<OrderLogisticsInfo> | Order Pickup status information |
OrderLogisticsInfo
| Params | Require | DataType | Sample | Description |
|---|---|---|---|---|
| orderNumber | Y | String | System order number | |
| trackingNumber | N | String | trackingNumber | |
| status | Y | String | SHIPPED | Order 状态 |
| isPicked | N | Boolean | true | Order Whether it has been picked up, true or false |