Retrieve a single discount
One discount by id — the list entry's attributes plus usage (the flows, campaigns and popups configured with it, ids and names) and statistics (lifetime counters, no date range). Which statistics are present depends on the discount shape and on omitShopifyData — see DiscountStatistics.
get
Authorizations
X-Recart-API-KeystringRequired
It can be obtained in Recart account after contacting Support
Path parameters
idstringRequired
ID of the discount
Query parameters
omitShopifyDatabooleanOptionalDefault:
true (default): no live Shopify call — statistics has sent on code pools and expiring discounts and is empty on general discounts. false: Shopify is called and used, sales and codesCount are added on general discounts and code pools (never on expiring discounts).
trueResponses
200
Ok
application/vnd.api+json
4XX
HTTP Error response
application/vnd.api+json
5XX
HTTP Error response
application/vnd.api+json
get/discounts/{id}
GET /app-integrations/2023-12/discounts/{id} HTTP/1.1
Host: api.recart.com
X-Recart-API-Key: YOUR_API_KEY
Accept: */*
{
"data": {
"type": "discounts",
"attributes": {
"id": "66aa0f1c7e8c9d2b00123abc",
"name": "Welcome 10%",
"status": "active",
"customizationType": "unique",
"expiryType": "fixed",
"type": "basic",
"discountClasses": [
"order"
],
"amount": 10,
"valueType": "PERCENTAGE",
"summary": "10% off entire order",
"discountCodePattern": "WELCOME-",
"mode": "refilling",
"targetCount": 10000,
"availableCount": 8612,
"fillStatus": "full",
"startsAt": "2026-03-01T00:00:00.000Z",
"endsAt": null,
"shopifyDiscountId": "1234567890123",
"usage": {
"flows": [
{
"id": "6138d0ac2d79e00001210035",
"name": "Welcome flow"
}
],
"campaigns": [],
"optinTools": [
{
"id": "64f2a1b2c3d4e5f60718293a",
"name": "Mobile - Welcome popup"
}
]
},
"createdAt": "2026-03-01T09:12:00.000Z",
"updatedAt": "2026-08-14T10:03:11.000Z",
"statistics": {
"sent": 1388,
"used": 212,
"sales": {
"USD": 9418.4
},
"codesCount": 10000
}
}
}
}Last updated
Was this helpful?