查询单个商品

需要 read_products 权限点。

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

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

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

查询指定商品信息。

路径参数

product_id string required

商品的唯一标识 ID。
最大长度限制：64

例子: 16049619743346320200470282

查询参数

fields string

指明需要返回的字段，多个字段用英文逗号分隔。可指定的字段范围参考响应体中 product 对象下的一级子字段。

例子: title,id

请求头

Content-Type string required

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

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

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

状态码

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

响应头

traceId

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

响应体

productobject

商品信息。
body_html string

商品的描述。
created_at string

商品的创建时间。格式：ISO 8601。
例子: 2025-03-06T02:20:26+08:00
handle string

商品的语义化的唯一标识，默认基于 title 生成。
例子: product-handle
id string

商品的唯一标识 ID。
例子: 16057850264845250791280282
imageobject

商品的封面图。
alt string

图片的替代文本描述，通常是具有图片特征或内容的单词或短语。
例子: This is an image alt.
id string

图片的唯一标识 ID。
例子: 5785060242207917075
src string

图片的链接，以 URL 形式展示。
例子: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
imagesobject[]

商品图片列表。
alt string

商品图的替代文本描述，通常是具有图片特征或内容的单词或短语。
例子: This is an image alt.
id string

商品图的唯一标识 ID。
例子: 5785060242207917075
src string

商品图的链接，以 URL 形式展示。
例子: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
optionsobject[]

商品规格列表。
id string

规格的唯一标识 ID。
例子: 16158068291703878544960282
name string

规格的名称。
例子: Color
option_valuesobject[]

商品规格值列表。
id string

规格值的唯一标识 ID。
例子: 16050375155238626683133099
value string

规格值。
例子: red
product_id string

规格对应商品的唯一标识 ID。
例子: 16057850264845250791280282
values array

规格值列表。
例子: ["[\"red\", \"green\", \"white\"]"]
values_images map

规格值与对应图片 URL 的映射关系。
例子: {"red":"https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png"}
path string

商品的相对路径。
例子: /products/clothes
product_behavior string

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

商家自定义的商品类型。
例子: Electronic
product_type string

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

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

POD_TEMPORARY : POD 应用的临时商品

TEMPORARY : 其他临时商品
published_at string

商品发布到在线商店的时间。格式：ISO 8601。
例子: 2025-03-06T02:20:26+08:00
published_scope string

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

商家为商品自定义的标识，区别于 SHOPLINE 生成的 product.id。
例子: S00000001
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
updated_at string

商品最近一次更新的时间。格式：ISO 8601。
例子: 2025-03-06T02:20:26+08:00
variantsobject[]

商品款式列表。
barcode string

款式的条形码。
例子: T00000001
compare_at_price string

款式的原价，数值保留到小数点后两位。
例子: 129.99
id string

款式的唯一标识 ID。
例子: 18057039439794751459380282
imageobject

款式的图片。
alt string

款式图的替代文本描述，通常是具有图片特征或内容的单词或短语。
例子: This is an image alt.
id string

款式图的唯一标识 ID。
例子: 5785060242207917075
src string

款式图的链接，以 URL 形式展示。
例子: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
inventory_item_id string

库存单位的唯一标识 ID。
例子: 59854602422372317075
inventory_policy string

表明款式是否允许超卖。

deny：不允许超卖。

continue：允许超卖。

inventory_quantity integer

各存放地点的库存数量总和。
例子: 99
inventory_tracker boolean

表明是否开启库存追踪。

true：开启库存追踪。

false：不开启库存追踪。

option1 string

款式第一个规格的信息。
例子: red
option2 string

款式第二个规格的信息。
例子: xl
option3 string

款式第三个规格的信息。
例子: cotton
option4 string

款式第四个规格的信息。
例子: short
option5 string

款式第五个规格的信息。
例子: casual
price string

款式的售价，数值保留到小数点后两位。
例子: 90.22
product_id string

款式对应商品的唯一标识 ID。
例子: 16057039432335097907370282
require_shipping boolean

表明款式是否需要运输。

true：需要运输。

false：不需要运输。

sku string

商家为款式自定义的标识，区别于 SHOPLINE 生成的 variant.id。
例子: S00000001
taxable boolean

表明款式是否需要收税。

true：需要收税。

false：不需要收税。

title string

款式的标题，由款式的规格值拼装而成。
例子: red · xl
weight string

款式的重量，超过两位小数向上取整。
例子: 0.23
weight_unit string

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

g：克

kg：千克

lb：磅

oz：盎司

zh_kg：公斤
vendor string

商品的品牌或厂商。
例子: SHOPLINE

API Explorer

调试台

示例代码

Base URL

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

ParamOptions

product_id — path required

Authorization — header required

fields — query

Language

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

Examples

查询单个商品信息

Response

{
  "product": {
    "body_html": "<p>Thisisadesription</p>",
    "created_at": "2023-08-29T14:59:58+08:00",
    "handle": "my-product-23-1",
    "id": "16060895302856191591063144",
    "image": {
      "alt": "Thisisaimagealt",
      "id": "6089530275430875206",
      "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
    },
    "images": [
      {
        "alt": "Thisisaimagealt",
        "id": "6089530275430875206",
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
      },
      {
        "alt": "This is a image alt",
        "id": "6089563432963689533",
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
      }
    ],
    "options": [
      {
        "id": "16160895302863070249763144",
        "name": "Size",
        "product_id": "16060895302856191591063144",
        "values": [
          "L",
          "S",
          "XL",
          "XXL"
        ],
        "values_images": {}
      },
      {
        "id": "16160895302863070249793144",
        "name": "Color",
        "product_id": "16060895302856191591063144",
        "values": [
          "White"
        ],
        "values_images": {}
      }
    ],
    "product_behavior": "",
    "product_category": "Clothes",
    "product_type": "NORMAL",
    "published_at": "2023-08-29T14:59:58+08:00",
    "published_scope": "web",
    "spu": "S000000001",
    "status": "active",
    "subtitle": "Thisisasubtitle",
    "tags": "Spring,Tshirt",
    "title": "MyProduct25",
    "updated_at": "2023-08-29T14:59:59+08:00",
    "variants": [
      {
        "barcode": "T0000001",
        "compare_at_price": "99.00",
        "id": "18060895302863070249743144",
        "image": {
          "alt": "my image alt",
          "id": "6089530275430875206",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
        },
        "inventory_item_id": "6089530288991379429",
        "inventory_policy": "deny",
        "inventory_quantity": 0,
        "inventory_tracker": true,
        "option1": "L",
        "option2": "White",
        "price": "90.00",
        "product_id": "16060895302856191591063144",
        "require_shipping": true,
        "sku": "S0000001",
        "taxable": true,
        "title": "L · White",
        "weight": "0.20",
        "weight_unit": "kg"
      },
      {
        "barcode": "T0000001",
        "compare_at_price": "99.00",
        "id": "18060895634402500988513144",
        "image": {
          "alt": "This is a image alt",
          "id": "6089563432963689533",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
        },
        "inventory_item_id": "6089563439612587791",
        "inventory_policy": "continue",
        "inventory_quantity": 0,
        "inventory_tracker": true,
        "option1": "S",
        "option2": "White",
        "price": "90.00",
        "product_id": "16060895302856191591063144",
        "require_shipping": true,
        "sku": "S0000001",
        "taxable": true,
        "title": "S · White",
        "weight": "0.50",
        "weight_unit": "kg"
      },
      {
        "barcode": "B0000000001",
        "compare_at_price": "120.00",
        "id": "18060895302863070249833144",
        "image": {
          "alt": "Thisisaimagealt",
          "id": "6089530275430875206",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
        },
        "inventory_item_id": "6089530288991379430",
        "inventory_policy": "deny",
        "inventory_quantity": 0,
        "inventory_tracker": true,
        "option1": "XL",
        "option2": "White",
        "price": "100.00",
        "product_id": "16060895302856191591063144",
        "require_shipping": true,
        "sku": "S00000000102",
        "taxable": true,
        "title": "XL · White",
        "weight": "50.00",
        "weight_unit": "g"
      },
      {
        "barcode": "B0000000001",
        "compare_at_price": "120.00",
        "id": "18060895302863070249893144",
        "image": {
          "alt": "Thisisaimagealt",
          "id": "6089530275430875206",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/e46e6189dd5641a3b179444cacdcdd2a_15.png?w=1024&h=1024"
        },
        "inventory_item_id": "6089530288991379428",
        "inventory_policy": "deny",
        "inventory_quantity": 0,
        "inventory_tracker": true,
        "option1": "XXL",
        "option2": "White",
        "price": "100.00",
        "product_id": "16060895302856191591063144",
        "require_shipping": true,
        "sku": "S00000000103",
        "taxable": true,
        "title": "XXL · White",
        "weight": "50.00",
        "weight_unit": "g"
      }
    ],
    "vendor": "Shopline"
  }
}

这篇文章对你有帮助吗？

SHOPLINE

条款协议