All Classes and Interfaces
Class
Description
Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
Lists 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.
Callback for asynchronous API call.
ApiClient class.
ApiException class.
API response returned by API call.
ApplicableTo
This object stores information about the resource to which the discount is applicable.
Gets or Sets ApplicableToEffect
ApplicableToResultList
The 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 rule
The type of the object represented by JSON.
The validation status of the assignment
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 validityDayOfWeek
Indicates 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 validityDayOfWeek
Indicates the status of the campaign's voucher generation.
Schema model for a campaign loyalty card.
CampaignLoyaltyCardExpirationRules
Type of period
Type of rounding
Schema model for a discount voucher.
Type of voucher.
Defines the redemption limits on vouchers.
CampaignsCreateRequestBody
Gets or Sets campaignType
Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.
Gets or Sets validityDayOfWeek
CampaignsCreateRequestBodyPromotion
CampaignsCreateRequestBodyVoucher
Gets or Sets type
CampaignsCreateRequestBodyVoucherRedemption
Response 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 validityDayOfWeek
Indicates 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 validityDayOfWeek
Indicates 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`.
CampaignsImportVoucherItem
Gets or Sets type
Gets or Sets validityDayOfWeek
CampaignsImportVoucherItemRedemption
Schema model for **GET** `v1/campaigns`.
CampaignsUpdateRequestBody
Defines whether the campaign can be updated with new vouchers after campaign creation.
Gets or Sets validityDayOfWeek
CampaignsUpdateRequestBodyOptions
Response 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 validityDayOfWeek
Indicates the status of the campaign's voucher generation.
CampaignsVouchersCreateCombinedResponseBody
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
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 **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 validityDayOfWeek
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.
CampaignTemplate
Type 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 validityDayOfWeek
Defines the redemption limits on vouchers.
Request body schema for **POST** `v1/categories`.
Response body schema for **POST** `v1/categories`.
Gets or Sets _object
Response 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 _object
This 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 expand
ClientRedemptionsRedeemRequestBodyRedeemablesItem
Gets or Sets _object
Contains 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 expand
ClientValidationsValidateRequestBodyRedeemablesItem
Gets or Sets _object
Contains 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`.
ClientValidationsValidateResponseBodyRedeemablesItem
Redeemable's object type.
Gets or Sets status
ClientValidationsValidateResponseBodyRedeemablesItemResult
ClientValidationsValidateResponseBodyRedeemablesItemResultDetails
ClientValidationsValidateResponseBodyRedeemablesItemResultDiscount
Gets or Sets effect
Gets or Sets type
ClientValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct
Stores the amount of gift card credits to be applied in the redemption.
ClientValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard
Contains information about the config used for the voucher code.
Create publication with campaign.
Customer
This is an object representing customer activity.
Customer's address.
CustomerId
The type of the object represented by JSON.
CustomerLoyalty
Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
Single customer's redeemable
Defines the type of the campaign.
Role of the holder.
Defines the type of the voucher.
Detailed information about the customer's redeemable item
Status 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`.
CustomerSummary
CustomerSummaryOrders
CustomerSummaryRedemptions
Summary 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.
CustomerWithSummaryLoyaltyReferrals
The type of the object represented by JSON.
Customer's address.
Contains information about the customer's cockpit.
Discount
Gets or Sets effect
Gets or Sets type
DiscountProduct
DiscountUnitMultipleOneUnit
Defines how the unit is added to the customer's order.
EarningRule
The type of the object represented by JSON.
Gets or Sets validityDayOfWeek
Contains details about the custom event.
EarningRuleLoyalty
Gets or Sets calculationType
Gets or Sets type
EarningRuleLoyaltyCustomer
Defines the ratio based on the property defined in the calculation_type parameter.
EarningRuleLoyaltyCustomEvent
Defines the ratio based on the property defined in the calculation_type parameter.
EarningRuleLoyaltyOrder
Defines the ratio based on the property defined in the calculation_type parameter.
EarningRuleLoyaltyOrderItems
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.
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 details
Includes 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`.
Export
Gets or Sets exportedObject
The type of object being represented.
Status of the export.
Gets or Sets ExportOrderFields
Gets or Sets ExportOrderOrder
ExportParameters
Gets or Sets fields
Gets or Sets order
ExportResult
ExportsCreateRequestBody
Gets or Sets exportedObject
ExportsCreateRequestBodyParameters
Gets or Sets fields
Gets or Sets order
ExportsCreateResponseBody
Gets or Sets exportedObject
The type of object being represented.
Status of the export.
ExportsCreateResponseBodyParameters
Gets or Sets fields
Gets or Sets order
Response body schema for **GET** `v1/exports/{exportId}`.
Gets or Sets exportedObject
The type of object being represented.
Status of the export.
ExportsGetResponseBodyParameters
Gets or Sets fields
Gets or Sets order
ExportsGetResponseBodyResult
Response 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 ExportVoucherTransactionsFields
ExportVoucherTransactionsFilters
Gets or Sets ExportVoucherTransactionsOrder
FieldConditions
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.
FiltersCondition
Contains current gift card balance information.
Defines how the credits are applied to the customer's order.
InapplicableTo
This object stores information about the resource to which the discount is applicable.
InapplicableToResultList
The type of the object represented by JSON.
The type of the object represented by JSON.
Gson TypeAdapter for Byte Array type
Gson TypeAdapter for java.util.Date type
If the dateFormat is null, ISO8601Utils will be used.
Gson TypeAdapter for JSR310 LocalDate type
Gson TypeAdapter for JSR310 OffsetDateTime type
Gson TypeAdapter for java.sql.Date type
If the dateFormat is null, a simple "yyyy-MM-dd" format will be used
(more efficient than SimpleDateFormat).
Logical Operator Between Filters.
ListPublicationsItemVoucher
The 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.
LocationsGetResponseBodyShape
Gets or Sets format
Gets or Sets type
Defines the parameters for the circle.
LocationsGetResponseBodyShapeGeojson
Gets or Sets type
LocationShape
Gets or Sets format
Gets or Sets type
Defines the parameters for the circle.
LocationShapeGeojson
Gets or Sets type
Response 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 validityDayOfWeek
Response 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 validityDayOfWeek
Indicates the status of the campaign's voucher generation.
Response body schema for **DELETE** `/loyalties/{campaignId}`.
LoyaltiesEarningRulesCreateRequestBodyItem
Gets or Sets validityDayOfWeek
Contains the schema id of a custom event.
LoyaltiesEarningRulesCreateRequestBodyItemLoyalty
Gets or Sets calculationType
Gets or Sets type
LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomer
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEvent
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrder
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItems
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.
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.
LoyaltiesEarningRulesCreateRequestBodyItemSource
Response body schema for **POST** `v1/loyalties/{campaignId}/earning-rules`.
The type of the object represented by JSON.
Gets or Sets validityDayOfWeek
Contains details about the custom event.
LoyaltiesEarningRulesCreateResponseBodyLoyalty
Gets or Sets calculationType
Gets or Sets type
LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomer
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesCreateResponseBodyLoyaltyCustomEvent
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrder
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesCreateResponseBodyLoyaltyOrderItems
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.
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 validityDayOfWeek
Contains details about the custom event.
LoyaltiesEarningRulesDisableResponseBodyLoyalty
Gets or Sets calculationType
Gets or Sets type
LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomer
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesDisableResponseBodyLoyaltyCustomEvent
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrder
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesDisableResponseBodyLoyaltyOrderItems
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.
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 validityDayOfWeek
Contains details about the custom event.
LoyaltiesEarningRulesEnableResponseBodyLoyalty
Gets or Sets calculationType
Gets or Sets type
LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomer
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesEnableResponseBodyLoyaltyCustomEvent
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrder
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesEnableResponseBodyLoyaltyOrderItems
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.
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 validityDayOfWeek
Contains details about the custom event.
LoyaltiesEarningRulesGetResponseBodyLoyalty
Gets or Sets calculationType
Gets or Sets type
LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomer
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesGetResponseBodyLoyaltyCustomEvent
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesGetResponseBodyLoyaltyOrder
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesGetResponseBodyLoyaltyOrderItems
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.
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.
LoyaltiesEarningRulesUpdateRequestBody
Gets or Sets validityDayOfWeek
LoyaltiesEarningRulesUpdateRequestBodyLoyalty
Gets or Sets calculationType
Gets or Sets type
LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomer
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesUpdateRequestBodyLoyaltyCustomEvent
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrder
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesUpdateRequestBodyLoyaltyOrderItems
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.
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 validityDayOfWeek
Contains details about the custom event.
LoyaltiesEarningRulesUpdateResponseBodyLoyalty
Gets or Sets calculationType
Gets or Sets type
LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomer
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesUpdateResponseBodyLoyaltyCustomEvent
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrder
Defines the ratio based on the property defined in the calculation_type parameter.
LoyaltiesEarningRulesUpdateResponseBodyLoyaltyOrderItems
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.
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 validityDayOfWeek
Indicates 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 validityDayOfWeek
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.
Response body schema for **GET** `/loyalties/{campaignId}/members/{memberId}` and **GET** `/loyalties/members/{memberId}`.
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
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.
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 JSON
Defines 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.
LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptions
LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRedemptionsItem
LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRollbacksItem
LoyaltiesMembersRedemptionRedeemResponseBodyRelatedRedemptionsRollbacksItem.CustomTypeAdapterFactory
Defines the details of the voucher being redeemed.
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
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.
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.
LoyaltiesMembersRewardsListResponseBodyDataItem
The 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 validityDayOfWeek
Stores 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 fields
How 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.CustomTypeAdapterFactory
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.
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 fields
How 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.CustomTypeAdapterFactory
Data 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**.
LoyaltiesRewardsCreateAssignmentItemRequestBody
Defines 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.
LoyaltiesTiersCreateInBulkRequestBodyItem
Response 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`.
LoyaltiesTransferPoints
Request body schema for **PUT** `/loyalties/{campaignId}`.
Defines whether the campaign can be updated with new vouchers after campaign creation.
Gets or Sets validityDayOfWeek
LoyaltiesUpdateCampaignRequestBodyOptions
Response 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 validityDayOfWeek
Indicates the status of the campaign's voucher generation.
LoyaltyCampaign
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 validityDayOfWeek
Indicates the status of the campaign's voucher generation.
Schema model for a campaign voucher.
Type of voucher.
Gets or Sets validityDayOfWeek
Defines the redemption limits on vouchers.
LoyaltyCardTransaction
Contains 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 validityDayOfWeek
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.
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.
LoyaltyTier
The type of the object represented by JSON.
LoyaltyTierBase
Defines 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.
ManagementProject
The 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.
ManagementProjectsBrandingUpdateRequestBody
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 **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).
ManagementProjectsGetResponseBody
The 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.
ManagementProjectsUpdateResponseBody
The 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.
ManagementProjectsUsersAssignRequestBody
Details 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.
ManagementProjectsUsersUpdateRoleRequestBody
Details about the user assigned to the project.
Response body schema for webhook endpoints.
Gets or Sets events
The type of the object represented by JSON.
Request body schema for **POST** `/management/v1/projects/{projectId}/webhooks/{webhookId}`.
Gets or Sets events
Response body schema for **POST** `/management/v1/projects/{projectId}/webhooks`.
Gets or Sets events
The type of the object represented by JSON.
Response body schema for **GET** `/management/v1/projects/{projectId}/webhooks/{webhookId}`.
Gets or Sets events
The 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 events
Response body schema for **PUT** `/management/v1/projects/{projectId}/webhooks/{webhookId}`.
Gets or Sets events
The 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.
MappingPoints
Gets or Sets type
This is an object representing member activity.
Custom definition name.
Gets or Sets type
Object 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.
OrderCalculatedItem
The 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.
OrderItem
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.
OrderRedemptionsEntry
Request 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.
OrdersImportCreateRequestBodyItem
The 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 ParameterActivityCategory
Gets or Sets ParameterCampaignType
ParameterCreatedBeforeAfter
Gets or Sets ParameterExpandListCampaigns
ParameterFiltersListBin
Unique 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.
ParameterFiltersListBinResourceTypeConditions
Gets or Sets $in
Value is exactly this value (single value).
Results omit this value (single value).
Gets or Sets $notIn
ParameterFiltersListCampaigns
Type of the campaign.
ParameterFiltersListCampaignsCampaignStatusConditions
Gets or Sets $in
Value is exactly this value (single value).
Results omit this value (single value).
Gets or Sets $notIn
Filter by categories names
Filter by categories ids
Value is exactly this value (single value).
Results omit this value (single value).
Filter by validity timeframe
Filter by voucher type
ParameterFiltersListCustomerRedeemables
Unique campaign identifer, e.g.
Type of the campaign.
ParameterFiltersListCustomerRedeemablesCampaignTypeConditions
Gets or Sets $in
Value is exactly this value (single value).
Results omit this value (single value).
Gets or Sets $notIn
Timestamp representing the date and time when the customer redeemable was created.
Holder role of the redeemable.
ParameterFiltersListCustomerRedeemablesHolderRoleConditions
Gets or Sets $in
Value is exactly this value (single value).
Results omit this value (single value).
Gets or Sets $notIn
Unique redeemable holder ID, i.e.
Unique redeemable ID, e.g.
Unique related object, i.e.
ParameterFiltersListCustomerRedeemablesRedeemableObjectConditions
Gets or Sets $in
Value is exactly this value (single value).
Results omit this value (single value).
Gets or Sets $notIn
Type of the voucher.
ParameterFiltersListCustomerRedeemablesVoucherTypeConditions
Gets or Sets $in
Value is exactly this value (single value).
Results omit this value (single value).
Gets or Sets $notIn
ParameterFiltersListLocations
Timestamp representing the date and time when the location was created.
ParameterFiltersListLocationsName
Timestamp representing the date and time when the location was updated.
ParameterFiltersListPublications
Filter 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.
ParameterFiltersListRedemptions
Campaign 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.
ParameterFiltersListReferralsRedeemableHolders
Timestamp representing the date and time when the redeemable was added to the holder.
Unique customer ID, i.e.
Holder role of the redeemable.
ParameterFiltersListReferralsRedeemableHoldersHolderRoleConditions
Gets or Sets $in
Value is exactly this value (single value).
Results omit this value (single value).
Gets or Sets $notIn
Unique redeemable holder ID, i.e.
ParameterFiltersListTemplates
Campaign template campaign type.
Data filters used to narrow down the data records to be returned in the result.
Gets or Sets $in
Value is exactly this value (single value).
Results omit this value (single value).
Gets or Sets $notIn
Unique template ID.
Unique user-defined template name.
Gets or Sets ParameterOrder
Gets or Sets ParameterOrderCreatedAt
Gets or Sets ParameterOrderListAllPromotionStacks
Gets or Sets ParameterOrderListBin
Gets or Sets ParameterOrderListCampaigns
Gets or Sets ParameterOrderListCustomers
Gets or Sets ParameterOrderListEarningRules
Gets or Sets ParameterOrderListExports
Gets or Sets ParameterOrderListLocations
Gets or Sets ParameterOrderListLoyaltyTiers
Gets or Sets ParameterOrderListOrders
Gets or Sets ParameterOrderListPromotionTiers
Gets or Sets ParameterOrderListPromotionTiersClientSide
Gets or Sets ParameterOrderListPublications
Gets or Sets ParameterOrderListRedeemables
Gets or Sets ParameterOrderListRedemptions
Gets or Sets ParameterOrderListTransactions
Gets or Sets ParameterOrderListValidationRuleAssignments
Gets or Sets ParameterOrderListValidationRules
Gets or Sets ParameterOrderVouchers
Gets or Sets ParameterResultListPublications
Gets or Sets ParameterTemplatesList
ParameterUpdatedBeforeAfter
Gets or Sets ParameterVoucherTypeListPublications
Gets or Sets PointsExpirationTypes
This is an object representing a product.
The type of the object represented by JSON.
ProductCollectionsCreateRequestBody
Show that the product collection is static (manually selected products).
ProductCollectionsCreateRequestBodyProductsItem
Denotes 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).
ProductCollectionsCreateResponseBodyProductsItem
Denotes 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).
ProductCollectionsGetResponseBodyProductsItem
Denotes 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).
ProductCollectionsItemProductsItem
Denotes 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`.
ProductCollectionsProductsListResponseBodyDataItem
Gets or Sets _object
Request 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}/skus
Response 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.
ProductWithoutSkus
The type of the object represented by JSON.
Request body schema for **POST** `v1/promotions/{campaignId}/stacks`.
Contains the tier configuration.
Gets or Sets hierarchyMode
Response body schema for **POST** `v1/promotions/{campaignId}/stacks`.
The type of the object represented by JSON.
Contains the tier configuration.
Gets or Sets hierarchyMode
Response body schema for **GET** `v1/promotions/{campaignId}/stacks/{stackId}`.
The type of the object represented by JSON.
Contains the tier configuration.
Gets or Sets hierarchyMode
Response 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 hierarchyMode
PromotionStack
The type of the object represented by JSON.
PromotionStackBase
Contains the tier configuration.
Gets or Sets hierarchyMode
Contains the tier configuration.
Gets or Sets hierarchyMode
Request body schema for **POST** `v1/v1/promotions/{campaignId}/tiers`.
Gets or Sets validityDayOfWeek
Contains details about the discount applied by the promotion tier.
Response body schema for **POST** `v1/promotions/{campaignId}/tiers`.
Gets or Sets validityDayOfWeek
Contains details about the discount applied by the promotion tier.
Contains details about promotion tier's parent campaign.
Gets or Sets validityDayOfWeek
Contains 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 validityDayOfWeek
Contains details about the discount applied by the promotion tier.
Contains details about promotion tier's parent campaign.
Gets or Sets validityDayOfWeek
Contains 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 validityDayOfWeek
Contains details about the discount applied by the promotion tier.
Contains details about promotion tier's parent campaign.
Gets or Sets validityDayOfWeek
Contains 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 validityDayOfWeek
Contains details about the discount applied by the promotion tier.
Contains details about promotion tier's parent campaign.
Gets or Sets validityDayOfWeek
Contains 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 validityDayOfWeek
Contains details about the discount applied by the promotion tier.
Response body schema for **PUT** `v1/promotions/tiers/{promotionTierId}`.
Gets or Sets validityDayOfWeek
Contains details about the discount applied by the promotion tier.
Contains details about promotion tier's parent campaign.
Gets or Sets validityDayOfWeek
Contains 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 validityDayOfWeek
Contains details about the discount applied by the promotion tier.
Contains details about promotion tier's parent campaign.
Gets or Sets validityDayOfWeek
This is an object representing a promotion tier create params.
Gets or Sets validityDayOfWeek
Contains details about the discount applied by the promotion tier.
Promotion Tiers
Contains statistics about promotion tier redemptions and orders.
Contains statistics about orders related to the promotion tier.
Contains statistics about promotion tier redemptions.
PublicationsCreateRequestBody
PublicationsCreateResponseBody
How 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`.
PublicationsListResponseBodyPublicationsItem
The type of the object represented by the JSON.
Gets or Sets result
PublicationsListResponseBodyPublicationsItemMetadata
Request body schema for **POST** `v1/qualifications`.
Defines the scenario Voucherify should consider during the qualification process.
Response body schema for **POST** `v1/qualifications`.
QualificationsFieldConditions
QualificationsFiltersCondition
Configure parameters returned in the response.
Gets or Sets expand
Is 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.
QualificationsOptionFiltersHolderRole
Data filters used to narrow down the data records to be returned in the result.
Gets or Sets $in
Gets or Sets $is
Gets or Sets $isNot
Gets or Sets $notIn
QualificationsOptionFiltersResourceType
Data filters used to narrow down the data records to be returned in the result.
QualificationsRedeemable
Object 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 redeemable
Defines 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 response
Information about redeemable result.
This is an object representing a voucher.
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
Object 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 JSON
Defines 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.
RedemptionEntry
Gets or Sets _object
Defines the related object.
Redemption result.
Gets or Sets status
RedemptionEntryChannel
Gets or Sets channelType
RedemptionEntryCustomer
The type of the object represented by JSON.
RedemptionEntryGift
RedemptionEntryLoyaltyCard
RedemptionEntryOrder
The type of the object represented by JSON.
The order status.
RedemptionEntryOrderCustomer
The type of the object represented by JSON.
RedemptionEntryOrderReferrer
The type of the object represented by JSON.
RedemptionEntryPromotionTier
Gets or Sets validityDayOfWeek
RedemptionEntryPromotionTierAction
RedemptionEntryPromotionTierCampaign
Gets or Sets validityDayOfWeek
RedemptionEntryPromotionTierSummary
RedemptionEntryPromotionTierSummaryOrders
RedemptionEntryPromotionTierSummaryRedemptions
RedemptionEntryRelatedRedemptions
RedemptionEntryRelatedRedemptionsRedemptionsItem
RedemptionEntryRelatedRedemptionsRollbacksItem
RedemptionEntryVoucher
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
RedemptionEntryVoucherGift
Defines how the credits are applied to the customer's order.
RedemptionEntryVoucherLoyaltyCard
RedemptionEntryVoucherPublish
RedemptionEntryVoucherRedemption
Contains the amount subtracted from the gift card for the redemption.
Contains the number of points subtracted from the loyalty card for the redemption.
RedemptionRelatedRedemptions
RedemptionRelatedRedemptionsRedemptionsItem
RedemptionRelatedRedemptionsRollbacksItem
RedemptionRewardResult
The type of the object represented by the JSON
Reward 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 JSON
Defines 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.
RedemptionRollbackRelatedRedemptions
RedemptionRollbackRelatedRedemptionsRedemptionsItem
RedemptionRollbackRelatedRedemptionsRollbacksItem
RedemptionsGetResponseBody
Gets or Sets _object
Defines the related object.
Redemption result.
Gets or Sets status
RedemptionsGetResponseBodyChannel
Gets or Sets channelType
RedemptionsGetResponseBodyCustomer
The type of the object represented by JSON.
RedemptionsGetResponseBodyGift
RedemptionsGetResponseBodyLoyaltyCard
RedemptionsGetResponseBodyOrder
The type of the object represented by JSON.
The order status.
RedemptionsGetResponseBodyOrderCustomer
The type of the object represented by JSON.
RedemptionsGetResponseBodyOrderReferrer
The type of the object represented by JSON.
RedemptionsGetResponseBodyPromotionTier
Gets or Sets validityDayOfWeek
RedemptionsGetResponseBodyPromotionTierAction
RedemptionsGetResponseBodyPromotionTierCampaign
Gets or Sets validityDayOfWeek
RedemptionsGetResponseBodyPromotionTierSummary
RedemptionsGetResponseBodyPromotionTierSummaryOrders
RedemptionsGetResponseBodyPromotionTierSummaryRedemptions
RedemptionsGetResponseBodyRelatedRedemptions
RedemptionsGetResponseBodyRelatedRedemptionsRedemptionsItem
RedemptionsGetResponseBodyRelatedRedemptionsRollbacksItem
RedemptionsGetResponseBodyVoucher
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
RedemptionsGetResponseBodyVoucherGift
Defines how the credits are applied to the customer's order.
RedemptionsGetResponseBodyVoucherLoyaltyCard
RedemptionsGetResponseBodyVoucherPublish
RedemptionsGetResponseBodyVoucherRedemption
Response body schema for **GET** `v1/redemptions`.
RedemptionsListResponseBodyRedemptionsItem
Gets or Sets _object
Defines the related object.
Redemption result.
Gets or Sets status
RedemptionsListResponseBodyRedemptionsItemChannel
Gets or Sets channelType
RedemptionsListResponseBodyRedemptionsItemCustomer
The type of the object represented by JSON.
RedemptionsListResponseBodyRedemptionsItemGift
RedemptionsListResponseBodyRedemptionsItemLoyaltyCard
RedemptionsListResponseBodyRedemptionsItemOrder
The type of the object represented by JSON.
The order status.
RedemptionsListResponseBodyRedemptionsItemOrderCustomer
The type of the object represented by JSON.
RedemptionsListResponseBodyRedemptionsItemOrderReferrer
The type of the object represented by JSON.
RedemptionsListResponseBodyRedemptionsItemPromotionTier
Gets or Sets validityDayOfWeek
RedemptionsListResponseBodyRedemptionsItemPromotionTierAction
RedemptionsListResponseBodyRedemptionsItemPromotionTierCampaign
Gets or Sets validityDayOfWeek
RedemptionsListResponseBodyRedemptionsItemPromotionTierSummary
RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryOrders
RedemptionsListResponseBodyRedemptionsItemPromotionTierSummaryRedemptions
RedemptionsListResponseBodyRedemptionsItemRelatedRedemptions
RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsItem
RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRedemptionsItem.CustomTypeAdapterFactory
RedemptionsListResponseBodyRedemptionsItemRelatedRedemptionsRollbacksItem
RedemptionsListResponseBodyRedemptionsItemVoucher
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
RedemptionsListResponseBodyRedemptionsItemVoucherGift
Defines how the credits are applied to the customer's order.
RedemptionsListResponseBodyRedemptionsItemVoucherLoyaltyCard
RedemptionsListResponseBodyRedemptionsItemVoucherPublish
RedemptionsListResponseBodyRedemptionsItemVoucherRedemption
Response body schema for **POST** `v1/redemptions`.
Configure parameters returned in the response.
Gets or Sets expand
RedemptionsRedeemRequestBodyRedeemablesItem
Gets or Sets _object
Contains 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 JSON
Defines 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.
RedemptionsRollbackCreateResponseBodyRelatedRedemptions
RedemptionsRollbackCreateResponseBodyRelatedRedemptionsRedemptionsItem
RedemptionsRollbackCreateResponseBodyRelatedRedemptionsRollbacksItem
Request 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 validityDayOfWeek
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.
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`
Referrer
Customer's address.
ReferrerId
The type of the object represented by JSON.
Types of usable resources.
Reward
The type of the object represented by the JSON.
Reward type.
RewardAssignment
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.
These properties are configurable for **material rewards**.
RewardsAssignmentsCreateRequestBody
Defines 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.
RewardsCreateRequestBody
Attributes of a material reward.
RewardsCreateRequestBodyParameters
RewardsCreateRequestBodyParametersCampaign
Define 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`.
RewardsUpdateRequestBody
Attributes of a material reward.
RewardsUpdateRequestBodyParameters
RewardsUpdateRequestBodyParametersCampaign
Define 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**.
RewardType
Objects 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.
SegmentsCreateRequestBody
Gets or Sets type
Response body schema for **POST** `v1/segments`.
Gets or Sets initialSyncStatus
The 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 initialSyncStatus
The 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).
Representing a Server configuration.
Representing a Server Variable for server URL template substitution.
Session
Defines 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.
SimpleProductDiscountUnit
SimpleSegment
The type of the object represented by the ID.
SimpleSkuDiscountUnit
Simplified 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 validityDayOfWeek
Stores 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.
TemplatesCampaignsCampaignSetupCreateResponseBodyCreatedResourcesItem
The 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 validityDayOfWeek
Response body schema for **POST** `/v1/templates/campaigns/{campaignTemplateId}/tier-setup`.
The type of the object represented by JSON.
TemplatesCampaignsTierSetupCreateResponseBodyCreatedResourcesItem
The 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.
UsageNotifications
Details about the user.
ValidationRule
Validation rule context type.
Type of validation rule.
ValidationRuleApplicableTo
This 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 List
Contains 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 Assignments
Identifies 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.
ValidationRulesCreateRequestBodyApplicableTo
Contains 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.
ValidationRulesCreateResponseBodyApplicableTo
Contains 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.
ValidationRulesGetResponseBodyApplicableTo
Contains 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.
ValidationRulesUpdateRequestBodyApplicableTo
Contains 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.
ValidationRulesUpdateResponseBodyApplicableTo
Contains the error message returned from API when validation / redemption fails to meet requirements of defined rules.
ValidationsRedeemableInapplicable
Redeemable'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 inapplicable
Provides details about the reason why the redeemable is inapplicable.
ValidationsRedeemableSkipped
Redeemable'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.
ValidationsRedeemableSkippedResultDetails
Gets or Sets key
Response body schema for **POST** `v1/validations`.
Configure parameters returned in the response.
Gets or Sets expand
ValidationsValidateRequestBodyRedeemablesItem
Gets or Sets _object
Contains 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`.
ValidationsValidateResponseBodyRedeemablesItem
Redeemable's object type.
Gets or Sets status
ValidationsValidateResponseBodyRedeemablesItemResult
ValidationsValidateResponseBodyRedeemablesItemResultDetails
ValidationsValidateResponseBodyRedeemablesItemResultDiscount
Gets or Sets effect
Gets or Sets type
ValidationsValidateResponseBodyRedeemablesItemResultDiscountProduct
Stores the amount of gift card credits to be applied in the redemption.
ValidationsValidateResponseBodyRedeemablesItemResultLoyaltyCard
Determines the hours of validity, e.g.
Defines the reccuring period(s) when the resource will be active.
Gets or Sets daysOfWeek
Set 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 validityDayOfWeek
Stores 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.
VouchersCreateRequestBody
Gets or Sets type
Gets or Sets validityDayOfWeek
VouchersCreateRequestBodyRedemption
Response body schema for **POST** `v1/vouchers` and `/vouchers/{code}`
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
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.
VouchersCreateWithSpecificCodeRequestBody
Gets or Sets type
Gets or Sets validityDayOfWeek
VouchersCreateWithSpecificCodeRequestBodyRedemption
Response body schema for **POST** `v1/vouchers/{code}/disable`.
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
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.
Response body schema for **POST** `v1/vouchers/{code}/enable`.
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
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.
Response body schema for **GET** `v1/vouchers/{code}`.
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
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.
VouchersImportCreateItemRequestBody
Gets or Sets type
Gets or Sets validityDayOfWeek
VouchersImportCreateItemRequestBodyRedemption
Response 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.
VouchersUpdateInBulkItemRequestBody
Response body schema for **POST** `v1/vouchers/bulk/async`.
VouchersUpdateRequestBody
Gets or Sets type
Gets or Sets validityDayOfWeek
Response body schema for **PUT** `v1/vouchers/{code}`.
Defines the type of the voucher.
Gets or Sets validityDayOfWeek
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.
VoucherTransaction
Gets or Sets type
Contains 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 fields
How 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 fields
How 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 validityDayOfWeek
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.