Export Loyalty Card Transactions with campaign ID

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/members/{memberId}/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",
      "related_transaction_id"
    ]
  }
}'

{
  "id": "exp_8Fwd6Z8NS67ZH314KRtm5xXE",
  "object": "export",
  "created_at": "2023-03-21T13:50:43.286Z",
  "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"
    ],
    "filters": {
      "voucher_id": {
        "conditions": {
          "$in": [
            "LOYALTY-CARD-2IAoDNF"
          ]
        }
      }
    }
  },
  "result": null,
  "user_id": null
}

Export Loyalty Card Transactions with campaign ID

Export transactions that are associated with point movements on a loyalty card.

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

POST

loyalties

{campaignId}

members

{memberId}

transactions

export

Export Loyalty Card Transactions with campaign ID

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/loyalties/{campaignId}/members/{memberId}/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",
      "related_transaction_id"
    ]
  }
}'

{
  "id": "exp_8Fwd6Z8NS67ZH314KRtm5xXE",
  "object": "export",
  "created_at": "2023-03-21T13:50:43.286Z",
  "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"
    ],
    "filters": {
      "voucher_id": {
        "conditions": {
          "$in": [
            "LOYALTY-CARD-2IAoDNF"
          ]
        }
      }
    }
  },
  "result": null,
  "user_id": null
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Authorization

string

header

required

Path Parameters

campaignId

string

required

Example:

memberId

string

required

Example:

Body

application/json

parameters

object

Show child attributes

Response

string

required

object

enum<string>

default:export

required

Available options:

export

created_at

string<date-time>

required

status

enum<string>

default:SCHEDULED

required

Available options:

SCHEDULED

result

object | null

required

user_id

string

required

exported_object

enum<string>

default:voucher_transactions

required

Available options:

voucher_transactions

channel

string

parameters

object

Show child attributes

Export Loyalty Card Transactions List Loyalty Card Point Expiration

⌘I

Introduction

Endpoints

Events

Export Loyalty Card Transactions with campaign ID

Authorizations

Path Parameters

Body

Response