Skip to content

AppCreateCouponBatch

POST
/apps/discounts/batches
curl --request POST \
--url https://your-store.myciqra.com/apps/discounts/batches \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "codePrefix": "example", "count": 1, "template": { "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.

Media typeapplication/json
object
codePrefix
required
null | string
count
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
template
required
object
bundleGroupA
Array<string> | null
bundleGroupB
Array<string> | null
buyQuantity
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
code
required
null | string
competesWithSetMarkdowns
boolean
currency
required
null | string
customerCompanyIds
Array<string> | null
customerEligibility
default: Everyone
Allowed values: Everyone CustomerTags B2bCompanies Segments
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
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
getQuantity
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
giftProductId
required
null | string format: uuid
isActive
required
boolean
isCombinable
required
boolean
kind
required
Allowed values: Standard BuyXGetY GiftWithPurchase QuantityBreak Bundle PayAverage
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
boolean
previewOnProductPages
boolean
priority
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
quantityBreaks
Array<object> | null
object
minQuantity
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
value
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
refundAtRegularOnPartialReturn
boolean
scope
required
Allowed values: EntireCart Products Categories Collections
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
Allowed values: Percentage FixedAmount FreeShipping
usageLimit
required
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
value
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/

OK

Media typeapplication/json
object
batchId
required
string format: uuid
count
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
sampleCodes
required
Array<string>
Examplegenerated
{
"batchId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"count": 1,
"sampleCodes": [
"example"
]
}

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"
}
}