抖音开放平台Logo
开发者文档
控制台
  • 接入前准备
  • 通用能力
  • 门店相关接口
  • 团购核销
  • 团购对账
  • 会员接入
  • 订单查询
  • 订单查询
  • 订单消息通知
  • 券消息通知
  • 订单状态查询
  • 三方码
  • 商品发布
  • 代运营
  • 团购退款
  • 商品查询
  • 招商入驻
  • KA核销对账
  • 餐饮
  • 大交通
  • 酒旅
  • 综合
  • 历史版本文档(不推荐)
  • 订单状态查询
    收藏
    我的收藏

    抖音生活服务侧主动查询服务商侧订单状态信息并进行订单状态更新,确认两边数据状态一致。

    使用限制

    接口说明

      业务场景:适用于抖音回查对应订单状态,并进行平台状态更新,确保平台和服务商/商家订单状态一致。
      注意事项:按照接口接入即可,需在SPI配置中为“抖音主动查询服务商侧订单信息”配置URL地址

    基本信息

    基本信息
    HTTP URL
    -
    HTTP Method
    POST
    Scope
    life.capacity.tripartite.code
    权限要求
      需要申请权限。路径:
      移动/网站应用:抖音开放平台控制台 > 应用详情 > 权限管理 > 生活服务应用权限

    请求参数

    POST请求
    字段名称
    类型
    是否必填
    说明
    scene
    string
    场景,方便后续扩展,在不同场景下,要求返回的字段和结构或许不同
    order_ids
    list<string>
    订单id列表,不超过100个

    请求示例

    { "scene": "fulfil", // 场景,方便后续扩展,在不同场景下,返回的内容可能有所不同 "order_ids": ["123", "234"], // 抖音侧订单id }

    响应参数

    字段名称
    类型
    说明
    对应场景
    data
    object
    返回结构体
    all
    .error_code
    int
    错误码,详见错误码部分
    all
    .description
    string
    错误描述
    all
    .result
    map<string,OrderDetail>
    查询结果,key为订单id,value为对应的订单结构体
    all

    OrderDetail

    字段名称
    类型
    说明
    对应场景
    order_id
    string
    抖音侧订单id
    all
    out_order_id
    string
    三方订单id
    all
    order_status
    int
    抖音侧订单状态
    all
    order_items
    list<OrderItem>
    抖音侧item单列表
    aftersale
    codes
    list<CodeRecord>
    三方码列表
    fulfil
    total_quantity
    int
    总凭证数量
    all
    used_quantity
    int
    已核销凭证数量
    all
    refund_quantity
    int
    已退款凭证数量
    all
    vouchers
    list<Voucher>
    凭证列表
    fulfil

    OrderItem

    字段名称
    类型
    说明
    对应场景
    sku_id
    string
    skuId
    aftersale
    out_sku_id
    string
    三方skuId
    aftersale
    order_item_id
    string
    抖音侧item单id
    aftersale
    certificate_id
    string
    凭证单id
    aftersale
    item_status
    int
    抖音侧item单状态
    aftersale
    refund_amount
    int
    退款金额,单位分
    aftersale
    refund_time
    int
    退款时间,秒级时间戳
    aftersale

    CodeRecord

    字段名称
    类型
    说明
    对应场景
    value
    string
    凭证值
    fulfil
    type
    string
    凭证类型,适用codes:code-三方码,以下类型适用vouchers:qr_code-二维码,certificate_no-凭证号,id_card-身份证,hm_permit-港澳通行证,tw_permit-台湾通行证,reentry_permit-回乡证,tw_mainland_travel_permit-台胞证,passport-护照,foreign_passport-外国人护照,foreign_permanent_resident_id_card-外国人永久居留证,url-url凭证
    fulfil
    fulfil_status
    int
    核销状态,1代表已核销,2代表未核销,3代表已退款
    fulfil
    fulfil_time
    int
    核销时间,秒级时间戳
    fulfil
    verify_token
    string
    核销幂等token
    fulfil
    poi_id
    string
    核销门店id
    fulfil

    Voucher

    字段名称
    类型
    说明
    对应场景
    entrance
    Entrance
    入场券
    fulfil
    projects
    list<Project>
    项目
    fulfil

    Entrance

    字段名称
    类型
    说明
    对应场景
    project_id
    string
    项目id
    fulfil
    records
    list<CodeRecord>
    凭证记录
    fulfil

    Project

    字段名称
    类型
    说明
    对应场景
    project_id
    string
    项目id
    fulfil
    project_name
    string
    项目名称
    fulfil
    records
    list<CodeRecord>
    凭证记录
    fulfil

    响应示例

    { "data": { "error_code": 0, "description": "success", "result": { "123": { "order_id": "123", // 抖音订单id "out_order_id": "out123", // 服务商订单id "order_status": 201, // 抖音店铺单状态,100-待支付,101-支付取消,200-已支付,201-可使用,1-已完成 "order_items": // 抖音item单列表,履约场景不需要返回 [ { "sku_id": "抖音skuId", // 对应的抖音侧skuId "out_sku_id": "服务商侧的skuId", // 服务商侧skuId "order_item_id": "item单号", // 抖音侧item单号 "certificate_id": "券码id", // 抖音侧券码id,非券码code "item_status": 300, // item单状态,100-待使用,200-预约中,201-已预约,400-履约中,401-已履约,300-退款中,301-已退款 "refund_amount": 1000, // 退款金额 "refund_time": 1111 // 退款时间,秒级时间戳 } ], "codes": // 券码列表,售后场景不需要返回 [ { "value": "123", // 凭证值 "type": "code", // 值类型,code-码,id_card-身份证,qr_code-二维码,certificate_no-凭证 "fulfil_status": 1, // 核销状态,1-已核销,2-未核销 "fulfil_time": 123, // 核销时间 "verify_token": "xxx", // 核销token "poi_id": "123" // 核销门店 } ], "total_quantity": 6, // 凭证总数 "used_quantity": 4, // 使用数量 "vouchers": // 景区凭证,售后场景不需要返回 [ { "entrance": { "project_id": "abc", // 项目id "records": // 凭证记录 [ { "value": "123", "type": "id_card", "fulfil_status": 2, "fulfil_time": 123, "verify_token": "xxx", "poi_id": "123" }, { "value": "123", "type": "qr_code", "fulfil_status": 1, "fulfil_time": 123, "verify_token": "xxx", "poi_id": "123" }, { "value": "123", "type": "certificate_no", "fulfil_status": 1, "fulfil_time": 123, "verify_token": "xxx", "poi_id": "123" } ] }, "projects": [ { "project_id": "efg", "project_name": "项目名称", "records": [ { "id": "123", "id_type": "id_card", "fulfil_status": 2, "fulfil_time": 123, "verify_token": "xxx", "poi_id": "123" }, { "id": "123", "id_type": "qr_code", "fulfil_status": 1, "fulfil_time": 123, "verify_token": "xxx", "poi_id": "123" }, { "id": "123", "id_type": "certificate_no", "fulfil_status": 1, "fulfil_time": 123, "verify_token": "xxx", "poi_id": "123" } ] } ] ] } } } } }

    错误码

    错误码
    含义
    备注
    1
    未查询到抖音订单id
    2
    未查询到相关券码code
    3
    服务商内部错误,可重试(如超时)
    重试3次
    4
    服务商内部错误,不可重试(如宕机了)
    会触发过期退
    5
    不支持该场景
    入参中的scene无法支持
    99999
    其他
    其他未预定义的异常情况