For the complete documentation index, see llms.txt. This page is also available as Markdown.

Gift Cards, Gift Boxes & Loyalty

Checkout Gift Cards, Gift Boxes & Loyalty

Apply supplementary payment methods and gifting options that adjust the order total or add items to the order.

Gift Cards let customers apply a pre-loaded card balance to their order. The flow supports OTP verification, multi-card application (when configured), amount adjustment, and removal.

Gift Boxes let customers add gift packaging to their order.

Loyalty Points let customers redeem accumulated points as a payment contribution.

Rewards present available reward options that the customer can apply to the order.

Authentication

These endpoints support both authenticated and anonymous sessions.

  • Authenticated users: Session cookie (sessionid) tracks checkout progress.

  • Anonymous users: Guest checkout is available when the CAN_GUEST_PURCHASE setting is enabled.

Request Format

Include the following header in all checkout requests:

  • x-requested-with: XMLHttpRequest

Dynamic Settings

GIFT_CARD_CONFIG

Configuration for the gift card feature:

  • multi_card_enabled — allows more than one gift card per order when enabled.

  • max_amount_per_order — maximum cumulative gift card amount per order (zero means no cap).

  • balance_cache_ttl — duration in seconds that a fetched card balance is cached.

  • otp_resend_cooldown — minimum interval in seconds between OTP resend requests.

  • void_task_countdown — delay in seconds before unused reservations are voided.

LOYALTY_MONEY_ENABLED

Master switch for the loyalty money payment feature. When disabled, the loyalty money step is not shown.

MINIMUM_ORDER_AMOUNT

Minimum order total required after loyalty points are applied. Redemption is capped so the remaining amount does not fall below this threshold.

CUSTOMER_LOYALTY_CARD_SERVICE

Configures the service used to retrieve loyalty point balances and the optional minimum basket amount required before redemption is available.

Last updated

Was this helpful?