Brainerce
Help CenterPricingResourcesDashboard
API ReferenceEndpointsOrder bumps

Order bumps

Order bumps are one-click upsells shown at checkout — "Add a gift card?". They appear after the shopper selects payment method but before completing the order. Use these endpoints to manage which products trigger which bumps for which segments.

List checkout bumps

GET
/vc/{connectionId}/checkout/{checkoutId}/bumps

Authorization

X-Sales-Channel-Origin<token>

For /api/vc/{connectionId}/* routes the connectionId (vc_*) is in the URL path — not a header. Live-mode requests must also send a matching Origin header.

In: header

Path Parameters

connectionIdstring
checkoutIdstring

Header Parameters

originstring
curl -X GET "https://api.brainerce.com/api/vc/string/checkout/string/bumps" \  -H "origin: string"
{
  "bumps": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "bumpProduct": {
        "id": "clprd_abc123",
        "name": "string",
        "slug": "string",
        "basePrice": "9.00",
        "salePrice": "string",
        "images": [
          {
            "url": "https://cdn.brainerce.com/products/abc123.jpg",
            "alt": "Blue mug"
          }
        ],
        "type": "SIMPLE",
        "variants": [
          {}
        ]
      },
      "bumpVariantId": "string",
      "requiresVariantSelection": false,
      "lockedVariant": {
        "id": "clvar_abc123",
        "name": "string",
        "attributes": {}
      },
      "originalPrice": "9.00",
      "discountedPrice": "7.20",
      "discountType": "PERCENTAGE",
      "discountValue": "20"
    }
  ]
}

Add order bump

POST
/vc/{connectionId}/cart/{cartId}/bump

Authorization

X-Sales-Channel-Origin<token>

For /api/vc/{connectionId}/* routes the connectionId (vc_*) is in the URL path — not a header. Live-mode requests must also send a matching Origin header.

In: header

Path Parameters

connectionIdstring
cartIdstring

Header Parameters

originstring

Request Body

bumpConfigIdstring

Id of the order-bump configuration being accepted.

curl -X POST "https://api.brainerce.com/api/vc/string/cart/string/bump" \  -H "origin: string" \  -H "Content-Type: application/json" \  -d '{    "bumpConfigId": "string"  }'
{
  "id": "clcrt_abc123",
  "sessionToken": "string",
  "customerId": "string",
  "status": "ACTIVE",
  "currency": "USD",
  "notes": "string",
  "analyticsClientId": "string",
  "analyticsSessionId": "string",
  "subtotal": "39.80",
  "discountAmount": "5.00",
  "ruleDiscountAmount": "0",
  "promoDiscountTotal": "0",
  "couponCode": "WELCOME10",
  "appliedDiscounts": [
    {
      "ruleId": "cldr_abc123",
      "ruleName": "string",
      "type": "PERCENTAGE_OFF",
      "discountAmount": "5.00",
      "description": "string"
    }
  ],
  "nudges": [
    {
      "ruleId": "cldr_abc123",
      "text": "string",
      "type": "AMOUNT_NEEDED",
      "amountNeeded": "12.00",
      "quantityNeeded": 1
    }
  ],
  "items": [
    {
      "productId": "clx1234567890",
      "variantId": "string",
      "quantity": 2
    }
  ],
  "itemCount": 3,
  "hasPriceChanges": false,
  "hasUnavailableItems": false,
  "unavailableItemIds": [],
  "expiresAt": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "reservation": {
    "hasReservation": true,
    "expiresAt": "string",
    "remainingSeconds": 540,
    "strategy": "ON_CART",
    "countdownMessage": "string"
  },
  "recommendations": {},
  "upgrades": {},
  "bundles": {}
}

{
  "statusCode": 400,
  "code": "VALIDATION_FAILED",
  "message": "name should not be empty, price must be a positive number",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/cart/{cartId}/bump"
}

Remove order bump

DELETE
/vc/{connectionId}/cart/{cartId}/bump/{bumpConfigId}

Authorization

X-Sales-Channel-Origin<token>

For /api/vc/{connectionId}/* routes the connectionId (vc_*) is in the URL path — not a header. Live-mode requests must also send a matching Origin header.

In: header

Path Parameters

connectionIdstring
cartIdstring
bumpConfigIdstring

Header Parameters

originstring
curl -X DELETE "https://api.brainerce.com/api/vc/string/cart/string/bump/string" \  -H "origin: string"
{
  "id": "clcrt_abc123",
  "sessionToken": "string",
  "customerId": "string",
  "status": "ACTIVE",
  "currency": "USD",
  "notes": "string",
  "analyticsClientId": "string",
  "analyticsSessionId": "string",
  "subtotal": "39.80",
  "discountAmount": "5.00",
  "ruleDiscountAmount": "0",
  "promoDiscountTotal": "0",
  "couponCode": "WELCOME10",
  "appliedDiscounts": [
    {
      "ruleId": "cldr_abc123",
      "ruleName": "string",
      "type": "PERCENTAGE_OFF",
      "discountAmount": "5.00",
      "description": "string"
    }
  ],
  "nudges": [
    {
      "ruleId": "cldr_abc123",
      "text": "string",
      "type": "AMOUNT_NEEDED",
      "amountNeeded": "12.00",
      "quantityNeeded": 1
    }
  ],
  "items": [
    {
      "productId": "clx1234567890",
      "variantId": "string",
      "quantity": 2
    }
  ],
  "itemCount": 3,
  "hasPriceChanges": false,
  "hasUnavailableItems": false,
  "unavailableItemIds": [],
  "expiresAt": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "reservation": {
    "hasReservation": true,
    "expiresAt": "string",
    "remainingSeconds": 540,
    "strategy": "ON_CART",
    "countdownMessage": "string"
  },
  "recommendations": {},
  "upgrades": {},
  "bundles": {}
}

Bundle offers

Previous Page

Product reviews

Next Page

On this page

No Headings