订单-- 查询列表 - OPEN-API-客户对接【外】

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

x-api-key

string

必需

示例值:

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

Body 参数multipart/form-data

page

integer

必需

(第几页) 例 1

rows

integer

必需

一页的行数，例 10 (这儿默认最高100)

sidx

string

必需

排序字段，可写死 'id'

sort

string

必需

排序规则升序'asc' ,降序 'desc '

beginDateTime

string

可选

开始时间（yyyy-mm-dd）字符串，utc 时间例 '2020-07-10' ,( 时间,订单号，订单id必填其一 )

endDateTime

string

可选

结束时间（yyyy-mm-dd）字符串，utc 时间例 '2020-07-10' （两个时间的跨度不要超过30天),( 时间,订单号，订单id必填其一 )

channel

string

可选

平台(如amazon,ebay)

channelAccount

string

可选

渠道账号（如 office-US）

orderNos

string

可选

订单号 ( 多条以","号隔开 , 如 test-001,test-002) ,( 时间,订单号，订单id必填其一 )

orderIds

string

可选

订单id ( 多条以","号隔开 , 如 101790269,101790270) ,,( 时间,订单号，订单id必填其一 )

warehouseCode

string

可选

仓库code（查询时需要加上开始时间和结束时间）如 COPE_CA_US

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://hwc-open-api.yqn.com/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=""'

返回响应

🟢200成功

application/json

Body

statusCode

number

必需

status

number

必需

code

number

必需

message

string

必需

data

object

必需

pageable

object

必需

totalElements

number

必需

totalPages

number

必需

last

boolean

必需

first

boolean

必需

sort

object

必需

numberOfElements

number

必需

size

number

必需

number

必需

empty

boolean

必需

content

array [object {27}]

多条订单的详情返回

必需

示例

{
  "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,
            "insureAmount": 0
          }
        ],
        "enclosure": [
          {
            "type": "Shippinglabel",
            "name": "aa1.pdf",
            "url": "http://bizark-pdev-hz.oss-cn-hangzhou.aliyuncs.com/boss/B2cOrder/2020/06/29/22489f113e644df49ac7b2f4f409b50e.pdf"
          }
        ],
        "shipmentPackages": []
      }
    ]
  }
}