Loyalty - 010901

Couponing API - 01090101118

WebServiceServerConfig

Parameter Name Data Type, Range Description Default
address String
connectionTimeout Integer This parameter defines the timeout for establishing the connection. 10000
timeout Integer This parameter defines the timeout for responding after establishing the connection. 15000
username String
password String
passwordencryptorclass String
format String

Delete Manual Line Item Discount - 01090100314

RemoveDiscountsForLineItemConfig

Note:
extends ProcessConfig
Parameter Name Migration Data Type, Range Description Default
positionOperationConfig PositionOperationConfig It defines the configuration for line item-related operations.
confirmDialog MessageDialogConfig

Delete Manual Receipt Discount - 01090100328

RemoveDiscountsForTransactionConfig

Note:
extends ProcessConfig
Parameter Name Data Type, Range Description Default
positionOperationConfig PositionOperationConfig It defines the configuration for line item-related operations.
confirmDialog MessageDialogConfig
confirmRemove Boolean It specifies whether a confirmation prompt is displayed before removing discounts. true

Display Unused Coupons - 01090100327

DisplayCouponsConfig

Note:
extends ProcessConfig
Parameter Name Migration Data Type, Range Description Default
displayCouponMode UNUSED

ALL

NONE

 String The function is called with the mode "Unused" and displays all unused coupons.

The function is called with the mode "All" and displays all coupons.

Employee Purchase - 01090101105

Function Parameters

Table 1. EmployeePurchaseConfig
Parameter Name Migration Data Type, Range Description Default
checkEmployeeID MITARBEITER_CHECK Boolean It specifies whether the employee number is checked against the master data. true
cashierAsEmployee MITARBEITER_GLEICH_KASSIERER Boolean It defines whether the cashier is equal to the employee.

True: The logged-in operator is allowed to make employee purchases on their own behalf.

False: The logged-in operator is not allowed to make employee purchases on their own behalf.

 false
checkDiscountEligibility CHECK_DISCOUNT_ELIGIBLE Boolean It defines whether the discount condition of the employee logging in is checked. true
employeeID MITARBEITERNUMMER String It defines the predefined employee number.
promptUserConfig PromptUserDialogConfig It defines the prompt user config.
positionOperationConfig PositionOperationConfig It defines the configuration for line item-related operations.
Note:
extends ProcessConfig

Interface Couponing System - 01090101117

Parameter Name Data Type, Range Description
externalSystemAdapterName String Name of the couponing adapter that should be used by default.

Loyalty Reward - 01090100315

Function Parameters

Table 2. LoyaltyRewardConfig
Parameter Name Data Type, Range Description Default
externalSystemAdapterName String It defines the Stored Value Server instance to be used and contains the logical name of the adapter.
gcsUsage Boolean It specifies whether the Stored Value Server is used. true
gcPrefix String It defines the prefix for the generation of the gift certificate number. 98
useCouponingService Boolean It defines whether the coupon should be issued by the couponing service. false
Note:
extends ProcessConfig

Manual Line Item Discount - 01090100311

Functional Parameters

Table 3. ManualLineItemDiscountConfig
Parameter Name Data Type, Range Description Default
positionOperationConfig PositionOperationConfig It defines the configuration for line item-related operations.
promotionOperationConfig PromotionOperationConfig It defines the configuration for promotion-related operations.
promptUserConfig PromptUserDialogConfig It defines the configuration for prompting the user.
itemRequired Boolean It specifies whether an item must have been entered to execute the function. false
reasonRequired Boolean It defines whether a reason for price changes is required. true
reasonCode String It defines the reason.
reasonGroupCode String It filters reasons with the following reason group code.
inputOrder BEFORE_OR_AFTER

BEFORE

AFTER

 It defines whether the promotion value must be known before/after starting the process.

BEFORE_OR_AFTER - The condition value is entered before or after the function call.

BEFORE - The condition value is entered before the function call.

AFTER - The condition value is entered after the function call.

 BEFORE_OR_AFTER
maxQuantity Integer It defines the maximum quantity up to which a line item discount can be granted. If the parameter is set to 0 or not filled, the quantity will not be checked. In this case, the line item discount is allowed for any quantity.
limitExceededAuthorizationConfig AuthorizationConfig It defines the configuration of dialogs for limit exceeded promotions.
limitExceededWarnMessageDialogConfig MessageDialogConfig
limitExceededForbidMessageDialogConfig MessageDialogConfig
validationMode Boolean It defines the process usage; the validation mode is the mode for validation of already created triggers.
referenceValue String The reference is stored as additional information.
checkIfRebateWasApplied Boolean It specifies whether a check is made to determine if the discount was actually applied. true
Note:
extends ProcessConfig
Table 4. PromotionOperationConfig
Parameter Name Data Type, Range Description Default
triggerType String It defines the trigger type (reference to the corresponding promotion) for the Loyalty Engine (e.g. CO).
triggerValue String It defines the trigger value (reference to the corresponding promotion) for the Loyalty Engine.
privilegeType PromotionTriggerPrivilegeType [REBATEPERCENT, REBATESINGLE, NEWPRICE, REBATEAMOUNT]

RP/RS/PS/AM

 Type of manual discount

RP: Discount in %

RS: Absolute discount

PS: New price

AM: Discount value resulting from promotion

 RP
privilegeValue Double It defines the condition value.
sequenceType FIX/MAX/SAME FIX: Only one entry can be created per TriggerValue for the currently active line item. If an entry exists already, this entry will be overwritten.

MAX: No more than the number of entries defined by the parameter MAX_SEQUENCE can be created per TriggerValue for the currently active receipt line item.

SAME: No more than the number of entries defined by the parameter MAX_SEQUENCE can be created per TriggerValue for the currently active receipt line item. The sequence addend always corresponds to the value defined in the parameter START_SEQUENCE.

 FIX
startSequence Integer It defines the start value of the sequence addend. 1
maxSequence Integer It defines the maximum number of conditions/promotions with the same trigger value. 1
maxLimitWarn Double It defines the maximum percentage deviation from the unit price of the line item, from which a warning message is displayed. A warning message is displayed if the defined maxLimitWarn is exceeded. 100
maxLimitAuthorize Double It defines the maximum percentage deviation from the unit price of the item, from which authorization is required. Authorization is required if the defined maxLimitAuthorize is exceeded. 100
maxLimitForbid Double It defines the maximum percentage deviation from the unit price of the item, from which it is not allowed to exceed the limit. An error message is required if the defined maxLimitForbid is exceeded. The operation will be canceled. 100
priceDeviationType ALL

EQUAL_LESS

EQUAL_GREATER

 It defines the price deviation with respect to the previously valid line item price:

ALL: The new price can be greater than, smaller than, or equal to the previously valid line item price.

EQUAL_LESS: The new price must be smaller than or equal to the previous price.

EQUAL_GREATER: The new price must be greater than or equal to the previous price.

 ALL

Manual Receipt Discount - 01090100312

Functional Parameters

Table 5. ManualReceiptDiscountConfig
Parameter Name Data Type, Range Description Default
promotionOperationConfig PromotionOperationConfig It defines the configuration for promotion-related operations.
reasonRequired Boolean It defines whether a reason is requested. true
reasonCode String It defines the reason.
reasonGroupCode String It filters reasons with the following reason group code.
referenceRequired Boolean It specifies whether a reference is requested. false
referenceValue String It defines the reference as additional information.
takeInputFieldValue Boolean It specifies whether a value is entered before the function call. It can be used as the condition value or ignored.

True: The value on the entry line is used.

False: The value on the entry line is ignored.

 true
limitExceededAuthorizationConfig AuthorizationConfig It defines the configuration of dialogs for limit exceeded promotions.
limitExceededWarnMessageDialogConfig MessageDialogConfig
limitExceededForbidMessageDialogConfig MessageDialogConfig
promptUserPrivilegeValueConfig PromptUserDialogConfig It defines the prompt user condition value config.
promptUserReferenceValueConfig PromptUserDialogConfig It defines the prompt user reference value config.
Note:
extends ProcessConfig
Table 6. PromotionOperationConfig
Parameter Name Data Type, Range Description Default
triggerType String It defines the trigger type (reference to the corresponding promotion) for the Loyalty Engine (e.g. CO).
triggerValue String It defines the trigger value (reference to the corresponding promotion) for the Loyalty Engine.
privilegeType PromotionTriggerPrivilegeType [REBATEPERCENT, REBATESINGLE, NEWPRICE, REBATEAMOUNT]

RP/RS/PS/AM

 Type of manual discount

RP: Discount in %

RS: Absolute discount

PS: New price

AM: Discount value resulting from promotion

 RP
privilegeValue Double It defines the condition value.
sequenceType PromotionTriggerSequenceType [

FIX

MAX

SAME]

 FIX: Only one entry can be created per TriggerValue for the currently active line item. If an entry exists already, this entry will be overwritten.

MAX: No more than the number of entries defined by the parameter MAX_SEQUENCE can be created per TriggerValue for the currently active receipt line item.

SAME: No more than the number of entries defined by the parameter MAX_SEQUENCE can be created per TriggerValue for the currently active receipt line item. The sequence addend always corresponds to the value defined in the parameter START_SEQUENCE.

 FIX
startSequence Integer It defines the start value of the sequence addend. 1
maxSequence Integer It defines the maximum number of conditions/promotions with the same trigger value. 1
maxLimitWarn Double It defines the maximum percentage deviation from the unit price of the line item, from which a warning message is displayed. A warning message is displayed if the defined maxLimitWarn is exceeded. 100
maxLimitAuthorize Double It defines the maximum percentage deviation from the unit price of the item, from which authorization is required. Authorization is required if the defined maxLimitAuthorize is exceeded. 100
maxLimitForbid Double It defines the maximum percentage deviation from the unit price of the item, from which it is not allowed to exceed the limit. An error message is required if the defined maxLimitForbid is exceeded. The operation will be canceled. 100
priceDeviationType ALL

EQUAL_LESS

EQUAL_GREATER

 It defines the price deviation with respect to the previously valid line item price:

ALL: The new price can be greater than, smaller than, or equal to the previously valid line item price.

EQUAL_LESS: The new price must be smaller than or equal to the previous price.

EQUAL_GREATER: The new price must be greater than or equal to the previous price.

 ALL

Promotion Coupon - 01090100309

Server Parameters

Table 7. CouponingServiceConfigs
Parameter Name Data Type, Range Description Default
companyCode String It defines the company code. GK

Functional Parameters

Table 8. EnterCouponConfig
Parameter Name Data Type, Range Description Default
couponNumber String It defines the number of the coupon.
privilegeType EnterCouponPrivilegeType [DISCOUNT_PERCENT, DISCOUNT_ABSOLUTE, PRICE_ABSOLUTE]

RP/RS/PS

 It defines the privilege type.
  • DISCOUNT_PERCENT: discount in % (RP)
  • DISCOUNT_ABSOLUTE: absolute discount (RS)
  • PRICE_ABSOLUTE: new price (PS)
privilegeValue String It defines the condition value (percentage, absolute value, or new price according to privilegeType).
privilegeRequired Flag It specifies whether a condition value is required. false
showRegistrationMessage Flag It specifies whether information is displayed after the coupon was successfully entered. false
positionOperationConfig PositionOperationConfig It defines the configuration for position-related operations.
customerIdentificationConfig CustomerIdentificationConfig It defines whether and how the customer is identified.
doneMessageConfig MessageDialogConfig It defines the process completed message.
promptCouponNumberConfig PromptUserDialogConfig It defines the user dialog for the input of the coupon number.
promptPrivilegeValueConfigDefault PromptUserDialogConfig It defines the user dialog for the input of the privilege value if no privilege type was specified.
promptPrivilegeValueConfigDiscount PromptUserDialogConfig It defines the user dialog for the input of the privilege value if the privilege type discount was specified.
promptPrivilegeValueConfigPrice PromptUserDialogConfig It defines the user dialog for the input of the privilege value if the privilege type price was specified.
promptPrivilegeValueConfigReduction PromptUserDialogConfig It defines the user dialog for the input of the privilege value if the privilege type reduction was specified.
useCouponingService Boolean It defines whether the coupon should be verified against the couponing service. false
couponSerialNumber String It contains the serial number of the coupon in the case of serialized coupons.
offlineAllowed Boolean It defines whether it is allowed to accept the coupon if the couponing service is not available. true
Note:
extends ProcessConfig

Promotion Gift Certificate Line Item - 01090100219

Function Parameters

Table 9. PromotionGiftCertificateConfig
Parameter Name Data Type, Range Description
promotionGiftCertificateTaxGroup String It defines the tax group of the promotion gift certificate line item.