List supported deal types
GET /deals/types
GET /deals/types
Operation
GET
/deals/types
Returns the canonical set of values accepted by the deal_type / deal_kind filters on GET /deals, paired with their human-readable labels. Use this to populate dropdowns or validate inputs before calling /deals.
Operation ID:
listDealTypes
·
Tags: Deals
Parameters
This operation does not define any parameters.
Request Body
No request body is defined for this operation.
Responses
Content Types
application/json
{
"description": "Supported deal types",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"enum": [
"free_shipping",
"coupon",
"promotion",
"seasonal_holiday"
]
},
"label": {
"type": "string"
}
},
"required": [
"key",
"label"
]
}
}
},
"required": [
"data"
]
}
}
}
}{
"$ref": "#/components/responses/Unauthorized"
}{
"$ref": "#/components/responses/RateLimited"
}API Playground
Run this GET request with your API key, or open it in a new tab. Path uses sample IDs where the OpenAPI path has {parameters}.
Sign in to enable live testing with your API key.
| Action | Method | Endpoint | Description |
|---|---|---|---|
| List supported deal types | GET |
/api/v1/deals/types |
OpenAPI operationId: listDealTypes. |
GET /api/v1/deals/types
OpenAPI
List supported deal types