Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 3.19 KB

ManagementProjectsStackingRulesCreateRequestBody.md

File metadata and controls

52 lines (32 loc) · 3.19 KB

ManagementProjectsStackingRulesCreateRequestBody

Request body schema for POST /management/v1/projects/{projectId}/stacking-rules.

Properties

Name Type Description
exclusiveCategories List<String> Lists the IDs of the categories that are exclusive.
jointCategories List<String> Lists the IDs of the categories that are joint.
redeemablesLimit Integer Defines how many redeemables can be sent to Voucherify for validation at the same time.
applicableRedeemablesLimit Integer Defines how many redeemables can be applied at the same time. The number must be less than or equal to `&quot;redeemables_limit&quot;`.
applicableRedeemablesPerCategoryLimit Integer Defines how many redeemables with the same category can be applied at the same time. The number must be less than or equal to `&quot;applicable_redeemables_limit&quot;`.
applicableExclusiveRedeemablesLimit Integer Defines how many redeemables with an assigned exclusive category can be applied at the same time.
applicableExclusiveRedeemablesPerCategoryLimit Integer Defines how many exclusive redeemables with the same category can be applied at the same time. The number must be less than or equal to `&quot;applicable_exclusive_redeemables_limit&quot;`.
discountCalculationMode DiscountCalculationModeEnum Defines if the discounts are applied by taking into account the initial order amount or the discounted order amount.
initialAmountModeCategories List<String> Lists the IDs of the categories that apply a discount based on the initial amount.
discountedAmountModeCategories List<String> Lists the IDs of the categories that apply a discount based on the discounted amount.
redeemablesApplicationMode RedeemablesApplicationModeEnum Defines the application mode for redeemables. `&quot;ALL&quot;` means that all redeemables must be validated for the redemption to be successful. `&quot;PARTIAL&quot;` means that only those redeemables that can be validated will be redeemed. The redeemables that fail validaton will be skipped.
redeemablesSortingRule RedeemablesSortingRuleEnum Defines the sorting rule for redeemables. `&quot;CATEGORY_HIERARCHY&quot;` means that redeemables are applied with the order established by the hierarchy of the categories. `&quot;REQUESTED_ORDER&quot;` means that redeemables are applied with the order established in the request.

Enum: DiscountCalculationModeEnum

Name Value
INITIAL_AMOUNT "INITIAL_AMOUNT"
DISCOUNTED_AMOUNT "DISCOUNTED_AMOUNT"

Enum: RedeemablesApplicationModeEnum

Name Value
ALL "ALL"
PARTIAL "PARTIAL"

Enum: RedeemablesSortingRuleEnum

Name Value
CATEGORY_HIERARCHY "CATEGORY_HIERARCHY"
REQUESTED_ORDER "REQUESTED_ORDER"