Voucherify promotion engine REST API. Please see https://docs.voucherify.io/docs for more details.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: v2018-08-01
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.voucherify.io/contact-support
- Go in root directory of the SDK.
- Copy .env.example to .env and fill in the values.
- Run
docker build -t python .
to build the image. - Run
docker run --rm -v $(pwd):/app python
to run the tests and delete container immediately after. - Make changes You desire and run again command from step 4. It uses volumes so no need to rebuild the image.
Python 3.7+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import voucherify_client
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import voucherify_client
Execute pytest
to run the tests.
Please follow the installation procedure and then run the following:
import time
import voucherify_client
from voucherify_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.voucherify.io
# See configuration.py for a list of all supported configuration parameters.
configuration = voucherify_client.Configuration(
host = "https://api.voucherify.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: X-App-Id
configuration.api_key['X-App-Id'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Id'] = 'Bearer'
# Configure API key authorization: X-App-Token
configuration.api_key['X-App-Token'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-App-Token'] = 'Bearer'
# Enter a context with an instance of the API client
with voucherify_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = voucherify_client.CampaignsApi(api_client)
campaign_id = 'campaign_id_example' # str | 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' # str | 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"}} # CampaignsVouchersCreateRequestBody | Specify the voucher parameters that you would like to overwrite. (optional)
try:
# Add Voucher with Specific Code to Campaign
api_response = api_instance.add_voucher_with_specific_code_to_campaign(campaign_id, code, campaigns_vouchers_create_request_body=campaigns_vouchers_create_request_body)
print("The response of CampaignsApi->add_voucher_with_specific_code_to_campaign:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling CampaignsApi->add_voucher_with_specific_code_to_campaign: %s\n" % e)
All URIs are relative to https://api.voucherify.io
Class | Method | HTTP request | Description |
---|---|---|---|
CampaignsApi | add_voucher_with_specific_code_to_campaign | POST /v1/campaigns/{campaignId}/vouchers/{code} | Add Voucher with Specific Code to Campaign |
CampaignsApi | add_vouchers_to_campaign | POST /v1/campaigns/{campaignId}/vouchers | Add Vouchers to Campaign |
CampaignsApi | create_campaign | POST /v1/campaigns | Create Campaign |
CampaignsApi | delete_campaign | DELETE /v1/campaigns/{campaignId} | Delete Campaign |
CampaignsApi | disable_campaign | POST /v1/campaigns/{campaignId}/disable | Disable Campaign |
CampaignsApi | enable_campaign | POST /v1/campaigns/{campaignId}/enable | Enable Campaign |
CampaignsApi | get_campaign | GET /v1/campaigns/{campaignId} | Get Campaign |
CampaignsApi | import_vouchers_to_campaign | POST /v1/campaigns/{campaignId}/import | Import Vouchers to Campaign |
CampaignsApi | import_vouchers_to_campaign_using_csv | POST /v1/campaigns/{campaignId}/importCSV | Import Vouchers to Campaign by CSV |
CampaignsApi | list_campaigns | GET /v1/campaigns | List Campaigns |
CampaignsApi | update_campaign | PUT /v1/campaigns/{campaignId} | Update Campaign |
CategoriesApi | create_category | POST /v1/categories | Create Category |
CategoriesApi | delete_category | DELETE /v1/categories/{categoryId} | Delete Category |
CategoriesApi | get_category | GET /v1/categories/{categoryId} | Get Category |
CategoriesApi | list_categories | GET /v1/categories | List Categories |
CategoriesApi | update_category | PUT /v1/categories/{categoryId} | Update Category |
CustomersApi | create_customer | POST /v1/customers | Create Customer |
CustomersApi | customer_permanently_deletion | POST /v1/customers/{customerId}/permanent-deletion | Delete Customer Permanently |
CustomersApi | delete_customer | DELETE /v1/customers/{customerId} | Delete Customer |
CustomersApi | get_customer | GET /v1/customers/{customerId} | Get Customer |
CustomersApi | import_customers_using_csv | POST /v1/customers/importCSV | Import and Update Customers using CSV |
CustomersApi | list_customer_activities | GET /v1/customers/{customerId}/activities | List Customer Activities |
CustomersApi | list_customer_segments | GET /v1/customers/{customerId}/segments | List Customer's Segments |
CustomersApi | list_customers | GET /v1/customers | List Customers |
CustomersApi | update_customer | PUT /v1/customers/{customerId} | Update Customer |
CustomersApi | update_customers_consents | PUT /v1/customers/{customerId}/consents | Update Customer's consents |
CustomersApi | update_customers_consents_client_side | PUT /client/v1/customers/{customerId}/consents | Update Customer's consents (client-side) |
CustomersApi | update_customers_in_bulk | POST /v1/customers/bulk/async | Update Customers in bulk |
CustomersApi | update_customers_metadata_in_bulk | POST /v1/customers/metadata/async | Update Customers' Metadata in bulk |
EventsApi | track_custom_event | POST /v1/events | Track Custom Event |
EventsApi | track_custom_event_client_side | POST /client/v1/events | Track Custom Event (client-side) |
ExportsApi | create_export | POST /v1/exports | Create Export |
ExportsApi | delete_export | DELETE /v1/exports/{exportId} | Delete Export |
ExportsApi | download_export | GET /v1/exports/{export_Id} | Download Export |
ExportsApi | get_export | GET /v1/exports/{exportId} | Get Export |
ExportsApi | list_exports | GET /v1/exports | List Exports |
LoyaltiesApi | create_in_bulk_loyalty_tiers | POST /v1/loyalties/{campaignId}/tiers | Create loyalty tiers |
LoyaltiesApi | delete_earning_rule | DELETE /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Delete Earning Rule |
LoyaltiesApi | delete_loyalty_program | DELETE /v1/loyalties/{campaignId} | Delete Loyalty Campaign |
LoyaltiesApi | delete_reward_assignment1 | DELETE /v1/loyalties/{campaignId}/rewards/{assignmentId} | Delete Reward Assignment |
LoyaltiesApi | disable_earning_rule | POST /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | Disable Earning Rule |
LoyaltiesApi | enable_earning_rule | POST /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | Enable Earning Rule |
LoyaltiesApi | export_loyalty_card_transactions | POST /v1/loyalties/members/{memberId}/transactions/export | Export Loyalty Card Transactions |
LoyaltiesApi | export_loyalty_card_transactions1 | POST /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | Export Loyalty Card Transactions |
LoyaltiesApi | get_earning_rule | GET /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | Get Earning Rule |
LoyaltiesApi | get_loyalty_tier | GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | Get Loyalty Tier |
LoyaltiesApi | get_reward_assignment1 | GET /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | Get Reward Assignment |
LoyaltiesApi | get_reward_assignment2 | GET /v1/loyalties/{campaignId}/rewards/{assignmentId} | Get Reward Assignment |
LoyaltiesApi | get_reward_details | GET /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | Get Reward Details |
LoyaltiesApi | list_loyalty_card_transactions | GET /v1/loyalties/members/{memberId}/transactions | List Loyalty Card Transactions |
LoyaltiesApi | list_loyalty_card_transactions1 | GET /v1/loyalties/{campaignId}/members/{memberId}/transactions | List Loyalty Card Transactions |
LoyaltiesApi | list_loyalty_tier_earning_rules | GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | List Loyalty Tier Earning Rules |
LoyaltiesApi | list_loyalty_tier_rewards | GET /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | List Loyalty Tier Rewards |
LoyaltiesApi | list_loyalty_tiers | GET /v1/loyalties/{campaignId}/tiers | List Loyalty Tiers |
LoyaltiesApi | list_member_loyalty_tier | GET /v1/loyalties/members/{memberId}/tiers | List Member's Loyalty Tiers |
LoyaltiesApi | list_member_rewards | GET /v1/loyalties/members/{memberId}/rewards | List Member Rewards |
LoyaltiesApi | list_points_expiration | GET /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | Get Points Expiration |
LoyaltiesApi | redeem_reward | POST /v1/loyalties/members/{memberId}/redemption | Redeem Reward |
LoyaltiesApi | redeem_reward1 | POST /v1/loyalties/{campaignId}/members/{memberId}/redemption | Redeem Reward |
LoyaltiesApi | transfer_points | POST /v1/loyalties/{campaignId}/members/{memberId}/transfers | Transfer Loyalty Points |
LoyaltiesApi | update_loyalty_card_balance | POST /v1/loyalties/members/{memberId}/balance | Add or Remove Loyalty Card Balance |
LoyaltiesApi | update_loyalty_card_balance1 | POST /v1/loyalties/{campaignId}/members/{memberId}/balance | Add or Remove Loyalty Card Balance |
OrdersApi | create_order | POST /v1/orders | Create Order |
OrdersApi | create_order_export | POST /v1/orders/export | Create Orders Export |
OrdersApi | get_order | GET /v1/orders/{orderId} | Get Order |
OrdersApi | import_orders | POST /v1/orders/import | Import Orders |
OrdersApi | list_orders | GET /v1/orders | List Orders |
OrdersApi | update_order | PUT /v1/orders/{orderId} | Update Order |
ProductCollectionsApi | create_product_collection | POST /v1/product-collections | Create Product Collection |
ProductCollectionsApi | delete_product_collection | DELETE /v1/product-collections/{productCollectionId} | Delete Product Collection |
ProductCollectionsApi | get_product_collection | GET /v1/product-collections/{productCollectionId} | Get Product Collection |
ProductCollectionsApi | list_product_collections | GET /v1/product-collections | List Product Collections |
ProductCollectionsApi | list_products_in_collection | GET /v1/product-collections/{productCollectionId}/products | List Products in Collection |
ProductsApi | create_product | POST /v1/products | Create Product |
ProductsApi | create_sku | POST /v1/products/{productId}/skus | Create SKU |
ProductsApi | delete_product | DELETE /v1/products/{productId} | Delete Product |
ProductsApi | delete_sku | DELETE /v1/products/{productId}/skus/{skuId} | Delete SKU |
ProductsApi | get_product | GET /v1/products/{productId} | Get Product |
ProductsApi | get_sku | GET /v1/skus/{skuId} | Get SKU |
ProductsApi | import_products_using_csv | POST /v1/products/importCSV | Import Products using CSV |
ProductsApi | import_skus_using_csv | POST /v1/skus/importCSV | Import SKUs using CSV |
ProductsApi | list_products | GET /v1/products | List Products |
ProductsApi | list_skus_in_product | GET /v1/products/{productId}/skus | List SKUs in Product |
ProductsApi | update_product | PUT /v1/products/{productId} | Update Product |
ProductsApi | update_products_in_bulk | POST /v1/products/bulk/async | Update Products in bulk |
ProductsApi | update_products_metadata_in_bulk | POST /v1/products/metadata/async | Update Products' Metadata in bulk |
ProductsApi | update_sku | PUT /v1/products/{productId}/skus/{skuId} | Update SKU |
PromotionsApi | create_promotion_stack | POST /v1/promotions/{campaignId}/stacks | Create Promotion Stack |
PromotionsApi | delete_promotion_stack | DELETE /v1/promotions/{campaignId}/stacks/{stackId} | Delete Promotion Stack |
PromotionsApi | delete_promotion_tier | DELETE /v1/promotions/tiers/{promotionTierId} | Delete Promotion Tier |
PromotionsApi | disable_promotion_tier | POST /v1/promotions/tiers/{promotionTierId}/disable | Disable Promotion Tier |
PromotionsApi | enable_promotion_tier | POST /v1/promotions/tiers/{promotionTierId}/enable | Enable Promotion Tier |
PromotionsApi | get_promotion_stack | GET /v1/promotions/{campaignId}/stacks/{stackId} | Get Promotion Stack |
PromotionsApi | get_promotion_tier | GET /v1/promotions/tiers/{promotionTierId} | Get Promotion Tier |
PromotionsApi | list_all_promotion_stacks | GET /v1/promotions/stacks | List Promotion Stacks |
PromotionsApi | list_promotion_stacks_in_campaign | GET /v1/promotions/{campaignId}/stacks | List Promotion Stacks in Campaign |
PromotionsApi | list_promotion_tiers_from_campaign | GET /v1/promotions/{campaignId}/tiers | List Promotion Tiers from Campaign |
PromotionsApi | update_promotion_stack | PUT /v1/promotions/{campaignId}/stacks/{stackId} | Update Promotion Stack |
PublicationsApi | create_publication | POST /v1/publications | Create Publication |
PublicationsApi | create_publication1 | GET /v1/publications/create | Create Publication |
PublicationsApi | list_publications | GET /v1/publications | List Publications |
QualificationsApi | check_eligibility | POST /v1/qualifications | Check Eligibility |
QualificationsApi | check_eligibility_client_side | POST /client/v1/qualifications | Check Eligibility (client-side) |
RedemptionsApi | get_redemption | GET /v1/redemptions/{redemptionId} | Get Redemption |
RedemptionsApi | get_voucher_redemptions | GET /v1/vouchers/{code}/redemption | Get Voucher's Redemptions |
RedemptionsApi | list_redemptions | GET /v1/redemptions | List Redemptions |
RedemptionsApi | rollback_redemption | POST /v1/redemptions/{redemptionId}/rollback | Rollback Redemption |
RewardsApi | create_reward_assignment | POST /v1/rewards/{rewardId}/assignments | Create Reward Assignment |
RewardsApi | delete_reward | DELETE /v1/rewards/{rewardId} | Delete Reward |
RewardsApi | delete_reward_assignment | DELETE /v1/rewards/{rewardId}/assignments/{assignmentId} | Delete Reward Assignment |
RewardsApi | get_reward_assignment | GET /v1/rewards/{rewardId}/assignments/{assignmentId} | Get Reward Assignment |
RewardsApi | list_reward_assignments | GET /v1/rewards/{rewardId}/assignments | List Reward Assignments |
RewardsApi | update_reward_assignment | PUT /v1/rewards/{rewardId}/assignments/{assignmentId} | Update Reward Assignment |
SegmentsApi | delete_segment | DELETE /v1/segments/{segmentId} | Delete Segment |
StackableDiscountsApi | redeem_stacked_discounts | POST /v1/redemptions | Redeem Stackable Discounts |
StackableDiscountsApi | redeem_stacked_discounts_client_side | POST /client/v1/redemptions | Redeem Stackable Discounts (client-side) |
StackableDiscountsApi | rollback_stacked_redemptions | POST /v1/redemptions/{parentRedemptionId}/rollbacks | Rollback Stackable Redemptions |
StackableDiscountsApi | validate_stacked_discounts | POST /v1/validations | Validate Stackable Discounts |
StackableDiscountsApi | validate_stacked_discounts_client_side | POST /client/v1/validations | Validate Stackable Discounts (client-side) |
ValidationRulesApi | create_validation_rules | POST /v1/validation-rules | Create Validation Rules |
ValidationRulesApi | delete_validation_rule_assignment | DELETE /v1/validation-rules/{validationRuleId}/assignments/{assignmentId} | Delete Validation Rule Assignment |
ValidationRulesApi | delete_validation_rules | DELETE /v1/validation-rules/{validationRuleId} | Delete Validation Rule |
ValidationRulesApi | get_validation_rule | GET /v1/validation-rules/{validationRuleId} | Get Validation Rule |
ValidationRulesApi | list_validation_rule_assignments | GET /v1/validation-rules/{validationRuleId}/assignments | List Validation Rule Assignments |
ValidationRulesApi | list_validation_rules | GET /v1/validation-rules | List Validation Rules |
ValidationRulesApi | list_validation_rules_assignments | GET /v1/validation-rules-assignments | List Validation Rules' Assignment(s) |
ValidationRulesApi | update_validation_rule | PUT /v1/validation-rules/{validationRuleId} | Update Validation Rule |
VouchersApi | delete_voucher | DELETE /v1/vouchers/{code} | Delete Voucher |
VouchersApi | disable_voucher | POST /v1/vouchers/{code}/disable | Disable Voucher |
VouchersApi | enable_voucher | POST /v1/vouchers/{code}/enable | Enable Voucher |
VouchersApi | export_voucher_transactions | POST /v1/vouchers/{code}/transactions/export | Export Voucher Transactions |
VouchersApi | get_voucher | GET /v1/vouchers/{code} | Get Voucher |
VouchersApi | import_vouchers_using_csv | POST /v1/vouchers/importCSV | Import Vouchers using CSV |
VouchersApi | list_voucher_transactions | GET /v1/vouchers/{code}/transactions | List Voucher Transactions |
VouchersApi | release_validation_session | DELETE /v1/vouchers/{code}/sessions/{sessionKey} | Release Validation Session |
VouchersApi | update_voucher_balance | POST /v1/vouchers/{code}/balance | Add or Remove Voucher Balance |
- Any
- ApplicableTo
- ApplicableToEffect
- ApplicableToResultList
- ArrayInner
- AsyncActions
- BusValRuleAssignment
- Campaign
- CampaignBase
- CampaignBaseValidityTimeframe
- CampaignLoyaltyCard
- CampaignLoyaltyCardExpirationRules
- CampaignLoyaltyVoucher
- CampaignLoyaltyVoucherRedemption
- CampaignVoucher
- CampaignsCreateBase
- CampaignsCreateDiscountCouponsCampaign
- CampaignsCreateGiftCampaign
- CampaignsCreateGiveawayCampaign
- CampaignsCreateLoyaltyCampaign
- CampaignsCreatePromotionCampaign
- CampaignsCreateReferralCampaign
- CampaignsCreateRequestBody
- CampaignsCreateResponseBody
- CampaignsDeleteResponseBody
- CampaignsDisableResponseBody
- CampaignsEnableResponseBody
- CampaignsGetResponseBody
- CampaignsImportCreateResponseBody
- CampaignsImportCsvCreateResponseBody
- CampaignsImportVoucherItem
- CampaignsImportVoucherItemRedemption
- CampaignsImportVoucherLoyaltyCard
- CampaignsListResponseBody
- CampaignsUpdateBase
- CampaignsUpdateCouponCampaignBase
- CampaignsUpdateDiscountCouponsCampaign
- CampaignsUpdateGiftCampaign
- CampaignsUpdateGiveawayCampaign
- CampaignsUpdateLoyaltyCampaign
- CampaignsUpdatePromotionCampaign
- CampaignsUpdateReferralCampaign
- CampaignsUpdateRequestBody
- 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
- CreatePublicationBase
- CreatePublicationCampaign
- CreatePublicationWithCampaign
- CreatePublicationWithSpecificVoucher
- CustomEvent
- CustomEventReferral
- Customer
- CustomerActivity
- CustomerActivityData
- CustomerBase
- CustomerBaseAddress
- CustomerId
- CustomerLoyalty
- 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
- DiscountAmount
- DiscountAmountVouchersEffectTypes
- DiscountCouponsCampaignVoucher
- DiscountFixed
- DiscountFixedVouchersEffectTypes
- DiscountPercent
- DiscountPercentVouchersEffectTypes
- DiscountUnit
- DiscountUnitMultiple
- DiscountUnitMultipleOneUnit
- DiscountUnitVouchersEffectTypes
- EarningRule
- EarningRuleBase
- EarningRuleBaseCustomEvent
- EarningRuleBaseLoyalty
- EarningRuleBaseSegment
- EarningRuleBaseSource
- EarningRuleBaseValidityTimeframe
- EarningRuleEvent
- EarningRuleFixed
- EarningRuleProportional
- EarningRuleProportionalCustomEvent
- EarningRuleProportionalCustomEventCustomEvent
- EarningRuleProportionalCustomEventCustomEventMetadata
- EarningRuleProportionalCustomerMetadata
- EarningRuleProportionalCustomerMetadataCustomer
- EarningRuleProportionalCustomerMetadataCustomerMetadata
- EarningRuleProportionalOrder
- EarningRuleProportionalOrderAmount
- EarningRuleProportionalOrderAmountOrder
- EarningRuleProportionalOrderAmountOrderAmount
- EarningRuleProportionalOrderItems
- EarningRuleProportionalOrderItemsAmount
- EarningRuleProportionalOrderItemsAmountOrderItems
- EarningRuleProportionalOrderItemsAmountOrderItemsAmount
- EarningRuleProportionalOrderItemsQuantity
- EarningRuleProportionalOrderItemsQuantityOrderItems
- EarningRuleProportionalOrderItemsSubtotalAmount
- EarningRuleProportionalOrderItemsSubtotalAmountOrderItems
- EarningRuleProportionalOrderMetadata
- EarningRuleProportionalOrderMetadataOrder
- EarningRuleProportionalOrderMetadataOrderMetadata
- EarningRuleProportionalOrderTotalAmount
- EarningRuleProportionalOrderTotalAmountOrder
- Error
- EventCustomerActiveCampaignFailed
- EventCustomerActiveCampaignRecovered
- EventCustomerActiveCampaignSent
- EventCustomerBatchFailed
- EventCustomerBatchRecovered
- EventCustomerBatchSent
- EventCustomerBrazeFailed
- EventCustomerBrazeRecovered
- EventCustomerBrazeSent
- EventCustomerConfirmed
- EventCustomerConfirmedUnconfirmedCustomer
- EventCustomerConsents
- EventCustomerConsentsGiven
- EventCustomerConsentsRevoked
- EventCustomerCreated
- EventCustomerCustomEvent
- EventCustomerDeleted
- EventCustomerEmailFailed
- EventCustomerEmailRecovered
- EventCustomerEmailSent
- EventCustomerFailed
- EventCustomerGiftVoucherBalanceAdded
- EventCustomerIntercomFailed
- EventCustomerIntercomRecovered
- EventCustomerIntercomSent
- EventCustomerKlaviyoFailed
- EventCustomerKlaviyoRecovered
- EventCustomerKlaviyoSent
- EventCustomerLoyaltyCardPointsAdded
- EventCustomerLoyaltyCardPointsTransferred
- EventCustomerLoyaltyTierBase
- EventCustomerLoyaltyTierDowngraded
- EventCustomerLoyaltyTierExpirationChanged
- EventCustomerLoyaltyTierJoined
- EventCustomerLoyaltyTierLeft
- EventCustomerLoyaltyTierProlonged
- EventCustomerLoyaltyTierUpgraded
- EventCustomerLoyaltyUpdated
- EventCustomerMailchimpFailed
- EventCustomerMailchimpRecovered
- EventCustomerMailchimpSent
- EventCustomerOrder
- EventCustomerOrderCanceled
- EventCustomerOrderCreated
- EventCustomerOrderFulfilled
- EventCustomerOrderPaid
- EventCustomerOrderProcessing
- EventCustomerOrderUpdated
- EventCustomerPublicationFailed
- EventCustomerPublicationSucceeded
- EventCustomerRecovered
- EventCustomerRedemption
- EventCustomerRedemptionFailed
- EventCustomerRedemptionRollbackFailed
- EventCustomerRedemptionRollbackSucceeded
- EventCustomerRedemptionSucceeded
- EventCustomerReferred
- EventCustomerRewardRedemptions
- EventCustomerRewardRedemptionsCompleted
- EventCustomerRewardRedemptionsCreated
- EventCustomerRewardRedemptionsPending
- EventCustomerRewardRedemptionsRolledBack
- EventCustomerRewarded
- EventCustomerRewardedLoyaltyPoints
- EventCustomerSegmentEntered
- EventCustomerSegmentLeft
- EventCustomerSent
- EventCustomerShopifyFailed
- EventCustomerShopifyRecovered
- EventCustomerShopifySent
- EventCustomerSmsFailed
- EventCustomerSmsRecovered
- EventCustomerSmsSent
- EventCustomerUpdated
- EventCustomerValidationFailed
- EventCustomerValidationSucceeded
- EventCustomerVoucherDeleted
- EventCustomerVouchersLoyaltyPointsExpired
- EventsCreateRequestBody
- EventsCreateResponseBody
- Export
- ExportBase
- ExportBaseResult
- ExportCustomer
- ExportCustomerBase
- ExportCustomerBaseParameters
- ExportCustomerFields
- ExportCustomerOrder
- ExportCustomerScheduled
- ExportOrder
- ExportOrderBase
- ExportOrderFields
- ExportOrderOrder
- ExportOrderScheduled
- ExportPointsExpiration
- ExportPointsExpirationBase
- ExportPointsExpirationBaseParameters
- ExportPointsExpirationFields
- ExportPointsExpirationFilters
- ExportPointsExpirationOrder
- ExportPointsExpirationScheduled
- ExportPublication
- ExportPublicationBase
- ExportPublicationBaseParameters
- ExportPublicationFields
- ExportPublicationOrder
- ExportPublicationScheduled
- ExportRedemption
- ExportRedemptionBase
- ExportRedemptionBaseParameters
- ExportRedemptionFields
- ExportRedemptionOrder
- ExportRedemptionScheduled
- ExportScheduledBase
- ExportVoucher
- ExportVoucherBase
- ExportVoucherBaseParameters
- ExportVoucherFields
- ExportVoucherOrder
- ExportVoucherScheduled
- ExportVoucherTransactions
- ExportVoucherTransactionsBase
- ExportVoucherTransactionsFields
- ExportVoucherTransactionsFilters
- ExportVoucherTransactionsOrder
- ExportVoucherTransactionsScheduled
- ExportsCreateRequestBody
- ExportsCreateResponseBody
- ExportsGetResponseBody
- ExportsListResponseBody
- FieldConditions
- FilterConditionsString
- FiltersCondition
- Gift
- GiftCampaignVoucher
- GiveawayCampaignVoucher
- InapplicableTo
- InapplicableToResultList
- Junction
- ListPublicationsItemBase
- ListPublicationsItemInvalid
- ListPublicationsItemValidMultipleVouchers
- ListPublicationsItemValidSingleVoucher
- 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
- LoyaltyCardTransactionsType
- LoyaltyTier
- LoyaltyTierAllOfConfig
- LoyaltyTierAllOfConfigPoints
- LoyaltyTierBase
- LoyaltyTierBasePoints
- LoyaltyTierExpiration
- LoyaltyTiersExpirationAll
- LoyaltyTiersExpirationAllExpirationDate
- LoyaltyTiersExpirationAllExpirationDateRounding
- LoyaltyTiersExpirationAllStartDate
- LuckyDraw
- Order
- OrderBase
- OrderCalculated
- OrderCalculatedBase
- OrderCalculatedCustomer
- OrderCalculatedNoCustomerData
- OrderCalculatedReferrer
- OrderItem
- OrderItemCalculated
- OrderItemProduct
- OrderItemSku
- 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
- PointsExpirationTypes
- Product
- ProductCollectionsCreateDynamicRequestBody
- ProductCollectionsCreateDynamicRequestBodyFilter
- ProductCollectionsCreateDynamicRequestBodyProductsItem
- ProductCollectionsCreateRequestBody
- ProductCollectionsCreateResponseBody
- ProductCollectionsCreateStaticRequestBody
- ProductCollectionsGetResponseBody
- ProductCollectionsItem
- ProductCollectionsItemProductsItem
- ProductCollectionsList
- ProductCollectionsListResponseBody
- ProductCollectionsProductsList
- ProductCollectionsProductsListProductsItem
- 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
- PropertiesForLoyaltyCampaignOptions
- PublicationsCreateBaseResponseBody
- PublicationsCreateRequestBody
- PublicationsCreateResponseBody
- PublicationsCreateVoucherResponseBody
- PublicationsCreateVouchersResponseBody
- PublicationsListResponseBody
- PublicationsListResponseBodyPublicationsItem
- QualificationsCheckEligibilityRequestBody
- QualificationsCheckEligibilityResponseBody
- QualificationsFieldConditions
- QualificationsFiltersCondition
- QualificationsOption
- QualificationsOptionFilters
- QualificationsRedeemable
- QualificationsRedeemableBase
- QualificationsRedeemables
- RedeemGiftCard
- RedeemGiftCardAllOfGift
- RedeemLoyaltyCard
- RedeemLoyaltyCardAllOfReward
- RedeemPromotionStack
- RedeemPromotionTier
- RedeemVoucher
- RedeemableGift
- RedeemableLoyaltyCard
- RedeemableResult
- RedeemableResultGiftCard
- RedeemableResultGiftCardGift
- RedeemableResultLoyaltyCard
- RedeemableResultLoyaltyCardLoyaltyCard
- RedeemableResultPromotionStack
- RedeemableResultPromotionTier
- RedeemableResultPromotionTierDiscount
- RedeemableResultVoucherCode
- Redemption
- RedemptionChannel
- RedemptionGift
- RedemptionInternal
- RedemptionInternalRelatedRedemptions
- RedemptionInternalRelatedRedemptionsItem
- RedemptionInternalRelatedRedemptionsRollbacksItem
- RedemptionLoyaltyCard
- RedemptionRelatedRedemptions
- RedemptionRelatedRedemptionsItem
- RedemptionRelatedRedemptionsRollbacksItem
- RedemptionRewardResult
- RedemptionRewardResultParameters
- RedemptionRewardResultParametersCampaign
- RedemptionRewardResultParametersCoin
- RedemptionRewardResultParametersProduct
- RedemptionRewardResultProduct
- RedemptionRewardResultSku
- RedemptionRewardResultVoucher
- RedemptionRollback
- RedemptionRollbackRelatedRedemptions
- RedemptionRollbackRelatedRedemptionsItem
- RedemptionRollbackRelatedRedemptionsRollbacksItem
- RedemptionsGetResponseBody
- RedemptionsListResponseBody
- RedemptionsListResponseBodyRedemptionsItem
- RedemptionsRedeemRequestBody
- RedemptionsRedeemResponseBody
- RedemptionsRollbackCreateRequestBody
- RedemptionsRollbackCreateResponseBody
- RedemptionsRollbacksCreateRequestBody
- RedemptionsRollbacksCreateResponseBody
- ReferralCampaignVoucher
- ReferralProgram
- ReferralProgramCustomEvent
- ReferralProgramRefereeReward
- ReferralProgramRefereeRewardRelatedObjectParent
- Referrer
- ReferrerId
- ReferrerWithSummaryLoyaltyReferrals
- Reward
- RewardAssignment
- RewardAssignmentBase
- RewardAssignmentParameters
- RewardAssignmentParametersParameters
- RewardAssignmentParametersParametersLoyalty
- RewardAssignmentsCreateCoinRewardRequestBody
- RewardAssignmentsCreateDigitalOrMaterialRewardRequestBody
- RewardAssignmentsCreateDigitalOrMaterialRewardRequestBodyParameters
- RewardAssignmentsCreateDigitalOrMaterialRewardRequestBodyParametersLoyalty
- RewardAttributes
- RewardType
- RewardTypeCampaign
- RewardTypeCampaignCampaign
- RewardTypeCoin
- RewardTypeCoinCoin
- RewardTypeMaterial
- RewardTypeMaterialProduct
- RewardsAssignmentsCreateRequestBody
- RewardsAssignmentsCreateResponseBody
- RewardsAssignmentsGetResponseBody
- RewardsAssignmentsListResponseBody
- RewardsAssignmentsUpdateRequestBody
- RewardsAssignmentsUpdateRequestBodyParameters
- RewardsAssignmentsUpdateRequestBodyParametersLoyalty
- RewardsAssignmentsUpdateResponseBody
- SchemaThatContainsUniquePropertiesForPromotionCampaignPromotion
- Session
- SimpleCampaign
- SimpleConsent
- SimpleCustomer
- SimpleCustomerRequiredObjectType
- SimpleOrder
- SimpleOrderItem
- SimpleProduct
- SimpleProductDiscountUnit
- SimplePromotionTier
- SimplePromotionTierCampaign
- SimpleRedemption
- SimpleRedemptionRewardResult
- SimpleReferralTier
- SimpleSegment
- SimpleSku
- SimpleSkuDiscountUnit
- SimpleVoucher
- Sku
- SkuWithProduct
- SkusGetResponseBody
- SkusImportCsvCreateResponseBody
- SkusList
- SkusListForProduct
- StackableValidateRedeemBase
- StackableValidateRedeemBaseRedeemablesItem
- StackingRules
- ValidationEntity
- ValidationRule
- ValidationRuleAssignment
- ValidationRuleAssignmentsList
- ValidationRuleBase
- ValidationRuleBaseApplicableTo
- ValidationRuleBaseError
- ValidationRulesAssignmentsList
- ValidationRulesAssignmentsListResponseBody
- ValidationRulesCreateRequestBody
- ValidationRulesCreateResponseBody
- ValidationRulesGetResponseBody
- ValidationRulesListResponseBody
- ValidationRulesUpdateRequestBody
- ValidationRulesUpdateResponseBody
- ValidationsRedeemableApplicable
- ValidationsRedeemableApplicableResult
- ValidationsRedeemableInapplicable
- ValidationsRedeemableInapplicableResult
- ValidationsRedeemableSkipped
- ValidationsValidateAllResponseBodyRedeemablesItem
- ValidationsValidateRequestBody
- ValidationsValidateResponseBody
- 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
- VouchersTransactionsExportCreateRequestBody
- VouchersTransactionsExportCreateResponseBody
- VouchersTransactionsListResponseBody
Authentication schemes defined for the API:
- 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