UPS Shipping API — Pickup

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