Package io.voucherify.client.model
package io.voucherify.client.model
-
ClassDescriptionAbstract class for oneOf,anyOf schemas defined in OpenAPI specLists all assignments of the campaign to areas and stores.Identifies the name of the attribute that contains the array of campaign assignments.The type of the object represented by JSON.ApplicableToThis object stores information about the resource to which the discount is applicable.Gets or Sets ApplicableToEffectApplicableToResultListThe type of the object represented by JSON.The type of the object represented by JSON.An object representing an assignment of a campaign to an area or store.The type of the object represented by JSON.This is an object representing an asynchronous action.The type of the object represented by JSON.Status of the async action.Response body schema for **GET** `v1/async-actions/{asyncActionId}`.The type of the object represented by JSON.Status of the async action.Response body schema for **GET** `v1/async-actions`.Identifies the name of the JSON property that contains the array of asynchronous actions.The type of the object represented by JSON.Assignments of business validation ruleThe type of the object represented by JSON.The validation status of the assignmentCampaignType of campaign.Indicates the status of the campaign creation.Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.Gets or Sets validityDayOfWeekIndicates the status of the campaign's voucher generation.This is an object representing a campaign.Type of campaign.Indicates the status of the campaign creation.Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.Gets or Sets validityDayOfWeekIndicates the status of the campaign's voucher generation.Schema model for a campaign loyalty card.CampaignLoyaltyCardExpirationRulesType of periodType of roundingSchema model for a discount voucher.Type of voucher.Defines the redemption limits on vouchers.CampaignsCreateRequestBodyGets or Sets campaignTypeDefines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.Gets or Sets validityDayOfWeekCampaignsCreateRequestBodyPromotionCampaignsCreateRequestBodyVoucherGets or Sets typeCampaignsCreateRequestBodyVoucherRedemptionResponse body schema for **POST** `v1/campaigns/{campaignId}`.Type of campaign.Indicates the status of the campaign creation.Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.Gets or Sets validityDayOfWeekIndicates the status of the campaign's voucher generation.Response body schema for **DELETE** `/campaigns/{campaignId}`.Response body schema for **GET** `v1/campaigns/{campaignId}`.Type of campaign.Indicates the status of the campaign creation.Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.Gets or Sets validityDayOfWeekIndicates the status of the campaign's voucher generation.Response body schema for **POST** `v1/campaigns/{campaignId}/import`.Response body schema for **POST** `v1/campaigns/{campaignId}/importCSV`.CampaignsImportVoucherItemGets or Sets typeGets or Sets validityDayOfWeekCampaignsImportVoucherItemRedemptionSchema model for **GET** `v1/campaigns`.CampaignsUpdateRequestBodyDefines whether the campaign can be updated with new vouchers after campaign creation.Gets or Sets validityDayOfWeekCampaignsUpdateRequestBodyOptionsResponse body schema for **PUT** `v1/campaigns/{campaignId}`.Type of campaign.Indicates the status of the campaign creation.Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.Gets or Sets validityDayOfWeekIndicates the status of the campaign's voucher generation.CampaignsVouchersCreateCombinedResponseBodyDefines the type of the voucher.Gets or Sets validityDayOfWeekObject representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.Stores a summary of publication events: an event counter and endpoint to return details of each event.Stores a summary of redemptions that have been applied to the voucher.Request body schema for **POST** `v1/campaigns/{campaignId}/vouchers`.Stores the quantity of redemptions that can be applied to the voucher.Request body schema for **POST** `v1/campaigns/{campaignId}/vouchers/{code}`.Stores the quantity of redemptions that can be applied to the voucher.Response body schema for **POST** `v1/campaigns/{campaignId}/vouchers/{code}` and **POST** `v1/campaigns/{campaignId}/vouchers`.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.Stores a summary of publication events: an event counter and endpoint to return details of each event.Stores a summary of redemptions that have been applied to the voucher.CampaignTemplateType of the campaign used to create the campaign template.The type of the object represented by JSON.Schema model for a campaign voucher.Gets or Sets validityDayOfWeekDefines the redemption limits on vouchers.Request body schema for **POST** `v1/categories`.Response body schema for **POST** `v1/categories`.Gets or Sets _objectResponse body schema for **GET** `v1/categories/{categoryId}`.The type of the object represented by the JSON.Response body schema for **GET** `v1/categories`.Identifies the name of the attribute that contains the array of category objects.The type of the object represented by JSON.Request body schema for **PUT** `v1/categories/{categoryId}`.Response body schema for **PUT** `v1/categories/{categoryId}`.Gets or Sets _objectThis is an object representing a category.The type of the object represented by the JSON.Category object with `stacking_rules_type`The type of the object represented by the JSON.The type of the stacking rule eligibility.Request body schema for **POST** `v1/events`.If an earning rule in a loyalty program is based on a custom event.If a **conversion event** for a referral program is set to a custom event, then you need to send the referral code in the payload to make a record of the conversion event.Response body schema for **POST** `v1/events`.The object represented is an `event`.Response body schema for **GET** `v1/client/v1/promotions/tiers`.Request body schema for **POST** `v1/qualifications`.Defines the scenario Voucherify should consider during the qualification process.Response body schema for **POST** `v1/qualifications`.Response body schema for **POST** `v1/redemptions`.Configure parameters returned in the response.Gets or Sets expandClientRedemptionsRedeemRequestBodyRedeemablesItemGets or Sets _objectContains information on the number of gift card credits that the customer wants to apply to the order.Contains information about the reward that the customer wants to redeem and the number of points the customer is choosing to use for the reward.Response body schema for **POST** `v1/redemptions`.Response body schema for **POST** `v1/validations`.Configure parameters returned in the response.Gets or Sets expandClientValidationsValidateRequestBodyRedeemablesItemGets or Sets _objectContains information on the number of gift card credits that the customer wants to apply to the order.Contains information about the reward that the customer wants to redeem and the number of points the customer is choosing to use for the reward.Response body schema for **POST** `/validations`.ClientValidationsValidateResponseBodyRedeemablesItemRedeemable's object type.Gets or Sets statusClientValidationsValidateResponseBodyRedeemablesItemResultClientValidationsValidateResponseBodyRedeemablesItemResultDetailsClientValidationsValidateResponseBodyRedeemablesItemResultDiscountGets or Sets effectGets or Sets typeClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProductStores the amount of gift card credits to be applied in the redemption.ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCardContains information about the config used for the voucher code.Create publication with campaign.CustomerThis is an object representing customer activity.Customer's address.CustomerIdThe type of the object represented by JSON.CustomerLoyaltyContains details about the point balances left on loyalty cards and the number of referred customers in each campaign.Single customer's redeemableDefines the type of the campaign.Role of the holder.Defines the type of the voucher.Detailed information about the customer's redeemable itemStatus of the redeemable.Summary of customer's referrals, in this case, the customer being the referee, i.e.Contains information about the source of the referral.Response body schema for **GET** `v1/customers/{customerId}/activity`.The type of the object represented by JSON.Request body schema for **POST** `v1/customers`.Customer's address.Response body for **POST** `v1/customers`.The type of the object represented by JSON.Customer's address.Contains information about the customer's cockpit.Response body schema for **GET** `v1/customers/{customerId}`.The type of the object represented by JSON.Customer's address.Contains information about the customer's cockpit.Response body schema for **POST** `v1/customers/importCSV`.Response body schema for **GET** `v1/customers`.Request body schema for **POST** `v1/customers/metadata/async`.Response body schema for **POST** `v1/customers/metadata/async`.Response body schema for **POST** `v1/customers/{customerId}/permanent-deletion`.Statistics summarizing the number of related information that was deleted.Response body schema for **GET** `v1/customers/{customerId}/redeemables`.Response body schema for **GET** `v1/customers/{customerId}/segments`.CustomerSummaryCustomerSummaryOrdersCustomerSummaryRedemptionsSummary of gift card credits.Summary of loyalty points.Request body schema for **POST** `v1/customers/bulk/async`.Customer's address.Response body schema for **POST** `v1/customers/bulk/async`.Request body schema for **PUT** `v1/customers/{customerId}`.Customer's address.Response body schema for **PUT** `v1/customers/{customerId}`.The type of the object represented by JSON.Customer's address.Contains information about the customer's cockpit.CustomerWithSummaryLoyaltyReferralsThe type of the object represented by JSON.Customer's address.Contains information about the customer's cockpit.DiscountGets or Sets effectGets or Sets typeDiscountProductDiscountUnitMultipleOneUnitDefines how the unit is added to the customer's order.EarningRuleThe type of the object represented by JSON.Gets or Sets validityDayOfWeekContains details about the custom event.EarningRuleLoyaltyGets or Sets calculationTypeGets or Sets typeEarningRuleLoyaltyCustomerDefines the ratio based on the property defined in the calculation_type parameter.EarningRuleLoyaltyCustomEventDefines the ratio based on the property defined in the calculation_type parameter.EarningRuleLoyaltyOrderDefines the ratio based on the property defined in the calculation_type parameter.EarningRuleLoyaltyOrderItemsDefines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Defines the ratio based on the property defined in the calculation_type parameter.Defines the tier associated with the earning rule definition.Contains the ID of a customer segment.Contains the custom earning rule name and parent campaign.Defines the object associated with the earning rule.Error detailsIncludes additional information about the error.Request body schema for **POST** `v1/events`.If an earning rule in a loyalty program is based on a custom event.If a **conversion event** for a referral program is set to a custom event, then you need to send the referral code in the payload to make a record of the conversion event.Response body schema for **POST** `v1/events`.The object represented is an `event`.ExportGets or Sets exportedObjectThe type of object being represented.Status of the export.Gets or Sets ExportOrderFieldsGets or Sets ExportOrderOrderExportParametersGets or Sets fieldsGets or Sets orderExportResultExportsCreateRequestBodyGets or Sets exportedObjectExportsCreateRequestBodyParametersGets or Sets fieldsGets or Sets orderExportsCreateResponseBodyGets or Sets exportedObjectThe type of object being represented.Status of the export.ExportsCreateResponseBodyParametersGets or Sets fieldsGets or Sets orderResponse body schema for **GET** `v1/exports/{exportId}`.Gets or Sets exportedObjectThe type of object being represented.Status of the export.ExportsGetResponseBodyParametersGets or Sets fieldsGets or Sets orderExportsGetResponseBodyResultResponse body schema for **GET** `v1/exports`.Identifies the name of the attribute that contains the array of exports.The type of the object represented by JSON.Gets or Sets ExportVoucherTransactionsFieldsExportVoucherTransactionsFiltersGets or Sets ExportVoucherTransactionsOrderFieldConditionsData filters used to narrow down the data records to be returned in the result.Data filters used to narrow down the data records to be returned in the result.FiltersConditionContains current gift card balance information.Defines how the credits are applied to the customer's order.InapplicableToThis object stores information about the resource to which the discount is applicable.InapplicableToResultListThe type of the object represented by JSON.The type of the object represented by JSON.Logical Operator Between Filters.ListPublicationsItemVoucherThe type of the object represented by JSON.This is an object representing a location.The type of the object represented by JSON.Response schema for listing locations using **GET** `/v1/locations/{locationId}`.The type of the object represented by JSON.LocationsGetResponseBodyShapeGets or Sets formatGets or Sets typeDefines the parameters for the circle.LocationsGetResponseBodyShapeGeojsonGets or Sets typeLocationShapeGets or Sets formatGets or Sets typeDefines the parameters for the circle.LocationShapeGeojsonGets or Sets typeResponse schema for listing locations using **GET** `v1/locations`.Request body schema for **POST** `/loyalties`.Type of campaign.Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.Gets or Sets validityDayOfWeekResponse body schema for **POST** `/loyalties`.Type of campaign.Indicates the status of the campaign creation.Defines whether the campaign can be updated with new vouchers after campaign creation.Gets or Sets validityDayOfWeekIndicates the status of the campaign's voucher generation.Response body schema for **DELETE** `/loyalties/{campaignId}`.LoyaltiesEarningRulesCreateRequestBodyItemGets or Sets validityDayOfWeekContains the schema id of a custom event.LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyGets or Sets calculationTypeGets or Sets typeLoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomerDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEventDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItemsDefines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Defines the ratio based on the property defined in the calculation_type parameter.Defines the tier associated with the earning rule definition.Contains the ID of a customer segment.LoyaltiesEarningRulesCreateRequestBodyItemSourceResponse body schema for **POST** `v1/loyalties/{campaignId}/earning-rules`.The type of the object represented by JSON.Gets or Sets validityDayOfWeekContains details about the custom event.LoyaltiesEarningRulesCreateResponseBodyLoyaltyGets or Sets calculationTypeGets or Sets typeLoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomerDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEventDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItemsDefines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Defines the ratio based on the property defined in the calculation_type parameter.Defines the tier associated with the earning rule definition.Contains the ID of a customer segment.Contains the custom earning rule name and parent campaign.Defines the object associated with the earning rule.Response body schema for **POST** `v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable`The type of the object represented by JSON.Gets or Sets validityDayOfWeekContains details about the custom event.LoyaltiesEarningRulesDisableResponseBodyLoyaltyGets or Sets calculationTypeGets or Sets typeLoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomerDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEventDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItemsDefines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Defines the ratio based on the property defined in the calculation_type parameter.Defines the tier associated with the earning rule definition.Contains the ID of a customer segment.Contains the custom earning rule name and parent campaign.Defines the object associated with the earning rule.Response body schema for **POST** `v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable`The type of the object represented by JSON.Gets or Sets validityDayOfWeekContains details about the custom event.LoyaltiesEarningRulesEnableResponseBodyLoyaltyGets or Sets calculationTypeGets or Sets typeLoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomerDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEventDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItemsDefines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Defines the ratio based on the property defined in the calculation_type parameter.Defines the tier associated with the earning rule definition.Contains the ID of a customer segment.Contains the custom earning rule name and parent campaign.Defines the object associated with the earning rule.Response body schema for **GET** `v1/loyalties/{campaignId}/earning-rules/{earningRuleId}`.The type of the object represented by JSON.Gets or Sets validityDayOfWeekContains details about the custom event.LoyaltiesEarningRulesGetResponseBodyLoyaltyGets or Sets calculationTypeGets or Sets typeLoyaltiesEarningRulesGetResponseBodyLoyaltyCustomerDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEventDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItemsDefines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Defines the ratio based on the property defined in the calculation_type parameter.Defines the tier associated with the earning rule definition.Contains the ID of a customer segment.Contains the custom earning rule name and parent campaign.Defines the object associated with the earning rule.Response body schema for listing earning rules using **GET** `v1/loyalties/{campaignId}/earning-rules` endpoint.The type of the object represented by JSON.LoyaltiesEarningRulesUpdateRequestBodyGets or Sets validityDayOfWeekLoyaltiesEarningRulesUpdateRequestBodyLoyaltyGets or Sets calculationTypeGets or Sets typeLoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomerDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEventDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItemsDefines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Defines the ratio based on the property defined in the calculation_type parameter.Contains the custom earning rule name and parent campaign.Response body schema for **PUT** `v1/loyalties/{campaignId}/earning-rules/{earningRuleId}`.The type of the object represented by JSON.Gets or Sets validityDayOfWeekContains details about the custom event.LoyaltiesEarningRulesUpdateResponseBodyLoyaltyGets or Sets calculationTypeGets or Sets typeLoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomerDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEventDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderDefines the ratio based on the property defined in the calculation_type parameter.LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItemsDefines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Type of object taken under consideration.Defines the ratio based on the property defined in the calculation_type parameter.Defines the ratio based on the property defined in the calculation_type parameter.Defines the tier associated with the earning rule definition.Contains the ID of a customer segment.Contains the custom earning rule name and parent campaign.Defines the object associated with the earning rule.Response body schema for **GET** `/loyalties/{campaignId}`.Type of campaign.Indicates the status of the campaign creation.Defines whether the campaign can be updated with new vouchers after campaign creation.Gets or Sets validityDayOfWeekIndicates the status of the campaign's voucher generation.Response body schema for **Get** `/loyalties`.Identifies the name of the attribute that contains the array of loyalty campaign objects.Response body schema for **GET** `v1/loyalties/{campaignId}/members`.Identifies the name of the attribute that contains the array of voucher objects.This is an object representing a loyalty tier reward.The type of the object represented by JSON.Response body schema for retrieving member activity.The type of the object represented by JSON.Request Body schema for **POST** `v1/loyalties/members/{memberId}/balance` and **POST** `v1/loyalties/{campaignId}/members/{memberId}/balance`.Response schema for **POST** `v1/loyalties/members/{memberId}/balance` and for **POST** `v1/loyalties/{campaignId}/members/{memberId}/balance`.The type of the object represented by JSON.The type of operation being performed.The type of voucher being modified.Defines the object that is being modified with the values that are returned in the balance object.The object being modified.Request body schema for assigning a loyalty card to a customer using **POST** `/loyalties/{campaignId}/members`.Respone body schema for assigning a loyalty card to a customer using **POST** `/loyalties/{campaignId}/members`.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing loyalty card parameters.This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event.Stores a summary of redemptions that have been applied to the voucher.Response body schema for **GET** `/loyalties/{campaignId}/members/{memberId}` and **GET** `/loyalties/members/{memberId}`.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing loyalty card parameters.This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event.Stores a summary of redemptions that have been applied to the voucher.Response body schema for **GET** `v1/loyalties/{campaignId}/members/{memberId}/points-expiration`.Identifies the name of the attribute that contains the array of loyalty points expiration bucket objects.The type of the object represented by JSON.Contains the details about expiring loyalty points.The type of the object represented by JSON.Defines the number of points stored in this loyalty point bucket.Request body schema for **POST** `v1/loyalties/{campaignId}/members/{memberId}/redemption` and for **POST** `v1/loyalties/members/{memberId}/redemption`.Contains information about the reward that the customer wants to redeem and the number of points the customer is choosing to use for the reward if the reward is a pay with points reward.Response body schema for **POST** `v1/loyalties/{campaignId}/members/{memberId}/redemption` and for **POST** `v1/loyalties/members/{memberId}/redemption`.The type of the object represented by the JSONDefines the related object.Redemption result.Redemption status.Defines the details of the channel through which the redemption was issued.The source of the channel for the redemption.Contains the amount subtracted from the gift card for the redemption.Contains the number of points subtracted from the loyalty card for the redemption.LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsLoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRedemptionsItemLoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRollbacksItemLoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRollbacksItem.CustomTypeAdapterFactoryDefines the details of the voucher being redeemed.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.Stores a summary of publication events: an event counter and endpoint to return details of each event.Stores a summary of redemptions that have been applied to the voucher.Response body schema for **GET** `v1/loyalties/members/{memberId}/rewards`Identifies the name of the attribute that contains the array of loyalty reward objects.The type of the object represented by JSON.LoyaltiesMembersRewardsListResponseBodyDataItemThe type of the object represented by JSON.Response body schema for **GET** `v1/loyalties/members/{memberId}/tiers`.Identifies the name of the attribute that contains the array of loyalty tier objects.The type of the object represented by JSON.Request body schema for **POST** `v1/loyalties/members/{memberId}/transactions/export` and for **POST** `v1/loyalties/{campaignId}/members/{memberId}/transactions/export`.List of available fields and filters that can be exported with an order along with the sorting order of the returned data.Response body schema for **POST** `v1/loyalties/members/{memberId}/transactions/export` and for **POST** `v1/loyalties/{campaignId}/members/{memberId}/transactions/export`.The type of object to be exported.The type of object being represented.Status of the export.List of available fields and filters that can be exported with an order along with the sorting order of the returned data.Response body schema for **GET** `v1/loyalties/{campaignId}/members/{memberId}/transactions` and `/loyalties/members/{memberId}/transactions`.Identifies the name of the attribute that contains the array of transaction objects.The type of the object represented by JSON.Response body schema for **POST** `v1/loyalties/{campaignId}/members/{memberId}/transfers`.Defines the type of the voucher.Gets or Sets validityDayOfWeekStores links to images of QR and barcode that correspond to an encrypted voucher code.Stores barcode representation of encrypted code.Stores Quick Response (QR) representation of encrypted code.Object representing loyalty card parameters.This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event.The type of the object represented is by default list.Stores a summary of redemptions that have been applied to the voucher.The type of the object represented is by default list.Request schema model for validating a voucher using **POST** `/v1/loyalties/{campaignId}/points-expiration/export`List of fields and filters that will be used to create the export.Gets or Sets fieldsHow the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order.Data filters used to narrow down the data records to be returned in the export.Data filters used to narrow down the data records to be returned in the result.LoyaltiesPointsExpirationExportCreateRequestBodyParametersFiltersCampaignId.CustomTypeAdapterFactoryData filters used to narrow down the data records to be returned in the result.Data filters used to narrow down the data records to be returned in the result.Data filters used to narrow down the data records to be returned in the result.Object representing an export of points expirations.The channel through which the export was triggered.The type of exported object.The type of object being represented.Status of the export.List of fields and filters that were passed in the request body to create the export.Gets or Sets fieldsHow the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order.Data filters used to narrow down the data records to be returned in the export.Data filters used to narrow down the data records to be returned in the result.Data filters used to narrow down the data records to be returned in the result.Data filters used to narrow down the data records to be returned in the result.LoyaltiesPointsExpirationExportCreateResponseBodyParametersFiltersVoucherId.CustomTypeAdapterFactoryData filters used to narrow down the data records to be returned in the result.Response body schema for **GET** `v1/loyalties/{campaignId}/reward-assignments/{assignmentId}`.The type of the object represented by the JSON.Related object type to which the reward was assigned.Defines the cost of the reward.Defines the equivalent points value of the reward.Response body schema for **GET** `v1/loyalties/{campaignId}/reward-assignments`.The type of the object represented by JSON.Response body schema for **GET** `v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward`The type of the object represented by the JSON.Reward type.These properties are configurable for **material rewards**.LoyaltiesRewardsCreateAssignmentItemRequestBodyDefines the cost of the reward.Defines the equivalent points value of the reward.Response body schema for **POST** `v1/v1/loyalties/{campaignId}/rewards`.The type of the object represented by the JSON.Related object type to which the reward was assigned.Defines the cost of the reward.Defines the equivalent points value of the reward.Response body schema for **GET** `v1/loyalties/{campaignId}/rewards/{assignmentId}`The type of the object represented by the JSON.Related object type to which the reward was assigned.Defines the cost of the reward.Defines the equivalent points value of the reward.Response body schema for **GET** `v1/loyalties/{campaignId}/rewards`.The type of the object represented by JSON.Response body schema for **PUT** `v1/v1/loyalties/{campaignId}/rewards/{assignmentId}`.An object that defines the price of the reward in loyalty points.Stores the points parameter.Response body schema for **PUT** `v1/v1/loyalties/{campaignId}/rewards/{assignmentId}`.The type of the object represented by the JSON.Related object type to which the reward was assigned.Defines the cost of the reward.Defines the equivalent points value of the reward.LoyaltiesTiersCreateInBulkRequestBodyItemResponse body schema for **GET** `v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules`.Identifies the name of the attribute that contains the array of earning rule objects.The type of the object represented by JSON.Response body schema for **GET** `v1/loyalties/{campaignId}/tiers/{loyaltyTierId}`.The type of the object represented by JSON.Defines loyalty tier range in points.Defines range of loyalty tier in points.Defines range of loyalty tier in points.Response body schema for **GET** `v1/loyalties/{campaignId}/tiers`.Identifies the name of the attribute that contains the array of loyalty tier objects.The type of the object represented by JSON.Response body schema for **GET** `v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards`.LoyaltiesTransferPointsRequest body schema for **PUT** `/loyalties/{campaignId}`.Defines whether the campaign can be updated with new vouchers after campaign creation.Gets or Sets validityDayOfWeekLoyaltiesUpdateCampaignRequestBodyOptionsResponse body schema for **PUT** `/loyalties/{campaignId}`.Type of campaign.Indicates the status of the campaign creation.Defines whether the campaign can be updated with new vouchers after campaign creation.Gets or Sets validityDayOfWeekIndicates the status of the campaign's voucher generation.LoyaltyCampaignType of campaign.Indicates the status of the campaign creation.Defines whether the campaign can be updated with new vouchers after campaign creation.Gets or Sets validityDayOfWeekIndicates the status of the campaign's voucher generation.Schema model for a campaign voucher.Type of voucher.Gets or Sets validityDayOfWeekDefines the redemption limits on vouchers.LoyaltyCardTransactionContains the detailed information about the transaction.Contains information on how the balance was affected by the transaction.The type of the object represented by the JSON.The type of the operation being performed.The type of voucher whose balance is being adjusted due to the transaction.Defines the resource that is being modified with the values that are returned in the balance object.The object being modified, i.e.Contains information about the custom event that triggers the point accrual.Contains information about the earning rule.Contains the custom earning rule name.Contains information about the event that triggers the point accrual.Contains information about the custom event metadata schema.Contains information about the loyalty tier.Contains information about the original order.Contains information about the original redemption.Contains information about the pay with points reward.Contains information about the redemption rollback.Contains information about the segment.Transaction types concerning loyalty points.This is an object representing a loyalty member.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing loyalty card parameters.This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event.Stores a summary of redemptions that have been applied to the voucher.Contains the details about expiring loyalty points.The type of the object represented by JSON.Defines the number of points stored in this loyalty point bucket.LoyaltyTierThe type of the object represented by JSON.LoyaltyTierBaseDefines range of loyalty tier in points.Defines loyalty tier range in points.Defines range of loyalty tier in points.Defines loyalty tier expiration date.Defines range of loyalty tier in points.Defines the Loyalty Tiers Expiration.Customers can qualify for the tier if they collected enough points in a given time period.Tier qualification.Defines the conditions for the expiration date of a tier.What triggers the tier to expire for a customer.Defines the rounding mechanism for tier expiration.This mechanism describes a rounding strategy for the expiration date.This mechanism describes a custom rounding for the expiration date.Defines the type of unit of time in which the rounding period is counted.Defines the conditions for the start date of the tier.What triggers the tier to be valid for a customer.ManagementProjectThe API version used in the project.The webhook version used in the project.Determines the notification settings.Determines the character set that is used as default for vouchers.Determines additional limits set on a given project, e.g.Determines the limit of API calls per given unit time.Response brand schema.Defines the address details.Defines basic brand details.Defines customer cockpit details.Determines the color scheme of the customer cockpit.Defines contact details.Request body schema for **POST** `/management/v1/projects/{projectId}/branding`.Defines the address details.Defines basic brand details.Defines customer cockpit details.Determines the color scheme of the customer cockpit.Defines contact details.Response body schema for **POST** `/management/v1/projects/{projectId}/branding`.Defines the address details.Defines basic brand details.Defines customer cockpit details.Determines the color scheme of the customer cockpit.Defines contact details.Response body schema for **GET** `/management/v1/projects/{projectId}/branding/{brandingId}`.Defines the address details.Defines basic brand details.Defines customer cockpit details.Determines the color scheme of the customer cockpit.Defines contact details.Object containing a list of brand configurations.Identifies the name of the attribute that contains the array of brand objects.The type of the object represented by JSON.ManagementProjectsBrandingUpdateRequestBodyDefines the address details.Defines basic brand details.Defines customer cockpit details.Determines the color scheme of the customer cockpit.Defines contact details.Response body schema for **PUT** `/management/v1/projects/{projectId}/branding/{brandingId}`.Defines the address details.Defines basic brand details.Defines customer cockpit details.Determines the color scheme of the customer cockpit.Defines contact details.Request body schema for **POST** `/management/v1/projects`.The API version used in the project.The webhook version used in the project.Determines the notification settings.Contains details about the users who will be assigned to the project.Determines the notification settings for webhook callouts configured in Distributions and Project settings.Determines the notification settings for webhooks sent through Distributions.Determines the notification settings for webhooks sent as set out in the Project settings.Response body schema for **POST** `management/v1/projects`.The API version used in the project.The webhook version used in the project.Determines the notification settings.Contains the `app_id` and `app_token` to authenticate client-side requests.Contains the `app_id` and `app_token` to authenticate server-side requests.Determines the notification settings for webhook callouts configured in Distributions and Project settings.Determines the notification settings for webhooks sent through Distributions.Determines the notification settings for webhooks sent as set out in the Project settings.Object containing the response to creating a custom event schema.The type of the object represented by JSON.Object containing custom event schema and its custom attributes (metadata).Request body schema for **POST** `/management/v1/projects/{projectId}/custom-event-schema`.Object containing custom event schema and its custom attributes (metadata).Custom event metadata name.Indicates the type of the custom event.Response body schema for **POST** `/management/v1/projects/{projectId}/custom-event-schema`.The type of the object represented by JSON.Object containing custom event schema and its custom attributes (metadata).Response body schema for **GET** `/management/v1/projects/{projectId}/custom-event-schema/{customEventSchemaId}`.The type of the object represented by JSON.Object containing custom event schema and its custom attributes (metadata).Object containing a list of custom event schemas.Identifies the name of the attribute that contains the array of custom event schema objects.The type of the object represented by JSON.Request body schema for **POST** `/management/v1/projects/{projectId}/custom-event-schema/{customEventSchemaId}`.Object containing custom event schema and its custom attributes (metadata).Response body schema for **POST** `/management/v1/projects/{projectId}/custom-event-schema/{customEventSchemaId}`.The type of the object represented by JSON.Object containing custom event schema and its custom attributes (metadata).ManagementProjectsGetResponseBodyThe API version used in the project.The webhook version used in the project.Determines the notification settings.Determines the character set that is used as default for vouchers.Determines additional limits set on a given project, e.g.Determines the limit of API calls per given unit time.Determines the notification settings for webhook callouts configured in Distributions and Project settings.Determines the notification settings for webhooks sent through Distributions.Determines the notification settings for webhooks sent as set out in the Project settings.Schema model for **GET** `managment/v1/projects`.Identifies the name of the attribute that contains the array of project objects.The type of the object represented by JSON.Object representing a metadata schema.Custom definition name.Indicates the type of metadata.Response body schema for **POST** `management/v1/projects/{projectId}/metadata-schemas`.Response body schema for **GET** `management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}`.Object containing a list of metadata schemas.Identifies the name of the attribute that contains the array of metadata schema objects.The type of the object represented by JSON.Response body schema for **PUT** `management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}`.Object representing the details of the stacking rules.Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount.Defines the application mode for redeemables.Defines the sorting rule for redeemables.Request body schema for **POST** `/management/v1/projects/{projectId}/stacking-rules`.Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount.Defines the application mode for redeemables.Defines the sorting rule for redeemables.Response body schema for **POST** `/management/v1/projects/{projectId}/stacking-rules`.Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount.Defines the application mode for redeemables.Defines the sorting rule for redeemables.Response body schema for **GET** `/management/v1/projects/{projectId}/stacking-rules/{stackingRulesId}`.Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount.Defines the application mode for redeemables.Defines the sorting rule for redeemables.Response body schema for **GET** `/management/v1/projects/{projectId}/stacking-rules`.Identifies the name of the attribute that contains the array of stacking rule objects.The type of the object represented by JSON.Request body schema for **PUT** `/management/v1/projects/{projectId}/stacking-rules/{stackingRulesId}`.Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount.Defines the application mode for redeemables.Defines the sorting rule for redeemables.Response body schema for **PUT** `/management/v1/projects/{projectId}/stacking-rules/{stackingRulesId}`.Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount.Defines the application mode for redeemables.Defines the sorting rule for redeemables.Response body schema for **POST** `/management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy`.Response body schema for **POST** `/management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy`.Type of the campaign used to create the campaign template.The type of the object represented by JSON.Response body schema for **GET** `/management/v1/projects/{projectId}/templates/campaigns`.Identifies the name of the JSON property that contains the array of campaign templates.The type of the object represented by JSON.Request body schema for **PUT** `/management/v1/projects/{projectId}`.The webhook version used in the project.Determines the notification settings.Determines the character set that is used as default for vouchers.Determines the notification settings for webhook callouts configured in Distributions and Project settings.Determines the notification settings for webhooks sent through Distributions.Determines the notification settings for webhooks sent as set out in the Project settings.ManagementProjectsUpdateResponseBodyThe API version used in the project.The webhook version used in the project.Determines the notification settings.Determines the character set that is used as default for vouchers.Determines additional limits set on a given project, e.g.Determines the limit of API calls per given unit time.Determines the notification settings for webhook callouts configured in Distributions and Project settings.Determines the notification settings for webhooks sent through Distributions.Determines the notification settings for webhooks sent as set out in the Project settings.ManagementProjectsUsersAssignRequestBodyDetails about the user assigned to the project.Details about the user assigned to the project.Request body schema for **POST** `/management/v1/projects/users/invite`.Object containing a list of users assigned to the project.Identifies the name of the attribute that contains the array of user objects.The type of the object represented by JSON.ManagementProjectsUsersUpdateRoleRequestBodyDetails about the user assigned to the project.Response body schema for webhook endpoints.Gets or Sets eventsThe type of the object represented by JSON.Request body schema for **POST** `/management/v1/projects/{projectId}/webhooks/{webhookId}`.Gets or Sets eventsResponse body schema for **POST** `/management/v1/projects/{projectId}/webhooks`.Gets or Sets eventsThe type of the object represented by JSON.Response body schema for **GET** `/management/v1/projects/{projectId}/webhooks/{webhookId}`.Gets or Sets eventsThe type of the object represented by JSON.Object containing a list of webhook configurations.Identifies the name of the attribute that contains the array of webhook objects.The type of the object represented by JSON.Request body schema for **PUT** `/management/v1/projects/{projectId}/webhooks`.Gets or Sets eventsResponse body schema for **PUT** `/management/v1/projects/{projectId}/webhooks/{webhookId}`.Gets or Sets eventsThe type of the object represented by JSON.Determines the notification settings for webhook callouts configured in Distributions and Project settings.Determines the notification settings for webhooks sent through Distributions.Determines the notification settings for webhooks sent as set out in the Project settings.MappingPointsGets or Sets typeThis is an object representing member activity.Custom definition name.Gets or Sets typeObject representing a metadata schema.Response body schema for **GET** `/v1/metadata-schemas/{resource}`.Object containing a list of metadata schemas.Identifies the name of the attribute that contains the array of metadata schema objects.The type of the object represented by JSON.Order information.The order status.Order information.The type of the object represented by JSON.The order status.OrderCalculatedItemThe type of the object represented by JSON.Used along with the source_id property, can be set to either sku or product.An object containing details of the related product.An object containing details of the related SKU.OrderItemUsed along with the source_id property, can be set to either sku or product.An object containing details of the related product.An object containing details of the related SKU.OrderRedemptionsEntryRequest body schema for **POST** `v1/orders`.The order status.Response body schema for **POST** `v1/orders`.The type of the object represented by JSON.The order status.Request body schema for **POST** `v1/orders/export`.List of available fields and filters that can be exported with an order along with the sorting order of the returned data.Response body schema for **POST** `v1/orders/export`.The type of object to be exported.The type of object being represented.Status of the export.List of available fields and filters that can be exported with an order along with the sorting order of the returned data.Response body schema for **GET** `v1/orders/{orderId}`.The type of the object represented by JSON.The order status.OrdersImportCreateRequestBodyItemThe order status.Response body schema for **POST** `v1/orders/import`.Response body schema representing **GET** `v1/orders`.Identifies the name of the attribute that contains the array of order objects.The type of the object represented by JSON.Request body schema for **PUT** `v1/orders/{orderId}`.The order status.Response body schema for **PUT** `v1/orders/{orderId}`.The type of the object represented by JSON.The order status.Gets or Sets ParameterActivityCategoryGets or Sets ParameterCampaignTypeParameterCreatedBeforeAfterGets or Sets ParameterExpandListCampaignsParameterFiltersListBinUnique identifier of the bin entry.Unique identifier of the resource moved to the bin.Name of the resource moved to the bin: the name of the campaign, voucher, product, or SKU.Resource type of the resource moved to the bin.ParameterFiltersListBinResourceTypeConditionsGets or Sets $inValue is exactly this value (single value).Results omit this value (single value).Gets or Sets $notInParameterFiltersListCampaignsType of the campaign.ParameterFiltersListCampaignsCampaignStatusConditionsGets or Sets $inValue is exactly this value (single value).Results omit this value (single value).Gets or Sets $notInFilter by categories namesFilter by categories idsValue is exactly this value (single value).Results omit this value (single value).Filter by validity timeframeFilter by voucher typeParameterFiltersListCustomerRedeemablesUnique campaign identifer, e.g.Type of the campaign.ParameterFiltersListCustomerRedeemablesCampaignTypeConditionsGets or Sets $inValue is exactly this value (single value).Results omit this value (single value).Gets or Sets $notInTimestamp representing the date and time when the customer redeemable was created.Holder role of the redeemable.ParameterFiltersListCustomerRedeemablesHolderRoleConditionsGets or Sets $inValue is exactly this value (single value).Results omit this value (single value).Gets or Sets $notInUnique redeemable holder ID, i.e.Unique redeemable ID, e.g.Unique related object, i.e.ParameterFiltersListCustomerRedeemablesRedeemableObjectConditionsGets or Sets $inValue is exactly this value (single value).Results omit this value (single value).Gets or Sets $notInType of the voucher.ParameterFiltersListCustomerRedeemablesVoucherTypeConditionsGets or Sets $inValue is exactly this value (single value).Results omit this value (single value).Gets or Sets $notInParameterFiltersListLocationsTimestamp representing the date and time when the location was created.ParameterFiltersListLocationsNameTimestamp representing the date and time when the location was updated.ParameterFiltersListPublicationsFilter publications by campaign names.Filter publications by customer ids.Filter publications by ids.Filter publications by is referall code.Filter publications by parent object id.Filter publications by related object id.Filter publications by names.Filter publications by source id.Filter publications by voucher types.ParameterFiltersListRedemptionsCampaign name.Unique customer ID, i.e.Failure code, i.e.Specify which type of object to return, i.e.Unique parent redemption ID, i.e.Unique related object ID, i.e.Unique related object parent ID, i.e.Result, i.e.User login used to login to Voucherify, i.e.Unique voucher code.ParameterFiltersListReferralsRedeemableHoldersTimestamp representing the date and time when the redeemable was added to the holder.Unique customer ID, i.e.Holder role of the redeemable.ParameterFiltersListReferralsRedeemableHoldersHolderRoleConditionsGets or Sets $inValue is exactly this value (single value).Results omit this value (single value).Gets or Sets $notInUnique redeemable holder ID, i.e.ParameterFiltersListTemplatesCampaign template campaign type.Data filters used to narrow down the data records to be returned in the result.Gets or Sets $inValue is exactly this value (single value).Results omit this value (single value).Gets or Sets $notInUnique template ID.Unique user-defined template name.Gets or Sets ParameterOrderGets or Sets ParameterOrderCreatedAtGets or Sets ParameterOrderListAllPromotionStacksGets or Sets ParameterOrderListBinGets or Sets ParameterOrderListCampaignsGets or Sets ParameterOrderListCustomersGets or Sets ParameterOrderListEarningRulesGets or Sets ParameterOrderListExportsGets or Sets ParameterOrderListLocationsGets or Sets ParameterOrderListLoyaltyTiersGets or Sets ParameterOrderListOrdersGets or Sets ParameterOrderListPromotionTiersGets or Sets ParameterOrderListPromotionTiersClientSideGets or Sets ParameterOrderListPublicationsGets or Sets ParameterOrderListRedeemablesGets or Sets ParameterOrderListRedemptionsGets or Sets ParameterOrderListTransactionsGets or Sets ParameterOrderListValidationRuleAssignmentsGets or Sets ParameterOrderListValidationRulesGets or Sets ParameterOrderVouchersGets or Sets ParameterResultListPublicationsGets or Sets ParameterTemplatesListParameterUpdatedBeforeAfterGets or Sets ParameterVoucherTypeListPublicationsGets or Sets PointsExpirationTypesThis is an object representing a product.The type of the object represented by JSON.ProductCollectionsCreateRequestBodyShow that the product collection is static (manually selected products).ProductCollectionsCreateRequestBodyProductsItemDenotes the type of the object represented by the ID.Response body schema for **POST** `v1/product-collections`.The type of the object represented by JSON.Describes whether the product collection is dynamic (products come in and leave based on set criteria) or static (manually selected products).ProductCollectionsCreateResponseBodyProductsItemDenotes the type of the object represented by the ID.Response body schema for **GET** `v1/product-collections/{productCollectionId}`.The type of the object represented by JSON.Describes whether the product collection is dynamic (products come in and leave based on set criteria) or static (manually selected products).ProductCollectionsGetResponseBodyProductsItemDenotes the type of the object represented by the ID.This is an object representing a product collection base.The type of the object represented by JSON.Describes whether the product collection is dynamic (products come in and leave based on set criteria) or static (manually selected products).ProductCollectionsItemProductsItemDenotes the type of the object represented by the ID.Response body schema for **GET** `v1/product-collections`.Identifies the name of the JSON property that contains the array of product collections.The type of the object represented by JSON.Response body schema for **GET** `v1/product-collections/{productCollectionId}/products`.ProductCollectionsProductsListResponseBodyDataItemGets or Sets _objectRequest schema for **POST** `v1/products`.Response body schema for **POST** `v1/products`.The type of the object represented by JSON.Response body schema for **GET** `v1/products/{productId}`.The type of the object represented by JSON.Response body schema for **POST** `v1/products/importCSV`.Response body schema for **GET** `v1/products`.Request schema for **POST** `v1/products/metadata/async`.Response body schema for **POST** `v1/products/metadata/async`.Request body schema for **POST** `v1/products/{productId}/skusResponse body schema for **PUT** `v1/products/{productId}/skus`.The type of the object represented by JSON.Response body schema for **GET** `v1/products/{productId}/skus`.Request body schema for **PUT** `v1/products/{productId}/skus/{skuId}`.Response body schema for **PUT** `v1/products/{productId}/skus/{skuId}`.The type of the object represented by JSON.Request schema for **POST** `v1/products/bulk/async`.Response body schema for **POST** `v1/products/bulk/async`.Request schema for **PUT** `v1/products`.Response body schema for **PUT** `v1/products/{productId}`.The type of the object represented by JSON.ProductWithoutSkusThe type of the object represented by JSON.Request body schema for **POST** `v1/promotions/{campaignId}/stacks`.Contains the tier configuration.Gets or Sets hierarchyModeResponse body schema for **POST** `v1/promotions/{campaignId}/stacks`.The type of the object represented by JSON.Contains the tier configuration.Gets or Sets hierarchyModeResponse body schema for **GET** `v1/promotions/{campaignId}/stacks/{stackId}`.The type of the object represented by JSON.Contains the tier configuration.Gets or Sets hierarchyModeResponse body schema for **GET** `v1/promotions/stacks` and for **GET** `v1/promotions/{campaignId}/stacks`.Identifies the name of the attribute that contains the array of promotion stack objects.The type of the object represented by JSON.Request Body schema for **PUT** `v1/promotions/{campaignId}/stacks/{stackId}`.Contains the tier configuration.Category hierarchy.Response body schema for **PUT** `v1/promotions/{campaignId}/stacks/{stackId}`.The type of the object represented by JSON.Contains the tier configuration.Gets or Sets hierarchyModePromotionStackThe type of the object represented by JSON.PromotionStackBaseContains the tier configuration.Gets or Sets hierarchyModeContains the tier configuration.Gets or Sets hierarchyModeRequest body schema for **POST** `v1/v1/promotions/{campaignId}/tiers`.Gets or Sets validityDayOfWeekContains details about the discount applied by the promotion tier.Response body schema for **POST** `v1/promotions/{campaignId}/tiers`.Gets or Sets validityDayOfWeekContains details about the discount applied by the promotion tier.Contains details about promotion tier's parent campaign.Gets or Sets validityDayOfWeekContains statistics about promotion tier redemptions and orders.Contains statistics about orders related to the promotion tier.Contains statistics about promotion tier redemptions.Response body schema for **POST** `v1/promotions/tiers/{promotionTierId}/disable`.Gets or Sets validityDayOfWeekContains details about the discount applied by the promotion tier.Contains details about promotion tier's parent campaign.Gets or Sets validityDayOfWeekContains statistics about promotion tier redemptions and orders.Contains statistics about orders related to the promotion tier.Contains statistics about promotion tier redemptions.Response body schema for **POST** `v1/promotions/tiers/{promotionTierId}/enable`.Gets or Sets validityDayOfWeekContains details about the discount applied by the promotion tier.Contains details about promotion tier's parent campaign.Gets or Sets validityDayOfWeekContains statistics about promotion tier redemptions and orders.Contains statistics about orders related to the promotion tier.Contains statistics about promotion tier redemptions.Response body schema for **GET** `v1/promotions/tiers/{promotionTierId}`.Gets or Sets validityDayOfWeekContains details about the discount applied by the promotion tier.Contains details about promotion tier's parent campaign.Gets or Sets validityDayOfWeekContains statistics about promotion tier redemptions and orders.Contains statistics about orders related to the promotion tier.Contains statistics about promotion tier redemptions.Response body schema for **GET** `v1/promotions/{campaignId}/tiers` and **GET** `v1/promotions/tiers`.Request body schema for **PUT** `v1/promotions/tiers/{promotionTierId}`.Gets or Sets validityDayOfWeekContains details about the discount applied by the promotion tier.Response body schema for **PUT** `v1/promotions/tiers/{promotionTierId}`.Gets or Sets validityDayOfWeekContains details about the discount applied by the promotion tier.Contains details about promotion tier's parent campaign.Gets or Sets validityDayOfWeekContains statistics about promotion tier redemptions and orders.Contains statistics about orders related to the promotion tier.Contains statistics about promotion tier redemptions.This is an object representing a promotion tier.Gets or Sets validityDayOfWeekContains details about the discount applied by the promotion tier.Contains details about promotion tier's parent campaign.Gets or Sets validityDayOfWeekThis is an object representing a promotion tier create params.Gets or Sets validityDayOfWeekContains details about the discount applied by the promotion tier.Promotion TiersContains statistics about promotion tier redemptions and orders.Contains statistics about orders related to the promotion tier.Contains statistics about promotion tier redemptions.PublicationsCreateRequestBodyPublicationsCreateResponseBodyHow the publication was originated.The type of the object represented by the JSON.Status of the publication attempt.Response body schema for listing publications using **GET** `v1/publications`.PublicationsListResponseBodyPublicationsItemThe type of the object represented by the JSON.Gets or Sets resultPublicationsListResponseBodyPublicationsItemMetadataRequest body schema for **POST** `v1/qualifications`.Defines the scenario Voucherify should consider during the qualification process.Response body schema for **POST** `v1/qualifications`.QualificationsFieldConditionsQualificationsFiltersConditionConfigure parameters returned in the response.Gets or Sets expandIs used to determine the order in which data is displayed in the result array.A set of filters to return only a specific category or type of redeemable.Returns both campaigns and their vouchers or promotion tiers.Data filters used to narrow down the data records to be returned in the result.QualificationsOptionFiltersHolderRoleData filters used to narrow down the data records to be returned in the result.Gets or Sets $inGets or Sets $isGets or Sets $isNotGets or Sets $notInQualificationsOptionFiltersResourceTypeData filters used to narrow down the data records to be returned in the result.QualificationsRedeemableObject type of the redeemable.Data of single redeemable which was properly qualified.Object type of the redeemable.List of redeemables for examine qualification.Identifies the name of the attribute that contains the array of qualified redeemables.The type of the object represented by JSON.Contains current gift card balance information.Single customer's redeemableDefines the type of the campaign.Role of the holder.The type of the object represented by JSON.Defines the type of the voucher.Redeemable loyalty card object responseInformation about redeemable result.This is an object representing a voucher.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event.Stores a summary of redemptions that have been applied to the voucher.This is an object representing a redemption for **POST** `v1/redemptions` and **POST** `/client/v1/redemptions`.The type of the object represented by the JSONDefines the related object.Redemption result.Redemption status.Defines the details of the channel through which the redemption was issued.The source of the channel for the redemption.RedemptionEntryGets or Sets _objectDefines the related object.Redemption result.Gets or Sets statusRedemptionEntryChannelGets or Sets channelTypeRedemptionEntryCustomerThe type of the object represented by JSON.RedemptionEntryGiftRedemptionEntryLoyaltyCardRedemptionEntryOrderThe type of the object represented by JSON.The order status.RedemptionEntryOrderCustomerThe type of the object represented by JSON.RedemptionEntryOrderReferrerThe type of the object represented by JSON.RedemptionEntryPromotionTierGets or Sets validityDayOfWeekRedemptionEntryPromotionTierActionRedemptionEntryPromotionTierCampaignGets or Sets validityDayOfWeekRedemptionEntryPromotionTierSummaryRedemptionEntryPromotionTierSummaryOrdersRedemptionEntryPromotionTierSummaryRedemptionsRedemptionEntryRelatedRedemptionsRedemptionEntryRelatedRedemptionsRedemptionsItemRedemptionEntryRelatedRedemptionsRollbacksItemRedemptionEntryVoucherDefines the type of the voucher.Gets or Sets validityDayOfWeekRedemptionEntryVoucherGiftDefines how the credits are applied to the customer's order.RedemptionEntryVoucherLoyaltyCardRedemptionEntryVoucherPublishRedemptionEntryVoucherRedemptionContains the amount subtracted from the gift card for the redemption.Contains the number of points subtracted from the loyalty card for the redemption.RedemptionRelatedRedemptionsRedemptionRelatedRedemptionsRedemptionsItemRedemptionRelatedRedemptionsRollbacksItemRedemptionRewardResultThe type of the object represented by the JSONReward type.These are parameters representing a material reward.Defines the product redeemed as a reward.Defines the ratio by mapping the number of loyalty points in `points_ratio` to a predefined cash amount in `exchange_ratio`.Defines the product redeemed as a reward.This is an object representing a redemption rollback.The type of the object represented by the JSONDefines the related object.Redemption result.Redemption status.Defines the details of the channel through which the redemption was issued.The source of the channel for the redemption.Contains the amount returned to the gift card in the redemption rollback.Contains the number of points returned to the loyalty card in the reward redemption rollback.RedemptionRollbackRelatedRedemptionsRedemptionRollbackRelatedRedemptionsRedemptionsItemRedemptionRollbackRelatedRedemptionsRollbacksItemRedemptionsGetResponseBodyGets or Sets _objectDefines the related object.Redemption result.Gets or Sets statusRedemptionsGetResponseBodyChannelGets or Sets channelTypeRedemptionsGetResponseBodyCustomerThe type of the object represented by JSON.RedemptionsGetResponseBodyGiftRedemptionsGetResponseBodyLoyaltyCardRedemptionsGetResponseBodyOrderThe type of the object represented by JSON.The order status.RedemptionsGetResponseBodyOrderCustomerThe type of the object represented by JSON.RedemptionsGetResponseBodyOrderReferrerThe type of the object represented by JSON.RedemptionsGetResponseBodyPromotionTierGets or Sets validityDayOfWeekRedemptionsGetResponseBodyPromotionTierActionRedemptionsGetResponseBodyPromotionTierCampaignGets or Sets validityDayOfWeekRedemptionsGetResponseBodyPromotionTierSummaryRedemptionsGetResponseBodyPromotionTierSummaryOrdersRedemptionsGetResponseBodyPromotionTierSummaryRedemptionsRedemptionsGetResponseBodyRelatedRedemptionsRedemptionsGetResponseBodyRelatedRedemptionsRedemptionsItemRedemptionsGetResponseBodyRelatedRedemptionsRollbacksItemRedemptionsGetResponseBodyVoucherDefines the type of the voucher.Gets or Sets validityDayOfWeekRedemptionsGetResponseBodyVoucherGiftDefines how the credits are applied to the customer's order.RedemptionsGetResponseBodyVoucherLoyaltyCardRedemptionsGetResponseBodyVoucherPublishRedemptionsGetResponseBodyVoucherRedemptionResponse body schema for **GET** `v1/redemptions`.RedemptionsListResponseBodyRedemptionsItemGets or Sets _objectDefines the related object.Redemption result.Gets or Sets statusRedemptionsListResponseBodyRedemptionsItemChannelGets or Sets channelTypeRedemptionsListResponseBodyRedemptionsItemCustomerThe type of the object represented by JSON.RedemptionsListResponseBodyRedemptionsItemGiftRedemptionsListResponseBodyRedemptionsItemLoyaltyCardRedemptionsListResponseBodyRedemptionsItemOrderThe type of the object represented by JSON.The order status.RedemptionsListResponseBodyRedemptionsItemOrderCustomerThe type of the object represented by JSON.RedemptionsListResponseBodyRedemptionsItemOrderReferrerThe type of the object represented by JSON.RedemptionsListResponseBodyRedemptionsItemPromotionTierGets or Sets validityDayOfWeekRedemptionsListResponseBodyRedemptionsItemPromotionTierActionRedemptionsListResponseBodyRedemptionsItemPromotionTierCampaignGets or Sets validityDayOfWeekRedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryOrdersRedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptionsRedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsItemRedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsItem.CustomTypeAdapterFactoryRedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItemRedemptionsListResponseBodyRedemptionsItemVoucherDefines the type of the voucher.Gets or Sets validityDayOfWeekRedemptionsListResponseBodyRedemptionsItemVoucherGiftDefines how the credits are applied to the customer's order.RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCardRedemptionsListResponseBodyRedemptionsItemVoucherPublishRedemptionsListResponseBodyRedemptionsItemVoucherRedemptionResponse body schema for **POST** `v1/redemptions`.Configure parameters returned in the response.Gets or Sets expandRedemptionsRedeemRequestBodyRedeemablesItemGets or Sets _objectContains information on the number of gift card credits that the customer wants to apply to the order.Contains information about the reward that the customer wants to redeem and the number of points the customer is choosing to use for the reward.Response body schema for **POST** `v1/redemptions`.Request body schema for **POST** `v1/redemptions/{redemptionId}/rollback`.Response body schema for **POST** `v1/redemptions/{redemptionId}/rollback`.The type of the object represented by the JSONDefines the related object.Redemption result.Redemption status.Defines the details of the channel through which the redemption was issued.The source of the channel for the redemption.Contains the amount returned to the gift card in the redemption rollback.Contains the number of points returned to the loyalty card in the reward redemption rollback.RedemptionsRollbackCreateResponseBodyRelatedRedemptionsRedemptionsRollbackCreateResponseBodyRelatedRedemptionsRedemptionsItemRedemptionsRollbackCreateResponseBodyRelatedRedemptionsRollbacksItemRequest body schema for **POST** `v1/redemptions/{parentRedemptionId}/rollbacks`.Response body schema for **POST** `/redemptions/{parentRedemptionID}/rollbacks`.Defines the details of the voucher being redeemed.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.Stores a summary of publication events: an event counter and endpoint to return details of each event.Stores a summary of redemptions that have been applied to the voucher.Defines the referee reward and the way a referral is triggered.Define how a referral is triggered.Contains details about the custom event.Defines the referee reward.Type of reward.Details of the resource from which the reward originates.Type of resource represented by the source of the reward.Request body schema for **POST** `v1/referrals/{campaignId}/members/{memberId}/holders` and **POST** `v1/referrals/members/{memberId}/holders`.Response body schema for **POST** `v1/referrals/{campaignId}/members/{memberId}/holders` and **POST** `v1/referrals/members/{memberId}/holders`.Response body schema for **GET** `v1/referrals/{campaignId}/members/{memberId}/holders` and for **GET** `v1/referrals/members/{memberId}/holders`ReferrerCustomer's address.ReferrerIdThe type of the object represented by JSON.Types of usable resources.RewardThe type of the object represented by the JSON.Reward type.RewardAssignmentThe type of the object represented by the JSON.Related object type to which the reward was assigned.Defines the cost of the reward.Defines the equivalent points value of the reward.These properties are configurable for **material rewards**.RewardsAssignmentsCreateRequestBodyDefines the cost of the reward.Defines the equivalent points value of the reward.Response body schema for **POST** `v1/rewards/{rewardId}/assignments/`.The type of the object represented by the JSON.Related object type to which the reward was assigned.Defines the cost of the reward.Defines the equivalent points value of the reward.Response body schema for **GET** `v1/rewards/{rewardId}/assignments/{assignmentId}`.The type of the object represented by the JSON.Related object type to which the reward was assigned.Defines the cost of the reward.Defines the equivalent points value of the reward.Response body schema for **GET** `v1/rewards/{rewardID}/assignments`.Request body schema for **PUT** `v1/rewards/{rewardId}/assignments/{assignmentId}`.An object that defines the price of the reward in loyalty points.Stores the points parameter.Response body schema for **PUT** `v1/rewards/{rewardId}/assignments/{assignmentId}`.The type of the object represented by the JSON.Related object type to which the reward was assigned.Defines the cost of the reward.Defines the equivalent points value of the reward.RewardsCreateRequestBodyAttributes of a material reward.RewardsCreateRequestBodyParametersRewardsCreateRequestBodyParametersCampaignDefine the ratio by mapping the number of loyalty points in `points_ratio` to a predefined cash amount in `exchange_ratio`.Define the product given as a reward.Response body schema for **POST** `v1/rewards`.The type of the object represented by the JSON.Reward type.These properties are configurable for **material rewards**.Response body schema for **GET** `v1/rewards`.RewardsUpdateRequestBodyAttributes of a material reward.RewardsUpdateRequestBodyParametersRewardsUpdateRequestBodyParametersCampaignDefine the ratio by mapping the number of loyalty points in `points_ratio` to a predefined cash amount in `exchange_ratio`.Define the product given as a reward.Response body schema for **PUT** `v1/rewards/{rewardId}`.The type of the object represented by the JSON.Reward type.These properties are configurable for **material rewards**.RewardTypeObjects stores information about the campaign related to the reward.Campaign type.Defines the ratio by mapping the number of loyalty points in points_ratio to a predefined cash amount in exchange_ratio.Contains information about the product given as a reward.SegmentsCreateRequestBodyGets or Sets typeResponse body schema for **POST** `v1/segments`.Gets or Sets initialSyncStatusThe type of the object represented by JSON.Describes whether the segment is dynamic (customers come in and leave based on set criteria) or static (manually selected customers).Response body schema for **GET** `v1/v1/segments/{segmentId}`.Gets or Sets initialSyncStatusThe type of the object represented by JSON.Describes whether the segment is dynamic (customers come in and leave based on set criteria) or static (manually selected customers).SessionDefines the type of unit in which the session time is counted.This parameter is required to establish a new session.Simplified customer data.The type of the object represented by JSON.This is an object representing a customer with limited properties used in Event Tracking endpoints.Simplified loyalty card data.SimpleProductDiscountUnitSimpleSegmentThe type of the object represented by the ID.SimpleSkuDiscountUnitSimplified voucher data.The type of the object represented by JSON.Type of the voucher.Defines the redemption limits on vouchers.This is an object representing a product SKU.The type of the object represented by JSON.Response body schema for **GET** `v1/skus/{skuId}`.The type of the object represented by JSON.Response body schema for **POST** `v1/skus/importCSV`.Contains information about child SKUs.Defines stacking rules for redeemables.Defines redeemables application mode.Defines redeemables no effect rule.Defines redeemables products application mode.Defines redeemables sorting rule.Request body schema for **POST** `/v1/templates/campaigns/{campaignTemplateId}/campaign-setup`.Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.Gets or Sets validityDayOfWeekStores the quantity of redemptions that can be applied to the voucher.Response body schema for **POST** `/v1/templates/campaigns/{campaignTemplateId}/campaign-setup`.The type of the object represented by JSON.TemplatesCampaignsCampaignSetupCreateResponseBodyCreatedResourcesItemThe type of the created resource.Request body schema for **POST** `/templates/campaign`.Response body schema for **POST** `/v1/templates/campaigns`.Type of the campaign used to create the campaign template.The type of the object represented by JSON.Response body schema for **GET** `/v1/templates/campaign/{campaignTemplateId}`.Type of the campaign used to create the campaign template.The type of the object represented by JSON.Response body schema for **GET** `/v1/templates/campaign`.Identifies the name of the JSON property that contains the array of campaign templates.The type of the object represented by JSON.Request body schema for **POST** `/v1/templates/campaigns/{campaignTemplateId}/tier-setup`.Gets or Sets validityDayOfWeekResponse body schema for **POST** `/v1/templates/campaigns/{campaignTemplateId}/tier-setup`.The type of the object represented by JSON.TemplatesCampaignsTierSetupCreateResponseBodyCreatedResourcesItemThe type of the created resource.Request body schema for **PUT** `/templates/campaign/{campaignTemplateId}`.Request body schema for **PUT** `/templates/campaign/{campaignTemplateId}`.Type of the campaign used to create the campaign template.The type of the object represented by JSON.Resource moved to the bin, i.e.The type of the object represented by JSON.Type of the resource moved to the bin.Retrieves a list of the resources moved the bin.Identifies the name of the attribute that contains the array of bin entry objects.The type of the object represented by JSON.UsageNotificationsDetails about the user.ValidationRuleValidation rule context type.Type of validation rule.ValidationRuleApplicableToThis is an object representing a validation rule assignment.The type of the object represented by the ID.The type of resource to which the validation rule was assigned.Validation Rule Assignments ListContains the error message returned from API when validation / redemption fails to meet requirements of defined rules.Request body schema for **POST** `v1/validation-rules/{validationRuleId}/assignments`.Defines the related object, e.g.Response body for **POST** `v1/validation-rules/{validationRuleId}/assignments`.The type of the object represented by the ID.The type of resource to which the validation rule was assigned.List of Validation Rules AssignmentsIdentifies the name of the attribute that contains the array of validation rules assignments.The type of the object represented by JSON.Response body for **GET** `v1/validation-rules-assignments` and **GET** `v1/validation-rules/{validationRuleId}/assignments`.Request body schema for **POST** `v1/validation-rules`.Validation rule context type.Type of validation rule.ValidationRulesCreateRequestBodyApplicableToContains the error message returned from API when validation / redemption fails to meet requirements of defined rules.Response body schema for **POST** `v1/validation-rules`.Validation rule context type.Type of validation rule.ValidationRulesCreateResponseBodyApplicableToContains the error message returned from API when validation / redemption fails to meet requirements of defined rules.Response body schema for **GET** `v1/validation-rules/{validationRuleId}`.Validation rule context type.Type of validation rule.ValidationRulesGetResponseBodyApplicableToContains the error message returned from API when validation / redemption fails to meet requirements of defined rules.Response body schema for **GET** `v1/validation-rules`.Response body schema for **PUT** `v1/validation-rules/{validationRuleId}`.Validation rule context type.Type of validation rule.ValidationRulesUpdateRequestBodyApplicableToContains the error message returned from API when validation / redemption fails to meet requirements of defined rules.Response body schema for **PUT** `v1/validation-rules/{validationRuleId}`.Validation rule context type.Type of validation rule.ValidationRulesUpdateResponseBodyApplicableToContains the error message returned from API when validation / redemption fails to meet requirements of defined rules.ValidationsRedeemableInapplicableRedeemable's object type.Indicates whether the redeemable can be applied or not applied based on the validation rules.Includes the error object with details about the reason why the redeemable is inapplicableProvides details about the reason why the redeemable is inapplicable.ValidationsRedeemableSkippedRedeemable's object type.Indicates whether the redeemable can be applied or not applied based on the validation rules.Provides details about the reason why the redeemable is skipped.ValidationsRedeemableSkippedResultDetailsGets or Sets keyResponse body schema for **POST** `v1/validations`.Configure parameters returned in the response.Gets or Sets expandValidationsValidateRequestBodyRedeemablesItemGets or Sets _objectContains information on the number of gift card credits that the customer wants to apply to the order.Contains information about the reward that the customer wants to redeem and the number of points the customer is choosing to use for the reward.Response body schema for **POST** `v1/validations`.ValidationsValidateResponseBodyRedeemablesItemRedeemable's object type.Gets or Sets statusValidationsValidateResponseBodyRedeemablesItemResultValidationsValidateResponseBodyRedeemablesItemResultDetailsValidationsValidateResponseBodyRedeemablesItemResultDiscountGets or Sets effectGets or Sets typeValidationsValidateResponseBodyRedeemablesItemResultDiscountProductStores the amount of gift card credits to be applied in the redemption.ValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCardDetermines the hours of validity, e.g.Defines the reccuring period(s) when the resource will be active.Gets or Sets daysOfWeekSet recurrent time periods when the earning rule is valid.This is an object representing a voucher with categories and validation rules assignments.Defines the type of the voucher.Gets or Sets validityDayOfWeekStores links to images of QR and barcode that correspond to an encrypted voucher code.Stores barcode representation of encrypted code.Stores Quick Response (QR) representation of encrypted code.Contains information on how the balance was affected by the transaction.The type of the object represented by the JSON.The type of the operation being performed.The type of voucher whose balance is being adjusted due to the transaction.Defines the resource that is being modified with the values that are returned in the balance object.The object being modified, i.e.Object representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.Stores a summary of publication events: an event counter and endpoint to return details of each event.Stores a summary of redemptions that have been applied to the voucher.Request body schema for `vouchers/{code}/balance`.Response body schema for `vouchers/{code}/balance.`The type of the object represented by JSON.The type of the operation being performed.The type of voucher being modified.Defines the resource that is being modified with the values that are returned in the balance object.The object being modified, i.e.VouchersCreateRequestBodyGets or Sets typeGets or Sets validityDayOfWeekVouchersCreateRequestBodyRedemptionResponse body schema for **POST** `v1/vouchers` and `/vouchers/{code}`Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.Stores a summary of publication events: an event counter and endpoint to return details of each event.Stores a summary of redemptions that have been applied to the voucher.VouchersCreateWithSpecificCodeRequestBodyGets or Sets typeGets or Sets validityDayOfWeekVouchersCreateWithSpecificCodeRequestBodyRedemptionResponse body schema for **POST** `v1/vouchers/{code}/disable`.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.Stores a summary of publication events: an event counter and endpoint to return details of each event.Stores a summary of redemptions that have been applied to the voucher.Response body schema for **POST** `v1/vouchers/{code}/enable`.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.Stores a summary of publication events: an event counter and endpoint to return details of each event.Stores a summary of redemptions that have been applied to the voucher.Response body schema for **GET** `v1/vouchers/{code}`.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.Stores a summary of publication events: an event counter and endpoint to return details of each event.Stores a summary of redemptions that have been applied to the voucher.VouchersImportCreateItemRequestBodyGets or Sets typeGets or Sets validityDayOfWeekVouchersImportCreateItemRequestBodyRedemptionResponse body schema for **POST** `v1/vouchers/import`.Response body schema for **POST** `v1/vouchers/importCSV`.Response body schema for **GET** `v1/vouchers`.Identifies the name of the attribute that contains the array of voucher objects.The type of the object represented by JSON.Request body schema for `vouchers/metadata/async`.Response body schema for **POST** `v1/vouchers/metadata/async`.Response body schema for **GET** `v1/vouchers/{code}/redemption`.Request body schema for **POST** `v1/vouchers/transactions/export`.Response body schema for **POST** `v1/vouchers/{code}/transactions/export`.The type of exported object.The type of object being represented.Status of the export.Contains the URL of the CSV file.Response body schema for **GET** `v1/vouchers/{code}/transactions`.Identifies the name of the attribute that contains the array of transaction objects.The type of the object represented by JSON.VouchersUpdateInBulkItemRequestBodyResponse body schema for **POST** `v1/vouchers/bulk/async`.VouchersUpdateRequestBodyGets or Sets typeGets or Sets validityDayOfWeekResponse body schema for **PUT** `v1/vouchers/{code}`.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.Stores a summary of publication events: an event counter and endpoint to return details of each event.Stores a summary of redemptions that have been applied to the voucher.VoucherTransactionGets or Sets typeContains the detailed information about the transaction.Contains information on how the balance was affected by the transaction.The type of the object represented by the JSON.The type of the operation being performed.The type of voucher whose balance is being adjusted due to the transaction.Defines the resource that is being modified with the values that are returned in the balance object.The object being modified, i.e.Contains information about the custom event that triggers the point accrual.Contains information about the earning rule.Contains the custom earning rule name.Contains information about the event that triggers the point accrual.Contains information about the custom event metadata schema.Contains information about the loyalty tier.Contains information about the original order.Contains information about the original redemption.Contains information about the pay with points reward.Contains information about the redemption rollback.Contains information about the segment.Filter condition.Data filters used to narrow down the data records to be returned in the result.Data filters used to narrow down the data records to be returned in the result.List of available fields and filters that can be exported with a gift card or loyalty card transactions export along with the sorting order of the returned data.Gets or Sets fieldsHow the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order.List of available fields and filters that can be exported with gift card or loyalty card transactions along with the sorting order of the returned data.Gets or Sets fieldsHow the export is filtered, where the dash `-` preceding a sorting option means sorting in a descending order.This is an object representing a voucher with categories.Defines the type of the voucher.Gets or Sets validityDayOfWeekObject representing gift parameters.Defines how the credits are applied to the customer's order.Object representing loyalty card parameters.Stores a summary of publication events: an event counter and endpoint to return details of each event.Stores a summary of redemptions that have been applied to the voucher.