Collection Details

🔒

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:

  1. Fetch comprehensive details of a collection for display or management purposes.
  2. 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 NameTypeRequiredParameter LocationParameter ValueDescription
Access-TokenStringYesHeaderBx-_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-TypeStringYesHeaderapplication
/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 NameTypeMandatoryParameter LocationExample ValueDescription
errorStringNoResponse 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" }.
errorsArrayNoResponse Body{ "errors"["No Context"] }A list of errors that occurred during the request processing. Example: { "errors": [ "No Context" ] }.
Request-IdStringYesHeaderBx-_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

FieldTypeRequiredExampleDescription
idstringYesa60fe556-43ad
-4e07-9125-507ac1bf71f7
Unique identifier of the collection. Must be a valid UUID.

Response Explanation

Successful Response

FieldTypeExampleDescription
collection.idstringa60fe556-43ad-4e07-9125-507ac1bf71f7Unique identifier of the collection.
collection.titlestringTest-CollectionName of the collection.
collection.descriptionstringDescDescription of the collection.
collection.handlestringtest-collectionURL-friendly handle for the collection.
collection.smartbooleanfalseIndicates whether the collection is smart.
collection.imageobjectImage ObjectObject containing details of the collection image.
collection.image.srcstring//cdn.shoplazza.com/loading.pngSource URL of the collection image.
collection.image.widthinteger100Width of the collection image in pixels.
collection.image.heightinteger100Height of the collection image in pixels.
collection.image.altstring""Alt text for the collection image.
collection.image.pathstringloading.pngFile path of the collection image.
collection.seo_titlestringseo_titleSEO title of the collection.
collection.seo_descriptionstringDescSEO description of the collection.
collection.seo_keywordsstringtestSEO keywords associated with the collection.
collection.sort_orderstringtitle-ascMerchandise 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_atstring2024-04-16T10:31:12ZTimestamp when the collection was created.
collection.updated_atstring2024-04-16T10:31:12ZTimestamp 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.

FieldTypeExampleDescription
errorsArray[ "Collection not found"]A list of errors encountered during the request processing.
FieldTypeExampleDescription
errorArray "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 CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized
404Collection Not FoundThe Collection ID provided in the request does not exist.{ "errors": ["Collection not found"] }
422Invalid or empty collection_idmissing required collection_id or collection_id with incorrect UUID types{ "errors": [ "productId has an invalid UUID"]}
Path Params
string
required

Collection's ID

Responses

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json