Requires
read_collection
access scope. More access scope
The Get Collection Detail API retrieves detailed information about a specific collection by providing its unique identifier. The identifier must be a valid UUID to avoid errors.This API is especially useful for:
- Fetch comprehensive details of a collection for display or management purposes.
- Retrieve specific metadata and settings for a collection.
Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.
Public Request Parameters
Parameter Name | Type | Required | Parameter Location | Parameter Value | Description |
---|---|---|---|---|---|
Access-Token | String | Yes | Header | Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA | Used to authenticate API requests. Obtain an access token from the Access Token Guide. Pass it in the Authorization header for every request. |
Content-Type | String | Yes | Header | application /json | Indicates the media type of the request body. It tells the server how to parse the request and the client how to interpret the response. For more details, visit Content-Type. |
Public Response Parameters
Parameter Name | Type | Mandatory | Parameter Location | Example Value | Description |
---|---|---|---|---|---|
error | String | No | Response Body | { "error": "store is not active" } | Indicates an error encountered during the process. This field typically appears when the Access Token is missing or invalid. Example: { "error": "store is not active" } . |
errors | Array | No | Response Body | { "errors"["No Context"] } | A list of errors that occurred during the request processing. Example: { "errors": [ "No Context" ] } . |
Request-Id | String | Yes | Header | Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA | A unique identifier for each request. It helps in identifying and debugging specific requests. |
Error and Errors Clarification:
Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.
Request Parameters
Path Parameters
Field | Type | Required | Example | Description |
---|---|---|---|---|
id | string | Yes | a60fe556-43ad -4e07-9125-507ac1bf71f7 | Unique identifier of the collection. Must be a valid UUID. |
Response Explanation
Successful Response
Field | Type | Example | Description |
---|---|---|---|
collection.id | string | a60fe556-43ad-4e07-9125-507ac1bf71f7 | Unique identifier of the collection. |
collection.title | string | Test-Collection | Name of the collection. |
collection.description | string | Desc | Description of the collection. |
collection.handle | string | test-collection | URL-friendly handle for the collection. |
collection.smart | boolean | false | Indicates whether the collection is smart. |
collection.image | object | Image Object | Object containing details of the collection image. |
collection.image.src | string | //cdn.shoplazza.com/loading.png | Source URL of the collection image. |
collection.image.width | integer | 100 | Width of the collection image in pixels. |
collection.image.height | integer | 100 | Height of the collection image in pixels. |
collection.image.alt | string | "" | Alt text for the collection image. |
collection.image.path | string | loading.png | File path of the collection image. |
collection.seo_title | string | seo_title | SEO title of the collection. |
collection.seo_description | string | Desc | SEO description of the collection. |
collection.seo_keywords | string | test | SEO keywords associated with the collection. |
collection.sort_order | string | title-asc | Merchandise sorting rules. Options include: manual (default), sales-desc , price-asc , price-desc , views-desc , vendor-asc , vendor-desc , created-desc , and more. (see Sort Order Options). |
collection.created_at | string | 2024-04-16T10:31:12Z | Timestamp when the collection was created. |
collection.updated_at | string | 2024-04-16T10:31:12Z | Timestamp when the collection was last updated. |
error Response
Error responses in the API can be represented using two different fields: errors
and error
. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field | Type | Example | Description |
---|---|---|---|
errors | Array | [ "Collection not found"] | A list of errors encountered during the request processing. |
Field | Type | Example | Description |
---|---|---|---|
error | Array | "store is not active" | Indicates an error encountered during the process. |
Request Examples
curl --request GET \
--url https://<shopdomain>.myshoplazza.com/openapi/2022-01/collections/{id} \
--header 'accept: application/json' \
--header 'access-token: <access-token>'
Success Response Example
{
"collection": {
"id": "a60fe556-43ad-4e07-9125-507ac1bf71f7",
"title": "Test-Collection",
"description": "Desc",
"handle": "test-collection",
"smart": false,
"image": {
"src": "//cdn.shoplazza.com/loading.png",
"width": 100,
"height": 100,
"alt": "",
"path": "loading.png"
},
"seo_title": "seo_title",
"seo_description": "Desc",
"seo_keywords": "test",
"sort_order": "title-asc",
"created_at": "2024-04-16T10:31:12Z",
"updated_at": "2024-04-16T10:31:12Z"
}
}
Error Response Example
{
"errors": [
"Collection not found"
]
}
{
"error": "store is not active"
}
Error Details
Status Code | Message | Possible Reason | Example Response |
---|---|---|---|
400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
404 | Collection Not Found | The Collection ID provided in the request does not exist. | { "errors": ["Collection not found"] } |
422 | Invalid or empty collection_id | missing required collection_id or collection_id with incorrect UUID types | { "errors": [ "productId has an invalid UUID"]} |