Get order details

GET/ordermanagement/v1/orders/{order_id}

Use it in a workflow

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

Request

Path parameters

order_idstringrequired

Order id

Headers

Klarna-Integratorstring

Response

Returns 200 with an object. Read it in later steps with {{getOrderDetails.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.

captured_amountinteger (int64)

The total amount of all captures. In minor units.

capturesarray<object>

List of captures for this order.

billing_addressobject13 fields

Shipping address for the capture.

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>15 fields

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

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_addressobject13 fields

Shipping address for the capture.

shipping_infoarray<object>7 fields

Shipping information for this capture.

created_atstring (date-time)

The time for the purchase. Formatted according to ISO 8601.

customerobject

Information about the customer placing the order.

date_of_birthstring (date)

The customer date of birth. ISO 8601.

national_identification_numberstring

The customer national identification number

expires_atstring (date-time)

Order expiration time. The order can only be captured until this time. Formatted according to ISO 8601.

fraud_statusstring

Fraud status for the order. Either ACCEPTED, PENDING or REJECTED.

initial_payment_methodobject

Initial payment method for this order

descriptionstring

The description of the initial payment method.

number_of_installmentsinteger (int32)

The number of installments (if applicable).

typestring

The type of the initial payment method. One of ACCOUNT, ALTERNATIVE_PAYMENT_METHOD, BANK_TRANSFER, CARD, DEFERRED_INTEREST, DIRECT_DEBIT, FIXED_AMOUNT_BY_CARD, FIXED_AMOUNT, FIXED_SUM_CREDIT, INVOICE_BUSINESS, INVOICE, MOBILEPAY, PAY_BY_CARD, PAY_IN_X, PAY_LATER_BY_CARD, PAY_LATER_IN_PARTS, SWISH, OTHER

klarna_referencestring

A Klarna generated reference that is shorter than the Klarna Order Id and is used as a customer friendly reference. It is most often used as a reference when Klarna is communicating with the customer with regard to payment statuses.

localestring

The customers locale. Specified according to RFC 1766.

merchant_datastring

Text field for storing data about the order. Set at order creation.

merchant_reference1string

The order number that the merchant should assign to the order. This is how a customer would reference the purchase they made. If supplied, it is labeled as the Order Number within post purchase communications as well as the Klarna App.

merchant_reference2string

Can be used to store your internal reference to the order. This is generally an internal reference number that merchants use as alternate identifier that matches their internal ERP or Order Management system.

order_amountinteger (int64)

The order amount in minor units. That is the smallest currency unit available such as cent or penny.

order_idstring

The unique order ID. Cannot be longer than 255 characters.

order_linesarray<object>

An array of order_line objects. Each line represents one item in the cart.

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.

original_order_amountinteger (int64)

The original order amount. In minor units.

purchase_countrystring

The purchase country. Formatted according to ISO 3166-1 alpha-2.

purchase_currencystring

The currency for this order. Specified in ISO 4217 format.

refunded_amountinteger (int64)

The total amount of refunded for this order. In minor units.

refundsarray<object>

List of refunds for this order.

credit_invoiceboolean

Only relevant for B2B Orders. If the flag is set to true for an order with B2B_invoice as payment method, the customer will receive the refund as a credit invoice.

descriptionstring

Description of the refund shown to the customer. Max length is 255 characters.

order_linesarray<object>15 fields

Order lines for the refund shown to the customer. Optional but increases the customer experience. Maximum 1000 order lines.

referencestring

Internal reference to the refund that is also included in the settlement files. Max length is 255 characters.

refund_idstring

The refund id. Generated when the refund is created.

refunded_amountinteger (int64)

Refunded amount in minor units.

refunded_atstring (date-time)

The time of the refund. ISO 8601.

remaining_authorized_amountinteger (int64)

The remaining authorized amount for this order. To increase the `remaining_authorized_amount` the `order_amount` needs to be increased.

selected_shipping_optionobject

The shipping option selected by the user.

carrierstring

The carrier for the selected shipping option

carrier_productobject2 fields

The chosen timeslot of the selected shipping option

classstring

The class of the selected shipping option

idstring

The id of the selected shipping option as provided by the TMS

locationobject4 fields

The location of the selected shipping option

methodstring

The method of the selected shipping option

namestring

The display name of the selected shipping option

priceinteger (int64)

The price of the selected shipping option

selected_addonsarray<object>4 fields

Array consisting of add-ons selected by the consumer, may be empty

tax_amountinteger (int64)

The tax amount of the selected shipping option

tax_rateinteger (int64)

The tax rate of the selected shipping option

timeslotobject5 fields

The chosen timeslot of the selected shipping option

tms_referencestring

The shipment_id provided by the TMS

typestring

The type of the selected shipping option

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 order.

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.

statusstring

The order status.

One ofAUTHORIZEDPART_CAPTUREDCAPTUREDCANCELLEDEXPIREDCLOSED

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"
  },
  "captured_amount": 0,
  "captures": [
    {
      "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"
        }
      ]
    }
  ],
  "created_at": "2015-11-29T10:25:40Z",
  "customer": {
    "date_of_birth": "1981-09-06",
    "national_identification_number": "string"
  },
  "expires_at": "2015-12-04T10:26:06Z",
  "fraud_status": "ACCEPTED",
  "initial_payment_method": {
    "description": "Slice it (Fixed Payments)",
    "number_of_installments": 3,
    "type": "FIXED_AMOUNT"
  },
  "klarna_reference": "K4MADNY",
  "locale": "en-US",
  "merchant_data": "Order metadata",
  "merchant_reference1": "10001"
}

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

Was this page helpful?