Skip to content
BranchesTags

Repository files navigation

Voucherify PHP SDK

Official Voucherify PHP 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.

For more info, visit those places:

🧱 Requirements

PHP 8.1 or newer.

⚙️ Install

Use any of the following methods to install the SDK.

Composer

To install the bindings with Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/voucherifyio/voucherify-php-sdk"
    }
  ],
  "require": {
    "voucherify/voucherify-php-sdk": "^5.0"
  }
}

Then run:

composer install

Manual installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

🔒 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.io
  3. Scroll down to Application Keys to grab your Application ID and Secret key.

🚀 Run code

Once installed, run:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$host = getenv('VOUCHERIFY_HOST') ?: 'https://api.voucherify.io';
$xAppId = getenv('X_APP_ID');
$xAppToken = getenv('X_APP_TOKEN');

if (!$xAppId || !$xAppToken) {
    throw new RuntimeException('X_APP_ID and X_APP_TOKEN must be set in the environment.');
}

$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
    ->setHost($host)
    ->setApiKey('X-App-Id', $xAppId)
    ->setApiKey('X-App-Token', $xAppToken);

$apiInstance = new OpenAPI\Client\Api\CampaignsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->listCampaigns();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CampaignsApi->listCampaigns: ', $e->getMessage(), PHP_EOL;
}

Note

This code just lists campaigns, so it won't affect your Voucherify data.

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 .env and fill in the values.
  2. Run docker build -t php . to build the image.
  3. Run docker run --rm php to run the tests and delete container immediately after.

🛠️ Contribute

This SDK is generated automatically from our OpenAPI specification. To contribute, submit an issue rather than creating a pull request. Voucherify developers will review your issue and reply as soon as possible.

🏷️ Link tags

OpenAPI generated from tag.

🔐 Authorization

Authorization 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

📅 Changelog

  • 2026-08-10 - 5.1.0
    • Fixed: ValidationsRedeemableSkippedResultDetails was missing no_effect (ValidationsRedeemableSkippedResultDetails::KEY_NO_EFFECT), so deserializing a skipped redeemable with "key": "no_effect" threw \InvalidArgumentException (entire validations/redemptions response failed to parse).
    • This affects POST /v1/validations and stackable POST /v1/redemptions when redeemables_no_effect_rule is SKIP (globally or via no_effect_skip_categories).
    • New allowable value: no_effect (KEY_NO_EFFECT) - Redeemable cannot be applied due to no effect.
    • Fixed: FilterConditionsDateTime now serializes moreThan / lessThan as $more_than / $less_than, matching the documented filter contract and the already-correct FiltersCondition; previously these were sent as more_than / less_than and ignored by the API. Getters and setters are unchanged.
    • Added support for GET /v1/campaigns/{campaignId}/summary
    • Added support for GET /v1/campaigns/{campaignId}/transactions
    • Added support for POST /v1/campaigns/{campaignId}/transactions/export
    • Added support for GET /v1/loyalties/{campaignId}/transactions
    • Added support for POST /v1/loyalties/{campaignId}/transactions/export
    • Added support for POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance (LoyaltiesApi::adjustMemberPendingPoints())
    • Added 55 new models (campaign/loyalty transaction listing & export, campaign summary, bundle discounts, earning-rule expiration/applicable-to/pending-points types, redemption/qualification session objects, and related filters).
    • Updated bundle discounts: bundle on validation/redeemable results, bundleRules on validation rules, and new Bundle types.
    • Updated discount applicability with campaign/promotion-tier quantity limits (and formulas) and units_limit_exceeded on unit-level results; new discount effect ADD_SAME_ITEMS.
    • Updated loyalty earning rules with expirationRules, applicableTo, pointsFormula, and pending-points configuration; new FIXED_DAY_OF_YEAR expiration period type.
    • Updated redemptions and qualifications with optional session objects.
    • Updated gift/loyalty voucher responses with subtractedAmount / subtractedPoints and loyalty expiredPoints.
    • Updated customer assets with cockpitPreferenceCenterUrl.
    • Updated segments with passive type and updatedAt; async action listings with hasMore.
    • Updated CampaignsCreateRequestBody type enum with STANDALONE (TYPE_STANDALONE; alongside AUTO_UPDATE and STATIC).
    • Added many new management webhook event constants (campaign tiers/stacks/rewards, voucher transactions, pending-points lifecycle, customer confirmed, and more). Existing EVENTS_*_ADDED constants keep their names and values, and the importVouchersUsingCsv($file, $contentType) signature is unchanged. The upstream aded spelling typo in the source specification is compensated for during generation and will be corrected across all SDKs in a future alignment.
    • Not exposed yet: the webhooks_enable form field on CSV voucher import. It is omitted on purpose, because adding it would insert a parameter before $contentType and silently shift existing positional calls. It will arrive with a future cross-SDK alignment or the next major version.
  • 2026-05-07 - 5.0.4
    • Fixed PHP 8.4 deprecation warnings: added explicit nullable type declarations (?Type $param = null) across all API and Model constructors
    • Fixed tests: publish loyalty card before updating balance (required by API change)
  • 2025-01-29 - 5.0.3
    • Added support for GET /v1/loyalties/{campaignId}/pending-points
    • Added support for GET /v1/loyalties/members/{memberId}/pending-points
    • Added support for GET /v1/loyalties/{campaignId}/members/{memberId}/pending-points
    • Added support for POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate
    • Added support for POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel
    • Added types for pending points (loyalties) and access settings (areas and stores)
  • 2024-11-26 - 5.0.2
    • Added support for STANDALONE campaign type.
    • Added optional metadata in OrderCalculatedItemSku
    • New possible value of ParameterExpandListCampaigns
    • New optional error parameter in Error
    • Updated LoyaltyCardTransactionDetailsBalance
  • 2024-11-04 - 5.0.1
    • Added support for returning campaign_id and campaign_name in stackable validation endpoint, when redeemable option is expanded
  • 2024-10-28 - 5.0.0
    • Added missing enums in few filters models
    • !!! BREAKING CHANGES !!!
      • VouchersApi.generateRandomCode now requires VouchersCreateResponseBody instead of plain object
      • property product in model Discount now uses DiscountProduct instead of SimpleProductDiscountUnit
      • property filters of model ExportsCreateRequestBodyParameters now uses plain object instead of ExportsCreateRequestBodyParametersFilters
  • 2024-10-25 - 4.0.0
    • Fix object parsing in query. For example filters while listing redemptions.
    • Fix downloading exports. Include auth headers in the call.
    • !!! BREAKING CHANGES !!!
      • Remove support for /v1/customers/{customerId}/consents - put Update Customer's consents [Deprecated]
      • Remove support for /v1/consents - get List Consents [Deprecated]
      • Remove support for /client/v1/customers/{customerId}/consents - put Update Customer's consents (client-side) [Deprecated]
      • Pagination changed on listing card transactions(listLoyaltyCardTransactions) - NO page param is supported - use starting_after_id instead.
      • Pagination changed on listing voucher transactions(listVoucherTransactions) - NO page param is supported - use starting_after_id instead.
      • ApplicableToEffect - changed - EVERY -> TO_EVERY, CHEAPEST -> TO_CHEAPEST, MOST_EXPENSIVE -> TO_MOST_EXPENSIVE, 2 new values introduced.
      • listPublications parameter filters have changed - now uses ParameterFiltersListPublications instead of String
      • ParameterFiltersListRedemptions and ParameterFiltersListCustomerRedeemables have been updated
      • enum LUCKY_DRAW, LUCKY_DRAW_CODE, VOUCHER_LUCKY_DRAW_CODE, CAMPAIGN_LUCKY_DRAW have been deleted from everywhere and no longer supported
      • CampaignsUpdateRequestBody - properties activityDurationAfterPublishing, joinOnce, autoJoin, type, uniqueWinners, uniqueWinnersPerDraw and enum AUTO_UPDATE | STATIC have been deleted and no longer supported
      • updateCustomersConsents has been deleted and no longer supported
      • FilterConditionsDateTimeConditions model has been renamed to FilterConditionsDateTime
      • FilterConditionsDateTime - conditions has been divided on $after, $before, $hasValue, $isUnknown, moreThan, lessThan properties
      • ParamterFiltersListCustomerRedeemables - model name of createdAt has been renamed from FilterConditionsDateTime to ParameterFiltersListCustomerRedeemablesCreatedAt
      • filter property in schemas ProductCollectionsCreateRequestBody, ProductCollectionsCreateResponseBody, ProductCollectionsItem and ProductCollectionsGetResponseBody has changed. Uses plain object.
      • discount property in schema CampaignsUpdateRequestBody now uses Discount model
      • properties winnersCount, uniqueWinnersPerDraw, uniqueWinners in model CampaignsUpdateRequestBody were deleted.
      • property stackingRulesType were deleted from models CategoriesGetResponseBody, Category
      • property categories in model ClientValidationsValidateResponseBodyRedeemablesItem uses now Array model
      • model ParameterFiltersListCustomerRedeemablesCampaignId has been fixed, can use junction properly.
      • model ParameterFiltersListRedemptions has been fixed, can use junction properly.
      • property filter in model ProductCollectionsCreateRequestBody now uses plain Object
      • property categories in model QualificationsRedeemable now uses Array<CategoryWithStackingRulesType>
    • Added support:
      • /v1/metadata-schemas - get List Metadata Schemas
      • /v1/metadata-schemas/{resource} - get Get Metadata Schema
      • /v1/locations - List Locations
      • /v1/locations/{locationId} - get Get Location
      • /v1/referrals/{campaignId}/members/{memberId}/holders - post Add Referral Code Holders
      • /v1/referrals/{campaignId}/members/{memberId}/holders - get List Referral Code Holders
      • /v1/referrals/{campaignId}/members/{memberId}/holders/{holderId} - delete Remove Referral Card Holder
      • /v1/referrals/members/{memberId}/holders - post Add Referral Code Holders
      • /v1/referrals/members/{memberId}/holders - get List Referral Code Holders
      • /v1/referrals/members/{memberId}/holders/{holderId} - delete Remove Referral Card Holder
      • /v1/trash-bin - get List Bin Entries
      • /v1/trash-bin/{binEntryId} - delete Delete Bin Entry
      • /v1/templates/campaigns - get List Campaign Templates
      • /v1/templates/campaigns - post Create Campaign Template
      • /v1/templates/campaigns/{campaignTemplateId} - get Get Campaign Template
      • /v1/templates/campaigns/{campaignTemplateId} - put Update Campaign Template
      • /v1/templates/campaigns/{campaignTemplateId} - delete Delete Campaign Template
      • /v1/templates/campaigns/{campaignTemplateId}/campaign-setup - post Create Campaign From Template
      • /v1/templates/campaigns/{campaignTemplateId}/tier-setup - post Add Promotion Tier From Template
      • /management/v1/projects - post Create Project
      • /management/v1/projects - get List Projects
      • /management/v1/projects/{projectId} - get Get Project
      • /management/v1/projects/{projectId} - put Update Project
      • /management/v1/projects/{projectId} - delete Delete Project
      • /management/v1/projects/{projectId}/users - post Assign User
      • /management/v1/projects/{projectId}/users/{userId} - put Update User
      • /management/v1/projects/{projectId}/users/{userId} - delete Unassign User
      • /management/v1/projects/users/invite - post Invite a New User
      • /management/v1/projects/{projectId}/templates/campaigns - get List Campaign Templates
      • /management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy - post Copy Campaign Template to a Project
      • /management/v1/projects/{projectId}/stacking-rules - post Create Stacking Rules
      • /management/v1/projects/{projectId}/stacking-rules - get List Stacking Rules
      • /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} - get Get Stacking Rules
      • /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} - put Update Stacking Rules
      • /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} - delete Delete Stacking Rules
      • /management/v1/projects/{projectId}/metadata-schemas - post Create Metadata Schema
      • /management/v1/projects/{projectId}/metadata-schemas - get List Metadata Schemas
      • /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} - get Get Metadata Schema
      • /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} - put Update Metadata Schema
      • /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} - delete Delete Metadata Schema
      • /management/v1/projects/{projectId}/custom-event-schemas - post Create Custom Event Schema
      • /management/v1/projects/{projectId}/custom-event-schemas - get List Custom Event Schemas
      • /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} - get Get Custom Event Schema
      • /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} - put Update Custom Event Schema
      • /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} - delete Delete Custom Event Schema
      • /management/v1/projects/{projectId}/webhooks - post Create Webhook
      • /management/v1/projects/{projectId}/webhooks - get List Webhooks
      • /management/v1/projects/{projectId}/webhooks/{webhookId} - get Get Webhook
      • /management/v1/projects/{projectId}/webhooks/{webhookId} - put Update Webhook
      • /management/v1/projects/{projectId}/webhooks/{webhookId} - delete Delete Webhook
      • /management/v1/projects/{projectId}/branding - post Create Brand
      • /management/v1/projects/{projectId}/branding - get List Brands
      • /management/v1/projects/{projectId}/branding/{brandingId} - get Get Brand
      • /management/v1/projects/{projectId}/branding/{brandingId} - put Update Brand
      • /management/v1/projects/{projectId}/branding/{brandingId} - delete Delete Brand
  • 2024-09-11 - 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 API are no longer supported, and we highly recommend upgrading to version 3.0.0, which is now designated as Long-Term Support (LTS).

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 getCampaignSummary GET /v1/campaigns/{campaignId}/summary Get Campaign Summary
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 adjustMemberPendingPoints POST /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance Adjust Member Pending Points
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 Loyalty Campaign 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 Campaign 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 with campaign ID
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 with campaign ID
LoyaltiesApi getRewardAssignment1 GET /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} Get Campaign Reward Assignments
LoyaltiesApi getRewardAssignment2 GET /v1/loyalties/{campaignId}/rewards/{assignmentId} Get Campaign 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 with campaign ID
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 with campaign ID
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 with campaign ID
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 with campaign ID
LoyaltiesApi listRewardAssignments2 GET /v1/loyalties/{campaignId}/rewards List Campaign Rewards
LoyaltiesApi redeemReward POST /v1/loyalties/members/{memberId}/redemption Redeem Reward
LoyaltiesApi redeemReward1 POST /v1/loyalties/{campaignId}/members/{memberId}/redemption Redeem Reward with campaign ID
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 with campaign ID
LoyaltiesApi updateLoyaltyProgram PUT /v1/loyalties/{campaignId} Update Loyalty Campaign
LoyaltiesApi updateRewardAssignment1 PUT /v1/loyalties/{campaignId}/rewards/{assignmentId} Update Campaign 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 Schema Definitions
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 with GET
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 with Campaign ID
ReferralsApi referralsCodeHolders GET /v1/referrals/{campaignId}/members/{memberId}/holders List Referral Code Holders with campaign ID
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 with campaign ID
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

Models

About

PHP SDK for Voucherify - coupons, vouchers, promo codes

www.voucherify.io

Resources

Readme
MIT license
Activity
Custom properties

Stars

22 stars

Watchers

9 watching

Forks

15 forks
Report repository

Releases

Packages

Used by

Contributors

Languages