Export coupons

GET {{baseUrl}}/v1/applications/:applicationId/export_coupons?campaignId={{campaignId}}&sort=value&value=value&createdBefore=2022-11-08T00:11:22.082Z&createdAfter=2022-11-08T00:11:22.082Z&valid=expired&usable=false&referralId=10&recipientIntegrationId=value&batchId=value&exactMatch=false&dateFormat=excel&campaignState=expired&valuesOnly=false

Download a CSV file containing the coupons that match the given properties.

Tip: If the exported CSV file is too large to view, you can split it into multiple files.

The CSV file contains the following columns:

• accountid: The ID of your deployment.
• applicationid: The ID of the Application this coupon is related to.
• attributes: A json object describing custom referral attribute names and their values.
• batchid: The ID of the batch this coupon is part of.
• campaignid: The ID of the campaign this coupon is related to.
• counter: The number of times this coupon has been redeemed.
• created: The creation date of the coupon code.
• deleted: Whether the coupon code is deleted.
• deleted_changelogid: The ID of the delete event in the logs.
• discount_counter: The amount of discount given by this coupon.
• discount_limitval: The maximum discount amount that can be given be this coupon.
• expirydate: The end date in RFC3339 of the code redemption period.
• id: The internal ID of the coupon code.
• importid: The ID of the import job that created this coupon.
• is_reservation_mandatory: Whether this coupon requires a reservation to be redeemed.
• limits: The limits set on this coupon.
• limitval: The maximum number of redemptions of this code.
• recipientintegrationid: The integration ID of the customer considered as recipient of the coupon. Only the customer with this integration ID can redeem the corresponding coupon code. Learn about coupon reservation.
• referralid: The ID of the referral code that triggered the creation of this coupon (create coupon effect).
• reservation: Whether the coupon is reserved.
• reservation_counter: How many times this coupon has been reserved.
• reservation_limitval: The maximum of number of reservations this coupon can have.
• startdate: The start date in RFC3339 of the code redemption period.
• value: The coupon code.

Request Params

Note: This parameter works only with numeric fields. | | value | string | | Filter results performing case-insensitive matching against the coupon code. Both the code and the query are folded to remove all non-alpha-numeric characters. | | createdBefore | string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | | createdAfter | string | | Filter results comparing the parameter value, expected to be an RFC3339 timestamp string, to the coupon creation timestamp. You can use any timezone. Talon.One will convert to UTC internally. | | valid | string | | Either "expired", "validNow", or "validFuture". The first option matches coupons in which the expiration date is set and in the past. The second matches coupons in which start date is null or in the past and expiration date is null or in the future, the third matches coupons in which start date is set and in the future. | | usable | boolean | | Either "true" or "false". If "true", only coupons where usageCounter < usageLimit will be returned, "false" will return only coupons where usageCounter >= usageLimit. | | referralId | number | | Filter the results by matching them with the ID of a referral. This filter shows the coupons created by redeeming a referral code. | | recipientIntegrationId | string | | Filter results by match with a profile id specified in the coupon's RecipientIntegrationId field | | batchId | string | | Filter results by batches of coupons | | exactMatch | boolean | | Filter results to an exact case-insensitive matching against the coupon code | | dateFormat | string | | Determines the format of dates in the export document. | | campaignState | string | | Filter results by the state of the campaign.

• enabled: Campaigns that are scheduled, running (activated), or expired.
• running: Campaigns that are running (activated).
• disabled: Campaigns that are disabled.
• expired: Campaigns that are expired.
• archived: Campaigns that are archived.
• draft: Campaigns that are drafts. | | valuesOnly | boolean | | Filter results to only return the coupon codes (value column) without the associated coupon data. |

HEADERS