查询订单列表 - 探马OpenAPI

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

pageNo

integer

页号

可选

默认1

pageSize

integer

数量

可选

默认30

channelId

string

平台id

必需

startDate

string

下单开始时间

可选

endDate

string

下单结束时间

可选

keyWord

string

订单编号或者客户姓名

可选

status

number

订单状态

可选

1：待支付；2：已支付；3：已发货；4：已完成；5：售后中；6：已关闭；7：已取消

示例

{
  "pageNo": 1,
  "pageSize": 15,
  "channelId": "12306",
  "startDate":"2021-11-14 00:00:00",
  "endDate":"2021-12-13 23:59:59"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/external/order/list/get' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "pageNo": 1,
  "pageSize": 15,
  "channelId": "12306",
  "startDate":"2021-11-14 00:00:00",
  "endDate":"2021-12-13 23:59:59"
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

示例：0

message

string

响应结果

必需

示例：success

data

object

必需

数据体。以下为data中的参数

currentPage

integer

页号

必需

示例：1

pageSize

integer

数量

必需

示例：15

totalPage

integer

总页数

必需

示例：8

totalCount

integer

总数量

必需

示例：115

list

array [object {14}]

示例：-

必需

示例

{
    "code": 0,
    "message": "success",
    "data": {
        "currentPage": 1,
        "pageSize": 15,
        "totalPage": 8,
        "totalCount": 115,
        "list": [
            {
                "id": "85fd72f95c0e11eca61600163e106b20",
                "corpid": "xxx",
                "salesId": 444256224170048,
                "customerId": 444926101606464,
                "channelId": "12306",
                "channelName": "12306",
                "shopId": "TEST",
                "shopName": "测试店铺",
                "orderId": "TEST_12345678",
                "orderPrice": 0.01,
                "status": 2,
                "orderTime": "2021-12-10 15:53:29",
                "customDefine": [
                    {
                        "key": "1191",
                        "value": "xxx"
                    },
                    {
                        "key": "1190",
                        "value": "1"
                    }
                ],
                "goodsList": [
                    {
                        "goodName": "测试商品",
                        "imageUrl": "https://xxx",
                        "goodPrice": 0.01,
                        "num": 1
                    }
                ]
            }
        ]
    }
}