SCscalev
Storefront

Start or resume a storefront checkout intent

Changed on

The path store unique ID and Storefront API key define the capture scope. Use a stable form_widget_id chosen by your storefront. Requires a reCAPTCHA token for action checkout_intent_start. Repeating client_session_id resumes the unfinished attempt without replacing saved snapshots; PATCH with last_sequence + 1 to save new input. A completed session returns 409; create a new client_session_id after checkout succeeds. A valid optional cip_ prefill token resumes its matching unfinished attempt; invalid or mismatched prefill tokens fall back to the client session. Capture failures must not block checkout.

post/v3/stores/{store_id}/public/checkout-intents

Request

  • Base URL
    https://api.scalev.com
  • URL
    https://api.scalev.com/v3/stores/{store_id}/public/checkout-intents
  • Auth
    none required

Request body

recaptcha_tokenstring required

reCAPTCHA token for action checkout_intent_start.

client_session_idstring uuid required

Browser-persistent random UUID scoped to the page or storefront checkout; not a guest-cart token.

checkout_intent_prefill_tokenstring

Optional cip_ recovery capability. Invalid or mismatched tokens fall back to client_session_id.

form_widget_idstring required

Stable identifier chosen by the storefront, for example storefront-checkout.

source_urlstring uri nullable

Current checkout URL. Sensitive query parameters and fragments are stripped. Recovery links are only issued for trusted source origins.

cart_idinteger nullable

Response

New or resumed checkout intent and write capability.

idstring uuid required
form_widget_idstring required
checkout_intent_tokenstring required

Write capability valid for 24 hours. Start/resume refreshes the window for an unfinished intent. Never include it in URLs or analytics.

status'active' | 'abandoned' | 'completed' required
last_sequenceinteger required
started_atstring date-time required
last_activity_atstring date-time required
expires_atstring date-time required

Changes