创建商品

需要 write_products 权限点。

更多权限点使用信息，请参考：

POST https://{handle}.myshopline.com/admin/openapi/v20260301/products/products.json

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

在店铺中创建一个新商品。

请求头

Content-Type string required

字段值固定为 application/json; charset=utf-8。
Authorization string required

资源的访问令牌。参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
例子:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

请求体

productobject

商品信息。
product_category string

商家自定义的商品类型。
最大长度限制：255
vendor string

商品的品牌或厂商。
最大长度限制：255
created_at string

商品的创建时间，默认为当前时间，不得早于1990-01-01T00:00:00+08:00。格式：ISO 8601。
handle string

商品的语义化的唯一标识，默认基于 title 生成。
最大长度限制： 255
status string

商品的状态。有效枚举值包含：

active：上架

draft：下架

archived：归档

默认值: draft
body_html string

商品的描述。
最大长度限制：512
imagesobject[]

商品图片列表。
最大个数限制：502
alt string

商品图的替代文本描述，通常是具有图片特征或内容的单词或短语。
最大长度限制：512
src string

商品图的链接，以 URL 形式展示。
最大长度限制：255
template_path string

商品的主题模板。
title string

商品的标题。
最大长度限制：255
tags array

商品的标签。
最大个数限制：250
单字符串长度限制：255
例子: [""]
optionsobject[]

商品规格列表。
最大个数限制：5
name string

规格的名称。
最大长度限制：255
values_images map

规格值与对应图片 URL 的映射关系。
例子: {}
published_scope string

商品的销售渠道发布范围。有效值固定为web，代表在线商城。
path string

商品的相对路径。
最大长度限制：512
published_at string

商品发布到在线商店的时间。格式：ISO 8601。
variantsobject[]

商品款式列表。
最大个数限制：500
price string

款式的售价，数值保留到小数点后两位。
默认值：0
option1 string

款式第一个规格的信息。
最大长度限制：255
option2 string

款式第二个规格的信息。
最大长度限制：255
inventory_tracker boolean

表明是否开启库存追踪。

true：开启库存追踪。

false：不开启库存追踪。

默认值：true
option5 string

款式第五个规格的信息。
最大长度限制：255
option3 string

款式第三个规格的信息。
最大长度限制：255
taxable boolean

表明款式是否需要收税。

true：需要收税。

false：不需要收税。

默认值: true
weight string

款式的重量，要求大于 0，超过两位小数向上取整。
weight_unit string

款式的重量单位。有效枚举值包含：

g：克

kg：千克

lb：磅

oz：盎司

zh_kg：公斤

默认值: g
option4 string

款式第四个规格的信息。
最大长度限制：255
required_shipping boolean

表明款式是否需要运输。

true：需要运输。

false：不需要运输。

默认值：true
inventory_policy string

表明款式是否允许超卖。

deny：不允许超卖。

continue：允许超卖。

默认值: deny
barcode string

款式的条形码。
最大长度限制：255
sku string

商家为款式自定义的标识，区别于 SHOPLINE 生成的 variant.id。
最大个数限制：255
compare_at_price string

款式的原价，数值保留到小数点后两位。
默认值: 0
imageobject

款式的图片。
alt string

款式图的替代文本描述，通常是具有图片特征或内容的单词或短语。
最大长度限制：512
src string

款式图的链接，以 URL 形式展示。
最大长度限制：255
subtitle string

商品的摘要。
最大长度限制：400
activated_at string

商品的上架时间，不得早于created_at。格式：ISO 8601。
spu string

商家为商品自定义的标识，区别于 SHOPLINE 生成的 product.id。
最大个数限制：255

状态码

更多状态码信息，参考 HTTP 状态码。

响应头

traceId

请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。

响应体

productobject

商品信息。
tags string

商品的标签。
handle string

商品的语义化的唯一标识，默认基于 title 生成。
imagesobject[]

商品图片列表。
alt string

商品图的替代文本描述，通常是具有图片特征或内容的单词或短语。
id string

商品图的唯一标识 ID。
src string

商品图的链接，以 URL 形式展示。
product_type string

商品的来源。有效枚举值包含：

NORMAL : SHOPLINE 商家后台维护的商品

POD_TEMPORARY : POD 应用的临时商品

TEMPORARY : 其他临时商品
published_scope string

商品的销售渠道发布范围。有效值固定为web，代表在线商城。
title string

商品的标题。
published_at string

商品发布到在线商店的时间。格式：ISO 8601。
variantsobject[]

商品款式列表。
inventory_policy string

表明款式是否允许超卖。

deny：不允许超卖。

continue：允许超卖。

required_shipping boolean

表明款式是否需要运输。

true：需要运输。

false：不需要运输。

sku string

商家为款式自定义的标识，区别于 SHOPLINE 生成的 variant.id。
option3 string

款式第三个规格的信息。
option5 string

款式第五个规格的信息。
title string

款式的标题，由款式的规格值拼装而成。
weight_unit string

款式的重量单位。有效枚举值包含：

g：克

kg：千克

lb：磅

oz：盎司

zh_kg：公斤

inventory_item_id string

库存单位的唯一标识 ID。
updated_at string

商品发布到在线商店的时间。格式：ISO 8601。
price string

款式的售价，数值保留到小数点后两位。
taxable boolean

表明款式是否需要收税。

true：需要收税。

false：不需要收税。

barcode string

款式的条形码。
created_at string

款式的创建时间。格式：ISO 8601。
compare_at_price string

款式的原价，数值保留到小数点后两位。
imageobject

款式的图片。
src string

款式图的链接，以 URL 形式展示。
alt string

款式图的替代文本描述，通常是具有图片特征或内容的单词或短语。
id string

款式图的唯一标识 ID。
option4 string

款式第四个规格的信息。
inventory_quantity integer

各存放地点的库存数量总和。
id string

款式的唯一标识 ID。
inventory_tracker boolean

表明是否开启库存追踪。

true：开启库存追踪。

false：不开启库存追踪。

option1 string

款式第一个规格的信息。
option2 string

款式第二个规格的信息。
product_id string

款式对应商品的唯一标识 ID。
weight string

款式的重量，超过两位小数时向上取整。
id string

商品的唯一标识 ID。
vendor string

商品的品牌或厂商。
status string

商品的状态。有效枚举值包含：

active: 上架

draft: 下架

archived: 归档
body_html string

商品的描述。
optionsobject[]

商品规格列表。
id string

规格的唯一标识 ID。
name string

规格的名称。
option_valuesobject[]

商品规格值列表。
id string

规格值的唯一标识 ID。
value string

规格值。
product_id string

规格对应商品的唯一标识 ID。
values array

规格值列表。
例子: [""]
values_images map

规格值与对应图片 URL 的映射关系。
例子: {}
imageobject

商品的封面图。
alt string

图片的替代文本描述，通常是具有图片特征或内容的单词或短语。
id string

图片的唯一标识 ID。
src string

图片的链接，以 URL 形式展示。
created_at string

商品的创建时间。格式：ISO 8601。
product_category string

商家自定义的商品类型。
spu string

商家为商品自定义的标识，区别于 SHOPLINE 生成的 product.id。
updated_at string

商品最近一次更新的时间。格式：ISO 8601。
activated_at string

商品的上架时间。格式：ISO 8601。
template_path string

商品的主题模板。
product_behavior string

用于标识商品的特殊行为，只在特定情况下有值返回。例如，当商品有潜在风险时，返回一个值。
subtitle string

商品的摘要。

API Explorer

调试台

示例代码

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

Body

Body required

{
  "product": {
    "activated_at": "",
    "path": "",
    "title": "",
    "handle": "",
    "status": "",
    "body_html": "",
    "subtitle": "",
    "template_path": "",
    "published_at": "",
    "images": [
      {
        "alt": "",
        "src": ""
      }
    ],
    "tags": [
      ""
    ],
    "variants": [
      {
        "option5": "",
        "option4": "",
        "inventory_tracker": false,
        "option3": "",
        "price": "",
        "image": {
          "src": "",
          "alt": ""
        },
        "option1": "",
        "option2": "",
        "barcode": "",
        "required_shipping": false,
        "taxable": false,
        "sku": "",
        "weight_unit": "",
        "compare_at_price": "",
        "inventory_policy": "",
        "weight": ""
      }
    ],
    "vendor": "",
    "created_at": "",
    "options": [
      {
        "name": "",
        "values_images": {}
      }
    ],
    "published_scope": "",
    "spu": "",
    "product_category": ""
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/products/products.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

这篇文章对你有帮助吗？

SHOPLINE

条款协议