抖音开放平台Logo
控制台

推送履约状态

更新时间 2024-07-24 02:58:49
收藏
我的收藏

接口说明

  • 请先判断是否需要调用此接口，具体可查看接入规范，如：虚拟充值、虚拟服务等商品类型无需调用此接口。
  • 请先确认当前订单商品类型对应的履约状态机，判断是否需要先完成弹窗确认流程。
  • 如需调用此接口，请确保在支付成功后保持一定间隔(至少5秒)再调用。

使用限制

无

基本信息

名称描述
HTTP URL
https://open.douyin.com/api/trade_basic/v1/developer/fulfill_push_status/
HTTP Method
POST
Scope
trade_basic.developer.trade_fulfill
权限要求

无

请求头

名称字段类型是否必填示例描述
access-tokenString是clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
调用https://open.douyin.com/oauth/client_token/生成的token
content-typeString是application/json
固定值"application/json"

请求参数

Body

名称字段类型是否必填示例描述
order_idString是motb123123131

通用交易系统侧订单号，长度 <= 64 byte

to_statusString是fulfilling

目标状态，详细枚举值见下文to_status枚举描述

请求示例

curl --location --request POST 'https://open.douyin.com/api/trade_basic/v1/developer/fulfill_push_status' \ 
--header 'Content-Type: application/json' \ 
--header 'access-token: clt.xxx' \ 
--data-raw='{ 
        "order_id": "motb123123131", 
        "item_order_id_list": ["motb123123132"], 
        "to_status": "fulfilling"        
}'

响应参数

Body

名称字段类型是否必填示例描述
err_msgString是success

错误提示信息

err_noInt64是0

状态码 0 代表业务处理成功，具体错误码参见后文错误码章节

log_idString是success

日志id

响应示例

正常响应示例

{
  "err_no": 0,
  "err_msg": "success",
  "log_id": "2022092115392201020812109511046"
}

异常响应示例

{
  "err_no": 10000,
  "err_msg": "参数错误",
  "log_id": "2022092115392201020812109511046"
}

错误码

http状态码错误码错误码描述排查建议
20010000

参数错误

请仔细阅读接口文档，检查并更正参数后，重新发起请求

20012001

操作过于频繁，请稍后再试

稍后使用相同的参数再次重试调用

20013000

系统错误，请重试

接口返回系统错误情况下，当前请求的结果可能成功也可能失败

可保持相同的参数再次重试调用，若多次重试失败，请联系平台

20027017

订单存在退款记录

退款中的订单或者退款成功的订单无法再履约，无需重试

20027019

当前指定状态无效,请检查参数

当前订单所对应的履约状态机不包含请求指定状态，请更正to_status参数的值后，再重新发起请求

20027020

当前不允许流转到指定状态

当前订单的状态无法往指定请求状态流转，请更正to_status参数的值后，再重新发起请求。状态流转请参考文档

20027021

不允许使用该方式进行调用,请检查是否使用组件或openapi

当前状态流转需使用履约组件，或需使用openapi，请检查后请求对应接口。使用方式请参考文档

20027022

当前请求的订单状态不相同,请检查参数

每次请求指定的item单必须在同一个状态，请检查并更正参数后，重新发起请求

to_status信息​
​to_status的传参需要根据当前订单的商品类型决定，且前置履约状态需要符合“使用场景”中的要求。​
​详细履约状态机请参考文档​
​​
订单商品类型​
toStatus​
含义​
使用场景​
    •​普通咨询​
fulfill_done​
履约完成​
用于服务结束后，将履约状态由“履约中”驱动到“履约完成”​
    •​号卡商品​
    •​虚拟运营商靓号​
    •​三大运营商靓号​
    •​标准号卡​
    •​非标准流量卡​
fulfilling​
履约中​
用于商家制卡发货后，将履约状态驱动到“履约中”​
fulfill_done​
履约完成​
用于买家收货后，将履约状态由“履约中”驱动到“履约完成”​
    •​定制服务​
fulfilling​
履约中​
用于服务定制中，将履约状态驱动到“履约中”​
fulfill_done​
履约完成​
用于定制交付后，将履约状态由“履约中”驱动到“履约完成”​
​