Export Loyalty Campaign Transactions

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/transactions/export \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "order": "-created_at",
  "parameters": {
    "fields": [
      "id",
      "type",
      "source_id",
      "created_at"
    ],
    "filters": {
      "created_at": {
        "conditions": {
          "$after": [
            "2024-10-01T00:00:00.000Z"
          ]
        }
      }
    }
  }
}
'

{
  "id": "exp_KBunyG5vwkuF3jSWD03kmnLx",
  "object": "export",
  "created_at": "2024-10-25T14:35:12.019Z",
  "status": "SCHEDULED",
  "channel": "API",
  "exported_object": "voucher_transactions",
  "parameters": {
    "fields": [
      "id",
      "type",
      "source_id",
      "created_at"
    ],
    "filters": {
      "junction": "AND",
      "created_at": {
        "conditions": {
          "$after": [
            "2024-10-01T00:00:00.000Z"
          ]
        }
      },
      "campaign_id": {
        "conditions": {
          "$in": [
            "camp_5pgKwSKsAeQtFkRz6mfKpxxD"
          ]
        }
      }
    }
  },
  "result": null,
  "user_id": null
}

Export Loyalty Campaign Transactions

deprecated

Legacy loyalty API

This endpoint belongs to the legacy loyalty API (/v1/loyalties).

Voucherify will not develop new features for this API. However, critical issues may still receive fixes.

For new integrations, use Loyalty v2.

If you have questions, contact Voucherify support.

Export transactions is an asynchronous process that generates a CSV file with the data about or point movements on all loyalty cards in a given campaign.

To export transactions:

In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered.
Use the returned id to track the export status with the GET Export method.
In the GET Export method, when the returned status field has the DONE value, the export file has been generated.
Use the URL in the result property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file.

An export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files.

An example export file can look as follows:

Field	Definition	Example Export
`id`	Unique transaction ID.	`vtx_0cb7811f1c07765800`
`type`	Transaction type.	- `POINTS_ACCRUAL` - `POINTS_REDEMPTION` - `POINTS_REFUND` - `POINTS_ADDITION` - `POINTS_REMOVAL` - `POINTS_EXPIRATION` - `POINTS_TRANSFER_IN` - `POINTS_TRANSFER_OUT`
`source_id`	Unique transaction source ID. Optional and only in manual operations: `POINTS_ADDITION`, `POINTS_REMOVAL`, `POINTS_TRANSFER_OUT`.	8638
`reason`	Contains the reason for the transaction if one was included originally. Optional and only in the following manual operations: `POINTS_ADDITION`, `POINTS_REMOVAL`, `POINTS_TRANSFER_OUT`, `POINTS_TRANSFER_IN`.	`Apology for sending a broken item`
`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.	`2024-10-09T09:16:32.521Z`
`voucher_id`	Unique voucher ID.	`v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp`
`source`	Channel through which the transaction was initiated.	`API`
`details`	More detailed information stored in the form of 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`

Export Campaign Transactions

This method works in the same way the POST Export Campaign Transactions does, but it is limited to loyalty campaigns only. The POST Export Campaign Transactions method can also export gift card campaign transactions.

POST

loyalties

{campaignId}

transactions

export

Export Loyalty Campaign Transactions

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/transactions/export \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '
{
  "order": "-created_at",
  "parameters": {
    "fields": [
      "id",
      "type",
      "source_id",
      "created_at"
    ],
    "filters": {
      "created_at": {
        "conditions": {
          "$after": [
            "2024-10-01T00:00:00.000Z"
          ]
        }
      }
    }
  }
}
'

{
  "id": "exp_KBunyG5vwkuF3jSWD03kmnLx",
  "object": "export",
  "created_at": "2024-10-25T14:35:12.019Z",
  "status": "SCHEDULED",
  "channel": "API",
  "exported_object": "voucher_transactions",
  "parameters": {
    "fields": [
      "id",
      "type",
      "source_id",
      "created_at"
    ],
    "filters": {
      "junction": "AND",
      "created_at": {
        "conditions": {
          "$after": [
            "2024-10-01T00:00:00.000Z"
          ]
        }
      },
      "campaign_id": {
        "conditions": {
          "$in": [
            "camp_5pgKwSKsAeQtFkRz6mfKpxxD"
          ]
        }
      }
    }
  },
  "result": null,
  "user_id": null
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Scopes

api

Gives access to whole server-side API.

loyalties

Gives access to all endpoints and methods starting with /v1/loyalties.

Path Parameters

campaignId

string

required

You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

Body

application/json

Specify the parameters for the transaction export.

Request body schema for POST v1/loyalties/{campaignId}/transactions/export.

parameters

Export Campaign Transactions · object

List of available parameters containing fields and filters that can be exported for transactions in a loyalty card campaign, along with the sorting order of the returned data.

Show child attributes

Response

An object representing an export.

Response body schema for POST v1/campaigns/{campaignId}/transactions/export.

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

enum<string>

default:API

required

The channel through which the export was triggered.

Available options:

API

exported_object

enum<string>

default:voucher_transactions

required

The type of exported object.

Available options:

voucher_transactions

parameters

Export Campaign Transactions · object

required

Show child attributes

result

object | null

required

Contains the URL of the CSV file.

Show child attributes

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"

Introduction

Endpoints

Events

Export Loyalty Campaign Transactions

Authorizations

Scopes

Path Parameters

Body

Response