Unified.to API — shipment

naftiko: 1.0.0-alpha2
info:
  label: Unified.to  API — shipment
  description: 'Unified.to  API — shipment. 6 operations. Lead operation: List all shipments. Self-contained Naftiko capability
    covering one Unified To business surface.'
  tags:
  - Unified To
  - shipment
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UNIFIED_TO_API_KEY: UNIFIED_TO_API_KEY
capability:
  consumes:
  - type: http
    namespace: it-ops-shipment
    baseUri: https://api.unified.to
    description: Unified.to  API — shipment business capability. Self-contained, no shared references.
    resources:
    - name: shipping-connection_id-shipment
      path: /shipping/{connection_id}/shipment
      operations:
      - name: listshippingshipments
        method: GET
        description: List all shipments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: number
        - name: offset
          in: query
          type: number
        - name: updated_gte
          in: query
          type: string
          description: Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ
            format)
        - name: sort
          in: query
          type: string
        - name: order
          in: query
          type: string
        - name: query
          in: query
          type: string
          description: Query string to search. eg. email address or name
        - name: order_id
          in: query
          type: string
          description: The AccountingOrder ID to filter by
        - name: carrier_id
          in: query
          type: string
          description: The ShippingCarrier ID to filter by
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters:
            foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
      - name: createshippingshipment
        method: POST
        description: Create a shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters:
            foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: shipping-connection_id-shipment-id
      path: /shipping/{connection_id}/shipment/{id}
      operations:
      - name: removeshippingshipment
        method: DELETE
        description: Remove a shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Shipment
          required: true
      - name: getshippingshipment
        method: GET
        description: Retrieve a shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters:
            foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Shipment
          required: true
      - name: patchshippingshipment
        method: PATCH
        description: Update a shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters:
            foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Shipment
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updateshippingshipment
        method: PUT
        description: Update a shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: array
          description: Fields to return
        - name: raw
          in: query
          type: string
          description: 'Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters:
            foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar'
        - name: connection_id
          in: path
          type: string
          description: ID of the connection
          required: true
        - name: id
          in: path
          type: string
          description: ID of the Shipment
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: authorization
      value: '{{env.UNIFIED_TO_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: it-ops-shipment-rest
    port: 8080
    description: REST adapter for Unified.to  API — shipment. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/shipping/{connection-id}/shipment
      name: shipping-connection-id-shipment
      description: REST surface for shipping-connection_id-shipment.
      operations:
      - method: GET
        name: listshippingshipments
        description: List all shipments
        call: it-ops-shipment.listshippingshipments
        with:
          limit: rest.limit
          offset: rest.offset
          updated_gte: rest.updated_gte
          sort: rest.sort
          order: rest.order
          query: rest.query
          order_id: rest.order_id
          carrier_id: rest.carrier_id
          fields: rest.fields
          raw: rest.raw
          connection_id: rest.connection_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createshippingshipment
        description: Create a shipment
        call: it-ops-shipment.createshippingshipment
        with:
          fields: rest.fields
          raw: rest.raw
          connection_id: rest.connection_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/shipping/{connection-id}/shipment/{id}
      name: shipping-connection-id-shipment-id
      description: REST surface for shipping-connection_id-shipment-id.
      operations:
      - method: DELETE
        name: removeshippingshipment
        description: Remove a shipment
        call: it-ops-shipment.removeshippingshipment
        with:
          connection_id: rest.connection_id
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getshippingshipment
        description: Retrieve a shipment
        call: it-ops-shipment.getshippingshipment
        with:
          fields: rest.fields
          raw: rest.raw
          connection_id: rest.connection_id
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchshippingshipment
        description: Update a shipment
        call: it-ops-shipment.patchshippingshipment
        with:
          fields: rest.fields
          raw: rest.raw
          connection_id: rest.connection_id
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateshippingshipment
        description: Update a shipment
        call: it-ops-shipment.updateshippingshipment
        with:
          fields: rest.fields
          raw: rest.raw
          connection_id: rest.connection_id
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: it-ops-shipment-mcp
    port: 9090
    transport: http
    description: MCP adapter for Unified.to  API — shipment. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-all-shipments
      description: List all shipments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: it-ops-shipment.listshippingshipments
      with:
        limit: tools.limit
        offset: tools.offset
        updated_gte: tools.updated_gte
        sort: tools.sort
        order: tools.order
        query: tools.query
        order_id: tools.order_id
        carrier_id: tools.carrier_id
        fields: tools.fields
        raw: tools.raw
        connection_id: tools.connection_id
      outputParameters:
      - type: object
        mapping: $.
    - name: create-shipment
      description: Create a shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: it-ops-shipment.createshippingshipment
      with:
        fields: tools.fields
        raw: tools.raw
        connection_id: tools.connection_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: remove-shipment
      description: Remove a shipment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: it-ops-shipment.removeshippingshipment
      with:
        connection_id: tools.connection_id
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-shipment
      description: Retrieve a shipment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: it-ops-shipment.getshippingshipment
      with:
        fields: tools.fields
        raw: tools.raw
        connection_id: tools.connection_id
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-shipment
      description: Update a shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: it-ops-shipment.patchshippingshipment
      with:
        fields: tools.fields
        raw: tools.raw
        connection_id: tools.connection_id
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-shipment-2
      description: Update a shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: it-ops-shipment.updateshippingshipment
      with:
        fields: tools.fields
        raw: tools.raw
        connection_id: tools.connection_id
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.