OMS开放接口文档
  1. 退件模块
OMS开放接口文档
  • 用户认证说明
  • 返回代码说明
  • 公共模块
    • 欢迎入口
      GET
    • 返回代码
      GET
    • 沙盒ApiToken生成
      GET
  • 通用数据模块
    • 仓库列表
      POST
    • 物流渠道列表
      POST
    • 查询产品分类
      POST
    • 国家列表
      POST
  • 产品模块
    • 产品列表
      POST
    • 创建产品
      POST
    • 修改产品
      POST
  • 入库单模块
    • 入库单列表
      POST
    • 创建入库单
      POST
    • 修改入库单
      POST
    • 取消入库单
      POST
    • 下载箱唛
      POST
    • 下载关联SKU条码
      POST
  • 出库单模块
    • B2C订单模块
      • B2C订单列表
      • 创建B2C订单
      • 修改B2C订单
    • B2B订单模块
      • B2B订单列表
      • 创建B2B订单
      • 修改B2B订单
    • 上传附件
      POST
    • 下载附件
      POST
    • 取消出库单
      POST
  • 退件模块
    • 退件单列表
      POST
    • 创建退件单
      POST
    • 修改退件单
      POST
    • 取消退件单
      POST
  • 库存模块
    • 库存列表
    • 库存流水列表
    • 库龄列表
  • 快递面单模块
    • 对接说明
    • 面单物流渠道列表
    • 面单列表
    • 面单信息
    • 创建面单
    • 创建并审核面单
    • 修改面单
    • 提交审核面单
    • 取消面单
    • 审核面单
    • 面单退款
    • 驳回面单
    • 激活面单
    • 重试制单
  1. 退件模块

退件单列表

POST
/open/return-order-data/list
用于获取退件单信息的列表

请求参数

Header 参数

Body 参数application/json

示例
{
    "commonParam": {
        "pageParam": {
            "pageNum": 0,
            "pageSize": 0
        }
    },
    "orderNo": "string",
    "referenceNo": "string",
    "signatureNo": "string",
    "trackingNo": "string",
    "pickupType": "1",
    "returnType": "1",
    "status": "1",
    "isSplitAsn": "-1",
    "orderNos": [
        "string"
    ],
    "referenceNos": [
        "string"
    ],
    "warehouseCode": "string"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/open/return-order-data/list' \
--header 'Authorization: {{api_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "commonParam": {
        "pageParam": {
            "pageNum": 0,
            "pageSize": 0
        }
    },
    "orderNo": "string",
    "referenceNo": "string",
    "signatureNo": "string",
    "trackingNo": "string",
    "pickupType": "1",
    "returnType": "1",
    "status": "1",
    "isSplitAsn": "-1",
    "orderNos": [
        "string"
    ],
    "referenceNos": [
        "string"
    ],
    "warehouseCode": "string"
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": "20000",
    "success": true,
    "data": {
        "pageNum": "1",
        "pageSize": "10",
        "totalCount": "1",
        "totalPage": "1",
        "list": [
            {
                "orderNo": "RO25101199766819",
                "referenceNo": "RO25101199766819",
                "signatureNo": "22222221",
                "outboundOrderNo": "111",
                "trackingNo": "1223",
                "pickupType": 2,
                "pickupDate": "2025-10-16",
                "etaDate": "2025-10-12",
                "companyName": "测试",
                "contactName": "测试",
                "contactMobile": "18888888888",
                "contactCellMobile": "",
                "contactEmail": "test@test.com",
                "province": "测试",
                "city": "测试",
                "district": "测试",
                "doorplate": "测试",
                "address": "测试",
                "postcode": "60000",
                "qty": 2,
                "receiveQty": 0,
                "goodQty": 0,
                "badQty": 0,
                "putawayQty": 0,
                "putawayBadQty": 0,
                "destroyQty": 0,
                "returnType": 1,
                "status": 1,
                "isSyncToSupplier": -1,
                "isSplitAsn": 1,
                "handleAdvice": "测试",
                "remark": "测试备注",
                "cancelType": 1,
                "cancelRemark": "",
                "errorReason": "",
                "errorOperationType": "",
                "openWarehouse": {
                    "warehouseCode": "TEST"
                },
                "openItems": [
                    {
                        "productSku": "SKU112",
                        "qty": 1,
                        "receiveQty": 0,
                        "productQuality": -1,
                        "handleType": -1,
                        "status": 1,
                        "remark": ""
                    }
                ],
                "openAttachments": [
                    {
                        "attachmentType": "物流运单",
                        "fileType": "png",
                        "fileName": "848ad6986d5846048b68b8a86a09c4db_100101.png",
                        "base64": "base64"
                    }
                ],
                "openshippingMethod": {
                    "code": "TEST"
                },
                "openCountry": {
                    "code2": "US"
                }
            }
        ]
    },
    "message": "请求成功",
    "errors": [],
    "timestamp": "1760337265902",
    "duration": 0.844,
    "requestId": "083ba540f01841d48e4cb12abea28e9e"
}
修改于 2025-10-24 01:21:14
上一页
取消出库单
下一页
创建退件单
Built with