商品创建
| 事件分组 | 事件标识 |
|---|---|
| products | products/create |
当商品被创建时触发。
请求头
- Content-Type string required字段值固定为
application/json; charset=utf-8。 - X-Shopline-Topic string required事件的唯一标识。例子:
orders/edited - X-Shopline-Hmac-Sha256 string required该请求的签名。收到请求后,你需要对该签名进行 验签 以验证数据的真实性和完整性。例子:
XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM= - X-Shopline-Shop-Domain string required店铺的域名。例子:
example.myshopline.com - X-Shopline-Shop-Id string required店铺 ID。例子:
1610418123456 - X-Shopline-Merchant-Id string required商家 ID。例子:
2000001234 - X-Shopline-API-Version string requiredAPI 版本号。例子:
v20250601 - X-Shopline-Webhook-Id string required该 Webhook 事件的 ID。例子:
b54557e48a5fbf7d70bcd043
请求体
- body_html string商品的描述。
combined_listingobject
组合商品关联信息对象,存放组合商品的 父商品与子商品关联标识信息。combined_listing_children_ids array组合商品下的子商品 ID 列表。例子:["16057850264845250791280282","16057850264845250333280282"]parent_product_id string组合商品的父商品 ID。例子:16050375155238626683133099- combined_listing_role string商品在组合商品中的角色。有效枚举值包含:
parent:表示组合商品的父商品。child:表示组合商品的子商品。no_role:表示非组合的独立售卖商品。
- handle string商品的语义化的唯一标识,默认基于
title生成。例子:product-handle - id string商品的唯一标识 ID。例子:
16057850264845250791280282 imageobject
商品的封面图。alt string图片的替代文本描述,通常是具有图片特征或内容的单词或短语。例子:This is an image alt.src string图片的链接,以 URL 形式展示。例子:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngimagesobject[]
商品图片列表。alt string商品图的替代文本描述,通常是具有图片特征或内容的单词或短语。例子:This is an image alt.src string商品图的链接,以 URL 形式展示。例子:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png- is_gift_card boolean是否为礼品卡商品。
true: 该商品是礼品卡商品false: 该商品不是礼品卡商品
mediaobject[]
商品媒体列表。alt string商品媒体的替代文本描述,通常是具有媒体特征或内容的单词或短语。例子:This is a media alt.caption string商品媒体的场景化说明文本。例子:This is a product media caption.content_type string商品媒体的类型。有效枚举值包含:IMAGE:表示一个 SHOPLINE 图像。VIDEO:表示一个 SHOPLINE 视频。EXTERNAL_VIDEO:表示一个外部视频。
id string商品媒体的唯一标识 ID。例子:5759070976424132652preview_image string商品媒体封面图的链接。例子:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngsrc string商品媒体的链接。例子:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pngoptionsobject[]
商品规格列表。id string规格的唯一标识 ID。例子:16158068291703878544960282name string规格的名称。例子:Coloroption_valuesobject[]
商品规格值列表。id string规格值的唯一标识 ID。例子:16050375155238626683133099value string规格值。例子:Redproduct_id string规格对应商品的唯一标识 ID。例子:16057850264845250791280282values array规格值列表。例子:["Red","Green","White"]values_images map规格值与对应图片 URL 的映射关系。- path string商品的相对路径。例子:
/products/clothes - product_behavior string用于标识商品的特殊行为,只在特定情况下有值返回。例如,当商品有潜在风险时,返回一个值。例子:
RISK,HIDDEN - product_category string商家自定义的商品类型。例子:
Electronic - product_type string商品的来源。有效枚举值包含:
NORMAL:SHOPLINE 商家后台维护的商品POD_TEMPORARY:POD 应用的临时商品TEMPORARY:其他临时商品
- published_scope string商品的销售渠道发布范围。有效值固定为
web,代表在线商店。 - spu string商家为商品自定义的标识。例子:
S00000001 - standard_category_id string标准商品类型 ID。例子:
3237 - status string商品的状态。有效枚举值包含:
active: 上架draft: 下架archived: 归档
- subtitle string商品的摘要。例子:
This is a subtitle - tags string商品的标签。例子:
tag1,tag2 - template_path string商品的主题模板。例子:
templates/product.product_template_name.json - title string商品的名称。例子:
This is a product title - unlisted boolean商品是否可被客户主动发现。
true: 商品不可被客户主动发现,但可通过直接链接访问。false: 商品可在店铺前台按原规则展示和被搜索。
variantsobject[]
商品款式列表。barcode string款式的条形码。例子:T00000001compare_at_price string款式的原价,数值保留到小数点后两位。例子:129.99id string款式的唯一标识 ID。例子:18057039439794751459380282imageobject
款式的图片。alt string款式图的替代文本描述,通常是具有图片特征或内容的单词或短语。例子:This is an image alt.src string款式图的链接,以 URL 形式展示。例子:https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.pnginventory_item_id string库存单位的唯一标识 ID。例子:59854602422372317075inventory_policy string款式的超卖策略。有效枚举值包含:deny:不允许超卖。continue:允许超卖。
inventory_quantity integer各存放地点的库存数量总和。例子:99inventory_tracker boolean表明是否开启库存追踪。true:开启库存追踪。false:不开启库存追踪。
option1 string款式第一个规格的信息。例子:redoption2 string款式第二个规格的信息。例子:xloption3 string款式第三个规格的信息。例子:cottonoption4 string款式第四个规格的信息。例子:shortoption5 string款式第五个规格的信息。例子:casualprice string款式的售价,数值保留到小数点后两位。例子:90.22product_id string款式对应商品的唯一标识 ID。例子:16057039432335097907370282required_shipping boolean表明款式是否需要运输。true:需要运输。false:不需要运输。
sku string商家为款式自定义的标识。例子:S00000001taxable boolean表明款式是否需要收税。true:需要收税。false:不需要收税。
title string款式的名称,由款式的规格值拼接而成。例子:red · xlweight string款式的重量,超过两位小数向上取整。例子:0.23weight_unit string款式的重量单位。有效枚举值包含:g:克kg:千克lb:磅oz:盎司zh_kg:公斤
- vendor string商品的品牌或厂商。例子:
SHOPLINE
状态码
收到 SHOPLINE 发送的 Webhook 通知后,你需要按照如下 SHOPLINE 要求的格式进行响应。
HTTP/1.1 200 OK关于如何订阅 Webhooks 及更多 Webhook 响应规则说明,请参考 Webhook 概述。
这篇文章对你有帮助吗?