Collection Details

GET 
/openapi/2022-01/collections/:id

Retrieves detailed information about a specific collection by providing its unique identifier.

Request

Path Parameters

id stringrequired

Collection's ID

Responses

200

200

application/json

Schema

Schema

collection object
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

{
  "collection": {
    "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

{
    "collection": {
        "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"
    }
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Collection not found"
  ]
}

Result

{
  "errors": [
    "Collection not found"
  ]
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "collectionId has an invalid UUID"
  ]
}

Result

{
  "errors": [
    "collectionId has an invalid UUID"
  ]
}