GET

Get order details

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

An order that has the given order id. Read more on Retrieving order details

Parameters2 fields

order_idstring · uuidrequiredin path
Order id
Klarna-Integratorstringoptionalin header

200

Response213 fields

Order found

billing_addressobjectoptional
Shipping address for the capture.
13 fields in billing_address
- attentionstringoptional
  ‘Attn.’ - optional parameter.
- citystringoptional
  City.
- countrystringoptional
  Country. ISO 3166 alpha-2.
- emailstringoptional
  E-mail address.
- family_namestringoptional
  Family name.
- given_namestringoptional
  Given name.
- organization_namestringoptional
  Organization name (if applicable). Only applicable for B2B customers.
- phonestringoptional
  Phone number.
- postal_codestringoptional
  Postcode. Validation according to Universal Postal Union addressing system.
- regionstringoptional
  State/Region. Required for US.
- street_addressstringoptional
  First line of street address. Validation according to Universal Postal Union addressing system
- street_address2stringoptional
  Second line of street address.
- titlestringoptional
  Title.
captured_amountinteger · int64optional
The total amount of all captures. In minor units.
captures[]array<object>optional
List of captures for this order.
64 fields in captures
- billing_addressobjectoptional
  Shipping address for the capture.
  13 fields in billing_address
  - attentionstringoptional
    ‘Attn.’ - optional parameter.
  - citystringoptional
    City.
  - countrystringoptional
    Country. ISO 3166 alpha-2.
  - emailstringoptional
    E-mail address.
  - family_namestringoptional
    Family name.
  - given_namestringoptional
    Given name.
  - organization_namestringoptional
    Organization name (if applicable). Only applicable for B2B customers.
  - phonestringoptional
    Phone number.
  - postal_codestringoptional
    Postcode. Validation according to Universal Postal Union addressing system.
  - regionstringoptional
    State/Region. Required for US.
  - street_addressstringoptional
    First line of street address. Validation according to Universal Postal Union addressing system
  - street_address2stringoptional
    Second line of street address.
  - titlestringoptional
    Title.
- capture_idstringoptional
  The capture id. Generated when the capture is created.
- captured_amountinteger · int64optional
  The captured amount in minor units.
- captured_atstring · date-timeoptional
  The time of the capture. Specified in ISO 8601.
- descriptionstringoptional
  Description of the capture shown to the customer.
- klarna_referencestringoptional
  Customer friendly reference id, used as a reference when communicating with the customer.
- order_lines[]array<object>optional
  List of order lines for the capture shown to the customer.
  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 which will be included in the settlement files. Max length is 255 characters.
- refunded_amountinteger · int64optional
  Refunded amount for this capture in minor units.
- shipping_addressobjectoptional
  Shipping address for the capture.
  Same shape as billing_address — 13 fields, identical. Anchors under this path still resolve.
  13 fields in shipping_address
  - attentionstringoptional
    ‘Attn.’ - optional parameter.
  - citystringoptional
    City.
  - countrystringoptional
    Country. ISO 3166 alpha-2.
  - emailstringoptional
    E-mail address.
  - family_namestringoptional
    Family name.
  - given_namestringoptional
    Given name.
  - organization_namestringoptional
    Organization name (if applicable). Only applicable for B2B customers.
  - phonestringoptional
    Phone number.
  - postal_codestringoptional
    Postcode. Validation according to Universal Postal Union addressing system.
  - regionstringoptional
    State/Region. Required for US.
  - street_addressstringoptional
    First line of street address. Validation according to Universal Postal Union addressing system
  - street_address2stringoptional
    Second line of street address.
  - titlestringoptional
    Title.
- shipping_info[]array<object>optional
  Shipping information for this capture.
  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.
created_atstring · date-timeoptional
The time for the purchase. Formatted according to ISO 8601.
customerobjectoptional
Information about the customer placing the order.
6 fields in customer
- date_of_birthstring · dateoptional
  The customer date of birth. ISO 8601.
- national_identification_numberstringoptional
  The customer national identification number
- vat_idstringoptional
  The customer vat Id
- typestringoptional
  The customer type
  - person
  - organization
- organization_entity_typestringoptional
  The customer organization entity type
  - LIMITED_COMPANY
  - PUBLIC_LIMITED_COMPANY
  - ENTREPRENEURIAL_COMPANY
  - LIMITED_PARTNERSHIP_LIMITED_COMPANY
  - LIMITED_PARTNERSHIP
  - GENERAL_PARTNERSHIP
  - REGISTERED_SOLE_TRADER
  - SOLE_TRADER
  - CIVIL_LAW_PARTNERSHIP
  - PUBLIC_INSTITUTION
  - OTHER
- organization_registration_idstringoptional
  The customer organization registration Id
expires_atstring · date-timeoptional
Order expiration time. The order can only be captured until this time. Formatted according to ISO 8601.
fraud_statusstringoptional
Fraud status for the order. Either ACCEPTED, PENDING or REJECTED.
initial_payment_methodobjectoptional
Initial payment method for this order
3 fields in initial_payment_method
- descriptionstringoptional
  The description of the initial payment method.
- number_of_installmentsinteger · int32optional
  The number of installments (if applicable).
- typestringoptional
  The type of the initial payment method. One of BANK_TRANSFER, CARD, FIXED_AMOUNT, INVOICE_BUSINESS, INVOICE, MOBILEPAY, PAY_BY_CARD, PAY_LATER_IN_PARTS, SWISH, APPLE_PAY_CARD, GOOGLE_PAY_CARD, CARTES_BANCAIRES, BLIK, TWINT, BANCONTACT, OTHER
klarna_referencestringoptional
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.
localestringoptional
The customers locale. Specified according to RFC 1766.
merchant_datastringoptional
Text field for storing data about the order. Set at order creation.
merchant_reference1stringoptional
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 payment method related apps.
merchant_reference2stringoptional
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 · int64optional
The order amount in minor units. That is the smallest currency unit available such as cent or penny.
order_idstringoptional
The unique order ID. Cannot be longer than 255 characters.
order_lines[]array<object>optional
An array of order_line objects. Each line represents one item in the cart.
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.
original_order_amountinteger · int64optional
The original order amount. In minor units.
purchase_countrystringoptional
The purchase country. Formatted according to ISO 3166-1 alpha-2.
purchase_currencystringoptional
The currency for this order. Specified in ISO 4217 format.
refunded_amountinteger · int64optional
The total amount of refunded for this order. In minor units.
refunds[]array<object>optional
List of refunds for this order.
26 fields in refunds
- descriptionstringoptional
  Description of the refund shown to the customer. Max length is 255 characters.
- order_lines[]array<object>optional
  Order lines for the refund shown to the customer. Optional but increases the customer experience. Maximum 1000 order lines.
  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 refund that is also included in the settlement files. Max length is 255 characters.
- refund_idstringoptional
  The refund id. Generated when the refund is created.
- refunded_amountinteger · int64optional
  Refunded amount in minor units.
- refunded_atstring · date-timeoptional
  The time of the refund. ISO 8601.
remaining_authorized_amountinteger · int64optional
The remaining authorized amount for this order. To increase the remaining_authorized_amount the order_amount needs to be increased.
selected_shipping_optionobjectoptional
The shipping option selected by the user.
35 fields in selected_shipping_option
- carrierstringoptional
  The carrier for the selected shipping option
- carrier_productobjectoptional
  The chosen timeslot of the selected shipping option
  2 fields in carrier_product
  - identifierstringoptional
    Id of carrier product
  - namestringoptional
    Name of carrier product
- classstringoptional
  The class of the selected shipping option
- idstringoptional
  The id of the selected shipping option as provided by the TMS
- locationobjectoptional
  The location of the selected shipping option
  10 fields in location
  - addressobjectoptional
    Address for location
    6 fields in address
    citystringoptional
    City.
    countrystringoptional
    Country. ISO 3166 alpha-2.
    postal_codestringoptional
    Postcode. Validation according to Universal Postal Union addressing system.
    regionstringoptional
    State/Region. Required for US.
    street_addressstringoptional
    First line of street address. Validation according to Universal Postal Union addressing system
    street_address2stringoptional
    Second line of street address.
  - idstringoptional
    The location id
  - namestringoptional
    The display name of the location
  - priceinteger · int64optional
    The price for this location
- methodstringoptional
  The method of the selected shipping option
- namestringoptional
  The display name of the selected shipping option
- priceinteger · int64optional
  The price of the selected shipping option
- selected_addons[]array<object>optional
  Array consisting of add-ons selected by the consumer, may be empty
  4 fields in selected_addons
  - external_idstringoptional
    The ID provided by the TMS
  - priceinteger · int64required
    The price of the add-on
  - typestringrequired
    The type of the add-on, e.g. sms or entry-code
  - user_inputstringoptional
    The text provided by the user
- tax_amountinteger · int64optional
  The tax amount of the selected shipping option
- tax_rateinteger · int64optional
  The tax rate of the selected shipping option
- timeslotobjectoptional
  The chosen timeslot of the selected shipping option
  5 fields in timeslot
  - cutoffstringoptional
    Cutoff time for delivery
  - endstringoptional
    End of the timeslot
  - idstringoptional
    The timeslot id
  - priceinteger · int64optional
    Price
  - startstringoptional
    Start of the timeslot
- tms_referencestringoptional
  The shipment_id provided by the TMS
- typestringoptional
  The type of the selected shipping option
shipping_addressobjectoptional
Shipping address for the capture.
Same shape as billing_address — 13 fields, identical. Anchors under this path still resolve.
13 fields in shipping_address
- attentionstringoptional
  ‘Attn.’ - optional parameter.
- citystringoptional
  City.
- countrystringoptional
  Country. ISO 3166 alpha-2.
- emailstringoptional
  E-mail address.
- family_namestringoptional
  Family name.
- given_namestringoptional
  Given name.
- organization_namestringoptional
  Organization name (if applicable). Only applicable for B2B customers.
- phonestringoptional
  Phone number.
- postal_codestringoptional
  Postcode. Validation according to Universal Postal Union addressing system.
- regionstringoptional
  State/Region. Required for US.
- street_addressstringoptional
  First line of street address. Validation according to Universal Postal Union addressing system
- street_address2stringoptional
  Second line of street address.
- titlestringoptional
  Title.
shipping_info[]array<object>optional
Shipping information for this order.
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.
statusstringoptional
The order status.
- AUTHORIZED
- PART_CAPTURED
- CAPTURED
- CANCELLED
- EXPIRED
- CLOSED

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
`NO_SUCH_ORDER`	404	The order_id does not exist, or belongs to the other environment.	Never retry

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

Response 200· Order found

{
  "billing_address": {
    "attention": "Anders Exempelsson",
    "city": "Vetlanda",
    "country": "se",
    "email": "john.testsson@kustom.co",
    "family_name": "Testsson",
    "given_name": "John",
    "organization_name": "Kustom",
    "phone": "1-555-555-5555",
    "postal_code": 12345,
    "region": "TN",
    "street_address": "Testgatan 10",
    "street_address2": 1,
    "title": "Herr"
  },
  "captured_amount": 0,
  "captures": [
    {
      "billing_address": {
        "attention": "Anders Exempelsson",
        "city": "Vetlanda",
        "country": "se",
        "email": "john.testsson@kustom.co",
        "family_name": "Testsson",
        "given_name": "John",
        "organization_name": "Kustom",
        "phone": "1-555-555-5555",
        "postal_code": 12345,
        "region": "TN",
        "street_address": "Testgatan 10",
        "street_address2": 1,
        "title": "Herr"
      },
      "capture_id": "4ba29b50-be7b-44f5-a492-113e6a865e22",
      "captured_amount": 0,
      "captured_at": "2025-11-19T01:51:17Z",
      "description": "Order has been shipped",
      "klarna_reference": "K4MADNY-1",
      "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>",
      "refunded_amount": 0,
      "shipping_address": {
        "attention": "Anders Exempelsson",
        "city": "Vetlanda",
        "country": "se",
        "email": "john.testsson@kustom.co",
        "family_name": "Testsson",
        "given_name": "John",
        "organization_name": "Kustom",
        "phone": "1-555-555-5555",
        "postal_code": 12345,
        "region": "TN",
        "street_address": "Testgatan 10",
        "street_address2": 1,
        "title": "Herr"
      },
      "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"
        }
      ]
    }
  ],
  "created_at": "2025-11-29T10:25:40Z",
  "customer": {
    "date_of_birth": "Sun Sep 06 02:00:00 CEST 1981",
    "national_identification_number": "<string>",
    "vat_id": "<string>",
    "type": "person",
    "organization_entity_type": "LIMITED_COMPANY",
    "organization_registration_id": "<string>"
  },
  "expires_at": "2025-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": [
    {
      "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
    }
  ],
  "original_order_amount": 0,
  "purchase_country": "us",
  "purchase_currency": "usd",
  "refunded_amount": 0,
  "refunds": [
    {
      "description": "The item was returned and the order refunded.",
      "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>",
      "refund_id": "b2cb4f2e-2781-4359-80ad-555735ebb8d8",
      "refunded_amount": 0,
      "refunded_at": "2025-12-04T15:17:40Z"
    }
  ],
  "remaining_authorized_amount": 0,
  "selected_shipping_option": {
    "carrier": "<string>",
    "carrier_product": {
      "identifier": "<string>",
      "name": "<string>"
    },
    "class": "<string>",
    "id": "<string>",
    "location": {
      "address": {
        "city": "Knoxville",
        "country": "us",
        "postal_code": 12345,
        "region": "TN",
        "street_address": "Apartment 10",
        "street_address2": 1
      },
      "id": "<string>",
      "name": "<string>",
      "price": 0
    },
    "method": "<string>",
    "name": "<string>",
    "price": 0,
    "selected_addons": [
      {
        "external_id": "<string>",
        "price": 0,
        "type": "<string>",
        "user_input": "<string>"
      }
    ],
    "tax_amount": 0,
    "tax_rate": 0,
    "timeslot": {
      "cutoff": "<string>",
      "end": "<string>",
      "id": "<string>",
      "price": 0,
      "start": "<string>"
    },
    "tms_reference": "<string>",
    "type": "<string>"
  },
  "shipping_address": {
    "attention": "Anders Exempelsson",
    "city": "Vetlanda",
    "country": "se",
    "email": "john.testsson@kustom.co",
    "family_name": "Testsson",
    "given_name": "John",
    "organization_name": "Kustom",
    "phone": "1-555-555-5555",
    "postal_code": 12345,
    "region": "TN",
    "street_address": "Testgatan 10",
    "street_address2": 1,
    "title": "Herr"
  },
  "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"
    }
  ],
  "status": "AUTHORIZED"
}

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