openapi: 3.2.0
info:
  title: ClickFunnels Shipping::Profile 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::Profile
  description: Shipping Profile
paths:
  /workspaces/{workspace_id}/shipping/profiles:
    get:
      tags:
      - Shipping::Profile
      summary: List Profiles
      description: List shipping profiles for a workspace
      operationId: listShippingProfiles
      parameters:
      - name: workspace_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/ShippingProfileAttributes'
              example:
              - id: 14
                public_id: JdqHSV
                name: Example Shipping Profile
                variant_ids: []
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
              - id: 15
                public_id: yKimcL
                name: Example Shipping Profile
                variant_ids: []
                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::Profile
      summary: Create Profile
      description: Add a new shipping profile to a workspace
      operationId: createShippingProfiles
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Profile
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                shipping_profile:
                  type: object
                  $ref: '#/components/schemas/ShippingProfileParameters'
            example:
              shipping_profile:
                name: Example Shipping Profile
                variant_ids: []
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingProfileAttributes'
              example:
                id: 17
                public_id: wNmEyr
                name: Example Shipping Profile
                variant_ids: []
                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/profiles/{id}:
    get:
      tags:
      - Shipping::Profile
      summary: Fetch Profile
      description: Retrieve a shipping profile for a workspace
      operationId: getShippingProfiles
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingProfileAttributes'
              example:
                id: 16
                public_id: KXZDCa
                name: Example Shipping Profile
                variant_ids: []
                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::Profile
      summary: Update Profile
      description: Update a shipping profile for a workspace
      operationId: updateShippingProfiles
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Information about updated fields in Profile
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                shipping_profile:
                  type: object
                  $ref: '#/components/schemas/ShippingProfileParametersUpdate'
            example:
              shipping_profile:
                name: Example Shipping
                variant_ids: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingProfileAttributes'
              example:
                id: 19
                public_id: BIKTCq
                name: Example Shipping Profile
                variant_ids: []
                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::Profile
      summary: Remove Profile
      description: Delete a shipping profile for a workspace
      operationId: removeShippingProfiles
      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:
  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).
  schemas:
    ShippingProfileParameters:
      type: object
      title: Profiles
      description: Profiles
      required:
      - name
      properties:
        name:
          type: string
          description: Name
        variant_ids:
          type:
          - array
          - 'null'
          description: Variant IDs
      example:
        shipping_profile:
          name: Example Shipping Profile
          variant_ids: []
    ShippingProfileParametersUpdate:
      type: object
      title: Profiles
      description: Profiles
      required: []
      properties:
        name:
          type: string
          description: Name
        variant_ids:
          type:
          - array
          - 'null'
          description: Variant IDs
      example:
        shipping_profile:
          name: Example Shipping
          variant_ids: []
    ShippingProfileAttributes:
      type: object
      title: Profiles
      description: Profiles
      properties:
        id:
          type: integer
          description: Profile ID
        public_id:
          type:
          - string
          - 'null'
          description: Profile public ID
        name:
          type: string
          description: Name
        variant_ids:
          type:
          - array
          - 'null'
          description: Variant IDs
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Added
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Updated
      example:
        id: 2
        public_id: XGHEUg
        name: Example Shipping Profile
        variant_ids: []
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
      required:
      - created_at
      - id
      - name
      - public_id
      - updated_at
      - variant_ids
  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