Skip to main content
POST
/
v1
/
vouchers
/
{code}
/
transactions
/
export
Export Voucher Transactions
curl --request POST \
  --url https://{cluster}.voucherify.io/v1/vouchers/{code}/transactions/export \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '{
  "parameters": {
    "order": "-created_at",
    "fields": [
      "id",
      "type",
      "source_id",
      "reason",
      "balance",
      "amount",
      "created_at",
      "voucher_id",
      "campaign_id",
      "details",
      "source"
    ]
  }
}'
{
  "id": "exp_ARi2UbRjgfrHQJoVcKFrBUgA",
  "object": "export",
  "created_at": "2023-05-16T08:30:21.496Z",
  "status": "SCHEDULED",
  "channel": "API",
  "exported_object": "voucher_transactions",
  "parameters": {
    "order": "-created_at",
    "fields": [
      "id",
      "type",
      "source_id",
      "reason",
      "balance",
      "amount",
      "created_at",
      "voucher_id",
      "campaign_id",
      "details",
      "related_transaction_id",
      "source"
    ],
    "filters": {
      "voucher_id": {
        "conditions": {
          "$in": [
            "HRwc0oHz"
          ]
        }
      }
    }
  },
  "result": null,
  "user_id": null
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
code
string
required

A code that identifies the voucher or a unique voucher ID assigned by Voucherify, i.e. v_TzD19aeNiqGc9LWciMWknyEZT8IW7u4u.

Example:

"2CpRCE2c"

Body

application/json

Specify the parameters for the camapign transaction export.

Request body schema for POST v1/vouchers/transactions/export.

​
parameters
object

Contains the parameters that define the data to be exported. List of available fields and filters that can be exported with a gift card or loyalty card transactions export along with the sorting order of the returned data.

Response

Returns an export object.

Response body schema for POST v1/vouchers/{code}/transactions/export. This is an object representing an export.

Using this endpoint, you can export voucher transactions as a CSV file. This functionality works asynchronously and comes down to the following steps: create an export object and return its id so you can track its status, trigger a CSV file generation, change the status to SCHEDULED when the generation is over, store the file in S3 and change the status to DONE. Now you can download it.

With parameters you can select which fields will be exported. An export request will almost always result in a single file being generated by the system. However, when your volume of data is large, the system may split the results into multiple chunks.

​
id
string
required

Unique export ID.

Example:

"exp_FFfp9o7daWuJqJCKp5xqqli4"

​
object
enum<string>
default:export
required

The type of object being represented. This object stores information about the export.

Available options:
export
​
created_at
string<date-time>
required

Timestamp representing the date and time when the export was scheduled in ISO 8601 format.

Example:

"2022-04-28T11:23:20.922Z"

​
status
enum<string>
default:SCHEDULED
required

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 options:
SCHEDULED
​
channel
string
default:API
required

The channel through which the export was triggered.

​
exported_object
enum<string>
default:voucher_transactions
required

The type of exported object.

Available options:
voucher_transactions
​
parameters
object
required

List of available fields and filters that can be exported with gift card or loyalty card transactions along with the sorting order of the returned data.

​
result
object | null
required

Contains the URL of the CSV file.

​
user_id
string | null
required

Identifies the specific user who initiated the export through the Voucherify Dashboard; returned when the channel value is WEBSITE.

Example:

"user_g24UoRO3Caxu7FCT4n5tpYEa3zUG0FrH"

⌘I