Voucherify promotion engine REST API. Please see https://docs.voucherify.io/docs for more details.
For more information, please visit https://www.voucherify.io/contact-support.
PHP 8.1 and later.
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
}
],
"require": {
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
}
}
Then run composer install
Download the files and include autoload.php
:
<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: X-App-Id
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Id', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Id', 'Bearer');
// Configure API key authorization: X-App-Token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-App-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-App-Token', 'Bearer');
$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
);
$campaign_id = 'campaign_id_example'; // string | The campaign ID or name of the campaign to which voucher will be added. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value.
$code = 'code_example'; // string | A custom **code** that identifies the voucher.
$campaigns_vouchers_create_request_body = {"category_id":"cat_0bb81a481615a37b5e","start_date":"2022-09-24T00:00:00Z","expiration_date":"2022-09-25T23:59:59Z","active":false,"redemption":{"quantity":null},"additional_info":"Voucher added using API","metadata":{"Season":"Fall"}}; // \OpenAPI\Client\Model\CampaignsVouchersCreateRequestBody | Specify the voucher parameters that you would like to overwrite.
try {
$result = $apiInstance->addVoucherWithSpecificCodeToCampaign($campaign_id, $code, $campaigns_vouchers_create_request_body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CampaignsApi->addVoucherWithSpecificCodeToCampaign: ', $e->getMessage(), PHP_EOL;
}
All URIs are relative to https://api.voucherify.io
Class | Method | HTTP request | Description |
---|---|---|---|
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 | 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 | 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 |
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 | listCustomerActivities | GET /v1/customers/{customerId}/activities | List Customer Activities |
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 | updateCustomersConsents | PUT /v1/customers/{customerId}/consents | Update Customer's consents |
CustomersApi | updateCustomersConsentsClientSide | PUT /client/v1/customers/{customerId}/consents | Update Customer's consents (client-side) |
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 |
EventsApi | trackCustomEventClientSide | POST /client/v1/events | Track Custom Event (client-side) |
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 |
LoyaltiesApi | createInBulkLoyaltyTiers | POST /v1/loyalties/{campaignId}/tiers | Create loyalty tiers |
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 | 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 | getLoyaltyTier | GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | Get Loyalty Tier |
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 | 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 | 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 | listMemberLoyaltyTier | GET /v1/loyalties/members/{memberId}/tiers | List Member's Loyalty Tiers |
LoyaltiesApi | listMemberRewards | GET /v1/loyalties/members/{memberId}/rewards | List Member Rewards |
LoyaltiesApi | listPointsExpiration | GET /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | Get Points Expiration |
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 | updateLoyaltyCardBalance | POST /v1/loyalties/members/{memberId}/balance | Add or Remove Loyalty Card Balance |
LoyaltiesApi | updateLoyaltyCardBalance1 | POST /v1/loyalties/{campaignId}/members/{memberId}/balance | Add or Remove Loyalty Card Balance |
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 | 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 | listPromotionTiersFromCampaign | GET /v1/promotions/{campaignId}/tiers | List Promotion Tiers from Campaign |
PromotionsApi | updatePromotionStack | PUT /v1/promotions/{campaignId}/stacks/{stackId} | Update Promotion Stack |
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 |
QualificationsApi | checkEligibilityClientSide | POST /client/v1/qualifications | Check Eligibility (client-side) |
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 | rollbackRedemption | POST /v1/redemptions/{redemptionId}/rollback | Rollback Redemption |
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 | getRewardAssignment | GET /v1/rewards/{rewardId}/assignments/{assignmentId} | Get Reward Assignment |
RewardsApi | listRewardAssignments | GET /v1/rewards/{rewardId}/assignments | List Reward Assignments |
RewardsApi | updateRewardAssignment | PUT /v1/rewards/{rewardId}/assignments/{assignmentId} | Update Reward Assignment |
SegmentsApi | deleteSegment | DELETE /v1/segments/{segmentId} | Delete Segment |
StackableDiscountsApi | redeemStackedDiscounts | POST /v1/redemptions | Redeem Stackable Discounts |
StackableDiscountsApi | redeemStackedDiscountsClientSide | POST /client/v1/redemptions | Redeem Stackable Discounts (client-side) |
StackableDiscountsApi | rollbackStackedRedemptions | POST /v1/redemptions/{parentRedemptionId}/rollbacks | Rollback Stackable Redemptions |
StackableDiscountsApi | validateStackedDiscounts | POST /v1/validations | Validate Stackable Discounts |
StackableDiscountsApi | validateStackedDiscountsClientSide | POST /client/v1/validations | Validate Stackable Discounts (client-side) |
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 |
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 | getVoucher | GET /v1/vouchers/{code} | Get Voucher |
VouchersApi | importVouchersUsingCsv | POST /v1/vouchers/importCSV | Import Vouchers using CSV |
VouchersApi | listVoucherTransactions | GET /v1/vouchers/{code}/transactions | List Voucher Transactions |
VouchersApi | releaseValidationSession | DELETE /v1/vouchers/{code}/sessions/{sessionKey} | Release Validation Session |
VouchersApi | updateVoucherBalance | POST /v1/vouchers/{code}/balance | Add or Remove Voucher Balance |
- ApplicableTo
- ApplicableToResultList
- AsyncActions
- BusValRuleAssignment
- Campaign
- CampaignBase
- CampaignBaseValidityTimeframe
- CampaignLoyaltyCard
- CampaignLoyaltyCardExpirationRules
- CampaignVoucher
- CampaignVoucherRedemption
- CampaignsCreateRequestBody
- CampaignsCreateRequestBodyPromotion
- CampaignsCreateRequestBodyValidityTimeframe
- CampaignsCreateRequestBodyVoucher
- CampaignsCreateRequestBodyVoucherRedemption
- CampaignsCreateResponseBody
- CampaignsDeleteResponseBody
- CampaignsDisableResponseBody
- CampaignsEnableResponseBody
- CampaignsGetResponseBody
- CampaignsImportCreateResponseBody
- CampaignsImportCsvCreateResponseBody
- CampaignsImportVoucherItem
- CampaignsImportVoucherItemRedemption
- CampaignsImportVoucherLoyaltyCard
- CampaignsListResponseBody
- CampaignsUpdateRequestBody
- CampaignsUpdateRequestBodyOptions
- CampaignsUpdateRequestBodyValidityTimeframe
- CampaignsUpdateResponseBody
- CampaignsVouchersCreateBaseRequestBody
- CampaignsVouchersCreateInBulkRequestBody
- CampaignsVouchersCreateInBulkResponseBody
- CampaignsVouchersCreateRequestBody
- CampaignsVouchersCreateResponseBody
- CategoriesCreateRequestBody
- CategoriesCreateResponseBody
- CategoriesGetResponseBody
- CategoriesListResponseBody
- CategoriesUpdateRequestBody
- CategoriesUpdateResponseBody
- Category
- ClientEventsCreateRequestBody
- ClientEventsCreateRequestBodyLoyalty
- ClientEventsCreateRequestBodyReferral
- ClientEventsCreateResponseBody
- ClientQualificationsCheckEligibilityRequestBody
- ClientQualificationsCheckEligibilityResponseBody
- ClientRedemptionsRedeemRequestBody
- ClientRedemptionsRedeemRequestBodyAllOfOptions
- ClientRedemptionsRedeemResponseBody
- ClientValidationsValidateRequestBody
- ClientValidationsValidateRequestBodyAllOfOptions
- ClientValidationsValidateResponseBody
- CodeConfig
- CodeConfigRequiredLengthCharsetPattern
- CreatePublicationCampaign
- CustomEvent
- CustomEventReferral
- Customer
- CustomerActivity
- CustomerActivityData
- CustomerActivityDataCustomer
- CustomerActivityDataCustomerAddress
- CustomerActivityDataCustomerAssets
- CustomerActivityDataCustomerLoyalty
- CustomerActivityDataCustomerReferrals
- CustomerActivityDataCustomerSummary
- CustomerActivityDataOrder
- CustomerActivityDataOrderCustomer
- CustomerActivityDataOrderCustomerAddress
- CustomerActivityDataOrderCustomerAssets
- CustomerActivityDataOrderCustomerLoyalty
- CustomerActivityDataOrderCustomerReferrals
- CustomerActivityDataOrderCustomerSummary
- CustomerActivityDataOrderItemsItem
- CustomerActivityDataOrderItemsItemProduct
- CustomerActivityDataOrderItemsItemSku
- CustomerActivityDataOrderReferrer
- CustomerActivityDataOrderReferrerAddress
- CustomerActivityDataOrderReferrerAssets
- CustomerActivityDataOrderReferrerLoyalty
- CustomerActivityDataOrderReferrerReferrals
- CustomerActivityDataOrderReferrerSummary
- CustomerActivityDataRedemption
- CustomerActivityDataRedemptionOrder
- CustomerActivityDataRedemptionOrderCustomer
- CustomerActivityDataRedemptionOrderCustomerAddress
- CustomerActivityDataRedemptionOrderCustomerAssets
- CustomerActivityDataRedemptionOrderCustomerLoyalty
- CustomerActivityDataRedemptionOrderCustomerReferrals
- CustomerActivityDataRedemptionOrderCustomerSummary
- CustomerActivityDataRedemptionOrderItemsItem
- CustomerActivityDataRedemptionOrderItemsItemProduct
- CustomerActivityDataRedemptionOrderItemsItemSku
- CustomerActivityDataRedemptionOrderReferrer
- CustomerActivityDataRedemptionOrderReferrerAddress
- CustomerActivityDataRedemptionOrderReferrerAssets
- CustomerActivityDataRedemptionOrderReferrerLoyalty
- CustomerActivityDataRedemptionOrderReferrerReferrals
- CustomerActivityDataRedemptionOrderReferrerSummary
- CustomerActivityDataRedemptionPromotionTier
- CustomerActivityDataRedemptionPromotionTierAction
- CustomerActivityDataRedemptionPromotionTierCampaign
- CustomerActivityDataRedemptionPromotionTierCampaignValidityTimeframe
- CustomerActivityDataRedemptionPromotionTierSummary
- CustomerActivityDataRedemptionPromotionTierSummaryOrders
- CustomerActivityDataRedemptionPromotionTierSummaryRedemptions
- CustomerActivityDataRedemptionPromotionTierValidityTimeframe
- CustomerActivityDataRedemptionRelatedRedemptions
- CustomerActivityDataRedemptionReward
- CustomerActivityDataRedemptionRewardCustomer
- CustomerActivityDataRedemptionRewardParameters
- CustomerActivityDataRedemptionRewardParametersCampaign
- CustomerActivityDataRedemptionRewardParametersCoin
- CustomerActivityDataRedemptionRewardParametersProduct
- CustomerActivityDataRedemptionRewardProduct
- CustomerActivityDataRedemptionRewardSku
- CustomerActivityDataRedemptionRewardVoucher
- CustomerActivityDataRedemptionRewardVoucherGift
- CustomerActivityDataRedemptionRewardVoucherLoyaltyCard
- CustomerActivityDataRedemptionRewardVoucherPublish
- CustomerActivityDataRedemptionRewardVoucherRedemption
- CustomerActivityDataRedemptionRewardVoucherValidityTimeframe
- CustomerActivityDataRedemptionVoucher
- CustomerActivityDataRedemptionVoucherGift
- CustomerActivityDataRedemptionVoucherLoyaltyCard
- CustomerActivityDataRedemptionVoucherPublish
- CustomerActivityDataRedemptionVoucherRedemption
- CustomerActivityDataRedemptionVoucherValidityTimeframe
- CustomerActivityDataUnconfirmedCustomer
- CustomerBase
- CustomerBaseAddress
- CustomerId
- CustomerLoyalty
- CustomerLoyaltyCampaignsValue
- CustomerReferrals
- CustomerReferralsCampaignsItem
- CustomerResponseDataAssets
- CustomerSegmentsList
- CustomerSummary
- CustomerSummaryOrders
- CustomerSummaryRedemptions
- CustomerSummaryRedemptionsGift
- CustomerSummaryRedemptionsLoyaltyCard
- CustomerWithSummaryLoyaltyReferrals
- CustomersActivitiesListResponseBody
- CustomersCreateRequestBody
- CustomersCreateResponseBody
- CustomersGetResponseBody
- CustomersImportCsvCreateResponseBody
- CustomersListResponseBody
- CustomersMetadataUpdateInBulkRequestBody
- CustomersMetadataUpdateInBulkResponseBody
- CustomersPermanentDeletionCreateResponseBody
- CustomersPermanentDeletionCreateResponseBodyDataJson
- CustomersSegmentsListResponseBody
- CustomersUpdateInBulkRequestBody
- CustomersUpdateInBulkResponseBody
- CustomersUpdateRequestBody
- CustomersUpdateResponseBody
- Discount
- DiscountUnitMultipleOneUnit
- EarningRule
- EarningRuleBase
- EarningRuleBaseCustomEvent
- EarningRuleBaseLoyalty
- EarningRuleBaseLoyaltyCustomEvent
- EarningRuleBaseLoyaltyCustomEventMetadata
- EarningRuleBaseLoyaltyCustomer
- EarningRuleBaseLoyaltyCustomerMetadata
- EarningRuleBaseLoyaltyOrder
- EarningRuleBaseLoyaltyOrderAmount
- EarningRuleBaseLoyaltyOrderItems
- EarningRuleBaseLoyaltyOrderItemsQuantity
- EarningRuleBaseLoyaltyOrderMetadata
- EarningRuleBaseSegment
- EarningRuleBaseSource
- EarningRuleBaseValidityTimeframe
- Error
- EventsCreateRequestBody
- EventsCreateResponseBody
- Export
- ExportOrderBase
- ExportParameters
- ExportParametersFilters
- ExportResult
- ExportScheduledBase
- ExportVoucherTransactionsBase
- ExportVoucherTransactionsFilters
- ExportVoucherTransactionsScheduled
- ExportsCreateRequestBody
- ExportsCreateRequestBodyParameters
- ExportsCreateRequestBodyParametersFilters
- ExportsCreateResponseBody
- ExportsCreateResponseBodyParameters
- ExportsCreateResponseBodyParametersFilters
- ExportsGetResponseBody
- ExportsListResponseBody
- FieldConditions
- FilterConditionsString
- FiltersCondition
- Gift
- InapplicableTo
- InapplicableToResultList
- ListPublicationsItemVoucher
- LoyaltiesDeleteResponseBody
- LoyaltiesEarningRulesDisableResponseBody
- LoyaltiesEarningRulesEnableResponseBody
- LoyaltiesEarningRulesGetResponseBody
- LoyaltiesLoyaltyTierReward
- LoyaltiesMembersBalanceUpdateRequestBody
- LoyaltiesMembersBalanceUpdateResponseBody
- LoyaltiesMembersBalanceUpdateResponseBodyRelatedObject
- LoyaltiesMembersPointsExpirationListResponseBody
- LoyaltiesMembersPointsExpirationListResponseBodyDataItem
- LoyaltiesMembersPointsExpirationListResponseBodyDataItemBucket
- LoyaltiesMembersRedemptionRedeemRequestBody
- LoyaltiesMembersRedemptionRedeemRequestBodyReward
- LoyaltiesMembersRedemptionRedeemResponseBody
- LoyaltiesMembersRewardsListResponseBody
- LoyaltiesMembersRewardsListResponseBodyDataItem
- LoyaltiesMembersTiersListResponseBody
- LoyaltiesMembersTransactionsExportCreateRequestBody
- LoyaltiesMembersTransactionsExportCreateRequestBodyParameters
- LoyaltiesMembersTransactionsExportCreateResponseBody
- LoyaltiesMembersTransactionsListResponseBody
- LoyaltiesMembersTransfersCreateResponseBody
- LoyaltiesMembersTransfersCreateResponseBodyAssets
- LoyaltiesMembersTransfersCreateResponseBodyAssetsBarcode
- LoyaltiesMembersTransfersCreateResponseBodyAssetsQr
- LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard
- LoyaltiesMembersTransfersCreateResponseBodyPublish
- LoyaltiesMembersTransfersCreateResponseBodyRedemption
- LoyaltiesMembersTransfersCreateResponseBodyValidityTimeframe
- LoyaltiesRewardAssignmentsGetResponseBody
- LoyaltiesRewardAssignmentsRewardGetResponseBody
- LoyaltiesRewardsGetResponseBody
- LoyaltiesTiersCreateInBulkRequestBodyItem
- LoyaltiesTiersEarningRulesListResponseBody
- LoyaltiesTiersGetResponseBody
- LoyaltiesTiersListResponseBody
- LoyaltiesTiersRewardsListResponseBody
- LoyaltiesTransferPoints
- LoyaltyCardTransaction
- LoyaltyTier
- LoyaltyTierAllOfConfig
- LoyaltyTierAllOfConfigPoints
- LoyaltyTierBase
- LoyaltyTierBasePoints
- LoyaltyTierExpiration
- LoyaltyTiersExpirationAll
- LoyaltyTiersExpirationAllExpirationDate
- LoyaltyTiersExpirationAllExpirationDateRounding
- LoyaltyTiersExpirationAllStartDate
- LuckyDraw
- MappingPoints
- Order
- OrderBase
- OrderCalculated
- OrderCalculatedBase
- OrderCalculatedCustomer
- OrderCalculatedCustomerAddress
- OrderCalculatedNoCustomerData
- OrderCalculatedReferrer
- OrderItem
- OrderItemCalculated
- OrderItemCalculatedProduct
- OrderItemCalculatedSku
- OrderRedemptions
- OrdersCreateRequestBody
- OrdersCreateResponseBody
- OrdersExportCreateRequestBody
- OrdersExportCreateRequestBodyParameters
- OrdersExportCreateResponseBody
- OrdersGetResponseBody
- OrdersImportCreateRequestBodyItem
- OrdersImportCreateResponseBody
- OrdersListResponseBody
- OrdersUpdateRequestBody
- OrdersUpdateResponseBody
- ParameterCampaignType
- ParameterCreatedBeforeAfter
- ParameterExpandListCampaigns
- ParameterFiltersListRedemptions
- ParameterFiltersListRedemptionsCampaignName
- ParameterFiltersListRedemptionsCustomerId
- ParameterFiltersListRedemptionsFailureCode
- ParameterFiltersListRedemptionsObject
- ParameterFiltersListRedemptionsParentRedemptionId
- ParameterFiltersListRedemptionsRelatedObjectId
- ParameterFiltersListRedemptionsRelatedObjectParentId
- ParameterFiltersListRedemptionsResult
- ParameterFiltersListRedemptionsUserLogin
- ParameterFiltersListRedemptionsVoucherCode
- ParameterOrder
- ParameterOrderListAllPromotionStacks
- ParameterOrderListCampaigns
- ParameterOrderListCustomers
- ParameterOrderListExports
- ParameterOrderListLoyaltyTiers
- ParameterOrderListOrders
- ParameterOrderListPublications
- ParameterOrderListRedemptions
- ParameterOrderListValidationRuleAssignments
- ParameterOrderListValidationRules
- ParameterResultListPublications
- ParameterUpdatedBeforeAfter
- ParameterVoucherTypeListPublications
- Product
- ProductCollectionsCreateDynamicRequestBodyProductsItem
- ProductCollectionsCreateRequestBody
- ProductCollectionsCreateRequestBodyFilter
- ProductCollectionsCreateResponseBody
- ProductCollectionsGetResponseBody
- ProductCollectionsItem
- ProductCollectionsItemProductsItem
- ProductCollectionsList
- ProductCollectionsListResponseBody
- ProductCollectionsProductsList
- ProductCollectionsProductsListDataItem
- ProductCollectionsProductsListResponseBody
- ProductWithoutSkus
- ProductsCreateRequestBody
- ProductsCreateResponseBody
- ProductsGetResponseBody
- ProductsImportCsvCreateResponseBody
- ProductsListResponseBody
- ProductsMetadataUpdateInBulkRequestBody
- ProductsMetadataUpdateInBulkResponseBody
- ProductsSkusCreateRequestBody
- ProductsSkusCreateResponseBody
- ProductsSkusListResponseBody
- ProductsSkusUpdateRequestBody
- ProductsSkusUpdateResponseBody
- ProductsUpdateInBulkRequestBody
- ProductsUpdateInBulkResponseBody
- ProductsUpdateRequestBody
- ProductsUpdateResponseBody
- PromotionStack
- PromotionStackBase
- PromotionStackBaseTiers
- PromotionTier
- PromotionTierAction
- PromotionTierCampaign
- PromotionTierCampaignValidityTimeframe
- PromotionTierCreateParams
- PromotionTierSummary
- PromotionTierSummaryOrders
- PromotionTierSummaryRedemptions
- PromotionTierValidityTimeframe
- PromotionTiersList
- PromotionsStacksCreateRequestBody
- PromotionsStacksCreateResponseBody
- PromotionsStacksGetResponseBody
- PromotionsStacksListResponseBody
- PromotionsStacksUpdateRequestBody
- PromotionsStacksUpdateRequestBodyTiers
- PromotionsStacksUpdateResponseBody
- PromotionsTiersDisableResponseBody
- PromotionsTiersEnableResponseBody
- PromotionsTiersGetResponseBody
- PromotionsTiersListResponseBody
- PublicationsCreateRequestBody
- PublicationsCreateRequestBodyCustomer
- PublicationsCreateRequestBodyCustomerAddress
- PublicationsCreateResponseBody
- PublicationsListResponseBody
- PublicationsListResponseBodyPublicationsItem
- QualificationsCheckEligibilityRequestBody
- QualificationsCheckEligibilityResponseBody
- QualificationsFieldConditions
- QualificationsFiltersCondition
- QualificationsOption
- QualificationsOptionFilters
- QualificationsRedeemable
- QualificationsRedeemableBase
- QualificationsRedeemables
- RedeemableGift
- RedeemableLoyaltyCard
- RedeemableResult
- Redemption
- RedemptionChannel
- RedemptionGift
- RedemptionInternalRelatedRedemptionsItem
- RedemptionInternalRelatedRedemptionsRollbacksItem
- RedemptionLoyaltyCard
- RedemptionRelatedRedemptions
- RedemptionRelatedRedemptionsItem
- RedemptionRelatedRedemptionsRollbacksItem
- RedemptionRewardResult
- RedemptionRewardResultParameters
- RedemptionRewardResultParametersCampaign
- RedemptionRewardResultParametersCoin
- RedemptionRewardResultParametersProduct
- RedemptionRewardResultProduct
- RedemptionRewardResultSku
- RedemptionRewardResultVoucher
- RedemptionRollback
- RedemptionRollbackRelatedRedemptions
- RedemptionRollbackRelatedRedemptionsItem
- RedemptionRollbackRelatedRedemptionsRollbacksItem
- RedemptionsGetResponseBody
- RedemptionsGetResponseBodyChannel
- RedemptionsGetResponseBodyCustomer
- RedemptionsGetResponseBodyGift
- RedemptionsGetResponseBodyLoyaltyCard
- RedemptionsGetResponseBodyOrder
- RedemptionsGetResponseBodyOrderCustomer
- RedemptionsGetResponseBodyOrderReferrer
- RedemptionsGetResponseBodyPromotionTier
- RedemptionsGetResponseBodyPromotionTierAction
- RedemptionsGetResponseBodyPromotionTierCampaign
- RedemptionsGetResponseBodyPromotionTierCampaignValidityTimeframe
- RedemptionsGetResponseBodyPromotionTierSummary
- RedemptionsGetResponseBodyPromotionTierSummaryOrders
- RedemptionsGetResponseBodyPromotionTierSummaryRedemptions
- RedemptionsGetResponseBodyPromotionTierValidityTimeframe
- RedemptionsGetResponseBodyRelatedRedemptions
- RedemptionsGetResponseBodyRelatedRedemptionsRedemptionsItem
- RedemptionsGetResponseBodyRelatedRedemptionsRollbacksItem
- RedemptionsGetResponseBodyVoucher
- RedemptionsGetResponseBodyVoucherGift
- RedemptionsGetResponseBodyVoucherLoyaltyCard
- RedemptionsGetResponseBodyVoucherPublish
- RedemptionsGetResponseBodyVoucherRedemption
- RedemptionsGetResponseBodyVoucherValidityTimeframe
- RedemptionsListResponseBody
- RedemptionsListResponseBodyRedemptionsItem
- RedemptionsListResponseBodyRedemptionsItemChannel
- RedemptionsListResponseBodyRedemptionsItemCustomer
- RedemptionsListResponseBodyRedemptionsItemGift
- RedemptionsListResponseBodyRedemptionsItemLoyaltyCard
- RedemptionsListResponseBodyRedemptionsItemOrder
- RedemptionsListResponseBodyRedemptionsItemOrderCustomer
- RedemptionsListResponseBodyRedemptionsItemOrderReferrer
- RedemptionsListResponseBodyRedemptionsItemPromotionTier
- RedemptionsListResponseBodyRedemptionsItemPromotionTierAction
- RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign
- RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaignValidityTimeframe
- RedemptionsListResponseBodyRedemptionsItemPromotionTierSummary
- RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryOrders
- RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptions
- RedemptionsListResponseBodyRedemptionsItemPromotionTierValidityTimeframe
- RedemptionsListResponseBodyRedemptionsItemRelatedRedemptions
- RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsItem
- RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem
- RedemptionsListResponseBodyRedemptionsItemVoucher
- RedemptionsListResponseBodyRedemptionsItemVoucherGift
- RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard
- RedemptionsListResponseBodyRedemptionsItemVoucherPublish
- RedemptionsListResponseBodyRedemptionsItemVoucherRedemption
- RedemptionsListResponseBodyRedemptionsItemVoucherValidityTimeframe
- RedemptionsRedeemRequestBody
- RedemptionsRedeemResponseBody
- RedemptionsRollbackCreateRequestBody
- RedemptionsRollbackCreateResponseBody
- RedemptionsRollbacksCreateRequestBody
- RedemptionsRollbacksCreateResponseBody
- ReferralProgram
- ReferralProgramCustomEvent
- ReferralProgramRefereeReward
- ReferralProgramRefereeRewardRelatedObjectParent
- Referrer
- ReferrerId
- Reward
- RewardAssignment
- RewardAssignmentBase
- RewardAssignmentParameters
- RewardAssignmentParametersParameters
- RewardAssignmentParametersParametersLoyalty
- RewardAttributes
- RewardType
- RewardTypeCampaign
- RewardTypeCoin
- RewardTypeProduct
- RewardsAssignmentsCreateRequestBody
- RewardsAssignmentsCreateRequestBodyParameters
- RewardsAssignmentsCreateRequestBodyParametersLoyalty
- RewardsAssignmentsCreateResponseBody
- RewardsAssignmentsGetResponseBody
- RewardsAssignmentsListResponseBody
- RewardsAssignmentsUpdateRequestBody
- RewardsAssignmentsUpdateRequestBodyParameters
- RewardsAssignmentsUpdateRequestBodyParametersLoyalty
- RewardsAssignmentsUpdateResponseBody
- Session
- SimpleCampaign
- SimpleConsent
- SimpleCustomer
- SimpleCustomerRequiredObjectType
- SimpleOrder
- SimpleOrderItem
- SimpleProduct
- SimpleProductDiscountUnit
- SimplePromotionTier
- SimplePromotionTierCampaign
- SimpleRedemption
- SimpleRedemptionRewardResult
- SimpleReferralTier
- SimpleSegment
- SimpleSku
- SimpleSkuDiscountUnit
- SimpleVoucher
- Sku
- SkusGetResponseBody
- SkusImportCsvCreateResponseBody
- SkusList
- SkusListForProduct
- StackableValidateRedeemBase
- StackableValidateRedeemBaseRedeemablesItem
- StackableValidateRedeemBaseRedeemablesItemGift
- StackableValidateRedeemBaseRedeemablesItemReward
- StackingRules
- ValidationEntity
- ValidationRule
- ValidationRuleAssignment
- ValidationRuleAssignmentsList
- ValidationRuleBase
- ValidationRuleBaseApplicableTo
- ValidationRuleBaseError
- ValidationRulesAssignmentsList
- ValidationRulesAssignmentsListResponseBody
- ValidationRulesCreateRequestBody
- ValidationRulesCreateResponseBody
- ValidationRulesGetResponseBody
- ValidationRulesListResponseBody
- ValidationRulesUpdateRequestBody
- ValidationRulesUpdateResponseBody
- ValidationsRedeemableApplicable
- ValidationsRedeemableApplicableResult
- ValidationsRedeemableApplicableResultDiscount
- ValidationsRedeemableApplicableResultDiscountProduct
- ValidationsRedeemableApplicableResultLoyaltyCard
- ValidationsRedeemableInapplicable
- ValidationsRedeemableInapplicableResult
- ValidationsRedeemableSkipped
- ValidationsValidateRequestBody
- ValidationsValidateResponseBody
- ValidationsValidateResponseBodyRedeemablesItem
- ValidationsValidateResponseBodyRedeemablesItemResult
- ValidationsValidateResponseBodyRedeemablesItemResultDiscount
- ValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct
- ValidationsValidateResponseBodyRedeemablesItemResultGift
- ValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard
- Voucher
- VoucherAssets
- VoucherGift
- VoucherLoyaltyCard
- VoucherPublish
- VoucherRedemption
- VoucherTransaction
- VoucherTransactionDetails
- VoucherTransactionDetailsBalance
- VoucherTransactionDetailsBalanceRelatedObject
- VoucherTransactionDetailsCustomEvent
- VoucherTransactionDetailsEarningRule
- VoucherTransactionDetailsEarningRuleSource
- VoucherTransactionDetailsEvent
- VoucherTransactionDetailsEventSchema
- VoucherTransactionDetailsLoyaltyTier
- VoucherTransactionDetailsOrder
- VoucherTransactionDetailsRedemption
- VoucherTransactionDetailsReward
- VoucherTransactionDetailsRollback
- VoucherTransactionDetailsSegment
- VoucherTransactionsExport
- VoucherTransactionsExportFilterConditions
- VoucherTransactionsExportFilterConditionsVoucherId
- VoucherTransactionsExportFilterConditionsVoucherIdConditions
- VoucherTransactionsExportParameters
- VoucherTransactionsExportResult
- VoucherTransactionsFilters
- VoucherValidityTimeframe
- VouchersBalanceUpdateRequestBody
- VouchersBalanceUpdateResponseBody
- VouchersBalanceUpdateResponseBodyRelatedObject
- VouchersDisableResponseBody
- VouchersEnableResponseBody
- VouchersGetResponseBody
- VouchersImportCsvCreateResponseBody
- VouchersRedemptionGetResponseBody
- VouchersRedemptionGetResponseBodyRedemptionEntriesItem
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemChannel
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemCustomer
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemGift
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemLoyaltyCard
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemOrder
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemOrderCustomer
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemOrderReferrer
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemPromotionTier
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemPromotionTierAction
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemPromotionTierCampaign
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemPromotionTierCampaignValidityTimeframe
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemPromotionTierSummary
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemPromotionTierSummaryOrders
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemPromotionTierSummaryRedemptions
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemPromotionTierValidityTimeframe
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemRelatedRedemptions
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemRelatedRedemptionsRedemptionsItem
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemRelatedRedemptionsRollbacksItem
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemVoucher
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemVoucherGift
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemVoucherLoyaltyCard
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemVoucherPublish
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemVoucherRedemption
- VouchersRedemptionGetResponseBodyRedemptionEntriesItemVoucherValidityTimeframe
- VouchersTransactionsExportCreateRequestBody
- VouchersTransactionsExportCreateResponseBody
- VouchersTransactionsListResponseBody
- Type: API key
- API key parameter name: X-App-Id
- Location: HTTP header
- Type: API key
- API key parameter name: X-App-Token
- Location: HTTP header
- Type: API key
- API key parameter name: X-Client-Token
- Location: HTTP header
- Type: API key
- API key parameter name: X-Client-Application-Id
- Location: HTTP header
- Copy
.env.example
to.env
and fill in the values. - Run
docker build -t php .
to build the image. - Run
docker run --rm php
to run the tests and delete container immediately after.
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
v2018-08-01
- Build package:
org.openapitools.codegen.languages.PhpNextgenClientCodegen