openapi: 3.2.0
info:
  title: ClickFunnels Shipping::Rate API
  termsOfService: https://www.clickfunnels.com/terms-of-service
  contact:
    name: ClickFunnels API Team
    url: https://developers.myclickfunnels.com
  x-logo:
    url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
  description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.

    '
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
  description: ClickFunnels API
  variables:
    subdomain:
      default: myworkspace
security:
- BearerAuth: []
tags:
- name: Shipping::Rate
  description: Shipping Rate
paths:
  /shipping/zones/{zone_id}/rates:
    get:
      tags:
      - Shipping::Rate
      summary: List Rates
      description: List shipping rates for a zone
      operationId: listShippingRates
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/sort_order'
      - $ref: '#/components/parameters/sort_property'
      responses:
        '200':
          description: OK
          headers:
            Pagination-Next:
              $ref: '#/components/headers/PaginationNext'
            Link:
              $ref: '#/components/headers/Link'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ShippingRateAttributes'
              example:
              - id: 2
                public_id: EQcBiN
                zone_id: 3
                description: Example Shipping Rates Name
                provider_name: Riley Bode
                price: '10.00'
                price_currency: USD
                rates_name_id: 3
                live_rates_provider: null
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
              - id: 3
                public_id: YqAsmi
                zone_id: 4
                description: Example Shipping Rates Name
                provider_name: Mr. Lynelle Runte
                price: '10.00'
                price_currency: USD
                rates_name_id: 4
                live_rates_provider: null
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID.
              example:
                error: 'Not found: Record missing'
    post:
      tags:
      - Shipping::Rate
      summary: Create Rate
      description: Add a new shipping rate to a zone
      operationId: createShippingRates
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Rate
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                shipping_rate:
                  type: object
                  $ref: '#/components/schemas/ShippingRateParameters'
            example:
              shipping_rate:
                provider_name: Tammera Kihn DO
                price: '10.00'
                price_currency: USD
                rates_name_id: 1
                live_rates_provider: null
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingRateAttributes'
              example:
                id: 5
                public_id: OLYIDm
                zone_id: 6
                description: Example Shipping Rates Name
                provider_name: Darleen Carroll
                price: '10.00'
                price_currency: USD
                rates_name_id: 6
                live_rates_provider: null
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Bad request: HTTP body must be valid JSON'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
  /shipping/rates/{id}:
    get:
      tags:
      - Shipping::Rate
      summary: Fetch Rate
      description: Retrieve a shipping rate for a zone
      operationId: getShippingRates
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingRateAttributes'
              example:
                id: 4
                public_id: TGMgAZ
                zone_id: 5
                description: Example Shipping Rates Name
                provider_name: Iraida Cummerata Sr.
                price: '10.00'
                price_currency: USD
                rates_name_id: 5
                live_rates_provider: null
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
    put:
      tags:
      - Shipping::Rate
      summary: Update Rate
      description: Update a shipping rate for a zone
      operationId: updateShippingRates
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Information about updated fields in Rate
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                shipping_rate:
                  type: object
                  $ref: '#/components/schemas/ShippingRateParametersUpdate'
            example:
              shipping_rate:
                provider_name: Tammera Kihn DO
                price: '10.00'
                price_currency: USD
                rates_name_id: 1
                live_rates_provider: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingRateAttributes'
              example:
                id: 7
                public_id: jgYIbw
                zone_id: 8
                description: Example Shipping Rates Name
                provider_name: The Hon. Demetrius Kreiger
                price: '10.00'
                price_currency: USD
                rates_name_id: 8
                live_rates_provider: null
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Bad request: HTTP body must be valid JSON'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
    delete:
      tags:
      - Shipping::Rate
      summary: Remove Rate
      description: Delete a shipping rate for a zone
      operationId: removeShippingRates
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
components:
  schemas:
    ShippingRateAttributes:
      type: object
      title: Rates
      description: Rates
      properties:
        id:
          type: integer
          description: Rate ID
        public_id:
          type:
          - string
          - 'null'
          description: Rate public ID
        zone_id:
          type: integer
          description: Zone ID
        description:
          type:
          - string
          - 'null'
          description: Rate name
        provider_name:
          type:
          - string
          - 'null'
          description: Provider Name
        price:
          type: string
          description: Price
        price_currency:
          type:
          - string
          - 'null'
          description: Price Currency
        rates_name_id:
          type: integer
          description: Rate name ID
        live_rates_provider:
          type:
          - string
          - 'null'
          enum:
          - Shippo
          - null
          description: Live Rates Provider
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Added
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Updated
      example:
        id: 1
        public_id: InONPz
        zone_id: 1
        description: Example Shipping Rates Name
        provider_name: Tammera Kihn DO
        price: '10.00'
        price_currency: USD
        rates_name_id: 1
        live_rates_provider: null
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
      required:
      - created_at
      - description
      - id
      - live_rates_provider
      - price
      - price_currency
      - provider_name
      - public_id
      - rates_name_id
      - updated_at
      - zone_id
    ShippingRateParametersUpdate:
      type: object
      title: Rates
      description: Rates
      required: []
      properties:
        provider_name:
          type:
          - string
          - 'null'
          description: Provider Name
        price:
          type: string
          description: Price
        price_currency:
          type: string
          description: Price Currency
        rates_name_id:
          type: integer
          description: Rate name ID
        live_rates_provider:
          type:
          - string
          - 'null'
          enum:
          - Shippo
          - null
          description: Live Rates Provider
      example:
        shipping_rate:
          provider_name: Tammera Kihn DO
          price: '10.00'
          price_currency: USD
          rates_name_id: 1
          live_rates_provider: null
    ShippingRateParameters:
      type: object
      title: Rates
      description: Rates
      required:
      - price
      - rates_name_id
      properties:
        provider_name:
          type:
          - string
          - 'null'
          description: Provider Name
        price:
          type: string
          description: Price
        price_currency:
          type:
          - string
          - 'null'
          description: Price Currency
        rates_name_id:
          type: integer
          description: Rate name ID
        live_rates_provider:
          type:
          - string
          - 'null'
          enum:
          - Shippo
          - null
          description: Live Rates Provider
      example:
        shipping_rate:
          provider_name: Tammera Kihn DO
          price: '10.00'
          price_currency: USD
          rates_name_id: 1
          live_rates_provider: null
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
    sort_property:
      name: sort_property
      in: query
      description: 'Sort property of a list response. The default is id and thus the created_at order.

        If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

        '
      required: false
      schema:
        type: string
        enum:
        - id
        - updated_at
    sort_order:
      name: sort_order
      in: query
      description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination).
      required: false
      schema:
        type: string
        enum:
        - asc
        - desc
    after:
      name: after
      in: query
      required: false
      schema:
        type: string
      description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination).
  headers:
    Link:
      description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value.
      schema:
        type: string
    PaginationNext:
      description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page.
      schema:
        type: string
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
externalDocs:
  description: More in-depth guides and further resources
  url: https://developers.myclickfunnels.com