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

# Get Free Shipping Upsell

> Determine whether the cart is eligible for a free shipping upsell prompt and, if so, how much more the customer needs to spend (value-based) or how many more items are needed (volume-based) to qualify. When no upsell applies, or the amount needed exceeds the store's display threshold, `show` is `false`.



## OpenAPI

````yaml /api-reference/openapi.json get /carts/{cartId}/freeShippingUpsell
openapi: 3.0.0
info:
  title: Marzipan API
  version: 1.0.0
servers:
  - url: https://api.marzipan.co/v1
security:
  - tenantAuth: []
tags:
  - name: Account
    description: >-
      Account management endpoints including registration, login, and user
      details
  - name: Carts
    description: Shopping cart management endpoints
  - name: Products
    description: Product catalog and search endpoints
  - name: Subscriptions
    description: Subscription management and renewal endpoints
  - name: CMS
    description: Content management system endpoints
  - name: Messaging
    description: Message and communication endpoints
  - name: Search
    description: Search functionality endpoints
  - name: Settings
    description: >-
      Storefront settings and market detection used to configure the web
      components and checkout.
  - name: Analytics
    description: Storefront visit and attribution tracking.
  - name: Rewards
    description: >-
      Loyalty and rewards programme endpoints for the authenticated customer,
      covering points balance, tier status, perks, exclusive products and
      transaction history.
  - name: Forms
    description: Render and submit dynamic storefront forms defined in the CMS.
  - name: Events
    description: >-
      Check event availability, browse occurrences and recurring dates, generate
      ticket QR codes, and manage event waitlists (join, leave, check status,
      and claim promoted spots).
paths:
  /carts/{cartId}/freeShippingUpsell:
    parameters:
      - name: cartId
        in: path
        required: true
        description: The unique identifier for the cart
        schema:
          type: string
          format: uuid
        example: 893ff86d-4453-4134-9f62-5c9b7a70d74e
    get:
      tags:
        - Carts
      summary: Get Free Shipping Upsell
      description: >-
        Determine whether the cart is eligible for a free shipping upsell prompt
        and, if so, how much more the customer needs to spend (value-based) or
        how many more items are needed (volume-based) to qualify. When no upsell
        applies, or the amount needed exceeds the store's display threshold,
        `show` is `false`.
      parameters: []
      responses:
        '200':
          description: The free shipping upsell state for the cart.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FreeShippingUpsell'
              example:
                show: true
                qualifies: false
                type: value
                amountNeeded: 1500
                itemsNeeded: null
components:
  schemas:
    FreeShippingUpsell:
      type: object
      description: The free shipping upsell state for a cart.
      properties:
        show:
          type: boolean
          description: Whether to display a free shipping upsell prompt.
        qualifies:
          type: boolean
          description: Whether the cart already qualifies for free shipping.
        type:
          type: string
          enum:
            - value
            - volume
          description: Whether the upsell threshold is based on order value or item volume.
        amountNeeded:
          type: number
          nullable: true
          description: >-
            For value-based upsells, the additional spend required to qualify,
            in minor currency units. Null for volume-based upsells.
        itemsNeeded:
          type: integer
          nullable: true
          description: >-
            For volume-based upsells, the additional item volume required to
            qualify. Null for value-based upsells.
      required:
        - show
  securitySchemes:
    tenantAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your API token.
      bearerFormat: JWT

````