跳到主要内容

专辑

Collection API 可用于获取指定 collection id 的 collection 商品或 filters。

所有 Ajax API 请求应使用多语言 URL,以便为访客提供一致的体验。

获取专辑商品列表

GET /{locale}/api/collections/{collection_id}/products

分页获取专辑下的商品。

请求示例

请求示例
fetch(window.SHOPLAZZA.routes.root + '/api/collections/8bc2047d-bf57-4c91-b207-e3480f79800d/products?page=0&limit=5')
.then((response) => response.json())
.then((data) => {
// do something...
});

请求参数

    collection_idstring

    专辑的 id。

    pagenumber

    返回第几页商品。

    limitnumber

    每页返回的商品数。

响应

    data object

    响应数据主体。

    products object[]

    商品列表。

  • Array [
  • idstring

    商品 ID。

    titlestring

    商品名称。

    briefstring

    商品的简要描述。

    vendorstring

    商品的供应商。

    vendor_urlstring

    商品供应商的链接。

    has_only_default_variantboolean

    商品是否只有默认款式。

    requires_shippingboolean

    是否需要物流配送。

    taxableboolean

    是否需要计税。

    inventory_policystring

    商品缺货时是否继续销售。

    inventory_quantitynumber

    库存数量。

    inventory_trackingboolean

    是否启用库存追踪。

    publishedboolean

    资源是否已发布。

    handlestring

    用于资源链接的 handle(URL 友好别名)。

    spustring

    商品的 SPU(标准产品单元)。

    notestring

    对象上的备注。

    need_variant_imageboolean

    款式是否必须单独配图。

    fake_salesnumber

    商品的虚拟销量。

    display_fake_salesboolean

    是否在前台展示虚拟销量。

    independent_seoboolean

    是否独立管理 SEO 设置。

    created_atstring

    创建时间(ISO-8601 格式)。

    updated_atstring

    最后更新时间(ISO-8601 格式)。

    tagsstring

    对象上的标签。

    availableboolean

    是否可购买。

    price_minstring

    款式中的最低价格,以店铺主货币单位表示。

    price_maxstring

    款式中的最高价格,以店铺主货币单位表示。

    pricestring

    商品价格,以店铺主货币单位表示。

    compare_at_pricestring

    划线价。

    compare_at_price_minstring

    款式中的最低划线价。

    compare_at_price_maxstring

    款式中的最高划线价。

    urlstring

    商品页的相对地址。

    published_atstring

    发布时间(ISO-8601 格式)。

    salesnumber

    销量。

    image object

    商品的第一张图片。

    srcstring

    图片的地址。

    widthnumber

    图片宽度(像素)。

    heightnumber

    图片高度(像素)。

    altstring

    图片的替代文本。

    pathstring

    图片文件在图床上的路径。

    aspect_rationumber

    图片宽度除以高度得到的宽高比。

    meta_titlestring

    页面元信息中的 SEO 标题。

    meta_descriptionstring

    页面元信息中的 SEO 描述。

    meta_keywordstring

    页面元信息中的 SEO 关键词。

    options object[]

    商品的属性,例如颜色、尺码。

  • Array [
  • idstring

    商品属性的 ID。

    namestring

    商品属性名称,例如 Color

    positionnumber

    属性的排序位置。

    valuesstring[]

    商品属性的可选值列表。

  • ]
  • variants object[]

    商品的款式列表。

  • Array [
  • idstring

    款式 ID。

    titlestring

    款式标题,由各属性取值用 - 连接而成。

    weight_unitstring

    重量单位,例如 kg

    inventory_quantitynumber

    库存数量。

    skustring

    款式的 SKU,用于库存管理。

    barcodestring

    款式的条形码。

    positionnumber

    在列表中的排序位置。

    option1string

    该款式在第一个商品属性上的取值。

    option2string

    该款式在第二个商品属性上的取值。

    option3string

    该款式在第三个商品属性上的取值。

    notestring

    对象上的备注。

    image object

    款式关联的图片。

    srcstring

    图片的地址。

    widthnumber

    图片宽度(像素)。

    heightnumber

    图片高度(像素)。

    altstring

    图片的替代文本。

    pathstring

    图片文件在图床上的路径。

    aspect_rationumber

    图片宽度除以高度得到的宽高比。

    weightstring

    款式的重量。

    compare_at_pricestring

    划线价。

    pricestring

    款式价格,以店铺主货币单位表示。

    availableboolean

    是否可购买。

    available_quantitynumber

    仍可购买的数量。

    options object[]

    该款式在各商品属性上的取值。

  • Array [
  • namestring

    商品属性名称,例如 Color

    valuestring

    该商品属性被选中的取值。

  • ]
  • urlstring

    选中该款式的商品页相对地址。

    off_rationumber

    当前适用的折扣比率。

    flashsale_infoundefined[]

    商品的闪购活动信息。

    salesnumber

    销量。

    wholesale_price object[]

    批发价梯度列表。

  • Array [
  • pricestring

    该批发价梯度的单价。

    min_quantitynumber

    该批发价梯度要求的最小数量。

  • ]
  • retail_pricestring

    以店铺主货币单位表示的零售价。

  • ]
  • variants_countnumber
    images object[]

    商品图片列表。

  • Array [
  • srcstring

    图片的地址。

    widthnumber

    图片宽度(像素)。

    heightnumber

    图片高度(像素)。

    altstring

    图片的替代文本。

    pathstring

    图片文件在图床上的路径。

    aspect_rationumber

    图片宽度除以高度得到的宽高比。

  • ]
  • flashsale_infoundefined[]

    商品的闪购活动信息。

    off_rationumber

    当前适用的折扣比率。

    price_variesboolean

    商品的各款式价格是否不同。

    ifbstring
    cfbstring
    sspstring
    scmstring
    mixed_wholesaleboolean

    是否支持混批。

    retail_pricestring

    以店铺主货币单位表示的零售价。

    retail_price_minstring

    款式中的最低零售价。

    retail_price_maxstring

    款式中的最高零售价。

    min_price_variant object

    价格最低的款式。

    idstring

    款式 ID。

    titlestring

    款式标题,由各属性取值用 - 连接而成。

    weight_unitstring

    重量单位,例如 kg

    inventory_quantitynumber

    库存数量。

    skustring

    款式的 SKU,用于库存管理。

    barcodestring

    款式的条形码。

    positionnumber

    在列表中的排序位置。

    option1string

    该款式在第一个商品属性上的取值。

    option2string

    该款式在第二个商品属性上的取值。

    option3string

    该款式在第三个商品属性上的取值。

    notestring

    对象上的备注。

    imagestring可空

    款式关联的图片。

    weightstring

    款式的重量。

    compare_at_pricestring

    划线价。

    pricestring

    款式价格,以店铺主货币单位表示。

    availableboolean

    是否可购买。

    available_quantitynumber

    仍可购买的数量。

    options object[]

    该款式在各商品属性上的取值。

  • Array [
  • namestring

    商品属性名称,例如 Color

    valuestring

    该商品属性被选中的取值。

  • ]
  • urlstring

    选中该款式的商品页相对地址。

    off_rationumber

    当前适用的折扣比率。

    flashsale_infoundefined[]

    商品的闪购活动信息。

    salesnumber

    销量。

    wholesale_price object[]

    批发价梯度列表。

  • Array [
  • pricestring

    该批发价梯度的单价。

    min_quantitynumber

    该批发价梯度要求的最小数量。

  • ]
  • retail_pricestring

    以店铺主货币单位表示的零售价。

    product_typestring

    商品类型。

    descriptionstring

    商品描述。

    comment_avg_starnumber

    商品评价的平均星级。

    comment_countnumber

    商品的顾客评价数量。

  • ]
  • has_morenumber

    是否还有更多记录。

    pagenumber

    当前页码。

    limitnumber

    每页最多返回的记录数。

    products_countnumber

    匹配到的商品总数。

    countnumber

    返回的商品数量。

    comment_enabledboolean

    是否开启了顾客评价。

    msgstring

    响应返回的结果说明。

    statenumber

    请求结果标识,success0 表示请求成功。

筛选专辑商品

GET /{locale}/api/collections/{collection_id}/cps

以下示例请求特定 collection 的商品:

curl
GET /{locale}/api/collections/{collection_id}/cps?page=0&limit=8

请求示例

Example request using Fetch
fetch(window.SHOPLAZZA.routes.root + '/api/collections/8bc2047d-bf57-4c91-b207-e3480f79800d/cps?page=0&limit=8')
.then((response) => response.json())
.then((data) => {
// do something...
});

请求参数

    pagenumber

    结果的基于 0 的页码。

    limitnumber

    限制结果数量。

    [filter.filter_scope.attribute]string

    请参阅店面筛选。也接受 [filter.filter_scope.attribute.attribute_scope] 写法。

响应

    data object

    响应数据主体。

    products object[]

    商品列表。

  • Array [
  • idstring

    商品 ID。

    titlestring

    商品名称。

    briefstring

    商品的简要描述。

    vendorstring

    商品的供应商。

    vendor_urlstring

    商品供应商的链接。

    has_only_default_variantboolean

    商品是否只有默认款式。

    requires_shippingboolean

    是否需要物流配送。

    taxableboolean

    是否需要计税。

    inventory_policystring

    商品缺货时是否继续销售。

    inventory_quantitynumber

    库存数量。

    inventory_trackingboolean

    是否启用库存追踪。

    publishedboolean

    资源是否已发布。

    handlestring

    用于资源链接的 handle(URL 友好别名)。

    spustring

    商品的 SPU(标准产品单元)。

    notestring

    对象上的备注。

    need_variant_imageboolean

    款式是否必须单独配图。

    fake_salesnumber

    商品的虚拟销量。

    display_fake_salesboolean

    是否在前台展示虚拟销量。

    independent_seoboolean

    是否独立管理 SEO 设置。

    created_atstring

    创建时间(ISO-8601 格式)。

    updated_atstring

    最后更新时间(ISO-8601 格式)。

    tagsstring

    对象上的标签。

    availableboolean

    是否可购买。

    price_minstring

    款式中的最低价格,以店铺主货币单位表示。

    price_maxstring

    款式中的最高价格,以店铺主货币单位表示。

    pricestring

    商品价格,以店铺主货币单位表示。

    compare_at_pricestring

    划线价。

    compare_at_price_minstring

    款式中的最低划线价。

    compare_at_price_maxstring

    款式中的最高划线价。

    urlstring

    商品页的相对地址。

    published_atstring

    发布时间(ISO-8601 格式)。

    salesnumber

    销量。

    image object

    商品的第一张图片。

    srcstring

    图片的地址。

    widthnumber

    图片宽度(像素)。

    heightnumber

    图片高度(像素)。

    altstring

    图片的替代文本。

    pathstring

    图片文件在图床上的路径。

    aspect_rationumber

    图片宽度除以高度得到的宽高比。

    meta_titlestring

    页面元信息中的 SEO 标题。

    meta_descriptionstring

    页面元信息中的 SEO 描述。

    meta_keywordstring

    页面元信息中的 SEO 关键词。

    options object[]

    商品的属性,例如颜色、尺码。

  • Array [
  • idstring

    商品属性的 ID。

    namestring

    商品属性名称,例如 Color

    positionnumber

    属性的排序位置。

    valuesstring[]

    商品属性的可选值列表。

  • ]
  • variants object[]

    商品的款式列表。

  • Array [
  • idstring

    款式 ID。

    titlestring

    款式标题,由各属性取值用 - 连接而成。

    weight_unitstring

    重量单位,例如 kg

    inventory_quantitynumber

    库存数量。

    skustring

    款式的 SKU,用于库存管理。

    barcodestring

    款式的条形码。

    positionnumber

    在列表中的排序位置。

    option1string

    该款式在第一个商品属性上的取值。

    option2string

    该款式在第二个商品属性上的取值。

    option3string

    该款式在第三个商品属性上的取值。

    notestring

    对象上的备注。

    image object

    款式关联的图片。

    srcstring

    图片的地址。

    widthnumber

    图片宽度(像素)。

    heightnumber

    图片高度(像素)。

    altstring

    图片的替代文本。

    pathstring

    图片文件在图床上的路径。

    aspect_rationumber

    图片宽度除以高度得到的宽高比。

    weightstring

    款式的重量。

    compare_at_pricestring

    划线价。

    pricestring

    款式价格,以店铺主货币单位表示。

    availableboolean

    是否可购买。

    available_quantitynumber

    仍可购买的数量。

    options object[]

    该款式在各商品属性上的取值。

  • Array [
  • namestring

    商品属性名称,例如 Color

    valuestring

    该商品属性被选中的取值。

  • ]
  • urlstring

    选中该款式的商品页相对地址。

    off_rationumber

    当前适用的折扣比率。

    flashsale_infoundefined[]

    商品的闪购活动信息。

    salesnumber

    销量。

    wholesale_price object[]

    批发价梯度列表。

  • Array [
  • pricestring

    该批发价梯度的单价。

    min_quantitynumber

    该批发价梯度要求的最小数量。

  • ]
  • retail_pricestring

    以店铺主货币单位表示的零售价。

  • ]
  • variants_countnumber
    images object[]

    商品图片列表。

  • Array [
  • srcstring

    图片的地址。

    widthnumber

    图片宽度(像素)。

    heightnumber

    图片高度(像素)。

    altstring

    图片的替代文本。

    pathstring

    图片文件在图床上的路径。

    aspect_rationumber

    图片宽度除以高度得到的宽高比。

  • ]
  • flashsale_infoundefined[]

    商品的闪购活动信息。

    off_rationumber

    当前适用的折扣比率。

    price_variesboolean

    商品的各款式价格是否不同。

    ifbstring
    cfbstring
    sspstring
    scmstring
    mixed_wholesaleboolean

    是否支持混批。

    retail_pricestring

    以店铺主货币单位表示的零售价。

    retail_price_minstring

    款式中的最低零售价。

    retail_price_maxstring

    款式中的最高零售价。

    min_price_variant object

    价格最低的款式。

    idstring

    款式 ID。

    titlestring

    款式标题,由各属性取值用 - 连接而成。

    weight_unitstring

    重量单位,例如 kg

    inventory_quantitynumber

    库存数量。

    skustring

    款式的 SKU,用于库存管理。

    barcodestring

    款式的条形码。

    positionnumber

    在列表中的排序位置。

    option1string

    该款式在第一个商品属性上的取值。

    option2string

    该款式在第二个商品属性上的取值。

    option3string

    该款式在第三个商品属性上的取值。

    notestring

    对象上的备注。

    imagestring可空

    款式关联的图片。

    weightstring

    款式的重量。

    compare_at_pricestring

    划线价。

    pricestring

    款式价格,以店铺主货币单位表示。

    availableboolean

    是否可购买。

    available_quantitynumber

    仍可购买的数量。

    options object[]

    该款式在各商品属性上的取值。

  • Array [
  • namestring

    商品属性名称,例如 Color

    valuestring

    该商品属性被选中的取值。

  • ]
  • urlstring

    选中该款式的商品页相对地址。

    off_rationumber

    当前适用的折扣比率。

    flashsale_infoundefined[]

    商品的闪购活动信息。

    salesnumber

    销量。

    wholesale_price object[]

    批发价梯度列表。

  • Array [
  • pricestring

    该批发价梯度的单价。

    min_quantitynumber

    该批发价梯度要求的最小数量。

  • ]
  • retail_pricestring

    以店铺主货币单位表示的零售价。

    product_typestring

    商品类型。

    descriptionstring

    商品描述。

    comment_avg_starnumber

    商品评价的平均星级。

    comment_countnumber

    商品的顾客评价数量。

  • ]
  • has_morenumber

    是否还有更多记录。

    pagenumber

    当前页码。

    limitnumber

    每页最多返回的记录数。

    products_countnumber

    匹配到的商品总数。

    countnumber

    返回的商品数量。

    comment_enabledboolean

    是否开启了顾客评价。

    msgstring

    响应返回的结果说明。

    statenumber

    请求结果标识,success0 表示请求成功。

获取专辑的筛选项

GET /{locale}/api/collections/{collection_id}/filters

请求示例

以下示例请求特定 collection 的 filters:

Example request using Fetch
fetch(window.SHOPLAZZA.routes.root + '/api/collections/8bc2047d-bf57-4c91-b207-e3480f79800d/filters')
.then((response) => response.json())
.then((data) => {
// do something...
});

请求参数

    collection_idstring

    专辑 ID。

响应

    data object[]

    响应数据主体。

  • Array [
  • labelstring

    筛选项的名称,例如 pricevendor

    param_namestring

    该筛选项使用的 URL 参数。

    typestring

    筛选项类型,例如 listprice_range

    range_minnumber

    price_range 类型筛选项的最小可选值。

    range_maxnumber

    price_range 类型筛选项的最大可选值。

    values object[]

    筛选项的可选值列表。

  • Array [
  • param_namestring

    该筛选项使用的 URL 参数。

    labelstring

    展示给顾客的筛选值标签。

    valuestring

    筛选值。

    activeboolean

    该筛选值当前是否已应用。

    countnumber

    符合该筛选值的商品数量。

  • ]
  • active_valuesstring可空

    当前已应用的筛选值。

    inactive_values object[]

    当前未应用的筛选值。

  • Array [
  • param_namestring

    该筛选项使用的 URL 参数。

    labelstring

    展示给顾客的筛选值标签。

    valuestring

    筛选值。

    activeboolean

    该筛选值当前是否已应用。

    countnumber

    符合该筛选值的商品数量。

  • ]
  • max_valuestring可空

    price_range 类型筛选项的上界。

    min_valuestring可空

    price_range 类型筛选项的下界。

  • ]
  • msgstring

    响应返回的结果说明。

    statenumber

    请求结果标识,success0 表示请求成功。