取消发货/截件

请求规格说明

在确认交运之后,若你需要截件,可以调用此接口来申请截件。我司在收到包裹之后会做退回处理。

在申请截件之后,需要等待我司内部系统自动处理,才能知道截件是否成功。此过程一般会在1分钟内完成。(注:测试环境对接时,如有需要,请联系我司技术人员,分别测试截件成功与失败的状态。)

你需要重复调用此接口,通过 Status 获知取消状态。

请求方式

POST api/parcels/{processCode}/cancellation

processCode 为我司处理号,请求url中不需要花括号({})

请求数据格式

此接口虽为POST接口,但并不需要从HTTP request body中读取数据,你可以只POST个空字符串。

返回数据格式说明

返回数据格式

名称 类型 描述 示例值
Status string 截件状态
Requested: 已申请截件
Accepted: 截件成功
Rejected: 截件失败
 
RequestOn string 截件申请时间, ISO8601 标准格式  
ResponseOn string 截件处理时间, ISO8601 标准格式  
Message string 处理消息  

返回数据示例

{
    "Data": {
        "Status": "Accepted",
        "RequestOn": "2017-08-06T09:01:14Z",
        "ResponseOn": "2017-08-06T09:02:11Z",
        "Message": ""
    },
    "Succeeded": true,
    "Error": null
}