> ## 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.

# Get server-evaluated checkout collection choices



## OpenAPI

````yaml /generated/storefront.openapi.json get /locations/{locationId}/carts/{cartId}/collection-options
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}/collection-options:
    get:
      tags:
        - Checkout
      summary: Get server-evaluated checkout collection choices
      operationId: storefrontGetCheckoutCollectionOptions
      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: Current collection choices for this cart and customer.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cartRevision:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                  options:
                    type: array
                    items:
                      anyOf:
                        - type: object
                          properties:
                            available:
                              type: boolean
                            collectionMode:
                              type: string
                              enum:
                                - ONLINE
                            settlementAdapter:
                              type: string
                              enum:
                                - STRIPE
                            unavailableReasonCode:
                              nullable: true
                              type: string
                              enum:
                                - ONLINE_UNAVAILABLE
                          required:
                            - available
                            - collectionMode
                            - settlementAdapter
                            - unavailableReasonCode
                          additionalProperties: false
                        - type: object
                          properties:
                            available:
                              type: boolean
                            collectionMode:
                              type: string
                              enum:
                                - PAY_AT_STORE
                            settlementAdapter:
                              nullable: true
                              type: string
                              enum:
                                - SQUARE
                                - CLOVER
                                - TOAST
                            unavailableReasonCode:
                              nullable: true
                              type: string
                              enum:
                                - PAY_AT_STORE_UNAVAILABLE
                                - PAY_AT_STORE_POLICY_UNCERTIFIED
                                - PAY_AT_STORE_ORDER_CAP_EXCEEDED
                                - PAY_AT_STORE_ACTIVE_COUNT_CEILING
                                - PAY_AT_STORE_ACTIVE_VALUE_CEILING
                                - PAY_AT_STORE_UNPAID_AGING
                                - PAY_AT_STORE_IDENTITY_REQUIRED
                          required:
                            - available
                            - collectionMode
                            - settlementAdapter
                            - unavailableReasonCode
                          additionalProperties: false
                    minItems: 2
                    maxItems: 2
                required:
                  - cartRevision
                  - options
                additionalProperties: false
          headers:
            ETag:
              description: >-
                Current resource revision tag. Send it in If-Match before
                mutation.
              schema:
                type: string
            Cache-Control:
              schema:
                type: string
                example: private, no-store
        '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:
        - StorefrontCartCapability: []
        - StorefrontCustomerAuth: []
components:
  schemas:
    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:
    StorefrontCartCapability:
      type: apiKey
      in: header
      name: X-Cart-Token
      description: Purpose-limited capability returned for a guest cart.
    StorefrontCustomerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: >-
        Merchant-bound opaque customer access capability returned by fresh code
        verification or refresh.

````

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