Class Checkout

Updates the Checkout. You can run multiple Checkout updates with different data types. See api docs.

Required token: Bearer token or Order token

Options schema:

interface options {
  order: {
    email?: string
    special_instructions?: string
    bill_address_attributes?: {
      firstname: string
      lastname: string
      address1: string
      city: string
      phone: string
      zipcode: string
      state_name: string
      country_iso: string
    }
    ship_address_attributes?: {
      firstname: string
      lastname: string
      address1: string
      city: string
      phone: string
      zipcode: string
      state_name: string
      country_iso: string
    }
    shipments_attributes?: [
      {
        selected_shipping_rate_id: number
        id: number
      }
    ]
  }
}

Success response schema: Success schema

Failure response schema: Error schema

Example:

// Logged in user
const response = await client.checkout.orderUpdate({
  bearer_token: '7381273269536713689562374856',
  order: {
    email: 'john@snow.org'
  }
})

// or guest user
const response = await client.checkout.orderUpdate({
  order_token: '7381273269536713689562374856',
  order: {
    email: 'john@snow.org'
  }
})

Goes to the next Checkout step. See api docs.

Required token: Bearer token or Order token

Success response schema: Success schema

Failure response schema: Error schema

Example:

// Logged in user
const response = await client.checkout.orderNext({
  bearer_token: '7381273269536713689562374856'
})

// or guest user
const response = await client.checkout.orderNext({
  order_token: '7381273269536713689562374856'
})

Advances Checkout to the furthest Checkout step validation allows, until the Complete step. See api docs.

Required token: Bearer token or Order token

Success response schema: Success schema

Failure response schema: Error schema

Example:

// Logged in user
const response = await client.checkout.advance({
  bearer_token: '7381273269536713689562374856'
})

// or guest user
const response = await client.checkout.advance({
  order_token: '7381273269536713689562374856'
})

Completes the Checkout. See api docs.

Required token: Bearer token or Order token

Success response schema: Success schema

Failure response schema: Error schema

Example:

// Logged in user
const response = await client.checkout.complete({
  bearer_token: '7381273269536713689562374856'
})

// or guest user
const response = await client.checkout.complete({
  order_token: '7381273269536713689562374856'
})

Adds Store Credit payments if a user has any. See api docs.

Required token: Bearer token or Order token

Options schema:

interface options {
  amount: number
}

Success response schema: Success schema

Failure response schema: Error schema

Example:

// Logged in user
const response = await client.checkout.addStoreCredits({
  bearer_token: '7381273269536713689562374856',
  amount: 100
})

// or guest user
const response = await client.checkout.addStoreCredits({
  order_token: '7381273269536713689562374856',
  amount: 100
})

Remove Store Credit payments if any applied. See api docs.

Required token: Bearer token or Order token

Success response schema: Success schema

Failure response schema: Error schema

Example:

// Logged in user
const response = await client.checkout.removeStoreCredits({
  bearer_token: '7381273269536713689562374856'
})

// or guest user
const response = await client.checkout.removeStoreCredits({
  order_token: '7381273269536713689562374856'
})

Returns a list of available Payment Methods. See api docs.

Required token: Bearer token or Order token

Success response schema: Success schema

Failure response schema: Error schema

Example:

// Logged in user
const response = await client.checkout.paymentMethods({
  bearer_token: '7381273269536713689562374856'
})

// or guest user
const response = await client.checkout.paymentMethods({
  order_token: '7381273269536713689562374856'
})

Returns a list of available Shipping Rates for Checkout. Shipping Rates are grouped against Shipments. Each checkout cna have multiple Shipments eg. some products are available in stock and will be send out instantly and some needs to be backordered. See api docs.

Required token: Bearer token or Order token

Success response schema: Success schema

Failure response schema: Error schema

Example:

// Logged in user
const response = await client.checkout.shippingRates({
  bearer_token: '7381273269536713689562374856',
  include: 'shipping_rates,stock_location'
})

// or guest user
const response = await client.checkout.shippingRates({
  order_token: '7381273269536713689562374856',
  include: 'shipping_rates,stock_location'
})

Selects a Shipping Method for Shipment(s). See api docs.

Required token: Bearer token or Order token

Options schema:

interface options {
  shipping_method_id: string
  shipment_id?: string
}

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.checkout.selectShippingMethod({
  bearer_token: '7381273269536713689562374856',
  shipping_method_id: '42'
})

Creates new Payment for the current checkout. See api docs.

Required token: Bearer token or Order token

Options schema:

interface options {
  payment_method_id: string
  source_id?: string
  amount?: number
  source_attributes?: {
    gateway_payment_profile_id: string
    cc_type?: string
    last_digits?: string
    month?: string
    year?: string
    name: string
  }
}

Success response schema: Success schema

Failure response schema: Error schema

Example:

// Logged in user

// Create new credit card
const response = await client.checkout.addPayment({
  bearer_token: '7381273269536713689562374856',
  payment_method_id: '1',
  source_attributes: {
    gateway_payment_profile_id: 'card_1JqvNB2eZvKYlo2C5OlqLV7S',
    cc_type: 'visa',
    last_digits: '1111',
    month: '10',
    year: '2026',
    name: 'John Snow'
  }
})

// Use existing credit card
const response = await client.checkout.addPayment({
  bearer_token: '7381273269536713689562374856',
  payment_method_id: '1',
  source_id: '1'
})

// or guest user

// Create new credit card
const response = await client.checkout.addPayment({
  order_token: '7381273269536713689562374856',
  payment_method_id: '1',
  source_attributes: {
    gateway_payment_profile_id: 'card_1JqvNB2eZvKYlo2C5OlqLV7S',
    cc_type: 'visa',
    last_digits: '1111',
    month: '10',
    year: '2026',
    name: 'John Snow'
  }
})