元仓开放平台
首页元仓客户端
首页元仓客户端
  1. 退货
  • 开发者必读
    • 对接说明
    • 枚举描述
  • 授权
    • 授权
      POST
  • 基础资料
    • 国家
      POST
    • 币种
      POST
    • 元仓渠道(物流公司)
      POST
    • 客户开启的元仓渠道(物流公司)
      POST
    • 元仓仓库
      POST
    • 客户开启的元仓仓库
      POST
    • 元仓平台
      POST
    • 文件上传
      POST
  • 商品
    • 商品分类
      POST
    • 商品货物属性
      POST
    • 商品成交单位
      POST
    • 商品新增
      POST
    • 商品修改
      POST
    • 商品作废
      POST
    • 商品打印标签
      POST
    • 商品列表
      POST
    • 商品详情
      POST
    • 商品发货仓库匹配
      POST
  • 入库
    • 预报入库
      • 运输方式
      • 货物属性
      • 入库新增
      • 入库作废
      • 入库确认
      • 入库详情
      • 入库列表
      • 头程物流成本修改
      • 入库箱唛打印标签
      • 入库完结
    • 入库(不带箱唛)
      • 入库新增
      • 入库作废
      • 入库确认
      • 入库详情
      • 入库列表
      • 入库完结
  • 订单
    • 几大平台对应channelCode字段的取值
    • 订单新增
    • 订单取消
    • 订单列表
    • 订单详情
    • 标记订单是否上网
    • 更新物流追踪信息
  • 库存
    • 库存动态列表
    • 库存盘点列表
    • 库存列表
    • 库龄报表(非实时)
  • 换单
    • 新增订单
    • 订单列表
    • 取消订单
  • 退货
    • 退货单新增
      POST
    • 退货单列表
      POST
    • 退货单作废
      POST
    • 退货单详情
      POST
    • 退货单决策
      POST
  • 订阅
    • 签名推送测试
    • 预报入库/入库(不带箱唛)推送(状态)
    • 预报入库/入库(不带箱唛)推送(上架明细)
    • 订单推送
    • 退货单推送
    • 库存盘点完结推送
  1. 退货

退货单新增

POST
/api/openPlatform/return/add

状态码#

状态码描述
000001成功
000400请求失败,详细见描述(msg)
000401鉴权失败 (token已过期或者token无效)
000403无权限访问
000405请求方法不允许
000422请求数据异常
000429请求太频繁
000500程序内部错误
015001退货单/物流单号已存在
015003退货单SKU非法

请求参数

Header 参数
Authorization
string 
必需
例: Bearer 2296|M9DlZJI54pxcbdtdapSOy4wNkzYKijw5jpjJIhS7
默认值:
Bearer {{token}}
Content-Type
string 
必需
默认值:
application/json
Body 参数application/json
customerReturnOrderSn
string 
客户退货单号
必需
customerOrderSn
string 
客户订单号
可选
当returnType=1,2时必填
deliveryType
integer 
派送方式
可选
默认 1:自选物流
returnType
integer 
退货类型
必需
1:客户退货,2物流退货,3第三方退货
trackingNumber
string 
物流单号
必需
returnReason
string 
退货原因
可选
receiver
string 
收件人
可选
area
string 
国家
可选
address_1
string 
地址
可选
zipcode
string 
邮编
可选
company
string 
公司
可选
houseNumber
string 
门牌号
可选
email
string 
邮箱
可选
district
string 
区
可选
city
string 
市
可选
phone
string 
手机号
可选
state
string 
省份
可选
receiveWarehouseCode
string 
收货仓库
必需
needPolicy
integer 
是否需要决策
可选
1是,0否 默认0,如果是0无需调用退货单决策
returnDetails
array [object {2}] 
必需
customerSku
string 
客户SKU
必需
quantity
integer 
数量
必需
示例
{
  "trackingNumber": "7122000092921111",
  "returnDetails": [
    {
      "customerSku": "A301",
      "quantity": 67
    },
    {
      "customerSku": "A302",
      "quantity": 21
    }
  ],
  "receiveWarehouseCode": "001",
  "customerReturnOrderSn": "RET00012121111",
  "zipcode": "85",
  "address_1": "qui",
  "area": "mollit id est esse ut",
  "receiver": "eu nulla ut",
  "customerOrderSn": "",
  "city": "益阳市",
  "deliveryType": 1,
  "district": "茂港区",
  "state": "Duis",
  "houseNumber": "86",
  "returnType": 3,
  "phone": "18642366232",
  "email": "f.rbcvp@qq.com",
  "returnReason": "anim laboris minim",
  "company": "sint"
}

返回响应

🟢200成功
application/json
Body
state
string 
必需
msg
string 
必需
data
object 
必需
returnOrderSn
string 
元仓退货单号
必需
示例
{
  "state": "000001",
  "msg": "新增成功",
  "data": {
    "returnOrderSn": "RG230509143010033"
  }
}
修改于 2025-05-07 07:53:15
上一页
取消订单
下一页
退货单列表
Built with