Klarna · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Checkout API V3 Merchant Urls.shipping Option Update API

2 actions 2 updates phrasing extends openapi/klarna-merchant-urls-shipping-option-update-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 2

$.info

$.paths['/merchant_urls.shipping_option_update'].post

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 Checkout API V3 Merchant Urls.shipping Option Update API
  version: 1.0.0
extends: openapi/klarna-merchant-urls-shipping-option-update-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: 1
- target: $.paths['/merchant_urls.shipping_option_update'].post
  update:
    x-apievangelist-phrasing:
      intent: Respond to a shipping option selection
      effect: write
      questions:
      - How do I add the shipping fee when a shopper picks a delivery option in checkout?
      - What does my store receive when the customer selects a different shipping method?
      instructions:
      - text: Handle the shipping option callback for {selected_shipping_option} and return total {order_amount}.
        slots:
          selected_shipping_option: requestBody.selected_shipping_option
          order_amount: requestBody.order_amount
      - text: Update the cart {order_lines} for the newly chosen shipping option.
        slots:
          order_lines: requestBody.order_lines
      method: generated
      generated: '2026-09-26'