ClickPost API — Order

naftiko: 1.0.0-alpha2
info:
  label: ClickPost API — Order
  description: 'ClickPost API — Order. 3 operations. Lead operation: Create a single-parcel order. Self-contained Naftiko
    capability covering one Clickpost business surface.'
  tags:
  - Clickpost
  - Order
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CLICKPOST_API_KEY: CLICKPOST_API_KEY
capability:
  consumes:
  - type: http
    namespace: clickpost-order
    baseUri: https://www.clickpost.in/api/v1
    description: ClickPost API — Order business capability. Self-contained, no shared references.
    resources:
    - name: order
      path: /order
      operations:
      - name: createorder
        method: POST
        description: Create a single-parcel order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: order-mps
      path: /order/mps
      operations:
      - name: creatempsorder
        method: POST
        description: Create a multi-parcel order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: order-order_id
      path: /order/{order_id}
      operations:
      - name: getorder
        method: GET
        description: Get order details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: order_id
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: key
      value: '{{env.CLICKPOST_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: clickpost-order-rest
    port: 8080
    description: REST adapter for ClickPost API — Order. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/order
      name: order
      description: REST surface for order.
      operations:
      - method: POST
        name: createorder
        description: Create a single-parcel order
        call: clickpost-order.createorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/order/mps
      name: order-mps
      description: REST surface for order-mps.
      operations:
      - method: POST
        name: creatempsorder
        description: Create a multi-parcel order
        call: clickpost-order.creatempsorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/order/{order-id}
      name: order-order-id
      description: REST surface for order-order_id.
      operations:
      - method: GET
        name: getorder
        description: Get order details
        call: clickpost-order.getorder
        with:
          order_id: rest.order_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: clickpost-order-mcp
    port: 9090
    transport: http
    description: MCP adapter for ClickPost API — Order. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: create-single-parcel-order
      description: Create a single-parcel order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: clickpost-order.createorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-multi-parcel-order
      description: Create a multi-parcel order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: clickpost-order.creatempsorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-order-details
      description: Get order details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: clickpost-order.getorder
      with:
        order_id: tools.order_id
      outputParameters:
      - type: object
        mapping: $.