SCscalev
Checkout Intents

Get a contactable checkout intent

Changed on

Requires the checkout_intent:read scope. Returns a contactable intent belonging to the selected business, including captured fields, item snapshots, safe attribution and a recovery URL when available. recovery_url and recovery_url_expires_at are null for completed intents or a missing or untrusted source URL. Recovery URLs are customer capabilities; protect them as customer data.

get/v3/checkout-intents/{checkout_intent_id}

Request

  • Base URL
    https://api.scalev.com
  • URL
    https://api.scalev.com/v3/checkout-intents/{checkout_intent_id}
  • Auth
    • HTTP bearer
    • or API key in header authorization
    • or OAuth 2
      Authorization code: https://api.scalev.com/v3/oauth/authorize
      Token URL: https://api.scalev.com/v3/oauth/token scopes: checkout_intent:read

Response

Contactable checkout intent.

idstring uuid required
form_widget_idstring required
status'active' | 'abandoned' | 'completed' required
contactableboolean required
is_email_follow_up_already_sendedboolean required
source_urlstring nullable required
started_atstring date-time required
last_activity_atstring date-time required
follow_up_eligible_atstring date-time nullable required
completed_atstring date-time nullable required
recovery_urlstring uri nullable required

Trusted checkout source URL with a cip_ prefill token. Null when completed or no trusted source is available.

recovery_url_expires_atstring date-time nullable required

Changes