Klarna · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klarna Order Management Refunds API

3 actions 3 updates phrasing extends openapi/klarna-refunds-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Klarna's API. It is a proposal applied on top of the contract, not a document Klarna publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/ordermanagement/v1/orders/{order_id}/refunds'].post

$.paths['/ordermanagement/v1/orders/{order_id}/refunds/{refund_id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Klarna Order Management Refunds API
  version: 1.0.0
extends: openapi/klarna-refunds-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/ordermanagement/v1/orders/{order_id}/refunds'].post
  update:
    x-apievangelist-phrasing:
      intent: Refund an order
      effect: write
      questions:
      - How do I refund a customer for a captured order?
      - Can I refund just part of an order and specify which lines are returned?
      instructions:
      - text: Refund {refunded_amount} on order {order_id}.
        slots:
          refunded_amount: requestBody.refunded_amount
          order_id: path.order_id
      - text: Refund {refunded_amount} of order {order_id} with reference {reference}.
        slots:
          refunded_amount: requestBody.refunded_amount
          order_id: path.order_id
          reference: requestBody.reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/refunds/{refund_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a refund's details
      effect: read
      questions:
      - Can I check the amount and lines of a refund I already issued?
      - Where do I see a specific refund on an order?
      instructions:
      - text: Get refund {refund_id} on order {order_id}.
        slots:
          refund_id: path.refund_id
          order_id: path.order_id
      - text: Show the details of refund {refund_id} for order {order_id}.
        slots:
          refund_id: path.refund_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'