Interface CheckoutItem

The checkout item object available in checkout pricing scripts. Represents comprehensive checkout information including all items being purchased, customer details, shipping information, and checkout context.

This object provides complete checkout context for pricing calculations that need to consider shipping, customer information, and multi-item scenarios.

Hierarchy

  • CheckoutItem

Properties

Address CountryFrom Customer Items Mode Properties StateProvince ZipPostalCodeFrom

Properties

Address

Address: CheckoutAddress

Complete shipping address information. Provides comprehensive shipping address details including contact information.

Example

var address = CheckoutItem.Address;
if (address) {
    console("Shipping Address:");
    console("  " + address.FirstName + " " + address.LastName);
    if (address.Company) console("  " + address.Company);
    console("  " + address.Address1);
    if (address.Address2) console("  " + address.Address2);
    console("  " + address.City + ", " + address.StateProvince.Abbreviation + " " + address.ZipPostalCode);
    console("  " + address.Country.Name);
}

CountryFrom

CountryFrom: CheckoutCountry

Origin country information for shipping calculations. Represents the country from which items are being shipped.

Example

if (CheckoutItem.CountryFrom) {
    console("Shipping from: " + CheckoutItem.CountryFrom.Name);
}

Customer

Customer: CheckoutCustomer

Customer information for the checkout. Provides access to customer details including name, email, roles, and department.

Example

var customer = CheckoutItem.Customer;
console("Checkout for: " + customer.FirstName + " " + customer.LastName);
console("Email: " + customer.Email);
console("Department: " + customer.DepartmentName);

Items

Items: Item[]

Array of all items being checked out. Contains complete item information for all products in the checkout process.

Example

console("Checkout contains " + CheckoutItem.Items.length + " items");
var checkoutTotal = 0;
for (var i = 0; i < CheckoutItem.Items.length; i++) {
    var item = CheckoutItem.Items[i];
    checkoutTotal += item.Price * item.Quantity;
    console("Item " + (i + 1) + ": " + item.ProductName + " - $" + item.Price);
}
console("Checkout subtotal: $" + checkoutTotal);

Mode

Mode: string

Checkout mode or type. Indicates the type of checkout being performed (e.g., "standard", "express", etc.).

Example

console("Checkout mode: " + CheckoutItem.Mode);
if (CheckoutItem.Mode === "express") {
    console("Express checkout - apply expedited processing");
}

Properties

Properties: {
    [key: string]: string;
}

Additional properties for the checkout. Contains key-value pairs of additional checkout-specific information.

Type declaration

  • [key: string]: string

Example

console("Checkout properties:");
for (var key in CheckoutItem.Properties) {
    console("  " + key + ": " + CheckoutItem.Properties[key]);
}

StateProvince

StateProvince: CheckoutStateProvince

State/province information for shipping destination. Provides state or province details for the shipping destination.

Example

if (CheckoutItem.StateProvince) {
    console("Shipping to state: " + CheckoutItem.StateProvince.Name);
    console("State abbreviation: " + CheckoutItem.StateProvince.Abbreviation);
}

ZipPostalCodeFrom

ZipPostalCodeFrom: string

Origin ZIP/postal code for shipping calculations. Represents the postal code from which items are being shipped.

Example

console("Origin ZIP: " + CheckoutItem.ZipPostalCodeFrom);

Settings

Theme

On This Page

Generated using TypeDoc