Checkout

Error

A valid request URL is required to generate request examples

{
  "cart_key": "abc123def456",
  "cart_hash": "d41d8cd98f00b204e9800998ecf8427e",
  "currency": {
    "code": "USD",
    "symbol": "$",
    "base_currency": "USD",
    "exchange_rate": 1
  },
  "customer_id": 123,
  "billing_address": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone": "+1234567890",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "Anytown",
    "state": "CA",
    "postcode": "12345",
    "country": "US",
    "company": ""
  },
  "shipping_address": {
    "first_name": "John",
    "last_name": "Doe",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "Anytown",
    "state": "CA",
    "postcode": "12345",
    "country": "US",
    "company": ""
  },
  "cart_contents": {
    "c4ca4238a0b923820dcc509a6f75849b": {
      "key": "c4ca4238a0b923820dcc509a6f75849b",
      "product_id": 456,
      "variation_id": 0,
      "quantity": 2,
      "product_name": "Premium T-Shirt",
      "product_title": "Premium T-Shirt",
      "product_price": "$19.99",
      "line_total": "39.98",
      "line_subtotal": "39.98"
    }
  },
  "cart_totals": {
    "subtotal": "39.98",
    "subtotal_tax": "0.00",
    "shipping_total": "5.00",
    "shipping_tax": "0.00",
    "discount_total": "0.00",
    "discount_tax": "0.00",
    "cart_contents_total": "39.98",
    "cart_contents_tax": "0.00",
    "fee_total": "0.00",
    "fee_tax": "0.00",
    "total": "44.98",
    "total_tax": "0.00"
  },
  "shipping_methods": {
    "flat_rate:1": {
      "id": "flat_rate:1",
      "label": "Flat Rate",
      "cost": "5.00",
      "method_id": "flat_rate",
      "instance_id": "1"
    }
  },
  "needs_payment": true,
  "needs_shipping": true,
  "payment_method": "stripe"
}

GET

checkout

Error

A valid request URL is required to generate request examples

{
  "cart_key": "abc123def456",
  "cart_hash": "d41d8cd98f00b204e9800998ecf8427e",
  "currency": {
    "code": "USD",
    "symbol": "$",
    "base_currency": "USD",
    "exchange_rate": 1
  },
  "customer_id": 123,
  "billing_address": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "phone": "+1234567890",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "Anytown",
    "state": "CA",
    "postcode": "12345",
    "country": "US",
    "company": ""
  },
  "shipping_address": {
    "first_name": "John",
    "last_name": "Doe",
    "address_1": "123 Main St",
    "address_2": "Apt 4B",
    "city": "Anytown",
    "state": "CA",
    "postcode": "12345",
    "country": "US",
    "company": ""
  },
  "cart_contents": {
    "c4ca4238a0b923820dcc509a6f75849b": {
      "key": "c4ca4238a0b923820dcc509a6f75849b",
      "product_id": 456,
      "variation_id": 0,
      "quantity": 2,
      "product_name": "Premium T-Shirt",
      "product_title": "Premium T-Shirt",
      "product_price": "$19.99",
      "line_total": "39.98",
      "line_subtotal": "39.98"
    }
  },
  "cart_totals": {
    "subtotal": "39.98",
    "subtotal_tax": "0.00",
    "shipping_total": "5.00",
    "shipping_tax": "0.00",
    "discount_total": "0.00",
    "discount_tax": "0.00",
    "cart_contents_total": "39.98",
    "cart_contents_tax": "0.00",
    "fee_total": "0.00",
    "fee_tax": "0.00",
    "total": "44.98",
    "total_tax": "0.00"
  },
  "shipping_methods": {
    "flat_rate:1": {
      "id": "flat_rate:1",
      "label": "Flat Rate",
      "cost": "5.00",
      "method_id": "flat_rate",
      "instance_id": "1"
    }
  },
  "needs_payment": true,
  "needs_shipping": true,
  "payment_method": "stripe"
}

This endpoint is currently shown as a preview of what’s currently in development and is subject to change.

Response

Checkout data retrieved successfully

cart_key

string | null

Unique identifier for the cart session

cart_hash

string

MD5 hash of cart contents

currency

object

Currency information including code, symbol, and exchange rate

Show child attributes

currency.code

string

ISO 4217 currency code

Example:

"EUR"

currency.symbol

string

Currency symbol

Example:

"€"

currency.base_currency

string

Store's base currency code

Example:

"USD"

currency.exchange_rate

number<float> | null

Exchange rate from base currency to selected currency (null if same or unavailable)

Example:

0.85

customer_id

integer

Customer ID, if logged in

billing_address

object

Show child attributes

billing_address.first_name

string

First name

billing_address.last_name

string

Last name

billing_address.company

string

Company name

billing_address.address_1

string

Address line 1

billing_address.address_2

string

Address line 2

billing_address.city

string

City name

billing_address.state

string

State/County

billing_address.postcode

string

Postal code

billing_address.country

string

Country code

billing_address.phone

string

Phone number

billing_address.email

string<email>

Email address

shipping_address

object

Show child attributes

shipping_address.first_name

string

First name

shipping_address.last_name

string

Last name

shipping_address.company

string

Company name

shipping_address.address_1

string

Address line 1

shipping_address.address_2

string

Address line 2

shipping_address.city

string

City name

shipping_address.state

string

State/County

shipping_address.postcode

string

Postal code

shipping_address.country

string

Country code

cart_contents

object

Cart contents with product details

Show child attributes

cart_contents.{key}

object

Show child attributes

cart_contents.{key}.key

string

Cart item key

cart_contents.{key}.product_id

integer

Product ID

cart_contents.{key}.variation_id

integer

Variation ID (if applicable)

cart_contents.{key}.quantity

integer

Item quantity

cart_contents.{key}.line_total

string

Line total amount

cart_contents.{key}.line_subtotal

string

Line subtotal amount

cart_contents.{key}.product_name

string

Product name

cart_contents.{key}.product_title

string

Product title

cart_contents.{key}.product_price

string

Product price

cart_totals

object

Show child attributes

cart_totals.subtotal

string

Cart subtotal

cart_totals.subtotal_tax

string

Cart subtotal tax

cart_totals.shipping_total

string

Shipping total

cart_totals.shipping_tax

string

Shipping tax

cart_totals.discount_total

string

Discount total

cart_totals.discount_tax

string

Discount tax

cart_totals.cart_contents_total

string

Cart contents total

cart_totals.cart_contents_tax

string

Cart contents tax

cart_totals.fee_total

string

Fee total

cart_totals.fee_tax

string

Fee tax

cart_totals.total

string

Grand total

cart_totals.total_tax

string

Total tax

shipping_methods

object

Available shipping methods

Show child attributes

shipping_methods.{key}

object

Show child attributes

shipping_methods.{key}.id

string

Shipping method ID

shipping_methods.{key}.label

string

Shipping method label

shipping_methods.{key}.cost

string

Shipping cost

shipping_methods.{key}.method_id

string

Base method ID

shipping_methods.{key}.instance_id

string

Method instance ID

needs_payment

boolean

Whether the cart needs payment

needs_shipping

boolean

Whether the cart needs shipping

payment_method

string

Selected payment method

Process Checkout

⌘I

Overview

JWT Authentication

API v1 (Deprecated in future)

API v2

Plugins

Resources

Response