About checkouts

Sync your store checkouts to Yotpo. This includes information about a user's cart as it transitions to a paid order, including which line items are included in the checkout, a customer's shipping and payment details, and tax and shipping rates.

📘

Checkouts endpoints are available for SMS Marketing.

Checkout endpoints

Checkout properties

Listed below are all of the available properties for checkouts. To see which properties are required per endpoint, refer to the endpoint pages below.

Field

Type

Description

token

string

A unique token for the checkout.
Max length: 255 characters

checkout_date

datetime

The date of the checkout. Must be in ISO 8601 format.

landing_site_url

string

The URL for the page where the buyer landed when they entered the shop.
Max length: 2048 characters

abandoned_checkout_url

string

The URL for the last page where the buyer abandoned the checkout.
Max length: 2048 characters

customer

object

The customer for this checkout. See customer checkout information description

billing_address

object

The billing address for this order. See address object description

shipping_address

object

The shipping address for this order. See address object description

currency

string

The shop's default currency at the time of checkout. Must be valid ISO code of 3 characters. See currency codes

line_items

array of objects

An array of line item objects for this checkout. See line item object description

created_at

datetime

The time the checkout was first synced to Yotpo. This field is read-only.

updated_at

datetime

The time the checkout was last updated in Yotpo. This field is read-only.