The
/product/
endpoint retrieves a list of products based on specified criteria. Users can filter the results using query parameters such as search query, pagination, sorting options, and product type.
Method:GET
Query Parameters:
Parameter | Type | Description |
---|---|---|
q (Optional) | string | Search query to filter products. |
page (Optional) | integer | Page number for pagination. Default: 1 |
size (Optional) | integer | Number of products per page. Default: 10 |
sort (Optional) | string | Field to sort by. Default: ‘updatedAt’ |
order (Optional) | string | Sort order (‘asc’ or ‘desc’). Default: ‘desc’ |
artist (Optional) | string | Filter by artist ID(s). Comma-separated for multiple. |
type (Optional) | string | Filter by product type. |
splits (Optional) | boolean | Whether to include splits information. Default: false |
statistics (Optional) | boolean | Whether to include statistical data. Default: false |
Authentication
This endpoint requires authentication. Include your bearer token in the Authorization header.Query Parameters
Parameter | Type | In | Required | Description |
---|---|---|---|---|
q | string | query | ❌ | Search query to filter products |
page | integer | query | ❌ | Page number for pagination |
size | integer | query | ❌ | Number of products per page |
sort | string | query | ❌ | Field to sort by |
order | string | query | ❌ | Sort order (‘asc’ or ‘desc’) |
artist | string | query | ❌ | Filter by artist ID(s). Comma-separated for multiple |
type | string | query | ❌ | Filter by product type |
splits | boolean | query | ❌ | Whether to include splits information |
statistics | boolean | query | ❌ | Whether to include statistical data |
Responses
✅ 200 - Success
⚠️ 401 - Unauthorized
❌ 500 - Internal Server Error
Tags
Product
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Search query to filter products
Page number for pagination
Number of products per page
Field to sort by
Sort order ('asc' or 'desc')
Available options:
asc
, desc
Filter by artist ID(s). Comma-separated for multiple
Filter by product type
Whether to include splits information
Whether to include statistical data