AppCreateDiscount
POST
/apps/discounts
const url = 'https://your-store.myciqra.com/apps/discounts';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"bundleGroupA":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"bundleGroupB":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"buyQuantity":1,"code":"example","competesWithSetMarkdowns":false,"currency":"example","customerCompanyIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"customerEligibility":"Everyone","customerSegmentIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"customerTags":["example"],"endsAt":"2026-04-15T12:00:00Z","excludeOnSale":false,"excludedCategoryIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"excludedCollectionIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"excludedProductIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"firstOrderOnly":false,"freeShippingCountries":["example"],"freeShippingMaxRate":1,"getQuantity":1,"giftProductId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","isActive":true,"isCombinable":true,"kind":"Standard","minSpend":1,"name":"example","perCustomerLimit":1,"percentOffRegularPrice":false,"previewOnProductPages":false,"priority":1,"quantityBreaks":[{"minQuantity":1,"value":1}],"refundAtRegularOnPartialReturn":false,"scope":"EntireCart","startsAt":"2026-04-15T12:00:00Z","targetIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"tiers":[{"minSubtotal":1,"value":1}],"type":"Percentage","usageLimit":1,"value":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://your-store.myciqra.com/apps/discounts \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "bundleGroupA": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "bundleGroupB": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "buyQuantity": 1, "code": "example", "competesWithSetMarkdowns": false, "currency": "example", "customerCompanyIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "customerEligibility": "Everyone", "customerSegmentIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "customerTags": [ "example" ], "endsAt": "2026-04-15T12:00:00Z", "excludeOnSale": false, "excludedCategoryIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "excludedCollectionIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "excludedProductIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "firstOrderOnly": false, "freeShippingCountries": [ "example" ], "freeShippingMaxRate": 1, "getQuantity": 1, "giftProductId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "isActive": true, "isCombinable": true, "kind": "Standard", "minSpend": 1, "name": "example", "perCustomerLimit": 1, "percentOffRegularPrice": false, "previewOnProductPages": false, "priority": 1, "quantityBreaks": [ { "minQuantity": 1, "value": 1 } ], "refundAtRegularOnPartialReturn": false, "scope": "EntireCart", "startsAt": "2026-04-15T12:00:00Z", "targetIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "tiers": [ { "minSubtotal": 1, "value": 1 } ], "type": "Percentage", "usageLimit": 1, "value": 1 }'Required scope: write_discounts — an installation token without it receives 403.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
bundleGroupA
Array<string> | null
bundleGroupB
Array<string> | null
buyQuantity
required
null | integer | string format: int32
code
required
null | string
competesWithSetMarkdowns
boolean
currency
required
null | string
customerCompanyIds
Array<string> | null
customerEligibility
customerSegmentIds
Array<string> | null
customerTags
Array<string> | null
endsAt
required
null | string format: date-time
excludeOnSale
boolean
excludedCategoryIds
Array<string> | null
excludedCollectionIds
Array<string> | null
excludedProductIds
Array<string> | null
firstOrderOnly
boolean
freeShippingCountries
Array<string> | null
freeShippingMaxRate
null | number | string format: double
getQuantity
required
null | integer | string format: int32
giftProductId
required
null | string format: uuid
isActive
required
boolean
isCombinable
required
boolean
kind
required
minSpend
required
null | number | string format: double
name
required
string
perCustomerLimit
required
null | integer | string format: int32
percentOffRegularPrice
boolean
previewOnProductPages
boolean
priority
required
integer | string format: int32
quantityBreaks
Array<object> | null
object
minQuantity
required
integer | string format: int32
value
required
number | string format: double
refundAtRegularOnPartialReturn
boolean
scope
required
startsAt
required
null | string format: date-time
targetIds
required
Array<string>
tiers
required
Array<object>
object
minSubtotal
required
number | string format: double
value
required
number | string format: double
type
required
usageLimit
required
null | integer | string format: int32
value
required
number | string format: double
Responses
Section titled “Responses”Created
Media typeapplication/json
object
bundleGroupA
required
Array<string>
bundleGroupB
required
Array<string>
buyQuantity
required
null | integer | string format: int32
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
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
name
required
string
perCustomerLimit
required
null | integer | string format: int32
percentOffRegularPrice
required
boolean
previewOnProductPages
required
boolean
priority
required
integer | string format: int32
quantityBreaks
required
Array<object>
object
minQuantity
required
integer | string format: int32
value
required
number | string format: double
redemptionCount
required
integer | string format: int32
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
value
required
number | string format: double
type
required
string
usageLimit
required
null | integer | string format: int32
value
required
number | string format: double
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}Unprocessable Entity
Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
request_id
required
string
scope
required
null | string
errors
required
object
key
additional properties
string
Examplegenerated
{ "error": { "code": "example", "message": "example", "request_id": "example", "scope": "example" }, "errors": { "additionalProperty": "example" }}