Staples Advantage eProcurement API — Catalog

naftiko: 1.0.0-alpha2
info:
  label: Staples Advantage eProcurement API — Catalog
  description: 'Staples Advantage eProcurement API — Catalog. 3 operations. Lead operation: List Categories. Self-contained
    Naftiko capability covering one Staples business surface.'
  tags:
  - Staples
  - Catalog
  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-catalog
    baseUri: https://api.staplesadvantage.com
    description: Staples Advantage eProcurement API — Catalog business capability. Self-contained, no shared references.
    resources:
    - name: v1-catalog-categories
      path: /v1/catalog/categories
      operations:
      - name: listcategories
        method: GET
        description: List Categories
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v1-catalog-products-sku
      path: /v1/catalog/products/{sku}
      operations:
      - name: getproduct
        method: GET
        description: Get Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: sku
          in: path
          type: string
          description: The product SKU identifier
          required: true
    - name: v1-catalog-search
      path: /v1/catalog/search
      operations:
      - name: searchproducts
        method: GET
        description: Search Products
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: q
          in: query
          type: string
          description: Search query string
          required: true
        - name: category
          in: query
          type: string
          description: Filter by product category
        - name: brand
          in: query
          type: string
          description: Filter by brand name
        - name: inStock
          in: query
          type: boolean
          description: Filter to in-stock items only
        - name: limit
          in: query
          type: integer
        - name: offset
          in: query
          type: integer
    authentication:
      type: bearer
      token: '{{env.STAPLES_API_KEY}}'
  exposes:
  - type: rest
    namespace: advantage-eprocurement-catalog-rest
    port: 8080
    description: REST adapter for Staples Advantage eProcurement API — Catalog. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/catalog/categories
      name: v1-catalog-categories
      description: REST surface for v1-catalog-categories.
      operations:
      - method: GET
        name: listcategories
        description: List Categories
        call: advantage-eprocurement-catalog.listcategories
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/catalog/products/{sku}
      name: v1-catalog-products-sku
      description: REST surface for v1-catalog-products-sku.
      operations:
      - method: GET
        name: getproduct
        description: Get Product
        call: advantage-eprocurement-catalog.getproduct
        with:
          sku: rest.sku
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/catalog/search
      name: v1-catalog-search
      description: REST surface for v1-catalog-search.
      operations:
      - method: GET
        name: searchproducts
        description: Search Products
        call: advantage-eprocurement-catalog.searchproducts
        with:
          q: rest.q
          category: rest.category
          brand: rest.brand
          inStock: rest.inStock
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: advantage-eprocurement-catalog-mcp
    port: 9090
    transport: http
    description: MCP adapter for Staples Advantage eProcurement API — Catalog. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-categories
      description: List Categories
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: advantage-eprocurement-catalog.listcategories
      outputParameters:
      - type: object
        mapping: $.
    - name: get-product
      description: Get Product
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: advantage-eprocurement-catalog.getproduct
      with:
        sku: tools.sku
      outputParameters:
      - type: object
        mapping: $.
    - name: search-products
      description: Search Products
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: advantage-eprocurement-catalog.searchproducts
      with:
        q: tools.q
        category: tools.category
        brand: tools.brand
        inStock: tools.inStock
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.