Overview

Export

One of:

Export Voucher, Export Redemption, Export Customers, Export Publication, Export Orders, Export Points Expiration, Export Vouchers Transactions

Export Voucher

All of:

1. Export Base
2. Export Vouchers

Export Redemption

All of:

1. Export Base
2. Export Redemptions

Export Customers

All of:

1. Export Base
2. Export Customers

Export Publication

All of:

1. Export Base
2. Export Publications

Export Orders

All of:

1. Export Base
2. Export Orders

Export Points Expiration

All of:

1. Export Base
2. Export Points Expirations

Export Vouchers Transactions

All of:

1. Export Base
2. Export Vouchers Transactions

Export Base

Attributes	Description
idstring	Unique export ID.
objectstring	The type of object being represented. This object stores information about the export.Available values: export
created_atstring	Timestamp representing the date and time when the export was scheduled in ISO 8601 format.
statusstring	Status of the export. Informs you whether the export has already been completed, i.e. indicates whether the file containing the exported data has been generated.Available values: SCHEDULED, IN_PROGRESS, DONE, ERROR
channelstring	The channel through which the export was triggered.
resultobject, null	Contains the URL of the CSV file.Attributes Descriptionurlstring URL of the CSV file location. It contains the token used for authorization in the Download export method.
user_idstring, null	Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE.

Export Vouchers

Attributes	Description
exported_objectstring	The type of object to be exported.Available values: voucher
parametersobject	Attributes Descriptionorder How the export is filtered, where the dash - preceding a sorting option means sorting in a descending order. Export Voucher Order fieldsarray Array of strings containing the data in the export. These fields define the headers in the CSV file. Array of Export Voucher Fields filters Filter conditions. Export Voucher Filters

Export Redemptions

Attributes	Description
exported_objectstring	The type of object to be exported.Available values: redemption
parametersobject	List of available fields and filters that can be exported with an order along with the sorting order of the returned data.Attributes Descriptionorder How the export is filtered, where the dash - preceding a sorting option means sorting in a descending order. Export Redemption Order fieldsarray Array of strings containing the data in the export. These fields define the headers in the CSV file. Array of Export Redemption Fields filters Filter conditions. Export Redemption Filters

Export Customers

Attributes	Description
exported_objectstring	The type of object to be exported.Available values: customer
parametersobject	List of available fields and filters that can be exported with an order along with the sorting order of the returned data.Attributes Descriptionorder How the export is filtered, where the dash - preceding a sorting option means sorting in a descending order. Export Customer Order fieldsarray Array of strings containing the data in the export. These fields define the headers in the CSV file. Array of Export Customer Fields filters Filter conditions. Export Customer Filters

Export Publications

Attributes	Description
exported_objectstring	The type of object to be exported.Available values: publication
parametersobject	List of available fields and filters that can be exported with an order along with the sorting order of the returned data.Attributes Descriptionorder How the export is filtered, where the dash - preceding a sorting option means sorting in a descending order. Export Publication Order fieldsarray Array of strings containing the data in the export. These fields define the headers in the CSV file. Array of Export Publication Fields filters Filter conditions. Export Publication Filters

Export Orders

Attributes	Description
exported_objectstring	The type of object to be exported.Available values: order
parametersobject	List of available fields and filters that can be exported with an order along with the sorting order of the returned data.Attributes Descriptionorder How the export is filtered, where the dash - preceding a sorting option means sorting in a descending order. Export Order Order fieldsarray Array of strings containing the data in the export. These fields define the headers in the CSV file. Array of Export Order Fields filters Filter conditions. Export Order Filters

Export Points Expirations

Attributes	Description
exported_objectstring	The type of object to be exported.Available values: points_expiration
parametersobject	List of available fields and filters that can be exported with an order along with the sorting order of the returned data.Attributes Descriptionorder How the export is filtered, where the dash - preceding a sorting option means sorting in a descending order. Export Points Expiration Order fieldsarray Array of strings containing the data in the export. These fields define the headers in the CSV file. Array of Export Points Expiration Fields filters Filter conditions. Export Points Expiration Filters

Export Vouchers Transactions

Attributes	Description
exported_objectstring	The type of object to be exported.Available values: voucher_transactions
parametersobject	List of available fields and filters that can be exported with an order along with the sorting order of the returned data.Attributes Descriptionorder How the export is filtered, where the dash - preceding a sorting option means sorting in a descending order. Export Voucher Transactions Order fieldsarray Array of strings containing the data in the export. These fields define the headers in the CSV file. Array of Export Voucher Transactions Fields filters Filter conditions. Export Voucher Transactions Filters

Export Voucher Order

Available values: -created_at, created_at, -updated_at, updated_at, -code, code

Export Voucher Fields

Available values: code, voucher_type, value, formula, discount_type, campaign, category, start_date, expiration_date, gift_balance, loyalty_balance, redemption_quantity, redemption_count, active, qr_code, bar_code, metadata, id, is_referral_code, created_at, updated_at, validity_timeframe_interval, validity_timeframe_duration, validity_day_of_week, discount_amount_limit, campaign_id, additional_info, customer_id, discount_effect, discount_unit_type, discount_unit_effect, validation_rules_id, customer_source_id

Export Voucher Filters

Attributes	Description
junction	Filter by conditions set on the junction parameter indicating how the conditions should be accounted for in the query. An AND is an all-inclusive logical operator, meaning the AND operator displays a record if ALL the conditions separated by AND are TRUE, while an OR operator displays a record if ANY of the conditions separated by OR is TRUE.Junction
created_at	See: Field Conditions
updated_at	See: Field Conditions
created_date	See: Field Conditions
active	See: Field Conditions
redemption_status	See: Field Conditions
start_date	See: Field Conditions
expiration_date	See: Field Conditions
validity_day_of_week	See: Field Conditions
code	See: Field Conditions
categories	See: Field Conditions
vouchers	See: Field Conditions
holder_id	See: Field Conditions
is_referral_code	See: Field Conditions
published_for_customer_id	See: Field Conditions
validity_timeframe	See: Field Conditions
category_ids	See: Field Conditions
[propertyName]	See: Field Conditions

Export Redemption Order

Available values: -id, id, -voucher_code, voucher_code, -tracking_id, tracking_id, -customer_id, customer_id, -created_at, created_at

Export Redemption Fields

Available values: id, object, date, voucher_code, campaign, promotion_tier_id, customer_id, customer_source_id, customer_name, tracking_id, order_id, order_amount, gift_amount, loyalty_points, result, failure_code, failure_message, metadata

Export Redemption Filters

Attributes	Description
junction	See: Junction
created_atobject	Attributes Descriptionconditionsobject Filters Condition Attributes Descriptionafter See: Any
before See: Any
campaignobject	Attributes Descriptionconditionsobject Filters Condition Attributes Description$is See: Any
customerobject	Attributes Descriptionconditionsobject Filters Condition Attributes Description$is See: Any
voucherobject	Attributes Descriptionconditionsobject Filters Condition Attributes Description$is See: Any
related_objectobject	Attributes Descriptionconditionsobject Filters Condition Attributes Description$in See: Any
voucher_code	See: Field Conditions
related_object_id	See: Field Conditions
related_object_parent_id	See: Field Conditions
parent_redemption_id	See: Field Conditions
failure_code	See: Field Conditions
result	See: Field Conditions
object	See: Field Conditions
customer_id	See: Field Conditions
campaign_name	See: Field Conditions
user_login	See: Field Conditions
status	See: Field Conditions
[propertyName]	See: Field Conditions

Export Customer Order

Available values: -name, name, -id, id, -email, email, -source_id, source_id, -created_at, created_at, -updated_at, updated_at

Export Customer Fields

Available values: name, id, description, email, source_id, created_at, address_city, address_state, address_line_1, address_line_2, address_country, address_postal_code, redemptions_total_redeemed, redemptions_total_failed, redemptions_total_succeeded, redemptions_total_rolled_back, redemptions_total_rollback_failed, redemptions_total_rollback_succeeded, orders_total_amount, orders_total_count, orders_average_amount, orders_last_order_amount, orders_last_order_date, loyalty_points, loyalty_referred_customers, updated_at, phone, birthday, metadata, birthdate

Export Customer Filters

Attributes	Description
junction	See: Junction
created_atobject	Attributes Descriptionconditionsobject Filters Condition Attributes Descriptionafter See: Any
before See: Any
updated_atobject	Attributes Descriptionconditionsobject Filters Condition Attributes Descriptionafterarray 
beforearray $isarray
email	See: Field Conditions
name	See: Field Conditions
cityobject	Attributes Descriptionconditionsobject Filters Condition Attributes Description$is See: Any
phone	See: Field Conditions
birthday	See: Field Conditions
source_id	See: Field Conditions
publications.created_at	See: Field Conditions
publications.related_object_id	See: Field Conditions
[propertyName]	See: Field Conditions

Export Publication Order

Available values: -id, id, -voucher_code, voucher_code, -tracking_id, tracking_id, -customer_id, customer_id, -created_at, created_at, -channel, channel

Export Publication Fields

Available values: voucher_code, customer_id, customer_source_id, date, channel, campaign, is_winner, metadata

Export Publication Filters

Attributes	Description
junction	See: Junction
created_atobject	Attributes Descriptionconditionsobject Filters Condition Attributes Descriptionafter See: Any
before See: Any
campaignobject	Attributes Descriptionconditionsobject Filters Condition Attributes Description$is See: Any
customerobject	Attributes Descriptionconditionsobject Filters Condition Attributes Description$is See: Any
voucherobject	Attributes Descriptionconditionsobject Filters Condition Attributes Description$is See: Any
failure_code	See: Field Conditions
result	See: Field Conditions
customer_id	See: Field Conditions
campaign_name	See: Field Conditions
voucher_type	See: Field Conditions
is_referral_code	See: Field Conditions
parent_object_id	See: Field Conditions
related_object_id	See: Field Conditions
source_id	See: Field Conditions
[propertyName]	See: Field Conditions

Export Order Order

Available values: -created_at, created_at, -updated_at, updated_at, -status, status

Export Order Fields

Available values: id, source_id, created_at, updated_at, status, amount, discount_amount, items_discount_amount, total_discount_amount, total_amount, customer_id, referrer_id, metadata

Export Order Filters

Attributes	Description
junction	See: Junction
created_atobject	Attributes Descriptionconditionsobject Filters Condition Attributes Descriptionafter See: Any
before See: Any
updated_atobject	Attributes Descriptionconditionsobject Filters Condition Attributes Descriptionafter See: Any
before See: Any
status	See: Field Conditions
source_id	See: Field Conditions
amount	See: Field Conditions
total_amount	See: Field Conditions
discount_amount	See: Field Conditions
total_discount_amount	See: Field Conditions
items_discount_amount	See: Field Conditions
[propertyName]	See: Field Conditions

Export Points Expiration Order

Available values: -expires_at, expires_at

Export Points Expiration Fields

Available values: id, campaign_id, voucher_id, points, status, expires_at

Export Points Expiration Filters

Attributes	Description
junction	See: Junction
campaign_id	See: Field Conditions
voucher_id	See: Field Conditions

Export Voucher Transactions Order

Available values: -created_at, created_at

Export Voucher Transactions Fields

Available values: id, campaign_id, voucher_id, type, source_id, reason, source, balance, amount, related_transaction_id, created_at, details

Export Voucher Transactions Filters

Attributes	Description
junction	See: Junction
created_at	See: Field Conditions
voucher_id	See: Field Conditions
campaign_id	See: Field Conditions

Junction

Logical Operator Between Filters. Filter by conditions set on the junction parameter indicating how the conditions should be accounted for in the query. An AND is an all-inclusive logical operator, meaning the AND operator displays a record if ALL the conditions separated by AND are TRUE, while an OR operator displays a record if ANY of the conditions separated by OR is TRUE.

Available values: and, or

Field Conditions

Attributes	Description
conditions	Data filters used to narrow down the data records to be returned in the result.Filters Condition

Any

Array any of: string, string, string, number, object

Filters Condition

Attributes	Description
$in	See: Any
$not_in	See: Any
$is	See: Any
$is_days_ago	See: Any
$is_days_in_future	See: Any
$is_not	See: Any
$has_value	See: Any
$is_unknown	See: Any
$contains	See: Any
$not_contain	See: Any
$starts_with	See: Any
$ends_with	See: Any
$more_than	See: Any
$less_than	See: Any
$more_than_ago	See: Any
$less_than_ago	See: Any
$more_than_future	See: Any
$less_than_future	See: Any
$more_than_equal	See: Any
$less_than_equal	See: Any
$after	See: Any
$before	See: Any
$count	See: Any
$count_less	See: Any
$count_more	See: Any