Skip to content

AppGetDiscount

GET
/apps/discounts/{id}
curl --request GET \
--url https://your-store.myciqra.com/apps/discounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

Required scope: read_discounts — an installation token without it receives 403.

id
required
string format: uuid

OK

Media typeapplication/json
object
bundleGroupA
required
Array<string>
bundleGroupB
required
Array<string>
buyQuantity
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
code
required
null | string
competesWithSetMarkdowns
required
boolean
currency
required
null | string
endsAt
required
null | string format: date-time
excludeOnSale
required
boolean
getQuantity
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
giftProductId
required
null | string format: uuid
id
required
string format: uuid
isActive
required
boolean
isCombinable
required
boolean
kind
required
string
minSpend
required
null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
name
required
string
perCustomerLimit
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
percentOffRegularPrice
required
boolean
previewOnProductPages
required
boolean
priority
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
quantityBreaks
required
Array<object>
object
minQuantity
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
value
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
redemptionCount
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
refundAtRegularOnPartialReturn
required
boolean
scope
required
string
startsAt
required
null | string format: date-time
targetIds
required
Array<string>
tiers
required
Array<object>
object
minSubtotal
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
value
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
type
required
string
usageLimit
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
value
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
Examplegenerated
{
"bundleGroupA": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
],
"bundleGroupB": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
],
"buyQuantity": 1,
"code": "example",
"competesWithSetMarkdowns": true,
"currency": "example",
"endsAt": "2026-04-15T12:00:00Z",
"excludeOnSale": true,
"getQuantity": 1,
"giftProductId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"isActive": true,
"isCombinable": true,
"kind": "example",
"minSpend": 1,
"name": "example",
"perCustomerLimit": 1,
"percentOffRegularPrice": true,
"previewOnProductPages": true,
"priority": 1,
"quantityBreaks": [
{
"minQuantity": 1,
"value": 1
}
],
"redemptionCount": 1,
"refundAtRegularOnPartialReturn": true,
"scope": "example",
"startsAt": "2026-04-15T12:00:00Z",
"targetIds": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
],
"tiers": [
{
"minSubtotal": 1,
"value": 1
}
],
"type": "example",
"usageLimit": 1,
"value": 1
}

Not Found