POST

Capture an order

https://api.kustom.co/ordermanagement/v1/orders/{order_id}/captures

Create capture. Read more on Capturing an order

Parameters2 fields

order_idstring · uuidrequiredin path
Order id
Klarna-Idempotency-Keystringoptionalin header
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 body33 fields

captured_amountinteger · int64required
The captured amount in minor units.
descriptionstringoptional
Description of the capture shown to the customer. Maximum 255 characters.
order_lines[]array<object>optional
Order lines for this capture. Maximum 1000 items.
20 fields in order_lines
- image_urlstringoptional
  URL to an image that can be embedded in communications between Klarna and the customer.
- merchant_datastringoptional
  Data about the order line.
- namestringrequired
  Descriptive item name.
- product_identifiersobjectoptional
  product_identifiers
  6 fields in product_identifiers
  - brandstringoptional
    The product’s brand name as generally recognized by consumers. If no brand is available for a product, do not supply any value. Maximum 70 characters. Example: Intel
  - category_pathstringoptional
    The product’s category path as used in the merchant’s webshop. Include the full and most detailed category and separate the segments with ’ > ’. Maximum 750 characters. Example: Electronics Store > Computers & Tablets > Desktops
  - colorstringoptional
    Color to be shown to the end customer (max 64 characters). Example: Denim blue
  - global_trade_item_numberstringoptional
    The product’s Global Trade Item Number (GTIN). Common types of GTIN are EAN, ISBN or UPC. Exclude dashes and spaces, where possible. Maximum 50 characters. Example: 735858293167
  - manufacturer_part_numberstringoptional
    The product’s Manufacturer Part Number (MPN), which - together with the brand - uniquely identifies a product. Only submit MPNs assigned by a manufacturer and use the most specific MPN possible. Maximum 70 characters. Example: BOXNUC5CPYH
  - sizestringoptional
    Size to be shown to the end customer (max 64 characters). Example: 4
- product_urlstringoptional
  URL to the product that can be used in communications between Klarna and the customer.
- quantityinteger · int64required
  Item quantity.
- quantity_unitstringoptional
  Unit used to describe the quantity.
- referencestringoptional
  Article number, SKU, or similar identifier on the product variant level.
- tax_rateinteger · int32optional
  The tax rate in percent with two implicit decimals.
- total_amountinteger · int64required
  Total amount including tax and discounts (quantity * unit_price - total_discount_amount).
- total_discount_amountinteger · int64optional
  The discount amount in minor units. Includes tax. Example: 1200 = $12. Max value: 200000000
- total_tax_amountinteger · int64optional
  The total tax amount in minor units.
- typestringoptional
  Order line type.
  - physical
  - discount
  - shipping_fee
  - sales_tax
  - store_credit
  - gift_card
  - digital
  - surcharge
  - return_fee
  - package
- unit_priceinteger · int64required
  Unit price including tax without applying discounts in minor units.
referencestringoptional
Internal reference to the capture. This will be included in the settlement files. Max length is 255 characters.
shipping_delayinteger · int64optional
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 Kustom for further information.
shipping_info[]array<object>optional
Shipping information for this capture. Maximum 500 items.
7 fields in shipping_info
- return_shipping_companystringoptional
  Name of the shipping company for the return shipment (as specific as possible). Maximum 100 characters. Example: ‘DHL SE’ and not only ‘DHL’
- return_tracking_numberstringoptional
  Tracking number for the return shipment. Maximum 100 characters.
- return_tracking_uristringoptional
  URL where the customer can track the return shipment. Maximum 1024 characters.
- shipping_companystringoptional
  Name of the shipping company (as specific as possible). Maximum 100 characters. Example: ‘DHL SE’ and not only ‘DHL’
- shipping_methodstringoptional
  Shipping method. Allowed values matches (PickUpStore|Home|BoxReg|BoxUnreg|PickUpPoint|Own|Postal|DHLPackstation|Digital|Undefined|PickUpWarehouse|ClickCollect|PalletDelivery)
- tracking_numberstringoptional
  Tracking number for the shipment. Maximum 100 characters.
- tracking_uristringoptional
  URI where the customer can track their shipment. Maximum 1024 characters.

201

Response0 fields

Capture created

No response body — this status returns headers only.

403

Response3 fields

Capture not allowed.

correlation_idstringoptional
Correlation id. For searching logs.
error_codestringoptional
Error code
error_messages[]array<string>optional
Error messages

404

Response3 fields

Order not found.

correlation_idstringoptional
Correlation id. For searching logs.
error_codestringoptional
Error code
error_messages[]array<string>optional
Error messages

409

Response0 fields

Conflict

No response body — this status returns headers only.

Errors

Code	Status	What it means	Retry
`CAPTURE_NOT_ALLOWED`	403	The order is not in a state that permits capture. Needs `AUTHORIZED`.	Never retry
`NO_SUCH_ORDER`	404	The order_id does not exist, or belongs to the other environment.	Never retry

POST https://api.kustom.co/ordermanagement/v1/orders/{order_id}/captures

Request body· application/json

{
  "captured_amount": 0,
  "description": "<string>",
  "order_lines": [
    {
      "image_url": "https://yourstore.example/product/headphones.png",
      "merchant_data": "Some metadata",
      "name": "<string>",
      "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": 1,
      "quantity_unit": "pcs.",
      "reference": 75001,
      "tax_rate": 0,
      "total_amount": 0,
      "total_discount_amount": 0,
      "total_tax_amount": 0,
      "type": "physical",
      "unit_price": 0
    }
  ],
  "reference": "<string>",
  "shipping_delay": 0,
  "shipping_info": [
    {
      "return_shipping_company": "DHL SE",
      "return_tracking_number": 93456415674545680000,
      "return_tracking_uri": "http://shipping.example/findmypackage?93456415674545679888",
      "shipping_company": "DHL SE",
      "shipping_method": "Home",
      "tracking_number": 63456415674545680000,
      "tracking_uri": "http://shipping.example/findmypackage?63456415674545679874"
    }
  ]
}

42 lines

Response 403· Capture not allowed.

{
  "correlation_id": "66782175-ae05-44fc-9eb3-eeceadbad271",
  "error_code": "CAPTURE_NOT_ALLOWED",
  "error_messages": [
    "<string>"
  ]
}

7 lines

Response 404· Order not found.

{
  "correlation_id": "66782175-ae05-44fc-9eb3-eeceadbad271",
  "error_code": "NO_SUCH_ORDER",
  "error_messages": [
    "<string>"
  ]
}

7 lines

Response 409· Conflict

"<string>"

1 lines

This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.