Update a checkout

PATCH 
/api/checkout/:id

Update details of a checkout using the checkout ID.

Request

Path Parameters

id stringrequired

The ID of the checkout to be updated

application/json

Body

required

buyer_accepts_purchase_conditions boolean
buyer_accepts_terms_conditions boolean
success_url string
cancel_url string
email string
payment_method string

shipping_address

object

first_name string

last_name string

zip string

city string

phone_code string

phone number

company string

address1 string

address2 string

province string

province_code string

country string

country_code string

billing_address

object

first_name string

last_name string

zip string

city string

phone_code string

phone number

company string

address1 string

address2 string

province string

province_code string

country string

country_code string

Responses

200

Successful update of the checkout

application/json

Schema

Schema

any

Example (from schema)

{
  "createdAt": "2024-01-03T16:07:18.375Z",
  "updatedAt": "2024-01-03T16:32:55.000Z",
  "id": "eec93917-c2bb-4d7b-88f0-1727c2c5ed09",
  "deletedAt": null,
  "success_url": "https://reachu.io/ok",
  "cancel_url": "https://reachu.io/failed",
  "payment_method": "Klarna",
  "email": "test@reachu.io",
  "status": "ACTIVE",
  "checkout_url": null,
  "origin_payment_id": null,
  "total_amount": 100,
  "total_taxes_amount": 12,
  "total_cart_amount": 100,
  "buyer_accepts_purchase_conditions": true,
  "buyer_accepts_terms_conditions": true,
  "cart": {
    "cart_id": "4c0010e7-c235-41ea-ab69-fba00be0ae6c",
    "customer_session_id": "test-doc",
    "shippingCountry": "c07d8af8-9d37-403b-aede-427c4b5fba3c",
    "line_items": [
      {
        "id": "7e426050-b3f6-40ea-9111-3bb7befc64d3",
        "supplier": "alanprod",
        "product_available_shippings": [],
        "product_id": 1230168,
        "product_title": "Test",
        "product_image": [
          {
            "id": 577005,
            "url": "https://containerproduction.blob.core.windows.net/outshifter-uploads-production/product-images/1230168-fde8d5a8-ad1b-442f-8448-b8ddcf548496.jpeg",
            "width": 500,
            "height": 500
          }
        ],
        "variant_id": null,
        "variant_title": null,
        "variant": [],
        "quantity": 1,
        "shipping": null,
        "price": {
          "amount": 100,
          "tax": 12,
          "currencyCode": "EUR",
          "discount": 0,
          "compareAt": 0
        }
      }
    ],
    "total_amount": 100,
    "currency": "EUR",
    "available_shipping_countries": [
      "NO"
    ]
  },
  "billing_address": {
    "id": "c03349c0-0636-435b-93c3-838e02238f16",
    "first_name": "test",
    "last_name": "documentation",
    "phone_code": "56",
    "phone": 123123123,
    "company": "",
    "address1": "test 1",
    "address2": null,
    "city": "oslo",
    "province": null,
    "province_code": null,
    "country": "norway",
    "country_code": "NO",
    "zip": "1234"
  },
  "shipping_address": {
    "id": "278e90f5-747b-4576-80f1-4fedc55ac9ba",
    "first_name": "test",
    "last_name": "documentation",
    "phone_code": "56",
    "phone": 123123123,
    "company": "",
    "address1": "test 1",
    "address2": null,
    "city": "oslo",
    "province": null,
    "province_code": null,
    "country": "norway",
    "country_code": "NO",
    "zip": "1234"
  },
  "total_shipping_amount": 0,
  "discount_code": null,
  "total_discount": null
}

Example

{
  "createdAt": "2024-01-03T16:07:18.375Z",
  "updatedAt": "2024-01-03T16:32:55.000Z",
  "id": "eec93917-c2bb-4d7b-88f0-1727c2c5ed09",
  "deletedAt": null,
  "success_url": "https://reachu.io/ok",
  "cancel_url": "https://reachu.io/failed",
  "payment_method": "Klarna",
  "email": "test@reachu.io",
  "status": "ACTIVE",
  "checkout_url": null,
  "origin_payment_id": null,
  "total_amount": 100,
  "total_taxes_amount": 12,
  "total_cart_amount": 100,
  "buyer_accepts_purchase_conditions": true,
  "buyer_accepts_terms_conditions": true,
  "cart": {
    "cart_id": "4c0010e7-c235-41ea-ab69-fba00be0ae6c",
    "customer_session_id": "test-doc",
    "shippingCountry": "c07d8af8-9d37-403b-aede-427c4b5fba3c",
    "line_items": [
      {
        "id": "7e426050-b3f6-40ea-9111-3bb7befc64d3",
        "supplier": "alanprod",
        "product_available_shippings": [],
        "product_id": 1230168,
        "product_title": "Test",
        "product_image": [
          {
            "id": 577005,
            "url": "https://containerproduction.blob.core.windows.net/outshifter-uploads-production/product-images/1230168-fde8d5a8-ad1b-442f-8448-b8ddcf548496.jpeg",
            "width": 500,
            "height": 500
          }
        ],
        "variant_id": null,
        "variant_title": null,
        "variant": [],
        "quantity": 1,
        "shipping": null,
        "price": {
          "amount": 100,
          "tax": 12,
          "currencyCode": "EUR",
          "discount": 0,
          "compareAt": 0
        }
      }
    ],
    "total_amount": 100,
    "currency": "EUR",
    "available_shipping_countries": [
      "NO"
    ]
  },
  "billing_address": {
    "id": "c03349c0-0636-435b-93c3-838e02238f16",
    "first_name": "test",
    "last_name": "documentation",
    "phone_code": "56",
    "phone": 123123123,
    "company": "",
    "address1": "test 1",
    "address2": null,
    "city": "oslo",
    "province": null,
    "province_code": null,
    "country": "norway",
    "country_code": "NO",
    "zip": "1234"
  },
  "shipping_address": {
    "id": "278e90f5-747b-4576-80f1-4fedc55ac9ba",
    "first_name": "test",
    "last_name": "documentation",
    "phone_code": "56",
    "phone": 123123123,
    "company": "",
    "address1": "test 1",
    "address2": null,
    "city": "oslo",
    "province": null,
    "province_code": null,
    "country": "norway",
    "country_code": "NO",
    "zip": "1234"
  },
  "total_shipping_amount": 0,
  "discount_code": null,
  "total_discount": null
}

Loading...