验券
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/api/apps/trade/v2/fulfillment/delivery_verify
接口说明
poi_info 信息
| 名称 | 类型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
| shop_name | string | 否 | 核销店铺名称，团购类商品库商品下单的订单必填。 | xx 门店 |
| ext_valid_shop_id | string | 否 | 核销门店的外部店铺 id，参考商铺同步接口中的接入方店铺 id（supplier_ext_id）字段 团购类商品库商品下单的订单必填。 | x0001 |
| valid_poi_id_str | string | 否 | 核销门店对应的抖音 poi_id，参考商铺同步接口中的抖音 poi_id 字段 团购类商品库商品下单的订单必填。 | 6601136930455291912 |
返回参数
data 信息
| 名称 | 类型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
| verify_results | array(object) | 是 | 数组，每个券的验券结果 |
verify_results 信息
| 名称 | 类型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
| result_code | number | 是 | 验券结果码，0 表示成功 | 0 |
| result_msg | string | 是 | 验券结果 result_code 的说明 | 验券成功 |
| verify_time | number | 是 | 核销时间，13 位毫秒级时间戳 | 1658300479000 |
| item_order_id | string | 是 | 交易系统里对应的商品单 id | ot123 |
| certificate_code | string | 否 | 用户券码，核销成功时会将用户券码返回。开发者可用于对账。 | 888888888888 |
result_code 不同值的含义
| 值 | result_msg | 含义 |
|---|---|---|
| 0 | 验券成功 | 成功 |
| 1208 | 券码已核销 | 代表券码已核销。短时间内的重试请求可能会返回1208，可当做成功处理。 |
| 1211 | 其他错误 | 检查券码有效期。如果券码不在有效期范围内，将会返回此错误。不在有效期内不能核销。 |
错误码
| HTTP 状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 200 | 10000 | 参数错误 | 参数不符合规范。请根据提示检查参数。 |
| 200 | 13000 | 系统错误，请重试 | 内部错误，重试可解决。 |
| 200 | 11001 | 访问未授权 | 请求的小程序和订单的小程序不匹配。 |
| 200 | 20000 | 订单不存在 | 检查传入的 order_id 参数是否正确，例如order_id错误，或者order_id和请求的小程序不匹配。 |
| 200 | 21001 | 商品单状态不支持核销 | 订单状态不符合可核销预期，检查是否处于退款中、已退款等状态。 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/api/apps/trade/v2/fulfillment/delivery_verify' \
--header 'access-token: clt.xxx' \
--header 'Content-Type: application/json' \
--data-raw '{
"verify_token":"xxx",
"order_id":"ot123456",
"certificates":[
{
"encrypted_code":"xxx",
"certificate_id":"123456"
}
],
"poi_info":"{\"shop_name\":\"xx门店\",\"ext_valid_shop_id\":\"x0001\",\"valid_poi_id_str\":\"6601136930455291912\"}"
}'响应示例响应示例
200 - 成功示例
{
"data": {
"error_code": 0,
"description": "success",
"verify_results": [
{
"item_order_id": "ot123",
"certificate_code": "888888888888",
"result_code": 0,
"result_msg": "验券成功",
"verify_time": 1658300479000
}
]
},
"extra": {
"sub_error_code": 0,
"sub_description": "success",
"logid": "2022092115392201020812109511046",
"now": 1663745962686,
"error_code": 0,
"description": "success"
}
}请求参数
Header 参数
Content-Type
string
必需
示例值:
application/json
access-token
string
必需
示例值:
clt.xxx
Body 参数application/json
返回响应
修改于 2023-12-01 06:07:53