Capture an order

POST/ordermanagement/v1/orders/{order_id}/captures

Use it in a workflow

Add a step and choose the Klarna connector.
Pick the Capture an order action (under Order Management).
Fill in the fields below, then reference the result from later steps as {{captureAnOrder.response.data}}.

Request

Path parameters

order_idstringrequired

Order id

Headers

Klarna-Idempotency-Keystring

This header will guarantee the idempotency of the operation. The key should be unique and is recommended to be a UUID version 4. Retries of requests are safe to be applied in case of errors such as network errors, socket errors and timeouts. Input values of the operation are disregarded when evaluating the idempotency of the operation, only the key matters.

Request body

Enter the body as JSON in the step's Body field.

captured_amountinteger (int64)required

The captured amount in minor units.

descriptionstring

Description of the capture shown to the customer. Maximum 255 characters.

order_linesarray<object>

Order lines for this capture. Maximum 1000 items.

image_urlstring

URL to an image that can be embedded in communications between Klarna and the customer.

merchant_datastring

Data about the order line.

namestringrequired

Descriptive item name.

product_identifiersobject6 fields

product_identifiers

product_urlstring

URL to the product that can be used in communications between Klarna and the customer.

quantityinteger (int64)required

Item quantity.

quantity_unitstring

Unit used to describe the quantity.

referencestring

Article number, SKU, or similar identifier on the product variant level.

subscriptionobject3 fields

Subscription information, such as the cadence and product name of the subscription that an order line item belongs to.

tax_rateinteger (int32)

The tax rate in percent with two implicit decimals.

total_amountinteger (int64)required

Total amount including tax and discounts (`quantity * unit_price - total_discount_amount`).

total_discount_amountinteger (int64)

The discount amount in minor units. Includes tax. Example: 1200 = $12. Max value: 200000000

total_tax_amountinteger (int64)

The total tax amount in minor units.

typestring

Order line type.

One ofphysicaldiscountshipping_feesales_taxstore_creditgift_carddigitalsurchargereturn_fee

unit_priceinteger (int64)required

Unit price including tax without applying discounts in minor units.

referencestring

Internal reference to the capture. This will be included in the settlement files. Max length is 255 characters.

shipping_delayinteger (int64)

Delay before the order will be shipped. Use for improving the customer experience regarding payments. This field is currently not returned when reading the order. Minimum: 0. Please note: to be able to submit values larger than 0, this has to be enabled in your merchant account. Please contact Klarna for further information.

shipping_infoarray<object>

Shipping information for this capture. Maximum 500 items.

return_shipping_companystring

Identifier of the shipping company for the return shipment. The value should be a valid SHIPPING_COMPANY from the [Carrier list](https://docs.klarna.com/payments/after-payments/order-management/more-actions/klarna-carrier-partner-list/).

return_tracking_numberstring

Tracking number for the return shipment. Maximum 100 characters.

return_tracking_uristring

URL where the customer can track the return shipment. Maximum 1024 characters.

shipping_companystring

Identifier of the shipping company. The value should be a valid SHIPPING_COMPANY from the [Carrier list](https://docs.klarna.com/payments/after-payments/order-management/more-actions/klarna-carrier-partner-list/).

shipping_methodstring

tracking_numberstring

Tracking number for the shipment. Maximum 100 characters.

tracking_uristring

URI where the customer can track their shipment. Maximum 1024 characters.

json

{
  "captured_amount": 0,
  "description": "string",
  "order_lines": [
    {
      "name": "string",
      "quantity": 1,
      "total_amount": 0,
      "unit_price": 0,
      "image_url": "https://yourstore.example/product/headphones.png",
      "merchant_data": "Some metadata",
      "product_identifiers": {
        "brand": "Intel",
        "category_path": "Electronics Store > Computers & Tablets > Desktops",
        "color": "Denim blue",
        "global_trade_item_number": "735858293167",
        "manufacturer_part_number": "BOXNUC5CPYH",
        "size": "4"
      },
      "product_url": "https://yourstore.example/product/headphones",
      "quantity_unit": "pcs.",
      "reference": "75001",
      "subscription": {
        "interval": "MONTH",
        "interval_count": 0,
        "name": "string"
      },
      "tax_rate": 0
    }
  ],
  "reference": "string",
  "shipping_delay": 0,
  "shipping_info": [
    {
      "return_shipping_company": "dhl-express",
      "return_tracking_number": "93456415674545679888",
      "return_tracking_uri": "http://shipping.example/findmypackage?93456415674545679888",
      "shipping_company": "dhl-express",
      "shipping_method": "Home",
      "tracking_number": "63456415674545679874",
      "tracking_uri": "http://shipping.example/findmypackage?63456415674545679874"
    }
  ]
}

Response

Returns 201 with a any. Read it in later steps with {{captureAnOrder.response.data.<field>}}.

Need more? See the Klarna guide for connection setup and behaviour shared by every action.

Was this page helpful?