SCscalev
Checkout Intents

List contactable checkout intents

Changed on

Requires the checkout_intent:list scope. Returns only intents with a valid normalized email or phone for the selected business. Use status=abandoned for recovery work. Active means activity within 15 minutes; abandoned means unfinished and idle at least 15 minutes; completed means an order was created. Resumed intents can become active again. Uses cursor pagination ordered by the selected timestamp and intent ID.

get/v3/checkout-intents

Request

  • Base URL
    https://api.scalev.com
  • URL
    https://api.scalev.com/v3/checkout-intents
  • 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:list

Query parameters

status'active' | 'abandoned' | 'completed'

Omit to include all contactable statuses.

searchstring

Search customer name, email, or normalized phone.

store_unique_idstring

Optional capture-source filter within the selected business.

page_unique_idstring

Optional capture-source filter within the selected business.

form_widget_idstring

Optional capture-source filter within the selected business.

started_at_fromstring date-time

Inclusive start timestamp.

started_at_untilstring date-time

Exclusive end timestamp.

sort_by'last_activity_at' | 'started_at' | 'completed_at'

Timestamp used for cursor ordering. completed_at falls back to started_at for unfinished intents. Keep sort_by and sort_direction unchanged while paging.

sort_direction'asc' | 'desc'

Sort direction.

page_sizeinteger

Maximum number of rows.

next_cursorstring

Opaque cursor for the next page.

previous_cursorstring

Opaque cursor for the previous page.

Response

Contactable checkout intents.

is_paginatedtrue required
has_nextboolean required
has_previousboolean required
next_cursorstring nullable required
previous_cursorstring nullable required
page_sizeinteger required

Changes