Create Export

curl --request POST \ --url https://{cluster}.voucherify.io/v1/exports \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'X-App-Id: <api-key>' \ --header 'X-App-Token: <api-key>' \ --data '{ "exported_object": "voucher", "parameters": { "order": "-created_at", "fields": [ "code" ], "filters": { "junction": "and", "created_at": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "updated_at": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "created_date": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "active": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "redemption_status": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "start_date": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "expiration_date": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "validity_day_of_week": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "code": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "categories": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "vouchers": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "holder_id": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "is_referral_code": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "published_for_customer_id": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "validity_timeframe": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } }, "category_ids": { "conditions": { "$in": [ "<string>" ], "$not_in": [ "<string>" ], "$is": [ "<string>" ], "$is_days_ago": [ "<string>" ], "$is_days_in_future": [ "<string>" ], "$is_not": [ "<string>" ], "$has_value": [ "<string>" ], "$is_unknown": [ "<string>" ], "$contains": [ "<string>" ], "$not_contain": [ "<string>" ], "$starts_with": [ "<string>" ], "$ends_with": [ "<string>" ], "$more_than": [ "<string>" ], "$less_than": [ "<string>" ], "$more_than_ago": [ "<string>" ], "$less_than_ago": [ "<string>" ], "$more_than_future": [ "<string>" ], "$less_than_future": [ "<string>" ], "$more_than_equal": [ "<string>" ], "$less_than_equal": [ "<string>" ], "$after": [ "<string>" ], "$before": [ "<string>" ], "$count": [ "<string>" ], "$count_less": [ "<string>" ], "$count_more": [ "<string>" ] } } }, "campaign_id": "camp_0dJG7cCAjquzcxWmZ634bA0C" } }'

{ "id": "<string>", "object": "export", "created_at": "2023-11-07T05:31:56Z", "status": "SCHEDULED", "channel": "<string>", "result": null, "user_id": "<string>", "exported_object": "voucher", "parameters": { "order": "-created_at", "fields": [ "code" ], "filters": { "junction": "and", "created_at": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "updated_at": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "created_date": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "active": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "redemption_status": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "start_date": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "expiration_date": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "validity_day_of_week": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "code": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "categories": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "vouchers": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "holder_id": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "is_referral_code": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "published_for_customer_id": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "validity_timeframe": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } }, "category_ids": { "conditions": { "$in": [ "<any>" ], "$not_in": [ "<any>" ], "$is": [ "<any>" ], "$is_days_ago": [ "<any>" ], "$is_days_in_future": [ "<any>" ], "$is_not": [ "<any>" ], "$has_value": [ "<any>" ], "$is_unknown": [ "<any>" ], "$contains": [ "<any>" ], "$not_contain": [ "<any>" ], "$starts_with": [ "<any>" ], "$ends_with": [ "<any>" ], "$more_than": [ "<any>" ], "$less_than": [ "<any>" ], "$more_than_ago": [ "<any>" ], "$less_than_ago": [ "<any>" ], "$more_than_future": [ "<any>" ], "$less_than_future": [ "<any>" ], "$more_than_equal": [ "<any>" ], "$less_than_equal": [ "<any>" ], "$after": [ "<any>" ], "$before": [ "<any>" ], "$count": [ "<any>" ], "$count_less": [ "<any>" ], "$count_more": [ "<any>" ] } } }, "campaign_id": "camp_0dJG7cCAjquzcxWmZ634bA0C" } }

Create export object. The export can be any of the following types: voucher, redemption, publication, customer, order, points_expiration, voucher_transactions, product, or sku.

Defaults

If you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object:

Export Object	Default fields returned
order	`id`, `source_id`, `status`
voucher	`code`, `voucher_type`, `value`, `discount_type`
publication	`code`, `customer_id`, `date`, `channel`
redemption	`id`, `object`, `voucher_code`, `customer_id`, `date`, `result`
customer	`name`, `source_id`
points_expiration	`id`, `campaign_id`, `voucher_id`, `status`, `expires_at`, `points`
voucher_transactions	`id`, `type`, `source_id`, `status`, `reason`, `source`, `balance`, `amount`, `created_at`
products	`id`, `name`, `price`, `image_url`, `source_id`, `attributes`, `created_at`
SKU	`id`, `sku`, `product_id`, `currency`, `price`, `image_url`, `source_id`, `attributes`, `created_at`

📘 Date and time in the export API

The exported date and times are always provided in the UTC time zone.

Fetching particular data sets

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 combination of any of the following available fields:

Orders

Field	Definition	Example Export
id	Unique order ID.	ord_A69RIxEdRsPuC6i8gFGVHUft
source_id	Unique order source ID.	8638
created_at	Timestamp in ISO 8601 format representing the date and time when the order was created.	2022-03-09T09:16:32.521Z
updated_at	Timestamp in ISO 8601 format representing the date and time when the order was last updated.	2022-03-09T09:16:33.331Z
status	Order status.	`PAID`, `CREATED`, `FULFILLED`, `CANCELED`
amount	Total amount of order items.	7700
discount_amount	Represents total amount of the discount applied to whole cart.	500
items_discount_amount	Represents total amount of the discount applied to order line items.	100
total_discount_amount	All discounts applied to the order including discounts applied to particular order line items and discounts applied to the whole cart.	600
total_amount	Total order amount after applying all discounts.	7100
customer_id	Customer unique ID.	cust_2G4fUQdCXUqp35nXNleav7bO
referrer_id	Referrer unique ID.	cust_IkrTR674vvQvr9a4rDMiqglY
metadata	Order metadata; expressed as metadata.X, where X is the name of the custom metadata property.	1

Vouchers

Field	Definition	Example Export
id	Unique voucher ID.	v_HSnGD2vNIHYighTQxwcB4dtVAv8VOmZD
code	Unique voucher code.	WELCOME100
voucher_type	Type of voucher.	`DISCOUNT_VOUCHER`, `GIFT_VOUCHER`, `LOYALTY_CARD`
value	Value of voucher.	`DISCOUNT_VOUCHER` : amount, percent, unit `GIFT_VOUCHER`: amount left to spend `LOYALTY_CARD`: available usable points
discount_type	The type of discount for a `DISCOUNT_VOUCHER`.	`AMOUNT`, `PERCENT`, `UNIT`, `FIXED`
campaign	Unique campaign name.	Summer Discounts 20% off
category	Tag defining the category that this voucher belongs to.
start_date	Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher is inactive before this date.	2020-12-10T23:00:00.000Z
expiration_date	Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format. Voucher is inactive after this date.	2023-12-31T23:00:00.000Z
gift_balance	Amount left to spend.	1000
loyalty_balance	Available usable points.	2000
redemption_quantity	Maximum number of times a voucher can be redeemed.	2
redemption_count	Total redemptions.	59
active	Boolean indicating whether the voucher is available for use.	`true`, `false`
qr_code	URL to QR representation of encrypted code.
bar_code	URL to barcode representation of encrypted code.
metadata	Custom voucher metadata.
is_referral_code	Boolean indicating whether the voucher is a referral code.	`true`, `false`
created_at	Timestamp in ISO 8601 format representing the date and time when the voucher was created.	2022-04-14T09:55:46.814Z
updated_at	Timestamp in ISO 8601 format representing the date and time when the voucher was last updated.	2022-04-14T10:02:18.036Z
validity_timeframe_interval	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.	P2D
validity_timeframe_duration	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.	PT1H
validity_day_of_week	Array corresponding to the particular days of the week in which the voucher is valid.	”1,2,3,4,5”
discount_amount_limit	For `PERCENT` discount type, this is the maximum threshold allowed to be deducted.	50
campaign_id	Parent campaign ID.	camp_7s3uXI44aKfIk5IhmeOPr6ic
additional_info	An optional field to keep any extra textual information about the code such as a code description and details.
customer_id	Unique customer ID of the assigned owner to whom the voucher was published.	cust_7iUa6ICKyU6gH40dBU25kQU1
discount_unit_type	For `UNIT` discount type, either a shipping or product ID for a `UNIT` discount with one product.	prod_5h1pp1ng, prod_0a9f9aeddb019a42db
discount_unit_effect	`UNIT` discount effect.	`ADD_MANY_ITEMS`, `ADD_MISSING_ITEMS`,`ADD_NEW_ITEMS`
customer_source_id	Unique customer source id of the assigned owner to whom the voucher was published.	name.lastname@email.com

Publications

Field	Definition	Example Export
voucher_code	Unique voucher code.	WELCOME100
customer_id	Customer unique ID.	cust_7iUa6ICKyU6gH40dBU25kQU1
customer_source_id	Unique customer source id of the assigned owner to whom the voucher was published.	name.lastname@email.com
date	Timestamp in ISO 8601 format representing the date and time when the voucher was published.	2022-04-28T10:19:30.792Z
channel	Publication channel.	voucherify-website
campaign	Unique campaign name.	Summer Discounts 20% off
is_winner
metadata	Custom publication metadata.

Redemptions

Field	Definition	Example Export
id	Unique redemption ID.	r_0acf3a6dae00e679c8, rf_0acf3a495740e679b8
object	Object being exported; by default `redemption`.	redemption
date	Timestamp in ISO 8601 format representing the date and time when the voucher was redeemed.	2022-03-23T08:52:24.867Z
voucher_code	Unique voucher code redeemed.	WELCOME100
campaign	Parent campaign name of voucher if applicable.	Summer Discounts 20% off
promotion_tier_id		promo_Mwy9XpA0TLctSGriM5kum0qp
customer_id	Unique customer ID of redeeming customer.	cust_nk0N1uNQ1YnupAoJGOgvsODC
customer_source_id	Unique source ID of redeeming customer.	name.lastname@email.com
customer_name	Customer name.	John Smith
tracking_id		track_Pw6r3ejnml43kIwNS4Zj09KZ67xOfLUy
order_amount	Total order amount before applying all discounts.	1000
gift_amount	Gift credits used for redemption.	10
loyalty_points		12
result	Tells you whether the redemption succeeded.	`SUCCESS`, `FAILURE`
failure_code	Internal Voucherify code for reason why redemption failed.	invalid_customer
failure_message	A human-readable message providing a short description explaining why the redemption failed.	Customer must be a holder of a loyalty card.
metadata	Custom redemption metadata.

Customers

Field	Definition	Example Export
name	Customer name.	John Smith
id	Unique customer ID.	cust_J1CDUdbqn5Exva8ASWk1Fq0j
description	An arbitrary string that you can attach to a customer object.	Customer requesting to be added to VIP tier.
email	Customer’s email.	name.lastname@email.com
source_id	Unique custom customer identifier.	name.lastname@email.com
created_at	Timestamp in ISO 8601 format representing the date and time when the customer was created.	2022-02-03T13:10:11.928Z
address_city	City	Houston
address_state	State	TX
address_line_1	First line of customer’s address.	72738 Main St
address_line_2	Second line of customer’s address.	Bld 2, Apt 4
address_country	Country	United States of America
address_postal_code	Postal code (ZIP code)	77042-4143
redemptions_total_redeemed	Total customer redemptions.	5
redemptions_total_failed	Total customer failed redemptions.	2
redemptions_total_succeeded	Total customer succeeded redemptions.	3
redemptions_total_rolled_back	Total customer redemptions that were rolled back.	3
redemptions_total_rollback_failed	Total customer redemptions that were unsuccessfully rolled back.	2
redemptions_total_rollback_succeeded	Total customer redemptions that were successfully rolled back.	1
orders_total_amount	Total sum of order amounts over customer lifetime. Value is multiplied by 100 to precisely represent 2 decimal places.	10000 (represents $100)
orders_total_count	Total number of customer orders.	2
orders_average_amount	Average amount spent on orders. Value is multiplied by 100 to precisely represent 2 decimal places.	5000 (represents $50)
orders_last_order_amount	How much did the customer spend on their last order. Value is multiplied by 100 to precisely represent 2 decimal places.	5000 (represents $50)
orders_last_order_date	When was the last customer order; timestamp in ISO 8601 format representing the date and time.	2022-02-03T13:17:30.630Z
loyalty_points	Sum of customer’s loyalty points to go across all loyalty cards.	2000
loyalty_referred_customers	How many customers were referred by this customer.	3
updated_at	Timestamp in ISO 8601 format representing the date and time when the customer was updated.	2022-02-14T14:10:14.305Z
phone	Customer’s phone number.	+1 (294) 752-1846
birthday	`Deprecated`. ~~Customer’s birthday~~.	2022-01-01
metadata	Customer metadata.	All metadata fields defined in Metadata Schema for the Customer object.
birthdate	Customer’s birthdate.	2022-01-01

Points Expirations

Field	Definition	Example Export
id	Loyalty points bucket ID.	lopb_Wl1o3EjJIHSNjvO5BDLy4z1n
campaign_id	Campaign ID of the parent loyalty campaign.	camp_7s3uXI44aKfIk5IhmeOPr6ic
voucher_id	Voucher ID of the parent loyalty card.	v_YLn0WVWXSXbUfDvxgrgUbtfJ3SQIY655
status	Status of the loyalty point bucket.	`ACTIVE` or `EXPIRED`
expires_at	Timestamp in ISO 8601 format representing the date when the points expire.	2022-06-30
points	Number of points.	1000

Gift Card Transactions

Field	Definition	Example Export
id	Unique transaction ID.	vtx_0cb7811f1c07765800
type	Transaction type.	- `CREDITS_REMOVAL` - `CREDITS_ADDITION` - `CREDITS_REFUND` - `CREDITS_REDEMPTION`
source_id	Unique transaction source ID.	8638
reason	Contains the reason for the transaction if one was included originally.
balance	The gift card or loyalty card balance after the transaction.
amount	The amount of gift card or loyalty card credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction.
created_at	Timestamp in ISO 8601 format representing the date and time when the transaction was created.	2022-03-09T09:16:32.521Z
voucher_id	Unique Voucher ID.	v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp
campaign_id	Parent campaign ID.	camp_FNYR4jhqZBM9xTptxDGgeNBV
source	Channel through which the transaction was initiated.	API
details	More detailed information stored in the form of a JSON.	Provides more details related to the transaction in the form of an object.

Loyalty Card Transactions

Field	Definition	Example Export
id	Unique transaction ID assigned by Voucherify.	vtx_0cb7811f1c07765800
type	Transaction type.	- `POINTS_EXPIRATION` - `POINTS_ADDITION` - `POINTS_REMOVAL` - `POINTS_TRANSFER_OUT` - `POINTS_ACCRUAL` - `POINTS_REFUND` - `POINTS_REDEMPTION`
source_id	Custom source ID of the transaction if one was included originally.	source_id_custom
reason	Contains the reason for the transaction if one was included originally.
balance	The loyalty card balance after the transaction.
amount	The amount of loyalty points being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction.
created_at	Timestamp in ISO 8601 format representing the date and time when the transaction was created.	2022-03-09T09:16:32.521Z
voucher_id	Unique Voucher ID.	v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp
campaign_id	Parent campaign ID.	camp_FNYR4jhqZBM9xTptxDGgeNBV
source	Channel through which the transaction was initiated.	- `API` - `voucherify-web-ui` - `Automation`
details	More detailed information stored in the form of a JSON.	Provides more details related to the transaction in the form of an object.
related_transaction_id	Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card.	vtx_0c9afe802593b34b80

Introduction

Endpoints

Events