Swell Liquid: Objects | Swell Developer Center

Objects represent Swell data that are used to render output in theme templates. This reference describes Liquid objects that are accessible in storefront apps using Swell Liquid for themes, however individual storefront apps like Proxima may differ in how objects or named, or on which pages that are accessible. Refer to documentation on your chosen storefront app for those details.

Model and fields references

The Liquid objects in this guide refer to models and fields that coincide directly with Swell's Backend API. To find descriptions of various object properties listed here, see to the equivalent field in our backend API documentation.

Shopify compatibility

For Shopify themes, this guide will refer to both the Swell object structure and its Shopify equivalent object name, if applicable. Note that when a theme is rendered in Shopify compatibility mode, both Swell object properties, as described here, and Shopify object properties are available at the same time.

account

Represents the logged-in customer account.

Model: account

Shopify equivalent: customer

Properties

addresses (collection<account_address>): Collection of addresses associated with account.
balance (number): Current balance of account.
billing (account_billing): Billing information for account.
cards (collection<account_card>): Collection of payment cards linked to account.
content (content_object): Content object associated with account.
date_created (date): Date account was created.
date_first_order (date): Date of account's first order.
date_last_order (date): Date of account's last order.
email (string): Email address of account holder.
email_optin (boolean): Indicates whether account holder has opted into email communications.
first_name (string): First name of account holder.
group (string): Group or category account belongs to.
id (string): Unique identifier for account.
last_name (string): Last name of account holder.
metadata (object): Additional metadata associated with account.
name (string): Full name of account holder, combining first and last names.
order_count (date): Number of orders placed by account.
order_value (number): Total value of orders placed by account.
orders (collection<order>): Collection of orders associated with account.
phone (string): Phone number associated with account.
shipping (account_address): Shipping address for account.
subscriptions (collection<subscription>): Collection of subscriptions linked to account.
type (string): Type or classification of account.
vat_number (string): VAT number associated with account, if applicable.

Returned by

Global

account_address

Represents a customer’s shipping or billing address.

Model: account address

Shopify equivalent: address

Properties

address1 (string): Primary street address.
address2 (string): Secondary street address, such as an apartment or suite number.
city (string): City of the address.
company (string): Company name associated with the address, if applicable.
country (string): Country of the address.
first_name (string): First name of the contact.
id (string): Unique identifier for the address.
last_name (string): Last name of the contact.
name (string): Full name of the contact, combining first and last names.
phone (string): Phone number associated with the address.
state (string): State or province of the address.
zip (string): Postal or ZIP code of the address.

Returned by

account.addresses[]
account.shipping
account.billing
order.shipping
order.billing
subscription.shipping
subscription.billing

account_billing

Represents a customer's default billing details.

Model: account.billing

Properties

account_card_id (string): The ID of the payment card associated with the billing address.
address1 (string): The primary street address for billing.
address2 (string): The secondary street address for billing, such as an apartment or suite number.
card (account_card): The payment card object linked to the billing address.
city (string): The city of the billing address.
company (string): The company name associated with the billing address, if applicable.
country (string): The country of the billing address.
first_name (string): The first name of the billing contact.
id (string): The unique identifier for the billing address.
last_name (string): The last name of the billing contact.
method (string): The payment method type used for billing, such as credit card or PayPal.
name (string): The full name of the billing contact, combining first and last names.
phone (string): The phone number associated with the billing address.
state (string): The state or province of the billing address.
zip (string): The postal or ZIP code of the billing address.

Returned by

account.billing

account_card

Represents a customer's credit card on file.

Model: account.cards

Properties

address_check (string): Address verification check result for payment card.
brand (string): Brand of the payment card, for example visa or mastercard.
cvc_check (string): CVC verification check result for payment card.
display_brand (string): Display-friendly version of the payment card brand.
exp_month (number): Expiration month of the payment card.
exp_year (number): Expiration year of the payment card.
gateway (string): Payment gateway used for the card transaction.
id (string): Unique identifier for the payment card.
last4 (string): Last four digits of the payment card number.
token (string): Token representing the payment card for secure transactions.
zip_check (string): ZIP code verification check result for payment card.

Returned by

account.cards[]
cart.billing.card
order.billing.card
subscription.billing.card

all_country_option_tags

Generates HTML <option> tags for all available countries in a dropdown. Output should be wrapped in a <select> tag.

Shopify equivalent: all_country_option_tags

Example

<select name="country">
  {{ all_country_option_tags }}
</select>

author

Represents the user which authored a blog.

Properties

email (string): Email address of the author.
name (string): Full name of the author.
username (string): Username of the author.

Returned by

blog.author

block

Represents a customizable section block in a theme, such as a text or image block.

Shopify equivalent: block

Properties

id (string): Unique identifier for the block.
settings (object): Configuration settings for the block.
type (string): Type of the block, indicating its purpose or layout.

Returned by

section.blocks[]

blog

Represents a blog post.

Shopify equivalent: article

Properties

author (author): Author object associated with the blog post.
author_id (string): ID of the author.
category (blog_category): Category object the blog post belongs to.
category_id (string): ID of the category.
content (string): Main content of the blog post.
date_created (date): Date the blog post was created.
date_updated (date): Date the blog post was last updated.
id (string): Unique identifier for the blog post.
image (image): Image object associated with the blog post.
meta_title (string): Meta title for SEO purposes.
meta_description (string): Meta description for SEO purposes.
slug (string): URL-friendly slug of the blog post.
summary (string): Brief summary of the blog post.
tags (array<string>): Array of tags associated with the blog post.
theme_template (string): Alternate template used to render the blog post in a storefront.

Returned by

blog_category.blogs[]

blog_category

Represents a blog category.

Shopify equivalent: blog

Properties

blogs (collection<blog>): Collection of blogs associated with the category.
id (string): Unique identifier for the category.
meta_title (string): Meta title for SEO purposes.
meta_description (string): Meta description for SEO purposes.
slug (string): URL-friendly slug of the category.
title (string): Title of the category.

Returned by

blog.category

canonical_url

Returns the canonical URL for the current page, used to avoid duplicate content pages from being indexed by search engines.

Learn more about canonical URLs here.

cart

Represents the customer’s shopping cart.

Model: cart

Shopify equivalent: cart

Properties

account_id (string): ID of the account associated with the cart.
account_info_saved (boolean): Indicates if account information is is to be saved when the order is submitted.
account_logged_in (boolean): Indicates if the account is logged in when placing the order.
auth_total (number): Total authorized amount for the cart.
billing (cart_billing): Billing information for the cart.
capture_total (number): Total captured amount for the cart.
checkout_id (string): Unique identifier for the checkout process.
checkout_url (string): URL for the checkout page.
comments (string): Comments added to the cart.
content (content_object): Content object associated with the cart.
coupon (coupon): Coupon object applied to the cart.
coupon_code (string): Coupon code applied to the cart.
coupon_id (string): ID of the applied coupon.
currency (string): Currency used for the cart.
date_created (date): Date the cart was created.
discounts (array<cart_discount>): Array of discount objects applied to the cart.
discount_total (number): Total discount amount applied.
display_currency (string): Display currency for the cart.
display_locale (string): Display locale for the cart.
gift (boolean): Indicates if the cart is a gift purchase.
gift_message (string): Gift message included with the cart.
giftcards (array<cart_giftcards>): Array of gift card objects applied to the cart.
giftcard_delivery (boolean): Indicates if the cart contains gift cards to be sent when the order is submitted.
giftcard_total (number): Total gift card amount applied as a payment source.
grand_total (number): Grand total amount of the cart.
guest (boolean): Indicates if the cart is for a guest user.
id (string): Unique identifier for the cart.
items (array<cart_item>): Array of items in the cart.
item_discount (number): Total discount amount for all items.
item_quantity (number): Total quantity of all items in the cart.
item_shipment_weight (number): Total shipment weight of all items.
item_tax (number): Total tax amount for all items.
item_tax_included (boolean): Indicates if item tax is included in the price.
metadata (metadata_object): Metadata object associated with the cart.
order_id (string): ID of the associated order after the cart is converted.
payment_intent (object): Payment intent object for the cart, if applicable.
promotions (collection<promotion>): Collection of promotion objects applied to the cart.
recovered (boolean): Indicates if the was recovered after being abandoned.
shipment_delivery (boolean): Indicates if cart contains physical items to be fulfilled when the order is submitted.
shipment_price (number): Price of the shipment.
shipment_rating (shipment_rating): Shipment rating object for the cart.
shipment_tax (number): Tax amount for the shipment.
shipment_tax_included (boolean): Indicates if shipment tax is included.
shipment_total (number): Total shipment cost.
shipping (cart_shipping): Shipping information for the cart.
sub_total (number): Subtotal amount of the cart.
subscription_delivery (boolean): Indicates if cart contains subscription items to be converted when the order is submitted.
taxes (array<cart_tax>): Array of tax objects applied to the cart.
tax_included_total (number): Total amount of taxes included with item prices.
tax_total (number): Total tax amount applied.

Returned by

Global

cart_billing

Represents a customer's billing address applied to the shopping cart.

Model: cart.billing

Properties

account_card_id (string): ID of the payment card associated with the billing.
address1 (string): Primary street address for billing.
address2 (string): Secondary street address for billing, such as an apartment or suite number.
card (account_card): Payment card object linked to the billing.
city (string): City of the billing address.
company (string): Company name associated with the billing, if applicable.
country (string): Country of the billing address.
default (boolean): Indicates if this is the default billing method.
first_name (string): First name of the billing contact.
intent (object): Intent object related to the billing process.
last_name (string): Last name of the billing contact.
method (string): ID of the payment method type used for billing, for example card or account.
name (string): Full name of the billing contact, combining first and last names.
phone (string): Phone number associated with the billing.
province (string): Province or region of the billing address, if applicable.
state (string): State of the billing address, used for countries like the US.
zip (string): Postal or ZIP code of the billing address.

Returned by

cart.billing
order.billing
subscription.billing

cart_bundle_item

Represents a bundle item as a part of a cart item in the customer's shopping cart.

Model: cart.items.bundle_items

Properties

id (string): Unique identifier for the bundle item.
options (array<cart_item_option>): Array of product options for the bundle item.
product (product): Reference to the product associated with the bundle item.
product_id (string): ID of the product in the bundle.
quantity (number): Quantity of the item in the bundle.
variant (variant): Reference to the variant associated with the bundle item, if applicable.
variant_id (string): ID of the variant in the bundle, if applicable.

Returned by

cart_item.bundle_items[]

cart_discount

Represents a customer's billing address applied to the shopping cart.

Model: cart.discounts

Properties

amount (number): Amount of the discount applied.
id (string): Unique identifier for the discount.
rule (object): Rule object defining the discount conditions.
source_id (string): ID of the source applying the discount.
type (string): Type of the discount, percent or fixed.

Returned by

cart.discounts
order.discounts
subscription.discounts

cart_giftcards

Represents one or more gift cards used as payment sources on the customer's shopping cart.

Model: cart.giftcards

Properties

amount (number): Amount of the gift card value applied.
code (string): Code of the gift card.
code_formatted (string): Formatted version of the gift card code.
id (string): Unique identifier for the gift card.
las4 (string): Last four digits of the gift card number.

Returned by

cart.giftcards
order.giftcards

cart_item

Represents line item within the customer’s shopping cart.

Model: cart.items

Properties

bundle_items (array<cart_bundle_item>): Array of bundle items as a part of the item, if applicable.
discount_each (number): Discount amount per unit of the cart item.
discount_total (number): Total discount amount for the cart item.
id (string): Unique identifier for the cart item.
metadata (object): Metadata object associated with the cart item.
options (array<cart_item_option>): Array of options applied to the cart item, relative to the selected product and variant.
orig_price (number): Original price of the cart item before any manual modifications.
price (number): Current price of the cart item.
price_total (number): Total price for the cart item based on quantity.
purchase_option (cart_purchase_option): Purchase option selected for the cart item.
product (product): Reference to the product associated with the cart item.
quantity (number): Quantity of the cart item.
shipment_weight (number): Shipment weight of the cart item, if applicable.
taxes (array<cart_item_tax>): Array of tax lines applied to the cart item.
tax_each (number): Tax amount per unit of the cart item.
tax_total (number): Total tax amount for the cart item.
variant (product_variant): Reference to the variant associated with the cart item.

Returned by

cart.items[]

cart_item_option

Represents an option applied to a line item in the customer's shopping cart. Variants are resolved using these values if a variant_id is not assigned directly.

Model: cart.items.options

Properties

name (string): Name of the option for the cart item.
id (string): Unique identifier for the option.
price (number): Price adjustment associated with the option.
shipment_weight (number): Shipment weight adjustment for the option.
value (string): Value of the option.
value_id (string): ID of the option value relative to the product option.
variant (boolean): Indicates if the option is a variant.

Returned by

cart.items.options
order.items.options
subscription.items.options

Gift card item options

If the item is a gift card, the application may indicate special options to affect the gift card recipient and an optional note.

Option to send to a specific recipient email

id: 'send_email'
value: 'recipient@example.com'

Option to send to a gift note

id: 'send_note'
value: 'For your special day!'

cart_item_tax

Represents a single tax line applied to an item in the customer's shopping cart.

Model: cart.items.taxes

Properties

amount (number): Amount of tax applied to the cart item.
id (string): Unique identifier for the applied tax.

Returned by

cart_item.taxes[]

cart_purchase_option

Represents a chosen purchase option for an item within the customer's shopping cart, either a standard purchase or subscription.

Model: cart.items.purchase_option

Shopify equivalent: selling_plan

Properties

auth_amount (number): Pre-authorized amount for the purchase option, if applicable
billing_schedule (purchase_option_schedule): Billing schedule for subscriptions
id (string): Unique identifier for the purchase option.
name (string): Descriptive name of the purchase option.
order_schedule (purchase_option_schedule): Order schedule for subscriptions
plan_id (string): ID of the associated product purchase optionplan.
plan_description (string): Description of the associated plan.
plan_name (string): Descriptive name of the associated plan.
price (number): Price of the purchase option.
type (string): Type of the purchase option, either standard or subscription.

Returned by

cart.items.purchase_option
order.items.purchase_option
subscription.items.purchase_option

cart_shipping

Properties

account_address_id (string): ID of the account address applied to the cart.
account_address (account_address): Reference to the account address record.
address1 (string): Primary street address.
address2 (string): Secondary street address, such as an apartment or suite number.
city (string): City of the address.
company (string): Company name associated with the address, if applicable.
country (string): Country of the address.
default (boolean): Indicates whether the shipping address was set as the default for the account.
first_name (string): First name of the contact.
id (string): Unique identifier for the address.
last_name (string): Last name of the contact.
name (string): Full name of the contact, combining first and last names.
phone (string): Phone number associated with the address.
pickup (boolean): Indicates the order is to be fulfilled at a physical pickup location.
price (number): Price of the selected shipping service.
service: (string): ID of the selected shipping service.
service_name (string): Name of the selected shipping service
state (string): State or province of the address.
zip (string): Postal or ZIP code of the address.

Returned by

cart.shipping
order.shipping
subscription.shipping

cart_tax

Represents a tax line applied to the customer's shopping cart.

Model: cart.taxes

Properties

amount (number): Amount of the tax applied.
id (string): Unique identifier for the tax.
name (string): Name of the tax.
priority (number): Priority level of the tax application.
rate (number): Rate of the tax as a decimal.
shipping (boolean): Indicates if the tax applies to shipping costs.

Returned by

cart.taxes
order.taxes
subscription.taxes

color

Represents a color setting value. Returns a hexidecimal color code when rendered directly.

Shopify equivalent: color

Returned by

settings object

Example

{{ settings.color_primary }}

color_scheme

Represents a color scheme setting value. Returns the scheme ID when rendered directly.

Shopify equivalent: color_scheme

Returned by

settings object

Example

{{ settings.color_accent_scheme }}

color_scheme_group

Represents a color scheme group setting value. Used output all color schemes to CSS rules.

Shopify equivalent: color_scheme_group

Returned by

settings.color_schemes

Example

{% for scheme in settings.color_schemes %}
  .color-scheme-{{ scheme.id }} {
    --color-text: {{ scheme.settings.text }};
    --color-background: {{ scheme.settings.background }};
  }
{% endfor %}

content_for_header

Injects necessary scripts and meta tags into the HTML <head> of a page. Automatically populated by the platform for essential functionality.

Returned by

Global

Example

<html>
  <head>
    {{ content_for_header }}
  </head>
  ...
</html>

content_for_layout

Renders the main content of a template, excluding the layout file’s wrapper. Used within layout files to insert page-specific content.

Returned by

Global

Example

<html>
  ...
  <body>
    {{ content_for_layout }}
  </body>
  ...
</html>

content_model

Represents a content model defined in the store either manually, or as installed by a Swell App.

Model: content

Shopify equivalent: metaobject

Properties

collection (string): API name of the collection representing the content model, for example reviews.
date_created (date): Date the content model was created.
date_updated (date): Date the content model was last updated.
fields (array<object>): Array of field definitions for the content model.
id (string): Unique identifier for the content model.
label (string): Label or display name of the content model entries.
name (string): Name of the content model itself.

content_object

Represents content field values present on another object. For example, product.content contains values in accordance with custom or app-defined fields applied to the product model.

Returned by

account.content
cart.content
order.content
subscription.content

Example

{{ product.content.my_content_field }}

country_option_tags

Generates HTML <option> tags for all available countries in a dropdown. Output should be wrapped in a <select> tag. Note: this is an alias for all_country_option_tags.

Shopify equivalent: country_option_tags

Returned by

Global

Example

<select name="country">
  {{ all_country_option_tags }}
</select>

coupon

Represents a coupon applied to the customer's shopping cart.

Model: coupon

Properties

content (content_object): Content object associated with the coupon.
description (string): Description of the coupon.
id (string): Unique identifier for the coupon.
name (string): Name of the coupon, representing the coupon code if the coupon only has one code.

Returned by

cart.coupon
order.coupon
subscription.coupon

current_page

Returns the current page number for paginated content, such as products and search results.

Shopify equivalent: current_page

Returned by

Global

Example

Page: {{ current_page }}

file

Represents a file stored by another object, such as a content model value representing an attached document. If the file is an image, it will also have width and length properties.

Model: file

Shopify equivalent: generic_file

Properties

content_type (string): MIME type of the file.
date_created (date): Date the file was created.
filename (string): Name of the file in the filesystem.
height (number): Height of the file in pixels, if applicable.
id (string): Unique identifier for the file.
length (number): Size of the file in bytes.
md5 (string): MD5 hash of the file for integrity verification.
url (string): URL where the file can be accessed.
width (number): Width of the file in pixels, if applicable.

Returned by

image.file

font

Represents a font setting value. Used to apply font setting values in theme CSS styles.

Shopify equivalent: font

Properties

fallback_families (string): Fallback font families as a string.
family (string): Primary font family name.
style (string): Style of the font, for example normal or italic.
system (boolean): Indicates if the font is a system font.
variants (array<font>): Array of font variant objects.
weight (number): Weight of the font, for example 400 or 700.

Returned by

settings object

Example

{% style %}
  --font-body-family: {{ settings.body_font.family }}, {{ settings.body_font.fallback_families }};
  --font-body-style: {{ settings.body_font.style }};
  --font-body-weight: {{ settings.body_font.weight }};
{% endstyle %}

forloop

Provides metadata about a for loop, such as iteration status.

Shopify equivalent: forloop

Properties

first (boolean): Indicates if the current iteration is the first one.
index (number): 1-based index of the current iteration.
index0 (number): 0-based index of the current iteration.
last (boolean): Indicates if the current iteration is the last one.
length (number): Total number of iterations.
parentloop (forloop): Parent forloop object if nested.
rindex (number): 1-based index in reverse order.
rindex0 (number): 0-based index in reverse order.

Returned by

for tag

Example

{% for product in products -%}
  {%- if forloop.length > 0 -%}
    {{ product.name }}{% unless forloop.last %}, {% endunless -%}
  {%- endif -%}
{% endfor %}

form

Represents an HTML form for user input, such as login or checkout forms. Each form may provide different properties represented in the form object. See the form tag for more details.

Properties

errors (array<form_error>): Array of error objects for the form, if any.
params (object): Parameters submitted with the form.
success (boolean): Indicates if the form submission was successful.

Returned by

form tag

Example

{% form 'account_subscribe' %}
  {% if form.success %}
    You have been subscribed to our newsletter.
  {% elsif form.errors %}
    Something went wrong.
  {% endif %}
{% endform %}

form_error

Represents an error that occurred while processing a form submission.

Properties

code (string): Error code associated with the form error.
field_label (string): Label of the field where the error occurred.
field_name (string): Name of the field where the error occurred.
message (string): Detailed message describing the error.

Returned by

form.errors

image

Represents an image including its caption and reference to the image file.

Shopify equivalent: image

Properties

caption (string): Caption to use as alt-text on the image.
file (file): File used as the product image.
id (string): Unique identifier of the product image.

Returned by

blog.image
category.image
category.images[]
product.images[]
product_variant.images[]

menus

Represents all navigation menu configured for the storefront in the Swell dashboard. Menus may have any number of nested items supported by the theme, and can be accessed directly using their ID.

Shopify equivalent: linklists

Returned by

Global

Example

<!-- Main menu -->
{% for link in menus.main_menu.items -%}
  {{ item.name | link_to: item.url }}
{%- endfor %}

<!-- Footer menu -->
{% for link in menus.footer_menu.items -%}
  {{ item.name | link_to: item.url }}
{%- endfor %}

menu_item

Represents a navigation menu item.

Shopify equivalent: link

Properties

active (boolean): Indicates if the menu item is active.
child_active (boolean): Indicates if any child item is active.
child_current (boolean): Indicates if any child item is the current page.
current (boolean): Indicates if the menu item is the current page.
items (array<menu_item>): Array of nested menu item objects.
levels (number): Number of nesting levels for the menu item.
name (string): Name of the menu item.
resource (mixed): Resource associated with the menu item.
type (string): Type of the menu item.
url (string): URL linked to the menu item.

Returned by

menu.items[]

metadata_object

Represents metadata values applied via API to an account, cart, order or subscription.

Returned by

account.metadata
cart.metadata
order.metadata
subscription.metadata

Example

{{ order.metadata.my_meta_field }}

order

Represents a customer order.

Model: order

Shopify equivalent: order

Properties

account_credit_amount (number): Total account credit available.
account_credit_applied (number): Amount of account credit applied to the order.
account_id (string): ID of the account that placed the order.
account_info_saved (boolean): Indicates if account information is is to be saved when the order is updated.
account_logged_in (boolean): Indicates if the account is logged in when placing the order.
authorized_payment_id (string): Unique identifier of the authorized payment, if applicable.
billing (cart_billing): Customer billing information for the order.
canceled (boolean): Indicates if the order is canceled.
comments (string): Comments added to the order.
content (content_object): Content object associated with the order.
coupon (coupon): Coupon object applied to the order.
coupon_code (string): Coupon code applied to the cart.
coupon_id (string): Unique identifier of the applied coupon.
currency (string): Currency used for the order.
date_created (date): Date the order was created.
delivered (boolean): Indicates if the order is delivered.
discounts (array<cart_discount>): Array of discount objects applied to the order.
discount_total (number): Total discount amount applied.
gift (boolean): Indicates if the order is a gift purchase.
gift_message (string): Gift message included with the order.
giftcards (array<cart_giftcard>): Array of gift card objects applied to the order.
giftcard_delivery (boolean): Indicates if order contains gift cards items to be sent when submitted.
giftcard_total (number): Total gift card amount applied.
grand_total (number): Grand total amount of the order.
guest (boolean): Indicates if the order is for a guest user.
id (string): Unique identifier for the order.
items (array<cart_item>): Array of items in the order.
item_discount (number): Total discount amount for items.
item_quantity (number): Total quantity of items in the order.
item_quantity_cancelable (number): Quantity of items eligible for cancellation.
item_quantity_canceled (number): Quantity of items canceled.
item_quantity_deliverable (number): Quantity of items eligible for delivery.
item_quantity_delivered (number): Quantity of items delivered.
item_quantity_returnable (number): Quantity of items eligible for return.
item_quantity_returned (number): Quantity of items returned.
item_shipment_weight (number): Total shipment weight of items.
item_tax (number): Total tax amount for items.
item_tax_included (boolean): Indicates if item tax is included in the price.
metadata (metadata_object): Metadata object associated with the order.
number (string): Order number for reference.
paid (boolean): Indicates if the order is paid.
payments (collection<payment>): Collection of payment objects for the order.
payment_balance (number): Remaining balance to be paid.
payment_intent (object): Payment intent object for the order, if applicable.
payment_total (number): Total payment amount received.
promotions (collection<promotion>): Collection of promotion objects applied to the order.
refunds (collection<refund>): Collection of refund objects for the order.
refund_total (number): Total amount of refunds for the order.
returns (collection<return>): Collection of return objects for the order.
shipments (collection<shipment>): Collection of shipment objects for the order.
shipment_delivery (boolean): Indicates if order contains subscription items to be converted when submitted.
shipment_discount (number): Discount amount applied to shipment.
shipment_price (number): Price of the shipment.
shipment_rating (shipment_rating): Shipment rating object for the order.
shipment_tax (number): Tax amount for the shipment.
shipment_tax_included (boolean): Indicates if shipment tax is included.
shipment_total (number): Total shipment cost.
shipping (cart_shipping): Customer shipping information for the order.
status (string): Status of the order, for example pending or completed.
sub_total (number): Subtotal amount of the order.
subscription_delivery (boolean): Indicates if order contains subscription items to be converted when submitted.
taxes (array<cart_tax>): Array of tax objects applied to the order.
tax_included_total (number): Total amount including tax.
tax_total (number): Total tax amount applied.

Returned by

account.orders[]

page_description

Returns the meta description for a page, used for search engine listings and social media previews. Falls back to a truncated version of the page content if not set.

Returned by

Global

Example

<html>
  <head>
    <meta name="description" content="{{ page_description }}">
  </head>
  ...
</html>

page_title

Returns the title of the current page, used for search engine listings and social media previews.

Returned by

Global

Example

<html>
  <head>
    <title>{{ page_title }}</title>
  </head>
  ...
</html>

paginate

Provides details about pagination inside of paginate tags.

Shopify equivalent: paginate

Properties

count (number): Total number of items in the paginated collection.
limit (number): Maximum number of items per page.
next (paginate_page): Next page object in the pagination sequence.
page (number): Current page number.
pages (array<paginate_page>): Array of page objects for all pages.
page_count (number): Total number of pages.
previous (paginate_page): Previous page object in the pagination sequence.

Returned by

paginate tag

paginate_page

Represents a page target within a pagination object, with numbers indexing the start and end of items on the page, and a URL to navigate to the page.

Properties

end (number): Ending index of items on the page.
start (number): Starting index of items on the page.
url (string): URL for the page.

Returned by

paginate.next
paginate.pages
paginate.previous

payment

Represents a payment made by a customer, applied to an order or subscription.

Model: payment

Properties

amount (number): Amount of the payment.
amount_refundable (number): Amount eligible for refund.
authorized (boolean): Indicates if the payment was pre-authorized.
captured (boolean): Indicates if the payment was captured.
card (account_card): Card object associated with the payment.
currency (string): Currency of the payment.
date_created (date): Date the payment was created.
gateway (string): Payment gateway used for the transaction.
id (string): Unique identifier for the payment.
method (string): Payment method used, for example card or account.
number (string): Payment transaction number.
status (string): Status of the payment, for example pending or success.
success (boolean): Indicates if the payment was successful.

Returned by

order.payments[]
subscription.payments[]

product

Represents a single product in the store.

Model: product

Shopify equivalent: product

Properties

attributes (object): Attributes associated with the product.
categories (collection<category>): Collection of categories the product belongs to.
cross_sells (array<product_cross_sell>): Array of cross-sell products.
currency (string): Currency used for the product price.
description (string): Description of the product.
bundle (boolean): Indicates if the product is a bundle of other products.
bundle_items (array<product_bundle_item>): Array of bundle items included in the product.
id (string): Unique identifier for the product.
images (array<image>): Array of images associated with the product.
meta_description (string): Meta description for SEO purposes.
meta_title (string): Meta title for SEO purposes.
name (string): Name of the product.
options (array<product_option>): Array of option objects for the product.
price (number): Base price of the product.
prices (array<product_price>): Array of price variations for the product.
purchase_options (purchase_options): Purchase options available for the product.
sale (boolean): Indicates if the product is on sale.
sku (string): Stock Keeping Unit for the product.
slug (string): URL-friendly slug of the product.
stock_level (number): Current stock level of the product.
stock_purchasable (boolean): Indicates if the product is purchasable based on stock.
stock_status (string): Status of the product stock, for example in_stock or out_of_stock.
stock_tracking (boolean): Indicates if stock is tracked for the product.
tags (array<string>): Array of tags associated with the product.
theme_template (string): Alternate template used to render the product in a storefront.
up_sells (array<product_up_sell>): Array of up-sell product objects.
variants (collection<product_variant>): Collection of variant objects for the product.

Scopes

category.products[]

product_bundle_item

Represents an item as part of a bundle product.

Model: product.bundle_items

Properties

id (string): Unique identifier for the bundle item.
product (product): Product object associated with the bundle item.
product_id (string): Unique identifier of the product.
product_name (string): Name of the product in the bundle.
quantity (number): Quantity of the bundle item.
variant (product_variant): Variant object associated with the bundle item.
variant_id (string): Unique identifier of the variant.

Returned by

product.bundle_items[]

product_cross_sell

Represents a cross-sell relationship between products, including an optional discount for offers that combine complementary items. Cross-sells are used to make additional offers when an item is added to the shopping cart.

Model: product.cross_sells

Properties

id (string): Unique identifier for the cross-sell item.
discount_amount (number): Discount amount applied to the cross-sell, if applicable.
discount_percent (number): Discount percentage applied to the cross-sell, if applicable.
discount_type (string): Type of discount, fixed or percent.
product (product): Product object for the cross-sell item.
product_id (string): Unique identifier of the cross-sell product.

Returned by

product.cross_sells[]

product_option

Represents an individual product option, such as "size" or "color". Options may represent variant attributes which correlate to product_variant objects, or non-variant options. May also represent a subscription purchase option.

Model: product.options

Shopify equivalent: product_option

Properties

active (boolean): Indicates if the option is active.
attribute_id (string): Unique identifier of the associated attribute.
description (string): Description of the option.
id (string): Unique identifier for the option.
input_type (string): Type of input field, for example text or select.
input_multi (boolean): Indicates if multiple values can be selected.
input_hint (string): Hint text for the input field.
name (string): Name of the option.
parent_id (string): Unique identifier of the parent option, if applicable.
parent_value_ids (array<string>): Array of parent value identifiers.
price (number): Price adjustment associated with the option.
required (boolean): Indicates if the option is required.
subscription (boolean): Indicates if the option is for a subscription purchase option.
values (array<product_option_value>): Array of value objects for the option.
variant (boolean): Indicates if the option defines a variant.

Returned by

product.options[]

product_option_value

Represents an individual value of a product option for multiple-select options such as "blue" for color. May also represent a subscription option such as "monthly".

Model: product.options.values

Shopify equivalent: product_option_value

Properties

description (string): Description of the option value.
id (string): Unique identifier for the option value.
name (string): Name of the option value.
price (currency): Price associated with the option value.
shipment_weight (number): Shipment weight adjustment for the option value, if applicable.
subscription_interval (string): Interval period for subscription, for example monthly or yearly, if applicable.
subscription_interval_count (number): Number of intervals for the subscription, if applicable.
subscription_trial_days (number): Number of trial days for the subscription, if applicable.

Returned by

product_option.values[]

product_price

Represents a product price rule, supporting volume and account-specific prices.

Model: product.prices

Properties

account_group (string): Account group associated with the price.
discount_percent (number): Discount percentage applied to the price.
price (number): Price value.
quantity_max (number): Maximum quantity for the price tier.
quantity_min (number): Minimum quantity for the price tier.

Returned by

product.prices[]

product_up_sell

Represents an ups-sell relationship between products.. Up-sells are used in product recommendations.

Model: product.up_sells

Properties

product (product): Reference to the product in the up-sell relationship.
product_id (string): ID of the up-sell product.

Returned by

product.up_sells[]

product_variant

Represents a variation of a product in the store. Products have variants only when variant options are configured.

Model: product variant

Shopify equivalent: variant

Properties

attributes (object): Attributes associated with the variant.
currency (string): Currency used for the variant price.
id (string): Unique identifier for the variant.
images (array<image>): Array of images associated with the variant.
name (string): Name of the variant.
option_value_ids (array<string>): Array of option value identifiers.
price (number): Price of the variant.
prices (array<product_price>): Array of price variations for the variant.
purchase_options (purchase_options): Purchase options available for the variant.
sku (string): Stock Keeping Unit for the variant.
stock_level (number): Current stock level of the variant.

Returned by

product.variants[]

promotion

Represents a promotion applied to the customer's shopping cart.

Model: promotions

Properties

content (content_object): Content object associated with promotion.
date_end (date): End date of the promotion.
date_start (date): Start date of the promotion.
description (string): Description of the promotion.
id (string): ID of the promotion.
name (string): Name of the promotion.

Returned by

cart.promotions[]
order.promotions[]

purchase_options

Represents the purchase options available for a product, such as standard meaning one-time purchase, and subscription.

Model: product.purchase_options

Properties

standard (purchase_option_standard): Standard purchase option configuration.
subscription (purchase_option_subscription): Subscription purchase option configuration.

Returned by

product.purchase_options

purchase_option_standard

Represents a standard product purchase option.

Model: product.purchase_options.standard

Properties

description (string): Description of the standard purchase option.
id (string): Unique identifier for the purchase option.
name (string): Name of the standard purchase option.
price (number): Base price of the purchase option.
prices (array<product_price>): Array of price variations for the purchase option.
sale (boolean): Indicates if the purchase option is on sale.
sale_price (number): Sale price of the purchase option, if applicable.

Returned by

purchase_options.standard

purchase_option_subscription

Represents a subscription product purchase option.

Model: product.purchase_options.subscription

Properties

description (string): Description of the subscription purchase option.
id (string): Unique identifier for the subscription purchase option.
name (string): Name of the subscription purchase option.
plans (array<purchase_option_subscription_plan>): Array of subscription plan objects.

Returned by

purchase_options.subscription

purchase_option_subscription_plan

Represents a subscription purchase option plan, such as a monthly or yearly plan.

Model: product.purchase_options.subscription.plans

Properties

billing_schedule (purchase_option_schedule): Billing schedule for the subscription plan.
description (string): Description of the subscription plan.
id (string): Unique identifier for the subscription plan.
name (string): Name of the subscription plan.
order_schedule (purchase_option_schedule): Order schedule for the subscription plan.
price (number): Price of the subscription plan.

Returned by

purchase_option_subscription.plans[]

purchase_option_schedule

Represents the schedule to trigger billing (payment) and order (fulfillment) of a subscription purchase option in a customer's shopping cart.

Properties

interval (string): Interval period for the schedule, daily, weekly, monthly, or yearly.
interval_count (number): Number of intervals between occurrences.
limit (number): Maximum number of occurrences for the schedule.

Returned by

cart_purchase_option.billing_schedule
cart_purchase_option.order_schedule
purchase_option_subscription_plan.billing_schedule
purchase_option_subscription_plan.order_schedule

refund

Represents a payment refund applied to a customer's order or subscription.

Model: payment refund

Properties

amount (number): Amount of the refund.
card (account_card): Card object associated with the refund.
currency (string): Currency of the refund.
date_created (date): Date the refund was created.
gateway (string): Payment gateway used for the refund, for example stripe.
id (string): Unique identifier for the refund.
method (string): Payment method used for the refund, for example card.
number (string): Refund transaction number.
status (string): Status of the refund, for example pending or success.
success (boolean): Indicates if the refund was successful.
canceled (boolean): Indicates if the refund is canceled.

Returned by

order.refunds[]
subscription.refunds[]

return

Represents a shipment return authorization for a customer's order.

Model: return

Properties

canceled (boolean): Indicates if the return shipment is canceled.
destination (shipment_endpoint): Destination endpoint for the return shipment.
items (array<shipment_item>): Array of items included in the return shipment.
number (string): Return shipment tracking number.
origin (shipment_address): Origin address for the return shipment.
tracking_code (object): Carrier tracking code for the return shipment.

Returned by

order.returns[]

request

Provides information about the current page request.

Shopify equivalent: request

Properties

currency (string): User-selected currency of the request.
host (string): Hostname of the request.
is_editor (boolean): Indicates if the request is from the Swell Theme editor.
is_preview (boolean): Indicates if the request is in preview mode.
locale (string): User-selected locale of the request.
origin (string): Origin URL of the request.
path (string): Path of the request.
query (object): Query parameters of the request.

Returned by

Global

section

Provides access to section properties within a section Liquid template.

Shopify equivalent: section

Properties

blocks (array<block>): Array of block objects within the section.
id (string): Unique identifier for the section.
settings (object): Configuration settings for the section.

Returned by

Global

Example

{% if settings.enable_floating_cart %}
  {% render 'floating-cart' %}
{% endif %}

settings

Provides access to theme settings defined in the theme editor.

Shopify equivalent: settings

Returned by

Global

Example

{% if settings.enable_floating_cart %}
  {% render 'floating-cart' %}
{% endif %}

shipment

Represents a physical shipment for a customer's order.

Model: shipment

Properties

canceled (boolean): Indicates if the shipment is canceled.
carrier (string): ID of the shipping carrier, for example ups or fedex.
carrier_name (string): Full name of the shipping carrier.
date_estimated (date): Estimated delivery date of the shipment.
date_created (date): Date the shipment was created.
destination (shipment_address): Destination address for the shipment.
items (array<shipment_item>): Array of items included in the shipment.
number (string): Shipment tracking number.
origin (shipment_endpoint): Origin endpoint for the shipment.
service (string): ID of the service used for the shipment.
service_name (string): Full name of the shipping service.
tracking_code (string): Carrier tracking code for the shipment.

Returned by

order.shipments[]

shipment_address

Represents an address for a shipment destination, or return origin.

Model: shipment.destination

Properties

address1 (string): Primary street address for the shipment.
address2 (string): Secondary street address for the shipment, such as an apartment or suite number.
city (string): City of the shipment address.
country (string): Country of the shipment address.
name (string): Name associated with the shipment address.
phone (string): Phone number associated with the shipment address.
state (string): State or province of the shipment address.
zip (string): Postal or ZIP code of the shipment address.

Returned by

return.origin
shipment.destination

shipment_endpoint

Represents a location for products to be shipped from, or returned to.

Model: shipment.origin

Properties

location (string): ID of the shipment location.

Returned by

return.destination
shipment.origin

shipment_item

Represents an item to be shipped or returned.

Model: shipment.items

Properties

bundle_item_id (string): ID of the bundle item in the order, if applicable
id (string): Unique identifier for the shipment item.
options (cart_item_option): Options associated with the product in the shipment.
order_item_id (string): ID of the order item.
product_id (string): ID of the product.
product (product): Reference to the product associated with the shipment item.
quantity (number): Quantity of the shipment item.
variant_id (string): ID of the product variant, if applicable.
variant (product_variant): Reference to the variant associated with the shipment item.

Returned by

return.items[]
shipment.items[]

shipment_rating

Represents the shipping services calculated for the customer's shopping cart.

Model: cart.shipment_rating

Properties

date_created (date): Date the shipment rating was created.
errors (array<shipment_rating_error>): Array of errors that occurred while rating the shipment.
md5 (string): Unique identifier of parameters used to calculate the shipment rating.
services (array<shipment_rating_service>): Array of shipping services rated for the shipment.

Returned by

cart.shipment_rating
order.shipment_rating
subscription.shipment_rating

shipment_rating_error

Represents an error that that was returned by an external integration when calculating shipment rates.

Model: cart.shipment_rating.errors

Properties

code (string): Error code.
message (string): Error message.

Returned by

shipment_rating.errors[]

shipment_rating_service

Represents a shipment service calculation performed either using Swell shipping rules or by an external integration.

Model: cart.shipment_rating.services

Properties

carrier (string): Carrier name for the shipping service.
id (string): Unique identifier for the rated service.
name (string): Name of the shipping service.
pickup (boolean): Indicates if pickup is available.
price (number): Price of the shipping service.
tax_code (string): Tax code associated with the rating service, if applicable.

Returned by

shipment_rating.services[]

store

Represents the store and its configuration.

Shopify equivalent: shop

Properties

country (string): Country where the store is based.
currency (string): Default currency of the store.
currencies (array<store_currency>): Array of supported store currencies.
id (string): Store ID. The first part of the dashboard URL, for example [store.id].swell.store.
locale (string): Default locale of the store.
locales (array<store_locale>): Array of supported store locales.
name (string): Name of the store.
public_key (string): Public key for the frontend API.
support_email (string): Email address for store support.
support_phone (string): Phone number for store support.
url (string): URL of the store.

Returned by

Global

store_currency

Represents a configured store currency.

Shopify equivalent: currency

Properties

code (string): ISO currency code, for example USD.
name (string): Name of the currency, for example United States Dollar.
symbol (string): Currency symbol, for example $.

Returned by

store.currencies[]

store_locale

Represents a configured store locale.

Properties

code (string): ISO language code, for example en-US.
name (string): Name of the locale, for example English.

Returned by

store.locales[]

store_payment_settings

Represents payment settings including information about payment methods enabled on the store. The following properties represent standard payment methods, however this object may also contain properties of custom payments methods if configured.

Properties

affirm (store_payment_affirm_settings): Affirm payment settings, if configured
amazon (store_payment_amazon_settings): Amazon payment settings, if configured.
card: (store_payment_card_settings): Credit card payment settings, if configured.
paypal (store_payment_paypal_settings): PayPal payment settings, if configured.

Returned by

store.payments

store_payment_affirm_settings

Represents Affirm payment settings.

Properties

public_key (string): Public key to initiate an Affirm payment source.

Returned by

store_payment_settings.affirm

store_payment_amazon_settings

Represents Amazon payment settings.

Properties

merchant_id (string): ID of the Amazon merchant account.
public_key_id (string): ID of the public key to initiate an Amazon payment source.

Returned by

store_payment_settings.amazon

store_payment_card_settings

Represents credit card payment settings.

Properties

gateway (string): String ID of the credit card gateway, for example stripe or authorizenet.
merchant_id (string): ID of the credit card merchant account, if applicable.
publishable_key (string): A publishable key used for client-side payment authorization, if applicable. For example, Stripe's publishable key for live or test mode, depending on the gateway's status in Swell.

Returned by

store_payment_settings.card

store_payment_paypal_settings

Represents PayPal payment settings.

Properties

merchant_id (string): ID of the PayPal merchant account.
test_merchant_id (string): ID of the PayPal merchant's test account, if configured.
live_merchant_id (string): ID of the PayPal merchant's live account, if configured.
store_owner_email (string): Email of the PayPal merchant's account owner.

Returned by

store_payment_settings.paypal

store_subscription_settings

Represents subscription settings of the store.

Properties

features (store_subscription_setting_features): Subscription feature settings configured by the store.
pause_next_skip_threshold (boolean): Number of days before next shipment by which a customer must skip, if applicable.

Returned by

store.subscriptions

store_subscription_setting_features

Represents subscription settings that are enabled or disabled on a store.

Properties

auto_invoice_payment (boolean): Indicates that subscription invoices will be automatically charged.
auto_payment_retry (boolean): Indicates that subscription payments will be automatically re-tried if they fail.
auto_apply_credit (boolean): Indicates that account credits will be automatically applied as payments on subscription invoices if any exist on the account.
pause_during_trial (boolean): Indicates that customers are allowed to pause a subscription during the trial period.
pause_indefinitely (boolean): Indicates that customers are allowed to pause a subscription indefinitely.
pause_past_due (boolean): Indicates that customers are allowed to pause a subscription when its payment is past due.
pause_skip_next (boolean): Indicates that customers are allowed to skip the next subscription interval.

Returned by

store_subscription_settings.features

subscription

Represents a customer subscription.

Model: subscription

Properties

account_id (string): ID of the account that created the subscription.
billing (cart_billing): Customer billing information for the subscription.
billing_schedule (subscription_schedule): Billing schedule of the subscription.
cancel_at_end (boolean): Indicates if the subscription cancels at the end of the period.
canceled (boolean): Indicates if the subscription is canceled.
content (content_object): Content object associated with the subscription.
coupon (coupon): Coupon object applied to the subscription.
coupon_code (string): Coupon code applied to the subscription.
coupon_id (string): Unique identifier of the applied coupon.
currency (string): Currency used for the subscription.
date_canceled (date): Date the subscription was canceled.
date_created (date): Date the subscription was created.
date_order_period_end (date): Date the current order period ends for the subscription.
date_paused (date): Date the subscription was paused.
date_pause_end (date): Date the subscription pause ends.
date_payment_retry (date): Date of the next payment retry attempt.
date_period_end (date): Date the current billing period ends.
date_period_start (date): Date the current billing period starts.
date_trial_end (date): Date the trial period ends.
date_trial_start (date): Date the trial period starts.
date_updated (date): Date the subscription was last updated.
discounts (array<cart_discount>): Array of discount objects applied to the subscription.
discount_total (number): Total discount amount applied to the subscription.
grand_total (number): Grand total amount of the subscription.
id (string): Unique identifier for the subscription.
interval (string): Interval period for the subscription, for example monthly or yearly.
interval_count (number): Number of intervals between subscription renewals.
invoice_total (number): Total amount invoiced for the subscription.
items (array<cart_item>): Array of items in the subscription.
item_discount (number): Total discount amount for subscription items.
item_tax (number): Total tax amount for subscription items.
item_total (number): Total cost of items in the subscription.
metadata (metadata_object): Metadata object associated with the subscription.
number (string): Subscription number for reference.
options (array<cart_item_option>): Array of options applied to subscription items.
order_id (string): Unique identifier of the associated order.
order_schedule (subscription_schedule): Order schedule of the subscription.
paid (boolean): Indicates if the subscription is paid.
payments (collection<payment>): Collection of payment objects for the subscription.
payment_balance (number): Remaining balance to be paid for the subscription.
payment_total (number): Total payment amount received for the subscription.
price (number): Base price of the subscription.
price_total (number): Total price for the subscription based on quantity.
product_id (string): Unique identifier of the product associated with the subscription.
product (product): Product object associated with the subscription.
product_discounts (array<cart_discount>): Array of product-specific discount objects.
product_discount_each (number): Discount amount per product unit.
product_discount_total (number): Total product discount amount.
product_tax_each (number): Tax amount per product unit.
product_tax_total (number): Total tax amount for products.
quantity (number): Quantity of items in the subscription.
recurring_discount_total (number): Total recurring discount amount.
recurring_item_discount (number): Recurring discount amount per item.
recurring_item_tax (number): Recurring tax amount per item.
recurring_item_total (number): Total recurring cost of items.
recurring_tax_included_total (number): Total recurring amount including tax.
recurring_tax_total (number): Total recurring tax amount.
recurring_total (number): Total recurring amount for the subscription.
refunds (collection<refund>): Collection of refund objects for the subscription.
refund_total (number): Total amount of refunds for the subscription.
shipping (cart_shipping): Customer shipping information for the subscription.
status (string): Status of the subscription, for example active or paused.
sub_total (number): Subtotal amount of the subscription.
subscription_delivery (boolean): Indicates if the subscription includes delivery items.
taxes (array<cart_tax>): Array of tax objects applied to the subscription.
tax_included_total (number): Total amount including tax for the subscription.
tax_total (number): Total tax amount applied to the subscription.
trial (boolean): Indicates if the subscription is in a trial period.
trial_days (number): Number of days in the trial period.
unpaid (boolean): Indicates if the subscription has unpaid amounts.
variant_id (number): Unique identifier of the variant.
variant (product_variant): Variant object associated with the subscription.

Returned by

account.subscriptions[]

subscription_schedule

Represents the billing or order schedule of a subscription.

Model: subscription.billing_schedule

Properties

date_limit_end (date): Date the schedule will end based on its limit.
interval (string): Interval period for the schedule, daily, weekly, monthly, or yearly.
interval_count (number): Number of intervals between occurrences.
limit (number): Maximum number of occurrences for the schedule.
limit_current (number): Current number of iterations toward the limit.
trial_days (number): Number of trial days before the schedule starts iterating.

Returned by

subscription.billing_schedule
subscription.order_schedule

tablerowloop

Provides metadata about a tablerow loop, similar to forloop.

Shopify equivalent: tablerowloop

Properties

col (number): 1-based index of the current column.
col0 (number): 0-based index of the current column.
col_first (boolean): Indicates if the current column is the first one.
col_last (boolean): Indicates if the current column is the last one.
first (boolean): Indicates if the current iteration is the first one.
index (number): 1-based index of the current iteration.
index0 (number): 0-based index of the current iteration.
last (boolean): Indicates if the current iteration is the last one.
length (number): Total number of iterations.
parentloop (forloop): Parent tablerowloop object if nested.
rindex (number): 1-based index in reverse order.
rindex0 (number): 0-based index in reverse order.
row (number): 1-based index of the current row.

Returned by

tablerow tag

template

Provides information about the current template being rendered.

Shopify equivalent: template

Properties

alt_name (string): Alternate name of the template, if applicable.
name (string): Name of the template.
path (string): Path of the template within the theme.

Returned by

Global