> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List checkout experiences

> List the store's checkout experiences with a summary of each one's shipping
methods. For prices, carriers, conditions, and fulfillment delays, get the
experience by ID.

`active` tells you whether an experience is reachable in the store's live
checkout tree, which decides which shoppers see which experience.

Requires the [`checkout_read`](/docs/api-reference/scopes) scope.




## OpenAPI

````yaml /api-schema/openapi.yaml get /stores/{storeId}/checkout-experiences
openapi: 3.1.0
info:
  contact:
    email: engineering-admin@getredo.com
    name: Redo Engineering
  description: |
    ## Endpoints

    Endpoints are authenticated using the Bearer authorization scheme, using the
    REDO_API_SECRET.

    ```txt
    GET /v2.2/resource HTTP/1.1
    Authorization: Bearer 77bb7598b7a972475cc7c7e171ec33af
    Host: api.getredo.com
    ```

    ## Webhooks

    Webhooks are authenticated using the Bearer authorization scheme, using
    a secret supplied by the subscriber.

    ```txt
    POST /events HTTP/1.1
    Authorization: Bearer subscriberauth123
    Host: subscriber.example.com
    ```

    Webhook events are delivered in order for each individual subject (e.g.
    return).

    If the response is not a 2xx status code, the event will be retried multiple
    times before discarding it.
  title: Redo API
  version: 2.2.1
servers:
  - url: https://api.getredo.com/v2.2
security: []
tags:
  - description: >-
      Group several products under one product shoppers buy, so a returned
      bundle can be broken back into the products it contains.
    name: Bundles
  - name: Checkout Buttons
  - description: >-
      Manage the shipping methods shown at checkout. A checkout experience is a
      named group of shipping methods; the store's checkout tree decides which
      shoppers see which experience.
    name: Checkout Experiences
  - name: Coverage Info
  - name: Coverage Products
  - name: Custom Events
  - name: Customer Portal
  - name: Customer Subscriptions
  - name: Customers
  - name: Inbound Shipments
  - name: Inventory Items
  - name: Inventory Levels
  - name: Invoices
  - name: Merchant Admin
  - name: Orders
  - name: Products
  - name: Returns
  - description: >-
      Push orders into Redo from a commerce platform Redo does not support
      directly, so shoppers can return them.
    name: Returns Custom Integration
  - name: Storefront
  - name: Webhooks
paths:
  /stores/{storeId}/checkout-experiences:
    summary: Checkout Experiences
    parameters:
      - $ref: '#/components/parameters/store-id.param'
    get:
      tags:
        - Checkout Experiences
      summary: List checkout experiences
      description: >
        List the store's checkout experiences with a summary of each one's
        shipping

        methods. For prices, carriers, conditions, and fulfillment delays, get
        the

        experience by ID.


        `active` tells you whether an experience is reachable in the store's
        live

        checkout tree, which decides which shoppers see which experience.


        Requires the [`checkout_read`](/docs/api-reference/scopes) scope.
      operationId: Checkout experiences list
      parameters:
        - $ref: '#/components/parameters/checkout-experience-active.param'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkout-experience-list-response.schema'
              examples:
                experiences:
                  summary: A live experience and a draft
                  value:
                    checkoutExperiences:
                      - id: 66b2f1c9e4b0a1d2c3f4a5b6
                        name: Standard rates
                        active: true
                        createdAt: '2026-08-12T15:04:05.000Z'
                        methods:
                          - id: 66b2f1c9e4b0a1d2c3f4a5c7
                            name: Standard
                            description: 5-8 business days
                            priceDisplay: $5.99
                          - id: 66b2f1c9e4b0a1d2c3f4a5c8
                            name: Ground
                            description: Quoted live
                            priceDisplay: DYNAMIC
                      - id: 66b2f1c9e4b0a1d2c3f4a5d1
                        name: Holiday rates
                        active: false
                        createdAt: '2026-09-01T09:30:00.000Z'
                        methods: []
                    totalCount: 2
          description: Success
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/error.schema'
          description: Error
      security:
        - Bearer: []
components:
  parameters:
    store-id.param:
      description: Store ID
      in: path
      name: storeId
      required: true
      schema:
        example: 64e5a8a1af49a89df37e4ee7
        type: string
    checkout-experience-active.param:
      description: >-
        `true` returns only experiences reachable in the store's live checkout
        tree, `false` only those that are not. Omit to return both.
      in: query
      name: active
      required: false
      schema:
        enum:
          - 'true'
          - 'false'
        type: string
  schemas:
    checkout-experience-list-response.schema:
      properties:
        checkoutExperiences:
          description: >-
            The team's checkout experiences matching the filter. An experience
            that is not active is fully configured but unreachable — no shopper
            can currently be served it.
          items:
            $ref: '#/components/schemas/checkout-experience-summary.schema'
          type: array
        totalCount:
          description: Number of checkout experiences returned.
          example: 2
          maximum: 9007199254740991
          minimum: -9007199254740991
          type: integer
      required:
        - checkoutExperiences
        - totalCount
      title: Checkout experience list
      type: object
    error.schema:
      description: >-
        Problem details. See [RFC 7807 Section
        3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).
      properties:
        detail:
          description: Human-readable description of the problem.
          title: Detail
          type: string
        instance:
          description: A URI reference that identifies this problem.
          format: uri-reference
          type: string
        title:
          description: Human-readable summary of the problem type.
          title: Title
          type: string
        type:
          default: about:blank
          description: A URI reference that identifies the problem type.
          format: uri-reference
          type: string
      title: Problem details
      type: object
    checkout-experience-summary.schema:
      description: >-
        A checkout experience: a named group of shipping methods shown together
        at checkout. It does not decide who sees it — the checkout tree does. An
        experience can also group checkout widgets and a post-purchase upsell
        page; this summary covers only its shipping methods.
      properties:
        id:
          description: >-
            Checkout experience ID. Pass it to `GET
            /stores/{storeId}/checkout-experiences/{checkoutExperienceId}` for
            full detail.
          example: 66b2f1c9e4b0a1d2c3f4a5b6
          type: string
        name:
          description: Merchant-facing name of the checkout experience.
          example: Standard rates
          type: string
        active:
          description: >-
            True when this experience is reachable in the team's live checkout
            tree, i.e. real shoppers can be served it.
          example: true
          type: boolean
        createdAt:
          description: Creation timestamp, ISO 8601 UTC.
          example: '2026-08-12T15:04:05.000Z'
          type: string
        methods:
          description: >-
            Shipping methods this experience offers. Summary only: call `GET
            /stores/{storeId}/checkout-experiences/{checkoutExperienceId}` for
            prices, carriers, conditions, constraints, and which methods are
            auto-selected.
          items:
            properties:
              id:
                description: Shipping method ID, unique within the team.
                example: 66b2f1c9e4b0a1d2c3f4a5c7
                type: string
              name:
                description: >-
                  Shopper-facing name of the shipping method as it appears at
                  checkout, e.g. 'Standard'.
                example: Standard
                type: string
              description:
                description: Shopper-facing description shown next to the method.
                example: 5-8 business days
                type: string
              priceDisplay:
                description: >-
                  Human-readable price for this method: 'FREE', a formatted
                  amount like '$5.99', 'DYNAMIC' for carrier-calculated rates,
                  'CUSTOM' for merchant-scripted rates, or '-' when no price is
                  configured. Reflects only the FIRST configured price, so a
                  method that prices by cart weight or cart value, or that has a
                  free-shipping threshold, may read 'FREE' while most carts are
                  charged something else. Call `GET
                  /stores/{storeId}/checkout-experiences/{checkoutExperienceId}`
                  for every price and the conditions each applies to.
                example: $5.99
                type: string
            required:
              - id
              - name
              - description
              - priceDisplay
            type: object
          type: array
      required:
        - id
        - name
        - active
        - createdAt
        - methods
      title: Checkout experience summary
      type: object
  securitySchemes:
    Bearer:
      scheme: bearer
      type: http

````