Pitney Bowes Shipping API — Pickups

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