8.4 订单查询 - Open-Agent-Api

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Query 参数

out_trade_no

string

可选

商户订单号
out_trade_no、order_id 两个单号必传其一。都传优先查询商户订单号。

>= 0 字符<= 32 字符

示例值:

39036799440040000

order_id

string

可选

接单方订单id
out_trade_no、order_id 两个单号必传其一。都传优先查询商户订单号。

>= 0 字符<= 32 字符

示例值:

1908940273

Header 参数

channel

string

可选

默认值:

benlai

shopId

string

商城id

可选

默认值:

123

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://open-agent-branch.benlai.com/api/v2/Order/query?out_trade_no=39036799440040000&order_id=1908940273' \
--header 'channel: benlai' \
--header 'shopId: 123'

返回响应

🟢200成功

text/plain

Success

Body

out_trade_no

string

商户订单号

可选

您的订单id

order_id

string

接单方订单id

可选

本分销平台的订单id

receive_contact

string

收货人姓名

可选

receive_phone

string

收货人手机号

可选

province

string

省

可选

city

string

市

可选

county

string

县（区）

可选

receive_address

string

收货地址

可选

order_price

number <double>

订单价格

可选

保留2位小数
如有订单优惠，则此处金额为
订单原价-订单优惠金额

order_status

string

订单状态

可选

ORDER_STATUS_INITIAL 订单初始
ORDER_STATUS_REVOKE 订单作废
ORDER_STATUS_CANCEL 订单取消
ORDER_STATUS_CONFIRM 订单确认
ORDER_STATUS_EXPRESS_WAIT 订单商品待出库
ORDER_STATUS_EXPRESS_PART 订单商品部分出库
ORDER_STATUS_EXPRESS_FULL 订单商品全出库
ORDER_STATUS_EXPRESS_COMPLETE 订单商品妥投完成

order_status_remark

string

订单状态描述

可选

ORDER_STATUS_INITIAL 订单初始
ORDER_STATUS_REVOKE 订单作废
ORDER_STATUS_CANCEL 订单取消
ORDER_STATUS_CONFIRM 订单确认
ORDER_STATUS_EXPRESS_WAIT 订单商品待出库
ORDER_STATUS_EXPRESS_PART 订单商品部分出库
ORDER_STATUS_EXPRESS_FULL 订单商品全出库
ORDER_STATUS_EXPRESS_COMPLETE 订单商品妥投完成

create_date

string

创单时间

可选

格式， “yyyyMMddHHmmss”

ship_price

number <double>

运费价格

可选

order_discount

number <double>

订单优惠金额

可选

expire_date

string

订单未确认作废时间

可选

格式， “yyyyMMddHHmmss”

order_detail

array[object (Benlai.Open.Models.Order.orderDetailModel) {5}]

订单详情

可选

product_id

string

商品编号

可选

product_name

string

商品名称

可选

quantity

integer <int32>

商品数量

可选

price

number <double>

商品含税单价

可选

如有促销优惠，则单价为减去优惠后单个SKU的单件价格

product_discount

number <double>

商品优惠金额

可选

如有促销优惠，此字段为当前SKU总数的优惠总额

order_invoice

object (Benlai.Open.Models.Order.orderInvoiceModel)

可选

invoice_type

string

发票类型

可选

ELECTRONIC：电子发票
PAPER：纸质发票

title

string

发票抬头

可选

title_type

string

抬头类型

可选

PERSONAL：个人
ENTERPRISE：企业

tax_no

string

税号

可选

email

string

电子邮箱

可选

do_list

array[string]

出库单号列表

可选

示例

成功示例异常示例

{
    "code": 0,
    "msg": "success",
    "value": {
        "out_trade_no": "110119112114109",
        "order_id": "1900286003",
        "receive_contact": "沙和尚110",
        "receive_phone": "13661844883",
        "receive_address": "北京市北京市朝阳区圣爱大厦公园",
        "order_price": 200,
        "province": "北京市",
        "city": "北京市",
        "county": "朝阳区",
        "order_status": "ORDER_STATUS_EXPRESS_COMPLETE",
        "order_status_remark": "订单商品妥投完成",
        "create_date": "20190418144552",
        "ship_price": 0,
        "order_detail": [
            {
                "product_id": "P0000061617",
                "product_name": "新疆库尔勒香梨 8-10粒（约1kg）",
                "quantity": 1,
                "price": 200
            }
        ],
        "do_list": [
            "D661021529437"
        ]
    }
}