UPS Shipping API — Paperless Documents

naftiko: 1.0.0-alpha2
info:
  label: UPS Shipping API — Paperless Documents
  description: 'UPS Shipping API — Paperless Documents. 1 operations. Lead operation: Upload Paperless Document. Self-contained
    Naftiko capability covering one Ups business surface.'
  tags:
  - Ups
  - Paperless Documents
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UPS_API_KEY: UPS_API_KEY
capability:
  consumes:
  - type: http
    namespace: shipping-paperless-documents
    baseUri: https://onlinetools.ups.com/api
    description: UPS Shipping API — Paperless Documents business capability. Self-contained, no shared references.
    resources:
    - name: paperlessdocuments-v1-upload-shipperNumber
      path: /paperlessdocuments/v1/upload/{shipperNumber}
      operations:
      - name: uploadpaperlessdocument
        method: POST
        description: Upload Paperless Document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: shipperNumber
          in: path
          type: string
          description: UPS account (shipper) number
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.UPS_API_KEY}}'
  exposes:
  - type: rest
    namespace: shipping-paperless-documents-rest
    port: 8080
    description: REST adapter for UPS Shipping API — Paperless Documents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/paperlessdocuments/v1/upload/{shippernumber}
      name: paperlessdocuments-v1-upload-shippernumber
      description: REST surface for paperlessdocuments-v1-upload-shipperNumber.
      operations:
      - method: POST
        name: uploadpaperlessdocument
        description: Upload Paperless Document
        call: shipping-paperless-documents.uploadpaperlessdocument
        with:
          shipperNumber: rest.shipperNumber
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shipping-paperless-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for UPS Shipping API — Paperless Documents. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: upload-paperless-document
      description: Upload Paperless Document
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shipping-paperless-documents.uploadpaperlessdocument
      with:
        shipperNumber: tools.shipperNumber
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.