> ## Documentation Index > Fetch the complete documentation index at: https://voucherify-pz-test.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Overview ## Export One of: [Export Voucher](#export-voucher), [Export Redemption](#export-redemption), [Export Customers](#export-customers), [Export Publication](#export-publication), [Export Orders](#export-orders), [Export Points Expiration](#export-points-expiration), [Export Vouchers Transactions](#export-vouchers-transactions) ## Export Voucher All of: 1. [Export Base](#export-base) 2. [Export Vouchers](#export-vouchers) ## Export Redemption All of: 1. [Export Base](#export-base) 2. [Export Redemptions](#export-redemptions) ## Export Customers All of: 1. [Export Base](#export-base) 2. [Export Customers](#export-customers) ## Export Publication All of: 1. [Export Base](#export-base) 2. [Export Publications](#export-publications) ## Export Orders All of: 1. [Export Base](#export-base) 2. [Export Orders](#export-orders) ## Export Points Expiration All of: 1. [Export Base](#export-base) 2. [Export Points Expirations](#export-points-expirations) ## Export Vouchers Transactions All of: 1. [Export Base](#export-base) 2. [Export Vouchers Transactions](#export-vouchers-transactions) ## Export Base | Attributes | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | id`string` | Unique export ID. | | object`string` | The type of object being represented. This object stores information about the export.Available values: `export` | | created\_at`string` | Timestamp representing the date and time when the export was scheduled in ISO 8601 format. | | status`string` | 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` | | channel`string` | The channel through which the export was triggered. | | result`object`, `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\_id`string`, `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\_object`string` | The type of object to be exported.Available values: `voucher` | | parameters`object` | 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\_object`string` | The type of object to be exported.Available values: `redemption` | | parameters`object` | 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\_object`string` | The type of object to be exported.Available values: `customer` | | parameters`object` | 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\_object`string` | The type of object to be exported.Available values: `publication` | | parameters`object` | 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\_object`string` | The type of object to be exported.Available values: `order` | | parameters`object` | 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\_object`string` | The type of object to be exported.Available values: `points_expiration` | | parameters`object` | 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\_object`string` | The type of object to be exported.Available values: `voucher_transactions` | | parameters`object` | 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](#junction) | | created\_at | See: [Field Conditions](#field-conditions) | | updated\_at | See: [Field Conditions](#field-conditions) | | created\_date | See: [Field Conditions](#field-conditions) | | active | See: [Field Conditions](#field-conditions) | | redemption\_status | See: [Field Conditions](#field-conditions) | | start\_date | See: [Field Conditions](#field-conditions) | | expiration\_date | See: [Field Conditions](#field-conditions) | | validity\_day\_of\_week | See: [Field Conditions](#field-conditions) | | code | See: [Field Conditions](#field-conditions) | | categories | See: [Field Conditions](#field-conditions) | | vouchers | See: [Field Conditions](#field-conditions) | | holder\_id | See: [Field Conditions](#field-conditions) | | is\_referral\_code | See: [Field Conditions](#field-conditions) | | published\_for\_customer\_id | See: [Field Conditions](#field-conditions) | | validity\_timeframe | See: [Field Conditions](#field-conditions) | | category\_ids | See: [Field Conditions](#field-conditions) | | \[propertyName] | See: [Field Conditions](#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](#junction) | | created\_at`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description$after See: Any $before See: Any | | campaign`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description\$is See: Any | | customer`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description\$is See: Any | | voucher`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description\$is See: Any | | related\_object`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description\$in See: Any | | voucher\_code | See: [Field Conditions](#field-conditions) | | related\_object\_id | See: [Field Conditions](#field-conditions) | | related\_object\_parent\_id | See: [Field Conditions](#field-conditions) | | parent\_redemption\_id | See: [Field Conditions](#field-conditions) | | failure\_code | See: [Field Conditions](#field-conditions) | | result | See: [Field Conditions](#field-conditions) | | object | See: [Field Conditions](#field-conditions) | | customer\_id | See: [Field Conditions](#field-conditions) | | campaign\_name | See: [Field Conditions](#field-conditions) | | user\_login | See: [Field Conditions](#field-conditions) | | status | See: [Field Conditions](#field-conditions) | | \[propertyName] | See: [Field Conditions](#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](#junction) | | created\_at`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description$after See: Any $before See: Any | | updated\_at`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description$afterarray $beforearray \$isarray | | email | See: [Field Conditions](#field-conditions) | | name | See: [Field Conditions](#field-conditions) | | city`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description\$is See: Any | | phone | See: [Field Conditions](#field-conditions) | | birthday | See: [Field Conditions](#field-conditions) | | source\_id | See: [Field Conditions](#field-conditions) | | publications.created\_at | See: [Field Conditions](#field-conditions) | | publications.related\_object\_id | See: [Field Conditions](#field-conditions) | | \[propertyName] | See: [Field Conditions](#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](#junction) | | created\_at`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description$after See: Any $before See: Any | | campaign`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description\$is See: Any | | customer`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description\$is See: Any | | voucher`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description\$is See: Any | | failure\_code | See: [Field Conditions](#field-conditions) | | result | See: [Field Conditions](#field-conditions) | | customer\_id | See: [Field Conditions](#field-conditions) | | campaign\_name | See: [Field Conditions](#field-conditions) | | voucher\_type | See: [Field Conditions](#field-conditions) | | is\_referral\_code | See: [Field Conditions](#field-conditions) | | parent\_object\_id | See: [Field Conditions](#field-conditions) | | related\_object\_id | See: [Field Conditions](#field-conditions) | | source\_id | See: [Field Conditions](#field-conditions) | | \[propertyName] | See: [Field Conditions](#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](#junction) | | created\_at`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description$after See: Any $before See: Any | | updated\_at`object` | Attributes Descriptionconditionsobject Filters Condition Attributes Description$after See: Any $before See: Any | | status | See: [Field Conditions](#field-conditions) | | source\_id | See: [Field Conditions](#field-conditions) | | amount | See: [Field Conditions](#field-conditions) | | total\_amount | See: [Field Conditions](#field-conditions) | | discount\_amount | See: [Field Conditions](#field-conditions) | | total\_discount\_amount | See: [Field Conditions](#field-conditions) | | items\_discount\_amount | See: [Field Conditions](#field-conditions) | | \[propertyName] | See: [Field Conditions](#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](#junction) | | campaign\_id | See: [Field Conditions](#field-conditions) | | voucher\_id | See: [Field Conditions](#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](#junction) | | created\_at | See: [Field Conditions](#field-conditions) | | voucher\_id | See: [Field Conditions](#field-conditions) | | campaign\_id | See: [Field Conditions](#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](#filters-condition) | ## Any Array any of: string, string, string, number, object ## Filters Condition | Attributes | Description | | ---------------------- | ---------------- | | \$in | See: [Any](#any) | | \$not\_in | See: [Any](#any) | | \$is | See: [Any](#any) | | \$is\_days\_ago | See: [Any](#any) | | \$is\_days\_in\_future | See: [Any](#any) | | \$is\_not | See: [Any](#any) | | \$has\_value | See: [Any](#any) | | \$is\_unknown | See: [Any](#any) | | \$contains | See: [Any](#any) | | \$not\_contain | See: [Any](#any) | | \$starts\_with | See: [Any](#any) | | \$ends\_with | See: [Any](#any) | | \$more\_than | See: [Any](#any) | | \$less\_than | See: [Any](#any) | | \$more\_than\_ago | See: [Any](#any) | | \$less\_than\_ago | See: [Any](#any) | | \$more\_than\_future | See: [Any](#any) | | \$less\_than\_future | See: [Any](#any) | | \$more\_than\_equal | See: [Any](#any) | | \$less\_than\_equal | See: [Any](#any) | | \$after | See: [Any](#any) | | \$before | See: [Any](#any) | | \$count | See: [Any](#any) | | \$count\_less | See: [Any](#any) | | \$count\_more | See: [Any](#any) |