v1
latestOpenAPI 3.0.12026-07-24168217310.4 KBCoupons
Get Coupon By Code
get/Sites/{siteId}/Coupons/ByCode
Path parameters
siteIdinteger required
The site identifier
Query parameters
codestring
The coupon code
Response
Success
idinteger
siteIdinteger
codestring nullable
namestring nullable
countrystring nullable
postcodestring nullable
statestring nullable
citystring nullable
minUnitsinteger nullable
maxUnitsinteger nullable
minWeightnumber double nullable
maxWeightnumber double nullable
weightUnitType'Pound' | 'Ounce' | 'Kilogram' | 'Gram'
cyclesinteger
maxCyclesPerSiteinteger nullable
minSubtotalnumber float nullable
maxSubtotalnumber float nullable
maxCyclesPerCustomerinteger nullable
assignmentsinteger nullable
maxAssignmentsPerCustomerinteger nullable
maxAssignmentsPerSiteinteger nullable
minScheduledOrderCyclesinteger nullable
maxScheduledOrderCyclesinteger nullable
maxCyclesPerScheduledOrderinteger nullable
maxDiscountPerCustomernumber double nullable
lifetimeValuenumber double
amountnumber double
discountType'None' | 'ReduceSubtotalByPercentage' | 'ReduceSubtotalByAmount' | 'ReduceShippingByPercentage' | 'ReduceShippingByAmount' | 'SetShippingToAmount' | 'ReduceProductPriceByPercentage' | 'ReduceProductPriceByAmount'
maxPercentageDiscountnumber double nullable
expirationDatestring date-time nullable
applyExpirationDateToExistingboolean
isStackableboolean
productIdinteger nullable
productDiscountNotAppliesWhenItHasSalePriceboolean
subtotalDiscountAppliesToRegularPriceboolean
createdUtcstring date-time
updatedUtcstring date-time
includeCustomerEmailsstring nullable
excludeCustomerEmailsstring nullable
activeboolean
validboolean
couponInvalidationCode'Expired' | 'SiteLimitExceeded' | 'ScheduledOrderLimitExceeded' | 'CustomerLimitExceeded' | 'GeographyNotMet' | 'TotalsNotMet' | 'UnitsNotMet' | 'MinWeightNotMet' | 'MaxWeightNotMet' | 'ScheduledOrderCyclesNotMet' | 'CustomerInclusionList' | 'CustomerExclusionList' | 'NonStackable' | 'ManuallyRemoved' | 'MaxAssignmentsReached' | 'MapRemoved' | 'ProductNotPresent' | 'SubtotalDiscountTypeMixed' | 'ItemHasSalePrice'
productGroupIdinteger nullable
productsExternalIdsstring[] nullable