> ## 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 Shipping Rates

> Returns a list of available shipping rates for the checkout.

Shipping rates are grouped against shipments. Each checkout can have multiple shipments. Some products are in stock and will be shipped immediately, while others might be back-ordered and sent later.



## OpenAPI

````yaml /api-reference/storefront.yaml get /api/v2/storefront/checkout/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/checkout/shipping_rates:
    get:
      tags:
        - Checkout / Shipments
      summary: List Shipping Rates
      description: >-
        Returns a list of available shipping rates for the checkout.


        Shipping rates are grouped against shipments. Each checkout can have
        multiple shipments. Some products are in stock and will be shipped
        immediately, while others might be back-ordered and sent later.
      operationId: shipping-rates
      responses:
        '200':
          $ref: '#/components/responses/Shipment'
        '404':
          $ref: '#/components/responses/404NotFound'
      security:
        - orderToken: []
        - bearerAuth: []
components:
  responses:
    Shipment:
      description: >-
        200 Success - Returns an array containing several `shipment` objects,
        along with the included array containing all available `shipping_rate`
        and `stock_location` objects. 
      content:
        application/vnd.api+json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  $ref: '#/components/schemas/Shipment'
              included:
                type: array
                items:
                  $ref: '#/components/schemas/ShipmentIncludes'
            required:
              - data
              - included
          examples:
            Shipment:
              value:
                data:
                  - id: '3'
                    type: shipment
                    attributes:
                      number: H97593072360
                      final_price: '5.0'
                      display_final_price: $5.00
                      state: pending
                      shipped_at: null
                      tracking_url: null
                      free: false
                    relationships:
                      shipping_rates:
                        data:
                          - id: '10'
                            type: shipping_rate
                          - id: '11'
                            type: shipping_rate
                          - id: '12'
                            type: shipping_rate
                      stock_location:
                        data:
                          id: '1'
                          type: stock_location
                included:
                  - id: '10'
                    type: shipping_rate
                    attributes:
                      name: UPS Ground (USD)
                      selected: true
                      final_price: '5.0'
                      display_final_price: $5.00
                      cost: '5.0'
                      display_cost: $5.00
                      tax_amount: '0.0'
                      display_tax_amount: $0.00
                      shipping_method_id: '1'
                      free: false
                    relationships:
                      shipping_method:
                        data:
                          id: '1'
                          type: shipping_method
                  - id: '11'
                    type: shipping_rate
                    attributes:
                      name: UPS Two Day (USD)
                      selected: false
                      final_price: '10.0'
                      display_final_price: $10.00
                      cost: '10.0'
                      display_cost: $10.00
                      tax_amount: '0.0'
                      display_tax_amount: $0.00
                      shipping_method_id: '2'
                      free: false
                    relationships:
                      shipping_method:
                        data:
                          id: '2'
                          type: shipping_method
                  - id: '12'
                    type: shipping_rate
                    attributes:
                      name: UPS One Day (USD)
                      selected: false
                      final_price: '15.0'
                      display_final_price: $15.00
                      cost: '15.0'
                      display_cost: $15.00
                      tax_amount: '0.0'
                      display_tax_amount: $0.00
                      shipping_method_id: '3'
                      free: false
                    relationships:
                      shipping_method:
                        data:
                          id: '3'
                          type: shipping_method
                  - id: '1'
                    type: stock_location
                    attributes:
                      name: default
    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:
    Shipment:
      type: object
      title: Shipment
      x-internal: false
      properties:
        id:
          type: string
          example: '1'
        type:
          type: string
          default: shipment
        attributes:
          type: object
          properties:
            number:
              type: string
              example: H121354
              description: Unique Shipment identifier
            free:
              type: boolean
              description: >-
                Indicates if the Shipping Rate is free, eg. when Free shipping
                promo applied to Cart
            final_price:
              type: string
              example: '10.0'
              description: Price to be presented for the Customer
            display_final_price:
              type: string
              example: $10.00
            tracking_url:
              type: string
              example: >-
                https://tools.usps.com/go/TrackConfirmAction?tRef=fullpage&tLc=2&text28777=&tLabels=4123412434%2C
              description: Tracking URL to the service provider website
              nullable: true
            state:
              type: string
              example: shipped
              enum:
                - pending
                - ready
                - shipped
                - canceled
              description: >-
                Status of the Shipment. For a list of all available statuses
                please refer: <a href="/developer/core-concepts/shipments"
                target="_blank" rel="noopener">
                  Shipment section in Spree Guides
                </a>
            shipped_at:
              type: string
              format: date-time
              example: '2021-01-02 13:42:12'
              description: Date when Shipment was being sent from the warehouse
              nullable: true
        relationships:
          type: object
          properties:
            stock_location:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/Relation'
            shipping_rates:
              type: object
              properties:
                data:
                  type: array
                  items:
                    allOf:
                      - $ref: '#/components/schemas/Relation'
      required:
        - id
        - type
        - attributes
        - relationships
    ShipmentIncludes:
      x-internal: false
      title: Shipment Includes
      allOf:
        - $ref: '#/components/schemas/ShippingRate'
        - $ref: '#/components/schemas/StockLocation'
    Relation:
      type: object
      nullable: true
      properties:
        id:
          type: string
        type:
          type: string
      required:
        - id
        - type
      x-internal: false
      description: ''
    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
    StockLocation:
      title: Stock Location
      type: object
      x-internal: false
      properties:
        id:
          type: string
          example: '1'
        type:
          type: string
          default: stock_location
        attributes:
          type: object
          properties:
            name:
              type: string
              example: Main Warehouse
      required:
        - id
        - type
        - attributes
  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.

````