查询销售渠道中的单个商品

需要 read_product_listings 权限点。

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

GET https://{handle}.myshopline.com/admin/openapi/v20270301/product_listings/:product_listing_id.json

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

查询当前销售渠道下的指定商品。

路径参数

product_listing_id string required

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

例子: 16049619743346320200470282

请求头

Content-Type string required

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

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

Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

状态码

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

响应头

traceId

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

响应体

product_listingobject

商品信息。
body_html string

商品的描述。
例子: This is a description
created_at string

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

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

商品图片列表。
alt string

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

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

商品规格列表。
id string

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

规格的名称。
例子: Color
product_id string

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

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

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

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

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

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

商家为商品自定义的标识。
例子: 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 name
unlisted boolean

商品是否设置为非公开状态。

true: 非公开。商品在店铺前台的所有公开展示与搜索渠道中均被隐藏，仅可通过直接链接访问。

false: 公开。商品正常在前台各渠道展示，并可被搜索。
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.
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
required_shipping boolean

表明款式是否需要运输。

true：需要运输。

false：不需要运输。

sku string

商家为款式自定义的标识。
例子: 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/v20270301

ParamOptions

product_listing_id — path required

Authorization — header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20270301/product_listings/product_listing_id.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Examples

查询销售渠道中的指定商品

Response

{
  "product_listing": {
    "body_html": "<p>This is a description</p>",
    "created_at": "2023-08-28T11:45:53+08:00",
    "handle": "my-product-15",
    "images": [
      {
        "alt": "This is an alt",
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
      }
    ],
    "options": [
      {
        "id": "16160878853605069127763144",
        "name": "Size",
        "product_id": "16060878853599197112313144",
        "values": [
          "L",
          "XL",
          "XXL"
        ],
        "values_images": {}
      },
      {
        "id": "16160878853605069127793144",
        "name": "Color",
        "product_id": "16060878853599197112313144",
        "values": [
          "White"
        ],
        "values_images": {}
      }
    ],
    "product_id": "16060878853599197112313144",
    "published_at": "2023-08-28T11:45:53+08:00",
    "published_scope": "web",
    "spu": "S000000001",
    "status": "active",
    "subtitle": "This is a subtitle",
    "tags": "Spring,T shirt",
    "template_path": "templates/products/detail.html",
    "title": "My Product 15",
    "updated_at": "2023-08-28T19:19:05+08:00",
    "variants": [
      {
        "barcode": "T00000001",
        "compare_at_price": "120.00",
        "id": "18060878853605069127743144",
        "image": {
          "alt": "This is an alt",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
        },
        "inventory_item_id": "6087885361949712083",
        "inventory_policy": "continue",
        "inventory_quantity": 580,
        "inventory_tracker": true,
        "option1": "L",
        "option2": "White",
        "price": "100.00",
        "product_id": "16060878853599197112313144",
        "required_shipping": true,
        "sku": "S00000000101",
        "taxable": true,
        "title": "L · White",
        "weight": "10.00",
        "weight_unit": "g"
      },
      {
        "barcode": "B0000000001",
        "compare_at_price": "120.00",
        "id": "18060878853605069127833144",
        "image": {
          "alt": "My Product-10",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
        },
        "inventory_item_id": "6087885361949712081",
        "inventory_policy": "deny",
        "inventory_quantity": 100,
        "inventory_tracker": true,
        "option1": "XL",
        "option2": "White",
        "price": "100.00",
        "product_id": "16060878853599197112313144",
        "required_shipping": true,
        "sku": "S00000000102",
        "taxable": true,
        "title": "XL · White",
        "weight": "50.00",
        "weight_unit": "g"
      },
      {
        "barcode": "B0000000001",
        "compare_at_price": "120.00",
        "id": "18060878853605069127893144",
        "image": {
          "alt": "My Product-10",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
        },
        "inventory_item_id": "6087885361949712082",
        "inventory_policy": "deny",
        "inventory_quantity": 170,
        "inventory_tracker": true,
        "option1": "XXL",
        "option2": "White",
        "price": "100.00",
        "product_id": "16060878853599197112313144",
        "required_shipping": true,
        "sku": "S00000000103",
        "taxable": true,
        "title": "XXL · White",
        "weight": "50.00",
        "weight_unit": "g"
      }
    ],
    "vendor": "Shopline"
  }
}

这篇文章对你有帮助吗？

SHOPLINE

条款协议