oTMS-openapi
  1. oTMS API
oTMS-openapi
  • oTMS API
    • 订单导入
      PUT
    • 订单导出/追踪
      POST
    • 提送货点导入
      PUT
    • 提送货点删除
      DELETE
    • 卡车和司机导入
      PUT
    • 订单分配司机
      POST
    • 运输单导入
      PUT
    • 运输单删除
      PUT
    • 订单外部追踪
      POST
    • 订单召回
      POST
    • 订单分享链接
      PUT
    • 承运商导出
      POST
    • h5链接
      PUT
    • 订单更新
      PUT
    • 订单费用更新
      POST
    • 订单分配
      POST
    • 车辆信息
      POST
    • 订单撤销
      PUT
    • 运输单分配司机
      PUT
    • 订单评分
      POST
    • 订单交接创建
      PUT
    • 订单自定义文本字段更新
      POST
    • 订单快速交接
      POST
    • 价格文件匹配
      POST
    • 收货方/发货方导出
      POST
    • 运输单导出/追踪
      POST
    • 运输单召回
      PUT
    • 文件上传
      POST
    • 订单事件推送
      PUT
    • 运输单事件推送
      PUT
    • 拒收导出
      POST
    • 收货码查询
      POST
    • 便携式设备导入
      POST
  1. oTMS API

拒收导出

POST
https://login.otms.cn/ws/rejectionOutbound

拒收导出#

通过拒收导出接口,客户系统可以接入 oTMS 系统,查询 oTMS 订单的拒收相关信息和状态。
重要提示:如果订单已结账超过3个月,此接口将无法查询到该订单的相关信息。
版本号文档说明
0.1当前版本文档

配置说明#

oTMS同时在生产环境和测试环境中提供Web Service接口,其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况,会对API账号的调用进行限制,甚至停用。
目前对该接口的调用限制为每个公司每秒最多3个请求(如需增加可选购增值服务)。

接口说明#

公共参数#

环境HTTP请求方法HTTPS请求地址请求主体MIME类型响应主体MIME类型
正式环境POSThttps://login.otms.cn/ws/rejectionOutboundapplication/jsonapplication/json
沙箱环境POSThttps://demo.otms.cn/ws/rejectionOutboundapplication/jsonapplication/json

请求参数#

字段名位置是否必填描述Schema
bodybody是拒收查询请求OrderRequest

错误码解释#

全局反馈代码#

反馈代码说明
0客户验证失败。
1不支持的请求版本。

单个请求反馈代码#

反馈代码说明
1000成功。
2000失败。
1001未找到订单。

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Basic 之后拼接空格,以及经过 Base64 编码的 username:password
示例:
Authorization: Basic *****************
Body 参数application/json

示例
{
    "orderNumber": "YBLHQYHD017633",
    "erpNumber": "",
    "clientCode": ""
}

返回响应

🟢200成功
application/json
Body

示例
{
    "version": "0.1",
    "responseCode": "1000",
    "rejectionDetails": [
        {
            "reason": "损坏",
            "rejectionTotal": 2,
            "remarks": "222",
            "updateTime": 1749713110018,
            "state": "REJECTED",
            "files": null,
            "lineRejectionDetails": [
                {
                    "cargoCode": "913",
                    "cargoName": "文具",
                    "unit": "吨",
                    "rejectionQuantity": 2,
                    "customFields": null
                }
            ]
        },
        {
            "reason": "损坏",
            "rejectionTotal": 2,
            "remarks": "sdfd ",
            "updateTime": 1749928803764,
            "state": "REJECTED",
            "files": [
                {
                    "fileName": "YBLHQYHD017633_1_20250613_140632.png",
                    "fileId": "epod:2OEBNBAGUL5LWQ4CO7LZDTIZ:WGRJCRGZFU6XJYKQJGIWBNPQ6I======"
                }
            ],
            "lineRejectionDetails": [
                {
                    "cargoCode": "913",
                    "cargoName": "文具",
                    "unit": "吨",
                    "rejectionQuantity": 1,
                    "customFields": null
                },
                {
                    "cargoCode": "913",
                    "cargoName": "文具",
                    "unit": "box",
                    "rejectionQuantity": 1,
                    "customFields": {
                        "customText1": null,
                        "customText2": "2",
                        "customText3": "3",
                        "customText4": null,
                        "customText5": null,
                        "customText6": null,
                        "customText7": null,
                        "customText8": null,
                        "customText9": "9",
                        "customText10": null,
                        "customText11": null,
                        "customText12": null,
                        "customText13": null,
                        "customText14": "14",
                        "customText15": null,
                        "customText16": "16",
                        "customText17": "17",
                        "customText18": "18",
                        "customText19": null,
                        "customText20": null,
                        "customText21": null,
                        "customText22": null,
                        "customText23": null,
                        "customText24": null,
                        "customText25": "25",
                        "customText26": "26",
                        "customText27": "27",
                        "customText28": "28",
                        "customText29": "29",
                        "customText30": "30",
                        "customText31": null,
                        "customText32": null,
                        "customText33": null,
                        "customText34": null,
                        "customText35": null,
                        "customText36": null,
                        "customText37": null,
                        "customText38": "38",
                        "customText39": null,
                        "customText40": null,
                        "customText41": "41",
                        "customText42": null,
                        "customText43": null,
                        "customText44": "44",
                        "customText45": "45",
                        "customText46": null,
                        "customText47": null,
                        "customText48": null,
                        "customText49": null,
                        "customText50": null,
                        "customText51": null,
                        "customText52": null,
                        "customText53": null,
                        "customText54": null,
                        "customText55": null,
                        "customText56": null,
                        "customText57": null,
                        "customText58": null,
                        "customText59": null,
                        "customText60": null,
                        "customText61": null,
                        "customText62": null,
                        "customText63": null,
                        "customText64": null,
                        "customText65": null,
                        "customText66": null,
                        "customText67": null,
                        "customText68": null,
                        "customText69": null,
                        "customText70": null,
                        "customText71": null,
                        "customText72": null,
                        "customText73": null,
                        "customText74": null,
                        "customText75": null,
                        "customText76": null,
                        "customText77": null,
                        "customText78": null,
                        "customText79": null,
                        "customText80": null,
                        "customNum1": null,
                        "customNum2": null,
                        "customNum3": null,
                        "customNum4": null,
                        "customNum5": null,
                        "customNum6": null,
                        "customNum7": null,
                        "customNum8": null,
                        "customNum9": null,
                        "customNum10": null,
                        "customEnum1": null,
                        "customEnum2": null,
                        "customEnum3": null,
                        "customEnum4": null,
                        "customEnum5": null,
                        "customEnum6": null,
                        "customEnum7": null,
                        "customEnum8": null,
                        "customEnum9": null,
                        "customEnum10": null,
                        "customEnum1Zh": null,
                        "customEnum2Zh": null,
                        "customEnum3Zh": null,
                        "customEnum4Zh": null,
                        "customEnum5Zh": null,
                        "customEnum6Zh": null,
                        "customEnum7Zh": null,
                        "customEnum8Zh": null,
                        "customEnum9Zh": null,
                        "customEnum10Zh": null,
                        "customEnum1En": null,
                        "customEnum2En": null,
                        "customEnum3En": null,
                        "customEnum4En": null,
                        "customEnum5En": null,
                        "customEnum6En": null,
                        "customEnum7En": null,
                        "customEnum8En": null,
                        "customEnum9En": null,
                        "customEnum10En": null
                    }
                }
            ]
        }
    ]
}
上一页
运输单事件推送
下一页
收货码查询
Built with