Storefront GraphQL API Reference

Queries

`customer`

The currently logged in customer

Returns a Customer

Example

Query

query customer {
  customer {
    entityId
    company
    customerGroupId
    email
    firstName
    lastName
    notes
    phone
    taxExemptCategory
    addressCount
    attributeCount
    storeCredit {
      ...MoneyFragment
    }
    attributes {
      ...CustomerAttributesFragment
    }
  }
}

Response

{
  "data": {
    "customer": {
      "entityId": 123,
      "company": "xyz789",
      "customerGroupId": 987,
      "email": "xyz789",
      "firstName": "xyz789",
      "lastName": "xyz789",
      "notes": "abc123",
      "phone": "xyz789",
      "taxExemptCategory": "abc123",
      "addressCount": 123,
      "attributeCount": 987,
      "storeCredit": [Money],
      "attributes": CustomerAttributes
    }
  }
}

Queries

`inventory`

Alpha version. Do not use in production.

Returns an Inventory!

Example

Query

query inventory {
  inventory {
    locations(entityIds: $entityIds, codes: $codes, typeIds: $typeIds, serviceTypeIds: $serviceTypeIds, distanceFilter: $distanceFilter, countryCodes: $countryCodes, states: $states, cities: $cities, before: $before, after: $after, first: $first, last: $last) {
      ...LocationConnectionFragment
    }
  }
}

Response

{"data": {"inventory": {"locations": LocationConnection}}}

Queries

`site`

Returns a Site!

Example

Query

query site {
  site {
    search {
      ...SearchQueriesFragment
    }
    categoryTree(rootEntityId: $rootEntityId) {
      ...CategoryTreeItemFragment
    }
    brands(before: $before, after: $after, first: $first, last: $last, productEntityIds: $productEntityIds) {
      ...BrandConnectionFragment
    }
    products(before: $before, after: $after, first: $first, last: $last, ids: $ids, entityIds: $entityIds, hideOutOfStock: $hideOutOfStock) {
      ...ProductConnectionFragment
    }
    newestProducts(before: $before, after: $after, first: $first, last: $last, hideOutOfStock: $hideOutOfStock) {
      ...ProductConnectionFragment
    }
    bestSellingProducts(before: $before, after: $after, first: $first, last: $last, hideOutOfStock: $hideOutOfStock) {
      ...ProductConnectionFragment
    }
    featuredProducts(before: $before, after: $after, first: $first, last: $last, hideOutOfStock: $hideOutOfStock) {
      ...ProductConnectionFragment
    }
    product(id: $id, entityId: $entityId, variantEntityId: $variantEntityId, optionValueIds: $optionValueIds, sku: $sku) {
      ...ProductFragment
    }
    route(path: $path) {
      ...RouteFragment
    }
    settings {
      ...SettingsFragment
    }
    content {
      ...ContentFragment
    }
    currency(currencyCode: $currencyCode) {
      ...CurrencyFragment
    }
    currencies(before: $before, after: $after, first: $first, last: $last) {
      ...CurrencyConnectionFragment
    }
  }
}

Response

{
  "data": {
    "site": {
      "search": SearchQueries,
      "categoryTree": [CategoryTreeItem],
      "brands": BrandConnection,
      "products": ProductConnection,
      "newestProducts": ProductConnection,
      "bestSellingProducts": ProductConnection,
      "featuredProducts": ProductConnection,
      "product": Product,
      "route": Route,
      "settings": Settings,
      "content": Content,
      "currency": Currency,
      "currencies": CurrencyConnection
    }
  }
}

Mutations

`login`

Returns a LoginResult!

Name	Description
`email` - `String!`
`password` - `String!`

Example

Query

mutation login($email: String!, $password: String!) {
  login(email: $email, password: $password) {
    result
    customer {
      ...CustomerFragment
    }
  }
}

Variables

{"email": "abc123", "password": "abc123"}

Response

{
  "data": {
    "login": {"result": "abc123", "customer": Customer}
  }
}

Mutations

`logout`

Returns a LogoutResult!

Example

Query

mutation logout {
  logout {
    result
  }
}

Response

{"data": {"logout": {"result": "xyz789"}}}

Types

`Aggregated`

Aggregated

Field Name	Description
`availableToSell` - `Long!`	Number of available products in stock. This can be 'null' if inventory is not set orif the store's Inventory Settings disable displaying stock levels on the storefront.
`warningLevel` - `Int!`	Indicates a threshold low-stock level. This can be 'null' if the inventory warning level is not set or if the store's Inventory Settings disable displaying stock levels on the storefront.

Example

{"availableToSell": Long, "warningLevel": 123}

Types

`AggregatedInventory`

Aggregated Product Inventory

Field Name	Description
`availableToSell` - `Int!`	Number of available products in stock. This can be 'null' if inventory is not set orif the store's Inventory Settings disable displaying stock levels on the storefront.
`warningLevel` - `Int!`	Indicates a threshold low-stock level. This can be 'null' if the inventory warning level is not set or if the store's Inventory Settings disable displaying stock levels on the storefront.

Example

{"availableToSell": 123, "warningLevel": 987}

Types

`Author`

Author

Field Name	Description
`name` - `String!`	Author name.

Example

{"name": "abc123"}

Types

`BigDecimal`

The BigDecimal scalar type represents signed fractional values with arbitrary precision.

Example

object

Types

`Boolean`

The Boolean scalar type represents true or false.

Example

true

Types

`Brand`

Brand

Field Name	Description
`id` - `ID!`	The ID of an object
`entityId` - `Int!`	Id of the brand.
`name` - `String!`	Name of the brand.
`defaultImage` - `Image`	Default image for brand.
`pageTitle` - `String!`	Page title for the brand. Use SEO details instead.
`metaDesc` - `String!`	Meta description for the brand. Use SEO details instead.
`metaKeywords` - `[String!]!`	Meta keywords for the brand. Use SEO details instead.
`seo` - `SeoDetails!`	Brand SEO details.
`searchKeywords` - `[String!]!`	Search keywords for the brand.
`path` - `String!`	Path for the brand page.
`products` - `ProductConnection!`
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int` `hideOutOfStock` - `Boolean`
`metafields` - `MetafieldConnection!`	Metafield data related to a brand.
Arguments `namespace` - `String!` `keys` - `[String!]` default = `[]` `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{
  "id": ID,
  "entityId": 123,
  "name": "xyz789",
  "defaultImage": Image,
  "pageTitle": "xyz789",
  "metaDesc": "xyz789",
  "metaKeywords": ["abc123"],
  "seo": SeoDetails,
  "searchKeywords": ["abc123"],
  "path": "abc123",
  "products": ProductConnection,
  "metafields": MetafieldConnection
}

Types

`BrandConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[BrandEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [BrandEdge]
}

Types

`BrandEdge`

An edge in a connection.

Field Name	Description
`node` - `Brand!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": Brand, "cursor": "abc123"}

Types

`Breadcrumb`

Breadcrumb

Field Name	Description
`entityId` - `Int!`	Category id.
`name` - `String!`	Name of the category.

Example

{"entityId": 123, "name": "abc123"}

Types

`BreadcrumbConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[BreadcrumbEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [BreadcrumbEdge]
}

Types

`BreadcrumbEdge`

An edge in a connection.

Field Name	Description
`node` - `Breadcrumb!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": Breadcrumb, "cursor": "abc123"}

Types

`BulkPricingFixedPriceDiscount`

Bulk pricing tier that sets a fixed price for the product or variant.

Field Name	Description
`price` - `BigDecimal!`	This price will override the current product price.
`minimumQuantity` - `Int!`	Minimum item quantity that applies to this bulk pricing tier.
`maximumQuantity` - `Int`	Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound.

Example

{
  "price": BigDecimal,
  "minimumQuantity": 123,
  "maximumQuantity": 123
}

Types

`BulkPricingPercentageDiscount`

Bulk pricing tier that reduces the price of the product or variant by a percentage.

Field Name	Description
`percentOff` - `BigDecimal!`	The percentage that will be removed from the product price.
`minimumQuantity` - `Int!`	Minimum item quantity that applies to this bulk pricing tier.
`maximumQuantity` - `Int`	Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound.

Example

{
  "percentOff": BigDecimal,
  "minimumQuantity": 987,
  "maximumQuantity": 123
}

Types

`BulkPricingRelativePriceDiscount`

Bulk pricing tier that will subtract an amount from the price of the product or variant.

Field Name	Description
`priceAdjustment` - `BigDecimal!`	The price of the product/variant will be reduced by this priceAdjustment.
`minimumQuantity` - `Int!`	Minimum item quantity that applies to this bulk pricing tier.
`maximumQuantity` - `Int`	Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound.

Example

{
  "priceAdjustment": BigDecimal,
  "minimumQuantity": 987,
  "maximumQuantity": 123
}

Types

`Category`

Example

{
  "id": ID,
  "entityId": 123,
  "name": "abc123",
  "path": "abc123",
  "defaultImage": Image,
  "description": "xyz789",
  "breadcrumbs": BreadcrumbConnection,
  "products": ProductConnection,
  "metafields": MetafieldConnection,
  "seo": SeoDetails
}

Types

`CategoryConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[CategoryEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [CategoryEdge]
}

Types

`CategoryEdge`

An edge in a connection.

Field Name	Description
`node` - `Category!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": Category, "cursor": "xyz789"}

Types

`CategoryProductSort`

Product sorting by categories.

Enum Value	Description
`DEFAULT`
`FEATURED`
`NEWEST`
`BEST_SELLING`
`A_TO_Z`
`Z_TO_A`
`BEST_REVIEWED`
`LOWEST_PRICE`
`HIGHEST_PRICE`

Types

`CategoryTreeItem`

An item in a tree of categories.

Field Name	Description
`entityId` - `Int!`	The id category.
`name` - `String!`	The name of category.
`path` - `String!`	Path assigned to this category
`description` - `String!`	The description of this category.
`productCount` - `Int!`	The number of products in this category.
`image` - `Image`	The category image.
`children` - `[CategoryTreeItem!]!`	Subcategories of this category

Example

{
  "entityId": 987,
  "name": "xyz789",
  "path": "abc123",
  "description": "abc123",
  "productCount": 123,
  "image": Image,
  "children": [CategoryTreeItem]
}

Types

`CheckboxOption`

A simple yes/no question represented by a checkbox.

Field Name	Description
`checkedByDefault` - `Boolean!`	Indicates the default checked status.
`entityId` - `Int!`	Unique ID for the option.
`displayName` - `String!`	Display name for the option.
`isRequired` - `Boolean!`	One of the option values is required to be selected for the checkout.

Example

{
  "checkedByDefault": true,
  "entityId": 987,
  "displayName": "abc123",
  "isRequired": true
}

Types

`ContactField`

Contact field

Field Name	Description
`address` - `String!`	Store address line.
`country` - `String!`	Store country.
`addressType` - `String!`	Store address type.
`email` - `String!`	Store email.
`phone` - `String!`	Store phone number.

Example

{
  "address": "abc123",
  "country": "abc123",
  "addressType": "abc123",
  "email": "xyz789",
  "phone": "abc123"
}

Types

`Content`

The page content.

Field Name	Description
`renderedRegionsByPageType` - `RenderedRegionsByPageType!`
Arguments `pageType` - `PageType!`
`renderedRegionsByPageTypeAndEntityId` - `RenderedRegionsByPageType!`
Arguments `entityId` - `Long!` `entityPageType` - `EntityPageType!`

Example

{
  "renderedRegionsByPageType": RenderedRegionsByPageType,
  "renderedRegionsByPageTypeAndEntityId": RenderedRegionsByPageType
}

Types

`Currency`

Field Name	Description
`entityId` - `Int!`	Currency ID.
`code` - `currencyCode!`	Currency code.
`name` - `String!`	Currency name.
`flagImage` - `String`	Flag image URL.
`isActive` - `Boolean!`	Indicates whether this currency is active.
`exchangeRate` - `Float!`	Exchange rate relative to default currency.
`isTransactional` - `Boolean!`	Indicates whether this currency is transactional.
`display` - `CurrencyDisplay!`	Currency display settings.

Example

{
  "entityId": 123,
  "code": currencyCode,
  "name": "abc123",
  "flagImage": "xyz789",
  "isActive": false,
  "exchangeRate": 123.45,
  "isTransactional": true,
  "display": CurrencyDisplay
}

Types

`CurrencyConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[CurrencyEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [CurrencyEdge]
}

Types

`CurrencyDisplay`

Field Name	Description
`symbol` - `String!`	Currency symbol.
`symbolPlacement` - `CurrencySymbolPosition!`	Currency symbol.
`decimalToken` - `String!`	Currency decimal token.
`thousandsToken` - `String!`	Currency thousands token.
`decimalPlaces` - `Int!`	Currency decimal places.

Example

{
  "symbol": "abc123",
  "symbolPlacement": CurrencySymbolPosition,
  "decimalToken": "abc123",
  "thousandsToken": "xyz789",
  "decimalPlaces": 987
}

Types

`CurrencyEdge`

An edge in a connection.

Field Name	Description
`node` - `Currency!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": Currency, "cursor": "abc123"}

Types

`CurrencySymbolPosition`

Currency symbol position

Enum Value	Description
`LEFT`
`RIGHT`

Types

`CustomField`

Custom field

Field Name	Description
`entityId` - `Int!`	Custom field id.
`name` - `String!`	Name of the custom field.
`value` - `String!`	Value of the custom field.

Example

{"entityId": 123, "name": "xyz789", "value": "abc123"}

Types

`CustomFieldConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[CustomFieldEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [CustomFieldEdge]
}

Types

`CustomFieldEdge`

An edge in a connection.

Field Name	Description
`node` - `CustomField!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": CustomField, "cursor": "xyz789"}

Types

`Customer`

A customer that shops on a store

Field Name	Description
`entityId` - `Int!`	The ID of the customer.
`company` - `String!`	The company name of the customer.
`customerGroupId` - `Int!`	The customer group id of the customer.
`email` - `String!`	The email address of the customer.
`firstName` - `String!`	The first name of the customer.
`lastName` - `String!`	The last name of the customer.
`notes` - `String!`	The notes of the customer.
`phone` - `String!`	The phone number of the customer.
`taxExemptCategory` - `String!`	The tax exempt category of the customer.
`addressCount` - `Int!`	Customer addresses count.
`attributeCount` - `Int!`	Customer attributes count.
`storeCredit` - `[Money!]!`	Customer store credit.
`attributes` - `CustomerAttributes!`	Customer attributes.

Example

{
  "entityId": 123,
  "company": "abc123",
  "customerGroupId": 987,
  "email": "xyz789",
  "firstName": "abc123",
  "lastName": "abc123",
  "notes": "abc123",
  "phone": "abc123",
  "taxExemptCategory": "abc123",
  "addressCount": 123,
  "attributeCount": 123,
  "storeCredit": [Money],
  "attributes": CustomerAttributes
}

Types

`CustomerAttribute`

A custom, store-specific attribute for a customer

Field Name	Description
`entityId` - `Int!`	The ID of the custom customer attribute
`value` - `String`	The value of the custom customer attribute
`name` - `String!`	The name of the custom customer attribute

Example

{"entityId": 987, "value": "xyz789", "name": "xyz789"}

Types

`CustomerAttributes`

Custom, store-specific customer attributes

Field Name	Description
`attribute` - `CustomerAttribute!`
Arguments `entityId` - `Int!` The ID of the customer attribute

Example

{"attribute": CustomerAttribute}

Types

`DateFieldOption`

A calendar for allowing selection of a date.

Field Name	Description
`entityId` - `Int!`	Unique ID for the option.
`displayName` - `String!`	Display name for the option.
`isRequired` - `Boolean!`	One of the option values is required to be selected for the checkout.

Example

{"entityId": 123, "displayName": "xyz789", "isRequired": true}

Types

`DateTime`

Example

object

Types

`DateTimeExtended`

Date Time Extended

Field Name	Description
`utc` - `DateTime!`	ISO-8601 formatted date in UTC

Example

{"utc": DateTime}

Types

`DisplayField`

Display field

Field Name	Description
`shortDateFormat` - `String!`	Short date format.
`extendedDateFormat` - `String!`	Extended date format.

Example

{"shortDateFormat": "abc123", "extendedDateFormat": "abc123"}

Types

`Distance`

Distance

Field Name	Description
`value` - `Float!`	Distance in specified length unit
`lengthUnit` - `LengthUnit!`	Length unit

Example

{"value": 123.45, "lengthUnit": LengthUnit}

Types

`DistanceFilter`

Filter locations by the distance

Input Field	Description
`radius` - `Float!`	Radius of search in length units specified in lengthUnit argument
`longitude` - `Float!`	Signed decimal degrees without compass direction
`latitude` - `Float!`	Signed decimal degrees without compass direction
`lengthUnit` - `LengthUnit!`

Example

{
  "radius": 123.45,
  "longitude": 987.65,
  "latitude": 987.65,
  "lengthUnit": LengthUnit
}

Types

`EntityPageType`

Entity page type

Enum Value	Description
`BLOG_POST`
`BRAND`
`CATEGORY`
`CONTACT_US`
`PAGE`
`PRODUCT`

Types

`FileUploadFieldOption`

A form allowing selection and uploading of a file from the user's local computer.

Field Name	Description
`entityId` - `Int!`	Unique ID for the option.
`displayName` - `String!`	Display name for the option.
`isRequired` - `Boolean!`	One of the option values is required to be selected for the checkout.

Example

{"entityId": 123, "displayName": "xyz789", "isRequired": false}

Types

`Float`

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

987.65

Types

`ID`

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

object

Types

`Image`

Image

Field Name	Description
`url` - `String!`	Absolute path to image using store CDN.
Arguments `width` - `Int!` `height` - `Int`
`urlOriginal` - `String!`	Absolute path to original image using store CDN.
`altText` - `String!`	Text description of an image that can be used for SEO and/or accessibility purposes.
`isDefault` - `Boolean!`	Indicates whether this is the primary image.

Example

{
  "url": "xyz789",
  "urlOriginal": "xyz789",
  "altText": "xyz789",
  "isDefault": true
}

Types

`ImageConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[ImageEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [ImageEdge]
}

Types

`ImageEdge`

An edge in a connection.

Field Name	Description
`node` - `Image!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": Image, "cursor": "xyz789"}

Types

`Int`

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

Types

`Inventory`

An inventory

Field Name Description

locations - LocationConnection! Locations

Field Name	Description
`locations` - `LocationConnection!`	Locations
Arguments `entityIds` - `[Int!]` default = `[]` `codes` - `[String!]` default = `[]` `typeIds` - `[String!]` default = `[]` `serviceTypeIds` - `[String!]` default = `[]` `distanceFilter` - `DistanceFilter` `countryCodes` - `[countryCode!]` default = `[]` `states` - `[String!]` default = `[]` `cities` - `[String!]` default = `[]` `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Arguments

entityIds - [Int!] default = []

codes - [String!] default = []

typeIds - [String!] default = []

serviceTypeIds - [String!] default = []

distanceFilter - DistanceFilter

countryCodes - [countryCode!] default = []

states - [String!] default = []

cities - [String!] default = []

before - String

after - String

first - Int

last - Int

Example

{"locations": LocationConnection}

Types

`InventoryByLocations`

Inventory By Locations

Field Name	Description
`locationEntityId` - `Long!`	Location id.
`availableToSell` - `Long!`	Number of available products in stock.
`warningLevel` - `Int!`	Indicates a threshold low-stock level.
`isInStock` - `Boolean!`	Indicates whether this product is in stock.
`locationDistance` - `Distance`	Distance between location and specified longitude and latitude
`locationEntityTypeId` - `String`	Location type id.
`locationEntityServiceTypeIds` - `[String!]!`	Location service type ids. Deprecated. Will be substituted with pickup methods.
`locationEntityCode` - `String!`	Location code.

Example

{
  "locationEntityId": Long,
  "availableToSell": Long,
  "warningLevel": 123,
  "isInStock": false,
  "locationDistance": Distance,
  "locationEntityTypeId": "abc123",
  "locationEntityServiceTypeIds": ["abc123"],
  "locationEntityCode": "abc123"
}

Types

`LengthUnit`

length unit

Enum Value	Description
`Miles`
`Kilometres`

Types

`LocationConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[LocationEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [LocationEdge]
}

Types

`LocationEdge`

An edge in a connection.

Field Name	Description
`node` - `InventoryByLocations!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": InventoryByLocations, "cursor": "abc123"}

Types

`LoginResult`

Field Name	Description
`result` - `String!`	The result of a login Use customer node instead.
`customer` - `Customer`	The currently logged in customer.

Example

{"result": "abc123", "customer": Customer}

Types

`LogoField`

Logo field

Field Name	Description
`title` - `String!`	Logo title.
`image` - `Image!`	Store logo image.

Example

{"title": "xyz789", "image": Image}

Types

`LogoutResult`

Logout result

Field Name	Description
`result` - `String!`	The result of a logout

Example

{"result": "abc123"}

Types

`Long`

The Long scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1.

Example

object

Types

`Measurement`

Measurement

Field Name	Description
`value` - `Float!`	Unformatted weight measurement value.
`unit` - `String!`	Unit of measurement.

Example

{"value": 987.65, "unit": "abc123"}

Types

`MetafieldConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[MetafieldEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [MetafieldEdge]
}

Types

`MetafieldEdge`

An edge in a connection.

Field Name	Description
`node` - `Metafields!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": Metafields, "cursor": "abc123"}

Types

`Metafields`

Key/Value pairs of data attached tied to a resource entity (product, brand, category, etc.)

Field Name	Description
`id` - `ID!`	The ID of an object
`entityId` - `Int!`	The ID of the metafield when referencing via our backend API.
`key` - `String!`	A label for identifying a metafield data value.
`value` - `String!`	A metafield value.

Example

{
  "id": ID,
  "entityId": 987,
  "key": "abc123",
  "value": "abc123"
}

Types

`Money`

A money object - includes currency code and a money amount

Field Name	Description
`currencyCode` - `String!`	Currency code of the current money.
`value` - `BigDecimal!`	The amount of money.

Example

{"currencyCode": "abc123", "value": BigDecimal}

Types

`MoneyRange`

A min and max pair of money objects

Field Name	Description
`min` - `Money!`	Minimum money object.
`max` - `Money!`	Maximum money object.

Example

{"min": Money, "max": Money}

Types

`MultiLineTextFieldOption`

A multi-line text input field, aka a text box.

Field Name	Description
`entityId` - `Int!`	Unique ID for the option.
`displayName` - `String!`	Display name for the option.
`isRequired` - `Boolean!`	One of the option values is required to be selected for the checkout.

Example

{"entityId": 123, "displayName": "abc123", "isRequired": false}

Types

`MultipleChoiceOption`

An option type that has a fixed list of values.

Field Name	Description
`displayStyle` - `String!`	The chosen display style for this multiple choice option.
`values` - `ProductOptionValueConnection!`	List of option values.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`entityId` - `Int!`	Unique ID for the option.
`displayName` - `String!`	Display name for the option.
`isRequired` - `Boolean!`	One of the option values is required to be selected for the checkout.

Example

{
  "displayStyle": "xyz789",
  "values": ProductOptionValueConnection,
  "entityId": 987,
  "displayName": "xyz789",
  "isRequired": false
}

Types

`MultipleChoiceOptionValue`

A simple multiple choice value comprised of an id and a label.

Field Name	Description
`entityId` - `Int!`	Unique ID for the option value.
`label` - `String!`	Label for the option value.
`isDefault` - `Boolean!`	Indicates whether this value is the chosen default selected value.

Example

{"entityId": 123, "label": "abc123", "isDefault": false}

Types

`NumberFieldOption`

A single line text input field that only accepts numbers.

Field Name	Description
`entityId` - `Int!`	Unique ID for the option.
`displayName` - `String!`	Display name for the option.
`isRequired` - `Boolean!`	One of the option values is required to be selected for the checkout.

Example

{"entityId": 123, "displayName": "xyz789", "isRequired": true}

Types

`OptionConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[OptionEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [OptionEdge]
}

Types

`OptionEdge`

An edge in a connection.

Field Name	Description
`node` - `ProductOption!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": ProductOption, "cursor": "xyz789"}

Types

`OptionValueConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[OptionValueEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [OptionValueEdge]
}

Types

`OptionValueEdge`

An edge in a connection.

Field Name	Description
`node` - `ProductOptionValue!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": ProductOptionValue, "cursor": "abc123"}

Types

`OptionValueId`

Input Field	Description
`optionEntityId` - `Int!`
`valueEntityId` - `Int!`

Example

{"optionEntityId": 987, "valueEntityId": 987}

Types

`PageInfo`

Information about pagination in a connection.

Field Name	Description
`hasNextPage` - `Boolean!`	When paginating forwards, are there more items?
`hasPreviousPage` - `Boolean!`	When paginating backwards, are there more items?
`startCursor` - `String`	When paginating backwards, the cursor to continue.
`endCursor` - `String`	When paginating forwards, the cursor to continue.

Example

{
  "hasNextPage": true,
  "hasPreviousPage": false,
  "startCursor": "abc123",
  "endCursor": "xyz789"
}

Types

`PageType`

Page type

Enum Value	Description
`ACCOUNT_ADDRESS`
`ACCOUNT_ADD_ADDRESS`
`ACCOUNT_ADD_RETURN`
`ACCOUNT_ADD_WISHLIST`
`ACCOUNT_DOWNLOAD_ITEM`
`ACCOUNT_EDIT`
`ACCOUNT_INBOX`
`ACCOUNT_ORDERS_ALL`
`ACCOUNT_ORDERS_COMPLETED`
`ACCOUNT_ORDERS_DETAILS`
`ACCOUNT_ORDERS_INVOICE`
`ACCOUNT_RECENT_ITEMS`
`ACCOUNT_RETURNS`
`ACCOUNT_RETURN_SAVED`
`ACCOUNT_WISHLISTS`
`ACCOUNT_WISHLIST_DETAILS`
`AUTH_ACCOUNT_CREATED`
`AUTH_CREATE_ACC`
`AUTH_FORGOT_PASS`
`AUTH_LOGIN`
`AUTH_NEW_PASS`
`BLOG`
`BRANDS`
`CART`
`COMPARE`
`GIFT_CERT_BALANCE`
`GIFT_CERT_PURCHASE`
`GIFT_CERT_REDEEM`
`HOME`
`ORDER_INFO`
`SEARCH`
`SITEMAP`
`SUBSCRIBED`
`UNSUBSCRIBE`

Types

`PriceRanges`

The min and max range of prices that apply to this product.

Field Name	Description
`priceRange` - `MoneyRange!`	Product price min/max range.
`retailPriceRange` - `MoneyRange`	Product retail price min/max range.

Example

{
  "priceRange": MoneyRange,
  "retailPriceRange": MoneyRange
}

Types

`PriceSearchFilterInput`

Input Field	Description
`minPrice` - `Float`
`maxPrice` - `Float`

Example

{"minPrice": 987.65, "maxPrice": 987.65}

Types

`Prices`

The various prices that can be set on a product.

Field Name	Description
`price` - `Money!`	Calculated price of the product. Calculated price takes into account basePrice, salePrice, rules (modifier, option, option set) that apply to the product configuration, and customer group discounts. It represents the in-cart price for a product configuration without bulk pricing rules.
`salePrice` - `Money`	Sale price of the product.
`basePrice` - `Money`	Original price of the product.
`retailPrice` - `Money`	Retail price of the product.
`mapPrice` - `Money`	Minimum advertised price of the product.
`priceRange` - `MoneyRange!`	Product price min/max range.
`retailPriceRange` - `MoneyRange`	Product retail price min/max range.
`saved` - `Money`	The difference between the retail price (MSRP) and the current price, which can be presented to the shopper as their savings.

Example

{
  "price": Money,
  "salePrice": Money,
  "basePrice": Money,
  "retailPrice": Money,
  "mapPrice": Money,
  "priceRange": MoneyRange,
  "retailPriceRange": MoneyRange,
  "saved": Money
}

Types

`Product`

Product

Field Name	Description
`id` - `ID!`	The ID of an object
`entityId` - `Int!`	Id of the product.
`sku` - `String!`	Default product variant when no options are selected.
`path` - `String!`	Relative URL path to product page.
`name` - `String!`	Name of the product.
`description` - `String!`	Description of the product.
`plainTextDescription` - `String!`	Description of the product in plain text.
Arguments `characterLimit` - `Int` default = `120`
`warranty` - `String!`	Warranty information of the product.
`minPurchaseQuantity` - `Int`	Minimum purchasable quantity for this product in a single order.
`maxPurchaseQuantity` - `Int`	Maximum purchasable quantity for this product in a single order.
`addToCartUrl` - `String!`	Absolute URL path for adding a product to cart.
`addToWishlistUrl` - `String!`	Absolute URL path for adding a product to customer's wishlist. Deprecated.
`prices` - `Prices`	Prices object determined by supplied product ID, variant ID, and selected option IDs.
Arguments `includeTax` - `Boolean` default = `false` `currencyCode` - `currencyCode` Please select a currency
`priceRanges` - `PriceRanges`	The minimum and maximum price of this product based on variant pricing and/or modifier price rules. Use priceRanges inside prices node instead.
Arguments `includeTax` - `Boolean` default = `false`
`weight` - `Measurement`	Weight of the product.
`height` - `Measurement`	Height of the product.
`width` - `Measurement`	Width of the product.
`depth` - `Measurement`	Depth of the product.
`options` - `OptionConnection!`	Product options.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`productOptions` - `ProductOptionConnection!`	Product options.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`reviewSummary` - `Reviews!`	Summary of the product reviews, includes the total number of reviews submitted and summation of the ratings on the reviews (ratings range from 0-5 per review).
`type` - `String!`	Type of product, ex: physical, digital
`availability` - `String!`	The availability state of the product. Use status inside availabilityV2 instead.
`availabilityDescription` - `String!`	A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. Use description inside availabilityV2 instead.
`categories` - `CategoryConnection!`	List of categories associated with the product.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`brand` - `Brand`	Brand associated with the product.
`variants` - `VariantConnection!`	Variants associated with the product.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int` `entityIds` - `[Int!]` default = `[]` `optionValueIds` - `[OptionValueId!]` default = `[]`
`customFields` - `CustomFieldConnection!`	Custom fields of the product.
Arguments `names` - `[String!]` default = `[]` `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`images` - `ImageConnection!`	A list of the images for a product.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`defaultImage` - `Image`	Default image for a product.
`relatedProducts` - `RelatedProductsConnection!`	Related products for this product.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`inventory` - `ProductInventory!`	Inventory information of the product.
`metafields` - `MetafieldConnection!`	Metafield data related to a product.
Arguments `namespace` - `String!` `keys` - `[String!]` default = `[]` `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`upc` - `String`	Universal product code.
`mpn` - `String`	Manufacturer part number.
`gtin` - `String`	Global trade item number.
`createdAt` - `DateTimeExtended!`	Product creation date Alpha version. Do not use in production.
`reviews` - `ReviewConnection!`	Reviews associated with the product.
Arguments `sort` - `ProductReviewsSortInput` `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`seo` - `SeoDetails!`	Product SEO details.

Example

{
  "id": ID,
  "entityId": 123,
  "sku": "abc123",
  "path": "abc123",
  "name": "xyz789",
  "description": "xyz789",
  "plainTextDescription": "abc123",
  "warranty": "xyz789",
  "minPurchaseQuantity": 987,
  "maxPurchaseQuantity": 123,
  "addToCartUrl": "abc123",
  "addToWishlistUrl": "xyz789",
  "prices": Prices,
  "priceRanges": PriceRanges,
  "weight": Measurement,
  "height": Measurement,
  "width": Measurement,
  "depth": Measurement,
  "options": OptionConnection,
  "productOptions": ProductOptionConnection,
  "reviewSummary": Reviews,
  "type": "abc123",
  "availability": "xyz789",
  "availabilityDescription": "abc123",
  "categories": CategoryConnection,
  "brand": Brand,
  "variants": VariantConnection,
  "customFields": CustomFieldConnection,
  "images": ImageConnection,
  "defaultImage": Image,
  "relatedProducts": RelatedProductsConnection,
  "inventory": ProductInventory,
  "metafields": MetafieldConnection,
  "upc": "abc123",
  "mpn": "abc123",
  "gtin": "xyz789",
  "createdAt": DateTimeExtended,
  "reviews": ReviewConnection,
  "seo": SeoDetails
}

Types

`ProductAttributeSearchFilterInput`

Input Field	Description
`attribute` - `String!`
`values` - `[String!]!`

Example

{"attribute": "abc123", "values": ["xyz789"]}

Types

`ProductAvailabilityStatus`

Product availability status

Enum Value	Description
`Available`
`Preorder`
`Unavailable`

Types

`ProductAvailable`

Available Product

Field Name	Description
`status` - `ProductAvailabilityStatus!`	The availability state of the product.
`description` - `String!`	A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'.

Example

{
  "status": ProductAvailabilityStatus,
  "description": "abc123"
}

Types

`ProductConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[ProductEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [ProductEdge]
}

Types

`ProductEdge`

An edge in a connection.

Field Name	Description
`node` - `Product!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": Product, "cursor": "abc123"}

Types

`ProductInventory`

Product Inventory Information

Field Name	Description
`isInStock` - `Boolean!`	Indicates whether this product is in stock.
`hasVariantInventory` - `Boolean!`	Indicates whether this product's inventory is being tracked on variant level. If true, you may wish to check the variants node to understand the true inventory of each individual variant, rather than relying on this product-level aggregate to understand how many items may be added to cart.
`aggregated` - `AggregatedInventory`	Aggregated product inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront.

Example

{
  "isInStock": true,
  "hasVariantInventory": true,
  "aggregated": AggregatedInventory
}

Types

`ProductOption`

Product Option

Field Name	Description
`entityId` - `Int!`	Unique ID for the option.
`displayName` - `String!`	Display name for the option.
`isRequired` - `Boolean!`	One of the option values is required to be selected for the checkout.
`values` - `OptionValueConnection!`	Option values.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{
  "entityId": 987,
  "displayName": "xyz789",
  "isRequired": false,
  "values": OptionValueConnection
}

Types

`ProductOptionConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[ProductOptionEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [ProductOptionEdge]
}

Types

`ProductOptionEdge`

An edge in a connection.

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.

Example

{"cursor": "abc123"}

Types

`ProductOptionValue`

Product Option Value

Field Name	Description
`entityId` - `Int!`	Unique ID for the option value.
`label` - `String!`	Label for the option value.

Example

{"entityId": 123, "label": "abc123"}

Types

`ProductOptionValueConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[ProductOptionValueEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [ProductOptionValueEdge]
}

Types

`ProductOptionValueEdge`

An edge in a connection.

Field Name	Description
`cursor` - `String!`	A cursor for use in pagination.

Example

{"cursor": "xyz789"}

Types

`ProductPickListOptionValue`

A Product PickList Value - a product to be mapped to the base product if selected.

Field Name	Description
`productId` - `Int!`	The ID of the product associated with this option value.
`entityId` - `Int!`	Unique ID for the option value.
`label` - `String!`	Label for the option value.
`isDefault` - `Boolean!`	Indicates whether this value is the chosen default selected value.

Example

{"productId": 123, "entityId": 123, "label": "abc123", "isDefault": false}

Types

`ProductPreOrder`

PreOrder Product

Field Name	Description
`message` - `String`	The message to be shown in the store when a product is put into the pre-order availability state, e.g. "Expected release date is %%DATE%%"
`willBeReleasedAt` - `DateTimeExtended`	Product release date
`status` - `ProductAvailabilityStatus!`	The availability state of the product.
`description` - `String!`	A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'.

Example

{
  "message": "xyz789",
  "willBeReleasedAt": DateTimeExtended,
  "status": ProductAvailabilityStatus,
  "description": "xyz789"
}

Types

`ProductReviewsSortInput`

Enum Value	Description
`NEWEST`

Types

`ProductUnavailable`

Unavailable Product

Field Name	Description
`message` - `String`	The message to be shown in the store when "Call for pricing" is enabled for this product, e.g. "Contact us at 555-5555"
`status` - `ProductAvailabilityStatus!`	The availability state of the product.
`description` - `String!`	A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'.

Example

{
  "message": "xyz789",
  "status": ProductAvailabilityStatus,
  "description": "abc123"
}

Types

`RatingSearchFilterInput`

Input Field	Description
`minRating` - `Float`
`maxRating` - `Float`

Example

{"minRating": 123.45, "maxRating": 123.45}

Types

`Region`

Field Name	Description
`name` - `String!`	The name of a region.
`html` - `String!`	The rendered HTML content targeted at the region.

Example

{"name": "abc123", "html": "xyz789"}

Types

`RelatedProductsConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[RelatedProductsEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [RelatedProductsEdge]
}

Types

`RelatedProductsEdge`

An edge in a connection.

Field Name	Description
`node` - `Product!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": Product, "cursor": "abc123"}

Types

`RenderedRegionsByPageType`

The rendered regions by specific page.

Field Name	Description
`regions` - `[Region!]!`

Example

{"regions": [Region]}

Types

`Review`

Review

Field Name	Description
`entityId` - `Long!`	Unique ID for the product review.
`author` - `Author!`	Product review author.
`title` - `String!`	Product review title.
`text` - `String!`	Product review text.
`rating` - `Int!`	Product review rating.
`createdAt` - `DateTimeExtended!`	Product review creation date.

Example

{
  "entityId": Long,
  "author": Author,
  "title": "abc123",
  "text": "abc123",
  "rating": 987,
  "createdAt": DateTimeExtended
}

Types

`ReviewConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[ReviewEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [ReviewEdge]
}

Types

`ReviewEdge`

An edge in a connection.

Field Name	Description
`node` - `Review!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": Review, "cursor": "xyz789"}

Types

`Reviews`

Review Rating Summary

Field Name	Description
`averageRating` - `Float!`	Average rating of the product. Alpha version. Do not use in production.
`numberOfReviews` - `Int!`	Total number of reviews on product.
`summationOfRatings` - `Int!`	Summation of rating scores from each review.

Example

{"averageRating": 987.65, "numberOfReviews": 123, "summationOfRatings": 987}

Types

`Route`

route

Field Name	Description

Example

{}

Types

`Search`

Store search settings.

Field Name	Description
`productFilteringEnabled` - `Boolean!`	Product filtering enabled.

Example

{"productFilteringEnabled": true}

Types

`SearchProducts`

Field Name	Description
`products` - `ProductConnection!`	Details of the products.
Arguments `after` - `String` `first` - `Int`

Example

{"products": ProductConnection}

Types

`SearchProductsFiltersInput`

Input Field	Description
`searchTerm` - `String`
`price` - `PriceSearchFilterInput`
`rating` - `RatingSearchFilterInput`
`categoryEntityId` - `Int`
`categoryEntityIds` - `[Int!]`
`brandEntityIds` - `[Int!]`
`productAttributes` - `[ProductAttributeSearchFilterInput!]`
`isFreeShipping` - `Boolean`
`isFeatured` - `Boolean`
`isInStock` - `Boolean`

Example

{
  "searchTerm": "abc123",
  "price": PriceSearchFilterInput,
  "rating": RatingSearchFilterInput,
  "categoryEntityId": 123,
  "categoryEntityIds": [987],
  "brandEntityIds": [987],
  "productAttributes": [
    ProductAttributeSearchFilterInput
  ],
  "isFreeShipping": true,
  "isFeatured": true,
  "isInStock": false
}

Types

`SearchProductsSortInput`

Enum Value	Description
`FEATURED`
`NEWEST`
`BEST_SELLING`
`BEST_REVIEWED`
`A_TO_Z`
`Z_TO_A`
`LOWEST_PRICE`
`HIGHEST_PRICE`

Types

`SearchQueries`

Field Name	Description
`searchProducts` - `SearchProducts!`	Details of the products and facets matching given search criteria.
Arguments `filters` - `SearchProductsFiltersInput!` `sort` - `SearchProductsSortInput`

Example

{"searchProducts": SearchProducts}

Types

`SeoDetails`

Seo Details

Field Name	Description
`pageTitle` - `String!`	Page title.
`metaDescription` - `String!`	Meta description.
`metaKeywords` - `String!`	Meta keywords.

Example

{"pageTitle": "xyz789", "metaDescription": "abc123", "metaKeywords": "abc123"}

Types

`Settings`

Store settings information from the control panel.

Field Name	Description
`storeName` - `String!`	The name of the store.
`storeHash` - `String!`	The hash of the store.
`status` - `StorefrontStatusType!`	The current store status.
`logo` - `LogoField!`	Logo information for the store.
`contact` - `ContactField`	Contact information for the store.
`url` - `UrlField!`	Store urls.
`display` - `DisplayField!`	Store display format information.
`channelId` - `Long!`	Channel ID.
`tax` - `TaxDisplaySettings`
`search` - `Search!`	Store search settings.

Example

{
  "storeName": "abc123",
  "storeHash": "xyz789",
  "status": StorefrontStatusType,
  "logo": LogoField,
  "contact": ContactField,
  "url": UrlField,
  "display": DisplayField,
  "channelId": Long,
  "tax": TaxDisplaySettings,
  "search": Search
}

Types

`Site`

A site

Field Name	Description
`search` - `SearchQueries!`	The Search queries. Alpha version. Do not use in production.
`categoryTree` - `[CategoryTreeItem!]!`
Arguments `rootEntityId` - `Int`
`brands` - `BrandConnection!`	Details of the brand.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int` `productEntityIds` - `[Int!]` default = `[]`
`products` - `ProductConnection!`	Details of the products.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int` `ids` - `[ID!]` default = `[]` `entityIds` - `[Int!]` default = `[]` `hideOutOfStock` - `Boolean`
`newestProducts` - `ProductConnection!`	Details of the newest products.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int` `hideOutOfStock` - `Boolean`
`bestSellingProducts` - `ProductConnection!`	Details of the best selling products.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int` `hideOutOfStock` - `Boolean`
`featuredProducts` - `ProductConnection!`	Details of the featured products.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int` `hideOutOfStock` - `Boolean`
`product` - `Product`	A single product object with variant pricing overlay capabilities.
Arguments `id` - `ID` `entityId` - `Int` `variantEntityId` - `Int` `optionValueIds` - `[OptionValueId!]` default = `[]` `sku` - `String`
`route` - `Route!`	Route for a node
Arguments `path` - `String!`
`settings` - `Settings`	Store settings.
`content` - `Content!`
`currency` - `Currency`	Currency details.
Arguments `currencyCode` - `currencyCode!` Currency Code
`currencies` - `CurrencyConnection!`	Store Currencies.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{
  "search": SearchQueries,
  "categoryTree": [CategoryTreeItem],
  "brands": BrandConnection,
  "products": ProductConnection,
  "newestProducts": ProductConnection,
  "bestSellingProducts": ProductConnection,
  "featuredProducts": ProductConnection,
  "product": Product,
  "route": Route,
  "settings": Settings,
  "content": Content,
  "currency": Currency,
  "currencies": CurrencyConnection
}

Types

`StorefrontStatusType`

Storefront Mode

Enum Value	Description
`LAUNCHED`
`MAINTENANCE`
`PRE_LAUNCH`
`HIBERNATION`

Types

`String`

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Types

`SwatchOptionValue`

A swatch option value - swatch values can be associated with a list of hexidecimal colors or an image.

Field Name	Description
`hexColors` - `[String!]!`	List of up to 3 hex encoded colors to associate with a swatch value.
`imageUrl` - `String`	Absolute path of a swatch texture image.
Arguments `width` - `Int!` `height` - `Int`
`entityId` - `Int!`	Unique ID for the option value.
`label` - `String!`	Label for the option value.
`isDefault` - `Boolean!`	Indicates whether this value is the chosen default selected value.

Example

{
  "hexColors": ["xyz789"],
  "imageUrl": "xyz789",
  "entityId": 987,
  "label": "abc123",
  "isDefault": false
}

Types

`TaxDisplaySettings`

Field Name	Description
`pdp` - `TaxPriceDisplay!`	Tax display setting for Product Details Page.
`plp` - `TaxPriceDisplay!`	Tax display setting for Product List Page.

Example

{
  "pdp": TaxPriceDisplay,
  "plp": TaxPriceDisplay
}

Types

`TaxPriceDisplay`

Tax setting can be set included or excluded (Tax setting can also be set to both on PDP/PLP).

Enum Value	Description
`INC`
`EX`
`BOTH`

Types

`TextFieldOption`

A single line text input field.

Field Name	Description
`entityId` - `Int!`	Unique ID for the option.
`displayName` - `String!`	Display name for the option.
`isRequired` - `Boolean!`	One of the option values is required to be selected for the checkout.

Example

{"entityId": 123, "displayName": "xyz789", "isRequired": false}

Types

`UrlField`

Url field

Field Name	Description
`vanityUrl` - `String!`	Store url.
`cdnUrl` - `String!`	CDN url to fetch assets.

Example

{"vanityUrl": "abc123", "cdnUrl": "abc123"}

Types

`Variant`

Variant

Field Name	Description
`id` - `ID!`	The ID of an object
`entityId` - `Int!`	Id of the variant.
`sku` - `String!`	Sku of the variant.
`weight` - `Measurement`	The variant's weight. If a weight was not explicitly specified on the variant, this will be the product's weight.
`height` - `Measurement`	The variant's height. If a height was not explicitly specified on the variant, this will be the product's height.
`width` - `Measurement`	The variant's width. If a width was not explicitly specified on the variant, this will be the product's width.
`depth` - `Measurement`	The variant's depth. If a depth was not explicitly specified on the variant, this will be the product's depth.
`options` - `OptionConnection!`	The options which define a variant.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`productOptions` - `ProductOptionConnection!`	Product options that compose this variant.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`defaultImage` - `Image`	Default image for a variant.
`prices` - `Prices`	Variant prices
Arguments `includeTax` - `Boolean` default = `false` `currencyCode` - `currencyCode` Please select a currency
`inventory` - `VariantInventory`	Variant inventory
`metafields` - `MetafieldConnection!`	Metafield data related to a variant.
Arguments `namespace` - `String!` `keys` - `[String!]` default = `[]` `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`upc` - `String`	Universal product code.
`mpn` - `String`	Manufacturer part number.
`gtin` - `String`	Global trade item number.

Example

{
  "id": ID,
  "entityId": 987,
  "sku": "xyz789",
  "weight": Measurement,
  "height": Measurement,
  "width": Measurement,
  "depth": Measurement,
  "options": OptionConnection,
  "productOptions": ProductOptionConnection,
  "defaultImage": Image,
  "prices": Prices,
  "inventory": VariantInventory,
  "metafields": MetafieldConnection,
  "upc": "abc123",
  "mpn": "xyz789",
  "gtin": "xyz789"
}

Types

`VariantConnection`

A connection to a list of items.

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[VariantEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [VariantEdge]
}

Types

`VariantEdge`

An edge in a connection.

Field Name	Description
`node` - `Variant!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{"node": Variant, "cursor": "abc123"}

Types

`VariantInventory`

Variant Inventory

Field Name	Description
`aggregated` - `Aggregated`	Aggregated product variant inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront.
`isInStock` - `Boolean!`	Indicates whether this product is in stock.
`byLocation` - `LocationConnection`	Inventory by locations.
Arguments `locationEntityIds` - `[Int!]` default = `[]` `locationEntityCodes` - `[String!]` default = `[]` `locationEntityTypeIds` - `[String!]` default = `[]` `locationEntityServiceTypeIds` - `[String!]` default = `[]` `distanceFilter` - `DistanceFilter` `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{
  "aggregated": Aggregated,
  "isInStock": false,
  "byLocation": LocationConnection
}

Types

`countryCode`

Country Code

Enum Value	Description
`AW`
`AF`
`AO`
`AI`
`AX`
`AL`
`AD`
`AE`
`AR`
`AM`
`AS`
`AQ`
`TF`
`AG`
`AU`
`AT`
`AZ`
`BI`
`BE`
`BJ`
`BQ`
`BF`
`BD`
`BG`
`BH`
`BS`
`BA`
`BL`
`BY`
`BZ`
`BM`
`BO`
`BR`
`BB`
`BN`
`BT`
`BV`
`BW`
`CF`
`CA`
`CC`
`CH`
`CL`
`CN`
`CI`
`CM`
`CD`
`CG`
`CK`
`CO`
`KM`
`CV`
`CR`
`CU`
`CW`
`CX`
`KY`
`CY`
`CZ`
`DE`
`DJ`
`DM`
`DK`
`DO`
`DZ`
`EC`
`EG`
`ER`
`EH`
`ES`
`EE`
`ET`
`FI`
`FJ`
`FK`
`FR`
`FO`
`FM`
`GA`
`GB`
`GE`
`GG`
`GH`
`GI`
`GN`
`GP`
`GM`
`GW`
`GQ`
`GR`
`GD`
`GL`
`GT`
`GF`
`GU`
`GY`
`HK`
`HM`
`HN`
`HR`
`HT`
`HU`
`ID`
`IM`
`IN`
`IO`
`IE`
`IR`
`IQ`
`IS`
`IL`
`IT`
`JM`
`JE`
`JO`
`JP`
`KZ`
`KE`
`KG`
`KH`
`KI`
`KN`
`KR`
`KW`
`LA`
`LB`
`LR`
`LY`
`LC`
`LI`
`LK`
`LS`
`LT`
`LU`
`LV`
`MO`
`MF`
`MA`
`MC`
`MD`
`MG`
`MV`
`MX`
`MH`
`MK`
`ML`
`MT`
`MM`
`ME`
`MN`
`MP`
`MZ`
`MR`
`MS`
`MQ`
`MU`
`MW`
`MY`
`YT`
`NA`
`NC`
`NE`
`NF`
`NG`
`NI`
`NU`
`NL`
`NO`
`NP`
`NR`
`NZ`
`OM`
`PK`
`PA`
`PN`
`PE`
`PH`
`PW`
`PG`
`PL`
`PR`
`KP`
`PT`
`PY`
`PS`
`PF`
`QA`
`RE`
`RO`
`RU`
`RW`
`SA`
`SD`
`SN`
`SG`
`GS`
`SH`
`SJ`
`SB`
`SL`
`SV`
`SM`
`SO`
`PM`
`RS`
`SS`
`ST`
`SR`
`SK`
`SI`
`SE`
`SZ`
`SX`
`SC`
`SY`
`TC`
`TD`
`TG`
`TH`
`TJ`
`TK`
`TM`
`TL`
`TO`
`TT`
`TN`
`TR`
`TV`
`TW`
`TZ`
`UG`
`UA`
`UM`
`UY`
`US`
`UZ`
`VA`
`VC`
`VE`
`VG`
`VI`
`VN`
`VU`
`WF`
`WS`
`YE`
`ZA`
`ZM`
`ZW`

Types

`currencyCode`

Currency Code

Enum Value	Description
`ADP`
`AED`
`AFA`
`AFN`
`ALK`
`ALL`
`AMD`
`ANG`
`AOA`
`AOK`
`AON`
`AOR`
`ARA`
`ARL`
`ARM`
`ARP`
`ARS`
`ATS`
`AUD`
`AWG`
`AZM`
`AZN`
`BAD`
`BAM`
`BAN`
`BBD`
`BDT`
`BEC`
`BEF`
`BEL`
`BGL`
`BGM`
`BGN`
`BGO`
`BHD`
`BIF`
`BMD`
`BND`
`BOB`
`BOL`
`BOP`
`BOV`
`BRB`
`BRC`
`BRE`
`BRL`
`BRN`
`BRR`
`BRZ`
`BSD`
`BTN`
`BUK`
`BWP`
`BYB`
`BYN`
`BYR`
`BZD`
`CAD`
`CDF`
`CHE`
`CHF`
`CHW`
`CLE`
`CLF`
`CLP`
`CNX`
`CNY`
`COP`
`COU`
`CRC`
`CSD`
`CSK`
`CUC`
`CUP`
`CVE`
`CYP`
`CZK`
`DDM`
`DEM`
`DJF`
`DKK`
`DOP`
`DZD`
`ECS`
`ECV`
`EEK`
`EGP`
`ERN`
`ESA`
`ESB`
`ESP`
`ETB`
`EUR`
`FIM`
`FJD`
`FKP`
`FRF`
`GBP`
`GEK`
`GEL`
`GHC`
`GHS`
`GIP`
`GMD`
`GNF`
`GNS`
`GQE`
`GRD`
`GTQ`
`GWE`
`GWP`
`GYD`
`HKD`
`HNL`
`HRD`
`HRK`
`HTG`
`HUF`
`IDR`
`IEP`
`ILP`
`ILR`
`ILS`
`INR`
`IQD`
`ISJ`
`IRR`
`ISK`
`ITL`
`JMD`
`JOD`
`JPY`
`KES`
`KGS`
`KHR`
`KMF`
`KPW`
`KRH`
`KRO`
`KRW`
`KWD`
`KYD`
`KZT`
`LAK`
`LBP`
`LKR`
`LRD`
`LSL`
`LTL`
`LTT`
`LUC`
`LUF`
`LUL`
`LVL`
`LVR`
`LYD`
`MAD`
`MAF`
`MCF`
`MDC`
`MDL`
`MGA`
`MGF`
`MKD`
`MKN`
`MLF`
`MMK`
`MNT`
`MOP`
`MRO`
`MTL`
`MTP`
`MUR`
`MVP`
`MVR`
`MWK`
`MXN`
`MXP`
`MXV`
`MYR`
`MZE`
`MZM`
`MZN`
`NAD`
`NGN`
`NIC`
`NIO`
`NLG`
`NOK`
`NPR`
`NZD`
`OMR`
`PAB`
`PEI`
`PEN`
`PES`
`PGK`
`PHP`
`PKR`
`PLN`
`PLZ`
`PTE`
`PYG`
`QAR`
`RHD`
`ROL`
`RON`
`RSD`
`RUB`
`RUR`
`RWF`
`SAR`
`SBD`
`SCR`
`SDD`
`SDG`
`SDP`
`SEK`
`SGD`
`SHP`
`SIT`
`SKK`
`SLL`
`SOS`
`SRD`
`SRG`
`SSP`
`STD`
`SUR`
`SVC`
`SYP`
`SZL`
`THB`
`TJR`
`TJS`
`TMM`
`TMT`
`TND`
`TOP`
`TPE`
`TRL`
`TRY`
`TTD`
`TWD`
`TZS`
`UAH`
`UAK`
`UGS`
`UGX`
`USD`
`USN`
`USS`
`UYI`
`UYP`
`UYU`
`UZS`
`VEB`
`VEF`
`VND`
`VNN`
`VUV`
`WST`
`XAF`
`XCD`
`XEU`
`XFO`
`XFU`
`XOF`
`XPF`
`XRE`
`YDD`
`YER`
`YUD`
`YUM`
`YUN`
`YUR`
`ZAL`
`ZAR`
`ZMK`
`ZMW`
`ZRN`
`ZRZ`
`ZWD`
`ZWL`
`ZWR`