创建自建平台订单

接口描述

主要是开放给自建平台/自建商城导入订单数据至ERP，仅支持店铺类型为‘自建平台’的店铺使用该接口创建订单，原名为‘创建订单V2’

系统相关界面

"界面路径：【交易】----【订单管理】----【新建订单】"

接口说明

该接口可支持自建平台订单的创建，且支持修改指定的订单平台状态，但是不允许逆向流转。

订单平台状态流转：
WAIT_BUYER_PAY(等待买家付款)-->WAIT_SELLER_SEND_GOODS(等待卖家发货,即:买家已付款)-->WAIT_BUYER_CONFIRM_GOODS(等待买家确认收货,即:卖家已发货)-->TRADE_FINISHED(交易成功)/TRADE_CLOSED(付款以后用户退款成功，交易自动关闭)

请求参数status指定为‘WAIT_BUYER_PAY’，则订单平台状态为‘待付款’（WAIT_BUYER_PAY），系统状态为‘待付款’（WAIT_BUYER_PAY）；
请求参数status指定为‘WAIT_SELLER_SEND_GOODS’，则订单平台状态为‘待发货’（WAIT_SELLER_SEND_GOODS），系统状态为‘待审核’（WAIT_AUDIT）；
请求参数status指定为‘WAIT_BUYER_CONFIRM_GOODS’，则订单平台状态为‘已发货’（WAIT_BUYER_CONFIRM_GOODS），系统状态为‘卖家已发货’（SELLER_SEND_GOODS）；
请求参数status指定为‘TRADE_FINISHED’，则订单平台状态为‘交易成功’（TRADE_FINISHED），系统状态为‘交易成功’（FINISHED）；
请求参数status指定为‘TRADE_CLOSED’，则订单平台状态为‘交易关闭’（TRADE_CLOSED），系统状态为‘交易关闭’（CLOSED）；

注意：

此接口只能创建或修改店铺类型为‘自建平台’的订单。在【基础】--【店铺管理】--【新增店铺】，选择‘自建平台’店铺类型，填写店铺名称等信息，保存；
自建平台的订单不需要通过商品对应表进行对应，创建订单前需要提前在快麦ERP中维护好系统商品，系统商品可直接在快麦里维护，也可通过接口同步商品资料；
此接口不支持修改订单中的商品信息，包括增删改商品，修改商品数量，商品实付金额等操作；
此接口支持修改订单商品的退款状态，请求参数refundStatus可指定的状态包括：‘待卖家同意退款’（WAIT_SELLER_AGREE）、‘退款成功’（SUCCESS）、‘退款关闭‘（CLOSED）、’待买家退货‘（WAIT_BUYER_RETURN_GOODS）、’待卖家确认收货‘（WAIT_SELLER_CONFIRM_GOODS）；
待付款订单如果要推送到快麦ERP，需要在【基础】-【系统配置】-【交易配置】-【订单配置】中的‘平台对接’勾选‘同步待付款订单’配置。

实际案例

场景1

trade设置为已发货， order设置为已发货，同步到erp的订单会更新为其他ERP发货，并且不扣库存

场景2

trade设置为未发货，其中部分order为已发货，部分order为待发货，设置为已发货的order会执行发货并且显示是其他Erp发货，设置为待发货的order为待审核

请求地址

环境	服务地址(HTTP/HTTPS)
V2正式环境（推荐）	https://gw.superboss.cc/router

2022年4月1日以后申请的APP Key，统一使用V2正式环境的请求地址：https://gw.superboss.cc/router

公共参数

调用任何一个API都必须传入的参数，目前支持的公共参数有：

参数名称	参数类型	是否必须	参数描述
method	string	是	API接口名称
appKey	string	是	分配给应用的AppKey
timestamp	string	是	时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟
format	string	否	响应格式。默认为json格式，可选值：json
version	string	是	API协议版本可选值：1.0
sign_method	string	否	签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。
sign	string	是	签名
session	string	是	授权会话信息（即access_token，由系统分配）

请求头

全部展开

参数名

类型

描述

必填

Content-Type

string

application/x-www-form-urlencoded;charset=UTF-8

必填

API接口地址

全部展开

参数名

类型

描述

必填

method

string

erp.trade.create.new

必填

请求参数

全部展开

参数名

类型

描述

必填

默认值

tid

string

平台订单号

必填

userId

long

店铺编号

必填

status

string

订单平台状态 WAIT_BUYER_PAY(等待买家付款)，WAIT_SELLER_SEND_GOODS(等待卖家发货,即:买家已付款) ，WAIT_BUYER_CONFIRM_GOODS(等待买家确认收货,即:卖家已发货) ，TRADE_FINISHED(交易成功) ，TRADE_CLOSED(付款以后用户退款成功，交易自动关闭)

必填

receiverName

string

收件人姓名

必填

receiverState

string

收件省份

必填

receiverCity

string

收件市

必填

receiverDistrict

string

收件区县

必填

receiverStreet

string

收件街道

必填

receiverAddress

string

收件详细地址

必填

receiverZip

string

收件邮编

receiverMobile

string

收件人手机号

必填

receiverPhone

string

收件人固话

orders

array

订单商品明细

必填

oid

long

平台子订单号

outerId

string

商家编码/规格商家编码（最小粒度商家编码）

必填

price

string

商品销售价（单位：元）

必填

num

integer

商品数量（大于0）

必填

giftNum

integer

大于0则为赠品

payment

string

实付金额（例如1.00）（单位：元）

必填

title

string

商品标题

picPath

string

商品图片

status

string

子订单平台状态 WAIT_BUYER_PAY(等待买家付款)，WAIT_SELLER_SEND_GOODS(等待卖家发货,即:买家已付款) ，WAIT_BUYER_CONFIRM_GOODS(等待买家确认收货,即:卖家已发货) ，TRADE_FINISHED(交易成功) ，TRADE_CLOSED(付款以后用户退款成功，交易自动关闭)

refundStatus

string

子订单平台退款状态 WAIT_SELLER_AGREE（待卖家同意退款）、SUCCESS（退款成功）、CLOSED（退款关闭）、WAIT_BUYER_RETURN_GOODS（待买家退货）、WAIT_SELLER_CONFIRM_GOODS（待卖家确认收货）

orderExt

object

子订单扩展信息

orderRemark

string

订单商品备注

payment

string

订单实付金额（例如1.00）（单位：元）

必填

postFee

string

运费（单位：元）

buyerNick

string

平台订单上的买家昵称该字段是触发合单的关键标识字段，如为空则无法执行自动合单，可以使用收件人名字，或者收件人手机号作为 buyerNick值

相同收件人订单进入系统需要自动合并必填

buyerMessage

string

平台订单上的买家留言

sellerFlag

string

订单旗帜 0:灰, 1:红, 2:黄, 3:绿, 4:蓝, 5:紫, 6:橙, 7:浅蓝, 8:浅粉, 9:深绿, 10:桃红

sellerMemo

string

平台上的卖家备注

invoiceKind

string

发票种类 1.电子发票 2.纸质发票

invoiceName

string

发票抬头

buyerTaxNo

string

买家税号

invoiceRemark

string

发票备注

invoiceFormat

string

发票类型 1.普通发票 2.增值税发票

subSource

string

次来源地

created

string

下单时间格式:yyyy-MM-dd HH:mm:ss

payTime

string

付款时间格式:yyyy-MM-dd HH:mm:ss

consignTime

string

发货时间格式:yyyy-MM-dd HH:mm:ss

timeoutActionTime

string

承诺发货时间格式:yyyy-MM-dd HH:mm:ss

outSid

string

运单号

type

string

订单类型， cod:货到付款

trades

string

批量订单数据，优先批量订单数据

请求示例

示例一：

{
    "payTime": "2022-10-09 01:07:52",
    "created": "2022-10-09 01:07:52",
    "receiverName": "XXXXX",
    "receiverMobile": "XXXXX",
    "userId": "XXXXXX",
    "receiverCity": "长沙市",
    "tid": "202210090001",
    "receiverAddress": "雷锋大道莱茵城",
    "receiverDistrict": "岳麓区",
    "receiverState": "湖南省",
    "payment": "23.60",
    "orders": "[{\"price\":4.90,\"num\":1,\"outerId\":XXXXXXX,\"payment\":2.85,\"title\":\"XXXXXX\"}]",
    "status": "WAIT_SELLER_SEND_GOODS"
}

示例二：

{
    "trades": "[{\"payTime\":\"2022-10-09 01:07:52\",\"created\":\"2022-10-09 01:07:52\",\"receiverName\":\"陆哲痕\",\"receiverMobile\":\"17701608823\",\"userId\":\"143851\",\"receiverCity\":\"长沙市\",\"tid\":\"202210090004\",\"receiverAddress\":\"雷锋大道莱茵城\",\"receiverDistrict\":\"岳麓区\",\"receiverState\":\"湖南省\",\"payment\":\"23.60\",\"orders\":[{\"price\":4.9,\"num\":1,\"outerId\":\"test0049\",\"payment\":2.85,\"title\":\"测试0049\"}],\"status\":\"WAIT_SELLER_SEND_GOODS\"},{\"payTime\":\"2022-10-09 01:07:52\",\"created\":\"2022-10-09 01:07:52\",\"receiverName\":\"陆哲痕\",\"receiverMobile\":\"17701608823\",\"userId\":\"143851\",\"receiverCity\":\"长沙市\",\"tid\":\"202210090005\",\"receiverAddress\":\"雷锋大道莱茵城\",\"receiverDistrict\":\"岳麓区\",\"receiverState\":\"湖南省\",\"payment\":\"23.60\",\"orders\":[{\"price\":4.9,\"num\":1,\"outerId\":\"test0049\",\"payment\":2.85,\"title\":\"测试0049\"}],\"status\":\"WAIT_SELLER_SEND_GOODS\"}]"
}

响应参数

全部展开

参数名

类型

描述

必填

success

boolean

true-成功，false-失败

必填

trace_id

string

示例：3553483395407017

必填

sid

long

系统订单号

必填

tradeList

List

批量返回

必填

sid

Long

ERP的Trade流水号，系统生成，全系统唯一

必填

tid

String

平台订单号

必填

响应示例

异常示例

{
    "code": "25",
    "msg": "服务方法(erp.trade.create.new:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}

错误码解释

错误码	错误信息	解决方案
50	发票种类类型不合法！[1（电子发票）；2（纸质发票）]	请检查该参数的值是否规范
50	需要开具发票类型不合法！[0（关闭）；1（开启）]	请检查该参数的值是否规范
50	发票类型不合法！[1（普通）；2（增值）]	请检查该参数的值是否规范
50	旗帜类型不合法！0:灰, 1:红, 2:黄, 3:绿, 4:蓝, 5:紫, 6:橙, 7:浅蓝, 8:浅粉, 9:深绿, 10:桃红	请检查该参数的值是否规范
50	订单的平台状态枚举值不合法！	请检查该参数的值是否规范
30051	店铺编号不能为空	请检查店铺编号是否有值
30052	订单商品明细集合不能为空	订单商品明细集合不能为空
30053	收件人姓名不能为空	请检查该字段是否有值
30055	收件省份不能为空	请检查该字段是否有值
30056	收件市不能为空	请检查该字段是否有值
30057	收件详细地址不能为空	请检查该字段是否有值
30058	收件区县不能为空	请检查该字段是否有值
30059	实付金额不能为空	请检查该字段是否有值
30060	邮费不能为空	请检查该字段是否有值
30061	orders参数传入有误，解析失败	请检查该字段是否有值
30062	自定义赠品类型值不合法	请检查该参数的值是否规范
30063	是否是虚拟商品类型值不合法	请检查该参数的值是否规范
30065	收件人手机号不能为空	请检查该字段是否有值
30066	收件人手机号格式有误	请检查该参数的值是否规范，应为11位数字
30067	商家编码不能为空	请检查该字段是否有值
30068	商品销售价不能为空	请检查该字段是否有值
30069	商品销售价格式错误	请检查该参数的值是否规范
30070	子订单商品数量不能为空	请检查该字段是否有值
30071	实付金额格式错误	请检查该参数的值是否规范
30072	平台编号不能为空	请检查该字段是否有值
30073	平台状态不能为空	请检查该字段是否有值
30074	邮费格式错误	请检查该参数的值是否规范

接口描述​

系统相关界面​

接口说明​

实际案例​

场景1​

场景2​

请求地址​

公共参数​

请求头​

API接口地址​

请求参数​

请求示例​

响应参数​

响应示例​

异常示例​

错误码解释​

接口描述

系统相关界面

接口说明

实际案例

场景1

场景2

请求地址

公共参数

请求头

API接口地址

请求参数

请求示例

响应参数

响应示例

异常示例

错误码解释