Collection List

GET 
/openapi/2022-01/collections

Retrieves a list of collections based on various filter criteria, such as product_id, title, or update timestamps.

Request

Query Parameters

ids string

Collection's IDs, separated by comma. Each ID must be a valid UUID format.for example: 0097cfc8-6ec3-40ed,40ed-ab9f-6f2231b7

title string

The title of the collection. Maximum length: 255 characters.

updated_at_min string

Filter collections updated at or after date. Must follow RFC 3339 date-time format, for example: 2018-10-01T16:15:47-04:00

updated_at_max string

Filter collections updated at or before date. Must follow RFC 3339 date-time format, for example: 2018-10-01T16:15:47-04:00

product_id string

Product's ID. Must be a valid UUID format, for example: 0097cfc8-6ec3-40ed-ab9f-6f2231b705a6

page int32

Page number; Must be greater than or equal to 1. Default value: 1.

limit int32

limit collection result per page; Must be between 1 and 100 (inclusive). Default value: 10.

Responses

200

200

application/json

Schema

Schema

collections object[]
Array [
idstring
Example: a60fe556-43ad-4e07-9125-507ac1bf71f7
titlestring
Example: Test-Collection
descriptionstring
Example: Desc
handlestring
Example: test-collection
smartboolean
Default value: true
Example: false
image object
srcstring
Example: //cdn.shoplazza.com/9de53f9726576696b318a8d95c0946cb.jpeg
widthinteger
Default value: 0
Example: 1920
heightinteger
Default value: 0
Example: 1080
altstring
Example:
pathstring
Example: 9de53f9726576696b318a8d95c0946cb.jpeg
seo_titlestring
Example: seo_title
seo_descriptionstring
Example: Desc
seo_keywordsstring
Example: test
sort_orderstring
Example: title-asc
created_atstring
Example: 2024-04-16T10:31:13Z
updated_atstring
Example: 2024-04-16T10:31:13Z
]

Example

{
  "collections": [
    {
      "id": "a60fe556-43ad-4e07-9125-507ac1bf71f7",
      "title": "Test-Collection",
      "description": "Desc",
      "handle": "test-collection",
      "smart": false,
      "image": {
        "src": "//cdn.shoplazza.com/9de53f9726576696b318a8d95c0946cb.jpeg",
        "width": 1920,
        "height": 1080,
        "alt": "",
        "path": "9de53f9726576696b318a8d95c0946cb.jpeg"
      },
      "seo_title": "seo_title",
      "seo_description": "Desc",
      "seo_keywords": "test",
      "sort_order": "title-asc",
      "created_at": "2024-04-16T10:31:13Z",
      "updated_at": "2024-04-16T10:31:13Z"
    }
  ]
}

Result

{
    "collections": [
        {
            "id": "a60fe556-43ad-4e07-9125-507ac1bf71f7",
            "title": "Test-Collection",
            "description": "Desc",
            "handle": "test-collection",
            "smart": false,
            "image": {
                "src": "//cdn.shoplazza.com/9de53f9726576696b318a8d95c0946cb.jpeg",
                "width": 1920,
                "height": 1080,
                "alt": "",
                "path": "9de53f9726576696b318a8d95c0946cb.jpeg"
            },
            "seo_title": "seo_title",
            "seo_description": "Desc",
            "seo_keywords": "test",
            "sort_order": "title-asc",
            "created_at": "2024-04-16T10:31:13Z",
            "updated_at": "2024-04-16T10:31:13Z"
        }
    ]
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "UpdatedAtMin time format error"
  ]
}

Result

{
  "errors": [
    "UpdatedAtMin time format error"
  ]
}