供应链API

按买方订单号获取订单接口

POST

/order/query-order-by-buyer-order-id

订单接口

raw方式传入买方orderId,或者{"orderId":"10000000"}的形式

请求参数

Header 参数

apiKey

string

用户的apiKey

必需

sign

string

签名

必需

timestamp

string

当前时间戳

必需

Body 参数application/json

string

可选

示例

"string"

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://prod-cn.your-api-server.com/order/query-order-by-buyer-order-id' \
--header 'apiKey;' \
--header 'sign;' \
--header 'timestamp;' \
--header 'Content-Type: application/json' \
--data-raw '"string"'

返回响应

🟢200OK

application/json

Body

code

integer <int32>

可选

状态码，为0表示请求成功，其它则失败

data

object (订单 ModelOrder)

业务对象

可选

address

string

收件人地址

可选

buyerOrderId

string

买方订单号

可选

city

string

收件人所在市

可选

contactName

string

收件人姓名

可选

createTime

integer <int64>

可选

订单创建时间(毫秒)

expressFee

number

可选

快递费,提交订单时请不要设置此值

extra

string

可选

额外信息，一般用于API回调,不能大于200个字符

string

本平台订单编号

可选

orderSubList

array[object (子订单 OrderSub) {11}]

可选

要购买的商品规格列表

phone

string

收件人电话

可选

province

string

收件人所在省

可选

status

integer <int32>

可选

订单状态 1:待支付 2:支付完成

totalPay

number

可选

支付金额，包含快递费

msg

string

错误信息

可选

示例

{
  "code": 0,
  "data": {
    "address": "string",
    "buyerOrderId": "string",
    "city": "string",
    "contactName": "string",
    "createTime": 0,
    "expressFee": 0,
    "extra": "string",
    "id": "string",
    "orderSubList": [
      {
        "exceptionReason": "string",
        "expressCompany": "string",
        "expressNumber": "string",
        "expressStatus": 0,
        "expressTime": 0,
        "id": "string",
        "price": 0,
        "productSpecsId": "string",
        "quantity": 0,
        "remarks": "string",
        "sellerRemarks": "string"
      }
    ],
    "phone": "string",
    "province": "string",
    "status": 0,
    "totalPay": 0
  },
  "msg": "string"
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

修改于 2023-02-22 09:19:03

按订单号获取订单接口

按子订单号获取子订单接口