Sitecore OrderCloud API — Buyers

naftiko: 1.0.0-alpha2
info:
  label: Sitecore OrderCloud API — Buyers
  description: 'Sitecore OrderCloud API — Buyers. 5 operations. Lead operation: List buyers. Self-contained Naftiko capability
    covering one Sitecore business surface.'
  tags:
  - Sitecore
  - Buyers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SITECORE_API_KEY: SITECORE_API_KEY
capability:
  consumes:
  - type: http
    namespace: ordercloud-buyers
    baseUri: https://api.ordercloud.io/v1
    description: Sitecore OrderCloud API — Buyers business capability. Self-contained, no shared references.
    resources:
    - name: buyers
      path: /buyers
      operations:
      - name: listbuyers
        method: GET
        description: List buyers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createbuyer
        method: POST
        description: Create a buyer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: buyers-buyerID
      path: /buyers/{buyerID}
      operations:
      - name: getbuyer
        method: GET
        description: Get a buyer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatebuyer
        method: PUT
        description: Update a buyer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletebuyer
        method: DELETE
        description: Delete a buyer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SITECORE_API_KEY}}'
  exposes:
  - type: rest
    namespace: ordercloud-buyers-rest
    port: 8080
    description: REST adapter for Sitecore OrderCloud API — Buyers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/buyers
      name: buyers
      description: REST surface for buyers.
      operations:
      - method: GET
        name: listbuyers
        description: List buyers
        call: ordercloud-buyers.listbuyers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createbuyer
        description: Create a buyer
        call: ordercloud-buyers.createbuyer
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/buyers/{buyerid}
      name: buyers-buyerid
      description: REST surface for buyers-buyerID.
      operations:
      - method: GET
        name: getbuyer
        description: Get a buyer
        call: ordercloud-buyers.getbuyer
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatebuyer
        description: Update a buyer
        call: ordercloud-buyers.updatebuyer
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletebuyer
        description: Delete a buyer
        call: ordercloud-buyers.deletebuyer
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ordercloud-buyers-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sitecore OrderCloud API — Buyers. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-buyers
      description: List buyers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ordercloud-buyers.listbuyers
      outputParameters:
      - type: object
        mapping: $.
    - name: create-buyer
      description: Create a buyer
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ordercloud-buyers.createbuyer
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-buyer
      description: Get a buyer
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ordercloud-buyers.getbuyer
      outputParameters:
      - type: object
        mapping: $.
    - name: update-buyer
      description: Update a buyer
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ordercloud-buyers.updatebuyer
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-buyer
      description: Delete a buyer
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ordercloud-buyers.deletebuyer
      outputParameters:
      - type: object
        mapping: $.