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

# List all shipping methods

> Returns a list of shipping methods.

**NOTE:** QuickBooks Desktop does not support pagination for shipping methods; hence, there is no `cursor` parameter. Users typically have few shipping methods.



## OpenAPI

````yaml GET /quickbooks-desktop/shipping-methods
openapi: 3.1.0
info:
  title: Conductor API
  version: 0.0.1
servers:
  - url: https://api.conductor.is/v1
security:
  - BearerAuth: []
paths:
  /quickbooks-desktop/shipping-methods:
    get:
      summary: List all shipping methods
      description: >-
        Returns a list of shipping methods.


        **NOTE:** QuickBooks Desktop does not support pagination for shipping
        methods; hence, there is no `cursor` parameter. Users typically have few
        shipping methods.
      parameters:
        - in: header
          name: Conductor-End-User-Id
          schema:
            type: string
            description: The ID of the End-User to receive this request.
            example: end_usr_1234567abcdefg
            x-stainless-naming:
              typescript:
                method_argument: conductorEndUserId
              mcp:
                method_argument: conductorEndUserId
          required: true
          description: The ID of the End-User to receive this request.
        - in: query
          name: ids
          schema:
            description: >-
              Filter for specific shipping methods by their QuickBooks-assigned
              unique identifier(s).


              **IMPORTANT**: If you include this parameter, QuickBooks will
              ignore all other query parameters for this request.


              **NOTE**: If any of the values you specify in this parameter are
              not found, the request will return an error.
            example:
              - 80000001-1234567890
            type: array
            items:
              type: string
          description: >-
            Filter for specific shipping methods by their QuickBooks-assigned
            unique identifier(s).


            **IMPORTANT**: If you include this parameter, QuickBooks will ignore
            all other query parameters for this request.


            **NOTE**: If any of the values you specify in this parameter are not
            found, the request will return an error.
        - in: query
          name: names
          schema:
            description: >-
              Filter for specific shipping methods by their name(s),
              case-insensitive. Like `id`, `name` is a unique identifier for a
              shipping method.


              **IMPORTANT**: If you include this parameter, QuickBooks will
              ignore all other query parameters for this request.


              **NOTE**: If any of the values you specify in this parameter are
              not found, the request will return an error.
            example:
              - FedEx Ground
            type: array
            items:
              type: string
          description: >-
            Filter for specific shipping methods by their name(s),
            case-insensitive. Like `id`, `name` is a unique identifier for a
            shipping method.


            **IMPORTANT**: If you include this parameter, QuickBooks will ignore
            all other query parameters for this request.


            **NOTE**: If any of the values you specify in this parameter are not
            found, the request will return an error.
        - in: query
          name: limit
          schema:
            description: >-
              The maximum number of objects to return.


              **IMPORTANT**: QuickBooks Desktop does not support cursor-based
              pagination for shipping methods. This parameter will limit the
              response size, but you cannot fetch subsequent results using a
              cursor. For pagination, use the name-range parameters instead
              (e.g., `nameFrom=A&nameTo=B`).


              When this parameter is omitted, the endpoint returns all shipping
              methods without limit, unlike paginated endpoints which default to
              150 records. This is acceptable because shipping methods typically
              have low record counts.
            example: 10
            type: integer
            minimum: 1
          description: >-
            The maximum number of objects to return.


            **IMPORTANT**: QuickBooks Desktop does not support cursor-based
            pagination for shipping methods. This parameter will limit the
            response size, but you cannot fetch subsequent results using a
            cursor. For pagination, use the name-range parameters instead (e.g.,
            `nameFrom=A&nameTo=B`).


            When this parameter is omitted, the endpoint returns all shipping
            methods without limit, unlike paginated endpoints which default to
            150 records. This is acceptable because shipping methods typically
            have low record counts.
        - in: query
          name: status
          schema:
            description: Filter for shipping methods that are active, inactive, or both.
            example: active
            type: string
            enum:
              - active
              - all
              - inactive
            default: active
          description: Filter for shipping methods that are active, inactive, or both.
        - in: query
          name: updatedAfter
          schema:
            description: >-
              Filter for shipping methods updated on or after this date/time.
              Accepts the following ISO 8601 formats:

              - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the
              date as the **start of the specified day** in the local timezone
              of the end-user's computer (e.g., `2025-01-01` →
              `2025-01-01T00:00:00`).

              - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks
              Desktop interprets the timestamp in the local timezone of the
              end-user's computer.

              - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) -
              QuickBooks Desktop interprets the timestamp using the specified
              timezone.
            example: '2025-01-01T12:34:56.000Z'
            type: string
          description: >-
            Filter for shipping methods updated on or after this date/time.
            Accepts the following ISO 8601 formats:

            - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the
            date as the **start of the specified day** in the local timezone of
            the end-user's computer (e.g., `2025-01-01` →
            `2025-01-01T00:00:00`).

            - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks
            Desktop interprets the timestamp in the local timezone of the
            end-user's computer.

            - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) -
            QuickBooks Desktop interprets the timestamp using the specified
            timezone.
        - in: query
          name: updatedBefore
          schema:
            description: >-
              Filter for shipping methods updated on or before this date/time.
              Accepts the following ISO 8601 formats:

              - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the
              date as the **end of the specified day** in the local timezone of
              the end-user's computer (e.g., `2025-01-01` →
              `2025-01-01T23:59:59`).

              - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks
              Desktop interprets the timestamp in the local timezone of the
              end-user's computer.

              - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) -
              QuickBooks Desktop interprets the timestamp using the specified
              timezone.
            example: '2025-02-01T12:34:56.000Z'
            type: string
          description: >-
            Filter for shipping methods updated on or before this date/time.
            Accepts the following ISO 8601 formats:

            - **date-only** (YYYY-MM-DD) - QuickBooks Desktop interprets the
            date as the **end of the specified day** in the local timezone of
            the end-user's computer (e.g., `2025-01-01` →
            `2025-01-01T23:59:59`).

            - **datetime without timezone** (YYYY-MM-DDTHH:mm:ss) - QuickBooks
            Desktop interprets the timestamp in the local timezone of the
            end-user's computer.

            - **datetime with timezone** (YYYY-MM-DDTHH:mm:ss±HH:mm) -
            QuickBooks Desktop interprets the timestamp using the specified
            timezone.
        - in: query
          name: nameContains
          schema:
            description: >-
              Filter for shipping methods whose `name` contains this substring,
              case-insensitive.


              **NOTE**: If you use this parameter, you cannot also use
              `nameStartsWith` or `nameEndsWith`.
            example: ABC
            type: string
          description: >-
            Filter for shipping methods whose `name` contains this substring,
            case-insensitive.


            **NOTE**: If you use this parameter, you cannot also use
            `nameStartsWith` or `nameEndsWith`.
        - in: query
          name: nameStartsWith
          schema:
            description: >-
              Filter for shipping methods whose `name` starts with this
              substring, case-insensitive.


              **NOTE**: If you use this parameter, you cannot also use
              `nameContains` or `nameEndsWith`.
            example: ABC
            type: string
          description: >-
            Filter for shipping methods whose `name` starts with this substring,
            case-insensitive.


            **NOTE**: If you use this parameter, you cannot also use
            `nameContains` or `nameEndsWith`.
        - in: query
          name: nameEndsWith
          schema:
            description: >-
              Filter for shipping methods whose `name` ends with this substring,
              case-insensitive.


              **NOTE**: If you use this parameter, you cannot also use
              `nameContains` or `nameStartsWith`.
            example: ABC
            type: string
          description: >-
            Filter for shipping methods whose `name` ends with this substring,
            case-insensitive.


            **NOTE**: If you use this parameter, you cannot also use
            `nameContains` or `nameStartsWith`.
        - in: query
          name: nameFrom
          schema:
            description: >-
              Filter for shipping methods whose `name` is alphabetically greater
              than or equal to this value.
            example: A
            type: string
          description: >-
            Filter for shipping methods whose `name` is alphabetically greater
            than or equal to this value.
        - in: query
          name: nameTo
          schema:
            description: >-
              Filter for shipping methods whose `name` is alphabetically less
              than or equal to this value.
            example: Z
            type: string
          description: >-
            Filter for shipping methods whose `name` is alphabetically less than
            or equal to this value.
      responses:
        '200':
          description: Returns a list of shipping methods.
          headers:
            Conductor-Request-Id:
              required: true
              description: The unique identifier for this API request.
              schema:
                type: string
                description: The unique identifier for this API request.
                example: req_1234567abcdefg
          content:
            application/json:
              schema:
                type: object
                properties:
                  objectType:
                    description: The type of object. This value is always `"list"`.
                    example: list
                    type: string
                    const: list
                  url:
                    type: string
                    description: The endpoint URL where this list can be accessed.
                    example: /v1/quickbooks-desktop/shipping-methods
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/qbd_shipping_method'
                    description: The array of shipping methods.
                required:
                  - objectType
                  - url
                  - data
                additionalProperties: false
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Conductor from 'conductor-node';

            const conductor = new Conductor({
              apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
            });

            const shippingMethods = await conductor.qbd.shippingMethods.list({
              conductorEndUserId: 'end_usr_1234567abcdefg',
            });

            console.log(shippingMethods.data);
        - lang: Python
          source: |-
            import os
            from conductor import Conductor

            conductor = Conductor(
                api_key=os.environ.get("CONDUCTOR_SECRET_KEY"),  # This is the default and can be omitted
            )
            shipping_methods = conductor.qbd.shipping_methods.list(
                conductor_end_user_id="end_usr_1234567abcdefg",
            )
            print(shipping_methods.data)
components:
  schemas:
    qbd_shipping_method:
      type: object
      properties:
        id:
          type: string
          description: >-
            The unique identifier assigned by QuickBooks to this shipping
            method. This ID is unique across all shipping methods but not across
            different QuickBooks object types.
          example: 80000001-1234567890
        objectType:
          description: The type of object. This value is always `"qbd_shipping_method"`.
          example: qbd_shipping_method
          type: string
          const: qbd_shipping_method
        createdAt:
          type: string
          description: >-
            The date and time when this shipping method was created, in ISO 8601
            format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop
            interprets in the local timezone of the end-user's computer.
          example: '2025-01-01T12:34:56.000Z'
        updatedAt:
          type: string
          description: >-
            The date and time when this shipping method was last updated, in ISO
            8601 format (YYYY-MM-DDThh:mm:ss±hh:mm), which QuickBooks Desktop
            interprets in the local timezone of the end-user's computer.
          example: '2025-02-01T12:34:56.000Z'
        revisionNumber:
          type: string
          description: >-
            The current QuickBooks-assigned revision number of this shipping
            method object, which changes each time the object is modified. When
            updating this object, you must provide the most recent
            `revisionNumber` to ensure you're working with the latest data;
            otherwise, the update will return an error.
          example: '1721172183'
        name:
          type: string
          description: >-
            The case-insensitive unique name of this shipping method, unique
            across all shipping methods.


            **NOTE**: Shipping methods do not have a `fullName` field because
            they are not hierarchical objects, which is why `name` is unique for
            them but not for objects that have parents.
          example: FedEx Ground
        isActive:
          type: boolean
          description: >-
            Indicates whether this shipping method is active. Inactive objects
            are typically hidden from views and reports in QuickBooks. Defaults
            to `true`.
          example: true
      required:
        - id
        - objectType
        - createdAt
        - updatedAt
        - revisionNumber
        - name
        - isActive
      additionalProperties: false
      title: The Shipping Method object
      x-conductor-object-type: other
      summary: >-
        A shipping method defines how goods are delivered in QuickBooks Desktop,
        such as standard mail or overnight delivery.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your Conductor secret key using Bearer auth (e.g., `"Authorization:
        Bearer {{YOUR_SECRET_KEY}}"`).

````

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