上传发货

系统相关界面

"界面路径：【交易】----【订单管理】----【订单发货】"

接口说明

1. 支持在快麦ERP中将【已审核】订单操作发货，上传平台的节点根据快麦中的设置生效，请求参数只需要传sids/tid和consignType；
2. 支持传入快递编码与运单号操作发货，
   1. 如果该订单为平台订单，则不扣系统里的库存，为其他ERP发货；
   2. 如果订单为手工单，系统状态会更新为【卖家已发货】

注意，

1. 调用该接口前需要先在快麦中配置好对应的物流公司及编码，使传入的快递编码可以自动绑定快递模版，如果快递编码匹配出多个快递模版，则只会任意匹配任一快递模版；
2. 非在快麦中获取的快递公司与快递单号，直接上传平台时可能会出现上传失败、或风控异常的风险，需谨慎使用；
3. 如果在上传平台时出现了上传异常，则需在快麦里操作【取消异常】才能重新调用接口推送；
4. 不支持拆单发货，线上平台的订单状态会因为子订单发货而整个订单会变成已发货。

请求地址

环境	服务地址(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.consign

必填

请求参数

全部展开

参数名

类型

描述

必填

sids

string

系统订单号,多个逗号隔开，选填:平台订单号二选一，优先系统订单号

必填

consignType

string

发货类型 DUMMY："无需物流发货",OFFLINE: "自己联系物流发货",ONLINE:"在线订单发货",ONLINE_CONFIRM:"确认发货通知",RESEND:"修改物流公司和运单号并重新发货" 不填默认为OFFLINE

tid

string

平台订单号，选填:系统订单号二选一，优先系统订单号

expressCode

string

快递公司编码

outSid

string

运单号

operateType

string

操作类型，不填operateType但是填了运单号和快递公司编码会仅上传平台； 1:仅系统发货 ；2:系统发货并上传平台

非必填

请求示例

示例一：

{
    sids: "string",
    outSid: string,
    consignType: string,
    expressCode: string,
    tid: string
}

响应参数

全部展开

参数名

类型

描述

必填

list

array

唯一码列表

templateType

integer

订单快递模版类型，0表示普通，1表示电子面单

source

string

订单来自哪个平台 sys:系统 jd：京东 tb：淘宝 tm：天猫 tjb：淘宝特价版 1688：阿里巴巴

templateId

long

订单快递模版ID

warehouseName

string

仓库名称

tid

string

平台订单号

sid

long

系统订单号

isError

integer

上传平台是否发生异常 1是 0否

logisticsExceptType

string

物流异常类型

orderIds

string

本次发货时参与发货的子订单ID,以逗号分割. 一笔订单发货时,有些子订单处于已发货或已发货之后的状态这些子订单不再参与发货

tradePay

long

订单付款时间快照

consigned

long

订单发货时间

logisticsModified

long

物流最近更新时间

errorDesc

string

上传失败的异常信息

consignType

string

发货类型 OFFLINE ONLINE DUMMY

created

long

当前记录创建时间

retryCount

integer

重试次数

retryTime

long

重试时间

uploadTime

long

最近一次上传时间

userId

long

订单所属店铺的用户ID

mergeSid

long

合单的订单设置主单的sid

outSid

string

运单号

companyId

long

公司编号

wlySubscribeFlag

integer

物流云订阅状态 默认0 未订阅 1已订阅 2订阅失败

templateName

string

当时的快递模版名称

warehouseId

long

仓库ID

buyType

integer

发货时用户的订购类型 默认0, 按单付费为1

logisticsStatus

string

物流状态

success

boolean

示例：true

trace_id

string

示例：3553483395407017

total

long

总数

响应示例

{
    "list":[{
	"templateType": "int",
	"source": "string",
	"templateId": long,
	"warehouseName": "string",
	"tid": "string",
	"sid": long,
	"isError": integer,
	"logisticsExceptType": "string",
	"orderIds": "string",
	"tradePay": long,
	"consigned": long,
	"logisticsModified": long,
	"errorDesc": "string",
	"consignType": "string",
	"created": long,
	"retryCount": "int",
	"retryTime": long,
	"uploadTime": long,
	"userId": "int",
	"mergeSid": "int",
	"outSid": "string",
	"scalping": "int",
	"companyId": "int",
	"wlySubscribeFlag": "int",
	"templateName": "string",
	"warehouseId": "int",
	"buyType": "int",
	"enableStatus": "int",
	"logisticsStatus": "string"
}],
	"success": "boolean",
	"trace_id": "long"
}

异常示例

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

异常示例二

{
    "traceId": "2750170478828000000",
    "msg": "系统订单号和平台订单号不能同时为空!",
    "code": "20010",
    "success": false
}

异常示例三

{
    "msg": "订单发货上传失败:java.lang.IllegalArgumentException: 非审核成功订单[4415538908555951]不能无需物流发货",
    "traceId": "2753180604479142137",
    "code": "30078",
    "success": false
}

异常示例四

{
    "traceId": "2750174470969300000",
    "success": true,
    "list": [
        {
            "templateType": 0,
            "source": "tb",
            "templateId": -1,
            "warehouseName": "默认仓库",
            "tid": "55176155600000",
            "sid": 4414073450100000,
            "isError": 1,
            "tradePay": 1691391790000,
            "consigned": 1691391986592,
            "errorDesc": "缺少运单号",
            "consignType": "OFFLINE",
            "userId": 32941,
            "mergeSid": -1,
            "warehouseId": 13821,
            "buyType": 2,
            "enableStatus": 1
        }
    ]
}

异常示例五

{
    "traceId": "2750186668676500000",
    "success": true,
    "list": [
        {
            "templateType": 0,
            "source": "tb",
            "templateId": 53813,
            "warehouseName": "默认仓库",
            "tid": "551761556331008",
            "sid": 4414073450146551,
            "isError": 1,
            "tradePay": 1691391790000,
            "consigned": 1691392349466,
            "errorDesc": "异常订单",
            "consignType": "OFFLINE",
            "userId": 32941,
            "mergeSid": -1,
            "outSid": "888888990000",
            "templateName": "德邦快递德邦测试模板",
            "warehouseId": 13821,
            "buyType": 2,
            "enableStatus": 1
        }
    ]
}

错误码解释

错误信息	错误码	解决方案
资源异常,请联系管理员!	400	检查参数是否合法
非法参数!	50	检查参数类型等是否合法
系统订单号和平台订单号不能同时为空!	20010	检查系统订单号或平台订单号是否已填写
系统订单号格式不正确！	20009	检查参数是否合法
系统订单号数量最大支持10组！	20003	参数过长
发货类型枚举值不合法！[DUMMY：无需物流发货OFFLINE: 自己联系物流发货ONLINE：在线订单发货ONLINE_CONFIRM：确认发货通知RESEND：修改物流公司和运单号并重新发货]	50	检查参数是否合法
订单发货上传失败	30078	根据失败详细检查订单是否满足条件
"errorDesc": "缺少运单号"		检查运单号或快递公司编码是否已填写
"errorDesc": "异常订单"		检查订单是否已被标记异常