Magento REST API — Customers

naftiko: 1.0.0-alpha2
info:
  label: Magento REST API — Customers
  description: 'Magento REST API — Customers. 5 operations. Lead operation: Create a customer. Self-contained Naftiko capability
    covering one Magento business surface.'
  tags:
  - Magento
  - Customers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MAGENTO_API_KEY: MAGENTO_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-customers
    baseUri: https://{store_domain}/rest/{store_code}
    description: Magento REST API — Customers business capability. Self-contained, no shared references.
    resources:
    - name: V1-customers
      path: /V1/customers
      operations:
      - name: createcustomer
        method: POST
        description: Create a customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: V1-customers-search
      path: /V1/customers/search
      operations:
      - name: searchcustomers
        method: GET
        description: Search customers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: V1-customers-customerId
      path: /V1/customers/{customerId}
      operations:
      - name: getcustomer
        method: GET
        description: Get customer by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecustomer
        method: PUT
        description: Update a customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecustomer
        method: DELETE
        description: Delete a customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.MAGENTO_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-customers-rest
    port: 8080
    description: REST adapter for Magento REST API — Customers. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/customers
      name: v1-customers
      description: REST surface for V1-customers.
      operations:
      - method: POST
        name: createcustomer
        description: Create a customer
        call: rest-customers.createcustomer
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/customers/search
      name: v1-customers-search
      description: REST surface for V1-customers-search.
      operations:
      - method: GET
        name: searchcustomers
        description: Search customers
        call: rest-customers.searchcustomers
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/customers/{customerid}
      name: v1-customers-customerid
      description: REST surface for V1-customers-customerId.
      operations:
      - method: GET
        name: getcustomer
        description: Get customer by ID
        call: rest-customers.getcustomer
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecustomer
        description: Update a customer
        call: rest-customers.updatecustomer
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecustomer
        description: Delete a customer
        call: rest-customers.deletecustomer
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-customers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Magento REST API — Customers. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-customer
      description: Create a customer
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-customers.createcustomer
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: search-customers
      description: Search customers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-customers.searchcustomers
      outputParameters:
      - type: object
        mapping: $.
    - name: get-customer-id
      description: Get customer by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-customers.getcustomer
      outputParameters:
      - type: object
        mapping: $.
    - name: update-customer
      description: Update a customer
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-customers.updatecustomer
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-customer
      description: Delete a customer
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-customers.deletecustomer
      outputParameters:
      - type: object
        mapping: $.