自动化设备到派-http接口文档


拦截件接口

简要描述
  • 拦截件接口
请求URL
  • /openapi/express/check
请求方式
  • POST
参数
参数名 必选 类型 说明
sheetNo string 运单号
company string 快递公司编码 [YTO, ZTO, STO, YUNDA, HTKY, TTKDEX, JT, EMS]
userId string 派件用户ID
type string 固定值"PJ"
请求示例
{
    "company": "ZTO",
    "sheetNo": "75706890164395",
    "userId": "1755099536575205376",
    "type": "PJ"
}
正常返回示例
{
    "code": 200,
    "data": {
        "company": "ZTO",
        "isIntercept": true,
        "isDf": false,
        "isCod": false,
        "isFresh": false,
        "isVip": false,
        "isPrivate": false,
        "msg": "运单75706890164395是【拦截改地址】快件,请尽快打单转出"
    },
    "message": "success",
    "success": true,
    "isEncrypt": false
}
错误返回示例
{
    "code": 400,
    "message": "签名错误",
    "success": false
}
返回参数说明
参数名 类型 说明
isIntercept boolean 是否拦截件
msg string 拦截件信息描述
isDf boolean 是否到付类型拦截件
isCod boolean 是否货到付款类型拦截件
isFresh boolean 是否生鲜类型拦截件
isVip boolean 是否电联类型拦截件
isPrivate boolean 是否隐私类型拦截件
备注
  • 更多返回错误代码请看首页的错误代码描述

页面列表

ITEM_HTML