批量查询商品

需要 read_products 权限点。

更多权限点使用信息,请参考:

[]

访问权限

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

[]

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

[]

批量查询商品基本信息。

查询参数

collection_id string
[]
商品分类的唯一标识符 ID。
最大长度限制：64
[]
Example: 12248721639068681442230282
created_at_max string
[]
指定要查询商品的截止创建时间。在此日期或此日期之前创建的订单会被返回，需与 created_at_min 配合使用，共同确定查询的时间区间。格式：ISO 8601。
[]
Example: 2021-09-02T14:11:54+00:00
created_at_min string
[]
指定要查询商品的起始创建时间。在此日期或此日期之后创建的订单会被返回。格式：ISO 8601。
[]
Example: 2021-09-03T14:11:54+00:00
fields string
[]
需要返回的分类字段，多个字段使用逗号分隔。
[]
Example: title,id,created_at
handle string
[]
商品的 handle，基于商品标题自动生成的唯一标识。更改商品标题不会更新 handle。
[]
Example: product-handle
ids string
[]
指定的商品 ID，多个 ID 用逗号分隔。
[]
Example: 16057850264845250791280282,16057850264845250333280282
limit integer
[]
查询商品数量的限制。
默认值：50
取值范围：1-250
[]
Example: 100
order_by string
[]
按商品创建时间排序。
- created_at_asc : 按商品创建时间从远到近排序。
- created_at_desc : 按商品创建时间从近到远排序。
[]
Example: created_at_desc
page_info string
[]
调用方不需要使用和关注此字段，由SHOPLINE自动封装。
[]
Example: eyJzaW5jZUlkIjoiMTYwNTc4NTY3NjcxMTc3MDcyNTEwNjAyODIiLCJkaXJlY3Rpb24iOiJuZXh0Iiwic29ydFR5cGUiOiJjcmVh
product_category string
[]
产品的类型。
[]
Example: Electronics
since_id string
[]
从这个商品ID开始查询。
[]
Example: 16057850264845250791280282
status string
[]
商品状态。有效枚举值包含：
- active: 上架。
- draft: 下架。
- archived: 归档。
[]
Example: active
title string
[]
商品标题，用于展示给买家。
[]
Example: This is a title.
updated_at_max string
[]
指定要查询商品的截止更新时间。在此日期或此日期之前更新的商品会被返回，需与 updated_at_min 配合使用，共同确定查询的时间区间。格式：ISO 8601。
[]
Example: 2021-09-02T14:11:54+00:00
updated_at_min string
[]
指定要查询商品的起始更新时间。在此日期或此日期之后更新的商品会被返回，需与 updated_at_max 配合使用，共同确定查询的时间区间。格式：ISO 8601。
[]
Example: 2021-09-03T14:11:54+00:00
vendor string
[]
商品的厂商。
[]
Example: SHOPLINE

请求头

Content-Type required
[]
字段值固定为application/json; charset=utf-8
Authorization string required
[]
资源的访问令牌。请参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

响应

[]

更多状态码信息请参考 HTTP 状态码

响应头

link
[]
查询跳转页
traceId
[]
traceId

响应体

productsobject[]
[]
商品。
body_html string
[]
商品描述。
最大长度限制：512
[]
Example: product description
created_at string
[]
创建时间。格式：ISO 8601。
[]
Example: 2021-09-02T14:11:54+00:00
handle string
[]
商品的 handle，基于商品标题自动生成的唯一标识。更改商品标题不会更新 handle。
[]
Example: product-handle
id string
[]
商品的唯一标识符 ID。
[]
Example: 16057850264845250791280282
imageobject
[]
图片信息。
alt string
[]
具有图像特征或内容的单词或短语。
最大长度限制：255
[]
Example: This is a image alt.
id string
[]
图片的ID。
[]
Example: 5785060242207917075
src string
[]
对应的图片链接。
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
imagesobject[]
[]
图片信息。
alt string
[]
具有图像特征或内容的单词或短语。
最大长度限制：255
[]
Example: alt
id string
[]
图片ID。
[]
Example: 5785060242207917075
src string
[]
对应的图片链接。
最大长度限制：255
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
optionsobject[]
[]
选项列表。
id string
[]
选项ID。
[]
Example: 16158068291703878544960282
name string
[]
选项名称。
[]
Example: Color
product_id string
[]
对应的商品ID。
[]
Example: 16057850264845250791280282
values array
[]
选项值列表。
[]
Example: ["Red", "Green", "White"]
values_images map
[]
选项值图。
[]
Example: [object Object]
path string
[]
在线商店中商品URL的相对路径。

最大长度限制：512
[]
Example: /my_product
product_behavior string
[]
商品行为。
[]
Example: RISK, HIDDEN
product_category string
[]
产品类型。
[]
Example: Electronics
product_type string
[]
商品类型。

NORMAL : 正常商品。

POD_TEMPORARY : POD临时商品。

TEMPORARY : 临时商品。

[]
Example: NORMAL
published_at string
[]
发布到在线商店的时间，格式：ISO 8601。
[]
Example: 2021-09-02T14:11:54+00:00
published_scope string
[]
设置发布范围，值为 "web" 时表示在线商店。
[]
Example: web
spu string
[]
SPU（标准产品单元），表示一类具有相同基本属性的产品。
[]
Example: S00000001
status string
[]
商品状态。

active: 上架。

draft: 下架。

archived: 归档。

[]
Example: active
subtitle string
[]
商品摘要。
最大长度限制：255
[]
Example: This is a subtitle
tags string
[]
商品标签。
最大数量限制： 250
最大长度限制：255
[]
Example: tag1, tag2
template_path string
[]
主题模板。
[]
Example: templates/products/detail.json
title string
[]
商品标题。
最大长度限制：255
[]
Example: This is a Product title
updated_at string
[]
更新时间。格式：ISO 8601。
[]
Example: 2021-09-02T14:11:54+00:00
variantsobject[]
[]
款式列表。
barcode string
[]
变体的条形码。
最大长度限制：255
[]
Example: T0000001
compare_at_price string
[]
变体的原价，价格数值保留到小数点后两位，默认为空。
[]
Example: 129.99
id string
[]
款式ID。
[]
Example: 18057850264851626133510282
imageobject
[]
图片信息。
alt string
[]
图片的 alt 信息。
最大长度限制：255
[]
Example: This is the image alt
id string
[]
图片ID。
[]
Example: 5785060242207917075
src string
[]
对应的图片链接。
最大长度限制：255
[]
Example: https://img.myshopline.com/image/official/e46e6189dd5641a3b179444cacdcdd2a.png
inventory_item_id string
[]
库存对象ID。
[]
Example: 5785060242375689228
inventory_policy string
[]
超卖策略。

continue：允许。

deny：不允许。

[]
Example: deny
inventory_quantity integer
[]
所有地点的库存数汇总。
[]
Example: 99
inventory_tracker boolean
[]
表示是否启用对该商品库存的跟踪。

true：启用追踪。

false：不启用追踪。

默认值：false
[]
Example: true
option1 string
[]
该款式对应的第一个选项的值。
[]
Example: Red
option2 string
[]
该款式对应的第二个选项的值。
[]
Example: L
option3 string
[]
该款式对应的第三个选项的值。
option4 string
[]
该款式对应的第四个选项的值。
option5 string
[]
该款式对应的第五个选项的值。
position integer
[]
款式的位置权重。
[]
Example: 1
price string
[]
变体的销售价格，价格数值保留到小数点后两位。
[]
Example: 90
product_id string
[]
对应的商品ID。
[]
Example: 16057850264845250791280282
required_shipping boolean
[]
表明是否需要运输。

true：需要运输。

false：不需要运输。

默认值： true
[]
Example: true
sku string
[]
SKU（库存单位）是特定商品变体的唯一标识符，如尺寸、颜色或型号。
[]
Example: S000000001
taxable boolean
[]
表明是否需要收税。

true：需要收税。

false：不需要收税。

默认值： true
title string
[]
款式标题。
[]
Example: Red/L
weight string
[]
变体的重量要求大于0，超过两位小数时向上取整。
[]
Example: 0.23
weight_unit string
[]
变体的重量的测量单位，如果未指定 weight_unit，则默认为 g。有效的枚举值包含：

g：表示单位为克。

kg：表示单位为千克。

lb：表述单位为磅。

oz：表示单位为盎司。

zh_kg：表示单位为公斤。

[]
Example: kg
vendor string
[]
厂商。
[]
Example: SHOPLINE

API Explorer

调试台

示例代码

Base URL

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

ParamOptions

Authorization — header required

collection_id — query

created_at_max — query

created_at_min — query

fields — query

handle — query

ids — query

limit — query

order_by — query

page_info — query

product_category — query

since_id — query

status — query

title — query

updated_at_max — query

updated_at_min — query

vendor — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/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'

Examples

指定PageInfo

Response

{
  "products": [
    {
      "body_html": "<p>This is a desription</p>",
      "created_at": "2023-08-28T11:50:47+08:00",
      "handle": "my-product-19",
      "id": "16060878902926560859813144",
      "image": {
        "alt": "This is a alt",
        "id": "5976632123224980485",
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
      },
      "images": [
        {
          "alt": "This is a alt",
          "id": "5976632123224980485",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
        }
      ],
      "options": [
        {
          "id": "16160878902931594024693144",
          "name": "Color",
          "product_id": "16060878902926560859813144",
          "values": [
            "White"
          ],
          "values_images": {}
        }
      ],
      "product_behavior": "",
      "product_category": "Clothes",
      "product_type": "NORMAL",
      "published_at": "2023-08-28T11:50:47+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 19",
      "updated_at": "2023-08-28T19:23:56+08:00",
      "variants": [
        {
          "barcode": "T00000001",
          "compare_at_price": "120.00",
          "id": "18060878902931594024673144",
          "image": {
            "alt": "This is a alt",
            "id": "5976632123224980485",
            "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
          },
          "inventory_item_id": "6087890295139080241",
          "inventory_policy": "continue",
          "inventory_quantity": 580,
          "inventory_tracker": true,
          "option1": "White",
          "position": 1,
          "price": "100.00",
          "product_id": "16060878902926560859813144",
          "required_shipping": true,
          "sku": "S00000000101",
          "taxable": true,
          "title": "White",
          "weight": "10.00",
          "weight_unit": "g"
        }
      ],
      "vendor": "Shopline"
    },
    {
      "body_html": "<p>This is a desription</p>",
      "created_at": "2023-08-28T11:50:32+08:00",
      "handle": "my-product-18",
      "id": "16060878900384309254383144",
      "image": {
        "alt": "My Product 17",
        "id": "5976632123224980485",
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
      },
      "images": [
        {
          "alt": "My Product 17",
          "id": "5976632123224980485",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
        }
      ],
      "options": [],
      "product_behavior": "",
      "product_category": "服装",
      "product_type": "NORMAL",
      "published_at": "2023-08-28T11:50:32+08:00",
      "published_scope": "web",
      "spu": "S0000001",
      "status": "active",
      "subtitle": "This is a subtitle",
      "tags": "T shirt",
      "template_path": "templates/products/detail.html",
      "title": "My Product 18",
      "updated_at": "2023-08-28T11:50:32+08:00",
      "variants": [
        {
          "barcode": "B0000001",
          "compare_at_price": "120.00",
          "id": "18060878900387832469803144",
          "inventory_item_id": "6087890040041533931",
          "inventory_policy": "deny",
          "inventory_quantity": 222,
          "inventory_tracker": true,
          "position": 1,
          "price": "100.00",
          "product_id": "16060878900384309254383144",
          "required_shipping": true,
          "sku": "T0000001",
          "taxable": true,
          "weight": "50.00",
          "weight_unit": "g"
        }
      ],
      "vendor": "Shopline"
    },
    {
      "body_html": "<p>This is a desription</p>",
      "created_at": "2023-08-28T11:49:48+08:00",
      "handle": "my-product-17",
      "id": "16060878893067429883503144",
      "image": {
        "alt": "My Product 17",
        "id": "5976632123224980485",
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
      },
      "images": [
        {
          "alt": "My Product 17",
          "id": "5976632123224980485",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
        }
      ],
      "options": [],
      "product_behavior": "",
      "product_category": "服装",
      "product_type": "NORMAL",
      "published_at": "2023-08-28T11:49:48+08:00",
      "published_scope": "web",
      "spu": "S0000001",
      "status": "draft",
      "subtitle": "This is a subtitle",
      "tags": "T shirt",
      "template_path": "templates/products/detail.html",
      "title": "My Product 17",
      "updated_at": "2023-08-28T11:49:48+08:00",
      "variants": [
        {
          "barcode": "B0000001",
          "compare_at_price": "120.00",
          "id": "18060878893070953099003144",
          "inventory_item_id": "6087889308152263615",
          "inventory_policy": "deny",
          "inventory_quantity": 222,
          "inventory_tracker": true,
          "position": 1,
          "price": "100.00",
          "product_id": "16060878893067429883503144",
          "required_shipping": true,
          "sku": "T0000001",
          "taxable": true,
          "weight": "50.00",
          "weight_unit": "g"
        }
      ],
      "vendor": "Shopline"
    },
    {
      "body_html": "<p>This is a desription</p>",
      "created_at": "2023-08-28T11:46:30+08:00",
      "handle": "my-product-16",
      "id": "16060878859910114569133144",
      "image": {
        "alt": "This is a alt",
        "id": "5976632123224980485",
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
      },
      "images": [
        {
          "alt": "This is a alt",
          "id": "5976632123224980485",
          "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
        }
      ],
      "options": [
        {
          "id": "16160878859913134468093144",
          "name": "Color",
          "product_id": "16060878859910114569133144",
          "values": [
            "White"
          ],
          "values_images": {}
        }
      ],
      "product_behavior": "",
      "product_category": "Clothes",
      "product_type": "NORMAL",
      "published_at": "2023-08-28T11:46:31+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 16",
      "updated_at": "2023-08-28T19:23:28+08:00",
      "variants": [
        {
          "barcode": "T00000001",
          "compare_at_price": "120.00",
          "id": "18060878859913134468073144",
          "image": {
            "alt": "This is a alt",
            "id": "5976632123224980485",
            "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
          },
          "inventory_item_id": "6087885992420710729",
          "inventory_policy": "continue",
          "inventory_quantity": 580,
          "inventory_tracker": true,
          "option1": "White",
          "position": 1,
          "price": "100.00",
          "product_id": "16060878859910114569133144",
          "required_shipping": true,
          "sku": "S00000000101",
          "taxable": true,
          "title": "White",
          "weight": "10.00",
          "weight_unit": "g"
        }
      ],
      "vendor": "Shopline"
    },
    {
      "body_html": "<p>This is a desription</p>",
      "created_at": "2023-08-28T11:45:53+08:00",
      "handle": "my-product-15",
      "id": "16060878853599197112313144",
      "image": {
        "alt": "This is a alt",
        "id": "5976632123224980485",
        "src": "https://img-va.myshopline.com/image/store/2001026666/1653474941510/c4845f8f7cd84ff18f082eaf9c05b820.webp?w=1024&h=1024"
      },
      "images": [
        {
          "alt": "This is a alt",
          "id": "5976632123224980485",
          "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_behavior": "",
      "product_category": "Clothes",
      "product_type": "NORMAL",
      "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 a alt",
            "id": "5976632123224980485",
            "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",
          "position": 1,
          "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",
            "id": "5976632123224980485",
            "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",
          "position": 2,
          "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",
            "id": "5976632123224980485",
            "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",
          "position": 3,
          "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

条款协议

Error loading component.