接口介绍

该接口用于第三方小程序应用为授权小程序提交商铺资质材料。

注意:

  • 需要为每个店铺(supplier_ext_id) + 授权小程序组合都上传一遍所有材料,包括:商铺营业执照路径(biz_licence_path)、服务商和商家的合作协议路径(contract_path)、商铺行业资质材料(qual_material)以及必要的补充资质(additional_qual)。

请求

基本信息

基本


HTTP URL

https://open.microapp.bytedance.com/openapi/v1/microapp/operation/add_shop_material

HTTP Method

POST

权限要求

授权小程序授予运营管理权限

查询参数

参数名

参数类型

是否必须

备注

component_appid

string

第三方小程序应用 appid

authorizer_access_token

string

授权小程序接口调用凭据

请求体(json)

参数名

参数类型

是否必须

备注

client_key

string

服务商在抖音开放平台的应用唯一标识

supplier_ext_id

string

接入方店铺 ID

biz_licence_path

string

商铺营业执照路径
需要使用代授权小程序上传资源
接口返回的路径才可以,接口调用时入参 material_type 字段为 7,否则报错。

contract_path

string

商家授权函(或与小程序的合作协议)路径
需要使用代授权小程序上传资源
接口返回的路径才可以,接口调用时入参 material_type 字段为 8,否则报错。

qual_material

Array<object>

商铺行业资质材料信息

expire_time

string

过期时间
所有材料(营业执照、合作协议、行业资质材料)中的最早到期时间
格式:2021-07-22

additional_qual

Array<object>

其他补充资质,某些行业需要除上面已列资质之外的其他资质,请在这里添加

qual_material 说明

参数名

参数类型

是否必须

备注

path

string

商铺行业资质材料路径
需要使用代授权小程序上传资源
接口返回的路径才可以,接口调用时入参 material_type 字段为 7,否则报错。

additional_qual 说明

参数名

参数类型

是否必须

备注

additional_qual_type

int

上传资质类型,传入非有效值会或同一请求上传多个同一资质类型会报错

目前有效值为:
身份证:1

健康证:2

paths

Array<object>

资质材料路径list

目前支持图片数量上限为4张,超过数量或数量为0会报错

paths 说明

参数名

参数类型

是否必须

备注

path

string

资质材料路径
需要使用代授权小程序上传资源
接口返回的路径才可以,接口调用时入参 material_type 字段为 7,否则报错。

请求体示例

{ "client_key": "awxxxxxxxxxxxxxx", "supplier_ext_id": "y0001", "biz_licence_path": "xxxx/xxxx", "contract_path": "xxxx/xxxx", "qual_material": [ { "path": "xxxx/xxxx" }, ... ], "additional_qual": [ { "additional_qual_type": 1, //1类型为身份证 "paths": [{"path":"tos-xxx-ffffffff/44efddffd1611fdf95"}] }, { "additional_qual_type": 2, //2类型为健康证 "paths": [{"path":"tosxxx8/44efdfadfaf124c4edf95"}, {"path":"tosdsdf8/44efsdfafdasfc4e95"}] }, ... ], "expire_time": "2021-07-22" }

注意:

  • 按照目前标准,商铺行业资质材料(qual_material)最多只需要上传三份文件,所以多传会导致接口报“参数错误”。
  • 提交商铺资质前,需要保证完成商铺同步并且上线,商铺没有上线会导致接口报“找不到商铺相关信息”。
  • 按照目前标准,额外补充资质(additional_qual)每种资质最多上传四张图片,所以多传会导致接口报“参数错误”。

响应

响应体

参数名

参数类型

备注

errno

int

错误码

message

string

错误信息

响应体示例

{ "errno": 0, "message": "success" }

错误码

错误码

message

40001

参数错误

40003

找不到相关第三方小程序应用

40004

找不到相关授权小程序

40020

第三方小程序应用 authorizer_access_token 不正确或者已过期

40033

获取不到上传的材料,请确认文件路径正确

40036

授权小程序未授予该接口对应的权限

40042

时间格式有误

40047

找不到商铺相关信息

40048

该商铺资质材料正在审核中

40049

该商铺资质材料上传操作太频繁,请稍后重试

40050

不支持该类型的资质上传,检查额外资质类型是否为有效值

该文档是否有帮助?