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

# Return a list of Shipping Methods

> Returns a list of Shipping Methods



## OpenAPI

````yaml /api-reference/platform.yaml get /api/v2/platform/shipping_methods
openapi: 3.0.3
info:
  title: Platform API
  contact:
    name: Vendo Connect Inc.
    url: https://getvendo.com
    email: sales@getvendo.com
  description: Spree Platform API
  version: v2
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Addresses
  - name: Adjustments
  - name: Classifications
  - name: Countries
  - name: CMS Pages
  - name: CMS Sections
  - name: Digital Assets
  - name: Digital Links
  - name: Line Items
  - name: Menus
  - name: Menu Items
  - name: Option Types
  - name: Option Values
  - name: Orders
  - name: Payments
  - name: Payment Methods
  - name: Products
  - name: Promotions
  - name: Promotion Actions
  - name: Promotion Categories
  - name: Promotion Rules
  - name: Roles
  - name: Shipments
  - name: Shipping Categories
  - name: Shipping Methods
  - name: States
  - name: Stock Items
  - name: Stock Locations
  - name: Store Credit Categories
  - name: Store Credit Types
  - name: Store Credits
  - name: Tax Categories
  - name: Tax Rates
  - name: Taxons
  - name: Taxonomies
  - name: Users
  - name: Variants
  - name: Vendors
  - name: Webhook Events
  - name: Webhook Subscribers
  - name: Wishlists
  - name: Wished Items
  - name: Zones
paths:
  /api/v2/platform/shipping_methods:
    get:
      tags:
        - Shipping Methods
      summary: Return a list of Shipping Methods
      description: Returns a list of Shipping Methods
      operationId: shipping-methods-list
      parameters:
        - name: page
          in: query
          example: 1
          schema:
            type: integer
        - name: per_page
          in: query
          example: 50
          schema:
            type: integer
        - name: include
          in: query
          description: >-
            Select which associated resources you would like to fetch, see: <a
            href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>
          example: calculator,shipping_categories,shipping_rates,tax_category
          schema:
            type: string
        - name: filter[name]
          in: query
          description: ''
          example: DHL Express
          schema:
            type: string
        - name: filter[title_cont]
          in: query
          description: ''
          example: About Us
          schema:
            type: string
      responses:
        '200':
          description: Records returned
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    data:
                      - id: '77'
                        type: shipping_method
                        attributes:
                          name: UPS Ground
                          code: UPS_GROUND
                          admin_name: null
                          display_on: both
                          tracking_url: null
                          created_at: '2022-11-08T19:35:23.928Z'
                          updated_at: '2022-11-08T19:35:23.928Z'
                          deleted_at: null
                          public_metadata: {}
                          private_metadata: {}
                        relationships:
                          shipping_categories:
                            data:
                              - id: '146'
                                type: shipping_category
                          shipping_rates:
                            data: []
                          tax_category:
                            data: null
                          calculator:
                            data:
                              id: '137'
                              type: calculator
                      - id: '78'
                        type: shipping_method
                        attributes:
                          name: UPS Ground
                          code: UPS_GROUND
                          admin_name: null
                          display_on: both
                          tracking_url: null
                          created_at: '2022-11-08T19:35:23.939Z'
                          updated_at: '2022-11-08T19:35:23.939Z'
                          deleted_at: null
                          public_metadata: {}
                          private_metadata: {}
                        relationships:
                          shipping_categories:
                            data:
                              - id: '146'
                                type: shipping_category
                          shipping_rates:
                            data: []
                          tax_category:
                            data: null
                          calculator:
                            data:
                              id: '138'
                              type: calculator
                    meta:
                      count: 2
                      total_count: 2
                      total_pages: 1
                    links:
                      self: >-
                        http://www.example.com/api/v2/platform/shipping_methods?page=1&per_page=&include=&filter[name]=&filter[title_cont]=
                      next: >-
                        http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
                      prev: >-
                        http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
                      last: >-
                        http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
                      first: >-
                        http://www.example.com/api/v2/platform/shipping_methods?filter%5Bname%5D=&filter%5Btitle_cont%5D=&include=&page=1&per_page=
              schema:
                $ref: '#/components/schemas/resources_list'
        '401':
          description: Authentication Failed
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The access token is invalid
              schema:
                $ref: '#/components/schemas/error'
      security:
        - bearer_auth: []
components:
  schemas:
    resources_list:
      type: object
      properties:
        data:
          type: array
          items:
            allOf:
              - $ref: '#/components/schemas/resource_properties'
        meta:
          type: object
          properties:
            count:
              type: integer
            total_count:
              type: integer
            total_pages:
              type: integer
          required:
            - count
            - total_count
            - total_pages
        links:
          type: object
          properties:
            self:
              type: string
            next:
              type: string
            prev:
              type: string
            last:
              type: string
            first:
              type: string
          required:
            - self
            - next
            - prev
            - last
            - first
      required:
        - data
        - meta
        - links
      x-internal: false
    error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
      x-internal: false
    resource_properties:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          type: object
        relationships:
          type: object
      required:
        - id
        - type
        - attributes
      x-internal: false
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````