日期 版本号 作者 说明
2023-2-28 1.0 小陈 第一版

接口说明

返回格式

  1. {
  2.     "code": 200,
  3.     "msg": "推送成功",
  4.     "data": null
  5. }
字段名 数据类型 必填 是
code Integer 是 状态码
msg String 是 返回内容
data Object 是 数据对象

响应状态码

状态码 含义
200 成功
400 参数错误
401 未授权
404 页面不存在
500 服务器内部异常

协议规则

属性 规则
传输方式 为保证传输数据安全性，采用 HTTPS 传输
提交方式 POST
数据格式 JSON
签名算法 SHA-1
字符编码 UTF-8

签名Demo

附上文件，例如：SignUtils.java

白名单

如果需要白名单，可在在此说明

接口列表

查询订单

功能描述

第三方平台调用我方平台查询订单信息接口

请求方式：GET

是否认证：是

接口地址：

请求参数

字段名 数据类型 必填 描述
order_id String 是 订单唯一标识符
customer_name String 是 客户姓名 
  1. {
  2.   "order_no": "ORD-2023-00001",
  3.   "customer_name": "John Smith"
  4. }

响应数据

字段名 数据类型 必填 描述
order_id String 是 订单唯一标识符
customer_name String 是 客户姓名
customer_email String 否 客户电子邮件地址
order_date String（日期格式） 是 订单创建日期
total_amount BigDecimal(10,2) 是 订单总金额，包括税和运费
tax_amount BigDecimal(10,2) 否 订单的税费
province String 是 省份
city String 是 城市
street String 是 州
items Array 是 订单商品列表
字段名 数据类型 必填 描述
item_id String 是 商品唯一标识符
item_name String 是 商品名称
quantity Integer 是 商品数量
unit_price BigDecimal(10,2) 是 商品单价 
  1. {
  2.   "order_no": "ORD-2023-00001",
  3.   "customer_name": "John Smith",
  4.   "customer_email": "john.smith@example.com",
  5.   "order_date": "2023-02-28",
  6.   "total_amount": 150.00,
  7.   "tax_amount": 10.50,
  8.   "street": "123 Main St",
  9.   "city": "Anytown",
  10.   "province": "CA",
  11.   "items": [
  12.     {
  13.       "item_id": "PROD-0001",
  14.       "item_name": "Widget",
  15.       "quantity": 2,
  16.       "unit_price": 50.00
  17.     },
  18.     {
  19.       "item_id": "PROD-0002",
  20.       "item_name": "Gadget",
  21.       "quantity": 1,
  22.       "unit_price": 50.00
  23.     }
  24.   ]
  25. }

推送订单

功能描述

第三方平台需要通过此接口添加到我方系统。

请求方式：POST

是否认证：是

接口地址：

请求参数

字段名 数据类型 必填 描述
order_id String 是 订单唯一标识符
customer_name String 是 客户姓名
customer_email String 否 客户电子邮件地址
order_date String（日期格式） 是 订单创建日期
total_amount BigDecimal(10,2) 是 订单总金额，包括税和运费
tax_amount BigDecimal(10,2) 否 订单的税费
province String 是 省份
city String 是 城市
street String 是 州
items Array 是 订单商品列表
字段名 数据类型 必填 描述
item_id String 是 商品唯一标识符
item_name String 是 商品名称
quantity Integer 是 商品数量
unit_price BigDecimal(10,2) 是 商品单价 
  1. {
  2.   "order_no": "ORD-2023-00001",
  3.   "customer_name": "John Smith",
  4.   "customer_email": "john.smith@example.com",
  5.   "order_date": "2023-02-28",
  6.   "total_amount": 150.00,
  7.   "tax_amount": 10.50,
  8.   "street": "123 Main St",
  9.   "city": "Anytown",
  10.   "province": "CA",
  11.   "items": [
  12.     {
  13.       "item_id": "PROD-0001",
  14.       "item_name": "Widget",
  15.       "quantity": 2,
  16.       "unit_price": 50.00
  17.     },
  18.     {
  19.       "item_id": "PROD-0002",
  20.       "item_name": "Gadget",
  21.       "quantity": 1,
  22.       "unit_price": 50.00
  23.     }
  24.   ]
  25. }

响应数据

  1. {
  2.     "code": 200,
  3.     "msg": "推送成功",
  4.     "data": null
  5. }