POST

Update an order

https://api.kustom.co/checkout/v3/orders/{order_id}

To update an order simply provide a JSON object with the properties you want to update. Properties not provided in the request will stay the same.
Please note: an order can only be updated when the status is checkout_incomplete

Parameters1 field

order_idstringrequiredin path

Request body347 fields

order_idstringoptional
Unique order ID that will be used for the entire lifecycle of the order. (max 255 characters)
namestringoptional
The merchant name (max 255 characters).
purchase_countrystringrequired
The purchase country of the merchant’s store. The format to be used is ISO 3166 alpha-2. Eg: GB, SE, DE, US, etc.

Note: purchase country and currency need to match the defined merchant configuration. For global configuration see more details here
purchase_currencystringrequired
The purchase currency of the merchant’s store. The format to be used is ISO 4217. Eg: USD, EUR, SEK, GBP, etc.

Note: purchase country and currency need to match the defined merchant configuration. For global configuration see more details here
localestringrequired
Used to define the language and region of the customer. RFC 1766 customer’s locale.
statusstringoptional
The current status of the order. The status will be ‘incomplete’ until the customer has been successfully authorized.
billing_addressobjectoptional
18 fields in billing_address
- given_namestringoptional
  Given name.
- family_namestringoptional
  Family name.
- organization_namestringoptional
  Organization name. Only applicable for orders with customer.type=“organization”.
- buyer_referencestringoptional
  Reference of the buying organization, e.g. a purchase order number. Only applicable to the billing address of orders with customer.type=“organization”. Carries the same value as the legacy billing_address.attention field.
- emailstringoptional
  E-mail address.
- titlestringoptional
  Title.
  Valid values for UK:
  - Mr
  - Ms
  - Mrs
  - Miss
  Valid values for DACH:
  - Herr
  - Frau
  Valid values for NL:
  - Dhr.
  - Mevr.
- street_addressstringoptional
  Street address, first line. (Street name and number)
- street_address2stringoptional
  Street address, second line. (Apartment number, suite, etc.)
- street_namestringoptional
  Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See streetNumber.
- street_numberstringoptional
  Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See streetName.
- house_extensionstringoptional
  House extension. Only applicable in NL
- postal_codestringoptional
  Postal/post code.
- citystringoptional
  City.
- regionstringoptional
  State or Region.
- phonestringoptional
  Phone number.
- countrystringoptional
  ISO 3166 alpha-2. Country.
- care_ofstringoptional
  Care of.
- delivery_instructionstringoptional
  Instruction for the delivery of the order, entered by the customer. Only applicable to the shipping address of orders with customer.type=“organization”. Carries the same value as the legacy shipping_address.care_of field.
shipping_addressobjectoptional
Same shape as billing_address — 18 fields, identical. Anchors under this path still resolve.
18 fields in shipping_address
- given_namestringoptional
  Given name.
- family_namestringoptional
  Family name.
- organization_namestringoptional
  Organization name. Only applicable for orders with customer.type=“organization”.
- buyer_referencestringoptional
  Reference of the buying organization, e.g. a purchase order number. Only applicable to the billing address of orders with customer.type=“organization”. Carries the same value as the legacy billing_address.attention field.
- emailstringoptional
  E-mail address.
- titlestringoptional
  Title.
  Valid values for UK:
  - Mr
  - Ms
  - Mrs
  - Miss
  Valid values for DACH:
  - Herr
  - Frau
  Valid values for NL:
  - Dhr.
  - Mevr.
- street_addressstringoptional
  Street address, first line. (Street name and number)
- street_address2stringoptional
  Street address, second line. (Apartment number, suite, etc.)
- street_namestringoptional
  Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See streetNumber.
- street_numberstringoptional
  Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See streetName.
- house_extensionstringoptional
  House extension. Only applicable in NL
- postal_codestringoptional
  Postal/post code.
- citystringoptional
  City.
- regionstringoptional
  State or Region.
- phonestringoptional
  Phone number.
- countrystringoptional
  ISO 3166 alpha-2. Country.
- care_ofstringoptional
  Care of.
- delivery_instructionstringoptional
  Instruction for the delivery of the order, entered by the customer. Only applicable to the shipping address of orders with customer.type=“organization”. Carries the same value as the legacy shipping_address.care_of field.
order_amountinteger · int64required
Total amount of the order including tax and any available discounts. The value should be in non-negative minor units.

Example: 25 Euros should be 2500.
order_tax_amountinteger · int64required
Total tax amount of the order. The value should be in non-negative minor units.

Example: 25 Euros should be 2500.
order_lines[]array<object>required
An array containing list of line items that are part of this order. Maximum of 1000 line items could be processed in a single order.
36 fields in order_lines
- typestringoptional
  Type of the order line item. The possible values are:
  - physical (physical good)
  - discount
  - shipping_fee
  - sales_tax (depends on the country/city, usually called VAT)
  - digital (digital good)
  - gift_card
  - store_credit (credit from the merchant)
  - surcharge (extra charge)
- referencestringoptional
  Article number, SKU or similar. (max 255 characters)
- namestringrequired
  Descriptive name of the order line item (max 255 characters)
- quantityinteger · int64required
  Non-negative number. Quantity of the order line item.
- subscriptionobjectoptional
  Describes the subscription. Including subscription details will also change the buy button to inform the user that they will be subscribing. (Only applicable for recurring orders)
  3 fields in subscription
  - namestringoptional
    The name of the subscription product.
    
    Example: “Premium Account”
  - intervalstringrequired
    The cadence unit for this.
    
    Example: “DAY”
    DAY
    WEEK
    MONTH
    YEAR
  - interval_countinteger · int32required
    The number of intervals.
    
    Example: 30
- quantity_unitstringoptional
  Unit used to describe the quantity, e.g. kg, pcs… If defined has to be 1-8 characters
- unit_priceinteger · int64required
  Minor units. Includes tax, excludes discount. (max value: 100000000).
  
  Example: 100 Euros should be 10000.
- tax_rateinteger · int64required
  Non-negative value. The percentage value is represented with two implicit decimals. (max 10000)
  
  Example: 25% should be 2500.
- total_amountinteger · int64required
  Minor units. Includes tax and discount.
  
  Example: 25 euros should be 2500 Value = (quantity x unit_price) - total_discount_amount. (max value: 100000000)
- total_discount_amountinteger · int64optional
  Non-negative minor units. Includes tax.
  
  Example: 25 euros should be 2500
- total_tax_amountinteger · int64required
  Must be within ±1 of total_amount - total_amount * 10000 / (10000 + tax_rate). Negative when type is discount.
- merchant_datastringoptional
  Property used to store additional metadata per item that will be returned whenever an order is read from Kustom. Pass through field. (max 1024 characters).
- product_urlstringoptional
  URL to the product page that can be later embedded in communications between Kustom and the customer. (max 1024 characters)
- image_urlstringoptional
  URL to an image that can be later embedded in communications between Kustom and the customer. (max 1024 characters)
  
  Improves post-purchase customer experiences.
- product_identifiersobjectoptional
  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.
  - colorstringoptional
    Color to be shown to the end customer (max 64 characters).
  - 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 ’ > ’. (max 750 characters)
    
    Example: “Electronics Store > Computers & Tablets > Desktops”
  - 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
  - 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
  - sizestringoptional
    Size to be shown to the end customer (max 64 characters).
- shipping_attributesobjectoptional
  11 fields in shipping_attributes
  - weightinteger · int64optional
    The product’s weight as used in the merchant’s webshop. Non-negative. Measured in grams.
  - dimensionsobjectoptional
    3 fields in dimensions
    heightinteger · int64optional
    The product’s height as used in the merchant’s webshop. Non-negative. Measured in millimeters.
    widthinteger · int64optional
    The product’s width as used in the merchant’s webshop. Non-negative. Measured in millimeters.
    lengthinteger · int64optional
    The product’s length as used in the merchant’s webshop. Non-negative. Measured in millimeters.
  - display_attributes[]array<object>optional
    Extra product information to display in the checkout, for example the selected colour or size.
    3 fields in display_attributes
    keystringrequired
    Stable identifier for the attribute.
    labelstringoptional
    Human-readable label.
    valuestringrequired
    Displayable value.
  - tags[]array<string>optional
    The product’s extra features, example [“dangerous_goods”, “bulky”]
  - delivery_idstringoptional
    The ID of the delivery this item belongs to. The delivery ID must be defined in the deliveries array of the order.
customerobjectoptional
5 fields in customer
- typestringoptional
  The default supported value is ‘person’. If B2B is enabled for the merchant, the value may be “organization”.
- genderstringoptional
  Customer’s gender - ‘male’ or ‘female’.
- date_of_birthstringoptional
  Customer’s date of birth. The format is ‘yyyy-mm-dd’. ISO 8601 date.
- organization_registration_idstringoptional
  “The organization’s official registration id (organization number).
  
  Note: Applicable only for B2B orders.”
- vat_idstringoptional
  Organization VAT ID. Only applies for b2b orders.
merchant_urlsobjectoptional
13 fields in merchant_urls
- termsstringrequired
  URL for the terms and conditions page of the merchant. The URL will be displayed inside the Kustom Checkout iFrame.(max 2000 characters) Example: “https://merchant.com/terms”
- checkoutstringrequired
  URL for the checkout page of the merchant. (max 2000 characters) Example: “https://merchant.com/checkout”
- confirmationstringrequired
  URL of the merchant confirmation page. The consumer will be redirected back to the confirmation page if the authorization is successful after the customer clicks on the ‘Place Order’ button inside checkout. The special characters of the confirmation URL should be encoded, e.g. the “space” character should be written as “%20”. Then, on top of that, the whole confirmation URL should be encoded. E.g. the “space” character should become “%2520”. (max 2000 characters) Example: “https://merchant.com/confirmation”
- pushstringrequired
  URL that will be used for push notification when an order is completed. Should be different than checkout and confirmation URLs. (max 2000 characters) Example: “https://merchant.com/push”
- validationstringoptional
  URL that will be requested for final merchant validation. (must be https, max 2000 characters) Example: “https://merchant.com/validation”
- notificationstringoptional
  URL for notifications on pending orders. (max 2000 characters) Example: “https://merchant.com/notification/{checkout.order.id}”
- cancellation_termsstringoptional
  URL for the cancellation terms page of the merchant. The URL will be displayed in the email that is sent to the customer after the order is captured.(max 2000 characters) Example: “https://merchant.com/terms/cancelation”
- shipping_option_updatestringoptional
  URL for shipping option update. (must be https, max 2000 characters) Example: “https://merchant.com/shippingoptionupdate”
- address_updatestringoptional
  URL for shipping, tax and purchase currency updates. Will be called on address changes. (must be https, max 2000 characters) Example: “https://merchant.com/addressupdate”
- country_changestringoptional
  URL for shipping, tax and purchase currency updates. Will be called on billing or shipping country changes. (must be https, max 2000 characters) Example: “https://merchant.com/countrychange”
- upsellstringoptional
  URL for upsell. Will be called on upsell. This must be enabled for the merchant to use. (must be https, max 2000 characters) Example: “https://merchant.com/upsell”
- upsell_validationstringoptional
  URL for upsell validation when a completed order is attempted to add upsell. Example: “https://merchant.com/upsell-validation”
- upsell_notificationstringoptional
  URL for notification after order updated with upsell. (must be https, max 2000 characters) Example: “https://merchant.com/upsell/{checkout.order.id}”
html_snippetstringoptional
The HTML snippet that is used to render the checkout in an iframe.
merchant_reference1stringoptional
Used for storing merchant’s internal order number or other reference. If set, will be shown on the confirmation page as “order number” . The value is also available in the settlement files. (max 255 characters). Example: “45aa52f387871e3a210645d4”
merchant_reference2stringoptional
Used for storing merchant’s internal order number or other reference. The value is available in the settlement files. (max 255 characters). Example: “45aa52f387871e3a210645d4”
started_atstring · date-timeoptional
ISO 8601 datetime. The date and time when the order has been created. The format will be as follows: “yyyy-mm-ddThh:mm:ssZ”
completed_atstring · date-timeoptional
ISO 8601 datetime. The date and time when the order has been completed. The format will be as follows: “yyyy-mm-ddThh:mm:ssZ”
last_modified_atstring · date-timeoptional
ISO 8601 datetime. The date and time when the order was last modified. The format will be as follows: “yyyy-mm-ddThh:mm:ssZ”
optionsobjectoptional
39 fields in options
- require_validate_callback_successbooleanoptional
  If true, validate callback must get a positive response to not stop purchase. Default: false.
- acquiring_channelstringoptional
  Acquiring channel for the order. The possible values are:
  - ECOMMERCE for "E-commerce"
  - IN_STORE for "Purchase in boutique"
  - Default : ECOMMERCE
- vat_removedbooleanoptional
  If true, VAT is not displayed in Checkout’s Order Summary page.
- tms_configuration_overrideobjectoptional
  1 field in tms_configuration_override
  - disabledbooleanoptional
    If true, the TMS integration will be disabled for this session.
- subscription_buy_buttonbooleanoptional
  If true, the buy button will show ‘Subscribe’ instead of ‘Buy’ to indicate a subscription purchase
- allow_separate_shipping_addressbooleanoptional
  If true, the consumer can enter different billing and shipping addresses. Default: false, except for purchase_country DE where default is: true
- color_buttonstringoptional
  Color for the buttons within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_button_textstringoptional
  Color for the text inside the buttons within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_checkboxstringoptional
  Color for the checkboxes within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_checkbox_checkmarkstringoptional
  Color for the checkboxes checkmark within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_headerstringoptional
  Color for the headers within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_linkstringoptional
  Color for the hyperlinks within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_backgroundstringoptional
  Color for the background within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- date_of_birth_mandatorybooleanoptional
  If true, the consumer cannot skip date of birth. Default: false
- date_of_birth_optionalbooleanoptional
  If true, the consumer are able to enter date of birth, but can skip it. Default: false
- shipping_detailsstringoptional
  A message that will be presented on the confirmation page under the headline “Delivery” (max 255 characters).
- title_mandatorybooleanoptional
  If specified to false, title becomes optional. Only available for orders for country GB.
- additional_checkboxobjectoptional
  3 fields in additional_checkbox
  - textstringrequired
    Text that will be displayed to the consumer aside the checkbox. Links and formatting can be added using Markdown. (max 1000 characters)
  - checkedbooleanrequired
    Default state of the additional checkbox. It will use this value when loaded for the first time.
  - requiredbooleanrequired
    Whether it is required for the consumer to check the additional checkbox box or not in order to complete the purchase.
- national_identification_number_mandatorybooleanoptional
  If true, the user cannot skip national identification number in SE, NO, FI and DK. Default: false. In order to read the national identification number in the validation callback, please contact Kustom’s merchant support.
- additional_merchant_termsstringoptional
  Additional merchant defined field. e.g. Extra terms and conditions to show.
  
  Example: “ADDITIONAL MERCHANT TERMS! [terms link](https://merchant.com/extra_terms)”
- phone_mandatorybooleanoptional
  If false, the consumer can skip the phone. Only available for orders in DACH countries.
- radius_borderstringoptional
  Radius for the border of elements within the iFrame.
- allowed_customer_types[]array<string>optional
  A list of allowed customer types. Supported types: person & organization. Example: [“person”,“organization”]
- show_subtotal_detailbooleanoptional
  If true, the Order Detail subtotals view is expanded when the Kustom Checkout iFrame is loaded. Default: false
- additional_checkboxes[]array<object>optional
  4 fields in additional_checkboxes
  - textstringrequired
    Text that will be displayed to the consumer aside the checkbox. Links and formatting can be added using Markdown. (max 1000 characters)
  - checkedbooleanrequired
    Default state of the additional checkbox. It will use this value when loaded for the first time.
  - requiredbooleanrequired
    Whether it is required for the consumer to check the additional checkbox box or not in order to complete the purchase.
  - idstringrequired
    Identifier used when presenting data back to merchant
- verify_national_identification_numberbooleanoptional
  Enable verification of National Identification Numbers only in Sweden and Norway. This option also make the national identification number mandatory. (Not applicable for countries outside of Sweden and Norway)
- auto_capturebooleanoptional
  Allow merchant to trigger auto capturing.
- require_client_validationbooleanoptional
  If true, a client side validation is needed to complete the purchase
- show_vat_registration_number_fieldbooleanoptional
  If true, a optional VAT registration number field will be shown in the address form. Only applies for b2b orders.
- confirmation_page_upsellbooleanoptional
  If true, upsell recommendations will be presented on the order confirmation page.
- analytics_enabledbooleanoptional
  If true, front end analytics are enabled at checkout. Default: false
attachmentobjectoptional
2 fields in attachment
- bodystringrequired
  The content of the extra merchant data which should be presented as a string inside this property. The body should be an object containing any of the keys and sub objects described below serialised to JSON. More information on that object can be found here.
- content_typestringrequired
  The content type of the body. It is usually represented as “application/vnd.klarna.internal.emd-v2+json”
external_payment_methods[]array<object>optional
List of external payment methods that will be displayed as part of payment methods in the checkout.
7 fields in external_payment_methods
- namestringrequired
  The name of the payment provider. (max 255 characters)
- feeinteger · int64optional
  Minor units. Includes tax.
- descriptionstringoptional
  Short description of the payment method. This is displayed below the selected payment method. (max 500 characters)
- countries[]array<string>optional
  If specified, limits the method to the listed countries (alpha 2 codes).
- labelstringoptional
  Controls label of buy button
  - continue
  - complete
- redirect_urlstringrequired
  URL to redirect to. (must be https, min 7, max 2000 characters)
- image_urlstringoptional
  URL to an image to display. (must be https, max 2000 characters)
external_checkouts[]array<object>optional
List of external checkouts that will be displayed as part of payment methods in the checkout. The image_url is required, and the image size has to be 276x48px
Same shape as external_payment_methods — 7 fields, identical. Anchors under this path still resolve.
7 fields in external_checkouts
- namestringrequired
  The name of the payment provider. (max 255 characters)
- feeinteger · int64optional
  Minor units. Includes tax.
- descriptionstringoptional
  Short description of the payment method. This is displayed below the selected payment method. (max 500 characters)
- countries[]array<string>optional
  If specified, limits the method to the listed countries (alpha 2 codes).
- labelstringoptional
  Controls label of buy button
  - continue
  - complete
- redirect_urlstringrequired
  URL to redirect to. (must be https, min 7, max 2000 characters)
- image_urlstringoptional
  URL to an image to display. (must be https, max 2000 characters)
shipping_countries[]array<string>optional
List of allowed shipping countries for this order in ISO-3166 alpha-2 format.

If specified, the customer will be able to change the shipping country in the checkout and you will be notified through ‘address_update’ callback or the ‘shipping_address_change’ javascript event.

If not specified then the default value will be the purchase country.

Example: look at billing_countries example.
shipping_options[]array<object>optional
A list of shipping options available for this order.
54 fields in shipping_options
- idstringrequired
  The unique identifier of the shipping option
- namestringrequired
  Name.
- descriptionstringoptional
  Description.
- promostringoptional
  Promotion name. To be used if this shipping option is promotional.
- priceinteger · int64required
  Price including tax.
- preselectedbooleanoptional
  If true, this option will be preselected when checkout loads. Default: false
- tax_amountinteger · int64required
  Tax amount.
- tax_rateinteger · int64required
  Non-negative. In percent, two implicit decimals. I.e 2500 = 25%.
- shipping_methodstringoptional
  Shipping method. Possible values:
  - PickUpStore
  - Home
  - BoxReg
  - BoxUnreg
  - PickUpPoint
  - Own
  - Postal
  - DHLPackstation
  - Digital
  If DHLPackstation is selected the correct form will be displayed.
- delivery_detailsobjectoptional
  35 fields in delivery_details
  - carrierstringoptional
    Carrier product name
  - classstringoptional
    Type of shipping class
  - productobjectoptional
    6 fields in product
    namestringoptional
    Carrier product name
    identifierstringoptional
    Carrier product identifier
    external_idstringoptional
    The external identifier of the carrier
    product_namestringoptional
    The product or service level name provided by the carrier
    metaobjectoptional
    Carrier-specific metadata
    1 field in meta
    keystringoptional
    Any additional property. The key is free-form; the value has this shape.
  - timeslotobjectoptional
    3 fields in timeslot
    idstringoptional
    Id
    startstringoptional
    Start time
    endstringoptional
    End time
  - pickup_locationobjectoptional
    21 fields in pickup_location
    idstringoptional
    Id
    namestringoptional
    Name of the location
    addressobjectoptional
    18 fields in address
    given_namestringoptional
    Given name.
    family_namestringoptional
    Family name.
    organization_namestringoptional
    Organization name. Only applicable for orders with customer.type=“organization”.
    buyer_referencestringoptional
    Reference of the buying organization, e.g. a purchase order number. Only applicable to the billing address of orders with customer.type=“organization”. Carries the same value as the legacy billing_address.attention field.
    emailstringoptional
    E-mail address.
    titlestringoptional
    Title.
    Valid values for UK:
    Mr
    Ms
    Mrs
    Miss
    Valid values for DACH:
    Herr
    Frau
    Valid values for NL:
    Dhr.
    Mevr.
    street_addressstringoptional
    Street address, first line. (Street name and number)
    street_address2stringoptional
    Street address, second line. (Apartment number, suite, etc.)
    street_namestringoptional
    Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See streetNumber.
    street_numberstringoptional
    Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See streetName.
    house_extensionstringoptional
    House extension. Only applicable in NL
    postal_codestringoptional
    Postal/post code.
    citystringoptional
    City.
    regionstringoptional
    State or Region.
    phonestringoptional
    Phone number.
    countrystringoptional
    ISO 3166 alpha-2. Country.
    care_ofstringoptional
    Care of.
    delivery_instructionstringoptional
    Instruction for the delivery of the order, entered by the customer. Only applicable to the shipping address of orders with customer.type=“organization”. Carries the same value as the legacy shipping_address.care_of field.
- tms_referencestringoptional
  TMS reference. Required to map completed orders to shipments reserved in TMS.
- tos_idstringoptional
  TOS ID. Required to map completed orders to shipments reserved via Ingrid.
- selected_addons[]array<object>optional
  5 fields in selected_addons
  - typestringoptional
  - priceinteger · int64optional
  - external_idstringoptional
  - user_inputstringoptional
  - display_namestringoptional
- external_method_idstringoptional
  The external identifier defined on the TMS (Only applicable for Ingrid-Headless)
merchant_datastringoptional
Pass through field to send any information about the order to be used later for reference while retrieving the order details (max 6000 characters).
guiobjectoptional
1 field in gui
- options[]array<string>optional
  An array of options to define the checkout behaviour. Supported options: minimal_confirmation.
  
  The gui object is an array of options to modify checkout client ui behaviours.
  
  Examples: [“minimal_confirmation”]
merchant_requestedobjectoptional
4 fields in merchant_requested
- additional_checkboxbooleanoptional
  Informs whether the additional_checkbox is checked or not, when applicable.
- additional_checkboxes[]array<object>optional
  Informs whether the additional_checkboxes is checked or not, when applicable.
  2 fields in additional_checkboxes
  - idstringoptional
  - checkedbooleanoptional
selected_shipping_optionobjectoptional
Same shape as shipping_options — 54 fields, identical. Anchors under this path still resolve.
54 fields in selected_shipping_option
- idstringrequired
  The unique identifier of the shipping option
- namestringrequired
  Name.
- descriptionstringoptional
  Description.
- promostringoptional
  Promotion name. To be used if this shipping option is promotional.
- priceinteger · int64required
  Price including tax.
- preselectedbooleanoptional
  If true, this option will be preselected when checkout loads. Default: false
- tax_amountinteger · int64required
  Tax amount.
- tax_rateinteger · int64required
  Non-negative. In percent, two implicit decimals. I.e 2500 = 25%.
- shipping_methodstringoptional
  Shipping method. Possible values:
  - PickUpStore
  - Home
  - BoxReg
  - BoxUnreg
  - PickUpPoint
  - Own
  - Postal
  - DHLPackstation
  - Digital
  If DHLPackstation is selected the correct form will be displayed.
- delivery_detailsobjectoptional
  35 fields in delivery_details
  - carrierstringoptional
    Carrier product name
  - classstringoptional
    Type of shipping class
  - productobjectoptional
    6 fields in product
    namestringoptional
    Carrier product name
    identifierstringoptional
    Carrier product identifier
    external_idstringoptional
    The external identifier of the carrier
    product_namestringoptional
    The product or service level name provided by the carrier
    metaobjectoptional
    Carrier-specific metadata
    1 field in meta
    keystringoptional
    Any additional property. The key is free-form; the value has this shape.
  - timeslotobjectoptional
    3 fields in timeslot
    idstringoptional
    Id
    startstringoptional
    Start time
    endstringoptional
    End time
  - pickup_locationobjectoptional
    21 fields in pickup_location
    idstringoptional
    Id
    namestringoptional
    Name of the location
    addressobjectoptional
    18 fields in address
    given_namestringoptional
    Given name.
    family_namestringoptional
    Family name.
    organization_namestringoptional
    Organization name. Only applicable for orders with customer.type=“organization”.
    buyer_referencestringoptional
    Reference of the buying organization, e.g. a purchase order number. Only applicable to the billing address of orders with customer.type=“organization”. Carries the same value as the legacy billing_address.attention field.
    emailstringoptional
    E-mail address.
    titlestringoptional
    Title.
    Valid values for UK:
    Mr
    Ms
    Mrs
    Miss
    Valid values for DACH:
    Herr
    Frau
    Valid values for NL:
    Dhr.
    Mevr.
    street_addressstringoptional
    Street address, first line. (Street name and number)
    street_address2stringoptional
    Street address, second line. (Apartment number, suite, etc.)
    street_namestringoptional
    Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See streetNumber.
    street_numberstringoptional
    Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See streetName.
    house_extensionstringoptional
    House extension. Only applicable in NL
    postal_codestringoptional
    Postal/post code.
    citystringoptional
    City.
    regionstringoptional
    State or Region.
    phonestringoptional
    Phone number.
    countrystringoptional
    ISO 3166 alpha-2. Country.
    care_ofstringoptional
    Care of.
    delivery_instructionstringoptional
    Instruction for the delivery of the order, entered by the customer. Only applicable to the shipping address of orders with customer.type=“organization”. Carries the same value as the legacy shipping_address.care_of field.
- tms_referencestringoptional
  TMS reference. Required to map completed orders to shipments reserved in TMS.
- tos_idstringoptional
  TOS ID. Required to map completed orders to shipments reserved via Ingrid.
- selected_addons[]array<object>optional
  5 fields in selected_addons
  - typestringoptional
  - priceinteger · int64optional
  - external_idstringoptional
  - user_inputstringoptional
  - display_namestringoptional
- external_method_idstringoptional
  The external identifier defined on the TMS (Only applicable for Ingrid-Headless)
selected_shipping_options[]array<object>optional
Same shape as shipping_options — 54 fields, identical. Anchors under this path still resolve.
54 fields in selected_shipping_options
- idstringrequired
  The unique identifier of the shipping option
- namestringrequired
  Name.
- descriptionstringoptional
  Description.
- promostringoptional
  Promotion name. To be used if this shipping option is promotional.
- priceinteger · int64required
  Price including tax.
- preselectedbooleanoptional
  If true, this option will be preselected when checkout loads. Default: false
- tax_amountinteger · int64required
  Tax amount.
- tax_rateinteger · int64required
  Non-negative. In percent, two implicit decimals. I.e 2500 = 25%.
- shipping_methodstringoptional
  Shipping method. Possible values:
  - PickUpStore
  - Home
  - BoxReg
  - BoxUnreg
  - PickUpPoint
  - Own
  - Postal
  - DHLPackstation
  - Digital
  If DHLPackstation is selected the correct form will be displayed.
- delivery_detailsobjectoptional
  35 fields in delivery_details
  - carrierstringoptional
    Carrier product name
  - classstringoptional
    Type of shipping class
  - productobjectoptional
    6 fields in product
    namestringoptional
    Carrier product name
    identifierstringoptional
    Carrier product identifier
    external_idstringoptional
    The external identifier of the carrier
    product_namestringoptional
    The product or service level name provided by the carrier
    metaobjectoptional
    Carrier-specific metadata
    1 field in meta
    keystringoptional
    Any additional property. The key is free-form; the value has this shape.
  - timeslotobjectoptional
    3 fields in timeslot
    idstringoptional
    Id
    startstringoptional
    Start time
    endstringoptional
    End time
  - pickup_locationobjectoptional
    21 fields in pickup_location
    idstringoptional
    Id
    namestringoptional
    Name of the location
    addressobjectoptional
    18 fields in address
    given_namestringoptional
    Given name.
    family_namestringoptional
    Family name.
    organization_namestringoptional
    Organization name. Only applicable for orders with customer.type=“organization”.
    buyer_referencestringoptional
    Reference of the buying organization, e.g. a purchase order number. Only applicable to the billing address of orders with customer.type=“organization”. Carries the same value as the legacy billing_address.attention field.
    emailstringoptional
    E-mail address.
    titlestringoptional
    Title.
    Valid values for UK:
    Mr
    Ms
    Mrs
    Miss
    Valid values for DACH:
    Herr
    Frau
    Valid values for NL:
    Dhr.
    Mevr.
    street_addressstringoptional
    Street address, first line. (Street name and number)
    street_address2stringoptional
    Street address, second line. (Apartment number, suite, etc.)
    street_namestringoptional
    Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See streetNumber.
    street_numberstringoptional
    Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See streetName.
    house_extensionstringoptional
    House extension. Only applicable in NL
    postal_codestringoptional
    Postal/post code.
    citystringoptional
    City.
    regionstringoptional
    State or Region.
    phonestringoptional
    Phone number.
    countrystringoptional
    ISO 3166 alpha-2. Country.
    care_ofstringoptional
    Care of.
    delivery_instructionstringoptional
    Instruction for the delivery of the order, entered by the customer. Only applicable to the shipping address of orders with customer.type=“organization”. Carries the same value as the legacy shipping_address.care_of field.
- tms_referencestringoptional
  TMS reference. Required to map completed orders to shipments reserved in TMS.
- tos_idstringoptional
  TOS ID. Required to map completed orders to shipments reserved via Ingrid.
- selected_addons[]array<object>optional
  5 fields in selected_addons
  - typestringoptional
  - priceinteger · int64optional
  - external_idstringoptional
  - user_inputstringoptional
  - display_namestringoptional
- external_method_idstringoptional
  The external identifier defined on the TMS (Only applicable for Ingrid-Headless)
recurringbooleanoptional
Indicates whether this purchase will create a token that can be used by the merchant to create recurring purchases. This must be enabled for the merchant to use. Default: false

Depending on specified country, recurring could be used for the following payment methods: Klarna Pay Later, Direct Debit, Card, Apple Pay, Google Pay.
recurring_tokenstringoptional
Token to be used when creating recurring orders.
recurring_descriptionstringoptional
Description to be added to the recurring order.
billing_countries[]array<string>optional
List of allowed billing countries for this order. If specified, the customer will be able to change the billing country in the checkout and you will be notified through ‘country_change’ callback or the ‘billing_address_change’ javascript event. If not specified but shipping_countries is specified, will use same values as shipping_countries. If not specified and shipping_countries is not specified, then the default value will be the purchase country.

Example: [“AD”, “AE”, “AG”, “AI”, “AL”, “AM”, “AQ”, “AR”, “AS”, “AT”, “AU”, “AW”, “AX”, “AZ”, “BA”, “BB”, “BD”, “BE”, “BF”, “BG”, “BH”, “BJ”, “BL”, “BM”, “BN”, “BO”, “BQ”, “BR”, “BS”, “BT”, “BW”, “BY”, “BZ”, “CA”, “CF”, “CH”, “CI”, “CK”, “CL”, “CM”, “CN”, “CO”, “CR”, “CU”, “CV”, “CW”, “CX”, “CY”, “CZ”, “DE”, “DJ”, “DK”, “DM”, “DO”, “DZ”, “EC”, “EE”, “EG”, “ER”, “ES”, “ET”, “FI”, “FJ”, “FK”, “FM”, “FO”, “FR”, “GA”, “GB”, “GD”, “GE”, “GF”, “GG”, “GH”, “GI”, “GL”, “GM”, “GN”, “GP”, “GR”, “GS”, “GT”, “GU”, “GY”, “HK”, “HN”, “HR”, “HU”, “ID”, “IE”, “IL”, “IM”, “IN”, “IS”, “IT”, “JE”, “JM”, “JO”, “JP”, “KE”, “KG”, “KI”, “KM”, “KN”, “KR”, “KW”, “KY”, “KZ”, “LA”, “LA”, “LB”, “LC”, “LI”, “LK”, “LR”, “LS”, “LT”, “LU”, “LV”, “MA”, “MC”, “MD”, “ME”, “MF”, “MG”, “MH”, “MK”, “MK”, “ML”, “MM”, “MN”, “MO”, “MP”, “MQ”, “MR”, “MT”, “MU”, “MV”, “MW”, “MX”, “MY”, “MZ”, “NA”, “NC”, “NE”, “NF”, “NG”, “NI”, “NL”, “NO”, “NP”, “NR”, “NU”, “NZ”, “OM”, “PA”, “PE”, “PF”, “PG”, “PH”, “PK”, “PL”, “PM”, “PR”, “PS”, “PT”, “PW”, “PY”, “QA”, “RE”, “RO”, “RS”, “RU”, “RW”, “SA”, “SB”, “SC”, “SE”, “SG”, “SH”, “SI”, “SJ”, “SK”, “SL”, “SM”, “SN”, “SR”, “ST”, “SV”, “SX”, “SZ”, “TC”, “TF”, “TG”, “TH”, “TJ”, “TK”, “TL”, “TO”, “TR”, “TT”, “TV”, “TW”, “TZ”, “UA”, “UG”, “UM”, “US”, “UY”, “UZ”, “VA”, “VC”, “VG”, “VI”, “VN”, “VU”, “WF”, “WS”, “XK”, “YT”, “ZA”, “ZM”, “ZW”]”
tags[]array<string>optional
Extra information added to the order.

Example: [“dangerous_goods”, “bulky”]

200

Response347 fields

successful operation

order_idstringoptional
Unique order ID that will be used for the entire lifecycle of the order. (max 255 characters)
namestringoptional
The merchant name (max 255 characters).
purchase_countrystringrequired
The purchase country of the merchant’s store. The format to be used is ISO 3166 alpha-2. Eg: GB, SE, DE, US, etc.

Note: purchase country and currency need to match the defined merchant configuration. For global configuration see more details here
purchase_currencystringrequired
The purchase currency of the merchant’s store. The format to be used is ISO 4217. Eg: USD, EUR, SEK, GBP, etc.

Note: purchase country and currency need to match the defined merchant configuration. For global configuration see more details here
localestringrequired
Used to define the language and region of the customer. RFC 1766 customer’s locale.
statusstringoptional
The current status of the order. The status will be ‘incomplete’ until the customer has been successfully authorized.
billing_addressobjectoptional
18 fields in billing_address
- given_namestringoptional
  Given name.
- family_namestringoptional
  Family name.
- organization_namestringoptional
  Organization name. Only applicable for orders with customer.type=“organization”.
- buyer_referencestringoptional
  Reference of the buying organization, e.g. a purchase order number. Only applicable to the billing address of orders with customer.type=“organization”. Carries the same value as the legacy billing_address.attention field.
- emailstringoptional
  E-mail address.
- titlestringoptional
  Title.
  Valid values for UK:
  - Mr
  - Ms
  - Mrs
  - Miss
  Valid values for DACH:
  - Herr
  - Frau
  Valid values for NL:
  - Dhr.
  - Mevr.
- street_addressstringoptional
  Street address, first line. (Street name and number)
- street_address2stringoptional
  Street address, second line. (Apartment number, suite, etc.)
- street_namestringoptional
  Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See streetNumber.
- street_numberstringoptional
  Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See streetName.
- house_extensionstringoptional
  House extension. Only applicable in NL
- postal_codestringoptional
  Postal/post code.
- citystringoptional
  City.
- regionstringoptional
  State or Region.
- phonestringoptional
  Phone number.
- countrystringoptional
  ISO 3166 alpha-2. Country.
- care_ofstringoptional
  Care of.
- delivery_instructionstringoptional
  Instruction for the delivery of the order, entered by the customer. Only applicable to the shipping address of orders with customer.type=“organization”. Carries the same value as the legacy shipping_address.care_of field.
shipping_addressobjectoptional
Same shape as billing_address — 18 fields, identical. Anchors under this path still resolve.
18 fields in shipping_address
- given_namestringoptional
  Given name.
- family_namestringoptional
  Family name.
- organization_namestringoptional
  Organization name. Only applicable for orders with customer.type=“organization”.
- buyer_referencestringoptional
  Reference of the buying organization, e.g. a purchase order number. Only applicable to the billing address of orders with customer.type=“organization”. Carries the same value as the legacy billing_address.attention field.
- emailstringoptional
  E-mail address.
- titlestringoptional
  Title.
  Valid values for UK:
  - Mr
  - Ms
  - Mrs
  - Miss
  Valid values for DACH:
  - Herr
  - Frau
  Valid values for NL:
  - Dhr.
  - Mevr.
- street_addressstringoptional
  Street address, first line. (Street name and number)
- street_address2stringoptional
  Street address, second line. (Apartment number, suite, etc.)
- street_namestringoptional
  Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See streetNumber.
- street_numberstringoptional
  Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See streetName.
- house_extensionstringoptional
  House extension. Only applicable in NL
- postal_codestringoptional
  Postal/post code.
- citystringoptional
  City.
- regionstringoptional
  State or Region.
- phonestringoptional
  Phone number.
- countrystringoptional
  ISO 3166 alpha-2. Country.
- care_ofstringoptional
  Care of.
- delivery_instructionstringoptional
  Instruction for the delivery of the order, entered by the customer. Only applicable to the shipping address of orders with customer.type=“organization”. Carries the same value as the legacy shipping_address.care_of field.
order_amountinteger · int64required
Total amount of the order including tax and any available discounts. The value should be in non-negative minor units.

Example: 25 Euros should be 2500.
order_tax_amountinteger · int64required
Total tax amount of the order. The value should be in non-negative minor units.

Example: 25 Euros should be 2500.
order_lines[]array<object>required
An array containing list of line items that are part of this order. Maximum of 1000 line items could be processed in a single order.
36 fields in order_lines
- typestringoptional
  Type of the order line item. The possible values are:
  - physical (physical good)
  - discount
  - shipping_fee
  - sales_tax (depends on the country/city, usually called VAT)
  - digital (digital good)
  - gift_card
  - store_credit (credit from the merchant)
  - surcharge (extra charge)
- referencestringoptional
  Article number, SKU or similar. (max 255 characters)
- namestringrequired
  Descriptive name of the order line item (max 255 characters)
- quantityinteger · int64required
  Non-negative number. Quantity of the order line item.
- subscriptionobjectoptional
  Describes the subscription. Including subscription details will also change the buy button to inform the user that they will be subscribing. (Only applicable for recurring orders)
  3 fields in subscription
  - namestringoptional
    The name of the subscription product.
    
    Example: “Premium Account”
  - intervalstringrequired
    The cadence unit for this.
    
    Example: “DAY”
    DAY
    WEEK
    MONTH
    YEAR
  - interval_countinteger · int32required
    The number of intervals.
    
    Example: 30
- quantity_unitstringoptional
  Unit used to describe the quantity, e.g. kg, pcs… If defined has to be 1-8 characters
- unit_priceinteger · int64required
  Minor units. Includes tax, excludes discount. (max value: 100000000).
  
  Example: 100 Euros should be 10000.
- tax_rateinteger · int64required
  Non-negative value. The percentage value is represented with two implicit decimals. (max 10000)
  
  Example: 25% should be 2500.
- total_amountinteger · int64required
  Minor units. Includes tax and discount.
  
  Example: 25 euros should be 2500 Value = (quantity x unit_price) - total_discount_amount. (max value: 100000000)
- total_discount_amountinteger · int64optional
  Non-negative minor units. Includes tax.
  
  Example: 25 euros should be 2500
- total_tax_amountinteger · int64required
  Must be within ±1 of total_amount - total_amount * 10000 / (10000 + tax_rate). Negative when type is discount.
- merchant_datastringoptional
  Property used to store additional metadata per item that will be returned whenever an order is read from Kustom. Pass through field. (max 1024 characters).
- product_urlstringoptional
  URL to the product page that can be later embedded in communications between Kustom and the customer. (max 1024 characters)
- image_urlstringoptional
  URL to an image that can be later embedded in communications between Kustom and the customer. (max 1024 characters)
  
  Improves post-purchase customer experiences.
- product_identifiersobjectoptional
  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.
  - colorstringoptional
    Color to be shown to the end customer (max 64 characters).
  - 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 ’ > ’. (max 750 characters)
    
    Example: “Electronics Store > Computers & Tablets > Desktops”
  - 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
  - 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
  - sizestringoptional
    Size to be shown to the end customer (max 64 characters).
- shipping_attributesobjectoptional
  11 fields in shipping_attributes
  - weightinteger · int64optional
    The product’s weight as used in the merchant’s webshop. Non-negative. Measured in grams.
  - dimensionsobjectoptional
    3 fields in dimensions
    heightinteger · int64optional
    The product’s height as used in the merchant’s webshop. Non-negative. Measured in millimeters.
    widthinteger · int64optional
    The product’s width as used in the merchant’s webshop. Non-negative. Measured in millimeters.
    lengthinteger · int64optional
    The product’s length as used in the merchant’s webshop. Non-negative. Measured in millimeters.
  - display_attributes[]array<object>optional
    Extra product information to display in the checkout, for example the selected colour or size.
    3 fields in display_attributes
    keystringrequired
    Stable identifier for the attribute.
    labelstringoptional
    Human-readable label.
    valuestringrequired
    Displayable value.
  - tags[]array<string>optional
    The product’s extra features, example [“dangerous_goods”, “bulky”]
  - delivery_idstringoptional
    The ID of the delivery this item belongs to. The delivery ID must be defined in the deliveries array of the order.
customerobjectoptional
5 fields in customer
- typestringoptional
  The default supported value is ‘person’. If B2B is enabled for the merchant, the value may be “organization”.
- genderstringoptional
  Customer’s gender - ‘male’ or ‘female’.
- date_of_birthstringoptional
  Customer’s date of birth. The format is ‘yyyy-mm-dd’. ISO 8601 date.
- organization_registration_idstringoptional
  “The organization’s official registration id (organization number).
  
  Note: Applicable only for B2B orders.”
- vat_idstringoptional
  Organization VAT ID. Only applies for b2b orders.
merchant_urlsobjectoptional
13 fields in merchant_urls
- termsstringrequired
  URL for the terms and conditions page of the merchant. The URL will be displayed inside the Kustom Checkout iFrame.(max 2000 characters) Example: “https://merchant.com/terms”
- checkoutstringrequired
  URL for the checkout page of the merchant. (max 2000 characters) Example: “https://merchant.com/checkout”
- confirmationstringrequired
  URL of the merchant confirmation page. The consumer will be redirected back to the confirmation page if the authorization is successful after the customer clicks on the ‘Place Order’ button inside checkout. The special characters of the confirmation URL should be encoded, e.g. the “space” character should be written as “%20”. Then, on top of that, the whole confirmation URL should be encoded. E.g. the “space” character should become “%2520”. (max 2000 characters) Example: “https://merchant.com/confirmation”
- pushstringrequired
  URL that will be used for push notification when an order is completed. Should be different than checkout and confirmation URLs. (max 2000 characters) Example: “https://merchant.com/push”
- validationstringoptional
  URL that will be requested for final merchant validation. (must be https, max 2000 characters) Example: “https://merchant.com/validation”
- notificationstringoptional
  URL for notifications on pending orders. (max 2000 characters) Example: “https://merchant.com/notification/{checkout.order.id}”
- cancellation_termsstringoptional
  URL for the cancellation terms page of the merchant. The URL will be displayed in the email that is sent to the customer after the order is captured.(max 2000 characters) Example: “https://merchant.com/terms/cancelation”
- shipping_option_updatestringoptional
  URL for shipping option update. (must be https, max 2000 characters) Example: “https://merchant.com/shippingoptionupdate”
- address_updatestringoptional
  URL for shipping, tax and purchase currency updates. Will be called on address changes. (must be https, max 2000 characters) Example: “https://merchant.com/addressupdate”
- country_changestringoptional
  URL for shipping, tax and purchase currency updates. Will be called on billing or shipping country changes. (must be https, max 2000 characters) Example: “https://merchant.com/countrychange”
- upsellstringoptional
  URL for upsell. Will be called on upsell. This must be enabled for the merchant to use. (must be https, max 2000 characters) Example: “https://merchant.com/upsell”
- upsell_validationstringoptional
  URL for upsell validation when a completed order is attempted to add upsell. Example: “https://merchant.com/upsell-validation”
- upsell_notificationstringoptional
  URL for notification after order updated with upsell. (must be https, max 2000 characters) Example: “https://merchant.com/upsell/{checkout.order.id}”
html_snippetstringoptional
The HTML snippet that is used to render the checkout in an iframe.
merchant_reference1stringoptional
Used for storing merchant’s internal order number or other reference. If set, will be shown on the confirmation page as “order number” . The value is also available in the settlement files. (max 255 characters). Example: “45aa52f387871e3a210645d4”
merchant_reference2stringoptional
Used for storing merchant’s internal order number or other reference. The value is available in the settlement files. (max 255 characters). Example: “45aa52f387871e3a210645d4”
started_atstring · date-timeoptional
ISO 8601 datetime. The date and time when the order has been created. The format will be as follows: “yyyy-mm-ddThh:mm:ssZ”
completed_atstring · date-timeoptional
ISO 8601 datetime. The date and time when the order has been completed. The format will be as follows: “yyyy-mm-ddThh:mm:ssZ”
last_modified_atstring · date-timeoptional
ISO 8601 datetime. The date and time when the order was last modified. The format will be as follows: “yyyy-mm-ddThh:mm:ssZ”
optionsobjectoptional
39 fields in options
- require_validate_callback_successbooleanoptional
  If true, validate callback must get a positive response to not stop purchase. Default: false.
- acquiring_channelstringoptional
  Acquiring channel for the order. The possible values are:
  - ECOMMERCE for "E-commerce"
  - IN_STORE for "Purchase in boutique"
  - Default : ECOMMERCE
- vat_removedbooleanoptional
  If true, VAT is not displayed in Checkout’s Order Summary page.
- tms_configuration_overrideobjectoptional
  1 field in tms_configuration_override
  - disabledbooleanoptional
    If true, the TMS integration will be disabled for this session.
- subscription_buy_buttonbooleanoptional
  If true, the buy button will show ‘Subscribe’ instead of ‘Buy’ to indicate a subscription purchase
- allow_separate_shipping_addressbooleanoptional
  If true, the consumer can enter different billing and shipping addresses. Default: false, except for purchase_country DE where default is: true
- color_buttonstringoptional
  Color for the buttons within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_button_textstringoptional
  Color for the text inside the buttons within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_checkboxstringoptional
  Color for the checkboxes within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_checkbox_checkmarkstringoptional
  Color for the checkboxes checkmark within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_headerstringoptional
  Color for the headers within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_linkstringoptional
  Color for the hyperlinks within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- color_backgroundstringoptional
  Color for the background within the iFrame. Value should be a CSS hex color, e.g. “#FF9900”
- date_of_birth_mandatorybooleanoptional
  If true, the consumer cannot skip date of birth. Default: false
- date_of_birth_optionalbooleanoptional
  If true, the consumer are able to enter date of birth, but can skip it. Default: false
- shipping_detailsstringoptional
  A message that will be presented on the confirmation page under the headline “Delivery” (max 255 characters).
- title_mandatorybooleanoptional
  If specified to false, title becomes optional. Only available for orders for country GB.
- additional_checkboxobjectoptional
  3 fields in additional_checkbox
  - textstringrequired
    Text that will be displayed to the consumer aside the checkbox. Links and formatting can be added using Markdown. (max 1000 characters)
  - checkedbooleanrequired
    Default state of the additional checkbox. It will use this value when loaded for the first time.
  - requiredbooleanrequired
    Whether it is required for the consumer to check the additional checkbox box or not in order to complete the purchase.
- national_identification_number_mandatorybooleanoptional
  If true, the user cannot skip national identification number in SE, NO, FI and DK. Default: false. In order to read the national identification number in the validation callback, please contact Kustom’s merchant support.
- additional_merchant_termsstringoptional
  Additional merchant defined field. e.g. Extra terms and conditions to show.
  
  Example: “ADDITIONAL MERCHANT TERMS! [terms link](https://merchant.com/extra_terms)”
- phone_mandatorybooleanoptional
  If false, the consumer can skip the phone. Only available for orders in DACH countries.
- radius_borderstringoptional
  Radius for the border of elements within the iFrame.
- allowed_customer_types[]array<string>optional
  A list of allowed customer types. Supported types: person & organization. Example: [“person”,“organization”]
- show_subtotal_detailbooleanoptional
  If true, the Order Detail subtotals view is expanded when the Kustom Checkout iFrame is loaded. Default: false
- additional_checkboxes[]array<object>optional
  4 fields in additional_checkboxes
  - textstringrequired
    Text that will be displayed to the consumer aside the checkbox. Links and formatting can be added using Markdown. (max 1000 characters)
  - checkedbooleanrequired
    Default state of the additional checkbox. It will use this value when loaded for the first time.
  - requiredbooleanrequired
    Whether it is required for the consumer to check the additional checkbox box or not in order to complete the purchase.
  - idstringrequired
    Identifier used when presenting data back to merchant
- verify_national_identification_numberbooleanoptional
  Enable verification of National Identification Numbers only in Sweden and Norway. This option also make the national identification number mandatory. (Not applicable for countries outside of Sweden and Norway)
- auto_capturebooleanoptional
  Allow merchant to trigger auto capturing.
- require_client_validationbooleanoptional
  If true, a client side validation is needed to complete the purchase
- show_vat_registration_number_fieldbooleanoptional
  If true, a optional VAT registration number field will be shown in the address form. Only applies for b2b orders.
- confirmation_page_upsellbooleanoptional
  If true, upsell recommendations will be presented on the order confirmation page.
- analytics_enabledbooleanoptional
  If true, front end analytics are enabled at checkout. Default: false
attachmentobjectoptional
2 fields in attachment
- bodystringrequired
  The content of the extra merchant data which should be presented as a string inside this property. The body should be an object containing any of the keys and sub objects described below serialised to JSON. More information on that object can be found here.
- content_typestringrequired
  The content type of the body. It is usually represented as “application/vnd.klarna.internal.emd-v2+json”
external_payment_methods[]array<object>optional
List of external payment methods that will be displayed as part of payment methods in the checkout.
7 fields in external_payment_methods
- namestringrequired
  The name of the payment provider. (max 255 characters)
- feeinteger · int64optional
  Minor units. Includes tax.
- descriptionstringoptional
  Short description of the payment method. This is displayed below the selected payment method. (max 500 characters)
- countries[]array<string>optional
  If specified, limits the method to the listed countries (alpha 2 codes).
- labelstringoptional
  Controls label of buy button
  - continue
  - complete
- redirect_urlstringrequired
  URL to redirect to. (must be https, min 7, max 2000 characters)
- image_urlstringoptional
  URL to an image to display. (must be https, max 2000 characters)
external_checkouts[]array<object>optional
List of external checkouts that will be displayed as part of payment methods in the checkout. The image_url is required, and the image size has to be 276x48px
Same shape as external_payment_methods — 7 fields, identical. Anchors under this path still resolve.
7 fields in external_checkouts
- namestringrequired
  The name of the payment provider. (max 255 characters)
- feeinteger · int64optional
  Minor units. Includes tax.
- descriptionstringoptional
  Short description of the payment method. This is displayed below the selected payment method. (max 500 characters)
- countries[]array<string>optional
  If specified, limits the method to the listed countries (alpha 2 codes).
- labelstringoptional
  Controls label of buy button
  - continue
  - complete
- redirect_urlstringrequired
  URL to redirect to. (must be https, min 7, max 2000 characters)
- image_urlstringoptional
  URL to an image to display. (must be https, max 2000 characters)
shipping_countries[]array<string>optional
List of allowed shipping countries for this order in ISO-3166 alpha-2 format.

If specified, the customer will be able to change the shipping country in the checkout and you will be notified through ‘address_update’ callback or the ‘shipping_address_change’ javascript event.

If not specified then the default value will be the purchase country.

Example: look at billing_countries example.
shipping_options[]array<object>optional
A list of shipping options available for this order.
54 fields in shipping_options
- idstringrequired
  The unique identifier of the shipping option
- namestringrequired
  Name.
- descriptionstringoptional
  Description.
- promostringoptional
  Promotion name. To be used if this shipping option is promotional.
- priceinteger · int64required
  Price including tax.
- preselectedbooleanoptional
  If true, this option will be preselected when checkout loads. Default: false
- tax_amountinteger · int64required
  Tax amount.
- tax_rateinteger · int64required
  Non-negative. In percent, two implicit decimals. I.e 2500 = 25%.
- shipping_methodstringoptional
  Shipping method. Possible values:
  - PickUpStore
  - Home
  - BoxReg
  - BoxUnreg
  - PickUpPoint
  - Own
  - Postal
  - DHLPackstation
  - Digital
  If DHLPackstation is selected the correct form will be displayed.
- delivery_detailsobjectoptional
  35 fields in delivery_details
  - carrierstringoptional
    Carrier product name
  - classstringoptional
    Type of shipping class
  - productobjectoptional
    6 fields in product
    namestringoptional
    Carrier product name
    identifierstringoptional
    Carrier product identifier
    external_idstringoptional
    The external identifier of the carrier
    product_namestringoptional
    The product or service level name provided by the carrier
    metaobjectoptional
    Carrier-specific metadata
    1 field in meta
    keystringoptional
    Any additional property. The key is free-form; the value has this shape.
  - timeslotobjectoptional
    3 fields in timeslot
    idstringoptional
    Id
    startstringoptional
    Start time
    endstringoptional
    End time
  - pickup_locationobjectoptional
    21 fields in pickup_location
    idstringoptional
    Id
    namestringoptional
    Name of the location
    addressobjectoptional
    18 fields in address
    given_namestringoptional
    Given name.
    family_namestringoptional
    Family name.
    organization_namestringoptional
    Organization name. Only applicable for orders with customer.type=“organization”.
    buyer_referencestringoptional
    Reference of the buying organization, e.g. a purchase order number. Only applicable to the billing address of orders with customer.type=“organization”. Carries the same value as the legacy billing_address.attention field.
    emailstringoptional
    E-mail address.
    titlestringoptional
    Title.
    Valid values for UK:
    Mr
    Ms
    Mrs
    Miss
    Valid values for DACH:
    Herr
    Frau
    Valid values for NL:
    Dhr.
    Mevr.
    street_addressstringoptional
    Street address, first line. (Street name and number)
    street_address2stringoptional
    Street address, second line. (Apartment number, suite, etc.)
    street_namestringoptional
    Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See streetNumber.
    street_numberstringoptional
    Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See streetName.
    house_extensionstringoptional
    House extension. Only applicable in NL
    postal_codestringoptional
    Postal/post code.
    citystringoptional
    City.
    regionstringoptional
    State or Region.
    phonestringoptional
    Phone number.
    countrystringoptional
    ISO 3166 alpha-2. Country.
    care_ofstringoptional
    Care of.
    delivery_instructionstringoptional
    Instruction for the delivery of the order, entered by the customer. Only applicable to the shipping address of orders with customer.type=“organization”. Carries the same value as the legacy shipping_address.care_of field.
- tms_referencestringoptional
  TMS reference. Required to map completed orders to shipments reserved in TMS.
- tos_idstringoptional
  TOS ID. Required to map completed orders to shipments reserved via Ingrid.
- selected_addons[]array<object>optional
  5 fields in selected_addons
  - typestringoptional
  - priceinteger · int64optional
  - external_idstringoptional
  - user_inputstringoptional
  - display_namestringoptional
- external_method_idstringoptional
  The external identifier defined on the TMS (Only applicable for Ingrid-Headless)
merchant_datastringoptional
Pass through field to send any information about the order to be used later for reference while retrieving the order details (max 6000 characters).
guiobjectoptional
1 field in gui
- options[]array<string>optional
  An array of options to define the checkout behaviour. Supported options: minimal_confirmation.
  
  The gui object is an array of options to modify checkout client ui behaviours.
  
  Examples: [“minimal_confirmation”]
merchant_requestedobjectoptional
4 fields in merchant_requested
- additional_checkboxbooleanoptional
  Informs whether the additional_checkbox is checked or not, when applicable.
- additional_checkboxes[]array<object>optional
  Informs whether the additional_checkboxes is checked or not, when applicable.
  2 fields in additional_checkboxes
  - idstringoptional
  - checkedbooleanoptional
selected_shipping_optionobjectoptional
Same shape as shipping_options — 54 fields, identical. Anchors under this path still resolve.
54 fields in selected_shipping_option
- idstringrequired
  The unique identifier of the shipping option
- namestringrequired
  Name.
- descriptionstringoptional
  Description.
- promostringoptional
  Promotion name. To be used if this shipping option is promotional.
- priceinteger · int64required
  Price including tax.
- preselectedbooleanoptional
  If true, this option will be preselected when checkout loads. Default: false
- tax_amountinteger · int64required
  Tax amount.
- tax_rateinteger · int64required
  Non-negative. In percent, two implicit decimals. I.e 2500 = 25%.
- shipping_methodstringoptional
  Shipping method. Possible values:
  - PickUpStore
  - Home
  - BoxReg
  - BoxUnreg
  - PickUpPoint
  - Own
  - Postal
  - DHLPackstation
  - Digital
  If DHLPackstation is selected the correct form will be displayed.
- delivery_detailsobjectoptional
  35 fields in delivery_details
  - carrierstringoptional
    Carrier product name
  - classstringoptional
    Type of shipping class
  - productobjectoptional
    6 fields in product
    namestringoptional
    Carrier product name
    identifierstringoptional
    Carrier product identifier
    external_idstringoptional
    The external identifier of the carrier
    product_namestringoptional
    The product or service level name provided by the carrier
    metaobjectoptional
    Carrier-specific metadata
    1 field in meta
    keystringoptional
    Any additional property. The key is free-form; the value has this shape.
  - timeslotobjectoptional
    3 fields in timeslot
    idstringoptional
    Id
    startstringoptional
    Start time
    endstringoptional
    End time
  - pickup_locationobjectoptional
    21 fields in pickup_location
    idstringoptional
    Id
    namestringoptional
    Name of the location
    addressobjectoptional
    18 fields in address
    given_namestringoptional
    Given name.
    family_namestringoptional
    Family name.
    organization_namestringoptional
    Organization name. Only applicable for orders with customer.type=“organization”.
    buyer_referencestringoptional
    Reference of the buying organization, e.g. a purchase order number. Only applicable to the billing address of orders with customer.type=“organization”. Carries the same value as the legacy billing_address.attention field.
    emailstringoptional
    E-mail address.
    titlestringoptional
    Title.
    Valid values for UK:
    Mr
    Ms
    Mrs
    Miss
    Valid values for DACH:
    Herr
    Frau
    Valid values for NL:
    Dhr.
    Mevr.
    street_addressstringoptional
    Street address, first line. (Street name and number)
    street_address2stringoptional
    Street address, second line. (Apartment number, suite, etc.)
    street_namestringoptional
    Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See streetNumber.
    street_numberstringoptional
    Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See streetName.
    house_extensionstringoptional
    House extension. Only applicable in NL
    postal_codestringoptional
    Postal/post code.
    citystringoptional
    City.
    regionstringoptional
    State or Region.
    phonestringoptional
    Phone number.
    countrystringoptional
    ISO 3166 alpha-2. Country.
    care_ofstringoptional
    Care of.
    delivery_instructionstringoptional
    Instruction for the delivery of the order, entered by the customer. Only applicable to the shipping address of orders with customer.type=“organization”. Carries the same value as the legacy shipping_address.care_of field.
- tms_referencestringoptional
  TMS reference. Required to map completed orders to shipments reserved in TMS.
- tos_idstringoptional
  TOS ID. Required to map completed orders to shipments reserved via Ingrid.
- selected_addons[]array<object>optional
  5 fields in selected_addons
  - typestringoptional
  - priceinteger · int64optional
  - external_idstringoptional
  - user_inputstringoptional
  - display_namestringoptional
- external_method_idstringoptional
  The external identifier defined on the TMS (Only applicable for Ingrid-Headless)
selected_shipping_options[]array<object>optional
Same shape as shipping_options — 54 fields, identical. Anchors under this path still resolve.
54 fields in selected_shipping_options
- idstringrequired
  The unique identifier of the shipping option
- namestringrequired
  Name.
- descriptionstringoptional
  Description.
- promostringoptional
  Promotion name. To be used if this shipping option is promotional.
- priceinteger · int64required
  Price including tax.
- preselectedbooleanoptional
  If true, this option will be preselected when checkout loads. Default: false
- tax_amountinteger · int64required
  Tax amount.
- tax_rateinteger · int64required
  Non-negative. In percent, two implicit decimals. I.e 2500 = 25%.
- shipping_methodstringoptional
  Shipping method. Possible values:
  - PickUpStore
  - Home
  - BoxReg
  - BoxUnreg
  - PickUpPoint
  - Own
  - Postal
  - DHLPackstation
  - Digital
  If DHLPackstation is selected the correct form will be displayed.
- delivery_detailsobjectoptional
  35 fields in delivery_details
  - carrierstringoptional
    Carrier product name
  - classstringoptional
    Type of shipping class
  - productobjectoptional
    6 fields in product
    namestringoptional
    Carrier product name
    identifierstringoptional
    Carrier product identifier
    external_idstringoptional
    The external identifier of the carrier
    product_namestringoptional
    The product or service level name provided by the carrier
    metaobjectoptional
    Carrier-specific metadata
    1 field in meta
    keystringoptional
    Any additional property. The key is free-form; the value has this shape.
  - timeslotobjectoptional
    3 fields in timeslot
    idstringoptional
    Id
    startstringoptional
    Start time
    endstringoptional
    End time
  - pickup_locationobjectoptional
    21 fields in pickup_location
    idstringoptional
    Id
    namestringoptional
    Name of the location
    addressobjectoptional
    18 fields in address
    given_namestringoptional
    Given name.
    family_namestringoptional
    Family name.
    organization_namestringoptional
    Organization name. Only applicable for orders with customer.type=“organization”.
    buyer_referencestringoptional
    Reference of the buying organization, e.g. a purchase order number. Only applicable to the billing address of orders with customer.type=“organization”. Carries the same value as the legacy billing_address.attention field.
    emailstringoptional
    E-mail address.
    titlestringoptional
    Title.
    Valid values for UK:
    Mr
    Ms
    Mrs
    Miss
    Valid values for DACH:
    Herr
    Frau
    Valid values for NL:
    Dhr.
    Mevr.
    street_addressstringoptional
    Street address, first line. (Street name and number)
    street_address2stringoptional
    Street address, second line. (Apartment number, suite, etc.)
    street_namestringoptional
    Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See streetNumber.
    street_numberstringoptional
    Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See streetName.
    house_extensionstringoptional
    House extension. Only applicable in NL
    postal_codestringoptional
    Postal/post code.
    citystringoptional
    City.
    regionstringoptional
    State or Region.
    phonestringoptional
    Phone number.
    countrystringoptional
    ISO 3166 alpha-2. Country.
    care_ofstringoptional
    Care of.
    delivery_instructionstringoptional
    Instruction for the delivery of the order, entered by the customer. Only applicable to the shipping address of orders with customer.type=“organization”. Carries the same value as the legacy shipping_address.care_of field.
- tms_referencestringoptional
  TMS reference. Required to map completed orders to shipments reserved in TMS.
- tos_idstringoptional
  TOS ID. Required to map completed orders to shipments reserved via Ingrid.
- selected_addons[]array<object>optional
  5 fields in selected_addons
  - typestringoptional
  - priceinteger · int64optional
  - external_idstringoptional
  - user_inputstringoptional
  - display_namestringoptional
- external_method_idstringoptional
  The external identifier defined on the TMS (Only applicable for Ingrid-Headless)
recurringbooleanoptional
Indicates whether this purchase will create a token that can be used by the merchant to create recurring purchases. This must be enabled for the merchant to use. Default: false

Depending on specified country, recurring could be used for the following payment methods: Klarna Pay Later, Direct Debit, Card, Apple Pay, Google Pay.
recurring_tokenstringoptional
Token to be used when creating recurring orders.
recurring_descriptionstringoptional
Description to be added to the recurring order.
billing_countries[]array<string>optional
List of allowed billing countries for this order. If specified, the customer will be able to change the billing country in the checkout and you will be notified through ‘country_change’ callback or the ‘billing_address_change’ javascript event. If not specified but shipping_countries is specified, will use same values as shipping_countries. If not specified and shipping_countries is not specified, then the default value will be the purchase country.

Example: [“AD”, “AE”, “AG”, “AI”, “AL”, “AM”, “AQ”, “AR”, “AS”, “AT”, “AU”, “AW”, “AX”, “AZ”, “BA”, “BB”, “BD”, “BE”, “BF”, “BG”, “BH”, “BJ”, “BL”, “BM”, “BN”, “BO”, “BQ”, “BR”, “BS”, “BT”, “BW”, “BY”, “BZ”, “CA”, “CF”, “CH”, “CI”, “CK”, “CL”, “CM”, “CN”, “CO”, “CR”, “CU”, “CV”, “CW”, “CX”, “CY”, “CZ”, “DE”, “DJ”, “DK”, “DM”, “DO”, “DZ”, “EC”, “EE”, “EG”, “ER”, “ES”, “ET”, “FI”, “FJ”, “FK”, “FM”, “FO”, “FR”, “GA”, “GB”, “GD”, “GE”, “GF”, “GG”, “GH”, “GI”, “GL”, “GM”, “GN”, “GP”, “GR”, “GS”, “GT”, “GU”, “GY”, “HK”, “HN”, “HR”, “HU”, “ID”, “IE”, “IL”, “IM”, “IN”, “IS”, “IT”, “JE”, “JM”, “JO”, “JP”, “KE”, “KG”, “KI”, “KM”, “KN”, “KR”, “KW”, “KY”, “KZ”, “LA”, “LA”, “LB”, “LC”, “LI”, “LK”, “LR”, “LS”, “LT”, “LU”, “LV”, “MA”, “MC”, “MD”, “ME”, “MF”, “MG”, “MH”, “MK”, “MK”, “ML”, “MM”, “MN”, “MO”, “MP”, “MQ”, “MR”, “MT”, “MU”, “MV”, “MW”, “MX”, “MY”, “MZ”, “NA”, “NC”, “NE”, “NF”, “NG”, “NI”, “NL”, “NO”, “NP”, “NR”, “NU”, “NZ”, “OM”, “PA”, “PE”, “PF”, “PG”, “PH”, “PK”, “PL”, “PM”, “PR”, “PS”, “PT”, “PW”, “PY”, “QA”, “RE”, “RO”, “RS”, “RU”, “RW”, “SA”, “SB”, “SC”, “SE”, “SG”, “SH”, “SI”, “SJ”, “SK”, “SL”, “SM”, “SN”, “SR”, “ST”, “SV”, “SX”, “SZ”, “TC”, “TF”, “TG”, “TH”, “TJ”, “TK”, “TL”, “TO”, “TR”, “TT”, “TV”, “TW”, “TZ”, “UA”, “UG”, “UM”, “US”, “UY”, “UZ”, “VA”, “VC”, “VG”, “VI”, “VN”, “VU”, “WF”, “WS”, “XK”, “YT”, “ZA”, “ZM”, “ZW”]”
tags[]array<string>optional
Extra information added to the order.

Example: [“dangerous_goods”, “bulky”]

400

Response0 fields

We were unable to update an order with the provided data. Some field constraint was violated.

No response body — this status returns headers only.

401

Response0 fields

You were not authorized to execute this operation.

No response body — this status returns headers only.

403

Response0 fields

You tried to modify a read only resource.

No response body — this status returns headers only.

404

Response0 fields

We did not find any order with given ID. You need to create a new order.

No response body — this status returns headers only.

POST https://api.kustom.co/checkout/v3/orders/{order_id}

Request body· application/json

{
  "order_id": "f3392f8b-6116-4073-ab96-e330819e2c07",
  "name": "Women's Fashion",
  "purchase_country": "US",
  "purchase_currency": "USD",
  "locale": "en-US",
  "status": "CHECKOUT_INCOMPLETE",
  "billing_address": {
    "given_name": "John",
    "family_name": "Doe",
    "organization_name": "Acme Corporation",
    "buyer_reference": "PO-4711",
    "email": "john@doe.com",
    "title": "Mr",
    "street_address": "Lombard St 10",
    "street_address2": "Apt 214",
    "street_name": "Lombard St",
    "street_number": "10",
    "house_extension": "B",
    "postal_code": "90210",
    "city": "Beverly Hills",
    "region": "CA",
    "phone": "333444555",
    "country": "US",
    "care_of": "C/O",
    "delivery_instruction": "Leave at the loading dock, gate 3"
  },
  "shipping_address": {
    "given_name": "John",
    "family_name": "Doe",
    "organization_name": "Acme Corporation",
    "buyer_reference": "PO-4711",
    "email": "john@doe.com",
    "title": "Mr",
    "street_address": "Lombard St 10",
    "street_address2": "Apt 214",
    "street_name": "Lombard St",
    "street_number": "10",
    "house_extension": "B",
    "postal_code": "90210",
    "city": "Beverly Hills",
    "region": "CA",
    "phone": "333444555",
    "country": "US",
    "care_of": "C/O",
    "delivery_instruction": "Leave at the loading dock, gate 3"
  },
  "order_amount": 50000,
  "order_tax_amount": 4545,
  "order_lines": [
    {
      "type": "physical",
      "reference": "19-402-USA",
      "name": "Red T-Shirt",
      "quantity": 5,
      "subscription": {
        "name": "<string>",
        "interval": "DAY",
        "interval_count": 0
      },
      "quantity_unit": "pcs",
      "unit_price": 10000,
      "tax_rate": 1000,
      "total_amount": 50000,
      "total_discount_amount": 0,
      "total_tax_amount": 4545,
      "merchant_data": "{\"marketplace_seller_info\":[{\"product_category\":\"Women's Fashion\",\"product_name\":\"Women Sweatshirt\"}]}",
      "product_url": "https://www.example.com/products/f2a8d7e34",
      "image_url": "https://www.exampleobjects.com/product-image-1200x1200.jpg",
      "product_identifiers": {
        "brand": "Intel",
        "color": "Blue",
        "category_path": "Electronics Store > Computers & Tablets > Desktops",
        "global_trade_item_number": "735858293167",
        "manufacturer_part_number": "BOXNUC5CPYH",
        "size": "Medium"
      },
      "shipping_attributes": {
        "weight": 1000,
        "dimensions": {
          "height": 100,
          "width": 100,
          "length": 100
        },
        "display_attributes": [
          {
            "key": "color",
            "label": "Color",
            "value": "Black"
          }
        ],
        "tags": [
          "<string>"
        ],
        "delivery_id": "<string>"
      }
    }
  ],
  "customer": {
    "type": "person",
    "gender": "male",
    "date_of_birth": "1995-10-20",
    "organization_registration_id": "556737-0431",
    "vat_id": "<string>"
  },
  "merchant_urls": {
    "terms": "https://www.example.com/terms.html",
    "checkout": "https://www.example.com/checkout.html",
    "confirmation": "https://www.example.com/confirmation.html",
    "push": "https://www.example.com/api/push",
    "validation": "https://www.example.com/api/validation",
    "notification": "https://www.example.com/api/pending",
    "cancellation_terms": "https://www.example.com/terms/cancellation.html",
    "shipping_option_update": "https://www.example.com/api/shipment",
    "address_update": "https://www.example.com/api/address",
    "country_change": "https://www.example.com/api/country",
    "upsell": "https://www.example.com/api/upsell",
    "upsell_validation": "https://www.example.com/api/upsell-validation",
    "upsell_notification": "https://www.example.com/api/upsell/{checkout.order.id}"
  },
  "html_snippet": "<div id='klarna-checkout-container'><script>alert('Initializing Kustom Checkout');</script></div>",
  "merchant_reference1": "45aa52f387871e3a210645d4",
  "merchant_reference2": "45aa52f387871e3a210645d4",
  "started_at": "<date-time>",
  "completed_at": "<date-time>",
  "last_modified_at": "<date-time>",
  "options": {
    "require_validate_callback_success": false,
    "acquiring_channel": "<string>",
    "vat_removed": false,
    "tms_configuration_override": {
      "disabled": false
    },
    "subscription_buy_button": false,
    "allow_separate_shipping_address": false,
    "color_button": "#FF9900",
    "color_button_text": "#FF9900",
    "color_checkbox": "#FF9900",
    "color_checkbox_checkmark": "#FF9900",
    "color_header": "#FF9900",
    "color_link": "#FF9900",
    "color_background": "#FF9900",
    "date_of_birth_mandatory": false,
    "date_of_birth_optional": false,
    "shipping_details": "Delivered within 1-3 working days",
    "title_mandatory": false,
    "additional_checkbox": {
      "text": "Please add me to the newsletter list, read more here \\[link\\](http://www.google.com)",
      "checked": false,
      "required": false
    },
    "national_identification_number_mandatory": false,
    "additional_merchant_terms": "<string>",
    "phone_mandatory": false,
    "radius_border": "5",
    "allowed_customer_types": [
      "<string>"
    ],
    "show_subtotal_detail": false,
    "additional_checkboxes": [
      {
        "text": "Please add me to the newsletter list, read more here \\[link\\](http://www.google.com)",
        "checked": false,
        "required": false,
        "id": "newsletter_opt_in"
      }
    ],
    "verify_national_identification_number": false,
    "auto_capture": false,
    "require_client_validation": false,
    "show_vat_registration_number_field": false,
    "confirmation_page_upsell": false,
    "analytics_enabled": false
  },
  "attachment": {
    "body": "{\"hotel_reservation_details\": [{\"pnr\": \"VH67899\",\"hotel_intinerary\": [{\"hotel_name\": \"Hotel ltd.\",\"address\": {\"street_address\": \"Storgatan 3\",\"postal_code\": \"113 35\",\"city\": \"Stockholm\",\"country\": \"Sweden\"},\"start_time\": \"2019-01-31T15:00:00Z\",\"end_time\": \"2019-01-31T15:30:00Z\",\"number_of_rooms\": 2,\"ticket_delivery_method\": \"email\",\"ticket_delivery_recipient\": \"jonas.larlsson@kustom.co\",\"hotel_price\": 23050,\"class\": \"Business\",\"passenger_id\": [1]}],\"passengers\": [{\"id\": 1,\"title\": \"mr\",\"first_name\": \"Adam\",\"last_name\": \"Adamson\"}],\"insurance\": [{\"insurance_company\": \"Insurance Company X\",\"insurance_type\": \"travel\",\"insurance_price\": 0}],\"affiliate_name\": \"TradeMaxi AB\"}],\"air_reservation_details\": [{\"pnr\": \"VH67899\",\"intinerary\": [{\"departure\": \"ARN\",\"departure_city\": \"Stockholm\",\"arrival\": \"NCE\",\"arrival_city\": \"Nice\",\"carrier\": \"SK\",\"segment_price\": 34000,\"departure_date\": \"2019-01-30T15:00:00Z\",\"ticket_delivery_method\": \"email\",\"ticket_delivery_recipient\": \"jonas.larlsson@kustom.co\",\"passenger_id\": [1]}],\"passengers\": [{\"id\": 1,\"title\": \"mr\",\"first_name\": \"Adam\",\"last_name\": \"Adamson\"}],\"insurance\": [{\"insurance_company\": \"Insurance Company X\",\"insurance_type\": \"travel\",\"insurance_price\": 0}],\"affiliate_name\": \"TradeMaxi AB\"}],\"customer_account_info\": [{\"unique_account_identifier\": \"12345\",\"account_registration_date\": \"2016-01-24T15:00:00Z\",\"account_last_modified\": \"2017-01-24T15:00:00Z\"}],\"payment_history_full\": [{\"payment_option\": \"card\",\"number_paid_purchases\": 2,\"total_amount_paid_purchases\": 1234,\"date_of_last_paid_purchase\": \"2018-01-24T15:00:00Z\",\"date_of_first_paid_purchase\": \"2018-01-24T15:00:00Z\"}]}",
    "content_type": "application/vnd.klarna.internal.emd-v2+json"
  },
  "external_payment_methods": [
    {
      "name": "PayhereUs",
      "fee": 0,
      "description": "an American company operating a worldwide online payments system",
      "countries": [
        "<string>"
      ],
      "label": "continue",
      "redirect_url": "https://www.example.com/us/start",
      "image_url": "https://www.exampleobjects.com/product-image-1200x1200.jpg"
    }
  ],
  "external_checkouts": [
    {
      "name": "PayhereUs",
      "fee": 0,
      "description": "an American company operating a worldwide online payments system",
      "countries": [
        "<string>"
      ],
      "label": "continue",
      "redirect_url": "https://www.example.com/us/start",
      "image_url": "https://www.exampleobjects.com/product-image-1200x1200.jpg"
    }
  ],
  "shipping_countries": [
    "<string>"
  ],
  "shipping_options": [
    {
      "id": "express_priority",
      "name": "EXPRESS 1-2 Days",
      "description": "Delivery by 4:30 pm",
      "promo": "Christmas Promotion",
      "price": 0,
      "preselected": false,
      "tax_amount": 0,
      "tax_rate": 0,
      "shipping_method": "PickUpStore",
      "delivery_details": {
        "carrier": "<string>",
        "class": "<string>",
        "product": {
          "name": "<string>",
          "identifier": "<string>",
          "external_id": "<string>",
          "product_name": "Parcel",
          "meta": {
            "key": "<string>"
          }
        },
        "timeslot": {
          "id": "<string>",
          "start": "<string>",
          "end": "<string>"
        },
        "pickup_location": {
          "id": "<string>",
          "name": "<string>",
          "address": {
            "given_name": "John",
            "family_name": "Doe",
            "organization_name": "Acme Corporation",
            "buyer_reference": "PO-4711",
            "email": "john@doe.com",
            "title": "Mr",
            "street_address": "Lombard St 10",
            "street_address2": "Apt 214",
            "street_name": "Lombard St",
            "street_number": "10",
            "house_extension": "B",
            "postal_code": "90210",
            "city": "Beverly Hills",
            "region": "CA",
            "phone": "333444555",
            "country": "US",
            "care_of": "C/O",
            "delivery_instruction": "Leave at the loading dock, gate 3"
          }
        }
      },
      "tms_reference": "a1b2c3d4-e4f6-g7h8-i9j0-k1l2m3n4o5p6",
      "tos_id": "01K7HJZHY22AAX6PNV5DPXNZQF",
      "selected_addons": [
        {
          "type": "<string>",
          "price": 0,
          "external_id": "<string>",
          "user_input": "<string>",
          "display_name": "<string>"
        }
      ],
      "external_method_id": "dhl-parcelconnect-fr"
    }
  ],
  "merchant_data": "{\"marketplace_seller_info\":[{\"product_category\":\"Women's Fashion\",\"product_name\":\"Women Sweatshirt\"}]}",
  "gui": {
    "options": [
      "<string>"
    ]
  },
  "merchant_requested": {
    "additional_checkbox": false,
    "additional_checkboxes": [
      {
        "id": "<string>",
        "checked": false
      }
    ]
  },
  "selected_shipping_option": {
    "id": "express_priority",
    "name": "EXPRESS 1-2 Days",
    "description": "Delivery by 4:30 pm",
    "promo": "Christmas Promotion",
    "price": 0,
    "preselected": false,
    "tax_amount": 0,
    "tax_rate": 0,
    "shipping_method": "PickUpStore",
    "delivery_details": {
      "carrier": "<string>",
      "class": "<string>",
      "product": {
        "name": "<string>",
        "identifier": "<string>",
        "external_id": "<string>",
        "product_name": "Parcel",
        "meta": {
          "key": "<string>"
        }
      },
      "timeslot": {
        "id": "<string>",
        "start": "<string>",
        "end": "<string>"
      },
      "pickup_location": {
        "id": "<string>",
        "name": "<string>",
        "address": {
          "given_name": "John",
          "family_name": "Doe",
          "organization_name": "Acme Corporation",
          "buyer_reference": "PO-4711",
          "email": "john@doe.com",
          "title": "Mr",
          "street_address": "Lombard St 10",
          "street_address2": "Apt 214",
          "street_name": "Lombard St",
          "street_number": "10",
          "house_extension": "B",
          "postal_code": "90210",
          "city": "Beverly Hills",
          "region": "CA",
          "phone": "333444555",
          "country": "US",
          "care_of": "C/O",
          "delivery_instruction": "Leave at the loading dock, gate 3"
        }
      }
    },
    "tms_reference": "a1b2c3d4-e4f6-g7h8-i9j0-k1l2m3n4o5p6",
    "tos_id": "01K7HJZHY22AAX6PNV5DPXNZQF",
    "selected_addons": [
      {
        "type": "<string>",
        "price": 0,
        "external_id": "<string>",
        "user_input": "<string>",
        "display_name": "<string>"
      }
    ],
    "external_method_id": "dhl-parcelconnect-fr"
  },
  "selected_shipping_options": [
    {
      "id": "express_priority",
      "name": "EXPRESS 1-2 Days",
      "description": "Delivery by 4:30 pm",
      "promo": "Christmas Promotion",
      "price": 0,
      "preselected": false,
      "tax_amount": 0,
      "tax_rate": 0,
      "shipping_method": "PickUpStore",
      "delivery_details": {
        "carrier": "<string>",
        "class": "<string>",
        "product": {
          "name": "<string>",
          "identifier": "<string>",
          "external_id": "<string>",
          "product_name": "Parcel",
          "meta": {
            "key": "<string>"
          }
        },
        "timeslot": {
          "id": "<string>",
          "start": "<string>",
          "end": "<string>"
        },
        "pickup_location": {
          "id": "<string>",
          "name": "<string>",
          "address": {
            "given_name": "John",
            "family_name": "Doe",
            "organization_name": "Acme Corporation",
            "buyer_reference": "PO-4711",
            "email": "john@doe.com",
            "title": "Mr",
            "street_address": "Lombard St 10",
            "street_address2": "Apt 214",
            "street_name": "Lombard St",
            "street_number": "10",
            "house_extension": "B",
            "postal_code": "90210",
            "city": "Beverly Hills",
            "region": "CA",
            "phone": "333444555",
            "country": "US",
            "care_of": "C/O",
            "delivery_instruction": "Leave at the loading dock, gate 3"
          }
        }
      },
      "tms_reference": "a1b2c3d4-e4f6-g7h8-i9j0-k1l2m3n4o5p6",
      "tos_id": "01K7HJZHY22AAX6PNV5DPXNZQF",
      "selected_addons": [
        {
          "type": "<string>",
          "price": 0,
          "external_id": "<string>",
          "user_input": "<string>",
          "display_name": "<string>"
        }
      ],
      "external_method_id": "dhl-parcelconnect-fr"
    }
  ],
  "recurring": false,
  "recurring_token": "<string>",
  "recurring_description": "<string>",
  "billing_countries": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ]
}

431 lines

Response 200· successful operation

{
  "order_id": "f3392f8b-6116-4073-ab96-e330819e2c07",
  "name": "Women's Fashion",
  "purchase_country": "US",
  "purchase_currency": "USD",
  "locale": "en-US",
  "status": "CHECKOUT_INCOMPLETE",
  "billing_address": {
    "given_name": "John",
    "family_name": "Doe",
    "organization_name": "Acme Corporation",
    "buyer_reference": "PO-4711",
    "email": "john@doe.com",
    "title": "Mr",
    "street_address": "Lombard St 10",
    "street_address2": "Apt 214",
    "street_name": "Lombard St",
    "street_number": "10",
    "house_extension": "B",
    "postal_code": "90210",
    "city": "Beverly Hills",
    "region": "CA",
    "phone": "333444555",
    "country": "US",
    "care_of": "C/O",
    "delivery_instruction": "Leave at the loading dock, gate 3"
  },
  "shipping_address": {
    "given_name": "John",
    "family_name": "Doe",
    "organization_name": "Acme Corporation",
    "buyer_reference": "PO-4711",
    "email": "john@doe.com",
    "title": "Mr",
    "street_address": "Lombard St 10",
    "street_address2": "Apt 214",
    "street_name": "Lombard St",
    "street_number": "10",
    "house_extension": "B",
    "postal_code": "90210",
    "city": "Beverly Hills",
    "region": "CA",
    "phone": "333444555",
    "country": "US",
    "care_of": "C/O",
    "delivery_instruction": "Leave at the loading dock, gate 3"
  },
  "order_amount": 50000,
  "order_tax_amount": 4545,
  "order_lines": [
    {
      "type": "physical",
      "reference": "19-402-USA",
      "name": "Red T-Shirt",
      "quantity": 5,
      "subscription": {
        "name": "<string>",
        "interval": "DAY",
        "interval_count": 0
      },
      "quantity_unit": "pcs",
      "unit_price": 10000,
      "tax_rate": 1000,
      "total_amount": 50000,
      "total_discount_amount": 0,
      "total_tax_amount": 4545,
      "merchant_data": "{\"marketplace_seller_info\":[{\"product_category\":\"Women's Fashion\",\"product_name\":\"Women Sweatshirt\"}]}",
      "product_url": "https://www.example.com/products/f2a8d7e34",
      "image_url": "https://www.exampleobjects.com/product-image-1200x1200.jpg",
      "product_identifiers": {
        "brand": "Intel",
        "color": "Blue",
        "category_path": "Electronics Store > Computers & Tablets > Desktops",
        "global_trade_item_number": "735858293167",
        "manufacturer_part_number": "BOXNUC5CPYH",
        "size": "Medium"
      },
      "shipping_attributes": {
        "weight": 1000,
        "dimensions": {
          "height": 100,
          "width": 100,
          "length": 100
        },
        "display_attributes": [
          {
            "key": "color",
            "label": "Color",
            "value": "Black"
          }
        ],
        "tags": [
          "<string>"
        ],
        "delivery_id": "<string>"
      }
    }
  ],
  "customer": {
    "type": "person",
    "gender": "male",
    "date_of_birth": "1995-10-20",
    "organization_registration_id": "556737-0431",
    "vat_id": "<string>"
  },
  "merchant_urls": {
    "terms": "https://www.example.com/terms.html",
    "checkout": "https://www.example.com/checkout.html",
    "confirmation": "https://www.example.com/confirmation.html",
    "push": "https://www.example.com/api/push",
    "validation": "https://www.example.com/api/validation",
    "notification": "https://www.example.com/api/pending",
    "cancellation_terms": "https://www.example.com/terms/cancellation.html",
    "shipping_option_update": "https://www.example.com/api/shipment",
    "address_update": "https://www.example.com/api/address",
    "country_change": "https://www.example.com/api/country",
    "upsell": "https://www.example.com/api/upsell",
    "upsell_validation": "https://www.example.com/api/upsell-validation",
    "upsell_notification": "https://www.example.com/api/upsell/{checkout.order.id}"
  },
  "html_snippet": "<div id='klarna-checkout-container'><script>alert('Initializing Kustom Checkout');</script></div>",
  "merchant_reference1": "45aa52f387871e3a210645d4",
  "merchant_reference2": "45aa52f387871e3a210645d4",
  "started_at": "<date-time>",
  "completed_at": "<date-time>",
  "last_modified_at": "<date-time>",
  "options": {
    "require_validate_callback_success": false,
    "acquiring_channel": "<string>",
    "vat_removed": false,
    "tms_configuration_override": {
      "disabled": false
    },
    "subscription_buy_button": false,
    "allow_separate_shipping_address": false,
    "color_button": "#FF9900",
    "color_button_text": "#FF9900",
    "color_checkbox": "#FF9900",
    "color_checkbox_checkmark": "#FF9900",
    "color_header": "#FF9900",
    "color_link": "#FF9900",
    "color_background": "#FF9900",
    "date_of_birth_mandatory": false,
    "date_of_birth_optional": false,
    "shipping_details": "Delivered within 1-3 working days",
    "title_mandatory": false,
    "additional_checkbox": {
      "text": "Please add me to the newsletter list, read more here \\[link\\](http://www.google.com)",
      "checked": false,
      "required": false
    },
    "national_identification_number_mandatory": false,
    "additional_merchant_terms": "<string>",
    "phone_mandatory": false,
    "radius_border": "5",
    "allowed_customer_types": [
      "<string>"
    ],
    "show_subtotal_detail": false,
    "additional_checkboxes": [
      {
        "text": "Please add me to the newsletter list, read more here \\[link\\](http://www.google.com)",
        "checked": false,
        "required": false,
        "id": "newsletter_opt_in"
      }
    ],
    "verify_national_identification_number": false,
    "auto_capture": false,
    "require_client_validation": false,
    "show_vat_registration_number_field": false,
    "confirmation_page_upsell": false,
    "analytics_enabled": false
  },
  "attachment": {
    "body": "{\"hotel_reservation_details\": [{\"pnr\": \"VH67899\",\"hotel_intinerary\": [{\"hotel_name\": \"Hotel ltd.\",\"address\": {\"street_address\": \"Storgatan 3\",\"postal_code\": \"113 35\",\"city\": \"Stockholm\",\"country\": \"Sweden\"},\"start_time\": \"2019-01-31T15:00:00Z\",\"end_time\": \"2019-01-31T15:30:00Z\",\"number_of_rooms\": 2,\"ticket_delivery_method\": \"email\",\"ticket_delivery_recipient\": \"jonas.larlsson@kustom.co\",\"hotel_price\": 23050,\"class\": \"Business\",\"passenger_id\": [1]}],\"passengers\": [{\"id\": 1,\"title\": \"mr\",\"first_name\": \"Adam\",\"last_name\": \"Adamson\"}],\"insurance\": [{\"insurance_company\": \"Insurance Company X\",\"insurance_type\": \"travel\",\"insurance_price\": 0}],\"affiliate_name\": \"TradeMaxi AB\"}],\"air_reservation_details\": [{\"pnr\": \"VH67899\",\"intinerary\": [{\"departure\": \"ARN\",\"departure_city\": \"Stockholm\",\"arrival\": \"NCE\",\"arrival_city\": \"Nice\",\"carrier\": \"SK\",\"segment_price\": 34000,\"departure_date\": \"2019-01-30T15:00:00Z\",\"ticket_delivery_method\": \"email\",\"ticket_delivery_recipient\": \"jonas.larlsson@kustom.co\",\"passenger_id\": [1]}],\"passengers\": [{\"id\": 1,\"title\": \"mr\",\"first_name\": \"Adam\",\"last_name\": \"Adamson\"}],\"insurance\": [{\"insurance_company\": \"Insurance Company X\",\"insurance_type\": \"travel\",\"insurance_price\": 0}],\"affiliate_name\": \"TradeMaxi AB\"}],\"customer_account_info\": [{\"unique_account_identifier\": \"12345\",\"account_registration_date\": \"2016-01-24T15:00:00Z\",\"account_last_modified\": \"2017-01-24T15:00:00Z\"}],\"payment_history_full\": [{\"payment_option\": \"card\",\"number_paid_purchases\": 2,\"total_amount_paid_purchases\": 1234,\"date_of_last_paid_purchase\": \"2018-01-24T15:00:00Z\",\"date_of_first_paid_purchase\": \"2018-01-24T15:00:00Z\"}]}",
    "content_type": "application/vnd.klarna.internal.emd-v2+json"
  },
  "external_payment_methods": [
    {
      "name": "PayhereUs",
      "fee": 0,
      "description": "an American company operating a worldwide online payments system",
      "countries": [
        "<string>"
      ],
      "label": "continue",
      "redirect_url": "https://www.example.com/us/start",
      "image_url": "https://www.exampleobjects.com/product-image-1200x1200.jpg"
    }
  ],
  "external_checkouts": [
    {
      "name": "PayhereUs",
      "fee": 0,
      "description": "an American company operating a worldwide online payments system",
      "countries": [
        "<string>"
      ],
      "label": "continue",
      "redirect_url": "https://www.example.com/us/start",
      "image_url": "https://www.exampleobjects.com/product-image-1200x1200.jpg"
    }
  ],
  "shipping_countries": [
    "<string>"
  ],
  "shipping_options": [
    {
      "id": "express_priority",
      "name": "EXPRESS 1-2 Days",
      "description": "Delivery by 4:30 pm",
      "promo": "Christmas Promotion",
      "price": 0,
      "preselected": false,
      "tax_amount": 0,
      "tax_rate": 0,
      "shipping_method": "PickUpStore",
      "delivery_details": {
        "carrier": "<string>",
        "class": "<string>",
        "product": {
          "name": "<string>",
          "identifier": "<string>",
          "external_id": "<string>",
          "product_name": "Parcel",
          "meta": {
            "key": "<string>"
          }
        },
        "timeslot": {
          "id": "<string>",
          "start": "<string>",
          "end": "<string>"
        },
        "pickup_location": {
          "id": "<string>",
          "name": "<string>",
          "address": {
            "given_name": "John",
            "family_name": "Doe",
            "organization_name": "Acme Corporation",
            "buyer_reference": "PO-4711",
            "email": "john@doe.com",
            "title": "Mr",
            "street_address": "Lombard St 10",
            "street_address2": "Apt 214",
            "street_name": "Lombard St",
            "street_number": "10",
            "house_extension": "B",
            "postal_code": "90210",
            "city": "Beverly Hills",
            "region": "CA",
            "phone": "333444555",
            "country": "US",
            "care_of": "C/O",
            "delivery_instruction": "Leave at the loading dock, gate 3"
          }
        }
      },
      "tms_reference": "a1b2c3d4-e4f6-g7h8-i9j0-k1l2m3n4o5p6",
      "tos_id": "01K7HJZHY22AAX6PNV5DPXNZQF",
      "selected_addons": [
        {
          "type": "<string>",
          "price": 0,
          "external_id": "<string>",
          "user_input": "<string>",
          "display_name": "<string>"
        }
      ],
      "external_method_id": "dhl-parcelconnect-fr"
    }
  ],
  "merchant_data": "{\"marketplace_seller_info\":[{\"product_category\":\"Women's Fashion\",\"product_name\":\"Women Sweatshirt\"}]}",
  "gui": {
    "options": [
      "<string>"
    ]
  },
  "merchant_requested": {
    "additional_checkbox": false,
    "additional_checkboxes": [
      {
        "id": "<string>",
        "checked": false
      }
    ]
  },
  "selected_shipping_option": {
    "id": "express_priority",
    "name": "EXPRESS 1-2 Days",
    "description": "Delivery by 4:30 pm",
    "promo": "Christmas Promotion",
    "price": 0,
    "preselected": false,
    "tax_amount": 0,
    "tax_rate": 0,
    "shipping_method": "PickUpStore",
    "delivery_details": {
      "carrier": "<string>",
      "class": "<string>",
      "product": {
        "name": "<string>",
        "identifier": "<string>",
        "external_id": "<string>",
        "product_name": "Parcel",
        "meta": {
          "key": "<string>"
        }
      },
      "timeslot": {
        "id": "<string>",
        "start": "<string>",
        "end": "<string>"
      },
      "pickup_location": {
        "id": "<string>",
        "name": "<string>",
        "address": {
          "given_name": "John",
          "family_name": "Doe",
          "organization_name": "Acme Corporation",
          "buyer_reference": "PO-4711",
          "email": "john@doe.com",
          "title": "Mr",
          "street_address": "Lombard St 10",
          "street_address2": "Apt 214",
          "street_name": "Lombard St",
          "street_number": "10",
          "house_extension": "B",
          "postal_code": "90210",
          "city": "Beverly Hills",
          "region": "CA",
          "phone": "333444555",
          "country": "US",
          "care_of": "C/O",
          "delivery_instruction": "Leave at the loading dock, gate 3"
        }
      }
    },
    "tms_reference": "a1b2c3d4-e4f6-g7h8-i9j0-k1l2m3n4o5p6",
    "tos_id": "01K7HJZHY22AAX6PNV5DPXNZQF",
    "selected_addons": [
      {
        "type": "<string>",
        "price": 0,
        "external_id": "<string>",
        "user_input": "<string>",
        "display_name": "<string>"
      }
    ],
    "external_method_id": "dhl-parcelconnect-fr"
  },
  "selected_shipping_options": [
    {
      "id": "express_priority",
      "name": "EXPRESS 1-2 Days",
      "description": "Delivery by 4:30 pm",
      "promo": "Christmas Promotion",
      "price": 0,
      "preselected": false,
      "tax_amount": 0,
      "tax_rate": 0,
      "shipping_method": "PickUpStore",
      "delivery_details": {
        "carrier": "<string>",
        "class": "<string>",
        "product": {
          "name": "<string>",
          "identifier": "<string>",
          "external_id": "<string>",
          "product_name": "Parcel",
          "meta": {
            "key": "<string>"
          }
        },
        "timeslot": {
          "id": "<string>",
          "start": "<string>",
          "end": "<string>"
        },
        "pickup_location": {
          "id": "<string>",
          "name": "<string>",
          "address": {
            "given_name": "John",
            "family_name": "Doe",
            "organization_name": "Acme Corporation",
            "buyer_reference": "PO-4711",
            "email": "john@doe.com",
            "title": "Mr",
            "street_address": "Lombard St 10",
            "street_address2": "Apt 214",
            "street_name": "Lombard St",
            "street_number": "10",
            "house_extension": "B",
            "postal_code": "90210",
            "city": "Beverly Hills",
            "region": "CA",
            "phone": "333444555",
            "country": "US",
            "care_of": "C/O",
            "delivery_instruction": "Leave at the loading dock, gate 3"
          }
        }
      },
      "tms_reference": "a1b2c3d4-e4f6-g7h8-i9j0-k1l2m3n4o5p6",
      "tos_id": "01K7HJZHY22AAX6PNV5DPXNZQF",
      "selected_addons": [
        {
          "type": "<string>",
          "price": 0,
          "external_id": "<string>",
          "user_input": "<string>",
          "display_name": "<string>"
        }
      ],
      "external_method_id": "dhl-parcelconnect-fr"
    }
  ],
  "recurring": false,
  "recurring_token": "<string>",
  "recurring_description": "<string>",
  "billing_countries": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ]
}

431 lines

This page is also available as Markdown — append .md to its URL — and is indexed in llms.txt.