docs

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:

FieldDescription
idA unique identifier for the notification instance.
textTranslationKeyTranslation key to be used for localized display.
typeSeverity 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

textTranslationKeyDescription
address.notifications.invalidAddressSignatureThe address signature is invalid.
address.notifications.addressBookLimitReachedThe address book has reached its maximum limit.
basket.notifications.itemQuantityReducedThe quantity of an item in the basket was reduced.
basket.notifications.itemBecameUnavailableAn item in the basket became unavailable.
basket.notifications.newItemQuantityUnavailableThe desired quantity for a new item is not available.
basket.notifications.itemQuantityLimitReachedThe quantity limit for an item has been reached.
payment.loyaltyProgram.notifications.alreadyAttachedA loyalty card is already attached to the account.
payment.loyaltyProgram.notifications.customerNotFoundNo customer was found for the loyalty program.
payment.loyaltyProgram.notifications.insufficientBalanceThe loyalty account has insufficient balance.
payment.loyaltyProgram.notifications.redeemedPointsUpdatedRedeemed points have been updated.
payment.loyaltyProgram.notifications.successLoyalty card was successfully added.
payment.loyaltyProgram.notifications.registrationSuccessLoyalty program registration was successful.
payment.loyaltyProgram.notifications.removalSuccessLoyalty program was successfully removed.
payment.loyaltyProgram.notifications.notAllowedWithValueVoucherLoyalty program can't be used with a value voucher.
payment.notifications.%sA general payment error occurred.
payment.notifications.riskAssessmentDeniedPayment was denied due to risk assessment.
payment.promotion.notifications.notFoundThe promotion could not be found.
payment.promotion.notifications.removedDuringPendingTransitionPromotion was removed during a pending transition.
payment.promotion.notifications.removedPromotion was removed.
basket.notifications.promotionTierChangedThe promotion tier was changed.
payment.promotion.notifications.addSuccessPromotion was successfully added.
payment.promotion.notifications.addErrorAn error occurred while adding the promotion.
payment.promotion.notifications.addInvalidAn invalid promotion code was added.
payment.promotion.notifications.removalSuccessPromotion was successfully removed.
payment.promotion.notifications.removalErrorAn error occurred while removing the promotion.
shipping.notifications.collectionPointUnavailableThe selected collection point is unavailable.
payment.voucher.notifications.successVoucher was successfully applied.
payment.voucher.notifications.successToPromotionsVoucher successfully added to promotions.
payment.voucher.notifications.notFoundVoucher not found.
payment.voucher.notifications.oneBrandExcludedOne brand is excluded from the voucher.
payment.voucher.notifications.multipleBrandsExcludedMultiple brands are excluded from the voucher.
payment.voucher.notifications.categoriesExcludedCertain categories are excluded from the voucher.
payment.voucher.notifications.categoriesIncludedOnly certain categories are included for the voucher.
payment.voucher.notifications.merchantsExcludedSome merchants are excluded from the voucher.
payment.voucher.notifications.merchantsIncludedOnly specific merchants are included for the voucher.
payment.voucher.notifications.allItemsExcludedAll items are excluded from the voucher.
payment.voucher.notifications.someItemsExcludedSome items are excluded from the voucher.
payment.voucher.notifications.oneItemExcludedOne item is excluded from the voucher.
payment.voucher.notifications.multipleItemExcludedMultiple items are excluded from the voucher.
payment.voucher.notifications.notValidYetThe voucher is not valid yet.
payment.voucher.notifications.noLongerValidThe voucher is no longer valid.
payment.voucher.notifications.oneShopExcludedOne shop is excluded from the voucher.
payment.voucher.notifications.multipleShopsExcludedMultiple shops are excluded from the voucher.
payment.voucher.notifications.oneShopIncludedOne shop is included for the voucher.
payment.voucher.notifications.multipleShopsIncludedMultiple shops are included for the voucher.
payment.voucher.notifications.onlySpecificCustomersIncludedVoucher is valid only for specific customers.
payment.voucher.notifications.onlyNewCustomersIncludedVoucher is valid only for new customers.
payment.voucher.notifications.onlyReturningCustomersIncludedVoucher is valid only for returning customers.
payment.voucher.notifications.onlyDesktopAndMobileIncludedVoucher is valid only on desktop and mobile devices.
payment.voucher.notifications.onlyMobileIncludedVoucher is valid only on mobile devices.
payment.voucher.notifications.onlyDesktopIncludedVoucher is valid only on desktop devices.
payment.voucher.notifications.onlyAppAndMobileIncludedVoucher is valid only in the app and on mobile devices.
payment.voucher.notifications.onlyAppIncludedVoucher is valid only in the app.
payment.voucher.notifications.onlyAppAndDesktopIncludedVoucher is valid only in the app and on desktop.
payment.voucher.notifications.onePaymentTypeExcludedOne payment type is excluded from the voucher.
payment.voucher.notifications.multiplePaymentTypesExcludedMultiple payment types are excluded from the voucher.
payment.voucher.notifications.exceededUsageLimitVoucher usage limit has been exceeded.
payment.voucher.notifications.exceededBasketValueVoucher can't be used due to basket value exceeding the limit.
payment.voucher.notifications.notEnoughBasketValueBasket value is too low to use the voucher.
payment.voucher.notifications.disabledThe voucher is disabled.
payment.voucher.notifications.valueVoucherNotAllowedWithMembershipValue vouchers can't be used with a membership.