Skip to content

voucherifyio/voucherify-js-sdk

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

330 Commits
.github/workflows
.github/workflows
 
 
.idea
.idea
 
 
.openapi-generator
.openapi-generator
 
 
docs
docs
 
 
packages/react-widget
packages/react-widget
 
 
src
src
 
 
test
test
 
 
.babelrc
.babelrc
 
 
.env.example
.env.example
 
 
.gitignore
.gitignore
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.prettierignore
.prettierignore
 
 
.prettierrc.json
.prettierrc.json
 
 
.travis.yml
.travis.yml
 
 
DEPRECATED_CHANGELOG.md
DEPRECATED_CHANGELOG.md
 
 
Dockerfile
Dockerfile
 
 
ENDPOINTS-COVERAGE.md
ENDPOINTS-COVERAGE.md
 
 
README.md
README.md
 
 
eslint.config.js
eslint.config.js
 
 
git_push.sh
git_push.sh
 
 
jsconfig.json
jsconfig.json
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 
rollup.config.js
rollup.config.js
 
 

Repository files navigation

Official Voucherify JS SDK

Build Status SDK NPM Version SDK NPM Downloads

Voucherify empowers marketers and developers with flexible building blocks to come up with, implement, and track targeted promotional campaigns.

Learn more about Voucherify by visiting our site.

This SDK is automatically generated by the OpenAPI Generator based on our Documentation with v2018-08-01 version.

The legacy version of JS SDK could be found here

📝 Documentation

You will find detailed description and example responses at our official documentation. Most method headers point to more detailed descriptions of arguments you can use.

📚 Want to learn more? Visit our official site or our Success Portal.

👽 Having troubles? Check our Help center.

🧪 Looking for promotion ideas? Check our Cookbook to get an inspiration.

🐛 Encounter a bug? Please file a report in the Issues.

⚙️ Installation

For Node.js

To install the SDK, run:

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:

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

🚀 Running code

Please follow the installation instruction and execute the following JS code:

const Voucherify = require("@voucherify/sdk");

const defaultClient = Voucherify.ApiClient.instance;
// Configure the server url
defaultClient.basePath = "https://{cluster}.api.voucherify.io";
// Configure API key authorization: X-App-Id
const XAppId = defaultClient.authentications["X-App-Id"];
XAppId.apiKey = "YOUR APP ID";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-App-Id.apiKeyPrefix['X-App-Id'] = "Token"
// Configure API key authorization: X-App-Token
const XAppToken = defaultClient.authentications["X-App-Token"];
XAppToken.apiKey = "YOUR APP TOKEN";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-App-Token.apiKeyPrefix['X-App-Token'] = "Token"
// Configure OAuth2 access token for authorization: X-Voucherify-OAuth
const XVoucherifyOAuth = defaultClient.authentications["X-Voucherify-OAuth"];
XVoucherifyOAuth.accessToken = "";

const api = new Voucherify.CampaignsApi(defaultClient);
const callback = function (error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log(
      "API called successfully. Returned data: " +
        JSON.stringify(data, null, 2),
    );
  }
};
api.listCampaigns(undefined, callback);

🛡️ This code does simple campaign list, so it won't affect Your Voucherify data.

🔒 Remember to fill in your Voucherify keys for valid authorization and set the basePath (cluster) to match your server URL.

🐳 Running local tests with docker

  1. Copy .env.example to .env and fill in the values.
  2. Run docker build -t js . to build the image.
  3. Run docker run --rm js to run the tests and delete the container immediately after.

🛠️ Contributing

Read more about how to Contribute to Voucherify JS SDK by visiting main repo GENERATING-SDKS.md

Remember that this SDK is auto generated (except of the tests) so changes made here will be overwritten by generator.

Link tags

OpenAPI generated from tag

📅 Changelog

  • 2024-09-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, and we highly recommend upgrading to version 3.0.0, which is now designated as Long-Term Support (LTS).

Changelog for previous versions could be found in the DEPRECATED_CHANGELOG.md file

Documentation for API Endpoints

All URIs are relative to https://{cluster}.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 for Models

Documentation for Authorization

Authentication schemes defined for the API:

X-App-Id

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

X-App-Token

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

X-Client-Token

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

X-Client-Application-Id

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

X-Management-Id

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

X-Management-Token

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

X-Voucherify-OAuth

  • 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`.

About

Voucherify SDK for JavaScript and node.js – coupons, vouchers, promo codes

voucherifyio.github.io/voucherify-js-sdk/

Topics

typescript widget sdk voucherify

Resources

Readme
Activity
Custom properties

Stars

12 stars

Watchers

6 watching

Forks

17 forks
Report repository

Releases 120

@voucherify/[email protected] Latest
Nov 5, 2025
+ 119 releases

Contributors 23

+ 9 contributors

Languages