Brainerce
Help CenterPricingResourcesDashboard
API ReferenceEndpointsCartRecover cart from email link

Recover cart from email link

Trades the one-time code carried in the URL fragment of an abandoned-cart email link (#brainerce_recover=<code>) for the guest cart, including its sessionToken. The code is single use and valid for 10 minutes. Repeating the same code with the same attemptId within 120 seconds returns the same cart, so a response lost on the network can be retried. Every other failure (unknown, expired, already used by a different attempt, another store) returns the same 404.

POST
/vc/{connectionId}/cart/recover

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

Sales channel ID (vc_*), the canonical salesChannelId. connectionId is the deprecated name of the same value and is still the literal path segment.

Header Parameters

originstring

Origin of the storefront page making the call, for example https://shop.example.com. Required: a request with no Origin header is refused with 403. On a LIVE channel its host must equal the channel's registered domain (or one of its subdomains) or match an allowed origin. A TEST channel with no domain accepts any origin; once a domain is set it is matched as on LIVE.

X-SDK-Version?string

Version of the calling SDK (the Brainerce SDK sends it automatically). Informational: it is recorded on the channel and never changes the response.

Request Body

codestring

The one-time recovery code from the abandoned-cart email link, read from the URL fragment #brainerce_recover=<code> the storefront was redirected to. Single use, valid for 10 minutes.

Match^[A-Za-z0-9_-]+$
Lengthlength <= 128
attemptIdstring

A random id the client generates once per recovery and REUSES when it retries. A repeat of the same code with the same attemptId within 120 seconds returns the same cart again, so a response lost on the network can be retried; any other repeat of a used code is a 404.

Match^[A-Za-z0-9_-]{8,64}$
Length8 <= length <= 64
curl -X POST "https://api.brainerce.com/api/vc/string/cart/recover" \  -H "origin: string" \  -H "X-SDK-Version: string" \  -H "Content-Type: application/json" \  -d '{    "code": "q3F0y3mJ0b1Y2X9sC7uZpA4kT6vNwR8dE5hLgBxMiQo",    "attemptId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"  }'
{
  "id": "clcrt_abc123",
  "sessionToken": "string",
  "customerId": "clcustomer_abc123",
  "status": "ACTIVE",
  "currency": "USD",
  "notes": "string",
  "analyticsClientId": "clanalyticsclient_abc123",
  "analyticsSessionId": "clanalyticssession_abc123",
  "subtotal": "39.80",
  "discountAmount": "5.00",
  "ruleDiscountAmount": "0",
  "promoDiscountTotal": "0",
  "couponCode": "WELCOME10",
  "appliedDiscounts": [
    {
      "ruleId": "cldr_abc123",
      "ruleName": "string",
      "type": "PRODUCT_DISCOUNT",
      "discountAmount": "5.00",
      "description": "string"
    }
  ],
  "nudges": [
    {
      "ruleId": "cldr_abc123",
      "text": "string",
      "type": "AMOUNT_NEEDED",
      "amountNeeded": "12.00",
      "quantityNeeded": 1
    }
  ],
  "items": [
    {
      "id": "clx1234567890",
      "productId": "clprd_abc123",
      "variantId": "clvariant_abc123",
      "quantity": 2,
      "unitPrice": "19.90",
      "currentUnitPrice": "21.90",
      "priceChanged": true,
      "priceDelta": "2.00",
      "priceDirection": "increased",
      "isAvailable": true,
      "unavailableReason": null,
      "discountAmount": "0",
      "promoDiscountAmount": "0",
      "promoSource": "BUNDLE",
      "promoSourceId": "clpromosource_abc123",
      "notes": "string",
      "metadata": {},
      "customizations": {},
      "product": {
        "id": "clprd_abc123",
        "name": "string",
        "sku": "MUG-BLU",
        "images": [
          {
            "url": "https://cdn.brainerce.com/products/abc123.jpg",
            "alt": "Blue mug"
          }
        ]
      },
      "variant": {
        "id": "clvar_abc123",
        "name": "string",
        "sku": "MUG-BLU-L",
        "image": {
          "url": "https://cdn.brainerce.com/products/abc123.jpg",
          "alt": "Blue mug"
        }
      },
      "modifiers": [
        {
          "modifierId": "clmod_abc123",
          "modifierGroupId": "clmgr_abc123",
          "name": "string",
          "priceDelta": "1.50",
          "freeApplied": false,
          "effectivePrice": "1.50",
          "positionInGroup": 0
        }
      ],
      "modifiersTotal": "1.50",
      "parentCartItemId": "clparentcartitem_abc123",
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-01-15T10:30:00.000Z"
    }
  ],
  "itemCount": 3,
  "hasPriceChanges": false,
  "hasUnavailableItems": false,
  "unavailableItemIds": [],
  "expiresAt": "2026-01-15T10:30:00.000Z",
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-15T10:30:00.000Z",
  "reservation": {
    "hasReservation": true,
    "expiresAt": "2026-01-15T10:30:00.000Z",
    "remainingSeconds": 540,
    "strategy": "ON_CART",
    "countdownMessage": "string"
  },
  "recommendations": {
    "recommendations": [
      {
        "id": "clprd_abc123",
        "name": "string",
        "slug": "blue-mug",
        "basePrice": "24.00",
        "salePrice": "19.99",
        "images": [
          {
            "url": "https://cdn.brainerce.com/products/abc123.jpg",
            "alt": "Blue mug"
          }
        ],
        "type": "SIMPLE",
        "inventory": {
          "total": 42,
          "available": 39,
          "trackingMode": "TRACKED",
          "inStock": true,
          "canPurchase": true
        },
        "targetVariantId": null,
        "requiresVariantSelection": false,
        "pinnedVariant": {
          "id": "clvar_abc123",
          "name": "string",
          "attributes": {}
        },
        "variants": [
          {
            "id": "clvar_abc123",
            "name": "string",
            "attributes": {},
            "image": {
              "url": "https://cdn.brainerce.com/products/abc123.jpg",
              "alt": "Blue mug"
            },
            "price": "24.00",
            "salePrice": null
          }
        ],
        "relationType": "CROSS_SELL"
      }
    ]
  },
  "upgrades": {
    "upgrades": {}
  },
  "bundles": {
    "bundles": [
      {
        "id": "clx1234567890",
        "name": "string",
        "description": "string",
        "triggerProductId": "cltriggerproduct_abc123",
        "productIds": [
          "string"
        ],
        "offeredProducts": [
          {
            "id": "clprd_abc123",
            "name": "string",
            "slug": "blue-mug",
            "basePrice": "30.00",
            "salePrice": "19.99",
            "images": [
              {
                "url": "https://cdn.brainerce.com/products/abc123.jpg",
                "alt": "Blue mug"
              }
            ],
            "type": "SIMPLE",
            "variantId": "clvariant_abc123",
            "requiresVariantSelection": false,
            "pinnedVariant": {
              "id": "clvar_abc123",
              "name": "string",
              "attributes": {}
            },
            "variants": [
              {
                "id": "clvar_abc123",
                "name": "string",
                "attributes": {},
                "image": {
                  "url": "https://cdn.brainerce.com/products/abc123.jpg",
                  "alt": "Blue mug"
                },
                "price": "24.00",
                "salePrice": null
              }
            ],
            "originalPrice": "30.00",
            "discountedPrice": "24.00"
          }
        ],
        "discountType": "PERCENTAGE",
        "discountValue": "20",
        "totalOriginalPrice": "30.00",
        "totalDiscountedPrice": "24.00"
      }
    ]
  }
}

{
  "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/recover"
}

{
  "statusCode": 403,
  "code": "INSUFFICIENT_SCOPE",
  "message": "API key does not have the required scope: products:write",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/cart/recover"
}

{
  "statusCode": 404,
  "code": "RESOURCE_NOT_FOUND",
  "message": "Resource not found",
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/cart/recover"
}

{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "message": "Too many requests",
  "details": {
    "retryAfterSeconds": 12
  },
  "timestamp": "2026-08-23T10:15:00.000Z",
  "path": "/api/vc/{connectionId}/cart/recover"
}

Cart

Brainerce API reference: every cart operation, with its method, path and a page of its own.

Create cart

Creates an empty cart.