Shopify Admin REST API — Customers

naftiko: 1.0.0-alpha2
info:
  label: Shopify Admin REST API — Customers
  description: 'Shopify Admin REST API — Customers. 4 operations. Lead operation: List Customers. Self-contained Naftiko capability
    covering one Shopify Admin business surface.'
  tags:
  - Shopify Admin
  - Customers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHOPIFY_ADMIN_API_KEY: SHOPIFY_ADMIN_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-customers
    baseUri: https://{store_name}.myshopify.com/admin/api/2024-10
    description: Shopify Admin REST API — Customers business capability. Self-contained, no shared references.
    resources:
    - name: customers.json
      path: /customers.json
      operations:
      - name: listcustomers
        method: GET
        description: List Customers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: The maximum number of results to show
        - name: email
          in: query
          type: string
          description: Filter customers by email address
      - name: createcustomer
        method: POST
        description: Create Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: customers-customer_id}.json
      path: /customers/{customer_id}.json
      operations:
      - name: getcustomer
        method: GET
        description: Get Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer_id
          in: path
          type: integer
          description: The ID of the customer
          required: true
      - name: updatecustomer
        method: PUT
        description: Update Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customer_id
          in: path
          type: integer
          description: The ID of the customer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-Shopify-Access-Token
      value: '{{env.SHOPIFY_ADMIN_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-customers-rest
    port: 8080
    description: REST adapter for Shopify Admin REST API — Customers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/customers-json
      name: customers-json
      description: REST surface for customers.json.
      operations:
      - method: GET
        name: listcustomers
        description: List Customers
        call: rest-customers.listcustomers
        with:
          limit: rest.limit
          email: rest.email
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcustomer
        description: Create Customer
        call: rest-customers.createcustomer
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/customers/customer-id-json
      name: customers-customer-id-json
      description: REST surface for customers-customer_id}.json.
      operations:
      - method: GET
        name: getcustomer
        description: Get Customer
        call: rest-customers.getcustomer
        with:
          customer_id: rest.customer_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecustomer
        description: Update Customer
        call: rest-customers.updatecustomer
        with:
          customer_id: rest.customer_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-customers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shopify Admin REST API — Customers. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-customers
      description: List Customers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-customers.listcustomers
      with:
        limit: tools.limit
        email: tools.email
      outputParameters:
      - type: object
        mapping: $.
    - name: create-customer
      description: Create Customer
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-customers.createcustomer
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-customer
      description: Get Customer
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-customers.getcustomer
      with:
        customer_id: tools.customer_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-customer
      description: Update Customer
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-customers.updatecustomer
      with:
        customer_id: tools.customer_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.