Last updated

Read order


This document details how to read an order created using the Kustom Checkout (KCO) API.

Read order request

To read an order, use the KCO REST API. Make a GET request to the /checkout/v3/orders/order_id endpoint, replacing order_id with the ID from the create order response. Include the header content-type: application/json and an empty body.

Read order response

The response is a JSON object containing order details.

{
  "order_id": "8cf27b55-53e8-6aba-9fb4-7c692e56ddee",
  "status": "checkout_complete",
  "purchase_country": "se",
  "purchase_currency": "SEK",
  "locale": "en-SE",
  "billing_address": {
    "given_name": "Testperson-se",
    "family_name": "Approved",
    "email": "Testperson-se@kustom.co",
    "title": "Mr",
    "street_address": "test House 57",
    "postal_code": "WC2N 5DU",
    "city": "London",
    "phone": "+46 76 526 00 00",
    "country": "gb"
  },
  "customer": {
    "date_of_birth": "1941-03-21",
    "gender": "male"
  },
  "shipping_address": {
    "given_name": "Testperson-se",
    "family_name": "Approved",
    "email": "Testperson-se@kustom.co",
    "title": "Mr",
    "street_address": "test House 57",
    "postal_code": "WC2N 5DU",
    "city": "London",
    "phone": "+46 76 526 00 00",
    "country": "gb"
  },
  "order_amount": 50000,
  "order_tax_amount": 4545,
  "order_lines": [
    {
      "type": "physical",
      "reference": "19-402-USA",
      "name": "Red T-Shirt",
      "quantity": 5,
      "quantity_unit": "pcs",
      "unit_price": 10000,
      "tax_rate": 1000,
      "total_amount": 50000,
      "total_discount_amount": 0,
      "total_tax_amount": 4545
    }
  ],
  "merchant_urls": {
    "terms": "https://www.example.com/terms.html",
    "checkout": "https://www.example.com/checkout.html?order_id={checkout.order.id}",
    "confirmation": "https://www.example.com/confirmation.html?order_id={checkout.order.id}",
    "push": "https://www.example.com/api/push?order_id={checkout.order.id}"
  },
  "html_snippet": "<div id=\"klarna-checkout-container\".................",
  "started_at": "2020-03-05T13:32:42Z",
  "completed_at": "2020-03-05T13:33:14Z",
  "last_modified_at": "2020-03-05T13:33:14Z",
  "options": {
    "allow_separate_shipping_address": false,
    "date_of_birth_mandatory": false,
    "require_validate_callback_success": false
  },
  "external_payment_methods": [],
  "external_checkouts": [],
  "payment_type_allows_increase": true
}