Skip to main content

Retrieve coupon by id

Retrieve coupon by id

Authorizations:Token
Query Parameters
id
required
integerId value of the Coupon object

Responses

200Success
Response schema:
Success
vendor
allVendorsboolean
idintegerProduct unique ID
codestringCode
enabledbooleanEnabled status
valuestringValue
typestringType
commentstringComment
usesintegerUses count
dateRangeBeginintegerDate range (begin)
dateRangeEndintegerDate range (end)
totalRangeBeginstringTotal range (begin)
totalRangeEndstringTotal range (end)
usesLimitintegerUses limit
usesLimitPerUserintegerUses limit per user
singleUsebooleanFlag: Can a coupon be used together with other coupons (false) or no (true)
productClassesArrayProduct classes
membershipsArrayMemberships
usedCouponsArrayUsed coupons
categoriesArrayCategories