collection

A collection in a store.

PropertiesTypeDescription
default_sort_bystringThe default sort order of the collection. This is set on the collection's page in the Shoplazza admin.
descriptionstringThe description of the collection.
filtersAn array of filterThe storefront filters that have been set up on the collection. Only filters relevant to the current collection are returned.
handlestringThe handle of the collection.
idstringThe ID of the collection.
imageimageThe image for the collection. This image is added to the collection's page in the Shoplazza admin.
metafieldsAn array of metafieldThe metafields applied to the collection.
origin_tagsAn array of stringThese are the tags for all products, case-sensitive.
productsAn array of productAll of the products in the collection.
products_countnumberThe total number of products in a collection.
published_atstringA timestamp for when the collection was published.
tagsAn array of stringThese are the tags for all products, in lowercase.
titlestringThe title of the collection.
urlstringThe relative URL of the collection.
{
  "default_sort_by": "manual",
  "description": "<p>All Collections</p>",
  "filters": [
  	{
      "label": "availability",
      "param_name": "filter.v.availability",
      "type": "list",
      "range_min": 0,
      "range_max": 0,
      "values": [
        {
          "param_name": "filter.v.availability",
          "label": "1",
          "value": "1",
          "active": false,
          "count": 137
        },
        {
          "param_name": "filter.v.availability",
          "label": "0",
          "value": "0",
          "active": false,
          "count": 4
        }
      ],
      "active_values": null,
      "inactive_values": [
        {
          "param_name": "filter.v.availability",
          "label": "1",
          "value": "1",
          "active": false,
          "count": 137
        },
        {
          "param_name": "filter.v.availability",
          "label": "0",
          "value": "0",
          "active": false,
          "count": 4
        }
      ],
      "max_value": null,
      "min_value": null
    },
    {
      "label": "vendor",
      "param_name": "filter.p.vendor",
      "type": "list",
      "range_min": 0,
      "range_max": 0,
      "values": [
        {
          "param_name": "filter.p.vendor",
          "label": "apple",
          "value": "apple",
          "active": false,
          "count": 4
        },
        {
          "param_name": "filter.p.vendor",
          "label": "nero",
          "value": "nero",
          "active": false,
          "count": 100
        },
        {
          "param_name": "filter.p.vendor",
          "label": "nero theme fashion",
          "value": "nero theme fashion",
          "active": false,
          "count": 26
        },
        {
          "param_name": "filter.p.vendor",
          "label": "nero theme fashion ck",
          "value": "nero theme fashion ck",
          "active": false,
          "count": 4
        },
        {
          "param_name": "filter.p.vendor",
          "label": "shoplazza",
          "value": "shoplazza",
          "active": false,
          "count": 6
        }
      ],
      "active_values": null,
      "inactive_values": [
        {
          "param_name": "filter.p.vendor",
          "label": "apple",
          "value": "apple",
          "active": false,
          "count": 4
        },
        {
          "param_name": "filter.p.vendor",
          "label": "nero",
          "value": "nero",
          "active": false,
          "count": 100
        },
        {
          "param_name": "filter.p.vendor",
          "label": "nero theme fashion",
          "value": "nero theme fashion",
          "active": false,
          "count": 26
        },
        {
          "param_name": "filter.p.vendor",
          "label": "nero theme fashion ck",
          "value": "nero theme fashion ck",
          "active": false,
          "count": 4
        },
        {
          "param_name": "filter.p.vendor",
          "label": "shoplazza",
          "value": "shoplazza",
          "active": false,
          "count": 6
        }
      ],
      "max_value": null,
      "min_value": null
    }
  ],
  "handle": "all-collections",
  "id": "275cefa9-db7e-4192-99be-0748b45f1a4a",
  "image": {
    "src": "\/\/cdn.shoplazza.com\/003efe88f1b9f7708bca610e7325a3e4.jpg",
    "path": "003efe88f1b9f7708bca610e7325a3e4.jpg",
    "width": 3024,
    "height": 4032,
    "alt": "",
    "aspect_ratio": 0.75
  },
  "metafields": [],
  "origin_tags": [
    "Color_Black",
    "Color_Red",
    "Price_$100-$200 Price_$200-$300",
    "air",
    "earphones",
    "flash_sale_2019-12-30",
    "headphone"
  ],
  "products": [
  	{"id":"8fd435f3-53c7-4f7f-9cb9-a2defcfc8e82","title":"Multiple Variants Spencer Chelsea","brief":"","vendor":"Nero Theme Fashion","vendor_url":"","has_only_default_variant":false,"requires_shipping":true,"taxable":false,"published":true,"handle":"multiple-variants-spencer-chelsea","spu":"","need_variant_image":true,"updated_at":"2023-06-16T01:31:17Z","created_at":"2022-11-19T04:59:12Z","mixed_wholesale":false,"min_price_variant":{"id":"dc6d3751-17c6-4158-90cd-2ae29dbac0ca","title":"DarkGoldenrod-43-China","weight_unit":"kg","inventory_quantity":90,"sku":"MGF19FF0064S06-3","barcode":"","position":3,"option1":"DarkGoldenrod","option2":"43","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/a965136834f1dfc117ece9a1075f4942.jpeg","path":"a965136834f1dfc117ece9a1075f4942.jpeg","width":1280,"height":1710,"alt":""},"wholesale_price":[{"price":492,"min_quantity":1}],"weight":"0","compare_at_price":"668","price":"492","retail_price":"668","available":true,"url":"\/products\/multiple-variants-spencer-chelsea?variant=dc6d3751-17c6-4158-90cd-2ae29dbac0ca","available_quantity":90,"options":[{"name":"Color","value":"DarkGoldenrod"},{"name":"Size","value":"43"},{"name":"Ships From","value":"China"}],"off_ratio":26},"tags":"Color_Black,Color_Peru,flash_sale_2020-2-30,Location_New York,Price_$400-$500,FlashDeal01","available":true,"price_min":"492","price":"492","price_max":"4958","compare_at_price_min":"0","compare_at_price":"668","compare_at_price_max":"5288","retail_price_min":"0","retail_price_max":"5288","url":"\/products\/multiple-variants-spencer-chelsea","published_at":"2022-11-19T04:59:12Z","image":{"src":"\/\/cdn.shoplazza.com\/9c15032f7dd262295a2a5b497feb2969.jpeg?&media_type=video&vID=7246c87805d2e4a12bb5ae5d6eea494f&duration=30.70&mp4=https:\/\/videodelivery.net\/7246c87805d2e4a12bb5ae5d6eea494f\/downloads\/default.mp4&hls=https:\/\/videodelivery.net\/7246c87805d2e4a12bb5ae5d6eea494f\/manifest\/video.m3u8","path":"9c15032f7dd262295a2a5b497feb2969.jpeg?&media_type=video&vID=7246c87805d2e4a12bb5ae5d6eea494f&duration=30.70&mp4=https:\/\/videodelivery.net\/7246c87805d2e4a12bb5ae5d6eea494f\/downloads\/default.mp4&hls=https:\/\/videodelivery.net\/7246c87805d2e4a12bb5ae5d6eea494f\/manifest\/video.m3u8","width":1920,"height":1080,"alt":"","aspect_ratio":1.7777777777777777},"options":[{"id":"aad1cab0-2ec2-4ad4-b6d3-f5994d23c2d2","name":"Color","position":1,"values":["DarkGoldenrod","Black"]},{"id":"5921ef7f-95c5-4eb3-92ba-b12ab3006dc8","name":"Size","position":2,"values":["41","42","43","44","45","46"]},{"id":"1ef6155a-bdd1-4374-842a-dfedb44f5c55","name":"Ships From","position":3,"values":["China"]}],"variants":[{"id":"93e625eb-7bf0-428e-9f65-1c40cc08efac","title":"DarkGoldenrod-41-China","weight_unit":"kg","inventory_quantity":0,"sku":"MGF19FF0064S06-1","barcode":"","position":1,"option1":"DarkGoldenrod","option2":"41","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/a965136834f1dfc117ece9a1075f4942.jpeg","path":"a965136834f1dfc117ece9a1075f4942.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":4958,"min_quantity":1}],"weight":"0","compare_at_price":"5288","price":"4958","retail_price":"5288","available":false,"url":"\/products\/multiple-variants-spencer-chelsea?variant=93e625eb-7bf0-428e-9f65-1c40cc08efac","available_quantity":0,"options":[{"name":"Color","value":"DarkGoldenrod"},{"name":"Size","value":"41"},{"name":"Ships From","value":"China"}],"off_ratio":6,"flashsale_info":[],"sales":null},{"id":"e1fd3735-b732-4941-8476-a090318091ad","title":"DarkGoldenrod-42-China","weight_unit":"kg","inventory_quantity":0,"sku":"MGF19FF0064S06-2","barcode":"","position":2,"option1":"DarkGoldenrod","option2":"42","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/1438026920ac48b60bfd267062ab8d5c.jpeg","path":"1438026920ac48b60bfd267062ab8d5c.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":495,"min_quantity":1}],"weight":"0","compare_at_price":"688","price":"495","retail_price":"688","available":false,"url":"\/products\/multiple-variants-spencer-chelsea?variant=e1fd3735-b732-4941-8476-a090318091ad","available_quantity":0,"options":[{"name":"Color","value":"DarkGoldenrod"},{"name":"Size","value":"42"},{"name":"Ships From","value":"China"}],"off_ratio":28,"flashsale_info":[],"sales":null},{"id":"dc6d3751-17c6-4158-90cd-2ae29dbac0ca","title":"DarkGoldenrod-43-China","weight_unit":"kg","inventory_quantity":90,"sku":"MGF19FF0064S06-3","barcode":"","position":3,"option1":"DarkGoldenrod","option2":"43","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/a965136834f1dfc117ece9a1075f4942.jpeg","path":"a965136834f1dfc117ece9a1075f4942.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":492,"min_quantity":1}],"weight":"0","compare_at_price":"668","price":"492","retail_price":"668","available":true,"url":"\/products\/multiple-variants-spencer-chelsea?variant=dc6d3751-17c6-4158-90cd-2ae29dbac0ca","available_quantity":90,"options":[{"name":"Color","value":"DarkGoldenrod"},{"name":"Size","value":"43"},{"name":"Ships From","value":"China"}],"off_ratio":26,"flashsale_info":[],"sales":null},{"id":"64a1ca57-1c9e-43cd-ad06-4339e86a02a0","title":"DarkGoldenrod-44-China","weight_unit":"kg","inventory_quantity":90,"sku":"MGF19FF0064S06-4","barcode":"","position":4,"option1":"DarkGoldenrod","option2":"44","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/29ad5013acb0576f83357dc04acb7c11.jpeg","path":"29ad5013acb0576f83357dc04acb7c11.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":495,"min_quantity":1}],"weight":"0","compare_at_price":"0","price":"495","retail_price":"0","available":true,"url":"\/products\/multiple-variants-spencer-chelsea?variant=64a1ca57-1c9e-43cd-ad06-4339e86a02a0","available_quantity":90,"options":[{"name":"Color","value":"DarkGoldenrod"},{"name":"Size","value":"44"},{"name":"Ships From","value":"China"}],"off_ratio":0,"flashsale_info":[],"sales":null},{"id":"f70fa9ea-df8c-41ab-802e-0fa377f8e347","title":"DarkGoldenrod-45-China","weight_unit":"kg","inventory_quantity":90,"sku":"MGF19FF0064S06-5","barcode":"","position":5,"option1":"DarkGoldenrod","option2":"45","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/42d0984027f57f734a513577c43fed06.jpeg","path":"42d0984027f57f734a513577c43fed06.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":495,"min_quantity":1}],"weight":"0","compare_at_price":"0","price":"495","retail_price":"0","available":true,"url":"\/products\/multiple-variants-spencer-chelsea?variant=f70fa9ea-df8c-41ab-802e-0fa377f8e347","available_quantity":90,"options":[{"name":"Color","value":"DarkGoldenrod"},{"name":"Size","value":"45"},{"name":"Ships From","value":"China"}],"off_ratio":0,"flashsale_info":[],"sales":null},{"id":"b64e35f0-bc74-455c-86f3-ecb78a5eec65","title":"DarkGoldenrod-46-China","weight_unit":"kg","inventory_quantity":90,"sku":"MGF19FF0064S06-6","barcode":"","position":6,"option1":"DarkGoldenrod","option2":"46","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/9b201e5179839bdc0504526b8c9d8ab8.jpeg","path":"9b201e5179839bdc0504526b8c9d8ab8.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":495,"min_quantity":1}],"weight":"0","compare_at_price":"0","price":"495","retail_price":"0","available":true,"url":"\/products\/multiple-variants-spencer-chelsea?variant=b64e35f0-bc74-455c-86f3-ecb78a5eec65","available_quantity":90,"options":[{"name":"Color","value":"DarkGoldenrod"},{"name":"Size","value":"46"},{"name":"Ships From","value":"China"}],"off_ratio":0,"flashsale_info":[],"sales":null},{"id":"da00ae58-b2bb-4655-bcfc-708dbd7526ce","title":"Black-41-China","weight_unit":"kg","inventory_quantity":90,"sku":"MGF19FF0064S06-7","barcode":"","position":7,"option1":"Black","option2":"41","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/5ad063e3285bbb049eebfbd0ca1ecda6.jpeg","path":"5ad063e3285bbb049eebfbd0ca1ecda6.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":498,"min_quantity":1}],"weight":"0","compare_at_price":"0","price":"498","retail_price":"0","available":true,"url":"\/products\/multiple-variants-spencer-chelsea?variant=da00ae58-b2bb-4655-bcfc-708dbd7526ce","available_quantity":90,"options":[{"name":"Color","value":"Black"},{"name":"Size","value":"41"},{"name":"Ships From","value":"China"}],"off_ratio":0,"flashsale_info":[],"sales":null},{"id":"4ec4933b-b89b-4334-9a0d-51f713058002","title":"Black-42-China","weight_unit":"kg","inventory_quantity":90,"sku":"MGF19FF0064S06-8","barcode":"","position":8,"option1":"Black","option2":"42","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/ff0cf1823205d1da8cb414a6b1f4e59d.jpeg","path":"ff0cf1823205d1da8cb414a6b1f4e59d.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":495,"min_quantity":1}],"weight":"0","compare_at_price":"0","price":"495","retail_price":"0","available":true,"url":"\/products\/multiple-variants-spencer-chelsea?variant=4ec4933b-b89b-4334-9a0d-51f713058002","available_quantity":90,"options":[{"name":"Color","value":"Black"},{"name":"Size","value":"42"},{"name":"Ships From","value":"China"}],"off_ratio":0,"flashsale_info":[],"sales":null},{"id":"387e8916-e884-4eac-b816-ecb5c7db757e","title":"Black-43-China","weight_unit":"kg","inventory_quantity":90,"sku":"MGF19FF0064S06-9","barcode":"","position":9,"option1":"Black","option2":"43","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/f6b4bb96579de077fbcee9ece771c3d2.jpeg","path":"f6b4bb96579de077fbcee9ece771c3d2.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":495,"min_quantity":1}],"weight":"0","compare_at_price":"0","price":"495","retail_price":"0","available":true,"url":"\/products\/multiple-variants-spencer-chelsea?variant=387e8916-e884-4eac-b816-ecb5c7db757e","available_quantity":90,"options":[{"name":"Color","value":"Black"},{"name":"Size","value":"43"},{"name":"Ships From","value":"China"}],"off_ratio":0,"flashsale_info":[],"sales":null},{"id":"06f78dd1-d4ef-4ae6-b42a-1b02ded395f4","title":"Black-44-China","weight_unit":"kg","inventory_quantity":0,"sku":"MGF19FF0064S06-10","barcode":"","position":10,"option1":"Black","option2":"44","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/c06d976c8b5ca1abca91a953fe6d6b4e.jpeg","path":"c06d976c8b5ca1abca91a953fe6d6b4e.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":495,"min_quantity":1}],"weight":"0","compare_at_price":"0","price":"495","retail_price":"0","available":false,"url":"\/products\/multiple-variants-spencer-chelsea?variant=06f78dd1-d4ef-4ae6-b42a-1b02ded395f4","available_quantity":0,"options":[{"name":"Color","value":"Black"},{"name":"Size","value":"44"},{"name":"Ships From","value":"China"}],"off_ratio":0,"flashsale_info":[],"sales":null},{"id":"3e8ca956-8ae1-4b20-bbfc-b47fdef4a444","title":"Black-45-China","weight_unit":"kg","inventory_quantity":90,"sku":"MGF19FF0064S06-11","barcode":"","position":11,"option1":"Black","option2":"45","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/5ad063e3285bbb049eebfbd0ca1ecda6.jpeg","path":"5ad063e3285bbb049eebfbd0ca1ecda6.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":495,"min_quantity":1}],"weight":"0","compare_at_price":"0","price":"495","retail_price":"0","available":true,"url":"\/products\/multiple-variants-spencer-chelsea?variant=3e8ca956-8ae1-4b20-bbfc-b47fdef4a444","available_quantity":90,"options":[{"name":"Color","value":"Black"},{"name":"Size","value":"45"},{"name":"Ships From","value":"China"}],"off_ratio":0,"flashsale_info":[],"sales":null},{"id":"55625152-cca0-44f4-823b-21e519ac767a","title":"Black-46-China","weight_unit":"kg","inventory_quantity":90,"sku":"MGF19FF0064S06-12","barcode":"","position":12,"option1":"Black","option2":"46","option3":"China","image":{"src":"\/\/cdn.shoplazza.com\/ff0cf1823205d1da8cb414a6b1f4e59d.jpeg","path":"ff0cf1823205d1da8cb414a6b1f4e59d.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},"wholesale_price":[{"price":495,"min_quantity":1}],"weight":"0","compare_at_price":"0","price":"495","retail_price":"0","available":true,"url":"\/products\/multiple-variants-spencer-chelsea?variant=55625152-cca0-44f4-823b-21e519ac767a","available_quantity":90,"options":[{"name":"Color","value":"Black"},{"name":"Size","value":"46"},{"name":"Ships From","value":"China"}],"off_ratio":0,"flashsale_info":[],"sales":null}],"images":[{"src":"\/\/cdn.shoplazza.com\/9c15032f7dd262295a2a5b497feb2969.jpeg?&media_type=video&vID=7246c87805d2e4a12bb5ae5d6eea494f&duration=30.70&mp4=https:\/\/videodelivery.net\/7246c87805d2e4a12bb5ae5d6eea494f\/downloads\/default.mp4&hls=https:\/\/videodelivery.net\/7246c87805d2e4a12bb5ae5d6eea494f\/manifest\/video.m3u8","path":"9c15032f7dd262295a2a5b497feb2969.jpeg?&media_type=video&vID=7246c87805d2e4a12bb5ae5d6eea494f&duration=30.70&mp4=https:\/\/videodelivery.net\/7246c87805d2e4a12bb5ae5d6eea494f\/downloads\/default.mp4&hls=https:\/\/videodelivery.net\/7246c87805d2e4a12bb5ae5d6eea494f\/manifest\/video.m3u8","width":1920,"height":1080,"alt":"","aspect_ratio":1.7777777777777777},{"src":"\/\/cdn.shoplazza.com\/2fc412cf6d4aa67eb560b615aea972a21686877786133.png?media_type=model3d&sources=https:\/\/model3d.shoplazza.com\/558f35716f6af953f9bb5d75f6d77e6a1686877787287.glb","path":"2fc412cf6d4aa67eb560b615aea972a21686877786133.png?media_type=model3d&sources=https:\/\/model3d.shoplazza.com\/558f35716f6af953f9bb5d75f6d77e6a1686877787287.glb","width":1200,"height":1000,"alt":"","aspect_ratio":1.2},{"src":"\/\/cdn.shoplazza.com\/1af35e88f4be62831cdfbbbe86704824.jpeg","path":"1af35e88f4be62831cdfbbbe86704824.jpeg","width":542,"height":1086,"alt":"","aspect_ratio":0.4990791896869245},{"src":"\/\/cdn.shoplazza.com\/697fa1558163da478e04b50f50f95cff.jpeg","path":"697fa1558163da478e04b50f50f95cff.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},{"src":"\/\/cdn.shoplazza.com\/1438026920ac48b60bfd267062ab8d5c.jpeg","path":"1438026920ac48b60bfd267062ab8d5c.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},{"src":"\/\/cdn.shoplazza.com\/a965136834f1dfc117ece9a1075f4942.jpeg","path":"a965136834f1dfc117ece9a1075f4942.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},{"src":"\/\/cdn.shoplazza.com\/29ad5013acb0576f83357dc04acb7c11.jpeg","path":"29ad5013acb0576f83357dc04acb7c11.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},{"src":"\/\/cdn.shoplazza.com\/42d0984027f57f734a513577c43fed06.jpeg","path":"42d0984027f57f734a513577c43fed06.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},{"src":"\/\/cdn.shoplazza.com\/9b201e5179839bdc0504526b8c9d8ab8.jpeg","path":"9b201e5179839bdc0504526b8c9d8ab8.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064},{"src":"\/\/cdn.shoplazza.com\/5ad063e3285bbb049eebfbd0ca1ecda6.jpeg","path":"5ad063e3285bbb049eebfbd0ca1ecda6.jpeg","width":1280,"height":1710,"alt":"","aspect_ratio":0.7485380116959064}],"retail_price":"668","off_ratio":26,"price_varies":false}
  ], 
  "products_count": 141,
  "published_at": "2022-01-20T01:02:05Z",
  "tags": [
    "color_black",
    "color_red",
    "price_$100-$200 price_$200-$300",
    "air",
    "earphones",
    "flash_sale_2019-12-30",
    "headphone"
  ],
  "title": "All Collections",
  "url": "/collections/all-collections"
}