openapi: 3.2.0
info:
  title: ClickFunnels Fulfillments::Location 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: Fulfillments::Location
  description: Fulfillment Locations
paths:
  /workspaces/{workspace_id}/fulfillments/locations:
    get:
      tags:
      - Fulfillments::Location
      summary: List Locations
      description: List Locations
      operationId: listFulfillmentsLocations
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/sort_order'
      - 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
      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/FulfillmentsLocationAttributes'
              example:
              - id: 8
                public_id: OcTvQz
                workspace_id: 42000
                name: Example Location
                address_name: Example Address
                email_address: myemail1754939695@example.com
                phone_number: (123)-555-4567
                sort_order: 1
                archived: false
                external_app: true
                created_at: null
                updated_at: null
                address:
                  address_one: 3443 W. Bavaria St.
                  address_two: Suite 100
                  city: Eagle
                  region: Idaho
                  country: US
                  postal_code: '83616'
              - id: 9
                public_id: ZxWBnk
                workspace_id: 42000
                name: Example Location
                address_name: Example Address
                email_address: myemail1754939695@example.com
                phone_number: (123)-555-4567
                sort_order: 1
                archived: false
                external_app: true
                created_at: null
                updated_at: null
                address:
                  address_one: 3443 W. Bavaria St.
                  address_two: Suite 100
                  city: Eagle
                  region: Idaho
                  country: US
                  postal_code: '83616'
        '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:
      - Fulfillments::Location
      summary: Create Location
      description: Create Location
      operationId: createFulfillmentsLocations
      parameters:
      - name: workspace_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Location
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                fulfillments_location:
                  type: object
                  $ref: '#/components/schemas/FulfillmentsLocationParameters'
            example:
              fulfillments_location:
                name: Example Location
                address_name: Example Address
                email_address: myemail1754939677@example.com
                phone_number: (123)-555-4567
                archived: false
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FulfillmentsLocationAttributes'
              example:
                id: 11
                public_id: nKBJXf
                workspace_id: 42000
                name: Example Location
                address_name: Example Address
                email_address: myemail1754939695@example.com
                phone_number: (123)-555-4567
                sort_order: 1
                archived: false
                external_app: true
                created_at: null
                updated_at: null
                address:
                  address_one: 3443 W. Bavaria St.
                  address_two: Suite 100
                  city: Eagle
                  region: Idaho
                  country: US
                  postal_code: '83616'
        '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
  /fulfillments/locations/{id}:
    get:
      tags:
      - Fulfillments::Location
      summary: Fetch Location
      description: Fetch Location
      operationId: getFulfillmentsLocations
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FulfillmentsLocationAttributes'
              example:
                id: 10
                public_id: TfWGdk
                workspace_id: 42000
                name: Example Location
                address_name: Example Address
                email_address: myemail1754939695@example.com
                phone_number: (123)-555-4567
                sort_order: 1
                archived: false
                external_app: true
                created_at: null
                updated_at: null
                address:
                  address_one: 3443 W. Bavaria St.
                  address_two: Suite 100
                  city: Eagle
                  region: Idaho
                  country: US
                  postal_code: '83616'
        '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:
      - Fulfillments::Location
      summary: Update Location
      description: Update Location
      operationId: updateFulfillmentsLocations
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Information about updated fields in Location
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                fulfillments_location:
                  type: object
                  $ref: '#/components/schemas/FulfillmentsLocationParametersUpdate'
            example:
              fulfillments_location:
                name: Example Location
                address_name: Example Address
                email_address: myemail@example.com
                phone_number: (123)-555-4567
                archived: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FulfillmentsLocationAttributes'
              example:
                id: 13
                public_id: oAyPCr
                workspace_id: 42000
                name: Example Location
                address_name: Example Address
                email_address: myemail1754939695@example.com
                phone_number: (123)-555-4567
                sort_order: 1
                archived: false
                external_app: true
                created_at: null
                updated_at: null
                address:
                  address_one: 3443 W. Bavaria St.
                  address_two: Suite 100
                  city: Eagle
                  region: Idaho
                  country: US
                  postal_code: '83616'
        '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:
      - Fulfillments::Location
      summary: Remove Location
      description: Remove Location
      operationId: removeFulfillmentsLocations
      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_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:
    FulfillmentsLocationParametersUpdate:
      type: object
      title: Locations
      description: Locations
      required: []
      properties:
        name:
          type: string
          description: Location name
        address_name:
          type: string
          description: Address name
        email_address:
          type: string
          description: Email address
        phone_number:
          type:
          - string
          - 'null'
          description: Phone number
        archived:
          type: boolean
          default: false
          description: Indicates if the location is archived
        external_app:
          type: boolean
          description: Indicates a location managed by an external integration. Only to be used for requests made with Oauth 2.0 access tokens. External app locations do not need to provide an address.
        address:
          type: object
          properties:
            address_one:
              type: string
              description: The first line of the address
            address_two:
              type: string
              description: The second line of the address
            city:
              type: string
              description: The city
            region:
              type: string
              description: The state or province
            country:
              type: string
              description: The country (ISO2 code)
            postal_code:
              type: string
              description: The postal code
      example:
        fulfillments_location:
          name: Example Location
          address_name: Example Address
          email_address: myemail@example.com
          phone_number: (123)-555-4567
          archived: false
    FulfillmentsLocationParameters:
      type: object
      title: Locations
      description: Locations
      required:
      - name
      - address_name
      - email_address
      properties:
        name:
          type: string
          description: Location name
        address_name:
          type: string
          description: Address name
        email_address:
          type: string
          description: Email address
        phone_number:
          type:
          - string
          - 'null'
          description: Phone number
        archived:
          type: boolean
          default: false
          description: Indicates if the location is archived
        external_app:
          type: boolean
          description: Indicates a location managed by an external integration. Only to be used for requests made with Oauth 2.0 access tokens. External app locations do not need to provide an address.
        address:
          type: object
          properties:
            address_one:
              type: string
              description: The first line of the address
            address_two:
              type: string
              description: The second line of the address
            city:
              type: string
              description: The city
            region:
              type: string
              description: The state or province
            country:
              type: string
              description: The country (ISO2 code)
            postal_code:
              type: string
              description: The postal code
      example:
        fulfillments_location:
          name: Example Location
          address_name: Example Address
          email_address: myemail1754939677@example.com
          phone_number: (123)-555-4567
          archived: false
    FulfillmentsLocationAttributes:
      type: object
      title: Locations
      description: Locations
      properties:
        id:
          type: integer
          description: Location ID
        public_id:
          type:
          - string
          - 'null'
          description: Public ID
        workspace_id:
          type: integer
          description: Workspace ID
        name:
          type: string
          description: Location name
        address_name:
          type: string
          description: Address name
        email_address:
          type: string
          description: Email address
        phone_number:
          type:
          - string
          - 'null'
          description: Phone number
        sort_order:
          type:
          - integer
          - 'null'
          description: Sort order
        archived:
          type: boolean
          description: Indicates if the location is archived
        external_app:
          type:
          - boolean
          - 'null'
          description: External app
        created_at:
          type:
          - string
          - 'null'
          description: Added
        updated_at:
          type:
          - string
          - 'null'
          description: Updated
        address:
          type: object
          title: Locations
          description: Locations
          properties:
            address_one:
              type:
              - string
              - 'null'
              description: Address line 1
            address_two:
              type:
              - string
              - 'null'
              description: Address line 2
            city:
              type:
              - string
              - 'null'
              description: City
            region:
              type:
              - string
              - 'null'
              description: Region
            country:
              type:
              - string
              - 'null'
              description: Country
            postal_code:
              type:
              - string
              - 'null'
              description: Postal code
      example:
        id: 2
        public_id: jEvMrK
        workspace_id: 42000
        name: Example Location
        address_name: Example Address
        email_address: myemail1754939677@example.com
        phone_number: (123)-555-4567
        sort_order: 1
        archived: false
        external_app: true
        created_at: null
        updated_at: null
        address:
          address_one: 3443 W. Bavaria St.
          address_two: Suite 100
          city: Eagle
          region: Idaho
          country: US
          postal_code: '83616'
      required:
      - address
      - address_name
      - archived
      - created_at
      - email_address
      - external_app
      - id
      - name
      - phone_number
      - public_id
      - sort_order
      - updated_at
      - workspace_id
  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