Custom Bolt Plugin Endpoints
Reference for /V1/bolt/boltpay/... REST endpoints exposed by the Bolt for Adobe Commerce plugin.

The Bolt for Adobe Commerce plugin exposes a small set of REST endpoints under /V1/bolt/boltpay/... (and a handful of third-party-bridge endpoints under /V1/...). These exist for operations that are either not available in standard Magento REST, or require enough round trips that combining them in a single plugin endpoint materially improves checkout latency.

You don’t need to call these endpoints yourself — Bolt’s backend uses them as part of the checkout request flow. They are documented here so merchant engineers can identify them in logs, and so internal teams can reason about what behavior depends on the plugin being installed and up-to-date.

NOTE

Path templates use {cartId}, {maskedQuoteId}, {orderId}, etc. as placeholders. Authentication is the same OAuth Bearer token used for standard Magento REST calls — see Authentication.

Cart & Order

Method Endpoint Purpose
GET /V1/bolt/boltpay/carts/{cartId}/maskedid Resolve a cart ID to its masked quote ID (used as the public guest reference).
GET /V1/bolt/boltpay/carts/{maskedQuoteId}/cartid Reverse lookup: masked quote ID → internal cart ID.
POST /V1/bolt/boltpay/carts/{cartId}/estimate-shipping-and-tax Combined shipping + tax estimate. Saves the round trip required by the standard pair estimate-shipping-methods + shipping-information.
PUT /V1/bolt/boltpay/carts/{cartId} Activate or deactivate a quote (cart). Used during the pending webhook to lock a cart once the order is pending payment.
POST /V1/bolt/boltpay/carts/mine/payment-information Submit a logged-in shopper’s order. Wraps Magento’s carts/mine/payment-information to attach the Bolt payment method and persist transaction metadata in a single round trip. Guest checkouts use the standard /V1/guest-carts/{maskedQuoteId}/payment-information endpoint.
DELETE /V1/bolt/boltpay/orders/{orderId} Roll back a Magento order created via the Bolt flow when payment / fraud / enrichment fails after order persistence. Restricted to plugin-created orders in non-finalized state.
GET /V1/bolt/boltpay/defaultOrderStatuses Read the order-status mapping configured in the plugin admin (Bolt → Magento).
POST /V1/bolt/boltpay/transactions Persist a Bolt transaction reference onto the Magento order (transaction ID, processor metadata).
POST /V1/bolt/boltpay/order/{orderId}/triggerOrderEvents Re-emit plugin-side order events. Used for replay or webhook recovery.
POST /V1/bolt/boltpay/order/{orderId}/invoice Create a partial invoice tied to a Bolt capture.
GET /V1/bolt/boltpay/product/{productId}/image-url Return the configured catalog image URL for a product (used for the Bolt cart preview).

Add-On Bridges

These endpoints exist when the corresponding add-on is installed and configured.

Route (Shipping Protection)

Method Endpoint Purpose
POST /V1/bolt/boltpay/cart/{cartId}/route Toggle Route shipping insurance on the cart.

Third-Party Extensions

Several common third-party Magento extensions ship their own REST endpoints. The Bolt plugin auto-detects them when present and Bolt’s backend routes accordingly.

Amasty Multi-Coupons / Gift Cards

Method Endpoint Purpose
POST /V1/guest-carts/{cartId}/multicoupons/apply-to-cart Apply an Amasty multi-coupon.
GET /V1/carts/{cartId}/multicoupons List applied Amasty multi-coupons.
POST /V1/guest-carts/{cartId}/gift-card/{giftCardCode} Apply an Amasty gift card.
DELETE /V1/guest-carts/{cartId}/gift-card/{giftCardCode} Remove an Amasty gift card.

Aheadworks Gift Cards

Method Endpoint Purpose
POST /V1/carts/{cartId}/aw-giftcard/{giftCardCode} Apply an Aheadworks gift card.
DELETE /V1/carts/{cartId}/aw-giftcard/{giftCardCode} Remove an Aheadworks gift card.
GET /V1/awGiftcard/{giftCardCode} Look up an Aheadworks gift card’s balance / status.

Magento Native Gift Cards (Commerce / EE)

These are stock Magento Commerce endpoints — no plugin required — but Bolt’s backend uses them in the same flow:

Method Endpoint Purpose
POST /V1/carts/{cartId}/giftCards Read applied gift cards.
POST /V1/carts/{cartId}/giftCards/{giftCardCode} Apply a gift card.
DELETE /V1/carts/{cartId}/giftCards/{giftCardCode} Remove a gift card.

Plugin Version Requirements

Custom endpoints follow the plugin’s release cadence. Endpoint availability is tied to the supported plugin versions.

If a custom endpoint returns 404, Bolt falls back to the closest standard Magento REST equivalent where one exists (for example, estimate-shipping-and-tax falls back to estimate-shipping-methods + shipping-information). To restore the optimized path, update the plugin to a current release.

adobe commerce magento 2 api plugin rest