取件码API

一、调用说明

为了成功获取到取件码，调用方需要按接口调用步骤进行接口调用：

1.注册阶段：调用方需要在快递下单后进驿站前，调用注册接口，将单号和回调地址提交给快递100。

2.推送阶段：快递100在取件码生成后，会将生成的取件码，推送给客户提交的回调地址。

3.查询阶段：对于已经获取到取件码的单号，调用方可直接查询。

二、注册接口

1. 接口格式

2. 请求参数

请求参数（Header）

请求参数（Body）

Param字段

3. 请求示例

{
    "kuaidinum": "JT0019812345678",
    "receiverPhone": "17712345678",
    "callbackUrl": "您的回调接口的地址，如http://www.您的域名.com/kuaidi?callbackid=...",
    "kuaidicom": "jtexpress"
}

4. 返回结果

返回参数

Data字段信息

5. 返回结果示例

成功返回示例

{
    "code": 200,
    "data": {
        "taskId": "2B1DFB1112DF4BC8BF6F0D66D9395E17"
    },
    "message": "取件码注册请求受理成功",
    "time": 0,
    "success": true
}

错误示例

{
    "code": 10003,
    "data": {
        "taskId": "2B1DFB1112DF4BC8BF6F0D66D9395E17"
    },
    "message": "该运单号已注册，请勿重复操作",
    "time": 0,
    "success": false
}

6. 返回信息代码含义

7. 快递公司编码

三、推送接口

1. 请求说明

2. 请求参数

请求参数（Header）

请求参数（Body）

3. 请求示例

{
    "kuaidicom": "jtexpress",
    "kuaidinum": "JT0019817361102",
    "pickUpAddress": "2号门麦当劳旁边申通极兔多多驿站",
    "pickUpCode": "127-4-4833",
    "pickUpStation": "2号门麦当劳旁边申通极兔多多驿站",
    "timestamp": "2025-11-06 17:00:04"
}

4. 返回结果

重推机制：失败后每隔30分钟重推一次，包含第一次推送，最多重推3次。

四、查询接口

1. 接口格式

2. 请求参数

请求参数（Header）

请求参数（Body）

Param字段

3. 请求示例

{
    "kuaidinum": "JT001981712345678",
    "receiverPhone": "17712345678",
    "kuaidicom": "jtexpress"
}

4. 返回结果

返回参数

Data字段信息

5. 返回结果示例

成功返回示例

{
    "code": 200,
    "data": {
        "kuaidicom": "jtexpress",
        "kuaidinum": "JT001981712345678",
        "pickUpAddress": "2号门麦当劳旁边申通极兔多多驿站",
        "pickUpCode": "127-4-4833",
        "pickUpStation": "2号门麦当劳旁边申通极兔多多驿站",
        "statusDesc": "待提货"
    },
    "message": "success",
    "time": 0,
    "success": true
}

错误示例

{
    "code": 10005,
    "data": null,
    "message": "当前单号未注册",
    "time": 0,
    "success": false
}

6. 返回信息代码含义