@voucherify/sdk - npm explorer

Official Voucherify JS SDK

👋 Intro

Voucherify is an Incentive Optimization Engine that helps digital teams launch, test, and optimize targeted incentives – from coupons and promotions to loyalty programs and personalized offers – all with API.

We build Voucherify so you can run fewer incentives, but better ones.

Launch fast.

Test every day.

Drop what doesn’t work.

And optimize what does.

Integrate easily with your existing stack to make experimentation and optimization effortless.

📝 Useful info

This SDK is automatically generated by the OpenAPI Generator based on Voucherify API reference, v2018-08-01 version.

If needed, visit the legacy JS SDK

For more info, visit those places:
- ✅ Supported endpoints.
- 📘 API docs.
- 🧑‍🍳 Promotion cookbook.
- 💬 Help center.
- 🐛 Caught a bug? Add an issue!
- 🧑‍💻 Need help? Contact support.

🔄 JS SDK versions: v2 and v3

The v2 and v3 JS SDK version differ in:

- Language and generation:
- v2: hand-written in TypeScript.
- v3: auto-generated from the OpenAPI definition and written in JavaScript.
- Types:
- v2: built-in TypeScript types.
- v3: Includes built-in TypeScript definitions (starting from v3.0.1). Although written in JS, the SDK now ships with type declarations generated from JSDoc. Each generated model/class also exposes a validateJSON method to verify data shape/types at runtime.
- Client creation and auth:
- v2: different client initialization and API key handling.
- v3: a new way to configure the API client and provide API keys (see Get your keys and address and Run code).
- API coverage:
- v2: limited and historically maintained.
- v3: supports all non-deprecated endpoints. We strongly recommend using v3.

$3

To migrate from v2 to v3:

- Install: you can install v3 under an alias to migrate gradually (see Install section).
- Initialization: update client creation and key/basePath setup as shown in Run code.
- Types: ensure you are using v3.0.1 or later to leverage the included TypeScript definitions automatically. You no longer need to create custom .d.ts files. You can still use the models’ validateJSON methods for extra runtime validation.
- Endpoints: review ENDPOINTS-COVERAGE.md and switch calls to their v3 equivalents. Avoid deprecated endpoints — v3 covers active ones only.

⚙️ Install

Use any of the following methods to install the SDK.

$3

To install the SDK, run:

``shell npm install @voucherify/sdk --save`

If you’re still using the previous SDK (v2.x.x), you can install the new version under a different alias, for example:

`shell npm install @voucherify/newsdk@npm:@voucherify/sdk@^3.0.0`

`🔒 Get your keys and address`

Get your Voucherify keys for valid authorization and setting the basePath (cluster) to match your server URL: 1. In Voucherify dashboard, go to Project settings. 2. In Application information, find your basePath (cluster) address. For shared clusters: - Europe (default):https://api.voucherify.io- United States:https://us1.api.voucherify.io- Asia (Singapore):https://as1.api.voucherify.io3. Scroll down to Application Keys to grab your Application ID and Secret key.

`🚀 Run code`

Once installed, run:

`typescript import * as Voucherify from "@voucherify/sdk";

// Note: dotenv is an external library used for demonstration purposes only. It is not required. import dotenv from "dotenv"; dotenv.config();

const apiClient = Voucherify.ApiClient.instance;

const HOST = process.env.VOUCHERIFY_HOST || "https://api.voucherify.io"; const X_APP_ID = process.env.X_APP_ID; const X_APP_TOKEN = process.env.X_APP_TOKEN;

apiClient.basePath = HOST; apiClient.authentications["X-App-Id"].apiKey = X_APP_ID; apiClient.authentications["X-App-Token"].apiKey = X_APP_TOKEN;

const api = new Voucherify.CampaignsApi(apiClient);

const options = { filters: Voucherify.ParameterFiltersListCampaigns.constructFromObject({ junction: "and", campaign_status: Voucherify.ParameterFiltersListCampaignsCampaignStatus.constructFromObject( { conditions: Voucherify.ParameterFiltersListCampaignsCampaignStatusConditions.constructFromObject( { $in: ["DONE"], }, ), }, ), }), };

const callback = function ( error: Error | null, data?: Voucherify.CampaignsListResponseBody, response?: any, ) { if (error) { console.error(error); } else { console.log( "API called successfully. Returned data: " + JSON.stringify(data, null, 2), ); } };

// Example with callback: api.listCampaigns(options, callback);

// Example with promise: api.listCampaigns(options).then((response) => console.log(response));`

> [!NOTE] > > This code just lists campaigns, so it won't affect your Voucherify data.

Once set up, check the following methods to give Voucherify a more interesting spin: - Validations - Redemptions - Publications

> [!TIP] > > Check the test implementation in the Test folder.

`🐳 Run local tests with docker`

To run tests locally with docker: 1. Copy.env.example to .envand fill in the values. 2. Rundocker build -t js .to build the image. 3. Rundocker run --rm js to run the tests and delete the container immediately after.

`🛠️ Contribute`

Do you want to contribute?

Read more about how to contribute to this SDK in the Contributing guide in the main repo.

This SDK is auto-generated (except for tests), so changes made here will be overwritten by the generator.

`🏷️ Link tags`

OpenAPI generated from tag.

`🔐 Authorization`

Authorization schemes defined for the API.

`$3`

- Type: API key - API key parameter name: X-App-Id - Location: HTTP header

`$3`

- Type: API key - API key parameter name: X-App-Token - Location: HTTP header

`$3`

- Type: API key - API key parameter name: X-Client-Token - Location: HTTP header

`$3`

- Type: API key - API key parameter name: X-Client-Application-Id - Location: HTTP header

`$3`

- Type: API key - API key parameter name: X-Management-Id - Location: HTTP header

`$3`

- Type: API key - API key parameter name: X-Management-Token - Location: HTTP header

`$3`

- Type: OAuth - Flow: implicit - Authorization URL: https://api.voucherify.io/v1/oauth/token - Scopes: - api: Gives access to whole server-side API. - vouchers: Gives access to all endpoints and methods starting with `v1/vouchers`. - client_api: Gives access to whole client-side API. - client_vouchers: Gives access to all endpoints and methods starting with `/client/v1/vouchers`. - promotions: Gives access to all endpoints and methods starting with `/v1/promotions`. - client_promotions: Gives access to all endpoints and methods starting with `/client/v1/promotions` - campaigns: Gives access to all endpoints and methods starting with `v1/campaigns`. - client_publish: Gives access to all endpoints and methods starting with `/client/v1/publish`. - exports: Gives access to all endpoints and methods starting with `/v1/exports`. - publications: Gives access to all endpoints and methods starting with `/v1/publications`. - client_validate: Gives access to all endpoints and methods starting with `/client/v1/validate`. - validations: Gives access to all endpoints and methods starting with `/v1/validations`. - client_validations: Gives access to all endpoints and methods starting with `/client/v1/validations`. - qualifications: Gives access to all endpoints and methods starting with `/v1/qualifications`. - client_qualifications: Gives access to all endpoints and methods starting with `/client/v1/qualifications`. - client_redeem: Gives access to all endpoints and methods starting with `/client/v1/redeem - redemptions: Gives access to all endpoints and methods starting with `/v1/redemptions`. - client_redemptions: Gives access to all endpoints and methods starting with `/client/v1/redemptions` - customers: Gives access to all endpoints and methods starting with `/v1/customers`. - client_customers: Gives access to all endpoints and methods starting with `/client/v1/customers`. - orders: Gives access to all endpoints and methods starting with `/v1/orders`. - products: Gives access to all endpoints and methods starting with `/v1/products`. - skus: Gives access to all endpoints and methods starting with `/v1/SKUs`. - validation-rules: Gives access to all endpoints and methods starting with `/v1/validation-rules`. - validation-rules-assignments: Gives access to all endpoints and methods starting with `/v1/validation-rules-assignments - segments: Gives access to all endpoints and methods starting with `/v1/segments`. - events: Gives access to all endpoints and methods starting with `/v1/events`. - client_events: Gives access to all endpoints and methods starting with `client/v1/events`. - rewards: Gives access to all endpoints and methods starting with `/v1/rewards`. - assets: Gives access to all endpoints and methods starting with `/v1/assets`. - task-results: Gives access to all endpoints and methods starting with `/v1/task-results`. - loyalties: Gives access to all endpoints and methods starting with `/v1/loyalties`. - client_consents: Gives access to all endpoints and methods starting with `client/v1/consents`. - consents: Gives access to all endpoints and methods starting with `/v1/consents`. - async-actions: Gives access to all endpoints and methods starting with `/v1/async-actions`. - product-collections: Gives access to all endpoints and methods starting with `/v1/product-collections`. - categories: Gives access to all endpoints and methods starting with `/v1/categories`. - metadata-schemas: Gives access to all endpoints and methods starting with `/v1/metadata-schemas`. - locations: Gives access to all endpoints and methods starting with `/v1/locations`. - referrals: Gives access to all endpoints and methods starting with `/v1/referrals`. - trash-bin: Gives access to all endpoints and methods starting with `/v1/trash-bin`. - templates: Gives access to all endpoints and methods starting with `/v1/templates`.

`📅 Changelog`

- 2025-12-31 - 3.0.2: - Added theAUTO_UPDATE enum value to the type property in the ProductCollectionsCreateRequestBodymodel. - Added support for the newfilters query parameter in the listVouchers method of VouchersApi(GET /v1/vouchers). - 2025-11-24 -3.0.1- Introduced native TypeScript type definitions generated from JSDoc, enabling automatic type inference and IDE autocompletion. - 2025-11-05 -3.0.0` - The new version of the SDK includes coverage for all the most commonly used Voucherify endpoints and supports typed models.

Previous versions of the SDK are no longer supported. We highly recommend upgrading to version 3.0.0 or newer, as it is now designated as Long-Term Support (LTS).

Changelog for previous versions is in the DEPRECATED_CHANGELOG.md file

🌐 Documentation of API endpoints

All URIs are relative to https://{cluster}.api.voucherify.io

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
Voucherify.AsyncActionsApi | getAsyncAction | GET /v1/async-actions/{asyncActionId} | Get Async Action
Voucherify.AsyncActionsApi | listAsyncActions | GET /v1/async-actions | List Async Actions
Voucherify.BinApi | deleteBinEntry | DELETE /v1/trash-bin/{binEntryId} | Delete Bin Entry
Voucherify.BinApi | listBinEntries | GET /v1/trash-bin | List Bin Entries
Voucherify.CampaignsApi | addVoucherWithSpecificCodeToCampaign | POST /v1/campaigns/{campaignId}/vouchers/{code} | Add Voucher with Specific Code to Campaign
Voucherify.CampaignsApi | addVouchersToCampaign | POST /v1/campaigns/{campaignId}/vouchers | Add Vouchers to Campaign
Voucherify.CampaignsApi | createCampaign | POST /v1/campaigns | Create Campaign
Voucherify.CampaignsApi | deleteCampaign | DELETE /v1/campaigns/{campaignId} | Delete Campaign
Voucherify.CampaignsApi | disableCampaign | POST /v1/campaigns/{campaignId}/disable | Disable Campaign
Voucherify.CampaignsApi | enableCampaign | POST /v1/campaigns/{campaignId}/enable | Enable Campaign
Voucherify.CampaignsApi | exportCampaignTransactions | POST /v1/campaigns/{campaignId}/transactions/export | Export Campaign Transactions
Voucherify.CampaignsApi | getCampaign | GET /v1/campaigns/{campaignId} | Get Campaign
Voucherify.CampaignsApi | getCampaignSummary | GET /v1/campaigns/{campaignId}/summary | Get Campaign Summary
Voucherify.CampaignsApi | importVouchersToCampaign | POST /v1/campaigns/{campaignId}/import | Import Vouchers to Campaign
Voucherify.CampaignsApi | importVouchersToCampaignUsingCsv | POST /v1/campaigns/{campaignId}/importCSV | Import Vouchers to Campaign by CSV
Voucherify.CampaignsApi | listCampaignTransactions | GET /v1/campaigns/{campaignId}/transactions | List Campaign Transactions
Voucherify.CampaignsApi | listCampaigns | GET /v1/campaigns | List Campaigns
Voucherify.CampaignsApi | updateCampaign | PUT /v1/campaigns/{campaignId} | Update Campaign
Voucherify.CategoriesApi | createCategory | POST /v1/categories | Create Category
Voucherify.CategoriesApi | deleteCategory | DELETE /v1/categories/{categoryId} | Delete Category
Voucherify.CategoriesApi | getCategory | GET /v1/categories/{categoryId} | Get Category
Voucherify.CategoriesApi | listCategories | GET /v1/categories | List Categories
Voucherify.CategoriesApi | updateCategory | PUT /v1/categories/{categoryId} | Update Category
Voucherify.ClientSideApi | checkEligibilityClientSide | POST /client/v1/qualifications | Check Eligibility (client-side)
Voucherify.ClientSideApi | listPromotionTiersClientSide | GET /client/v1/promotions/tiers | List Promotion Tiers (client-side)
Voucherify.ClientSideApi | redeemStackedDiscountsClientSide | POST /client/v1/redemptions | Redeem Stackable Discounts (client-side)
Voucherify.ClientSideApi | trackCustomEventClientSide | POST /client/v1/events | Track Custom Event (client-side)
Voucherify.ClientSideApi | validateStackedDiscountsClientSide | POST /client/v1/validations | Validate Stackable Discounts (client-side)
Voucherify.CustomersApi | createCustomer | POST /v1/customers | Create Customer
Voucherify.CustomersApi | customerPermanentlyDeletion | POST /v1/customers/{customerId}/permanent-deletion | Delete Customer Permanently
Voucherify.CustomersApi | deleteCustomer | DELETE /v1/customers/{customerId} | Delete Customer
Voucherify.CustomersApi | getCustomer | GET /v1/customers/{customerId} | Get Customer
Voucherify.CustomersApi | importCustomersUsingCsv | POST /v1/customers/importCSV | Import and Update Customers using CSV
Voucherify.CustomersApi | listCustomerActivity | GET /v1/customers/{customerId}/activity | List Customer Activity
Voucherify.CustomersApi | listCustomerRedeemables | GET /v1/customers/{customerId}/redeemables | List Customer's Redeemables
Voucherify.CustomersApi | listCustomerSegments | GET /v1/customers/{customerId}/segments | List Customer's Segments
Voucherify.CustomersApi | listCustomers | GET /v1/customers | List Customers
Voucherify.CustomersApi | updateCustomer | PUT /v1/customers/{customerId} | Update Customer
Voucherify.CustomersApi | updateCustomersInBulk | POST /v1/customers/bulk/async | Update Customers in Bulk
Voucherify.CustomersApi | updateCustomersMetadataInBulk | POST /v1/customers/metadata/async | Update Customers' Metadata in Bulk
Voucherify.EventsApi | trackCustomEvent | POST /v1/events | Track Custom Event
Voucherify.ExportsApi | createExport | POST /v1/exports | Create Export
Voucherify.ExportsApi | deleteExport | DELETE /v1/exports/{exportId} | Delete Export
Voucherify.ExportsApi | downloadExport | GET /v1/exports/{export_Id} | Download Export
Voucherify.ExportsApi | getExport | GET /v1/exports/{exportId} | Get Export
Voucherify.ExportsApi | listExports | GET /v1/exports | List Exports
Voucherify.LocationsApi | getLocation | GET /v1/locations/{locationId} | Get Location
Voucherify.LocationsApi | listLocations | GET /v1/locations | List Locations
Voucherify.LoyaltiesApi | activateMemberPendingPoints | POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate | Activate Member Pending Points
Voucherify.LoyaltiesApi | addMember | POST /v1/loyalties/{campaignId}/members | Add Member
Voucherify.LoyaltiesApi | adjustMemberPendingPoints | POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance | Adjust Member Pending Points
Voucherify.LoyaltiesApi | cancelMemberPendingPoints | POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel | Cancel Member Pending Points
Voucherify.LoyaltiesApi | createEarningRule | POST /v1/loyalties/{campaignId}/earning-rules | Create Earning Rule
Voucherify.LoyaltiesApi | createInBulkLoyaltyTiers | POST /v1/loyalties/{campaignId}/tiers | Create loyalty tiers
Voucherify.LoyaltiesApi | createLoyaltyProgram | POST /v1/loyalties | Create Loyalty Campaign
Voucherify.LoyaltiesApi | createPointsExpirationExport | POST /v1/loyalties/{campaignId}/points-expiration/export | Export Loyalty Campaign Point Expiration
Voucherify.LoyaltiesApi | createRewardAssignment1 | POST /v1/loyalties/{campaignId}/rewards | Create Loyalty Campaign Reward Assignment
Voucherify.LoyaltiesApi | deleteEarningRule | DELETE /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Delete Earning Rule
Voucherify.LoyaltiesApi | deleteLoyaltyProgram | DELETE /v1/loyalties/{campaignId} | Delete Loyalty Campaign
Voucherify.LoyaltiesApi | deleteRewardAssignment1 | DELETE /v1/loyalties/{campaignId}/rewards/{assignmentId} | Delete Campaign Reward Assignment
Voucherify.LoyaltiesApi | disableEarningRule | POST /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | Disable Earning Rule
Voucherify.LoyaltiesApi | enableEarningRule | POST /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | Enable Earning Rule
Voucherify.LoyaltiesApi | exportLoyaltyCampaignTransactions | POST /v1/loyalties/{campaignId}/transactions/export | Export Loyalty Campaign Transactions
Voucherify.LoyaltiesApi | exportLoyaltyCardTransactions | POST /v1/loyalties/members/{memberId}/transactions/export | Export Loyalty Card Transactions
Voucherify.LoyaltiesApi | exportLoyaltyCardTransactions1 | POST /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | Export Loyalty Card Transactions with campaign ID
Voucherify.LoyaltiesApi | getEarningRule | GET /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Get Earning Rule
Voucherify.LoyaltiesApi | getLoyaltyProgram | GET /v1/loyalties/{campaignId} | Get Loyalty Campaign
Voucherify.LoyaltiesApi | getLoyaltyTier | GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | Get Loyalty Tier
Voucherify.LoyaltiesApi | getMember | GET /v1/loyalties/members/{memberId} | Get Member
Voucherify.LoyaltiesApi | getMember1 | GET /v1/loyalties/{campaignId}/members/{memberId} | Get Member with campaign ID
Voucherify.LoyaltiesApi | getRewardAssignment1 | GET /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | Get Campaign Reward Assignments
Voucherify.LoyaltiesApi | getRewardAssignment2 | GET /v1/loyalties/{campaignId}/rewards/{assignmentId} | Get Campaign Reward Assignment
Voucherify.LoyaltiesApi | getRewardDetails | GET /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | Get Reward Details
Voucherify.LoyaltiesApi | listCampaignPendingPoints | GET /v1/loyalties/{campaignId}/pending-points | List Campaign Pending Points
Voucherify.LoyaltiesApi | listEarningRules | GET /v1/loyalties/{campaignId}/earning-rules | List Earning Rules
Voucherify.LoyaltiesApi | listLoyaltyCampaignTransactions | GET /v1/loyalties/{campaignId}/transactions | List Loyalty Campaign Transactions
Voucherify.LoyaltiesApi | listLoyaltyCardTransactions | GET /v1/loyalties/members/{memberId}/transactions | List Loyalty Card Transactions
Voucherify.LoyaltiesApi | listLoyaltyCardTransactions1 | GET /v1/loyalties/{campaignId}/members/{memberId}/transactions | List Loyalty Card Transactions with campaign ID
Voucherify.LoyaltiesApi | listLoyaltyPrograms | GET /v1/loyalties | List Loyalty Campaigns
Voucherify.LoyaltiesApi | listLoyaltyTierEarningRules | GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | List Loyalty Tier Earning Rules
Voucherify.LoyaltiesApi | listLoyaltyTierRewards | GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | List Loyalty Tier Rewards
Voucherify.LoyaltiesApi | listLoyaltyTiers | GET /v1/loyalties/{campaignId}/tiers | List Loyalty Tiers
Voucherify.LoyaltiesApi | listMemberActivity | GET /v1/loyalties/members/{memberId}/activity | List Member Activity
Voucherify.LoyaltiesApi | listMemberActivity1 | GET /v1/loyalties/{campaignId}/members/{memberId}/activity | List Member Activity with campaign ID
Voucherify.LoyaltiesApi | listMemberLoyaltyTier | GET /v1/loyalties/members/{memberId}/tiers | List Member's Loyalty Tiers
Voucherify.LoyaltiesApi | listMemberPendingPoints | GET /v1/loyalties/members/{memberId}/pending-points | List Member Pending Points
Voucherify.LoyaltiesApi | listMemberPendingPoints1 | GET /v1/loyalties/{campaignId}/members/{memberId}/pending-points | List Member Pending Points with campaign ID
Voucherify.LoyaltiesApi | listMemberRewards | GET /v1/loyalties/members/{memberId}/rewards | List Member Rewards
Voucherify.LoyaltiesApi | listMembers | GET /v1/loyalties/{campaignId}/members | List Members
Voucherify.LoyaltiesApi | listPointsExpiration | GET /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | List Loyalty Card Point Expiration
Voucherify.LoyaltiesApi | listRewardAssignments1 | GET /v1/loyalties/{campaignId}/reward-assignments | List Reward Assignments with campaign ID
Voucherify.LoyaltiesApi | listRewardAssignments2 | GET /v1/loyalties/{campaignId}/rewards | List Campaign Rewards
Voucherify.LoyaltiesApi | redeemReward | POST /v1/loyalties/members/{memberId}/redemption | Redeem Reward
Voucherify.LoyaltiesApi | redeemReward1 | POST /v1/loyalties/{campaignId}/members/{memberId}/redemption | Redeem Reward with campaign ID
Voucherify.LoyaltiesApi | transferPoints | POST /v1/loyalties/{campaignId}/members/{memberId}/transfers | Transfer Loyalty Points
Voucherify.LoyaltiesApi | updateEarningRule | PUT /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Update Earning Rule
Voucherify.LoyaltiesApi | updateLoyaltyCardBalance | POST /v1/loyalties/members/{memberId}/balance | Adjust Loyalty Card Balance
Voucherify.LoyaltiesApi | updateLoyaltyCardBalance1 | POST /v1/loyalties/{campaignId}/members/{memberId}/balance | Adjust Loyalty Card Balance with campaign ID
Voucherify.LoyaltiesApi | updateLoyaltyProgram | PUT /v1/loyalties/{campaignId} | Update Loyalty Campaign
Voucherify.LoyaltiesApi | updateRewardAssignment1 | PUT /v1/loyalties/{campaignId}/rewards/{assignmentId} | Update Campaign Reward Assignment
Voucherify.ManagementApi | assignUser | POST /management/v1/projects/{projectId}/users | Assign User
Voucherify.ManagementApi | createBrand | POST /management/v1/projects/{projectId}/branding | Create Brand
Voucherify.ManagementApi | createCustomEventSchema | POST /management/v1/projects/{projectId}/custom-event-schemas | Create Custom Event Schema
Voucherify.ManagementApi | createMetadataSchema | POST /management/v1/projects/{projectId}/metadata-schemas | Create Metadata Schema
Voucherify.ManagementApi | createProject | POST /management/v1/projects | Create Project
Voucherify.ManagementApi | createStackingRules | POST /management/v1/projects/{projectId}/stacking-rules | Create Stacking Rules
Voucherify.ManagementApi | createWebhook | POST /management/v1/projects/{projectId}/webhooks | Create Webhook
Voucherify.ManagementApi | deleteBrand | DELETE /management/v1/projects/{projectId}/branding/{brandingId} | Delete Brand
Voucherify.ManagementApi | deleteCustomEventSchema | DELETE /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Delete Custom Event Schema
Voucherify.ManagementApi | deleteMetadataSchema | DELETE /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Delete Metadata Schema
Voucherify.ManagementApi | deleteProject | DELETE /management/v1/projects/{projectId} | Delete Project
Voucherify.ManagementApi | deleteStackingRules | DELETE /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Delete Stacking Rules
Voucherify.ManagementApi | deleteWebhook | DELETE /management/v1/projects/{projectId}/webhooks/{webhookId} | Delete Webhook
Voucherify.ManagementApi | getBrand | GET /management/v1/projects/{projectId}/branding/{brandingId} | Get Brand
Voucherify.ManagementApi | getCustomEventSchema | GET /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Get Custom Event Schema
Voucherify.ManagementApi | getMetadataSchema1 | GET /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Get Metadata Schema
Voucherify.ManagementApi | getProject | GET /management/v1/projects/{projectId} | Get Project
Voucherify.ManagementApi | getStackingRules | GET /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Get Stacking Rules
Voucherify.ManagementApi | getUser | GET /management/v1/projects/{projectId}/users/{userId} | Get User
Voucherify.ManagementApi | getWebhook | GET /management/v1/projects/{projectId}/webhooks/{webhookId} | Get Webhook
Voucherify.ManagementApi | inviteUser | POST /management/v1/projects/users/invite | Invite a New User
Voucherify.ManagementApi | listBrands | GET /management/v1/projects/{projectId}/branding | List Brands
Voucherify.ManagementApi | listCustomEventSchemas | GET /management/v1/projects/{projectId}/custom-event-schemas | List Custom Event Schemas
Voucherify.ManagementApi | listMetadataSchemas1 | GET /management/v1/projects/{projectId}/metadata-schemas | List Metadata Schemas
Voucherify.ManagementApi | listProjects | GET /management/v1/projects | List Projects
Voucherify.ManagementApi | listStackingRules | GET /management/v1/projects/{projectId}/stacking-rules | List Stacking Rules
Voucherify.ManagementApi | listUsers | GET /management/v1/projects/{projectId}/users | List Users
Voucherify.ManagementApi | listWebhooks | GET /management/v1/projects/{projectId}/webhooks | List Webhooks
Voucherify.ManagementApi | managementCopyCampaignTemplate | POST /management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy | Copy Campaign Template to a Project
Voucherify.ManagementApi | managementListCampaignTemplates | GET /management/v1/projects/{projectId}/templates/campaigns | List Campaign Templates
Voucherify.ManagementApi | unassignUser | DELETE /management/v1/projects/{projectId}/users/{userId} | Unassign User
Voucherify.ManagementApi | updateBrand | PUT /management/v1/projects/{projectId}/branding/{brandingId} | Update Brand
Voucherify.ManagementApi | updateCustomEventSchema | PUT /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | Update Custom Event Schema
Voucherify.ManagementApi | updateMetadataSchema | PUT /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | Update Metadata Schema
Voucherify.ManagementApi | updateProject | PUT /management/v1/projects/{projectId} | Update Project
Voucherify.ManagementApi | updateStackingRules | PUT /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | Update Stacking Rules
Voucherify.ManagementApi | updateUser | PUT /management/v1/projects/{projectId}/users/{userId} | Update User
Voucherify.ManagementApi | updateWebhook | PUT /management/v1/projects/{projectId}/webhooks/{webhookId} | Update Webhook
Voucherify.MetadataSchemasApi | getMetadataSchema | GET /v1/metadata-schemas/{resource} | Get Metadata Schema
Voucherify.MetadataSchemasApi | listMetadataSchemas | GET /v1/metadata-schemas | List Metadata Schema Definitions
Voucherify.OAuthApi | generateOauthToken | POST /v1/oauth/token | Generate OAuth 2.0 Token
Voucherify.OAuthApi | introspectOauthToken | POST /v1/oauth/introspect | Introspect OAuth 2.0 Token
Voucherify.OAuthApi | revokeOauthToken | POST /v1/oauth/token/revoke | Revoke OAuth 2.0 Token
Voucherify.OrdersApi | createOrder | POST /v1/orders | Create Order
Voucherify.OrdersApi | createOrderExport | POST /v1/orders/export | Create Orders Export
Voucherify.OrdersApi | getOrder | GET /v1/orders/{orderId} | Get Order
Voucherify.OrdersApi | importOrders | POST /v1/orders/import | Import Orders
Voucherify.OrdersApi | listOrders | GET /v1/orders | List Orders
Voucherify.OrdersApi | updateOrder | PUT /v1/orders/{orderId} | Update Order
Voucherify.ProductCollectionsApi | createProductCollection | POST /v1/product-collections | Create Product Collection
Voucherify.ProductCollectionsApi | deleteProductCollection | DELETE /v1/product-collections/{productCollectionId} | Delete Product Collection
Voucherify.ProductCollectionsApi | getProductCollection | GET /v1/product-collections/{productCollectionId} | Get Product Collection
Voucherify.ProductCollectionsApi | listProductCollections | GET /v1/product-collections | List Product Collections
Voucherify.ProductCollectionsApi | listProductsInCollection | GET /v1/product-collections/{productCollectionId}/products | List Products in Collection
Voucherify.ProductsApi | createProduct | POST /v1/products | Create Product
Voucherify.ProductsApi | createSku | POST /v1/products/{productId}/skus | Create SKU
Voucherify.ProductsApi | deleteProduct | DELETE /v1/products/{productId} | Delete Product
Voucherify.ProductsApi | deleteSku | DELETE /v1/products/{productId}/skus/{skuId} | Delete SKU
Voucherify.ProductsApi | getProduct | GET /v1/products/{productId} | Get Product
Voucherify.ProductsApi | getSku | GET /v1/skus/{skuId} | Get SKU
Voucherify.ProductsApi | importProductsUsingCsv | POST /v1/products/importCSV | Import Products using CSV
Voucherify.ProductsApi | importSKUsUsingCsv | POST /v1/skus/importCSV | Import SKUs using CSV
Voucherify.ProductsApi | listProducts | GET /v1/products | List Products
Voucherify.ProductsApi | listSKUsInProduct | GET /v1/products/{productId}/skus | List SKUs in Product
Voucherify.ProductsApi | updateProduct | PUT /v1/products/{productId} | Update Product
Voucherify.ProductsApi | updateProductsInBulk | POST /v1/products/bulk/async | Update Products in Bulk
Voucherify.ProductsApi | updateProductsMetadataInBulk | POST /v1/products/metadata/async | Update Products' Metadata in Bulk
Voucherify.ProductsApi | updateSku | PUT /v1/products/{productId}/skus/{skuId} | Update SKU
Voucherify.PromotionsApi | addPromotionTierToCampaign | POST /v1/promotions/{campaignId}/tiers | Add Promotion Tier to Campaign
Voucherify.PromotionsApi | createPromotionStack | POST /v1/promotions/{campaignId}/stacks | Create Promotion Stack
Voucherify.PromotionsApi | deletePromotionStack | DELETE /v1/promotions/{campaignId}/stacks/{stackId} | Delete Promotion Stack
Voucherify.PromotionsApi | deletePromotionTier | DELETE /v1/promotions/tiers/{promotionTierId} | Delete Promotion Tier
Voucherify.PromotionsApi | disablePromotionTier | POST /v1/promotions/tiers/{promotionTierId}/disable | Disable Promotion Tier
Voucherify.PromotionsApi | enablePromotionTier | POST /v1/promotions/tiers/{promotionTierId}/enable | Enable Promotion Tier
Voucherify.PromotionsApi | getPromotionStack | GET /v1/promotions/{campaignId}/stacks/{stackId} | Get Promotion Stack
Voucherify.PromotionsApi | getPromotionTier | GET /v1/promotions/tiers/{promotionTierId} | Get Promotion Tier
Voucherify.PromotionsApi | listAllPromotionStacks | GET /v1/promotions/stacks | List Promotion Stacks
Voucherify.PromotionsApi | listPromotionStacksInCampaign | GET /v1/promotions/{campaignId}/stacks | List Promotion Stacks in Campaign
Voucherify.PromotionsApi | listPromotionTiers | GET /v1/promotions/tiers | List Promotion Tiers
Voucherify.PromotionsApi | listPromotionTiersFromCampaign | GET /v1/promotions/{campaignId}/tiers | List Promotion Tiers from Campaign
Voucherify.PromotionsApi | updatePromotionStack | PUT /v1/promotions/{campaignId}/stacks/{stackId} | Update Promotion Stack
Voucherify.PromotionsApi | updatePromotionTier | PUT /v1/promotions/tiers/{promotionTierId} | Update Promotion Tier
Voucherify.PublicationsApi | createPublication | POST /v1/publications | Create Publication
Voucherify.PublicationsApi | createPublication1 | GET /v1/publications/create | Create Publication with GET
Voucherify.PublicationsApi | listPublications | GET /v1/publications | List Publications
Voucherify.QualificationsApi | checkEligibility | POST /v1/qualifications | Check Eligibility
Voucherify.RedemptionsApi | getRedemption | GET /v1/redemptions/{redemptionId} | Get Redemption
Voucherify.RedemptionsApi | getVoucherRedemptions | GET /v1/vouchers/{code}/redemption | Get Voucher's Redemptions
Voucherify.RedemptionsApi | listRedemptions | GET /v1/redemptions | List Redemptions
Voucherify.RedemptionsApi | redeemStackedDiscounts | POST /v1/redemptions | Redeem Stackable Discounts
Voucherify.RedemptionsApi | rollbackRedemption | POST /v1/redemptions/{redemptionId}/rollback | Rollback Redemption
Voucherify.RedemptionsApi | rollbackStackedRedemptions | POST /v1/redemptions/{parentRedemptionId}/rollbacks | Rollback Stackable Redemptions
Voucherify.ReferralsApi | referralsAddHolders | POST /v1/referrals/members/{memberId}/holders | Add Referral Code Holders
Voucherify.ReferralsApi | referralsAddHolders1 | POST /v1/referrals/{campaignId}/members/{memberId}/holders | Add Referral Code Holders with Campaign ID
Voucherify.ReferralsApi | referralsCodeHolders | GET /v1/referrals/{campaignId}/members/{memberId}/holders | List Referral Code Holders with campaign ID
Voucherify.ReferralsApi | referralsCodeHolders1 | GET /v1/referrals/members/{memberId}/holders | List Referral Code Holders
Voucherify.ReferralsApi | referralsRemoveHolder | DELETE /v1/referrals/members/{memberId}/holders/{holderId} | Remove Referral Card Holder
Voucherify.ReferralsApi | referralsRemoveHolder1 | DELETE /v1/referrals/{campaignId}/members/{memberId}/holders/{holderId} | Remove Referral Card Holder with campaign ID
Voucherify.RewardsApi | createReward | POST /v1/rewards | Create Reward
Voucherify.RewardsApi | createRewardAssignment | POST /v1/rewards/{rewardId}/assignments | Create Reward Assignment
Voucherify.RewardsApi | deleteReward | DELETE /v1/rewards/{rewardId} | Delete Reward
Voucherify.RewardsApi | deleteRewardAssignment | DELETE /v1/rewards/{rewardId}/assignments/{assignmentId} | Delete Reward Assignment
Voucherify.RewardsApi | getReward | GET /v1/rewards/{rewardId} | Get Reward
Voucherify.RewardsApi | getRewardAssignment | GET /v1/rewards/{rewardId}/assignments/{assignmentId} | Get Reward Assignment
Voucherify.RewardsApi | listRewardAssignments | GET /v1/rewards/{rewardId}/assignments | List Reward Assignments
Voucherify.RewardsApi | listRewards | GET /v1/rewards | List Rewards
Voucherify.RewardsApi | updateReward | PUT /v1/rewards/{rewardId} | Update Reward
Voucherify.RewardsApi | updateRewardAssignment | PUT /v1/rewards/{rewardId}/assignments/{assignmentId} | Update Reward Assignment
Voucherify.SegmentsApi | createSegment | POST /v1/segments | Create Segment
Voucherify.SegmentsApi | deleteSegment | DELETE /v1/segments/{segmentId} | Delete Segment
Voucherify.SegmentsApi | getSegment | GET /v1/segments/{segmentId} | Get Segment
Voucherify.TemplatesApi | addTierFromTemplate | POST /v1/templates/campaigns/{campaignTemplateId}/tier-setup | Add Promotion Tier From Template
Voucherify.TemplatesApi | createCampaignFromTemplate | POST /v1/templates/campaigns/{campaignTemplateId}/campaign-setup | Create Campaign From Template
Voucherify.TemplatesApi | createCampaignTemplate | POST /v1/templates/campaigns | Create Campaign Template
Voucherify.TemplatesApi | deleteCampaignTemplate | DELETE /v1/templates/campaigns/{campaignTemplateId} | Delete Campaign Template
Voucherify.TemplatesApi | getCampaignTemplate | GET /v1/templates/campaigns/{campaignTemplateId} | Get Campaign Template
Voucherify.TemplatesApi | listCampaignTemplates | GET /v1/templates/campaigns | List Campaign Templates
Voucherify.TemplatesApi | updateCampaignTemplate | PUT /v1/templates/campaigns/{campaignTemplateId} | Update Campaign Template
Voucherify.ValidationRulesApi | createValidationRuleAssignment | POST /v1/validation-rules/{validationRuleId}/assignments | Create Validation Rules Assignments
Voucherify.ValidationRulesApi | createValidationRules | POST /v1/validation-rules | Create Validation Rules
Voucherify.ValidationRulesApi | deleteValidationRuleAssignment | DELETE /v1/validation-rules/{validationRuleId}/assignments/{assignmentId} | Delete Validation Rule Assignment
Voucherify.ValidationRulesApi | deleteValidationRules | DELETE /v1/validation-rules/{validationRuleId} | Delete Validation Rule
Voucherify.ValidationRulesApi | getValidationRule | GET /v1/validation-rules/{validationRuleId} | Get Validation Rule
Voucherify.ValidationRulesApi | listValidationRuleAssignments | GET /v1/validation-rules/{validationRuleId}/assignments | List Validation Rule Assignments
Voucherify.ValidationRulesApi | listValidationRules | GET /v1/validation-rules | List Validation Rules
Voucherify.ValidationRulesApi | listValidationRulesAssignments | GET /v1/validation-rules-assignments | List Validation Rules' Assignment(s)
Voucherify.ValidationRulesApi | updateValidationRule | PUT /v1/validation-rules/{validationRuleId} | Update Validation Rule
Voucherify.ValidationsApi | validateStackedDiscounts | POST /v1/validations | Validate Stackable Discounts
Voucherify.VouchersApi | createVoucher | POST /v1/vouchers/{code} | Create Voucher
Voucherify.VouchersApi | deleteVoucher | DELETE /v1/vouchers/{code} | Delete Voucher
Voucherify.VouchersApi | disableVoucher | POST /v1/vouchers/{code}/disable | Disable Voucher
Voucherify.VouchersApi | enableVoucher | POST /v1/vouchers/{code}/enable | Enable Voucher
Voucherify.VouchersApi | exportVoucherTransactions | POST /v1/vouchers/{code}/transactions/export | Export Voucher Transactions
Voucherify.VouchersApi | generateRandomCode | POST /v1/vouchers | Generate Random Code
Voucherify.VouchersApi | getVoucher | GET /v1/vouchers/{code} | Get Voucher
Voucherify.VouchersApi | importVouchers | POST /v1/vouchers/import | Import Vouchers
Voucherify.VouchersApi | importVouchersUsingCsv | POST /v1/vouchers/importCSV | Import Vouchers using CSV
Voucherify.VouchersApi | listVoucherTransactions | GET /v1/vouchers/{code}/transactions | List Voucher Transactions
Voucherify.VouchersApi | listVouchers | GET /v1/vouchers | List Vouchers
Voucherify.VouchersApi | releaseValidationSession | DELETE /v1/vouchers/{code}/sessions/{sessionKey} | Release Validation Session
Voucherify.VouchersApi | updateVoucher | PUT /v1/vouchers/{code} | Update Voucher
Voucherify.VouchersApi | updateVoucherBalance | POST /v1/vouchers/{code}/balance | Adjust Voucher Balance
Voucherify.VouchersApi | updateVouchersInBulk | POST /v1/vouchers/bulk/async | Update Vouchers in Bulk
Voucherify.VouchersApi | updateVouchersMetadataInBulk | POST /v1/vouchers/metadata/async | Update Vouchers' Metadata in Bulk

📚 Documentation of models

Official Voucherify JS SDK

👋 Intro

We build Voucherify so you can run fewer incentives, but better ones.

Launch fast.

Test every day.

Drop what doesn’t work.

And optimize what does.

Integrate easily with your existing stack to make experimentation and optimization effortless.

📝 Useful info

This SDK is automatically generated by the OpenAPI Generator based on Voucherify API reference, v2018-08-01 version.

If needed, visit the legacy JS SDK

🔄 JS SDK versions: v2 and v3

The v2 and v3 JS SDK version differ in:

$3

To migrate from v2 to v3:

⚙️ Install

Use any of the following methods to install the SDK.

$3

To install the SDK, run:

``shell npm install @voucherify/sdk --save`

If you’re still using the previous SDK (v2.x.x), you can install the new version under a different alias, for example:

`shell npm install @voucherify/newsdk@npm:@voucherify/sdk@^3.0.0`

`🔒 Get your keys and address`

`🚀 Run code`

Once installed, run:

`typescript import * as Voucherify from "@voucherify/sdk";

// Note: dotenv is an external library used for demonstration purposes only. It is not required. import dotenv from "dotenv"; dotenv.config();

const apiClient = Voucherify.ApiClient.instance;

const HOST = process.env.VOUCHERIFY_HOST || "https://api.voucherify.io"; const X_APP_ID = process.env.X_APP_ID; const X_APP_TOKEN = process.env.X_APP_TOKEN;

apiClient.basePath = HOST; apiClient.authentications["X-App-Id"].apiKey = X_APP_ID; apiClient.authentications["X-App-Token"].apiKey = X_APP_TOKEN;

const api = new Voucherify.CampaignsApi(apiClient);

// Example with callback: api.listCampaigns(options, callback);

// Example with promise: api.listCampaigns(options).then((response) => console.log(response));`

> [!NOTE] > > This code just lists campaigns, so it won't affect your Voucherify data.

Once set up, check the following methods to give Voucherify a more interesting spin: - Validations - Redemptions - Publications

> [!TIP] > > Check the test implementation in the Test folder.

`🐳 Run local tests with docker`

`🛠️ Contribute`

Do you want to contribute?

Read more about how to contribute to this SDK in the Contributing guide in the main repo.

This SDK is auto-generated (except for tests), so changes made here will be overwritten by the generator.

`🏷️ Link tags`

OpenAPI generated from tag.

`🔐 Authorization`

Authorization schemes defined for the API.

`$3`

- Type: API key - API key parameter name: X-App-Id - Location: HTTP header

`$3`

- Type: API key - API key parameter name: X-App-Token - Location: HTTP header

`$3`

- Type: API key - API key parameter name: X-Client-Token - Location: HTTP header

`$3`

- Type: API key - API key parameter name: X-Client-Application-Id - Location: HTTP header

`$3`

- Type: API key - API key parameter name: X-Management-Id - Location: HTTP header

`$3`

- Type: API key - API key parameter name: X-Management-Token - Location: HTTP header

`$3`

`📅 Changelog`

Previous versions of the SDK are no longer supported. We highly recommend upgrading to version 3.0.0 or newer, as it is now designated as Long-Term Support (LTS).

Changelog for previous versions is in the DEPRECATED_CHANGELOG.md file

🌐 Documentation of API endpoints

All URIs are relative to https://{cluster}.api.voucherify.io