Get capture details

GET/ordermanagement/v1/orders/{order_id}/captures/{capture_id}

Use it in a workflow

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

Request

Path parameters

order_idstringrequired

Order id

capture_idstringrequired

Capture id

Response

Returns 200 with an object. Read it in later steps with {{getCaptureDetails.response.data.<field>}}.

billing_addressobject

Shipping address for the capture.

attentionstring

'Attn.' - optional parameter.

citystring

City.

countrystring

Country. ISO 3166 alpha-2.

emailstring

E-mail address.

family_namestring

Family name.

given_namestring

Given name.

organization_namestring

Organization name (if applicable). Only applicable for B2B customers.

phonestring

Phone number.

postal_codestring

Postcode. Validation according to [Universal Postal Union addressing system](https://www.upu.int/en/activities/addressing/postal-addressing-systems-in-member-countries.html).

regionstring

State/Region. Required for US.

street_addressstring

First line of street address. Validation according to [Universal Postal Union addressing system](https://www.upu.int/en/activities/addressing/postal-addressing-systems-in-member-countries.html)

street_address2string

Second line of street address.

titlestring

Title.

capture_idstring

The capture id. Generated when the capture is created.

captured_amountinteger (int64)

The captured amount in minor units.

captured_atstring (date-time)

The time of the capture. Specified in ISO 8601.

descriptionstring

Description of the capture shown to the customer.

klarna_referencestring

Customer friendly reference id, used as a reference when communicating with the customer.

order_linesarray<object>

List of order lines for the capture shown to the customer.

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 which will be included in the settlement files. Max length is 255 characters.

refunded_amountinteger (int64)

Refunded amount for this capture in minor units.

shipping_addressobject

Shipping address for the capture.

attentionstring

'Attn.' - optional parameter.

citystring

City.

countrystring

Country. ISO 3166 alpha-2.

emailstring

E-mail address.

family_namestring

Family name.

given_namestring

Given name.

organization_namestring

Organization name (if applicable). Only applicable for B2B customers.

phonestring

Phone number.

postal_codestring

Postcode. Validation according to [Universal Postal Union addressing system](https://www.upu.int/en/activities/addressing/postal-addressing-systems-in-member-countries.html).

regionstring

State/Region. Required for US.

street_addressstring

First line of street address. Validation according to [Universal Postal Union addressing system](https://www.upu.int/en/activities/addressing/postal-addressing-systems-in-member-countries.html)

street_address2string

Second line of street address.

titlestring

Title.

shipping_infoarray<object>

Shipping information for this capture.

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

{
  "billing_address": {
    "attention": "John Smith",
    "city": "New York",
    "country": "US",
    "email": "test.sam@test.com",
    "family_name": "Andersson",
    "given_name": "Adam",
    "organization_name": "Klarna",
    "phone": "1-555-555-5555",
    "postal_code": "10024-3941",
    "region": "US-NY",
    "street_address": "509 Amsterdam Ave",
    "street_address2": "Floor 22 / Flat 2"
  },
  "capture_id": "4ba29b50-be7b-44f5-a492-113e6a865e22",
  "captured_amount": 0,
  "captured_at": "2015-11-19T01:51:17Z",
  "description": "Order has been shipped",
  "klarna_reference": "K4MADNY-1",
  "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",
  "refunded_amount": 0,
  "shipping_address": {
    "attention": "John Smith",
    "city": "New York",
    "country": "US",
    "email": "test.sam@test.com",
    "family_name": "Andersson",
    "given_name": "Adam",
    "organization_name": "Klarna",
    "phone": "1-555-555-5555",
    "postal_code": "10024-3941",
    "region": "US-NY",
    "street_address": "509 Amsterdam Ave",
    "street_address2": "Floor 22 / Flat 2"
  },
  "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"
    }
  ]
}

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

Was this page helpful?