Trabex Trade Compliance API — Shipments

naftiko: 1.0.0-alpha2
info:
  label: Trabex Trade Compliance API — Shipments
  description: 'Trabex Trade Compliance API — Shipments. 4 operations. Lead operation: Get Shipments. Self-contained Naftiko
    capability covering one Trabex business surface.'
  tags:
  - Trabex
  - Shipments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TRABEX_API_KEY: TRABEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: trade-compliance-shipments
    baseUri: https://api.trabex.io
    description: Trabex Trade Compliance API — Shipments business capability. Self-contained, no shared references.
    resources:
    - name: v1-shipments
      path: /v1/shipments
      operations:
      - name: getshipments
        method: GET
        description: Get Shipments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter by shipment compliance status.
        - name: page
          in: query
          type: integer
          description: Page number for paginated results.
        - name: pageSize
          in: query
          type: integer
          description: Number of records per page.
        - name: fromDate
          in: query
          type: string
          description: Filter shipments created on or after this date (ISO 8601).
        - name: toDate
          in: query
          type: string
          description: Filter shipments created on or before this date (ISO 8601).
      - name: createshipment
        method: POST
        description: Create Shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-shipments-shipmentId
      path: /v1/shipments/{shipmentId}
      operations:
      - name: getshipment
        method: GET
        description: Get Shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateshipment
        method: PUT
        description: Update Shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-API-Key
      value: '{{env.TRABEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: trade-compliance-shipments-rest
    port: 8080
    description: REST adapter for Trabex Trade Compliance API — Shipments. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/shipments
      name: v1-shipments
      description: REST surface for v1-shipments.
      operations:
      - method: GET
        name: getshipments
        description: Get Shipments
        call: trade-compliance-shipments.getshipments
        with:
          status: rest.status
          page: rest.page
          pageSize: rest.pageSize
          fromDate: rest.fromDate
          toDate: rest.toDate
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createshipment
        description: Create Shipment
        call: trade-compliance-shipments.createshipment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/shipments/{shipmentid}
      name: v1-shipments-shipmentid
      description: REST surface for v1-shipments-shipmentId.
      operations:
      - method: GET
        name: getshipment
        description: Get Shipment
        call: trade-compliance-shipments.getshipment
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateshipment
        description: Update Shipment
        call: trade-compliance-shipments.updateshipment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: trade-compliance-shipments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Trabex Trade Compliance API — Shipments. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-shipments
      description: Get Shipments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: trade-compliance-shipments.getshipments
      with:
        status: tools.status
        page: tools.page
        pageSize: tools.pageSize
        fromDate: tools.fromDate
        toDate: tools.toDate
      outputParameters:
      - type: object
        mapping: $.
    - name: create-shipment
      description: Create Shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: trade-compliance-shipments.createshipment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment
      description: Get Shipment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: trade-compliance-shipments.getshipment
      outputParameters:
      - type: object
        mapping: $.
    - name: update-shipment
      description: Update Shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: trade-compliance-shipments.updateshipment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.