The Order Management API is used for handling an order after the customer has completed the purchase. It is used for all actions you need to manage your orders. Examples being: updating, capturing, reading and refunding an order.
Read more on the Order management process.
An order that has the given order id. Read more on Retrieving order details
curl -i -X GET \
'https://api.klarna.com/ordermanagement/v1/orders/{order_id}' \
-H 'Klarna-Integrator: string'Order found
The time for the purchase. Formatted according to ISO 8601.
Order expiration time. The order can only be captured until this time. Formatted according to ISO 8601.
Fraud status for the order. Either ACCEPTED, PENDING or REJECTED.
A Kustom generated reference that is shorter than the Order Id and is used as a customer friendly reference. It is most often used as a reference when Kustom is communicating with the customer with regard to payment statuses.
Text field for storing data about the order. Set at order creation.
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.
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.
The order amount in minor units. That is the smallest currency unit available such as cent or penny.
The unique order ID. Cannot be longer than 255 characters.
An array of order_line objects. Each line represents one item in the cart.
The purchase country. Formatted according to ISO 3166-1 alpha-2.
The total amount of refunded for this order. In minor units.
The remaining authorized amount for this order. To increase the remaining_authorized_amount the order_amount needs to be increased.
{ "billing_address": { "attention": "John Smith", "city": "New York", "country": "US", "email": "test.sam@test.com", "family_name": "Andersson", "given_name": "Adam", "organization_name": "Kustom", "phone": "1-555-555-5555", "postal_code": "10024-3941", "region": "US-NY", "street_address": "509 Amsterdam Ave", "street_address2": "Floor 22 / Flat 2", "title": "Mr." }, "captured_amount": 0, "captures": [ { … } ], "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", "merchant_reference2": "501", "order_amount": 0, "order_id": "f3392f8b-6116-4073-ab96-e330819e2c07", "order_lines": [ { … } ], "original_order_amount": 0, "purchase_country": "US", "purchase_currency": "USD", "refunded_amount": 0, "refunds": [ { … } ], "remaining_authorized_amount": 0, "selected_shipping_option": { "carrier": "string", "carrier_product": { … }, "class": "string", "id": "string", "location": { … }, "method": "string", "name": "string", "price": 0, "selected_addons": [ … ], "tax_amount": 0, "tax_rate": 0, "timeslot": { … }, "tms_reference": "string", "type": "string" }, "shipping_address": { "attention": "John Smith", "city": "New York", "country": "US", "email": "test.sam@test.com", "family_name": "Andersson", "given_name": "Adam", "organization_name": "Kustom", "phone": "1-555-555-5555", "postal_code": "10024-3941", "region": "US-NY", "street_address": "509 Amsterdam Ave", "street_address2": "Floor 22 / Flat 2", "title": "Mr." }, "shipping_info": [ { … } ], "status": "AUTHORIZED" }
Acknowledge order. Read more on Acknowledging orders
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.
curl -i -X POST \
'https://api.klarna.com/ordermanagement/v1/orders/{order_id}/acknowledge' \
-H 'Klarna-Idempotency-Key: string'Update shipping address. Read more on Updating customer addresses
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.
curl -i -X PATCH \
'https://api.klarna.com/ordermanagement/v1/orders/{order_id}/customer-details' \
-H 'Content-Type: application/json' \
-H 'Klarna-Idempotency-Key: string' \
-d '{
"shipping_address": {
"attention": "John Smith",
"city": "New York",
"country": "US",
"email": "test.sam@test.com",
"family_name": "Andersson",
"given_name": "Adam",
"organization_name": "Kustom",
"phone": "1-555-555-5555",
"postal_code": "10024-3941",
"region": "US-NY",
"street_address": "509 Amsterdam Ave",
"street_address2": "Floor 22 / Flat 2",
"title": "Mr."
}
}'"string"
Update merchant references. Read more on Updating merchant references
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.
New merchant reference 1. Old reference will be overwritten if this field is present.
curl -i -X PATCH \
'https://api.klarna.com/ordermanagement/v1/orders/{order_id}/merchant-references' \
-H 'Content-Type: application/json' \
-H 'Klarna-Idempotency-Key: string' \
-d '{
"merchant_reference1": "string",
"merchant_reference2": "string"
}'Add shipping info to an order. Read more on Adding shipping info
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.
curl -i -X POST \
'https://api.klarna.com/ordermanagement/v1/orders/{order_id}/shipping-info' \
-H 'Content-Type: application/json' \
-H 'Klarna-Idempotency-Key: string' \
-d '{
"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"
}
]
}'Cancel order. Read more on Cancelling an order
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.
curl -i -X POST \
'https://api.klarna.com/ordermanagement/v1/orders/{order_id}/cancel' \
-H 'Klarna-Idempotency-Key: string'