Sitecore OrderCloud API — Orders

naftiko: 1.0.0-alpha2
info:
  label: Sitecore OrderCloud API — Orders
  description: 'Sitecore OrderCloud API — Orders. 8 operations. Lead operation: List orders. Self-contained Naftiko capability
    covering one Sitecore business surface.'
  tags:
  - Sitecore
  - Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SITECORE_API_KEY: SITECORE_API_KEY
capability:
  consumes:
  - type: http
    namespace: ordercloud-orders
    baseUri: https://api.ordercloud.io/v1
    description: Sitecore OrderCloud API — Orders business capability. Self-contained, no shared references.
    resources:
    - name: orders-direction
      path: /orders/{direction}
      operations:
      - name: listorders
        method: GET
        description: List orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: buyerID
          in: query
          type: string
          description: Filter orders by buyer identifier
        - name: status
          in: query
          type: string
          description: Filter orders by status
      - name: createorder
        method: POST
        description: Create an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orders-direction-orderID
      path: /orders/{direction}/{orderID}
      operations:
      - name: getorder
        method: GET
        description: Get an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateorder
        method: PUT
        description: Update an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteorder
        method: DELETE
        description: Delete an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: orders-direction-orderID-lineitems
      path: /orders/{direction}/{orderID}/lineitems
      operations:
      - name: listlineitems
        method: GET
        description: List order line items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createlineitem
        method: POST
        description: Create a line item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orders-direction-orderID-submit
      path: /orders/{direction}/{orderID}/submit
      operations:
      - name: submitorder
        method: POST
        description: Submit an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SITECORE_API_KEY}}'
  exposes:
  - type: rest
    namespace: ordercloud-orders-rest
    port: 8080
    description: REST adapter for Sitecore OrderCloud API — Orders. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/orders/{direction}
      name: orders-direction
      description: REST surface for orders-direction.
      operations:
      - method: GET
        name: listorders
        description: List orders
        call: ordercloud-orders.listorders
        with:
          buyerID: rest.buyerID
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createorder
        description: Create an order
        call: ordercloud-orders.createorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/{direction}/{orderid}
      name: orders-direction-orderid
      description: REST surface for orders-direction-orderID.
      operations:
      - method: GET
        name: getorder
        description: Get an order
        call: ordercloud-orders.getorder
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateorder
        description: Update an order
        call: ordercloud-orders.updateorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteorder
        description: Delete an order
        call: ordercloud-orders.deleteorder
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/{direction}/{orderid}/lineitems
      name: orders-direction-orderid-lineitems
      description: REST surface for orders-direction-orderID-lineitems.
      operations:
      - method: GET
        name: listlineitems
        description: List order line items
        call: ordercloud-orders.listlineitems
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createlineitem
        description: Create a line item
        call: ordercloud-orders.createlineitem
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/{direction}/{orderid}/submit
      name: orders-direction-orderid-submit
      description: REST surface for orders-direction-orderID-submit.
      operations:
      - method: POST
        name: submitorder
        description: Submit an order
        call: ordercloud-orders.submitorder
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ordercloud-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sitecore OrderCloud API — Orders. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-orders
      description: List orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ordercloud-orders.listorders
      with:
        buyerID: tools.buyerID
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: create-order
      description: Create an order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ordercloud-orders.createorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-order
      description: Get an order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ordercloud-orders.getorder
      outputParameters:
      - type: object
        mapping: $.
    - name: update-order
      description: Update an order
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ordercloud-orders.updateorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-order
      description: Delete an order
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ordercloud-orders.deleteorder
      outputParameters:
      - type: object
        mapping: $.
    - name: list-order-line-items
      description: List order line items
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ordercloud-orders.listlineitems
      outputParameters:
      - type: object
        mapping: $.
    - name: create-line-item
      description: Create a line item
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ordercloud-orders.createlineitem
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: submit-order
      description: Submit an order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ordercloud-orders.submitorder
      outputParameters:
      - type: object
        mapping: $.