用于创建商品前查询商品模板信息。

接口信息

接口说明

查询商品模板，创建商品时的属性列表需与该接口保持一致，否则无法识别。根据商品类目及商品类型获取商品模版信息。

如果商品模版未返回的字段就是该商品暂不支持的字段

attr_key_value_map 的格式

根据「查询商品模板」查出的模板，可以看到该行业该类型下的商品对应的可传的相关属性，技术需要关心的字段主要是以下几个：

key - 属性主键，attr_key_value_map 的 key 是什么
is_required - 是否必传
is_multi - 是否列表，需要和 value_type 组合起来看。例如：
value_type=STRING（表示字符串，具体参见下文），is_multi=true，则表示 value 是一个字符串列表（也就是 list）类型；
value_type=IMAGE（表示图片控件，具体参见下文），is_multi=true，则表示 value 是一个图片控件结构体列表（也就是 list）类型；
value_type - attr_key_value_map 的 value 类型，枚举可参见后文的表格。

attr_key_value_map 的类型是 map<string,string>，如果 value_type 为其他值类型需转换为 string

value_type 为整数/浮点数：转为十进制格式的 string
value_type 为布尔值：转为"true"或"false"
value_type 为结构体或结构体列表：需要使用 json 序列化

商品属性（attr_key_value_map）详细介绍参考文档：商品发布和查询能力

如果创建的商品属于product_sub_type商品子类型下的商品，请仔细查看product_sub_type字段对应的商品类型，切product_sub_type必传

本接口返回的模板为实时动态计算结果：同一类目下 is_required（如 settle_type）、value_demo（如 show_channel）、name（配送商品的属性别名）可能因账户灰度、商品类型不同而变化。

使用限制

SLA：支持的最大QPS:70;

基本信息

名称	描述
HTTP URL	https://open.douyin.com/goodlife/v1/goods/template/get/
HTTP Method	GET
Scope	life.capacity.goods.query
权限要求	- 需要申请权限，路径：抖音开放平台-开发者平台/服务商平台>控制台>应用详情>解决方案 - 需要商家授权，路径：抖音来客>店铺管理>服务应用授权

请求参数

请求头

access-token必填String

示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ

调用https://open.douyin.com/oauth/client_token/生成的token

content-type必填String

固定值"application/json"

Rpc-Transit-Life-AccountString

来客商户根账户ID

Query展开全部子属性

category_id必填String

三级品类id

product_type必填Enum

商品类型

展开子属性

open_biz_typeEnum

开平业务类型

1-组合券包类型

（仅在创建组合券包类商品时需要传）

展开子属性

product_sub_typeEnum

商品子类型

（当目标商品归属某一商品子类型（如先买后约、日历房等）时，product_sub_type 必须与 product_type 配套传入，否则返回的模板属性与实际可创建商品不一致。普通商品可不传）

展开子属性

请求示例
curl --location --request GET 'https://open.douyin.com/goodlife/v1/goods/template/get/?Base={"LogID":"IbzwY323fo","Caller":"aGoOUR5o8Z","Addr":"jvOe5Pd7xL","Client":"hvOy7O0Lsw","TrafficEnv":{"Open":false,"Env":"VL1AVwRbUs"},"Extra":{"s3U4t2BGfM":"I5dAwqYqzO"}}&product_type=1&category_id=sPRb02ufgS&template_type=1&product_sub_type=1&open_biz_type=1' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \

响应参数

Body展开全部子属性

BaseResp必填Struct

展开子属性

extra必填Struct

扩展信息

展开子属性

dataStruct

响应信息

展开子属性

响应示例
正常响应示例异常响应示例
{
  "data": {
    "description": "",
    "product_attrs": [
      {
        "is_required": false,
        "value_type": "Ejk6jSHqYt",
        "value_demo": "vsVz4eLPGW",
        "desc": "dCoHVyHQse",
        "key": "6j6XXiHNul",
        "name": "nvPiPazuLK",
        "is_multi": false
      }
    ],
    "sku_attrs": [
      {
        "key": "xDP4EuGSbI",
        "name": "lZuvwXc7b2",
        "is_multi": false,
        "is_required": false,
        "value_type": "hIHKgVyub3",
        "value_demo": "3DK7h4BlRQ",
        "desc": "raYvTxbiz6"
      }
    ],
    "spu_attrs": [
      {
        "value_demo": "U6MFpemILT",
        "desc": "xcneyydcMc",
        "key": "BQfb1XueeZ",
        "name": "IvSLqlZZXA",
        "is_multi": false,
        "is_required": false,
        "value_type": "tEEkDFLMa2"
      }
    ],
    "calendar_attrs": [
      {
        "value_type": "39738uNZtT",
        "value_demo": "rsbz3fQQCj",
        "desc": "fZYIAcytnS",
        "key": "lJAnEv99GU",
        "name": "msxVbKMXVz",
        "is_multi": false,
        "is_required": false
      }
    ],
    "error_code": 0
  },
  "extra": {
    "error_code": 0,
    "description": "",
    "sub_error_code": 0,
    "sub_description": "",
    "logid": "202602021437161CEB1B90BDEC9D783E62",
    "now": 1770014236
  },
  "BaseResp": {
    "StatusCode": 2307720115545949700,
    "Extra": {
      "psFPXXN0mC": "5oojyGrieW"
    },
    "StatusMessage": "vRRCP6mBg6"
  }
}

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	2190002	access_token无效	调用接口重新生成access_token
200	2190004	应用未获得该能力, 请去https://open.douyin.com/申请	应用申请接口权限
200	2190008	access_token过期,请刷新或重新授权	规范token刷新机制，检查是否有测试环境在同步刷新token
200	2119001	参数不合法	更换参数
200	2119002	系统繁忙，请稍候再试	重试
200	2119003	请求太过频繁，请稍后再试	重试
200	2119005	应用未获商家授权	联系合作商家在商家后台发起授权，并在服务商后台同意授权
200	3000001	根据实际业务错误返回	对照接口文档规范参数并重试
200	4000001	根据实际业务错误返回	补充参数
200	4000002	根据实际业务错误返回	对照接口文档规范参数并重试
200	5000001	根据实际业务错误返回	联系抖音处理
200	2100001	未知错误	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100004	系统繁忙，此时请开发者稍候再试	重试接口，重试3次仍报错联系抖音生活服务技术支持
200	2100005	参数不合法	更换参数
200	5000001	服务器打瞌睡了，请稍后再试。
200	3000001	以实际错误信息为准

attr_key_value_map 的格式

根据「查询商品模板」查出的模板，可以看到该行业该类型下的商品对应的可传的相关属性，技术需要关心的字段主要是以下几个：

1.

key - 属性主键，attr_key_value_map 的 key 是什么

2.

is_required - 是否必传

3.

is_multi - 是否列表，需要和 value_type 组合起来看。例如：

a.

value_type=STRING（表示字符串，具体参见下文），is_multi=true，则表示 value 是一个字符串列表（也就是 list）类型；

b.

value_type=IMAGE（表示图片控件，具体参见下文），is_multi=true，则表示 value 是一个图片控件结构体列表（也就是 list）类型；

4.

value_type - attr_key_value_map 的 value 类型，枚举可参见后文的表格。

attr_key_value_map 的类型是 map<string,string>，如果 value_type 为其他值类型需转换为 string

5.

value_type 为整数/浮点数：转为十进制格式的 string

6.

value_type 为布尔值：转为"true"或"false"

7.

value_type 为结构体或结构体列表：需要使用 json 序列化

关键属性介绍

属性key	属性名	枚举值说明	is_multi	属性类型	参数示例
appointment	预约信息	消费提示：做展示使用	FALSE	APPOINTMENT
auto_renew	是否开启自动延期(只有闭环商品生效)	"true"/"false"	FALSE	BOOL
bring_out_meal	是否可以外带餐食（次卡不生效）	消费提示：做展示使用	FALSE	BOOL
can_no_use_date	不可使用日期	消费提示里注明的不可使用日期，可以是天、星期和节日	FALSE	CAN_NO_USE_DATE
cooperation_mode	合作模式	"DIRECT = 1 // 直连; INDIRECT = 2 // 间连 ",	FALSE	INT64
limit_use_rule	限制使用规则	is_limit_use（布尔类型）：true：启用张数限制 false：不限制使用张数 use_num_per_consume：整型每次消费可使用的张数，必须为正整数		LimitUseRuleStruct	"limit_use_rule": "{\"is_limit_use\":true,\"use_num_per_consume\":1}"
customer_reserved_info	留资规则		FALSE	CUSTOMER_RESERVED_INFO
description_rich_text	其他说明信息		TRUE	NOTE
Description	商品描述	•如果不需要，传"[]" •如需传入请参考示例："Description":"[\"【test】A+B\\nA：test2\\nB：test1\"]"
detail_image_list	长图	图片比例无限制	TRUE	IMAGE
dishes_image_list	菜品图	图片比例：375:280	TRUE	IMAGE
entry_type	入口类型	"1:H5 2:小程序 3:抖音",	FALSE	STRING
environment_image_list	环境图	图片比例：375:280	TRUE	IMAGE
free_pack	是否可以打包	消费提示：做展示使用	FALSE	BOOL
FrontCategoryTag		枚举 "测试", "门票", "项目", "团购", "一日游", "旅行跟拍", "含房套餐", "美食套餐", "美食单品", "单景区门票", "单景区套票", "多景区联票", "游玩项目票", "门店项目票", "代金券", "日历房", "其他", "多日游", "门店服务", "单房型",	TRUE	STRING
image_list	封面图	图片比例：375:280	TRUE	IMAGE
IndustryType	商品行业类型	枚举: "门票", "一日游", "多日游", "旅拍", "其他",	FALSE	STRING
IsConfirmImme	是否立即确认	酒旅专用	FALSE	BOOL
~~MpResourceID~~	~~小程序资源id~~		FALSE	STRING
~~MpSettleType~~	~~小程序分账类型~~	"1-包销 2-代销",三方分账使用	FALSE	INT64
Notification	使用规则		TRUE	NOTIFICATION
private_room	是否可以使用包间	消费提示：做展示使用	FALSE	BOOL
real_name_info	实名信息		FALSE	REAL_NAME_INFO
RecommendWord	推荐语		FALSE	STRING
rec_person_num	建议使用人数		FALSE	INT64
rec_person_num_max	最多使用人数		FALSE	INT64
RefundPolicy	退款政策	1-允许退款 2-不可退款 3-有条件退	FALSE	INT64
refund_need_merchant_confirm	退款是否需商家审核		FALSE	BOOL
release_source	商品发布渠道	"MERCHANT = 1 // 商家; BD = 2 // BD; FACILITATOR = 3 // 服务商;",	FALSE	INT64
show_channel	投放渠道	UNLIMIT = 1//不限制 ONLY_LIVING_ROOM=2//仅直播间展示 NOT_FOR_SALE=3 //废弃。不售卖,仅交易可见 ONLY_TRADE=4 //仅交易可见 OFFLINE=5,//线下活动 INFLUENCER=6,//商单 NEWBIE=7, //新人 ONLINE=8,//线上 ONLY_COUPON_PACKAGE=9//仅限省钱券包 LIVE_AND_VIDEO=10,//直播+短视频 VIDEO=11,//仅短视频 SUPER_SKU = 12,//超级sku EXCHANGE =13,//兑换可见 LIVE_AND_NEG=14,//直播间+协商订 SP_FREE=15,//仅大促免费领 SP_RANK=16,//仅大促排行榜 ONLY_EASY_BUY = 17, // 仅顺手买渠道 ONLY_FREE_TRY = 18, // 仅免费试 ONLY_OFFLINE_MACHINE = 19 // 仅线下机器售卖 ONLY_FUN_BUDDY = 21 // 仅趣玩搭子 ONLY_GROUPON_MALL = 22 //仅团购商城 LIVING_ROOM_AND_CUSTOMER_ACQUISITION_CARD = 23 // 直播间+获客卡 ONLY_CUSTOMER_ACQUISITION_CARD = 24 // 仅获客卡 ONLY_MARKETING_ACTIVITY = 25 // 仅活动报名 GUIDE_BLOCK = 26 //导购屏蔽	FALSE	INT64
superimposed_discounts	可以享受店内其他优惠	消费提示：做展示使用	FALSE	BOOL
trade_url	小程序提单页跳转	提单页URL，直播间下单会使用	FALSE	STRING
use_date	使用日期	券码的可以核销日期，履约核销强依赖	FALSE	USE_DATE
use_time	使用时间	用户可以消费的时间	FALSE	USE_TIME
code_source_type	券码生成方式	"1-抖音码 2-三方码 3-预导码", 抖音码：即交易后，抖音发券码，通过抖音侧进行核销，然后同步到开发者。当前仅针对白名单开发者开放。三方码：即交易后，开发者发券码，在开发者侧进行核销，然后核销以及订单状态，同步到抖音。预导码：可忽略	FALSE	INT64
commodity	菜品搭配		TRUE	COMMODITY
limit_rule	限制购买	最多购买份数	FALSE	LIMIT_RULE
market_price	市场价	即菜品搭配里的总价	FALSE	STRING
settle_type	收款方式	"1-总店结算 2-分店结算 3-区域结算", 总店结算：即商品的结算资金统一结算到商家（不是开发者）的收款账户。分店结算：按核销POI将资金结算到对应的POI的收款账户，如果POI没有设置收款账户，会将对应的POI的结算资金打款到总店账户；区域结算：按核销POI将资金结算到对应的区域账户，如未绑定区域账户，默认打款到总店账户（团购、代金券可用，次卡综合餐饮行业可用）	FALSE	INT64
use_type	团购使用方式	"1-到店核销",默认值	FALSE	INT64
SubTitle	副标题	过期退；随时退；x日内可退；免预约；提前x日预约；多个副标题以\|（英文半角）分隔，不要有空格（目前只有退款相关的生效）	FALSE
qualification_identity	资质身份	演出类目必填 1：主办方：主办方资质必填 2：票务代理：主办方资质和票务代理资质必填主办方资质对应资质查询接口中的“营业性演出准予许可决定” 票务代理资质对应资质查询接口中的“演出主办方授权书”	FALSE	INT64
host_approval_qual	主办方资质	最多5个	TRUE	QualificationInfoStruct
ticket_agent_qual	票务代理资质	最多10个	TRUE	QualificationInfoStruct
suitable_group_with_multi_enum(养发）	适宜人群	最多4个	TRUE	COMMON_ENUM
user_num_limit(养发）	使用人数限制		FALSE	USER_NUM_LIMIT
product_features(养发）	功能作用	最多4个	TRUE	COMMON_ENUM
limit_buy_rule_note	限购规则	用于展示对应规则，接口无限制，仅做透传使用	FALSE	STRING
real_name_ticket_rule_note	实名购票规则	仅作规则描述,不生效	FALSE	REAL_NAME_BUY_TICKET_RULE
refund_rule_note	是否支持退款	退款规则描述,不生效 policy_rule_type: 2-不可退 4-条件退	FALSE	CUSTOM_POLICY
tickets_rule_note	入场规则	仅作规则描述,不生效	FALSE	TICKETS_RULE
transfer_rule_note	转赠规则	仅作规则描述,不生效	FALSE	STRING
child_ticket_rule_note	儿童票规则	仅作规则描述,不生效	FALSE	STRING
performance_duration	演出时长		FALSE	COMMON_TIME
applicable_models	适用车型		FALSE	COMMON_ENUM
voucher_type	代金券类型	1-品牌券 2-品类券 3-通用券注意事项： - voucher_type=1时，适用品牌类型只能传2-部分品牌适用，并且适用品牌列表只能传一个品牌；适用品类没有限制； - voucher_type=2时，适用品类类型只能传2-部分品类适用，并且适用品类列表只能传一个品类；适用品牌无限制；	FALSE	COMMON_ENUM
applicable_brands	代金券适用品牌	适用品牌类型applicable_brand_type: 1-全部品牌适用；2-部分品牌适用；3-部分品牌不适用；类型2、3需同时传入品牌列表applicable_brand_list	FALSE	APPLICABLE_BRANDS	{\"applicable_brand_type\":{\"key\":1,\"value\":\"全部品牌适用\"}}
applicable_category	代金券适用品类范围	适用品牌类型applicable_category_type: 1-全部品类适用；2-部分品类适用；3-部分品类不适用；类型2、3需同时传入品类列表applicable_category_list	FALSE	APPLICABLE_CATEGORY	{\"applicable_category_type\": {\"key\":1,\"value\":\"全部品类适用\"}}
groupon_supplementary_instruction	补充说明		FALSE	STRING
fulfillment_method	履约方式	fulfillment_type内枚举值 3-闭环配送到家，即团购支持配送	false	FULFILLMENT_METHOD
can_microapp_delivery	小程序随心团	true-开通	FALSE	bool
additional_poi_support_history	历史订单新增门店	"true" "false"(false可不传)	FALSE	BOOL

备注

/** 预约方式 */
enum BookingType {
    ONLINE = 1 // 线上预约
    BOTH = 2   // 可线上/线下预约
    THIRD = 3  // 第三方预约
    MERCHANT = 4 // 商家端预约
}

/**提供发票方式*/
enum BillPolicyTypeEnum{
    //商家提供
    MERCHANT    = 1 //商家提供
    //平台提供
    PLATFORM    = 2 //平台提供
    //服务商提供
    SUPPLIER    = 3 //服务商提供
    //旅行社提供
    TRAVELAGENCY = 4 //旅行社提供
    // 酒店提供
    HOTEL = 5        // 酒店提供
    // 景区提供
    SCENICAREA = 6  // 景区提供
}

开发者文档

查询商品模板接口

接口信息

接口说明

attr_key_value_map 的格式

使用限制

基本信息

请求参数

响应参数

错误码

attr_key_value_map 的格式

关键属性介绍

备注

查询商品模板接口在线调试

接口信息

接口说明

attr_key_value_map 的格式

使用限制

基本信息

请求参数

响应参数

错误码

attr_key_value_map 的格式

关键属性介绍

备注

查询商品模板接口