BigCommerce Customers V3 — Form Field Values

naftiko: 1.0.0-alpha2
info:
  label: BigCommerce Customers V3 — Form Field Values
  description: 'BigCommerce Customers V3 — Form Field Values. 2 operations. Lead operation: BigCommerce Get Customer Form
    Field Values. Self-contained Naftiko capability covering one Bigcommerce business surface.'
  tags:
  - Bigcommerce
  - Form Field Values
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BIGCOMMERCE_API_KEY: BIGCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: customers-form-field-values
    baseUri: https://api.bigcommerce.com/stores/{store_hash}/v3
    description: BigCommerce Customers V3 — Form Field Values business capability. Self-contained, no shared references.
    resources:
    - name: customers-form-field-values
      path: /customers/form-field-values
      operations:
      - name: getcustomersformfieldvalues
        method: GET
        description: BigCommerce Get Customer Form Field Values
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Accept
          in: header
          type: string
        - name: Content-Type
          in: header
          type: string
        - name: page
          in: query
          type: integer
          description: Page number. `page=1`
        - name: limit
          in: query
          type: number
          description: Items count per page. `limit=50`
        - name: customer_id
          in: query
          type: integer
          description: Filter by the customer ID.
        - name: address_id
          in: query
          type: integer
          description: Filter by the ID of the customer address.
        - name: field_name
          in: query
          type: string
          description: Filter by the field name.
        - name: field_type
          in: query
          type: string
          description: Filter by the field type.
      - name: updatecustomerformfieldvalues
        method: PUT
        description: BigCommerce Upsert Customer Form Field Values
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.BIGCOMMERCE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: customers-form-field-values-rest
    port: 8080
    description: REST adapter for BigCommerce Customers V3 — Form Field Values. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/customers/form-field-values
      name: customers-form-field-values
      description: REST surface for customers-form-field-values.
      operations:
      - method: GET
        name: getcustomersformfieldvalues
        description: BigCommerce Get Customer Form Field Values
        call: customers-form-field-values.getcustomersformfieldvalues
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          page: rest.page
          limit: rest.limit
          customer_id: rest.customer_id
          address_id: rest.address_id
          field_name: rest.field_name
          field_type: rest.field_type
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecustomerformfieldvalues
        description: BigCommerce Upsert Customer Form Field Values
        call: customers-form-field-values.updatecustomerformfieldvalues
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: customers-form-field-values-mcp
    port: 9090
    transport: http
    description: MCP adapter for BigCommerce Customers V3 — Form Field Values. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: bigcommerce-get-customer-form-field
      description: BigCommerce Get Customer Form Field Values
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: customers-form-field-values.getcustomersformfieldvalues
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        page: tools.page
        limit: tools.limit
        customer_id: tools.customer_id
        address_id: tools.address_id
        field_name: tools.field_name
        field_type: tools.field_type
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-upsert-customer-form-field
      description: BigCommerce Upsert Customer Form Field Values
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: customers-form-field-values.updatecustomerformfieldvalues
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.