Notification Handling (hidden)
Overview
The Checkout API supports a flexible notification system across all state endpoints (e.g., orderState
, orderOptions
, etc.). These notifications serve as a mechanism to inform the frontend—and ultimately the customer—about important contextual feedback during the checkout process.
Where Notifications Appear
Notifications are returned at the top-level of the response JSON object under the property:
{
"notifications": []
}
This array may contain zero or more notification objects, each of which conveys a specific message relevant to the current request or customer state.
Notification Structure
Each notification contains:
Field | Description |
---|---|
id | A unique identifier for the notification instance. |
textTranslationKey | Translation key to be used for localized display. |
type | Severity level: notification , warning , or error |
Example:
{
"id": "e5aee158b584b930c6ec89db69a1560e01ebcf69f76761e5ca330435204cc0aa",
"textTranslationKey": "payment.voucher.notifications.notFound",
"type": "error"
}
Notification Types
notification
– Informational; no action required.warning
– Indicates a possible issue, but not blocking.error
– Indicates a critical issue that may block progress or require immediate attention.
Available notifications
textTranslationKey | Description |
---|---|
address.notifications.invalidAddressSignature | The address signature is invalid. |
address.notifications.addressBookLimitReached | The address book has reached its maximum limit. |
basket.notifications.itemQuantityReduced | The quantity of an item in the basket was reduced. |
basket.notifications.itemBecameUnavailable | An item in the basket became unavailable. |
basket.notifications.newItemQuantityUnavailable | The desired quantity for a new item is not available. |
basket.notifications.itemQuantityLimitReached | The quantity limit for an item has been reached. |
payment.loyaltyProgram.notifications.alreadyAttached | A loyalty card is already attached to the account. |
payment.loyaltyProgram.notifications.customerNotFound | No customer was found for the loyalty program. |
payment.loyaltyProgram.notifications.insufficientBalance | The loyalty account has insufficient balance. |
payment.loyaltyProgram.notifications.redeemedPointsUpdated | Redeemed points have been updated. |
payment.loyaltyProgram.notifications.success | Loyalty card was successfully added. |
payment.loyaltyProgram.notifications.registrationSuccess | Loyalty program registration was successful. |
payment.loyaltyProgram.notifications.removalSuccess | Loyalty program was successfully removed. |
payment.loyaltyProgram.notifications.notAllowedWithValueVoucher | Loyalty program can't be used with a value voucher. |
payment.notifications.%s | A general payment error occurred. |
payment.notifications.riskAssessmentDenied | Payment was denied due to risk assessment. |
payment.promotion.notifications.notFound | The promotion could not be found. |
payment.promotion.notifications.removedDuringPendingTransition | Promotion was removed during a pending transition. |
payment.promotion.notifications.removed | Promotion was removed. |
basket.notifications.promotionTierChanged | The promotion tier was changed. |
payment.promotion.notifications.addSuccess | Promotion was successfully added. |
payment.promotion.notifications.addError | An error occurred while adding the promotion. |
payment.promotion.notifications.addInvalid | An invalid promotion code was added. |
payment.promotion.notifications.removalSuccess | Promotion was successfully removed. |
payment.promotion.notifications.removalError | An error occurred while removing the promotion. |
shipping.notifications.collectionPointUnavailable | The selected collection point is unavailable. |
payment.voucher.notifications.success | Voucher was successfully applied. |
payment.voucher.notifications.successToPromotions | Voucher successfully added to promotions. |
payment.voucher.notifications.notFound | Voucher not found. |
payment.voucher.notifications.oneBrandExcluded | One brand is excluded from the voucher. |
payment.voucher.notifications.multipleBrandsExcluded | Multiple brands are excluded from the voucher. |
payment.voucher.notifications.categoriesExcluded | Certain categories are excluded from the voucher. |
payment.voucher.notifications.categoriesIncluded | Only certain categories are included for the voucher. |
payment.voucher.notifications.merchantsExcluded | Some merchants are excluded from the voucher. |
payment.voucher.notifications.merchantsIncluded | Only specific merchants are included for the voucher. |
payment.voucher.notifications.allItemsExcluded | All items are excluded from the voucher. |
payment.voucher.notifications.someItemsExcluded | Some items are excluded from the voucher. |
payment.voucher.notifications.oneItemExcluded | One item is excluded from the voucher. |
payment.voucher.notifications.multipleItemExcluded | Multiple items are excluded from the voucher. |
payment.voucher.notifications.notValidYet | The voucher is not valid yet. |
payment.voucher.notifications.noLongerValid | The voucher is no longer valid. |
payment.voucher.notifications.oneShopExcluded | One shop is excluded from the voucher. |
payment.voucher.notifications.multipleShopsExcluded | Multiple shops are excluded from the voucher. |
payment.voucher.notifications.oneShopIncluded | One shop is included for the voucher. |
payment.voucher.notifications.multipleShopsIncluded | Multiple shops are included for the voucher. |
payment.voucher.notifications.onlySpecificCustomersIncluded | Voucher is valid only for specific customers. |
payment.voucher.notifications.onlyNewCustomersIncluded | Voucher is valid only for new customers. |
payment.voucher.notifications.onlyReturningCustomersIncluded | Voucher is valid only for returning customers. |
payment.voucher.notifications.onlyDesktopAndMobileIncluded | Voucher is valid only on desktop and mobile devices. |
payment.voucher.notifications.onlyMobileIncluded | Voucher is valid only on mobile devices. |
payment.voucher.notifications.onlyDesktopIncluded | Voucher is valid only on desktop devices. |
payment.voucher.notifications.onlyAppAndMobileIncluded | Voucher is valid only in the app and on mobile devices. |
payment.voucher.notifications.onlyAppIncluded | Voucher is valid only in the app. |
payment.voucher.notifications.onlyAppAndDesktopIncluded | Voucher is valid only in the app and on desktop. |
payment.voucher.notifications.onePaymentTypeExcluded | One payment type is excluded from the voucher. |
payment.voucher.notifications.multiplePaymentTypesExcluded | Multiple payment types are excluded from the voucher. |
payment.voucher.notifications.exceededUsageLimit | Voucher usage limit has been exceeded. |
payment.voucher.notifications.exceededBasketValue | Voucher can't be used due to basket value exceeding the limit. |
payment.voucher.notifications.notEnoughBasketValue | Basket value is too low to use the voucher. |
payment.voucher.notifications.disabled | The voucher is disabled. |
payment.voucher.notifications.valueVoucherNotAllowedWithMembership | Value vouchers can't be used with a membership. |