Docs
Reference
Objects

Objects

Product

Represents a product

Properties

NameTypeDescription
_idstring
titlestring
imagestring
descriptionstring
routestring
vendorstring
pricenumber
compareAtPricenumber
mediaMedia[]
optionsOption[]
variantsVariant[]

Variant

Represents a product

Properties

NameTypeDescription
_idstring
namestring
valuesstring[]
pricenumber
compareAtPricenumber
mediaMedia[]
skustring

Media

Represents a media

Properties

NameTypeDescription
urlstring
typestring

Option

Represents a Product option

Properties

NameTypeDescription
_idstring
namestring
typestringPossible values: text, image color, product
valuesOptionValue[]

OptionValue

Represents a value item of Option

Properties

NameTypeDescription
_idstring
labelstring
valuestring

ProductListItem

Represents a product in a list context.

Properties

NameTypeDescription
_idstring
titlestring
imagestring
routestring
vendorstring
pricenumber
priceMaxnumber
compareAtPricenumber
compareAtPriceMaxnumber
mediaMedia[]
optionsOption[]

Collection

Represents a collection

Properties

NameTypeDescription
_idstring
titlestring
imagestring
routestring
productsProductListItem[]

CollectionListItem

Represents a collection in a list context

Properties

NameTypeDescription
_idstring
titlestring
imagestring
routestring

PageSchema

NameTypeDescription
layoutLayoutDescribes the layout component for this page.
sectionsSection[]Array of section with their props and blocks

Layout

NameTypeDescription
componentstringThe value is the exact file name of the corresponding layout component. It's a file in the `layouts` directory.

Section

NameTypeDescription
componentstringThe value is the exact file name of the corresponding section component. It's a file in the `sections` directory.
propskey => valueAn object containing prop names as keys and corresponding values for the component.
blocksBlock[]Array of blocks for the component.

Block

NameTypeDescription
namestringName of the block as defined in the block schema.
propskey => valueAn object containing prop names as keys and corresponding values for the block.

SearchResult

NameTypeDescription
productsProductListItem[]
collectionsCollectionListItem[]
pagesPageListItem[]
articlesArticleListItem[]

SearchFilter

NameTypeDescription
namestringTitle of the filter
typestringproduct | variant | meta | tag
choicesSearchFilterChoice[]Array of filter choices.

SearchFilterChoice

NameTypeDescription
namestringTitle of the choice
selectedbooleanIf the filter is currently selected.

Locale

NameTypeDescription
currencyCurrency
countryCountry
languageLanguage

Currency

NameTypeDescription
codestring
namestringName of the currency
symbolstringCurrency symbol such as $
decimalsnumberNumber of digits after the decimal point
displaystringDisplay style. Possible values: symbol, code, narrowSymbol, name See details
groupingstringGrouping style. Possible values: always, auto, min2, true, false See details

Country

NameTypeDescription
codestring2-letter ISO 3166-1 country code
namestringName of the country

Language

NameTypeDescription
codestringIETF Language code
namestringName of the language

Menu

NameTypeDescription
mainLinkItem[]The main menu. Usually used in the header.
footerLinkItem[]The footer menu
[custom-menu-key]LinkItem[]Custom menu.

LinkItem

NameTypeDescription
titlestringTitle of the link
urlstringLink URL
linksLinkItem[]Child links

OrderListItem

NameTypeDescription
numberstringThe order number/ID
grossAmountnumber
discountnumber
shippingCostnumber
netAmountnumber
paidAmountnumber
statusstring
paymentStatusstring
itemsCountnumber
itemsOrderProductItem[]

Order

NameTypeDescription
numberstringThe order number/ID
grossAmountnumber
discountnumber
shippingCostnumber
netAmountnumber
paidAmountnumber
statusstring
paymentStatusstring
itemsCountnumber
itemsOrderProductItem[]
shippingAddressAddress
billingAddressAddress?
billingSameAsShippingAddressboolean
shippingMethodShippingMethod
paymentMethodPaymentMethod
updatesOrderUpdate[]

OrderProductItem

NameTypeDescription
productProductOnly _id, title, image and route properties are available
variantVariantOnly _id, name, price and compareAtPrice properties are available
quantitynumber

Address

NameTypeDescription
firstNamestring
lastNamestring
addressLine1string
addressLine2string
statestring?
citystring
postalCodestring
countrystring

OrderUpdate

NameTypeDescription
timeDate
typestringPossible values: status, paymentStatus, custom
valuestring

CartItem

NameTypeDescription
productProductOnly _id, title, image and route properties are available
variantVariantOnly _id, name, price and compareAtPrice properties are available
quantitynumber