Magento REST API — Shipments

naftiko: 1.0.0-alpha2
info:
  label: Magento REST API — Shipments
  description: 'Magento REST API — Shipments. 2 operations. Lead operation: Create a shipment. Self-contained Naftiko capability
    covering one Magento business surface.'
  tags:
  - Magento
  - Shipments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MAGENTO_API_KEY: MAGENTO_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-shipments
    baseUri: https://{store_domain}/rest/{store_code}
    description: Magento REST API — Shipments business capability. Self-contained, no shared references.
    resources:
    - name: V1-shipment
      path: /V1/shipment
      operations:
      - name: createshipment
        method: POST
        description: Create a shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: V1-shipment-shipmentId
      path: /V1/shipment/{shipmentId}
      operations:
      - name: getshipment
        method: GET
        description: Get shipment by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.MAGENTO_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-shipments-rest
    port: 8080
    description: REST adapter for Magento REST API — Shipments. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/shipment
      name: v1-shipment
      description: REST surface for V1-shipment.
      operations:
      - method: POST
        name: createshipment
        description: Create a shipment
        call: rest-shipments.createshipment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/shipment/{shipmentid}
      name: v1-shipment-shipmentid
      description: REST surface for V1-shipment-shipmentId.
      operations:
      - method: GET
        name: getshipment
        description: Get shipment by ID
        call: rest-shipments.getshipment
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-shipments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Magento REST API — Shipments. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-shipment
      description: Create a shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-shipments.createshipment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment-id
      description: Get shipment by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-shipments.getshipment
      outputParameters:
      - type: object
        mapping: $.