Klarna · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klarna Order Management Orders API

10 actions 10 updates phrasing extends openapi/klarna-orders-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 10

$.info
$.paths['/ordermanagement/v1/orders/{order_id}'].get
$.paths['/ordermanagement/v1/orders/{order_id}/acknowledge'].post
$.paths['/ordermanagement/v1/orders/{order_id}/authorization'].patch
$.paths['/ordermanagement/v1/orders/{order_id}/customer-details'].patch
$.paths['/ordermanagement/v1/orders/{order_id}/extend-authorization-time'].post
$.paths['/ordermanagement/v1/orders/{order_id}/merchant-references'].patch
$.paths['/ordermanagement/v1/orders/{order_id}/release-remaining-authorization'].post
$.paths['/ordermanagement/v1/orders/{order_id}/shipping-info'].post
$.paths['/ordermanagement/v1/orders/{order_id}/cancel'].post

OpenAPI Overlay

Raw ↑
# 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 Orders API
  version: 1.0.0
extends: openapi/klarna-orders-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: 9
- target: $.paths['/ordermanagement/v1/orders/{order_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order's details
      effect: read
      questions:
      - How can I see the status, captures and remaining amount of a placed order?
      - Where do I look up a Klarna order after it has been created?
      instructions:
      - text: Get order {order_id}.
        slots:
          order_id: path.order_id
      - text: Show the order management details for order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/acknowledge'].post
  update:
    x-apievangelist-phrasing:
      intent: Acknowledge a checkout order
      effect: write
      questions:
      - Do I need to confirm to Klarna that I received a new checkout order?
      - What happens if I don't acknowledge an order my store just got?
      instructions:
      - text: Acknowledge order {order_id}.
        slots:
          order_id: path.order_id
      - text: Confirm receipt of checkout order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/authorization'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an order's amount and lines
      effect: write
      questions:
      - Can I raise or lower the authorized amount of an order before shipping?
      - How do I replace the order lines on an authorized order when the cart changes?
      instructions:
      - text: Set the amount of order {order_id} to {order_amount}.
        slots:
          order_id: path.order_id
          order_amount: requestBody.order_amount
      - text: Update order {order_id} to amount {order_amount} with new lines {order_lines}.
        slots:
          order_id: path.order_id
          order_amount: requestBody.order_amount
          order_lines: requestBody.order_lines
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/customer-details'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an order's shipping address
      effect: write
      questions:
      - The customer moved, can I change the shipping address on their order?
      - Is it possible to correct the delivery address before the order ships?
      instructions:
      - text: Change the shipping address of order {order_id} to {shipping_address}.
        slots:
          order_id: path.order_id
          shipping_address: requestBody.shipping_address
      - text: Update the customer's delivery address on order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/extend-authorization-time'].post
  update:
    x-apievangelist-phrasing:
      intent: Extend an order's authorization time
      effect: write
      questions:
      - My order won't ship before the authorization expires, can I get more time?
      - How do I keep an authorization alive longer for a delayed shipment?
      instructions:
      - text: Extend the authorization time of order {order_id}.
        slots:
          order_id: path.order_id
      - text: Give order {order_id} more time before its authorization expires.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/merchant-references'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an order's merchant references
      effect: write
      questions:
      - Can I change my internal order number stored on an order?
      - How do I set the second merchant reference after an order is placed?
      instructions:
      - text: Set merchant reference 1 on order {order_id} to {merchant_reference1}.
        slots:
          order_id: path.order_id
          merchant_reference1: requestBody.merchant_reference1
      - text: Update order {order_id} references to {merchant_reference1} and {merchant_reference2}.
        slots:
          order_id: path.order_id
          merchant_reference1: requestBody.merchant_reference1
          merchant_reference2: requestBody.merchant_reference2
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/release-remaining-authorization'].post
  update:
    x-apievangelist-phrasing:
      intent: Release an order's remaining authorization
      effect: destructive
      questions:
      - I shipped only part of an order, how can I free the rest of the authorized amount?
      - Can I release whatever hasn't been captured so the customer isn't held for it?
      instructions:
      - text: Release the remaining authorization on order {order_id}.
        slots:
          order_id: path.order_id
      - text: Free the uncaptured amount left on order {order_id}.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/shipping-info'].post
  update:
    x-apievangelist-phrasing:
      intent: Add shipping details to an order
      effect: write
      questions:
      - Can I attach tracking info to the whole order rather than a single capture?
      - Where do I record the carrier and tracking number for an order?
      instructions:
      - text: Add shipping info {shipping_info} to order {order_id}.
        slots:
          shipping_info: requestBody.shipping_info
          order_id: path.order_id
      - text: Attach tracking details to order {order_id} itself.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order
      effect: destructive
      questions:
      - How do I cancel an order that hasn't been captured yet?
      - Can a customer's order be cancelled before anything ships?
      instructions:
      - text: Cancel order {order_id}.
        slots:
          order_id: path.order_id
      - text: Cancel the uncaptured order {order_id} in order management.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'