> ## Documentation Index
> Fetch the complete documentation index at: https://docs.covver.io/llms.txt
> Use this file to discover all available pages before exploring further.
# List a Collection Products
> List a collection products by collection ID
export const item_0 = "product"
## Localization (optional)
Use the accept-language header to get translated {item_0} strings.
Supported locales:
* en-US (default locale)
* fr-FR
* fr-CA
* es-ES
* es-MX
* en-AU
* en-GB
```
Examples:
- Accept-Language: *
- Accept-Language: fr
- Accept-Language: fr-FR
- Accept-Language: fr-FR, fr;q=0.9, en;q=0.8, *;q=0.5
```
## Statuses
Multiple statuses can be sent as comma separated values
For a personalized collection, poll this API with the same data until `status !== 'Pending'` (\~20 seconds)
## OpenAPI
````yaml get /api/ext/v1/collection/{collectionId}/products
openapi: 3.0.1
info:
title: Covver External API docs
description: Covver External API docs
version: 0.1.0
servers:
- url: https://staging-api.covver.io
description: Covver Staging Server
- url: https://api.covver.io
description: Covver Production Server
- url: http://localhost:8080
description: Covver Local Server
security:
- BearerAuth: []
tags:
- name: Auth
description: Authentication endpoints
- name: Products
description: Product endpoints
- name: People
description: People endpoints
- name: Orders
description: Orders endpoints
- name: Reports
description: Report endpoints
externalDocs:
url: https://swagger.io
description: Find more info here
paths:
/api/ext/v1/collection/{collectionId}/products:
get:
tags:
- Products
summary: List a Collection Products
description: List a collection products by collection ID
parameters:
- schema:
type: string
in: query
name: countryCode
required: false
- schema:
enum:
- priceHighToLow
- priceLowToHigh
- alphabeticalAToZ
- alphabeticalZToA
in: query
name: sort
required: false
- schema:
type: string
in: query
name: status
required: false
- schema:
type: string
nullable: true
in: query
name: firstName
required: false
description: First name
- schema:
type: string
nullable: true
in: query
name: lastName
required: false
description: Last name
- schema:
type: string
nullable: true
in: query
name: department
required: false
description: Work department (e.g. sales)
- schema:
type: string
nullable: true
in: query
name: location
required: false
description: Work location (site/city/country)
- schema:
format: date-time
type: string
nullable: true
in: query
name: startDate
required: false
description: Start date in ISO format
- schema:
format: date-time
type: string
nullable: true
in: query
name: birthDate
required: false
description: Birth date in ISO format
- schema:
format: uuid
type: string
in: path
name: collectionId
required: true
- schema:
type: string
in: header
name: accept-language
required: false
description: >-
See
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language
responses:
'200':
description: Default Response
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
isPersonalized:
type: boolean
creationStatus:
enum:
- Pending
- Done
- Error
data:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
description:
type: string
priceRange:
type: object
properties:
minVariantPrice:
type: number
maxVariantPrice:
type: number
required:
- minVariantPrice
- maxVariantPrice
retailPriceRange:
type: object
properties:
minVariantPrice:
type: number
maxVariantPrice:
type: number
required:
- minVariantPrice
- maxVariantPrice
options:
type: array
items:
type: object
properties:
name:
enum:
- size
- color
values:
type: array
items:
type: object
properties:
title:
type: string
colorCode:
type: string
colorCode2:
type: string
required:
- title
required:
- name
- values
isInStock:
type: boolean
isDiscontinued:
type: boolean
featuredImage:
type: object
properties:
url:
type: string
lowResUrl:
type: string
nullable: true
width:
type: number
height:
type: number
required:
- url
errors:
type: object
properties:
hasLowResolutionElements:
type: boolean
hasNonCmykElements:
type: boolean
hasBaseProductIssue:
type: boolean
hasNonBlackAndWhiteElements:
type: boolean
isBlank:
type: boolean
hasOldPrintAreas:
type: boolean
nullable: true
isPersonalized:
default: false
type: boolean
nullable: true
status:
enum:
- Active
- Draft
notes:
type: string
nullable: true
customFields:
type: object
additionalProperties:
type: string
required:
- id
- title
- description
- priceRange
- options
- isInStock
- isDiscontinued
- featuredImage
- status
collection:
additionalProperties: false
type: object
properties:
id:
type: string
deletedAt:
format: date-time
type: string
description: ISO 8601 date-time, e.g. 2025-07-10T07:24:53.486Z
nullable: true
status:
enum:
- Active
- Pending
- Draft
- Disabled
slug:
type: string
title:
type: string
description:
type: string
image:
type: string
nullable: true
imageMobile:
type: string
nullable: true
rewardType:
enum:
- Coins
- Gifts
personalizationsUsed:
type: array
items:
type: string
required:
- id
- status
- slug
- title
- description
- rewardType
count:
type: number
required:
- isPersonalized
- creationStatus
- data
- collection
- count
4XX:
description: Default Response
content:
application/json:
schema:
type: object
properties:
message:
type: string
errorCode:
type: string
error: {}
statusCode:
type: number
required:
- message
- errorCode
- statusCode
5XX:
description: Default Response
content:
application/json:
schema:
type: object
properties:
message:
type: string
errorCode:
type: string
error: {}
statusCode:
type: number
required:
- message
- errorCode
- statusCode
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
````