API Reference
Product Groups
Product variant management
List product groups
Query Parameters
q?string
brand_id?string
category_id?string
product_type_id?string
limit?number
Default
20Range
1 <= value <= 100cursor?string
Cursor for pagination
sort?string
Default
"name"include_products?|
format?string
Response format: json (full), schemaorg (structured data), ai (token-efficient for agents)
Default
"json"Value in
"json" | "schemaorg" | "ai"Response Body
application/json
curl -X GET "https://api.covala.com/v2/product-groups"{
"success": true,
"data": [
{
"id": "string",
"name": "string",
"slug": "string",
"description": "string",
"base_model": "string",
"series_name": "string",
"variant_dimensions": [
"string"
],
"original_msrp": 0,
"current_market_value": 0,
"product_status": "string",
"brand_id": "string",
"category_id": "string",
"product_type_id": "string",
"brand": {
"id": "string",
"name": "string",
"slug": "string",
"logo_url": "string",
"website_url": "string",
"created_at": "string"
},
"category": {
"id": "string",
"name": "string",
"description": "string",
"icon": "string",
"is_featured": true,
"parent_id": "string"
},
"product_type": {
"id": "string",
"name": "string",
"slug": "string",
"subcategory_id": "string",
"is_active": true,
"level": 0,
"path": "string"
},
"variant_count": 0,
"products": [
null
]
}
],
"meta": {
"requestId": "string",
"timestamp": "string",
"responseTime": 0,
"version": "string",
"cached": true
},
"pagination": {
"total": 0,
"limit": 0,
"offset": 0,
"page": 0,
"cursor": "string",
"hasMore": true,
"nextCursor": "string",
"prevCursor": "string"
}
}Get product group by ID
Path Parameters
id*string
Format
uuidQuery Parameters
include_offers?|
Include retailer offers for each variant
format?string
Response format: json (full), schemaorg (structured data), ai (token-efficient for agents)
Default
"json"Value in
"json" | "schemaorg" | "ai"Response Body
application/json
application/json
curl -X GET "https://api.covala.com/v2/product-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"success": true,
"data": {
"id": "string",
"name": "string",
"slug": "string",
"description": "string",
"base_model": "string",
"series_name": "string",
"variant_dimensions": [
"string"
],
"original_msrp": 0,
"current_market_value": 0,
"product_status": "string",
"brand_id": "string",
"category_id": "string",
"product_type_id": "string",
"brand": {
"id": "string",
"name": "string",
"slug": "string",
"logo_url": "string",
"website_url": "string",
"created_at": "string"
},
"category": {
"id": "string",
"name": "string",
"description": "string",
"icon": "string",
"is_featured": true,
"parent_id": "string"
},
"product_type": {
"id": "string",
"name": "string",
"slug": "string",
"subcategory_id": "string",
"is_active": true,
"level": 0,
"path": "string"
},
"variant_count": 0,
"products": [
null
]
},
"meta": {
"requestId": "string",
"timestamp": "string",
"responseTime": 0,
"version": "string",
"cached": true
}
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"userMessage": "string",
"details": null,
"retryable": true,
"retryAfter": 0
},
"meta": {
"requestId": "string",
"timestamp": "string",
"responseTime": 0,
"version": "string",
"cached": true
}
}