详细描述

WMS退货单创建

支持平台: 物流宝, 酷武 , 科捷 , 百世 , 发网, 标杆

API用户类型授权

需授权

系统级别输入参数

名称 类型 是否必须 描述
method String

API接口名称

certi_id Number

分配给应用的证书ID

from_node_id String

API调用的来源节点ID,对于第三方开发者来说,此id即为申请应用颁发的APP KEY

from_api_v String

请求方版本号

to_node_id String

API调用的目的节点ID(除了基础服务类api,其他接口必传此参数)

to_api_v String

接收方版本号

callback_url String

响应回调地址,带http路径的标准URL。(调用异步接口此参数必填)

v String

矩阵API协议版本,可选值:1.0

timestamp String

时间戳,格式为yyyy-MM-dd hh:mm:ss,例如:2008-01-25 20:23:30。ShopEx API服务端允许客户端请求时间误差为10分钟

format String

可选,指定响应格式。默认JSON ,目前支持格式为JSON

sign String

对调用API时所有输入参数(包括应用级参数)进行签名结果

应用级输入参数

名称 类型
默认全部
示例值 默认值 描述
uniqid String

物流宝(必填)

酷武 (必填)

科捷 (必填)

百世 (必填)

发网(必填)

标杆(必填)

请求标识(在ISV即请求方系统中全局唯一),用于控制并发及去重

out_order_code String

物流宝(必填)

酷武 (必填)

科捷 (必填)

百世 (必填)

发网(必填)

标杆(必填)

退货单号

order_source WmsOrderSourcePlatform

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

订单来源平台

platform_order_code String

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

来源平台单号

orig_order_code String

物流宝(必填)

酷武 (必填)

科捷 (必填)

百世 (必填)

发网(必填)

标杆(必填)

原始发货单号

logistics_no String

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

快递单号

logistics_code String

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

快递公司编号

return_amount String

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

退货金额

remark String

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

备注

created Date

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

单据创建时间

wms_order_code String

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

wms订单编号

is_finished Boolean

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

该订单是否已完成,如果完成则设置为true,如果为false,则需要等待继续创建订单商品信息。

current_page String

物流宝(必填)

酷武 (必填)

科捷 (必填)

百世 (必填)

发网(必填)

标杆(可选)

当前分页数

total_page String

物流宝(必填)

酷武 (必填)

科捷 (必填)

百世 (必填)

发网(可选)

标杆(可选)

总分页数

receiver_name String

物流宝(必填)

酷武 (必填)

科捷 (必填)

百世 (必填)

发网(必填)

标杆(必填)

退货人姓名

receiver_zip String

物流宝(可选)

酷武 (必填)

科捷 (必填)

百世 (可选)

发网(必填)

标杆(必填)

退货人邮政编码

receiver_state String

物流宝(必填)

酷武 (必填)

科捷 (必填)

百世 (必填)

发网(必填)

标杆(必填)

退货人所在省,如浙江省、北京等

receiver_city String

物流宝(必填)

酷武 (必填)

科捷 (必填)

百世 (必填)

发网(必填)

标杆(必填)

退货人所在市,如杭州市、上海市等

receiver_district String

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

退货人所在县(区),注意有些市下面是没有区的,如:义乌市

receiver_address String

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

退货人的详细地址

receiver_phone String

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

退货人电话号码(如有分机号用“-”分隔)(电话和手机必选一项)

receiver_mobile String

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

退货人手机号码(电话和手机必选一项)

receiver_email String

物流宝(可选)

酷武 (可选)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

退货人email地址

storage_code String

物流宝(可选)

酷武 (可选)

科捷 (必填)

百世 (可选)

发网(可选)

标杆(可选)

库内存放点编号

line_total_count Number

物流宝(可选)

酷武 (可选)

科捷 (必填)

百世 (可选)

发网(可选)

标杆(可选)

订单商品明细总行数(即整个单据商品明细行数,而不是当前分页的商品明细行数)

item_total_num String

物流宝(可选)

酷武 (必填)

科捷 (可选)

百世 (可选)

发网(可选)

标杆(可选)

订单商品明细总数量

items WmsOrderItem

物流宝(必填)

酷武 (必填)

科捷 (必填)

百世 (必填)

发网(可选)

标杆(可选)

商品信息明细列表(json字符串,一次最多支持30个商品)

返回结果

名称 类型 是否必须 示例值 描述
wms_order_code String

LP31209123123

第三方仓储的订单编号

created Date

2011-08-16 19:27:29

订单创建时间

XML数据格式:

			
JSON数据格式:
{
    "rsp":"succ",
    "msg_id":"3463421b2581604c74dcb9b74ffab2e4"
    "data":{
        "wms_order_code": "LP31209123123",
        "created": "2011-08-16 19:27:29"
    }
}

错误码

错误码 错误描述 解决方案

FAQ

修改时间:2012-05-23 17:09:15