Open-Agent-Api

8.1 订单创建

POST

/api/v2/Order/create

NewOrder

创建意向订单

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Header 参数

channel

string

可选

默认值:

benlai

shopId

string

商城id

可选

默认值:

123

Body 参数application/json

创建订单模型

out_trade_no

string

商户订单号

可选

单合作方该值唯一

receive_contact

string

收货人姓名

可选

receive_phone

string

收货人手机号

可选

province

string

省

可选

city

string

市

可选

county

string

县（区）

可选

receive_address

string

收货地址

可选

order_price

number <double>

订单价格

可选

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

out_order_price

number <double>

实际订单价格

可选

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

ship_price

number <double>

运费

可选

无运费则传0保留2位小数

order_detail

array[object (Benlai.Open.Services.Model.CreateItemInfo) {5}]

订单详情

可选

product_id

string

商品编号

可选

product_name

string

商品名称

可选

quantity

integer <int32>

商品数量

可选

price

number <double>

商品含税单价

可选

保留2位小数
保如有促销优惠，则单价为减去优惠后单个SKU的单件价格

out_price

number <double>

实际商品含税单价

可选

保留2位小数
保如有促销优惠，则单价为减去优惠后单个SKU的单件价格

order_invoice

object (Benlai.Open.Services.Model.CreateInvoiceInfo)

可选

invoice_type

string

发票类型

可选

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

title

string

发票抬头

可选

title_type

string

抬头类型

可选

PERSONAL：个人
ENTERPRISE：企业

tax_no

string

税号

可选

抬头类型为企业时必传

string

电子邮箱

可选

发票类型为电子发票时必传

delivery_date

string

配送时间

可选

示例

{
    "out_trade_no": "OT177886655443399544",
    "receive_contact": "张三",
    "receive_phone": "13800138000",
    "city": "北京市",
    "county": "北京市",
    "province": "怀柔区",
    "receive_address": "西斗门路3号天堂软件园D幢5楼",
    "order_price": 24.00,
    "ship_price": 0.00,
    "delivery_date": "WorkDay",
    "order_detail": [
        {
            "product_id": "P0000122741",
            "product_name": "秘鲁进口红提 1kg",
            "quantity": 2,
            "price": 12.00
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open-agent-branch.benlai.com/api/v2/Order/create' \
--header 'channel: benlai' \
--header 'shopId: 123' \
--header 'Content-Type: application/json' \
--data-raw '{
    "out_trade_no": "OT177886655443399544",
    "receive_contact": "张三",
    "receive_phone": "13800138000",
    "city": "北京市",
    "county": "北京市",
    "province": "怀柔区",
    "receive_address": "西斗门路3号天堂软件园D幢5楼",
    "order_price": 24.00,
    "ship_price": 0.00,
    "delivery_date": "WorkDay",
    "order_detail": [
        {
            "product_id": "P0000122741",
            "product_name": "秘鲁进口红提 1kg",
            "quantity": 2,
            "price": 12.00
        }
    ]
}'

返回响应

🟢200成功

text/plain

Success

Body

trade_no

string

预订单号

可选

create_date

string

创单时间

可选

格式， “yyyyMMddHHmmss”

expire

integer <int64>

创单过期时间.

可选

秒级别，比如代表86400秒后过期，即24小时有效期

示例

成功示例异常示例

{
    "code": 0,
    "msg": "success",
    "value": {
        "trade_no": "P201904281205357746347224963",
        "create_date": "20190428120535",
        "expire": 600
    }
}

7.1 获取商品库存

8.2 订单确认