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

# List Estimated Shipping Rates

> Returns a list of shipping rates for the current cart. The rates given are only estimates and can vary from the final shipping rates.



## OpenAPI

````yaml /api-reference/storefront.yaml get /api/v2/storefront/cart/estimate_shipping_rates
openapi: 3.0.3
info:
  version: 2.0.0
  title: Storefront API
  description: >-
    Storefront API is a modern REST API based on the [JSON API
    spec](https://jsonapi.org/) which provides you with all the necessary
    endpoints to build amazing user interfaces either in JavaScript frameworks
    or native mobile libraries.


    Import to
    [Postman](https://raw.githubusercontent.com/spree/spree/main/docs/api-reference/storefront.yaml)
  contact:
    name: Vendo Connect Inc.
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  license:
    name: BSD-3-Clause
    url: https://github.com/spree/spree/blob/main/LICENSE.md
servers:
  - url: https://demo.spreecommerce.org
    description: demo
  - url: http://localhost:3000
    description: localhost
security: []
tags:
  - name: Account
  - name: Account / Address
  - name: Account / Credit Cards
  - name: Account / Orders
  - name: Cart
  - name: Cart / Line Items
  - name: Cart / Coupons
  - name: Cart / Other
  - name: Checkout
  - name: Checkout / State
  - name: Checkout / Shipments
  - name: Checkout / Payments
  - name: Checkout / Store Credit
  - name: Stripe
  - name: Adyen
  - name: Countries
  - name: Digital Downloads
  - name: Order Status
  - name: Products
  - name: Variants
  - name: Stores
  - name: Policies
  - name: Taxons
  - name: Vendors
  - name: Wishlists
  - name: Wishlists / Wished Items
paths:
  /api/v2/storefront/cart/estimate_shipping_rates:
    get:
      tags:
        - Cart / Other
      summary: List Estimated Shipping Rates
      description: >-
        Returns a list of shipping rates for the current cart. The rates given
        are only estimates and can vary from the final shipping rates.
      operationId: estimate-shipping-rates
      parameters:
        - name: country_iso
          in: query
          description: >-
            Pass country ISO or ISO3 symbol to get estimations for this
            destination. If no code is passed we'll try to use Cart shipping
            address country or the default Country for the current Store.
          schema:
            type: string
            example: USA
          example: USA
          required: true
        - $ref: '#/components/parameters/SparseFieldsShippingRate'
      responses:
        '200':
          $ref: '#/components/responses/EstimatedShippingRates'
        '404':
          $ref: '#/components/responses/404NotFound'
      security:
        - orderToken: []
        - bearerAuth: []
components:
  parameters:
    SparseFieldsShippingRate:
      in: query
      name: fields[shipping_rate]
      example: >-
        name,selected,final_price,display_final_price,cost,display_cost,tax_amount,display_tax_amount,shipping_method_id
      description: >-
        Specify the fields you would like returned in the response body. [More
        information](https://jsonapi.org/format/#fetching-sparse-fieldsets).
      schema:
        type: string
  responses:
    EstimatedShippingRates:
      description: 200 Success - Returns an array of `shipping_rate` objects.
      content:
        application/vnd.api+json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  $ref: '#/components/schemas/ShippingRate'
            required:
              - data
          examples:
            Estimated Shipping Rates:
              value:
                data:
                  - id: null
                    type: shipping_rate
                    attributes:
                      name: UPS Ground (USD)
                      selected: true
                      cost: '5.0'
                      tax_amount: '0.0'
                      final_price: '5.0'
                      shipping_method_id: '1'
                      display_cost: $5.00
                      display_final_price: $5.00
                      display_tax_amount: $0.00
                      free: false
                    relationships:
                      shipping_method:
                        data:
                          type: shipping_method
                          id: '1'
                  - id: null
                    type: shipping_rate
                    attributes:
                      name: UPS Two Day (USD)
                      selected: false
                      cost: '10.0'
                      tax_amount: '0.0'
                      final_price: '10.0'
                      shipping_method_id: '2'
                      display_cost: $10.00
                      display_final_price: $10.00
                      display_tax_amount: $0.00
                      free: false
                    relationships:
                      shipping_method:
                        data:
                          id: '2'
                          type: shipping_method
                  - id: null
                    type: shipping_rate
                    attributes:
                      name: UPS One Day (USD)
                      selected: false
                      cost: '15.0'
                      tax_amount: '0.0'
                      final_price: '15.0'
                      shipping_method_id: '3'
                      display_cost: $15.00
                      display_final_price: $15.00
                      display_tax_amount: $0.00
                      free: false
                    relationships:
                      shipping_method:
                        data:
                          id: '3'
                          type: shipping_method
    404NotFound:
      description: 404 Not Found - Resource not found.
      content:
        application/vnd.api+json:
          schema:
            properties:
              error:
                type: string
                example: The resource you were looking for could not be found.
                default: The resource you were looking for could not be found.
          examples:
            404 Example:
              value:
                error: The resource you were looking for could not be found.
  schemas:
    ShippingRate:
      type: object
      title: Shipping Rate
      description: ''
      x-internal: false
      properties:
        id:
          type: string
          example: '1'
          nullable: true
        type:
          type: string
          default: shipping_rate
        attributes:
          type: object
          properties:
            name:
              type: string
              example: USPS Ground
            selected:
              type: boolean
              example: true
            cost:
              type: string
              example: '10.0'
              description: Price of the service without discounts applied
            tax_amount:
              type: string
              example: '0.0'
              description: Eligible tax for service (if any)
            shipping_method_id:
              type: integer
              example: 1
              description: >-
                ID of a Shipping Method. You will need this for the Checkout
                Update action
            final_price:
              type: string
              example: '10.0'
              description: Price to be presented for the Customer
            display_cost:
              type: string
              example: $10.00
            display_final_price:
              type: string
              example: $10.00
            display_tax_amount:
              type: string
              example: $0.00
            free:
              type: boolean
              example: true
              description: >-
                Indicates if the Shipping Rate is free, eg. when Free shipping
                promo applied to Cart
        relationships:
          type: object
          properties:
            shipping_method:
              type: object
              description: Shipping method for which this shipping rate belongs to
              properties:
                data:
                  $ref: '#/components/schemas/Relation'
      required:
        - id
        - type
        - attributes
        - relationships
    Relation:
      type: object
      nullable: true
      properties:
        id:
          type: string
        type:
          type: string
      required:
        - id
        - type
      x-internal: false
      description: ''
  securitySchemes:
    orderToken:
      type: apiKey
      in: header
      description: |-
        Order token to authorize Cart and Checkout requests.

        [How to obtain X-Spree-Order-Token](../authentication#for-guest-users)
      name: X-Spree-Order-Token
    bearerAuth:
      type: http
      scheme: bearer
      description: |-
        User token to authorize Cart and Checkout requests.

        It is required to associate Cart with the User.

````