Klarna · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klarna Order Management Captures API

8 actions 8 updates phrasing extends openapi/klarna-captures-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 8

$.info
$.paths['/ordermanagement/v1/orders/{order_id}/captures'].get
$.paths['/ordermanagement/v1/orders/{order_id}/captures'].post
$.paths['/ordermanagement/v1/orders/{order_id}/captures/{capture_id}'].get
$.paths['/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/extend-due-date'].patch
$.paths['/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/extend-due-date-options'].get
$.paths['/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-info'].post
$.paths['/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/trigger-send-out'].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 Captures API
  version: 1.0.0
extends: openapi/klarna-captures-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: 7
- target: $.paths['/ordermanagement/v1/orders/{order_id}/captures'].get
  update:
    x-apievangelist-phrasing:
      intent: List the captures on an order
      effect: read
      questions:
      - Which captures have already been taken against a Klarna order?
      - Can I see every partial capture made on one order at once?
      instructions:
      - text: List all captures for order {order_id}.
        slots:
          order_id: path.order_id
      - text: Show me every capture recorded on order {order_id} so far.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/captures'].post
  update:
    x-apievangelist-phrasing:
      intent: Capture an order's payment
      effect: write
      questions:
      - How do I capture payment on an order once I've shipped it?
      - Can I capture only part of the order amount and name the shipped order lines?
      - Is it possible to attach tracking details at the moment I capture an order?
      instructions:
      - text: Capture {captured_amount} on order {order_id}.
        slots:
          captured_amount: requestBody.captured_amount
          order_id: path.order_id
      - text: Capture {captured_amount} on order {order_id} with reference {reference}.
        slots:
          captured_amount: requestBody.captured_amount
          order_id: path.order_id
          reference: requestBody.reference
      - text: Capture order {order_id} for {captured_amount} and delay shipping by {shipping_delay} days.
        slots:
          order_id: path.order_id
          captured_amount: requestBody.captured_amount
          shipping_delay: requestBody.shipping_delay
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/captures/{capture_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of one capture
      effect: read
      questions:
      - What was included in a specific capture on an order?
      - Can I look up the amount and order lines of a single capture by its id?
      instructions:
      - text: Get capture {capture_id} on order {order_id}.
        slots:
          capture_id: path.capture_id
          order_id: path.order_id
      - text: Show the details of capture {capture_id} for order {order_id}.
        slots:
          capture_id: path.capture_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/extend-due-date'].patch
  update:
    x-apievangelist-phrasing:
      intent: Extend a customer's payment due date
      effect: write
      questions:
      - Can I give a customer more days to pay for a captured purchase?
      - How do I push back when a shopper's invoice is due after capture?
      instructions:
      - text: Extend the due date of capture {capture_id} on order {order_id} by {number_of_days} days.
        slots:
          capture_id: path.capture_id
          order_id: path.order_id
          number_of_days: requestBody.number_of_days
      - text: Give the customer {number_of_days} extra days to pay capture {capture_id} of order {order_id}.
        slots:
          number_of_days: requestBody.number_of_days
          capture_id: path.capture_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/extend-due-date-options'].get
  update:
    x-apievangelist-phrasing:
      intent: See due date extension options and fees
      effect: read
      questions:
      - What would it cost me as a merchant to extend a customer's due date?
      - Which due date extension lengths are available for a capture before I apply one?
      instructions:
      - text: List the due date extension options for capture {capture_id} on order {order_id}.
        slots:
          capture_id: path.capture_id
          order_id: path.order_id
      - text: Show the merchant fees for extending the due date on capture {capture_id} of order {order_id}.
        slots:
          capture_id: path.capture_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-info'].post
  update:
    x-apievangelist-phrasing:
      intent: Add shipping details to a capture
      effect: write
      questions:
      - Can I add a tracking number to a capture I already made?
      - How do I attach carrier and tracking info to one specific capture rather than the whole order?
      instructions:
      - text: Add shipping info {shipping_info} to capture {capture_id} on order {order_id}.
        slots:
          shipping_info: requestBody.shipping_info
          capture_id: path.capture_id
          order_id: path.order_id
      - text: Attach tracking details to capture {capture_id} of order {order_id}.
        slots:
          capture_id: path.capture_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ordermanagement/v1/orders/{order_id}/captures/{capture_id}/trigger-send-out'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend a capture's customer communication
      effect: write
      questions:
      - A shopper lost their payment instructions, can I resend them for a capture?
      - Is there a way to re-trigger the customer email for a captured shipment?
      instructions:
      - text: Resend the customer communication for capture {capture_id} on order {order_id}.
        slots:
          capture_id: path.capture_id
          order_id: path.order_id
      - text: Trigger the send-out again for capture {capture_id} of order {order_id}.
        slots:
          capture_id: path.capture_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-26'