---
title: "Read checkout recovery prefill"
method: GET
path: "/v3/checkout-intents/prefill"
tags: ["Checkout Intents"]
---

# Read checkout recovery prefill

`GET /v3/checkout-intents/prefill`

## Request

- Base URL: `https://api.scalev.com`
- URL: `https://api.scalev.com/v3/checkout-intents/prefill`
- Auth: none required

Public capability endpoint. Pass the cip_ token from a recovery URL. The token lasts 30 days from issuance and only reads prefill; it cannot update an intent. The response keeps saved item references and adds current catalog display and availability data. Deleted or unavailable items remain in the response with is_available false. Do not send this token to analytics or logs.

## Query parameters

- `checkout_intent_prefill_token` string, required

## Response `200`

Safe form prefill and saved checkout items.

- CheckoutIntentPrefillResponse
  - `data` object, required
    - `name` string, nullable, required
    - `email` string, nullable, required
    - `phone` string, nullable, required
    - `fullPhoneNumber` string, nullable, required
    - `address` string, nullable, required
    - `province` string, nullable, required
    - `city` string, nullable, required
    - `subdistrict` string, nullable, required
    - `postalCodeSelected` string, nullable, required
    - `payment_method` string, nullable, required
    - `sub_payment_method` string, nullable, required
    - `notes` string, nullable, required
    - `discountCode` string, nullable, required
    - `destination_subdistrict_id` integer, nullable, required
    - `checkout_intent` object, required
      - `id` string, uuid, required
      - `fields` CheckoutIntentFields, required
        - `selected_order_bump_keys` string[]: Optional Builder offer selection metadata for recovery. Items still include the selected offer quantities. An empty array means no offers were selected. These keys do not authorize products or determine prices.
        - `customer_name` string, nullable
        - `customer_email` string, nullable
        - `customer_phone` string, nullable
        - `shipping_address` string, nullable
        - `shipping_province` string, nullable
        - `shipping_city` string, nullable
        - `shipping_subdistrict` string, nullable
        - `shipping_postal_code` string, nullable
        - `payment_method` string, nullable
        - `sub_payment_method` string, nullable
        - `notes` string, nullable
        - `discount_code_code` string, nullable
        - `shipping_location_id` integer, nullable
        - `custom_fields` object[]
          - `key` string, required
          - `label` string, required
          - `value` union
            - string, nullable
            - number
            - boolean
      - `items` CheckoutIntentPrefillItem[], required
        - `type` 'variant' | 'bundle_price_option', required
        - `variant_id` integer
        - `bundle_price_option_id` integer
        - `quantity` integer, required
        - `name` string, nullable
        - `unit_price` string
        - `line_total` string
        - `currency` string
        - `variant_unique_id` string, nullable
        - `product_name` string, nullable
        - `variant_name` string, nullable
        - `bundle_price_option_unique_id` string, nullable
        - `bundle_name` string, nullable
        - `bundle_price_option_name` string, nullable
        - `image` string, nullable
        - `images` string[]
        - `display_images` string[]
        - `item_type` string, nullable
        - `weight` number, nullable
        - `weight_bump` number, nullable
        - `available_qty` number, nullable
        - `available` boolean, required
        - `is_available` boolean, required
        - `unavailable_reason` 'deleted' | 'disabled' | 'out_of_stock' | 'null', nullable, required
        - `bundlelines` object[]

## Other responses

- `401`: Missing, invalid, or expired prefill token.
- `403`: Checkout intent is not included in the active business subscription, or authorization failed.
- `404`: Checkout intent or source was not found in this scope.
- `429`: Too Many Requests. Storefront public requests using `X-Scalev-Storefront-Api-Key` or `X-Scalev-Guest-Token` are rate-limited as direct client/browser requests. Machine-authenticated business requests are rate-limited per API key or OAuth installation. Rate-limit responses may be plain text instead of the normal JSON error shape.

## Changes

- **2026-10-02** `a14339bcc086`: 1 info
  - added the optional property `data/checkout_intent/fields/selected_order_bump_keys` to the response with the `200` status
- **2026-09-16** `40f39d0fda73`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/scalev/apis/nexus-commerce-api/changes/v3/checkout-intents/prefill/get.md)

---

[API](https://skmtc.dev/scalev/apis/nexus-commerce-api.md) - [All operations](https://skmtc.dev/scalev/apis/nexus-commerce-api/llms.txt) - [OpenAPI document](https://skmtc.dev/scalev/apis/nexus-commerce-api/revisions/6b9152f04622?raw)
