BigCommerce Customers V3 — Addresses

naftiko: 1.0.0-alpha2
info:
  label: BigCommerce Customers V3 — Addresses
  description: 'BigCommerce Customers V3 — Addresses. 4 operations. Lead operation: BigCommerce Get All Customer Addresses.
    Self-contained Naftiko capability covering one Bigcommerce business surface.'
  tags:
  - Bigcommerce
  - Addresses
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BIGCOMMERCE_API_KEY: BIGCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: customers-addresses
    baseUri: https://api.bigcommerce.com/stores/{store_hash}/v3
    description: BigCommerce Customers V3 — Addresses business capability. Self-contained, no shared references.
    resources:
    - name: customers-addresses
      path: /customers/addresses
      operations:
      - name: getcustomersaddresses
        method: GET
        description: BigCommerce Get All Customer Addresses
        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: company:in
          in: query
          type: array
          description: Filter items by company. `company:in=bigcommerce,commongood`
        - name: name:in
          in: query
          type: array
          description: Filter items by first_name and last_name. `name:in=James+Moriarty`
        - name: customer_id:in
          in: query
          type: array
          description: Filter by the ID of the customer. Also accepts comma-separated IDs to filter for multiple customers.
            `customer_id:in=23,24,55`
        - name: include
          in: query
          type: string
          description: 'Indicates whether to include customer address sub-resources:'
        - name: id:in
          in: query
          type: array
          description: Filter items by ID.
      - name: createcustomersaddresses
        method: POST
        description: BigCommerce Create a Customer Address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Accept
          in: header
          type: string
        - name: Content-Type
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updatecustomersaddresses
        method: PUT
        description: BigCommerce Update a Customer Address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Accept
          in: header
          type: string
        - name: Content-Type
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecustomersaddresses
        method: DELETE
        description: BigCommerce Delete a Customer Address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Accept
          in: header
          type: string
        - name: Content-Type
          in: header
          type: string
        - name: id:in
          in: query
          type: array
          description: Filter items by ID.
          required: true
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.BIGCOMMERCE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: customers-addresses-rest
    port: 8080
    description: REST adapter for BigCommerce Customers V3 — Addresses. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/customers/addresses
      name: customers-addresses
      description: REST surface for customers-addresses.
      operations:
      - method: GET
        name: getcustomersaddresses
        description: BigCommerce Get All Customer Addresses
        call: customers-addresses.getcustomersaddresses
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          page: rest.page
          limit: rest.limit
          company:in: rest.company:in
          name:in: rest.name:in
          customer_id:in: rest.customer_id:in
          include: rest.include
          id:in: rest.id:in
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcustomersaddresses
        description: BigCommerce Create a Customer Address
        call: customers-addresses.createcustomersaddresses
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecustomersaddresses
        description: BigCommerce Update a Customer Address
        call: customers-addresses.updatecustomersaddresses
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecustomersaddresses
        description: BigCommerce Delete a Customer Address
        call: customers-addresses.deletecustomersaddresses
        with:
          Accept: rest.Accept
          Content-Type: rest.Content-Type
          id:in: rest.id:in
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: customers-addresses-mcp
    port: 9090
    transport: http
    description: MCP adapter for BigCommerce Customers V3 — Addresses. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: bigcommerce-get-all-customer-addresses
      description: BigCommerce Get All Customer Addresses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: customers-addresses.getcustomersaddresses
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        page: tools.page
        limit: tools.limit
        company:in: tools.company:in
        name:in: tools.name:in
        customer_id:in: tools.customer_id:in
        include: tools.include
        id:in: tools.id:in
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-create-customer-address
      description: BigCommerce Create a Customer Address
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: customers-addresses.createcustomersaddresses
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-update-customer-address
      description: BigCommerce Update a Customer Address
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: customers-addresses.updatecustomersaddresses
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-customer-address
      description: BigCommerce Delete a Customer Address
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: customers-addresses.deletecustomersaddresses
      with:
        Accept: tools.Accept
        Content-Type: tools.Content-Type
        id:in: tools.id:in
      outputParameters:
      - type: object
        mapping: $.