Voucherify 8.0.1

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package Voucherify --version 8.0.1
                    


                    

                
NuGet\Install-Package Voucherify -Version 8.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Voucherify" Version="8.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Voucherify" Version="8.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Voucherify" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Voucherify --version 8.0.1
                    


                    

                
#r "nuget: Voucherify, 8.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=Voucherify&version=8.0.1
                    


                            Install Voucherify as a Cake Addin
                        

                    

                
#tool nuget:?package=Voucherify&version=8.0.1
                    


                            Install Voucherify as a Cake Tool

Voucherify Java SDK

Official Voucherify SDK for .NET Framework

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 Java 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 inspiration.

๐Ÿ› Encounter a bug? Please file a report in the Issues.

โœ… List of supported endpoints can be found here

<a id="frameworks-supported"></a>

Frameworks supported

  • .NET Core >=1.0
  • .NET Framework >=4.6
  • Mono/Xamarin >=vNext

<a id="dependencies"></a>

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

<a id="installation"></a>

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Voucherify.Api;
using Voucherify.Client;
using Voucherify.Model;

<a id="usage"></a>

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

<a id="getting-started"></a>

๐Ÿš€ Running code

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

using System.Collections.Generic;
using System.Diagnostics;
using Voucherify.Api;
using Voucherify.Client;
using Voucherify.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://api.voucherify.io";
            // Configure API key authorization: X-App-Id
            config.ApiKey.Add("X-App-Id", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("X-App-Id", "Bearer");
            // Configure API key authorization: X-App-Token
            config.ApiKey.Add("X-App-Token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // config.ApiKeyPrefix.Add("X-App-Token", "Bearer");
            // Configure OAuth2 access token for authorization: X-Voucherify-OAuth
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AsyncActionsApi(config);
            var asyncActionId = "asyncActionId_example";  // string | Unique ID of the asynchronous operation.

            try
            {
                // Get Async Action
                AsyncActionGetResponseBody result = apiInstance.GetAsyncAction(asyncActionId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AsyncActionsApi.GetAsyncAction: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

It may be useful to check the test implementation in the folder (./src/Voucherify.Test)

๐Ÿณ Running local tests with docker

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

๐Ÿ› ๏ธ Contributing

Read more about how to Contribute to Voucherify Java 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.

๐Ÿ“… Changelog

  • 2024-05-06 - 8.0.1
    • Added OAuth support for Loyalty Pending Points endpoints.
  • 2024-05-06 - 8.0.0
    • The new version of the SDK includes coverage for all Voucherify endpoints and supports typed models.

Previous versions of the SDK are no longer supported, and we highly recommend upgrading to version 8.0.0, which is now designated as Long-Term Support (LTS).

Changelog for previous versions could be found in the DEPRECATED CHANGELOG file

<a id="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

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

Class Method HTTP request Description
AsyncActionsApi GetAsyncAction GET /v1/async-actions/{asyncActionId} Get Async Action
AsyncActionsApi ListAsyncActions GET /v1/async-actions List Async Actions
BinApi DeleteBinEntry DELETE /v1/trash-bin/{binEntryId} Delete Bin Entry
BinApi ListBinEntries GET /v1/trash-bin List Bin Entries
CampaignsApi AddVoucherWithSpecificCodeToCampaign POST /v1/campaigns/{campaignId}/vouchers/{code} Add Voucher with Specific Code to Campaign
CampaignsApi AddVouchersToCampaign POST /v1/campaigns/{campaignId}/vouchers Add Vouchers to Campaign
CampaignsApi CreateCampaign POST /v1/campaigns Create Campaign
CampaignsApi DeleteCampaign DELETE /v1/campaigns/{campaignId} Delete Campaign
CampaignsApi DisableCampaign POST /v1/campaigns/{campaignId}/disable Disable Campaign
CampaignsApi EnableCampaign POST /v1/campaigns/{campaignId}/enable Enable Campaign
CampaignsApi ExportCampaignTransactions POST /v1/campaigns/{campaignId}/transactions/export Export Campaign Transactions
CampaignsApi GetCampaign GET /v1/campaigns/{campaignId} Get Campaign
CampaignsApi ImportVouchersToCampaign POST /v1/campaigns/{campaignId}/import Import Vouchers to Campaign
CampaignsApi ImportVouchersToCampaignUsingCsv POST /v1/campaigns/{campaignId}/importCSV Import Vouchers to Campaign by CSV
CampaignsApi ListCampaignTransactions GET /v1/campaigns/{campaignId}/transactions List Campaign Transactions
CampaignsApi ListCampaigns GET /v1/campaigns List Campaigns
CampaignsApi UpdateCampaign PUT /v1/campaigns/{campaignId} Update Campaign
CategoriesApi CreateCategory POST /v1/categories Create Category
CategoriesApi DeleteCategory DELETE /v1/categories/{categoryId} Delete Category
CategoriesApi GetCategory GET /v1/categories/{categoryId} Get Category
CategoriesApi ListCategories GET /v1/categories List Categories
CategoriesApi UpdateCategory PUT /v1/categories/{categoryId} Update Category
ClientSideApi CheckEligibilityClientSide POST /client/v1/qualifications Check Eligibility (client-side)
ClientSideApi ListPromotionTiersClientSide GET /client/v1/promotions/tiers List Promotion Tiers (client-side)
ClientSideApi RedeemStackedDiscountsClientSide POST /client/v1/redemptions Redeem Stackable Discounts (client-side)
ClientSideApi TrackCustomEventClientSide POST /client/v1/events Track Custom Event (client-side)
ClientSideApi ValidateStackedDiscountsClientSide POST /client/v1/validations Validate Stackable Discounts (client-side)
CustomersApi CreateCustomer POST /v1/customers Create Customer
CustomersApi CustomerPermanentlyDeletion POST /v1/customers/{customerId}/permanent-deletion Delete Customer Permanently
CustomersApi DeleteCustomer DELETE /v1/customers/{customerId} Delete Customer
CustomersApi GetCustomer GET /v1/customers/{customerId} Get Customer
CustomersApi ImportCustomersUsingCsv POST /v1/customers/importCSV Import and Update Customers using CSV
CustomersApi ListCustomerActivity GET /v1/customers/{customerId}/activity List Customer Activity
CustomersApi ListCustomerRedeemables GET /v1/customers/{customerId}/redeemables List Customer's Redeemables
CustomersApi ListCustomerSegments GET /v1/customers/{customerId}/segments List Customer's Segments
CustomersApi ListCustomers GET /v1/customers List Customers
CustomersApi UpdateCustomer PUT /v1/customers/{customerId} Update Customer
CustomersApi UpdateCustomersInBulk POST /v1/customers/bulk/async Update Customers in Bulk
CustomersApi UpdateCustomersMetadataInBulk POST /v1/customers/metadata/async Update Customers' Metadata in Bulk
EventsApi TrackCustomEvent POST /v1/events Track Custom Event
ExportsApi CreateExport POST /v1/exports Create Export
ExportsApi DeleteExport DELETE /v1/exports/{exportId} Delete Export
ExportsApi DownloadExport GET /v1/exports/{export_Id} Download Export
ExportsApi GetExport GET /v1/exports/{exportId} Get Export
ExportsApi ListExports GET /v1/exports List Exports
LocationsApi GetLocation GET /v1/locations/{locationId} Get Location
LocationsApi ListLocations GET /v1/locations List Locations
LoyaltiesApi ActivateMemberPendingPoints POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate Activate Member Pending Points
LoyaltiesApi AddMember POST /v1/loyalties/{campaignId}/members Add Member
LoyaltiesApi CancelMemberPendingPoints POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel Cancel Member Pending Points
LoyaltiesApi CreateEarningRule POST /v1/loyalties/{campaignId}/earning-rules Create Earning Rule
LoyaltiesApi CreateInBulkLoyaltyTiers POST /v1/loyalties/{campaignId}/tiers Create loyalty tiers
LoyaltiesApi CreateLoyaltyProgram POST /v1/loyalties Create Loyalty Campaign
LoyaltiesApi CreatePointsExpirationExport POST /v1/loyalties/{campaignId}/points-expiration/export Export Loyalty Campaign Point Expiration
LoyaltiesApi CreateRewardAssignment1 POST /v1/loyalties/{campaignId}/rewards Create Reward Assignment
LoyaltiesApi DeleteEarningRule DELETE /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} Delete Earning Rule
LoyaltiesApi DeleteLoyaltyProgram DELETE /v1/loyalties/{campaignId} Delete Loyalty Campaign
LoyaltiesApi DeleteRewardAssignment1 DELETE /v1/loyalties/{campaignId}/rewards/{assignmentId} Delete Reward Assignment
LoyaltiesApi DisableEarningRule POST /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable Disable Earning Rule
LoyaltiesApi EnableEarningRule POST /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable Enable Earning Rule
LoyaltiesApi ExportLoyaltyCampaignTransactions POST /v1/loyalties/{campaignId}/transactions/export Export Loyalty Campaign Transactions
LoyaltiesApi ExportLoyaltyCardTransactions POST /v1/loyalties/members/{memberId}/transactions/export Export Loyalty Card Transactions
LoyaltiesApi ExportLoyaltyCardTransactions1 POST /v1/loyalties/{campaignId}/members/{memberId}/transactions/export Export Loyalty Card Transactions
LoyaltiesApi GetEarningRule GET /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} Get Earning Rule
LoyaltiesApi GetLoyaltyProgram GET /v1/loyalties/{campaignId} Get Loyalty Campaign
LoyaltiesApi GetLoyaltyTier GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} Get Loyalty Tier
LoyaltiesApi GetMember GET /v1/loyalties/members/{memberId} Get Member
LoyaltiesApi GetMember1 GET /v1/loyalties/{campaignId}/members/{memberId} Get Member
LoyaltiesApi GetRewardAssignment1 GET /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} Get Reward Assignment
LoyaltiesApi GetRewardAssignment2 GET /v1/loyalties/{campaignId}/rewards/{assignmentId} Get Reward Assignment
LoyaltiesApi GetRewardDetails GET /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward Get Reward Details
LoyaltiesApi ListCampaignPendingPoints GET /v1/loyalties/{campaignId}/pending-points List Campaign Pending Points
LoyaltiesApi ListEarningRules GET /v1/loyalties/{campaignId}/earning-rules List Earning Rules
LoyaltiesApi ListLoyaltyCampaignTransactions GET /v1/loyalties/{campaignId}/transactions List Loyalty Campaign Transactions
LoyaltiesApi ListLoyaltyCardTransactions GET /v1/loyalties/members/{memberId}/transactions List Loyalty Card Transactions
LoyaltiesApi ListLoyaltyCardTransactions1 GET /v1/loyalties/{campaignId}/members/{memberId}/transactions List Loyalty Card Transactions
LoyaltiesApi ListLoyaltyPrograms GET /v1/loyalties List Loyalty Campaigns
LoyaltiesApi ListLoyaltyTierEarningRules GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules List Loyalty Tier Earning Rules
LoyaltiesApi ListLoyaltyTierRewards GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards List Loyalty Tier Rewards
LoyaltiesApi ListLoyaltyTiers GET /v1/loyalties/{campaignId}/tiers List Loyalty Tiers
LoyaltiesApi ListMemberActivity GET /v1/loyalties/members/{memberId}/activity List Member Activity
LoyaltiesApi ListMemberActivity1 GET /v1/loyalties/{campaignId}/members/{memberId}/activity List Member Activity
LoyaltiesApi ListMemberLoyaltyTier GET /v1/loyalties/members/{memberId}/tiers List Member's Loyalty Tiers
LoyaltiesApi ListMemberPendingPoints GET /v1/loyalties/members/{memberId}/pending-points List Member Pending Points
LoyaltiesApi ListMemberPendingPoints1 GET /v1/loyalties/{campaignId}/members/{memberId}/pending-points List Member Pending Points
LoyaltiesApi ListMemberRewards GET /v1/loyalties/members/{memberId}/rewards List Member Rewards
LoyaltiesApi ListMembers GET /v1/loyalties/{campaignId}/members List Members
LoyaltiesApi ListPointsExpiration GET /v1/loyalties/{campaignId}/members/{memberId}/points-expiration List Loyalty Card Point Expiration
LoyaltiesApi ListRewardAssignments1 GET /v1/loyalties/{campaignId}/reward-assignments List Reward Assignments
LoyaltiesApi ListRewardAssignments2 GET /v1/loyalties/{campaignId}/rewards List Reward Assignments
LoyaltiesApi RedeemReward POST /v1/loyalties/members/{memberId}/redemption Redeem Reward
LoyaltiesApi RedeemReward1 POST /v1/loyalties/{campaignId}/members/{memberId}/redemption Redeem Reward
LoyaltiesApi TransferPoints POST /v1/loyalties/{campaignId}/members/{memberId}/transfers Transfer Loyalty Points
LoyaltiesApi UpdateEarningRule PUT /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} Update Earning Rule
LoyaltiesApi UpdateLoyaltyCardBalance POST /v1/loyalties/members/{memberId}/balance Adjust Loyalty Card Balance
LoyaltiesApi UpdateLoyaltyCardBalance1 POST /v1/loyalties/{campaignId}/members/{memberId}/balance Adjust Loyalty Card Balance
LoyaltiesApi UpdateLoyaltyProgram PUT /v1/loyalties/{campaignId} Update Loyalty Campaign
LoyaltiesApi UpdateRewardAssignment1 PUT /v1/loyalties/{campaignId}/rewards/{assignmentId} Update Reward Assignment
ManagementApi AssignUser POST /management/v1/projects/{projectId}/users Assign User
ManagementApi CreateBrand POST /management/v1/projects/{projectId}/branding Create Brand
ManagementApi CreateCustomEventSchema POST /management/v1/projects/{projectId}/custom-event-schemas Create Custom Event Schema
ManagementApi CreateMetadataSchema POST /management/v1/projects/{projectId}/metadata-schemas Create Metadata Schema
ManagementApi CreateProject POST /management/v1/projects Create Project
ManagementApi CreateStackingRules POST /management/v1/projects/{projectId}/stacking-rules Create Stacking Rules
ManagementApi CreateWebhook POST /management/v1/projects/{projectId}/webhooks Create Webhook
ManagementApi DeleteBrand DELETE /management/v1/projects/{projectId}/branding/{brandingId} Delete Brand
ManagementApi DeleteCustomEventSchema DELETE /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} Delete Custom Event Schema
ManagementApi DeleteMetadataSchema DELETE /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} Delete Metadata Schema
ManagementApi DeleteProject DELETE /management/v1/projects/{projectId} Delete Project
ManagementApi DeleteStackingRules DELETE /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} Delete Stacking Rules
ManagementApi DeleteWebhook DELETE /management/v1/projects/{projectId}/webhooks/{webhookId} Delete Webhook
ManagementApi GetBrand GET /management/v1/projects/{projectId}/branding/{brandingId} Get Brand
ManagementApi GetCustomEventSchema GET /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} Get Custom Event Schema
ManagementApi GetMetadataSchema1 GET /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} Get Metadata Schema
ManagementApi GetProject GET /management/v1/projects/{projectId} Get Project
ManagementApi GetStackingRules GET /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} Get Stacking Rules
ManagementApi GetUser GET /management/v1/projects/{projectId}/users/{userId} Get User
ManagementApi GetWebhook GET /management/v1/projects/{projectId}/webhooks/{webhookId} Get Webhook
ManagementApi InviteUser POST /management/v1/projects/users/invite Invite a New User
ManagementApi ListBrands GET /management/v1/projects/{projectId}/branding List Brands
ManagementApi ListCustomEventSchemas GET /management/v1/projects/{projectId}/custom-event-schemas List Custom Event Schemas
ManagementApi ListMetadataSchemas1 GET /management/v1/projects/{projectId}/metadata-schemas List Metadata Schemas
ManagementApi ListProjects GET /management/v1/projects List Projects
ManagementApi ListStackingRules GET /management/v1/projects/{projectId}/stacking-rules List Stacking Rules
ManagementApi ListUsers GET /management/v1/projects/{projectId}/users List Users
ManagementApi ListWebhooks GET /management/v1/projects/{projectId}/webhooks List Webhooks
ManagementApi ManagementCopyCampaignTemplate POST /management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy Copy Campaign Template to a Project
ManagementApi ManagementListCampaignTemplates GET /management/v1/projects/{projectId}/templates/campaigns List Campaign Templates
ManagementApi UnassignUser DELETE /management/v1/projects/{projectId}/users/{userId} Unassign User
ManagementApi UpdateBrand PUT /management/v1/projects/{projectId}/branding/{brandingId} Update Brand
ManagementApi UpdateCustomEventSchema PUT /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} Update Custom Event Schema
ManagementApi UpdateMetadataSchema PUT /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} Update Metadata Schema
ManagementApi UpdateProject PUT /management/v1/projects/{projectId} Update Project
ManagementApi UpdateStackingRules PUT /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} Update Stacking Rules
ManagementApi UpdateUser PUT /management/v1/projects/{projectId}/users/{userId} Update User
ManagementApi UpdateWebhook PUT /management/v1/projects/{projectId}/webhooks/{webhookId} Update Webhook
MetadataSchemasApi GetMetadataSchema GET /v1/metadata-schemas/{resource} Get Metadata Schema
MetadataSchemasApi ListMetadataSchemas GET /v1/metadata-schemas List Metadata Schemas
OAuthApi GenerateOauthToken POST /v1/oauth/token Generate OAuth 2.0 Token
OAuthApi IntrospectOauthToken POST /v1/oauth/introspect Introspect OAuth 2.0 Token
OAuthApi RevokeOauthToken POST /v1/oauth/token/revoke Revoke OAuth 2.0 Token
OrdersApi CreateOrder POST /v1/orders Create Order
OrdersApi CreateOrderExport POST /v1/orders/export Create Orders Export
OrdersApi GetOrder GET /v1/orders/{orderId} Get Order
OrdersApi ImportOrders POST /v1/orders/import Import Orders
OrdersApi ListOrders GET /v1/orders List Orders
OrdersApi UpdateOrder PUT /v1/orders/{orderId} Update Order
ProductCollectionsApi CreateProductCollection POST /v1/product-collections Create Product Collection
ProductCollectionsApi DeleteProductCollection DELETE /v1/product-collections/{productCollectionId} Delete Product Collection
ProductCollectionsApi GetProductCollection GET /v1/product-collections/{productCollectionId} Get Product Collection
ProductCollectionsApi ListProductCollections GET /v1/product-collections List Product Collections
ProductCollectionsApi ListProductsInCollection GET /v1/product-collections/{productCollectionId}/products List Products in Collection
ProductsApi CreateProduct POST /v1/products Create Product
ProductsApi CreateSku POST /v1/products/{productId}/skus Create SKU
ProductsApi DeleteProduct DELETE /v1/products/{productId} Delete Product
ProductsApi DeleteSku DELETE /v1/products/{productId}/skus/{skuId} Delete SKU
ProductsApi GetProduct GET /v1/products/{productId} Get Product
ProductsApi GetSku GET /v1/skus/{skuId} Get SKU
ProductsApi ImportProductsUsingCsv POST /v1/products/importCSV Import Products using CSV
ProductsApi ImportSkusUsingCsv POST /v1/skus/importCSV Import SKUs using CSV
ProductsApi ListProducts GET /v1/products List Products
ProductsApi ListSkusInProduct GET /v1/products/{productId}/skus List SKUs in Product
ProductsApi UpdateProduct PUT /v1/products/{productId} Update Product
ProductsApi UpdateProductsInBulk POST /v1/products/bulk/async Update Products in Bulk
ProductsApi UpdateProductsMetadataInBulk POST /v1/products/metadata/async Update Products' Metadata in Bulk
ProductsApi UpdateSku PUT /v1/products/{productId}/skus/{skuId} Update SKU
PromotionsApi AddPromotionTierToCampaign POST /v1/promotions/{campaignId}/tiers Add Promotion Tier to Campaign
PromotionsApi CreatePromotionStack POST /v1/promotions/{campaignId}/stacks Create Promotion Stack
PromotionsApi DeletePromotionStack DELETE /v1/promotions/{campaignId}/stacks/{stackId} Delete Promotion Stack
PromotionsApi DeletePromotionTier DELETE /v1/promotions/tiers/{promotionTierId} Delete Promotion Tier
PromotionsApi DisablePromotionTier POST /v1/promotions/tiers/{promotionTierId}/disable Disable Promotion Tier
PromotionsApi EnablePromotionTier POST /v1/promotions/tiers/{promotionTierId}/enable Enable Promotion Tier
PromotionsApi GetPromotionStack GET /v1/promotions/{campaignId}/stacks/{stackId} Get Promotion Stack
PromotionsApi GetPromotionTier GET /v1/promotions/tiers/{promotionTierId} Get Promotion Tier
PromotionsApi ListAllPromotionStacks GET /v1/promotions/stacks List Promotion Stacks
PromotionsApi ListPromotionStacksInCampaign GET /v1/promotions/{campaignId}/stacks List Promotion Stacks in Campaign
PromotionsApi ListPromotionTiers GET /v1/promotions/tiers List Promotion Tiers
PromotionsApi ListPromotionTiersFromCampaign GET /v1/promotions/{campaignId}/tiers List Promotion Tiers from Campaign
PromotionsApi UpdatePromotionStack PUT /v1/promotions/{campaignId}/stacks/{stackId} Update Promotion Stack
PromotionsApi UpdatePromotionTier PUT /v1/promotions/tiers/{promotionTierId} Update Promotion Tier
PublicationsApi CreatePublication POST /v1/publications Create Publication
PublicationsApi CreatePublication1 GET /v1/publications/create Create Publication
PublicationsApi ListPublications GET /v1/publications List Publications
QualificationsApi CheckEligibility POST /v1/qualifications Check Eligibility
RedemptionsApi GetRedemption GET /v1/redemptions/{redemptionId} Get Redemption
RedemptionsApi GetVoucherRedemptions GET /v1/vouchers/{code}/redemption Get Voucher's Redemptions
RedemptionsApi ListRedemptions GET /v1/redemptions List Redemptions
RedemptionsApi RedeemStackedDiscounts POST /v1/redemptions Redeem Stackable Discounts
RedemptionsApi RollbackRedemption POST /v1/redemptions/{redemptionId}/rollback Rollback Redemption
RedemptionsApi RollbackStackedRedemptions POST /v1/redemptions/{parentRedemptionId}/rollbacks Rollback Stackable Redemptions
ReferralsApi ReferralsAddHolders POST /v1/referrals/members/{memberId}/holders Add Referral Code Holders
ReferralsApi ReferralsAddHolders1 POST /v1/referrals/{campaignId}/members/{memberId}/holders Add Referral Code Holders
ReferralsApi ReferralsCodeHolders GET /v1/referrals/{campaignId}/members/{memberId}/holders List Referral Code Holders
ReferralsApi ReferralsCodeHolders1 GET /v1/referrals/members/{memberId}/holders List Referral Code Holders
ReferralsApi ReferralsRemoveHolder DELETE /v1/referrals/members/{memberId}/holders/{holderId} Remove Referral Card Holder
ReferralsApi ReferralsRemoveHolder1 DELETE /v1/referrals/{campaignId}/members/{memberId}/holders/{holderId} Remove Referral Card Holder
RewardsApi CreateReward POST /v1/rewards Create Reward
RewardsApi CreateRewardAssignment POST /v1/rewards/{rewardId}/assignments Create Reward Assignment
RewardsApi DeleteReward DELETE /v1/rewards/{rewardId} Delete Reward
RewardsApi DeleteRewardAssignment DELETE /v1/rewards/{rewardId}/assignments/{assignmentId} Delete Reward Assignment
RewardsApi GetReward GET /v1/rewards/{rewardId} Get Reward
RewardsApi GetRewardAssignment GET /v1/rewards/{rewardId}/assignments/{assignmentId} Get Reward Assignment
RewardsApi ListRewardAssignments GET /v1/rewards/{rewardId}/assignments List Reward Assignments
RewardsApi ListRewards GET /v1/rewards List Rewards
RewardsApi UpdateReward PUT /v1/rewards/{rewardId} Update Reward
RewardsApi UpdateRewardAssignment PUT /v1/rewards/{rewardId}/assignments/{assignmentId} Update Reward Assignment
SegmentsApi CreateSegment POST /v1/segments Create Segment
SegmentsApi DeleteSegment DELETE /v1/segments/{segmentId} Delete Segment
SegmentsApi GetSegment GET /v1/segments/{segmentId} Get Segment
TemplatesApi AddTierFromTemplate POST /v1/templates/campaigns/{campaignTemplateId}/tier-setup Add Promotion Tier From Template
TemplatesApi CreateCampaignFromTemplate POST /v1/templates/campaigns/{campaignTemplateId}/campaign-setup Create Campaign From Template
TemplatesApi CreateCampaignTemplate POST /v1/templates/campaigns Create Campaign Template
TemplatesApi DeleteCampaignTemplate DELETE /v1/templates/campaigns/{campaignTemplateId} Delete Campaign Template
TemplatesApi GetCampaignTemplate GET /v1/templates/campaigns/{campaignTemplateId} Get Campaign Template
TemplatesApi ListCampaignTemplates GET /v1/templates/campaigns List Campaign Templates
TemplatesApi UpdateCampaignTemplate PUT /v1/templates/campaigns/{campaignTemplateId} Update Campaign Template
ValidationRulesApi CreateValidationRuleAssignment POST /v1/validation-rules/{validationRuleId}/assignments Create Validation Rules Assignments
ValidationRulesApi CreateValidationRules POST /v1/validation-rules Create Validation Rules
ValidationRulesApi DeleteValidationRuleAssignment DELETE /v1/validation-rules/{validationRuleId}/assignments/{assignmentId} Delete Validation Rule Assignment
ValidationRulesApi DeleteValidationRules DELETE /v1/validation-rules/{validationRuleId} Delete Validation Rule
ValidationRulesApi GetValidationRule GET /v1/validation-rules/{validationRuleId} Get Validation Rule
ValidationRulesApi ListValidationRuleAssignments GET /v1/validation-rules/{validationRuleId}/assignments List Validation Rule Assignments
ValidationRulesApi ListValidationRules GET /v1/validation-rules List Validation Rules
ValidationRulesApi ListValidationRulesAssignments GET /v1/validation-rules-assignments List Validation Rules' Assignment(s)
ValidationRulesApi UpdateValidationRule PUT /v1/validation-rules/{validationRuleId} Update Validation Rule
ValidationsApi ValidateStackedDiscounts POST /v1/validations Validate Stackable Discounts
VouchersApi CreateVoucher POST /v1/vouchers/{code} Create Voucher
VouchersApi DeleteVoucher DELETE /v1/vouchers/{code} Delete Voucher
VouchersApi DisableVoucher POST /v1/vouchers/{code}/disable Disable Voucher
VouchersApi EnableVoucher POST /v1/vouchers/{code}/enable Enable Voucher
VouchersApi ExportVoucherTransactions POST /v1/vouchers/{code}/transactions/export Export Voucher Transactions
VouchersApi GenerateRandomCode POST /v1/vouchers Generate Random Code
VouchersApi GetVoucher GET /v1/vouchers/{code} Get Voucher
VouchersApi ImportVouchers POST /v1/vouchers/import Import Vouchers
VouchersApi ImportVouchersUsingCsv POST /v1/vouchers/importCSV Import Vouchers using CSV
VouchersApi ListVoucherTransactions GET /v1/vouchers/{code}/transactions List Voucher Transactions
VouchersApi ListVouchers GET /v1/vouchers List Vouchers
VouchersApi ReleaseValidationSession DELETE /v1/vouchers/{code}/sessions/{sessionKey} Release Validation Session
VouchersApi UpdateVoucher PUT /v1/vouchers/{code} Update Voucher
VouchersApi UpdateVoucherBalance POST /v1/vouchers/{code}/balance Adjust Voucher Balance
VouchersApi UpdateVouchersInBulk POST /v1/vouchers/bulk/async Update Vouchers in Bulk
VouchersApi UpdateVouchersMetadataInBulk POST /v1/vouchers/metadata/async Update Vouchers' Metadata in Bulk

<a id="documentation-for-models"></a>

Documentation for Models

<a id="documentation-for-authorization"></a>

Documentation for Authorization

Authentication schemes defined for the API: <a id="X-App-Id"></a>

X-App-Id

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

<a id="X-App-Token"></a>

X-App-Token

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

<a id="X-Client-Token"></a>

X-Client-Token

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

<a id="X-Client-Application-Id"></a>

X-Client-Application-Id

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

<a id="X-Management-Id"></a>

X-Management-Id

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

<a id="X-Management-Token"></a>

X-Management-Token

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

<a id="X-Voucherify-OAuth"></a>

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

Recommendation

Please check out our test suite for more examples.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.0.1 0 5/12/2025
8.0.0 163 5/7/2025

2025-05-07: 8.0.1
           - Added OAuth support for Loyalty Pending Points endpoints.
       2025-05-07: 8.0.0
           - New complete version of Voucherify SDK, generated out of OpenApi specification.

       Other notes available in readme.md in repository.