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

# Read persisted hosted checkout state without payment reconciliation



## OpenAPI

````yaml /generated/storefront.openapi.json get /locations/{locationId}/carts/{cartId}/checkout-result
openapi: 3.0.3
info:
  title: Crave Storefront API
  version: 2.0.0
  description: >-
    Direct public Storefront API. Anonymous catalog reads require no API key.
    Protected resources use purpose-limited cart, checkout, receipt, or customer
    credentials.
  contact:
    name: Crave Support
    email: hello@craveup.com
servers:
  - url: https://api.craveup.com/api/v1/storefront
    description: Production Storefront API
  - url: https://sandbox-api.craveup.com/api/v1/storefront
    description: Sandbox Storefront API
security: []
tags:
  - name: Customer Auth
  - name: Catering
  - name: Loyalty
  - name: Merchants
  - name: Locations
  - name: Ordering Sessions
  - name: Menus
  - name: Products
  - name: Carts
  - name: Analytics
  - name: Checkout
  - name: Cart Items
  - name: Discounts
  - name: Customers
  - name: Orders
paths:
  /locations/{locationId}/carts/{cartId}/checkout-result:
    get:
      tags:
        - Checkout
      summary: Read persisted hosted checkout state without payment reconciliation
      operationId: storefrontObserveCheckoutResult
      parameters:
        - name: locationId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 128
        - name: cartId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 128
      responses:
        '200':
          description: >-
            Terminal submission permission is separate from payment settlement.
            Missing/expired authority is unknown, never cancellation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutResult'
        '400':
          description: The request is invalid.
          headers:
            X-Request-Id:
              description: Opaque request identifier for support and telemetry correlation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceErrorEnvelope'
        '401':
          description: Authentication or capability authorization is required.
          headers:
            X-Request-Id:
              description: Opaque request identifier for support and telemetry correlation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceErrorEnvelope'
        '403':
          description: The authenticated principal does not own this resource.
          headers:
            X-Request-Id:
              description: Opaque request identifier for support and telemetry correlation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceErrorEnvelope'
        '404':
          description: The requested resource was not found.
          headers:
            X-Request-Id:
              description: Opaque request identifier for support and telemetry correlation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceErrorEnvelope'
        '429':
          description: The request was rate limited.
          headers:
            X-Request-Id:
              description: Opaque request identifier for support and telemetry correlation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceErrorEnvelope'
        '500':
          description: An unexpected error occurred.
          headers:
            X-Request-Id:
              description: Opaque request identifier for support and telemetry correlation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceErrorEnvelope'
        '503':
          description: A required dependency is temporarily unavailable.
          headers:
            X-Request-Id:
              description: Opaque request identifier for support and telemetry correlation.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommerceErrorEnvelope'
      security:
        - StorefrontCheckoutResult: []
components:
  schemas:
    CheckoutResult:
      oneOf:
        - type: object
          properties:
            state:
              type: string
              enum:
                - NO_SUBMISSION
            cleanupAllowed:
              type: boolean
              enum:
                - false
          required:
            - state
            - cleanupAllowed
          additionalProperties: false
        - type: object
          properties:
            state:
              type: string
              enum:
                - PENDING
            cleanupAllowed:
              type: boolean
              enum:
                - false
            submission:
              type: object
              properties:
                attemptId:
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                cartId:
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                cartRevision:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                collectionMode:
                  type: string
                  enum:
                    - ONLINE
                    - PAY_AT_STORE
                lifecycle:
                  type: string
                  enum:
                    - SUBMITTING
                    - ACCEPTED
                    - IN_PREPARATION
                    - READY
                    - COMPLETED
                    - REJECTED
                    - CANCELED
                nextAction:
                  type: string
                  enum:
                    - NONE
                    - AWAIT_PAYMENT
                    - COMPLETE_CUSTOMER_PAYMENT
                    - AWAIT_TENDER_VERIFICATION
                    - RESOLVE_FAILURE
                orderId:
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                reconciliationState:
                  type: string
                  enum:
                    - CURRENT
                    - RECONCILING
                    - ACTION_REQUIRED
                settlementAdapter:
                  type: string
                  enum:
                    - STRIPE
                    - SQUARE
                    - CLOVER
                    - TOAST
                settlementState:
                  type: string
                  enum:
                    - NO_PAYMENT_REQUIRED
                    - DUE
                    - PARTIALLY_PAID
                    - PAID
                    - PARTIALLY_REFUNDED
                    - REFUNDED
                    - CANCELED
                submissionState:
                  type: string
                  enum:
                    - PREPARING
                    - ORDER_CREATED
                    - AWAITING_CUSTOMER_ACTION
                    - SUBMITTING
                    - SUCCEEDED
                    - FAILED
                    - EXPIRED
                    - ACTION_REQUIRED
              required:
                - attemptId
                - cartId
                - cartRevision
                - collectionMode
                - lifecycle
                - nextAction
                - orderId
                - reconciliationState
                - settlementAdapter
                - settlementState
                - submissionState
              additionalProperties: false
          required:
            - state
            - cleanupAllowed
            - submission
          additionalProperties: false
        - type: object
          properties:
            state:
              type: string
              enum:
                - TERMINAL
            cleanupAllowed:
              type: boolean
              enum:
                - true
            submission:
              type: object
              properties:
                attemptId:
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                cartId:
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                cartRevision:
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
                collectionMode:
                  type: string
                  enum:
                    - ONLINE
                    - PAY_AT_STORE
                lifecycle:
                  type: string
                  enum:
                    - SUBMITTING
                    - ACCEPTED
                    - IN_PREPARATION
                    - READY
                    - COMPLETED
                    - REJECTED
                    - CANCELED
                nextAction:
                  type: string
                  enum:
                    - NONE
                    - AWAIT_PAYMENT
                    - COMPLETE_CUSTOMER_PAYMENT
                    - AWAIT_TENDER_VERIFICATION
                    - RESOLVE_FAILURE
                orderId:
                  type: string
                  format: uuid
                  pattern: >-
                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                reconciliationState:
                  type: string
                  enum:
                    - CURRENT
                    - RECONCILING
                    - ACTION_REQUIRED
                settlementAdapter:
                  type: string
                  enum:
                    - STRIPE
                    - SQUARE
                    - CLOVER
                    - TOAST
                settlementState:
                  type: string
                  enum:
                    - NO_PAYMENT_REQUIRED
                    - DUE
                    - PARTIALLY_PAID
                    - PAID
                    - PARTIALLY_REFUNDED
                    - REFUNDED
                    - CANCELED
                submissionState:
                  type: string
                  enum:
                    - PREPARING
                    - ORDER_CREATED
                    - AWAITING_CUSTOMER_ACTION
                    - SUBMITTING
                    - SUCCEEDED
                    - FAILED
                    - EXPIRED
                    - ACTION_REQUIRED
              required:
                - attemptId
                - cartId
                - cartRevision
                - collectionMode
                - lifecycle
                - nextAction
                - orderId
                - reconciliationState
                - settlementAdapter
                - settlementState
                - submissionState
              additionalProperties: false
            receipt:
              type: object
              properties:
                receiptId:
                  type: string
                  minLength: 1
                receiptToken:
                  type: string
                  pattern: ^[A-Za-z0-9_-]{43}$
              required:
                - receiptId
                - receiptToken
              additionalProperties: false
          required:
            - state
            - cleanupAllowed
            - submission
          additionalProperties: false
    CommerceErrorEnvelope:
      type: object
      properties:
        code:
          anyOf:
            - type: string
              enum:
                - VALIDATION_ERROR
                - UNAUTHORIZED
                - CUSTOMER_AUTH_CODE_REJECTED
                - FORBIDDEN
                - NOT_FOUND
                - RATE_LIMITED
                - CART_CONFLICT
                - REQUOTE_REQUIRED
                - RESOURCE_CONFLICT
                - CART_IMMUTABLE
                - IDEMPOTENCY_KEY_REQUIRED
                - IDEMPOTENCY_KEY_REUSED
                - IDEMPOTENCY_IN_PROGRESS
                - DEPENDENCY_UNAVAILABLE
                - INTERNAL_ERROR
            - type: string
              minLength: 1
        message:
          type: string
          minLength: 1
        requestId:
          type: string
          minLength: 8
        details:
          type: object
          additionalProperties: {}
      required:
        - code
        - message
        - requestId
      additionalProperties: false
  securitySchemes:
    StorefrontCheckoutResult:
      type: apiKey
      in: header
      name: X-Checkout-Result
      description: >-
        Read-only current-handoff result capability. Never put in a URL or use
        as cart/payment authority.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.