ClickFunnels Shipping::Package API

Shipping Package

Operations 5

GET /workspaces/{workspace_id}/shipping/packages List Packages #
POST /workspaces/{workspace_id}/shipping/packages Create Package #
GET /shipping/packages/{id} Fetch Package #
PUT /shipping/packages/{id} Update Package #
DELETE /shipping/packages/{id} Remove Package #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/clickfunnels-shipping-package-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

clickfunnels-shipping-package-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: ClickFunnels Shipping::Package 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::Package
  description: Shipping Package
paths:
  /workspaces/{workspace_id}/shipping/packages:
    get:
      tags:
      - Shipping::Package
      summary: List Packages
      description: List packages for a workspace
      operationId: listShippingPackages
      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/ShippingPackageAttributes'
              example:
              - id: 2
                public_id: HVNCpb
                package_type: box
                height: '4.0'
                width: '2.0'
                length: '2.0'
                distance_unit: in
                empty_weight: null
                weight: '0.0'
                weight_unit: lb
                default_package: false
                name: Example Package
                token: null
                carrier: null
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
              - id: 3
                public_id: yPrxfQ
                package_type: box
                height: '4.0'
                width: '2.0'
                length: '2.0'
                distance_unit: in
                empty_weight: null
                weight: '0.0'
                weight_unit: lb
                default_package: false
                name: Example Package
                token: null
                carrier: 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::Package
      summary: Create Package
      description: Add a new package to a workspace
      operationId: createShippingPackages
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Package
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                shipping_package:
                  type: object
                  $ref: '#/components/schemas/ShippingPackageParameters'
            example:
              shipping_package:
                package_type: box
                height: '4.0'
                width: '2.0'
                length: '2.0'
                distance_unit: in
                empty_weight: null
                weight: '0.0'
                weight_unit: lb
                default_package: false
                name: Example Package
                carrier: null
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingPackageAttributes'
              example:
                id: 5
                public_id: ybLWXM
                package_type: box
                height: '4.0'
                width: '2.0'
                length: '2.0'
                distance_unit: in
                empty_weight: null
                weight: '0.0'
                weight_unit: lb
                default_package: false
                name: Example Package
                token: null
                carrier: 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/packages/{id}:
    get:
      tags:
      - Shipping::Package
      summary: Fetch Package
      description: Retrieve a package for a workspace
      operationId: getShippingPackages
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingPackageAttributes'
              example:
                id: 4
                public_id: XwHOCQ
                package_type: box
                height: '4.0'
                width: '2.0'
                length: '2.0'
                distance_unit: in
                empty_weight: null
                weight: '0.0'
                weight_unit: lb
                default_package: false
                name: Example Package
                token: null
                carrier: 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::Package
      summary: Update Package
      description: Update a package for a workspace
      operationId: updateShippingPackages
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Information about updated fields in Package
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                shipping_package:
                  type: object
                  $ref: '#/components/schemas/ShippingPackageParametersUpdate'
            example:
              shipping_package:
                package_type: box
                height: '4.0'
                width: '2.0'
                length: '2.0'
                distance_unit: in
                empty_weight: null
                weight: '0.0'
                weight_unit: lb
                default_package: false
                name: Example Package
                carrier: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ShippingPackageAttributes'
              example:
                id: 7
                public_id: NsGJSg
                package_type: box
                height: '4.0'
                width: '2.0'
                length: '2.0'
                distance_unit: in
                empty_weight: null
                weight: '0.0'
                weight_unit: lb
                default_package: false
                name: Example Package
                token: null
                carrier: 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::Package
      summary: Remove Package
      description: Delete a package for a workspace
      operationId: removeShippingPackages
      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:
    ShippingPackageAttributes:
      type: object
      title: Packages
      description: Packages
      properties:
        id:
          type: integer
          description: Package ID
        public_id:
          type:
          - string
          - 'null'
          description: Package public ID
        package_type:
          type: string
          enum:
          - box
          - envelope
          - soft_package
          description: Package Type
        height:
          type: number
          description: Height
        width:
          type: number
          description: Width
        length:
          type: number
          description: Length
        distance_unit:
          type: string
          enum:
          - in
          - cm
          - ft
          - m
          - mm
          description: Distance Unit
        empty_weight:
          type:
          - string
          - 'null'
          description: Empty Weight
        weight:
          type:
          - number
          - 'null'
          description: Weight
        weight_unit:
          type:
          - string
          - 'null'
          enum:
          - lb
          - kg
          - g
          - oz
          - null
          description: Weight Unit
        default_package:
          type:
          - boolean
          - 'null'
          description: Default Package
        name:
          type: string
          description: Name
        token:
          type:
          - string
          - 'null'
          description: Token
        carrier:
          type:
          - string
          - 'null'
          enum:
          - fedex
          - ups
          - usps
          - null
          description: Carrier
        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: EpuezP
        package_type: box
        height: '4.0'
        width: '2.0'
        length: '2.0'
        distance_unit: in
        empty_weight: null
        weight: '0.0'
        weight_unit: lb
        default_package: false
        name: Example Package
        token: null
        carrier: null
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
      required:
      - carrier
      - created_at
      - default_package
      - distance_unit
      - empty_weight
      - height
      - id
      - length
      - name
      - package_type
      - public_id
      - token
      - updated_at
      - weight
      - weight_unit
      - width
    ShippingPackageParameters:
      type: object
      title: Packages
      description: Packages
      required:
      - package_type
      - height
      - width
      - length
      - distance_unit
      - name
      properties:
        package_type:
          type: string
          enum:
          - box
          - envelope
          - soft_package
          description: Package Type
        height:
          type: number
          description: Height
        width:
          type: number
          description: Width
        length:
          type: number
          description: Length
        distance_unit:
          type: string
          enum:
          - in
          - cm
          - ft
          - m
          - mm
          description: Distance Unit
        empty_weight:
          type:
          - string
          - 'null'
          description: Empty Weight
        weight:
          type:
          - number
          - 'null'
          description: Weight
        weight_unit:
          type:
          - string
          - 'null'
          enum:
          - lb
          - kg
          - g
          - oz
          - null
          description: Weight Unit
        default_package:
          type:
          - boolean
          - 'null'
          description: Default Package
        name:
          type: string
          description: Name
        carrier:
          type:
          - string
          - 'null'
          enum:
          - fedex
          - ups
          - usps
          - null
          description: Carrier
      example:
        shipping_package:
          package_type: box
          height: '4.0'
          width: '2.0'
          length: '2.0'
          distance_unit: in
          empty_weight: null
          weight: '0.0'
          weight_unit: lb
          default_package: false
          name: Example Package
          carrier: null
    ShippingPackageParametersUpdate:
      type: object
      title: Packages
      description: Packages
      required: []
      properties:
        package_type:
          type: string
          description: Package Type
          enum:
          - box
          - envelope
          - soft_package
        height:
          type: number
          description: Height
        width:
          type: number
          description: Width
        length:
          type: number
          description: Length
        distance_unit:
          type: string
          description: Distance Unit
        empty_weight:
          type:
          - string
          - 'null'
          description: Empty Weight
        weight:
          type:
          - number
          - 'null'
          description: Weight
        weight_unit:
          type:
          - string
          - 'null'
          enum:
          - lb
          - kg
          - g
          - oz
          - null
          description: Weight Unit
        default_package:
          type:
          - boolean
          - 'null'
          description: Default Package
        name:
          type: string
          description: Name
        carrier:
          type:
          - string
          - 'null'
          enum:
          - fedex
          - ups
          - usps
          - null
          description: Carrier
      example:
        shipping_package:
          package_type: box
          height: '4.0'
          width: '2.0'
          length: '2.0'
          distance_unit: in
          empty_weight: null
          weight: '0.0'
          weight_unit: lb
          default_package: false
          name: Example Package
          carrier: null
  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