Collect List

GET 
/openapi/2022-01/collects

Retrieves a list of collect objects, representing the associations between products and collections.

Request

Query Parameters

collection_id string

Collection's ID, for example: 0097cfc8-6ec3-40ed

product_id string

Product's ID, for example: 0097cfc8-6ec3-40ed

page int32

Page number

limit string

limit result per page, maximum 250

Responses

200

200

application/json

Schema

Schema

collects object[]
Array [
idstring
Example: dec4897f-2537-44a7-91fb-9854f643ad1e
collection_idstring
Example: a60fe556-43ad-4e07-9125-507ac1bf71f7
product_idstring
Example: 636a07da-39eb-4829-bde9-b65fae1c28b0
positioninteger
Default value: 0
Example: 1
created_atstring
Example: 2024-04-16T10:31:13Z
updated_atstring
Example: 2024-04-16T10:31:13Z
]

Example

{
  "collects": [
    {
      "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"
    }
  ]
}

Result

{
    "collects": [
        {
            "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"
        }
    ]
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "CollectionID must be a valid UUID"
  ]
}

Result

{
  "errors": [
    "CollectionID must be a valid UUID",
    "ProductID must be a valid UUID"
  ]
}