Coupon

Coupon api.

APIAuthorizationDescription
OAuth2Basic
GET rest/coupons?couponUsage={couponUsage}

Gets a list of coupon links (Supports OData 4.0).

GET rest/coupons/$count?couponUsage={couponUsage}

Gets coupon link count (Supports OData 4.0).

GET rest/coupons/{couponId}

Gets a coupon.

POST rest/coupons

Creates a new coupon or coupon book.

DELETE rest/coupons/{couponId}

Deletes a coupon or coupon book.

GET rest/coupons/{couponId}?recipient={recipient}&recipientType={recipientType}&externalId={externalId}&batchId={batchId}

Gets coupon or coupon book recipient data (code and url).

GET rest/coupons/generate-test-recipient?couponId={couponId}&recipient={recipient}

Gets coupon or coupon book recipient data (code and url).

POST rest/coupons/{couponId}?batchId={batchId}&sequence={sequence}&recipient={recipient}&recipientType={recipientType}&externalId={externalId}

No documentation available.

GET rest/coupons/{couponId}/recipients?batchId={batchId}&sequence={sequence}

Get coupon or coupon book recipients data batch.

SiteTemplate

Site template API.

APIAuthorizationDescription
OAuth2Basic
GET rest/siteTemplates?global={global}

Gets all site templates for a partner or global templates if the global parameter is set..

GET rest/siteTemplates/{siteTemplateId}

Gets a site template.

POST rest/siteTemplates

Creates a new site template or updates an existing. Can also be used to update global templates, but such updates requires special permissions. To update a global template, just omit the PartnerId.

DefaultCouponSettings

Default coupon settings API.

APIAuthorizationDescription
OAuth2Basic
GET rest/defaultcouponsettings/{partnerId}

Returns the default coupon settings for the first partner id in the JWT token.

PUT rest/defaultcouponsettings/{partnerId}

Creates or updates the default coupon settings for the given partnerId.

External

External coupon codes api.

APIAuthorizationDescription
OAuth2Basic
GET rest/codes?externalId={externalId}&excludeExpiredCoupons={excludeExpiredCoupons}&excludeRedeemedCoupons={excludeRedeemedCoupons}

Gets existing coupon recipients identified by externalId.

POST rest/codes/{couponRecipientId}/redeem

Update redeem count for coupon recipient.

Statistics

Statistics api.

APIAuthorizationDescription
OAuth2Basic
GET rest/statistics?from={from}&to={to}&batchId={batchId}&serviceId={serviceId}

Gets statistics for all coupons from/to a given date or for one specific coupon.

GET rest/statistics/by-batch-id?couponBookId={couponBookId}

Gets statistics for a coupon book, divided by batches.

GET rest/statistics/by-batch-id?couponId={couponId}

Gets statistics for a coupon, divided by batches.

Recipient

Coupon recipients api. This is not in use anywhere atm (2016-04-20).

APIAuthorizationDescription
OAuth2Basic
GET rest/recipients/{couponRecipientId}

Gets coupon recipient identified by recipientId.

GET rest/recipients/{couponRecipientId}/access

Increment access count for coupon recipient.

GET rest/recipients/{couponRecipientId}/redeem

Increment redeem count for coupon recipient.