Orders - Query List - OPEN-API-English

Request

Header Params

Content-Type

string

required

Example:

application/json

x-api-key

string

required

Example:

abc123(示例，具体值请联系商舟对接人)

Body Params multipart/form-data

page

integer

required

Page Number, e.g., 1

rows

integer

required

Number of rows per page, for example 10 (default maximum here is 100)

sidx

string

required

Sorting filed, can be hardcode ID

sort

string

required

Sorting rules: 'asc' ascending, 'desc' descending

beginDateTime

string

optional

Start Date (yyyy-mm-dd) string, UTC time e.g., '2020-07-10' ,( Time, Order Number, or Order ID, one of which is required)

endDateTime

string

optional

Start Date (yyyy-mm-dd) string, UTC time e.g., '2020-07-10' , (The time span between two dates should not exceed 30 days), (Time, Order Number, or Order ID, one of which is required)

channel

string

optional

Channel (such as Amazon, ebay)

channelAccount

string

optional

Channel Account（such as office-US）

orderNos

string

optional

Order Number (multiple entries separated by commas, such as test-001, test-002), (Time, Order Number, Order ID, one of which is required )

orderIds

string

optional

Oder ID (multiple entries separated by commas, such as 101790269,101790270), (Time, Order Number, or Order ID, one of which is required)

warehouseCode

string

optional

Warehouse Code (querying need to include the start time and end time), such as COPE_CA_US

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'http://127.0.0.1/v1/saleOrder/findByPage' \
--header 'x-api-key: abc123(示例，具体值请联系商舟对接人)' \
--form 'page=""' \
--form 'rows=""' \
--form 'sidx=""' \
--form 'sort=""' \
--form 'beginDateTime=""' \
--form 'endDateTime=""' \
--form 'channel=""' \
--form 'channelAccount=""' \
--form 'orderNos=""' \
--form 'orderIds=""' \
--form 'warehouseCode=""'

Responses

🟢200成功

application/json

Body

statusCode

number

required

status

number

required

code

number

required

message

string

required

data

object

required

pageable

object

required

totalElements

number

required

totalPages

number

required

last

boolean

required

first

boolean

required

sort

object

required

numberOfElements

number

required

size

number

required

number

required

empty

boolean

required

content

array [object {23}]

required

Return of Details for Multiple Orders

Example

{
  "statusCode": 200,
  "status": 0,
  "code": 200,
  "message": "获取订单数据成功",
  "data": {
    "pageable": {
      "draw": 0,
      "offset": 0,
      "pageNumber": 0,
      "pageSize": 13,
      "paged": true,
      "unpaged": false
    },
    "totalElements": 1,
    "totalPages": 1,
    "last": true,
    "first": true,
    "sort": {
      "sorted": true,
      "unsorted": false,
      "empty": false
    },
    "numberOfElements": 1,
    "size": 13,
    "number": 0,
    "empty": false,
    "content": [
      {
        "orderNo": "111--gugu-01",
        "paidAt": "2020-07-10 03:09:59",
        "channelAccount": "YTC_default",
        "shipToContact": "gu-contact",
        "shipToAddress1": "jiangShu nanjing",
        "shipToAddress2": "",
        "shipToAddress3": "",
        "shipToCity": "A",
        "shipToState": "SC",
        "shipToCountry": "US",
        "shipToPostal": "92504-8730",
        "shipToTelephone": "45454423424",
        "warehouseCode": "",
        "carrierCode": "",
        "thirdPartyAccount": "",
        "shipServiceLevel": "Standard-48 Hours",
        "currency": "USD",
        "isSignature": 0,
        "isInsure": 0,
        "errorCode": "unexception",
        "orderStatusEnum": "unshipped",
        "productItems": [
          {
            "sku": "591811Black",
            "quantity": 2,
            "skuAmount": 0.0000,
            "insureAmount": 0.0000
          }
        ],
        "enclosure": [
          {
            "type": "Shippinglabel",
            "name": "aa1.pdf",
            "url": "http://bizark-pdev-hz.oss-cn-hangzhou.aliyuncs.com/boss/B2cOrder/2020/06/29/22489f113e644df49ac7b2f4f409b50e.pdf"
          }
        ],
        "shipmentPackages": []
      }
    ]
  }
}