Get a checkout by ID

GET 
/api/checkout/:id

Retrieve details of a checkout using the checkout ID.

Request

Path Parameters

id stringrequired

The ID of the checkout to be retrieved

Responses

200

Successful retrieval of the checkout

application/json

Schema

Schema

any

Example (from schema)

{
  "createdAt": "2024-01-02T16:09:30.782Z",
  "updatedAt": "2024-01-02T16:09:30.782Z",
  "id": "1bf45d2b-3a5c-4aac-8e36-4a9f393ad474",
  "deletedAt": null,
  "success_url": null,
  "cancel_url": null,
  "payment_method": null,
  "email": null,
  "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": null,
  "shipping_address": null,
  "total_shipping_amount": 0,
  "availablePaymentMethods": [
    {
      "name": "Stripe"
    },
    {
      "name": "Klarna"
    }
  ],
  "discount_code": null,
  "total_discount": null
}

Example

{
  "createdAt": "2024-01-02T16:09:30.782Z",
  "updatedAt": "2024-01-02T16:09:30.782Z",
  "id": "1bf45d2b-3a5c-4aac-8e36-4a9f393ad474",
  "deletedAt": null,
  "success_url": null,
  "cancel_url": null,
  "payment_method": null,
  "email": null,
  "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": null,
  "shipping_address": null,
  "total_shipping_amount": 0,
  "availablePaymentMethods": [
    {
      "name": "Stripe"
    },
    {
      "name": "Klarna"
    }
  ],
  "discount_code": null,
  "total_discount": null
}

Loading...