拒收导出
通过拒收导出/追踪接口，客户系统接入 oTMS 系统，查询 oTMS 订单拒收相关信息和状态。注意：如果订单已结账超过3个月，这个接口就查不到这个订单信息。
| 版本号 | 文档 | 说明 |
|---|---|---|
| 0.1 | 当前版本文档 |
oTMS同时在生产环境和测试环境中提供Web Service接口，其中测试环境用于集成测试。两种环境下都需要由oTMS系统管理员分配API帐号密码后方可使用。
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
注意: 请合理地调用公共接口。如果发现存在异常调用或者对我们系统性能造成影响等情况，会对API账号的调用进行限制，甚至停用。
目前对该接口的调用限制为每个公司每秒最多10个请求
目前对该接口的调用限制为每个公司每秒最多10个请求
公共参数
| 环境 | HTTP请求方法 | HTTPS请求地址 | 请求主体MIME类型 | 响应主体MIME类型 |
|---|---|---|---|---|
| 正式环境 | POST | https://login.otms.cn/ws/rejectionOutbound | application/json | application/json |
| 沙箱环境 | POST | https://demo.otms.cn/ws/rejectionOutbound | application/json | application/json |
请求参数
| 字段名 | 位置 | 是否必填 | 描述 | Schema |
|---|---|---|---|---|
| body | body | 是 | 拒收查询请求 | OrderRequest |
| Authorization | header | 是 | Basic Authorization。如果不为空，则优先使用该值作身份认证。否则使用请求报文中的用户名与密码 | string |
响应参数
| 状态码 | 描述 | 响应模型 |
|---|---|---|
| 200 | successful operation | RejectionResponse |
CustomFieldsInfo
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| customText1 | string | 否 | 自定义文本字段1 | |
| customText2 | string | 否 | 自定义文本字段2 | |
| customText3 | string | 否 | 自定义文本字段3 | |
| customText4 | string | 否 | 自定义文本字段4 | |
| customText5 | string | 否 | 自定义文本字段5 | |
| customText6 | string | 否 | 自定义文本字段6 | |
| customText7 | string | 否 | 自定义文本字段7 | |
| customText8 | string | 否 | 自定义文本字段8 | |
| customText9 | string | 否 | 自定义文本字段9 | |
| customText10 | string | 否 | 自定义文本字段10 | |
| customText11 | string | 否 | 自定义文本字段11 | |
| customText12 | string | 否 | 自定义文本字段12 | |
| customText13 | string | 否 | 自定义文本字段13 | |
| customText14 | string | 否 | 自定义文本字段14 | |
| customText15 | string | 否 | 自定义文本字段15 | |
| customText16 | string | 否 | 自定义文本字段16 | |
| customText17 | string | 否 | 自定义文本字段17 | |
| customText18 | string | 否 | 自定义文本字段18 | |
| customText19 | string | 否 | 自定义文本字段19 | |
| customText20 | string | 否 | 自定义文本字段20 | |
| customText21 | string | 否 | 自定义文本字段21 | |
| customText22 | string | 否 | 自定义文本字段22 | |
| customText23 | string | 否 | 自定义文本字段23 | |
| customText24 | string | 否 | 自定义文本字段24 | |
| customText25 | string | 否 | 自定义文本字段25 | |
| customText26 | string | 否 | 自定义文本字段26 | |
| customText27 | string | 否 | 自定义文本字段27 | |
| customText28 | string | 否 | 自定义文本字段28 | |
| customText29 | string | 否 | 自定义文本字段29 | |
| customText30 | string | 否 | 自定义文本字段30 | |
| customText31 | string | 否 | 自定义文本字段31 | |
| customText32 | string | 否 | 自定义文本字段32 | |
| customText33 | string | 否 | 自定义文本字段33 | |
| customText34 | string | 否 | 自定义文本字段34 | |
| customText35 | string | 否 | 自定义文本字段35 | |
| customText36 | string | 否 | 自定义文本字段36 | |
| customText37 | string | 否 | 自定义文本字段37 | |
| customText38 | string | 否 | 自定义文本字段38 | |
| customText39 | string | 否 | 自定义文本字段39 | |
| customText40 | string | 否 | 自定义文本字段40 | |
| customText41 | string | 否 | 自定义文本字段41 | |
| customText42 | string | 否 | 自定义文本字段42 | |
| customText43 | string | 否 | 自定义文本字段43 | |
| customText44 | string | 否 | 自定义文本字段44 | |
| customText45 | string | 否 | 自定义文本字段45 | |
| customText46 | string | 否 | 自定义文本字段46 | |
| customText47 | string | 否 | 自定义文本字段47 | |
| customText48 | string | 否 | 自定义文本字段48 | |
| customText49 | string | 否 | 自定义文本字段49 | |
| customText50 | string | 否 | 自定义文本字段50 | |
| customText51 | string | 否 | 自定义文本字段51 | |
| customText52 | string | 否 | 自定义文本字段52 | |
| customText53 | string | 否 | 自定义文本字段53 | |
| customText54 | string | 否 | 自定义文本字段54 | |
| customText55 | string | 否 | 自定义文本字段55 | |
| customText56 | string | 否 | 自定义文本字段56 | |
| customText57 | string | 否 | 自定义文本字段57 | |
| customText58 | string | 否 | 自定义文本字段58 | |
| customText59 | string | 否 | 自定义文本字段59 | |
| customText60 | string | 否 | 自定义文本字段60 | |
| customText61 | string | 否 | 自定义文本字段61 | |
| customText62 | string | 否 | 自定义文本字段62 | |
| customText63 | string | 否 | 自定义文本字段63 | |
| customText64 | string | 否 | 自定义文本字段64 | |
| customText65 | string | 否 | 自定义文本字段65 | |
| customText66 | string | 否 | 自定义文本字段66 | |
| customText67 | string | 否 | 自定义文本字段67 | |
| customText68 | string | 否 | 自定义文本字段68 | |
| customText69 | string | 否 | 自定义文本字段69 | |
| customText70 | string | 否 | 自定义文本字段70 | |
| customText71 | string | 否 | 自定义文本字段71 | |
| customText72 | string | 否 | 自定义文本字段72 | |
| customText73 | string | 否 | 自定义文本字段73 | |
| customText74 | string | 否 | 自定义文本字段74 | |
| customText75 | string | 否 | 自定义文本字段75 | |
| customText76 | string | 否 | 自定义文本字段76 | |
| customText77 | string | 否 | 自定义文本字段77 | |
| customText78 | string | 否 | 自定义文本字段78 | |
| customText79 | string | 否 | 自定义文本字段79 | |
| customText80 | string | 否 | 自定义文本字段80 | |
| customNum1 | number | 否 | 自定义小数字段1 -- 精确到18位数、6位小数 | |
| customNum2 | number | 否 | 自定义小数字段2 -- 精确到18位数、6位小数 | |
| customNum3 | number | 否 | 自定义小数字段3 -- 精确到18位数、6位小数 | |
| customNum4 | number | 否 | 自定义小数字段4 -- 精确到18位数、6位小数 | |
| customNum5 | number | 否 | 自定义小数字段5 -- 精确到18位数、6位小数 | |
| customNum6 | number | 否 | 自定义小数字段6 -- 精确到18位数、6位小数 | |
| customNum7 | number | 否 | 自定义小数字段7 -- 精确到18位数、6位小数 | |
| customNum8 | number | 否 | 自定义小数字段8 -- 精确到18位数、6位小数 | |
| customNum9 | number | 否 | 自定义小数字段9 -- 精确到18位数、6位小数 | |
| customNum10 | number | 否 | 自定义小数字段10 -- 精确到18位数、6位小数 | |
| customEnum1 | string | 否 | 自定义字段中定义并激活的枚举变量1的逻辑名 | |
| customEnum2 | string | 否 | 自定义字段中定义并激活的枚举变量2的逻辑名 | |
| customEnum3 | string | 否 | 自定义字段中定义并激活的枚举变量3的逻辑名 | |
| customEnum4 | string | 否 | 自定义字段中定义并激活的枚举变量4的逻辑名 | |
| customEnum5 | string | 否 | 自定义字段中定义并激活的枚举变量5的逻辑名 | |
| customEnum6 | string | 否 | 自定义字段中定义并激活的枚举变量6的逻辑名 | |
| customEnum7 | string | 否 | 自定义字段中定义并激活的枚举变量7的逻辑名 | |
| customEnum8 | string | 否 | 自定义字段中定义并激活的枚举变量8的逻辑名 | |
| customEnum9 | string | 否 | 自定义字段中定义并激活的枚举变量9的逻辑名 | |
| customEnum10 | string | 否 | 自定义字段中定义并激活的枚举变量10的逻辑名 | |
| customEnum1Zh | string | 否 | 自定义字段中定义并激活的枚举变量1的中文名 | |
| customEnum2Zh | string | 否 | 自定义字段中定义并激活的枚举变量2的中文名 | |
| customEnum3Zh | string | 否 | 自定义字段中定义并激活的枚举变量3的中文名 | |
| customEnum4Zh | string | 否 | 自定义字段中定义并激活的枚举变量4的中文名 | |
| customEnum5Zh | string | 否 | 自定义字段中定义并激活的枚举变量5的中文名 | |
| customEnum6Zh | string | 否 | 自定义字段中定义并激活的枚举变量6的中文名 | |
| customEnum7Zh | string | 否 | 自定义字段中定义并激活的枚举变量7的中文名 | |
| customEnum8Zh | string | 否 | 自定义字段中定义并激活的枚举变量8的中文名 | |
| customEnum9Zh | string | 否 | 自定义字段中定义并激活的枚举变量9的中文名 | |
| customEnum10Zh | string | 否 | 自定义字段中定义并激活的枚举变量10的中文名 | |
| customEnum1En | string | 否 | 自定义字段中定义并激活的枚举变量1的英文名 | |
| customEnum2En | string | 否 | 自定义字段中定义并激活的枚举变量2的英文名 | |
| customEnum3En | string | 否 | 自定义字段中定义并激活的枚举变量3的英文名 | |
| customEnum4En | string | 否 | 自定义字段中定义并激活的枚举变量4的英文名 | |
| customEnum5En | string | 否 | 自定义字段中定义并激活的枚举变量5的英文名 | |
| customEnum6En | string | 否 | 自定义字段中定义并激活的枚举变量6的英文名 | |
| customEnum7En | string | 否 | 自定义字段中定义并激活的枚举变量7的英文名 | |
| customEnum8En | string | 否 | 自定义字段中定义并激活的枚举变量8的英文名 | |
| customEnum9En | string | 否 | 自定义字段中定义并激活的枚举变量9的英文名 | |
| customEnum10En | string | 否 | 自定义字段中定义并激活的枚举变量10的英文名 |
FileDetail
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| fileName | string | 否 | 文件名 | |
| fileId | string | 否 | 文件ID |
OrderLineRejectionDetail
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| cargoCode | string | 否 | 货物代码 | |
| cargoName | string | 否 | 货物名称 | |
| unit | string | 否 | 货物单位 | |
| rejectionQuantity | number | 否 | 拒收数量 | |
| customFields | CustomFieldsInfo | 否 | 自定义字段。这适用于启用并且正确配置了自定义字段的公司。 |
OrderRejectionDetail
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| reason | string | 否 | 原因 | |
| rejectionTotal | number | 否 | 拒收总数 | |
| remarks | string | 否 | 备注 | |
| updateTime | string (date-time) | 否 | 更新时间 | |
| state | string | 否 | 状态 | |
| files | array[FileDetail] | 否 | 附件 | |
| lineRejectionDetails | array[OrderLineRejectionDetail] | 否 | 拒收明细 |
OrderRequest
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| orderNumber | string | 否 | oTMS单号 | |
| erpNumber | string | 否 | ERP#, 与oTMS单号不能同时为空 | |
| clientCode | string | 否 | 客户代码 |
RejectionResponse
| 字段名 | 类型 | 是否必填 | 描述 | 示例 |
|---|---|---|---|---|
| version | string | 是 | 响应版本号 | |
| responseCode | string | 否 | 全局的反馈代码 | |
| rejectionDetails | array[OrderRejectionDetail] | 否 | 拒收 |
请求示例
{
"orderNumber": "YBLHQYHD000420"
}响应示例
{
"version": "0.1",
"responseCode": "1000",
"rejectionDetails": [
{
"reason": null,
"rejectionTotal": 2.000000,
"remarks": "222",
"state": "REJECTED",
"files": null,
"lineRejectionDetails": [
{
"cargoCode": "913",
"cargoName": "文具",
"unit": "吨",
"rejectionQuantity": 2.000000,
"customFields": null
},
{
"cargoCode": "913",
"cargoName": "文具",
"unit": "box",
"rejectionQuantity": 0.000000,
"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
}
}
]
},
{
"reason": null,
"rejectionTotal": 2.000000,
"remarks": "sdfd ",
"state": "REPORTED",
"files": [
{
"fileName": "YBLHQYHD017633_1_20250613_140632.png",
"fileId": "epod:2OEBNBAGUL5LWQ4CO7LZDTIZ:WGRJCRGZFU6XJYKQJGIWBNPQ6I======"
}
],
"lineRejectionDetails": [
{
"cargoCode": "913",
"cargoName": "文具",
"unit": "吨",
"rejectionQuantity": 1.000000,
"customFields": null
},
{
"cargoCode": "913",
"cargoName": "文具",
"unit": "box",
"rejectionQuantity": 1.000000,
"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
}
}
]
}
]
}全局反馈代码
| 反馈代码 | 说明 |
| 0 | 客户验证失败。 |
| 1 | 不支持的请求版本。 |
单个请求反馈代码
| 反馈代码 | 说明 |
| 1000 | 成功。 |
| 2000 | 失败。 |
| 1001 | 未找到订单。 |