Using the parameters body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combintation of any of the following available fields:
Unique order ID.
Unique order source ID.
Timestamp in ISO 8601 format representing the date and time when the order was created.
Timestamp in ISO 8601 format representing the date and time when the order was last updated.
PAID, CREATED, FULFILLED, CANCELED
Total amount of order items.
Represents total amount of the discount applied to whole cart.
Represents total amount of the discount applied to order line items.
All discounts applied to the order including discounts applied to particular order line items and discounts applied to the whole cart.
Total order amount after applying all discounts.
Customer unique ID.
Referrer unique ID.
Order metadata; expressed as metadata.X, where X is the name of the custom metadata property.
Unique voucher ID.
Unique voucher code.
Type of voucher.
DISCOUNT_VOUCHER, GIFT_VOUCHER, LOYALTY_CARD
Value of voucher.
DISCOUNT_VOUCHER : amount, percent, unit GIFT_VOUCHER: amount left to spend LOYALTY_CARD: available usable points
The type of discount for a DISCOUNT_VOUCHER.
AMOUNT, PERCENT, UNIT, FIXED
Unique campaign name.
Summer Discounts 20% off
Tag defining the category that this voucher belongs to.
Start date defines when the code starts to be active. Activation timestamp in ISO 8601 format. Voucher is inactive before this date.
Expiration date defines when the code expires. Expiration timestamp in ISO 8601 format. Voucher is inactive after this date.
Amount left to spend.
Available usable points.
Maximum number of times a voucher can be redeemed.
Boolean indicating whether the voucher is available for use.
URL to QR representation of encrypted code.
URL to barcode representation of encrypted code.
Custom voucher metadata.
Boolean indicating whether the voucher is a referral code.
Timestamp in ISO 8601 format representing the date and time when the voucher was created.
Timestamp in ISO 8601 format representing the date and time when the voucher was last updated.
Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a voucher with an interval of P2D will be active every other day.
Defines the amount of time the voucher will be active in ISO 8601 format. For example, a voucher with a duration of PT1H will be valid for a duration of one hour.
Array corresponding to the particular days of the week in which the voucher is valid.
For PERCENT discount type, this is the maximum threshold allowed to be deducted.
Parent campaign ID.
An optional field to keep any extra textual information about the code such as a code description and details.
Unique customer ID of the assigned owner to whom the voucher was published.
For UNIT discount type, either a shipping or product ID for a UNIT discount with one product.
UNIT discount effect.
Unique customer source id of the assigned owner to whom the voucher was published.