推送核销状态
开发环境
开发环境
POST
/api/apps/trade/v2/push_delivery
接口说明
交易系统的订单，在开发者系统完成核销后，开发者可通过此接口同步核销状态，完成订单在开放平台交易系统内的状态流转。
此接口支持推送整个订单的核销完成状态，也支持指定订单中的某个或者几个 item_order_id 核销，即子单核销。
只有状态符合可核销预期的才能正常核销。 不同订单类型可能有不同的预期，比如，团购券订单，只有待使用状态才能核销，退款中或已退款的将返回错误。
poi_info 信息。
| 名称 | 类型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
| shop_name | string | 否 | 核销店铺名称，参考商铺同步中的店铺名称（name）字段。 团购类商品库商品下单的订单必填。 | xx 门店 |
| ext_valid_shop_id | string | 否 | 核销门店的外部店铺 id，参考商铺同步中的接入方店铺 id（supplier_ext_id）字段。 团购类商品库商品下单的订单必填。 | x0001 |
| valid_poi_id_str | string | 否 | 核销门店对应的抖音 poi_id，参考商铺同步中的抖音 poi_id 字段。 团购类商品库商品下单的订单必填。 | 6601136930455291912 |
错误码
| HTTP 状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 200 | 10000 | 参数错误 | 参数不符合规范。请根据提示检查参数。 |
| 200 | 13000 | 系统错误，请重试 | 内部错误，重试可解决。 |
| 200 | 11001 | 访问未授权 | 请求的小程序和订单的小程序不匹配。 |
| 200 | 21111 | 此订单不允许推送核销状态，请使用闭环核销方案核销 | 抖音码核销订单不能使用此接口推送核销状态。 |
| 200 | 21000 | 商品单与商户单不匹配 | item_order_list 中的商品单 id 非 out_order_no 关联的子单。 |
| 200 | 21001 | 商品单状态不支持核销 | 子单状态不符合可核销要求，请查询商品单信息，只有商品单状态为待使用状态才可核销。 |
| 200 | 21116 | 预约商品不允许推送核销状态 | 预约类商品不能通过此接口推送核销状态。 |
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/api/apps/trade/v2/push_delivery' \
--header 'Content-Type: application/json' \
--data-raw '{
"out_order_no":"out123456",
"item_order_list":[
{
"item_order_id":"ot123"
},
{
"item_order_id":"ot456"
}
],
"use_all":false,
"poi_info":"{\"shop_name\":\"xx门店\",\"ext_valid_shop_id\":\"x0001\",\"valid_poi_id_str\":\"6601136930455291912\"}"
}'响应示例响应示例
200 - 成功示例
{
"err_no": 0,
"err_tips": "success"
}请求参数
Header 参数
Content-Type
string
必需
示例值:
application/json
Body 参数application/json
返回响应
修改于 2023-12-04 03:18:19