Staples Advantage eProcurement API — Orders

naftiko: 1.0.0-alpha2
info:
  label: Staples Advantage eProcurement API — Orders
  description: 'Staples Advantage eProcurement API — Orders. 3 operations. Lead operation: List Orders. Self-contained Naftiko
    capability covering one Staples business surface.'
  tags:
  - Staples
  - Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STAPLES_API_KEY: STAPLES_API_KEY
capability:
  consumes:
  - type: http
    namespace: advantage-eprocurement-orders
    baseUri: https://api.staplesadvantage.com
    description: Staples Advantage eProcurement API — Orders business capability. Self-contained, no shared references.
    resources:
    - name: v1-orders
      path: /v1/orders
      operations:
      - name: listorders
        method: GET
        description: List Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter by order status
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: costCenter
          in: query
          type: string
          description: Filter by cost center code
        - name: limit
          in: query
          type: integer
      - name: createorder
        method: POST
        description: Create Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-orders-orderId
      path: /v1/orders/{orderId}
      operations:
      - name: getorder
        method: GET
        description: Get Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orderId
          in: path
          type: string
          description: The unique identifier of the order
          required: true
    authentication:
      type: bearer
      token: '{{env.STAPLES_API_KEY}}'
  exposes:
  - type: rest
    namespace: advantage-eprocurement-orders-rest
    port: 8080
    description: REST adapter for Staples Advantage eProcurement API — Orders. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/orders
      name: v1-orders
      description: REST surface for v1-orders.
      operations:
      - method: GET
        name: listorders
        description: List Orders
        call: advantage-eprocurement-orders.listorders
        with:
          status: rest.status
          startDate: rest.startDate
          endDate: rest.endDate
          costCenter: rest.costCenter
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createorder
        description: Create Order
        call: advantage-eprocurement-orders.createorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/orders/{orderid}
      name: v1-orders-orderid
      description: REST surface for v1-orders-orderId.
      operations:
      - method: GET
        name: getorder
        description: Get Order
        call: advantage-eprocurement-orders.getorder
        with:
          orderId: rest.orderId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: advantage-eprocurement-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for Staples Advantage eProcurement 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: advantage-eprocurement-orders.listorders
      with:
        status: tools.status
        startDate: tools.startDate
        endDate: tools.endDate
        costCenter: tools.costCenter
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: create-order
      description: Create Order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: advantage-eprocurement-orders.createorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-order
      description: Get Order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: advantage-eprocurement-orders.getorder
      with:
        orderId: tools.orderId
      outputParameters:
      - type: object
        mapping: $.