Objects

`Product`

Represents a product

Properties

Name	Type	Description
_id	string
title	string
image	string
description	string
route	string
vendor	string
price	number
compareAtPrice	number
media	Media[]
options	Option[]
variants	Variant[]

`Variant`

Represents a product

Properties

Name	Type	Description
_id	string
name	string
values	string[]
price	number
compareAtPrice	number
media	Media[]
sku	string

`Media`

Represents a media

Properties

Name	Type	Description
url	string
type	string

`Option`

Represents a Product option

Properties

Name	Type	Description
_id	string
name	string
type	string	Possible values: `text`, `image` `color`, `product`
values	OptionValue[]

`OptionValue`

Represents a value item of Option

Properties

Name	Type	Description
_id	string
label	string
value	string

`ProductListItem`

Represents a product in a list context.

Properties

Name	Type	Description
_id	string
title	string
image	string
route	string
vendor	string
price	number
priceMax	number
compareAtPrice	number
compareAtPriceMax	number
media	Media[]
options	Option[]

`Collection`

Represents a collection

Properties

Name	Type	Description
_id	string
title	string
image	string
route	string
products	ProductListItem[]

`CollectionListItem`

Represents a collection in a list context

Properties

Name	Type	Description
_id	string
title	string
image	string
route	string

`PageSchema`

Name	Type	Description
layout	Layout	Describes the layout component for this page.
sections	Section[]	Array of section with their props and blocks

`Layout`

Name	Type	Description
component	string	The value is the exact file name of the corresponding layout component. It's a file in the `layouts` directory.

`Section`

Name	Type	Description
component	string	The value is the exact file name of the corresponding section component. It's a file in the `sections` directory.
props	key => value	An object containing prop names as keys and corresponding values for the component.
blocks	Block[]	Array of blocks for the component.

`Block`

Name	Type	Description
name	string	Name of the block as defined in the block schema.
props	key => value	An object containing prop names as keys and corresponding values for the block.

`SearchResult`

Name	Type	Description
products	ProductListItem[]
collections	CollectionListItem[]
pages	PageListItem[]
articles	ArticleListItem[]

`SearchFilter`

Name	Type	Description
name	string	Title of the filter
type	string	`product` \| `variant` \| `meta` \| `tag`
choices	SearchFilterChoice[]	Array of filter choices.

`SearchFilterChoice`

Name	Type	Description
name	string	Title of the choice
selected	boolean	If the filter is currently selected.

`Locale`

Name	Type	Description
currency	Currency
country	Country
language	Language

`Currency`

Name	Type	Description
code	string
name	string	Name of the currency
symbol	string	Currency symbol such as $
decimals	number	Number of digits after the decimal point
display	string	Display style. Possible values: `symbol`, `code`, `narrowSymbol`, `name` See details
grouping	string	Grouping style. Possible values: `always`, `auto`, `min2`, `true`, `false` See details

`Country`

Name	Type	Description
code	string	2-letter ISO 3166-1 country code
name	string	Name of the country

`Language`

Name	Type	Description
code	string	IETF Language code
name	string	Name of the language

`Menu`

Name	Type	Description
main	LinkItem[]	The main menu. Usually used in the header.
footer	LinkItem[]	The footer menu
[custom-menu-key]	LinkItem[]	Custom menu.

`LinkItem`

Name	Type	Description
title	string	Title of the link
url	string	Link URL
links	LinkItem[]	Child links

`OrderListItem`

Name	Type	Description
number	string	The order number/ID
grossAmount	number
discount	number
shippingCost	number
netAmount	number
paidAmount	number
status	string
paymentStatus	string
itemsCount	number
items	OrderProductItem[]

`Order`

Name	Type	Description
number	string	The order number/ID
grossAmount	number
discount	number
shippingCost	number
netAmount	number
paidAmount	number
status	string
paymentStatus	string
itemsCount	number
items	OrderProductItem[]
shippingAddress	Address
billingAddress	Address?
billingSameAsShippingAddress	boolean
shippingMethod	ShippingMethod
paymentMethod	PaymentMethod
updates	OrderUpdate[]

`OrderProductItem`

Name	Type	Description
product	Product	Only `_id`, `title`, `image` and `route` properties are available
variant	Variant	Only `_id`, `name`, `price` and `compareAtPrice` properties are available
quantity	number

`Address`

Name	Type	Description
firstName	string
lastName	string
addressLine1	string
addressLine2	string
state	string?
city	string
postalCode	string
country	string

`OrderUpdate`

Name	Type	Description
time	Date
type	string	Possible values: `status`, `paymentStatus`, `custom`
value	string

`CartItem`

Name	Type	Description
product	Product	Only `_id`, `title`, `image` and `route` properties are available
variant	Variant	Only `_id`, `name`, `price` and `compareAtPrice` properties are available
quantity	number

theme.config.js useApp