> ## 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 Orders
> List all orders by collection ID
Date range filter is inclusive of both start and end dates and only filters via the day and not the time of day
Partners must pass in the companyId field in the body
## OpenAPI
````yaml post /api/ext/v1/collection/{collectionId}/orders/get
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}/orders/get:
post:
tags:
- Orders
summary: List Orders
description: List all orders by collection ID
parameters:
- schema:
format: uuid
type: string
in: path
name: collectionId
required: true
requestBody:
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
companyId:
description: Required for partners
type: string
filter:
type: object
properties:
userIds:
minItems: 1
type: array
items:
format: uuid
type: string
dateRange:
type: object
properties:
start:
format: date-time
type: string
description: ISO 8601 date-time, e.g. 2025-07-10T07:24:53.486Z
end:
format: date-time
type: string
description: ISO 8601 date-time, e.g. 2025-07-10T07:24:53.486Z
required:
- start
- end
required:
- filter
required: true
responses:
'200':
description: Default Response
content:
application/json:
schema:
additionalProperties: false
type: object
properties:
data:
type: array
items:
additionalProperties: false
type: object
properties:
id:
type: string
createdAt:
format: date-time
type: string
description: ISO 8601 date-time, e.g. 2025-07-10T07:24:53.486Z
nullable: true
orderNumber:
type: string
nullable: true
externalId:
type: string
nullable: true
user:
type: object
properties:
externalId:
type: string
nullable: true
email:
type: string
nullable: true
orderLineItems:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
quantity:
type: number
price:
type: number
retailPrice:
type: number
nullable: true
productTitle:
type: string
variantTitle:
type: string
productId:
type: string
variantId:
type: string
image:
type: object
properties:
url:
type: string
nullable: true
aspectRatio:
type: number
required:
- url
personalizations:
type: object
properties:
name:
type: object
properties:
first:
type: string
nullable: true
last:
type: string
nullable: true
firstNameInitials:
type: string
lastNameInitials:
type: string
initials:
type: string
firstPossessive:
type: string
nullable: true
anniversary:
type: object
properties:
month:
type: number
monthPadded:
type: string
year:
type: number
decade:
type: string
years:
type: number
yearsPadded:
type: string
hundreds:
type: string
zodiac:
enum:
- Capricorn
- Aquarius
- Pisces
- Aries
- Taurus
- Gemini
- Cancer
- Leo
- Virgo
- Libra
- Scorpio
- Sagittarius
ordinal:
type: string
elapsed:
type: string
elapsedYears:
type: string
birth:
type: object
properties:
month:
type: number
monthPadded:
type: string
year:
type: number
decade:
type: string
years:
type: number
yearsPadded:
type: string
hundreds:
type: string
zodiac:
enum:
- Capricorn
- Aquarius
- Pisces
- Aries
- Taurus
- Gemini
- Cancer
- Leo
- Virgo
- Libra
- Scorpio
- Sagittarius
ordinal:
type: string
elapsed:
type: string
elapsedYears:
type: string
work:
type: object
properties:
department:
type: string
nullable: true
location:
type: string
nullable: true
required:
- name
- anniversary
- birth
- work
nullable: true
sha:
type: string
nullable: true
required:
- id
- title
- quantity
- price
- retailPrice
- productTitle
- variantTitle
- productId
- variantId
- image
required:
- id
- orderLineItems
count:
type: number
required:
- data
- 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
````