🔒

Requires read_collection access scope. More access scope

The Get Collect Detail API retrieves detailed information about a specific collect by its unique identifier (id). This enables users to access and manage relationships between products and collections efficiently.This API is especially useful for:

1. Fetching specific collect details for display or management purposes.
2. Validating the relationship between a product and a collection.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all queries are applied to the correct store.

Public Request Parameters

Public Response Parameters

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

Response Explanation

Successful Response

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.

Request Examples

curl --request GET \
     --url https://{shopdomain}.myshoplazza.com/openapi/2022-01/collects/{id} \
     --header 'accept: application/json' \
     --header 'access-token: {your-access-token}' \
     --header 'content-type: application/json'

Success Response Example

{
  "collect": {
    "id": "dec4897f-2537-44a7-91fb-9854f643ad1e",
    "collection_id": "a60fe556-43ad-4e07-9125-507ac1bf71f7",
    "product_id": "636a07da-39eb-4829-bde9-b65fae1c28b0",
    "position": 1,
    "created_at": "2024-04-16T10:31:13Z",
    "updated_at": "2024-04-16T10:31:13Z"
  }
}

Error Response Example

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

{
  "error": "store is not active"
}

Error Details