Storefront GraphQL API Reference

Queries

channel

Description

The current channel.

Response

Returns a Channel!

Example

Query
query channel {
  channel {
    entityId
    metafields {
      ...MetafieldConnectionFragment
    }
  }
}
Response
{
  "data": {
    "channel": {
      "entityId": {},
      "metafields": MetafieldConnection
    }
  }
}
Queries

customer

Description

The currently logged in customer.

Response

Returns a Customer

Example

Query
query customer {
  customer {
    entityId
    company
    customerGroupId
    email
    firstName
    lastName
    notes
    phone
    taxExemptCategory
    addressCount
    attributeCount
    storeCredit {
      ...MoneyFragment
    }
    attributes {
      ...CustomerAttributesFragment
    }
    wishlists {
      ...WishlistConnectionFragment
    }
  }
}
Response
{
  "data": {
    "customer": {
      "entityId": 123,
      "company": "xyz789",
      "customerGroupId": 123,
      "email": "abc123",
      "firstName": "xyz789",
      "lastName": "xyz789",
      "notes": "xyz789",
      "phone": "xyz789",
      "taxExemptCategory": "abc123",
      "addressCount": 987,
      "attributeCount": 987,
      "storeCredit": [Money],
      "attributes": CustomerAttributes,
      "wishlists": WishlistConnection
    }
  }
}
Queries

inventory

Description

An inventory

Response

Returns an Inventory!

Example

Query
query inventory {
  inventory {
    locations {
      ...InventoryLocationConnectionFragment
    }
  }
}
Response
{
  "data": {
    "inventory": {
      "locations": InventoryLocationConnection
    }
  }
}
Queries

node

Description

Fetches an object given its ID

Response

Returns a Node

Arguments
Name Description
id - ID! The ID of an object

Example

Query
query node($id: ID!) {
  node(id: $id) {
    id
  }
}
Variables
{"id": 4}
Response
{"data": {"node": {"id": "4"}}}
Queries

site

Description

A site

Response

Returns a Site!

Example

Query
query site {
  site {
    search {
      ...SearchQueriesFragment
    }
    categoryTree {
      ...CategoryTreeItemFragment
    }
    category {
      ...CategoryFragment
    }
    brands {
      ...BrandConnectionFragment
    }
    products {
      ...ProductConnectionFragment
    }
    newestProducts {
      ...ProductConnectionFragment
    }
    bestSellingProducts {
      ...ProductConnectionFragment
    }
    featuredProducts {
      ...ProductConnectionFragment
    }
    product {
      ...ProductFragment
    }
    route {
      ...RouteFragment
    }
    settings {
      ...SettingsFragment
    }
    content {
      ...ContentFragment
    }
    currency {
      ...CurrencyFragment
    }
    currencies {
      ...CurrencyConnectionFragment
    }
    publicWishlist {
      ...PublicWishlistFragment
    }
    popularBrands {
      ...PopularBrandConnectionFragment
    }
    cart {
      ...CartFragment
    }
    checkout {
      ...CheckoutFragment
    }
  }
}
Response
{
  "data": {
    "site": {
      "search": SearchQueries,
      "categoryTree": [CategoryTreeItem],
      "category": Category,
      "brands": BrandConnection,
      "products": ProductConnection,
      "newestProducts": ProductConnection,
      "bestSellingProducts": ProductConnection,
      "featuredProducts": ProductConnection,
      "product": Product,
      "route": Route,
      "settings": Settings,
      "content": Content,
      "currency": Currency,
      "currencies": CurrencyConnection,
      "publicWishlist": PublicWishlist,
      "popularBrands": PopularBrandConnection,
      "cart": Cart,
      "checkout": Checkout
    }
  }
}

Mutations

cart

Description

The Cart mutations.

Response

Returns a CartMutations!

Example

Query
mutation cart {
  cart {
    createCart {
      ...CreateCartResultFragment
    }
    deleteCart {
      ...DeleteCartResultFragment
    }
    addCartLineItems {
      ...AddCartLineItemsResultFragment
    }
    updateCartLineItem {
      ...UpdateCartLineItemResultFragment
    }
    deleteCartLineItem {
      ...DeleteCartLineItemResultFragment
    }
    updateCartCurrency {
      ...UpdateCartCurrencyResultFragment
    }
    assignCartToCustomer {
      ...AssignCartToCustomerResultFragment
    }
    unassignCartFromCustomer {
      ...UnassignCartFromCustomerResultFragment
    }
  }
}
Response
{
  "data": {
    "cart": {
      "createCart": CreateCartResult,
      "deleteCart": DeleteCartResult,
      "addCartLineItems": AddCartLineItemsResult,
      "updateCartLineItem": UpdateCartLineItemResult,
      "deleteCartLineItem": DeleteCartLineItemResult,
      "updateCartCurrency": UpdateCartCurrencyResult,
      "assignCartToCustomer": AssignCartToCustomerResult,
      "unassignCartFromCustomer": UnassignCartFromCustomerResult
    }
  }
}
Mutations

checkout

Description

The Checkout mutations.

Response

Returns a CheckoutMutations!

Example

Query
mutation checkout {
  checkout {
    addCheckoutBillingAddress {
      ...AddCheckoutBillingAddressResultFragment
    }
    updateCheckoutBillingAddress {
      ...UpdateCheckoutBillingAddressResultFragment
    }
    updateCheckoutCustomerMessage {
      ...UpdateCheckoutCustomerMessageResultFragment
    }
    selectCheckoutShippingOption {
      ...SelectCheckoutShippingOptionResultFragment
    }
    applyCheckoutCoupon {
      ...ApplyCheckoutCouponResultFragment
    }
    unapplyCheckoutCoupon {
      ...UnapplyCheckoutCouponResultFragment
    }
    applyCheckoutSpamProtection {
      ...ApplyCheckoutSpamProtectionResultFragment
    }
    addCheckoutShippingConsignments {
      ...AddCheckoutShippingConsignmentsResultFragment
    }
    updateCheckoutShippingConsignment {
      ...UpdateCheckoutShippingConsignmentResultFragment
    }
    deleteCheckoutConsignment {
      ...DeleteCheckoutConsignmentResultFragment
    }
    completeCheckout {
      ...CompleteCheckoutResultFragment
    }
  }
}
Response
{
  "data": {
    "checkout": {
      "addCheckoutBillingAddress": AddCheckoutBillingAddressResult,
      "updateCheckoutBillingAddress": UpdateCheckoutBillingAddressResult,
      "updateCheckoutCustomerMessage": UpdateCheckoutCustomerMessageResult,
      "selectCheckoutShippingOption": SelectCheckoutShippingOptionResult,
      "applyCheckoutCoupon": ApplyCheckoutCouponResult,
      "unapplyCheckoutCoupon": UnapplyCheckoutCouponResult,
      "applyCheckoutSpamProtection": ApplyCheckoutSpamProtectionResult,
      "addCheckoutShippingConsignments": AddCheckoutShippingConsignmentsResult,
      "updateCheckoutShippingConsignment": UpdateCheckoutShippingConsignmentResult,
      "deleteCheckoutConsignment": DeleteCheckoutConsignmentResult,
      "completeCheckout": CompleteCheckoutResult
    }
  }
}
Mutations

login

Description

Customer login

Response

Returns a LoginResult!

Arguments
Name Description
email - String! An email of the customer.
password - String! A password of the customer.

Example

Query
mutation login(
  $email: String!,
  $password: String!
) {
  login(
    email: $email,
    password: $password
  ) {
    result
    customer {
      ...CustomerFragment
    }
  }
}
Variables
{
  "email": "xyz789",
  "password": "xyz789"
}
Response
{
  "data": {
    "login": {
      "result": "abc123",
      "customer": Customer
    }
  }
}
Mutations

logout

Description

Customer logout

Response

Returns a LogoutResult!

Example

Query
mutation logout {
  logout {
    result
  }
}
Response
{"data": {"logout": {"result": "xyz789"}}}
Mutations

wishlist

Description

The wishlist mutations.

Response

Returns a WishlistMutations!

Example

Query
mutation wishlist {
  wishlist {
    createWishlist {
      ...CreateWishlistResultFragment
    }
    addWishlistItems {
      ...AddWishlistItemsResultFragment
    }
    deleteWishlistItems {
      ...DeleteWishlistItemsResultFragment
    }
    updateWishlist {
      ...UpdateWishlistResultFragment
    }
    deleteWishlists {
      ...DeleteWishlistResultFragment
    }
  }
}
Response
{
  "data": {
    "wishlist": {
      "createWishlist": CreateWishlistResult,
      "addWishlistItems": AddWishlistItemsResult,
      "deleteWishlistItems": DeleteWishlistItemsResult,
      "updateWishlist": UpdateWishlistResult,
      "deleteWishlists": DeleteWishlistResult
    }
  }
}

Types

AddCartLineItemsDataInput

Description

Add cart line items data object

Fields
Input Field Description
lineItems - [CartLineItemInput!] List of cart line items
giftCertificates - [CartGiftCertificateInput!] List of gift certificates
Example
{
  "lineItems": [CartLineItemInput],
  "giftCertificates": [CartGiftCertificateInput]
}
Types

AddCartLineItemsInput

Description

Add cart line items input object

Fields
Input Field Description
cartEntityId - String! The cart id
data - AddCartLineItemsDataInput! Add cart line items data object
Example
{
  "cartEntityId": "xyz789",
  "data": AddCartLineItemsDataInput
}
Types

AddCartLineItemsResult

Description

Add cart line items result

Fields
Field Name Description
cart - Cart The Cart that is updated as a result of mutation.
Example
{"cart": Cart}
Types

AddCheckoutBillingAddressDataInput

Description

Add checkout billing address data object

Fields
Input Field Description
address - CheckoutAddressInput! The checkout billing address
Example
{"address": CheckoutAddressInput}
Types

AddCheckoutBillingAddressInput

Description

Add checkout billing address input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
data - AddCheckoutBillingAddressDataInput! Add checkout billing address data object
Example
{
  "checkoutEntityId": "abc123",
  "data": AddCheckoutBillingAddressDataInput
}
Types

AddCheckoutBillingAddressResult

Description

Add checkout billing address result

Fields
Field Name Description
checkout - Checkout The Checkout that is updated as a result of mutation.
Example
{"checkout": Checkout}
Types

AddCheckoutShippingConsignmentsDataInput

Description

Add checkout shipping consignments data object

Fields
Input Field Description
consignments - [CheckoutShippingConsignmentInput!]! The list of shipping consignments
Example
{"consignments": [CheckoutShippingConsignmentInput]}
Types

AddCheckoutShippingConsignmentsInput

Description

Add checkout shipping consignments input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
data - AddCheckoutShippingConsignmentsDataInput! Add checkout shipping consignments data object
Example
{
  "checkoutEntityId": "abc123",
  "data": AddCheckoutShippingConsignmentsDataInput
}
Types

AddCheckoutShippingConsignmentsResult

Description

Apply checkout shipping consignments result

Fields
Field Name Description
checkout - Checkout The Checkout that is updated as a result of mutation.
Example
{"checkout": Checkout}
Types

AddWishlistItemsInput

Description

Add wishlist items input object

Fields
Input Field Description
entityId - Int! The wishlist id
items - [WishlistItemInput!]! The new wishlist items
Example
{"entityId": 123, "items": [WishlistItemInput]}
Types

AddWishlistItemsResult

Description

Add wishlist items

Fields
Field Name Description
result - Wishlist! The wishlist
Example
{"result": Wishlist}
Types

Aggregated

Description

Aggregated

Fields
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": {}, "warningLevel": 123}
Types

AggregatedInventory

Description

Aggregated Product Inventory

Fields
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": 987, "warningLevel": 987}
Types

ApplyCheckoutCouponDataInput

Description

Apply checkout coupon data object

Fields
Input Field Description
couponCode - String! The checkout coupon code
Example
{"couponCode": "xyz789"}
Types

ApplyCheckoutCouponInput

Description

Apply checkout coupon input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
data - ApplyCheckoutCouponDataInput! Apply checkout coupon data object
Example
{
  "checkoutEntityId": "xyz789",
  "data": ApplyCheckoutCouponDataInput
}
Types

ApplyCheckoutCouponResult

Description

Apply checkout coupon result

Fields
Field Name Description
checkout - Checkout The Checkout that is updated as a result of mutation.
Example
{"checkout": Checkout}
Types

ApplyCheckoutSpamProtectionDataInput

Description

Apply checkout spam protection data object

Fields
Input Field Description
token - String! The checkout spam protection token
Example
{"token": "xyz789"}
Types

ApplyCheckoutSpamProtectionInput

Description

Apply checkout spam protection input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
data - ApplyCheckoutSpamProtectionDataInput! Apply checkout spam protection data object
Example
{
  "checkoutEntityId": "xyz789",
  "data": ApplyCheckoutSpamProtectionDataInput
}
Types

ApplyCheckoutSpamProtectionResult

Description

Apply checkout spam protection result

Fields
Field Name Description
checkout - Checkout The Checkout that is updated as a result of mutation.
Example
{"checkout": Checkout}
Types

AssignCartToCustomerInput

Description

Assign cart to the customer input object.

Fields
Input Field Description
cartEntityId - String! The cart id.
Example
{"cartEntityId": "abc123"}
Types

AssignCartToCustomerResult

Description

Assign cart to the customer result.

Fields
Field Name Description
cart - Cart The Cart that is updated as a result of mutation.
Example
{"cart": Cart}
Types

Author

Description

Author

Fields
Field Name Description
name - String! Author name.
Example
{"name": "abc123"}
Types

Banner

Description

Banner details.

Fields
Field Name Description
id - ID! The ID of an object
entityId - Long! The id of the Banner.
name - String! The name of the Banner.
content - String! The content of the Banner.
location - BannerLocation! The location of the Banner.
Example
{
  "id": 4,
  "entityId": {},
  "name": "xyz789",
  "content": "abc123",
  "location": "BOTTOM"
}
Types

BannerConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [BannerEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [BannerEdge]
}
Types

BannerEdge

Description

An edge in a connection.

Fields
Field Name Description
node - Banner! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": Banner,
  "cursor": "xyz789"
}
Types

BannerLocation

Description

Banner location

Values
Enum Value Description

BOTTOM

TOP
Example
"BOTTOM"
Types

Banners

Description

Banners details.

Fields
Field Name Description
homePage - BannerConnection! List of home page banners.
Arguments
before - String
after - String
first - Int
last - Int
searchPage - BannerConnection! List of search page banners.
Arguments
before - String
after - String
first - Int
last - Int
categoryPage - CategoryPageBannerConnection! List of category page banners.
Arguments
before - String
after - String
first - Int
last - Int
categoryEntityId - Int!

The id of the category to request banners for.
brandPage - BrandPageBannerConnection! List of brand page banners.
Arguments
before - String
after - String
first - Int
last - Int
brandEntityId - Int!

The id of the brand to request banners for.
Example
{
  "homePage": BannerConnection,
  "searchPage": BannerConnection,
  "categoryPage": CategoryPageBannerConnection,
  "brandPage": BrandPageBannerConnection
}
Types

BigDecimal

Description

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

Example
BigDecimal
Types

Blog

Description

Blog details.

Fields
Field Name Description
id - ID! The ID of an object
name - String! The name of the Blog.
description - String! The description of the Blog.
path - String! The path of the Blog.
isVisibleInNavigation - Boolean! Whether or not the blog should be visible in the navigation menu.
posts - BlogPostConnection! Details of the Blog posts.
Arguments
filters - BlogPostsFiltersInput

Filters for querying blog posts

sort - sortBy

Order to sort the blog posts.

before - String
after - String
first - Int
last - Int
post - BlogPost Blog post details.
Arguments
entityId - Int!

Id of the blog post to fetch.
renderedRegions - RenderedRegionsByPageType! The rendered regions for the blog index.
Example
{
  "id": 4,
  "name": "abc123",
  "description": "abc123",
  "path": "abc123",
  "isVisibleInNavigation": false,
  "posts": BlogPostConnection,
  "post": BlogPost,
  "renderedRegions": RenderedRegionsByPageType
}
Types

BlogIndexPage

Description

A blog index page.

Fields
Field Name Description
path - String! The URL path of the page.
renderedRegions - RenderedRegionsByPageType! The rendered regions for the web page.
entityId - Int! Unique ID for the web page.
parentEntityId - Int Unique ID for the parent page.
name - String! Page name.
isVisibleInNavigation - Boolean! Whether or not the page should be visible in the navigation menu.
seo - SeoDetails! Page SEO details.
Example
{
  "path": "xyz789",
  "renderedRegions": RenderedRegionsByPageType,
  "entityId": 123,
  "parentEntityId": 123,
  "name": "abc123",
  "isVisibleInNavigation": false,
  "seo": SeoDetails
}
Types

BlogPost

Description

Blog post details.

Fields
Field Name Description
id - ID! The ID of an object
entityId - Int! Unique ID for the blog post.
name - String! Blog post name.
tags - [String!]! Blog post tags.
path - String! Blog post path.
htmlBody - String! The body of the Blog post.
plainTextSummary - String! The plain text summary of the Blog post.
Arguments
characterLimit - Int

The max number of characters for the plain text summary.
publishedDate - DateTimeExtended! Blog post published date.
author - String Blog post author.
thumbnailImage - Image Blog post thumbnail image.
seo - SeoDetails! Blog post SEO details.
renderedRegions - RenderedRegionsByPageType! The rendered regions for the blog post.
Example
{
  "id": 4,
  "entityId": 123,
  "name": "xyz789",
  "tags": ["abc123"],
  "path": "xyz789",
  "htmlBody": "abc123",
  "plainTextSummary": "abc123",
  "publishedDate": DateTimeExtended,
  "author": "xyz789",
  "thumbnailImage": Image,
  "seo": SeoDetails,
  "renderedRegions": RenderedRegionsByPageType
}
Types

BlogPostConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [BlogPostEdge] A list of edges.
collectionInfo - CollectionInfo Collection info
Example
{
  "pageInfo": PageInfo,
  "edges": [BlogPostEdge],
  "collectionInfo": CollectionInfo
}
Types

BlogPostEdge

Description

An edge in a connection.

Fields
Field Name Description
node - BlogPost! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": BlogPost,
  "cursor": "abc123"
}
Types

BlogPostRedirect

Description

Redirect to a blog post.

Fields
Field Name Description
id - ID! The ID of an object.
entityId - Int! Entity id.
path - String! Relative destination url.
Example
{
  "id": "4",
  "entityId": 987,
  "path": "abc123"
}
Types

BlogPostsFiltersInput

Description

Object containing the filters for querying blog posts

Fields
Input Field Description
entityIds - [Int!] Ids of the expected blog posts.
tags - [String!] Tags of the expected blog posts.
Example
{"entityIds": [123], "tags": ["abc123"]}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Brand

Description

Brand

Fields
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! List of products associated with the brand.
Arguments
before - String
after - String
first - Int
last - Int
hideOutOfStock - Boolean

When set to True, hides products which are out of stock. Defaults to False. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.
metafields - MetafieldConnection! Metafield data related to a brand.
Arguments
namespace - String!

Metafield namespace filter

keys - [String!]

Labels for identifying metafield data values.

before - String
after - String
first - Int
last - Int
Example
{
  "id": "4",
  "entityId": 123,
  "name": "xyz789",
  "defaultImage": Image,
  "pageTitle": "xyz789",
  "metaDesc": "abc123",
  "metaKeywords": ["xyz789"],
  "seo": SeoDetails,
  "searchKeywords": ["abc123"],
  "path": "abc123",
  "products": ProductConnection,
  "metafields": MetafieldConnection
}
Types

BrandConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [BrandEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [BrandEdge]
}
Types

BrandEdge

Description

An edge in a connection.

Fields
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": "xyz789"
}
Types

BrandPageBannerConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [BrandPageBannerEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [BrandPageBannerEdge]
}
Types

BrandPageBannerEdge

Description

An edge in a connection.

Fields
Field Name Description
node - Banner! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": Banner,
  "cursor": "xyz789"
}
Types

BrandRedirect

Description

Redirect to a brand.

Fields
Field Name Description
id - ID! The ID of an object.
entityId - Int! Entity id.
path - String! Relative destination url.
Example
{
  "id": "4",
  "entityId": 987,
  "path": "xyz789"
}
Types

BrandSearchFilter

Description

Brand Filter

Fields
Field Name Description
displayProductCount - Boolean! Indicates whether to display product count next to the filter.
brands - BrandSearchFilterItemConnection! List of available brands.
Arguments
before - String
after - String
first - Int
last - Int
name - String! Display name for the filter.
isCollapsedByDefault - Boolean! Indicates whether filter is collapsed by default.
Example
{
  "displayProductCount": false,
  "brands": BrandSearchFilterItemConnection,
  "name": "abc123",
  "isCollapsedByDefault": true
}
Types

BrandSearchFilterItem

Description

Specific brand filter item

Fields
Field Name Description
entityId - Int! Brand ID.
name - String! Brand name.
isSelected - Boolean! Indicates whether brand is selected.
productCount - Int! Indicates how many products available for this filter.
Example
{
  "entityId": 123,
  "name": "xyz789",
  "isSelected": false,
  "productCount": 987
}
Types

BrandSearchFilterItemConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [BrandSearchFilterItemEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [BrandSearchFilterItemEdge]
}
Types

BrandSearchFilterItemEdge

Description

An edge in a connection.

Fields
Field Name Description
node - BrandSearchFilterItem! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": BrandSearchFilterItem,
  "cursor": "xyz789"
}
Types

Breadcrumb

Description

Breadcrumb

Fields
Field Name Description
entityId - Int! Category id.
name - String! Name of the category.
path - String Path to the category.
Example
{
  "entityId": 123,
  "name": "abc123",
  "path": "xyz789"
}
Types

BreadcrumbConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [BreadcrumbEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [BreadcrumbEdge]
}
Types

BreadcrumbEdge

Description

An edge in a connection.

Fields
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": "xyz789"
}
Types

BulkPricingFixedPriceDiscount

Description

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

Fields
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

Description

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

Fields
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": 987
}
Types

BulkPricingRelativePriceDiscount

Description

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

Fields
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": 123,
  "maximumQuantity": 123
}
Types

BulkPricingTier

Description

A set of bulk pricing tiers that define price discounts which apply when purchasing specified quantities of a product or variant.

Fields
Field Name Description
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.
Possible Types
BulkPricingTier Types

BulkPricingFixedPriceDiscount

BulkPricingPercentageDiscount

BulkPricingRelativePriceDiscount
Example
{"minimumQuantity": 123, "maximumQuantity": 987}
Types

Cart

Description

A cart

Fields
Field Name Description
id - ID! The ID of an object
entityId - String! Cart ID.
currencyCode - String! ISO-4217 currency code.
isTaxIncluded - Boolean! Whether this item is taxable.
baseAmount - Money! Cost of cart's contents, before applying discounts.
discountedAmount - Money! Discounted amount.
amount - Money! Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).
discounts - [CartDiscount!]! List of discounts applied to this cart.
lineItems - CartLineItems! List of line items.
createdAt - DateTimeExtended! Time when the cart was created.
updatedAt - DateTimeExtended! Time when the cart was last updated.
locale - String! Locale of the cart.
Example
{
  "id": 4,
  "entityId": "abc123",
  "currencyCode": "abc123",
  "isTaxIncluded": true,
  "baseAmount": Money,
  "discountedAmount": Money,
  "amount": Money,
  "discounts": [CartDiscount],
  "lineItems": CartLineItems,
  "createdAt": DateTimeExtended,
  "updatedAt": DateTimeExtended,
  "locale": "abc123"
}
Types

CartCustomItem

Description

Cart custom item.

Fields
Field Name Description
entityId - String! ID of the custom item.
sku - String Custom item sku.
name - String! Custom item name.
quantity - Int! Quantity of this item.
listPrice - Money! Price of the item. With or without tax depending on your stores set up.
extendedListPrice - Money! Item's list price multiplied by the quantity.
Example
{
  "entityId": "abc123",
  "sku": "xyz789",
  "name": "xyz789",
  "quantity": 987,
  "listPrice": Money,
  "extendedListPrice": Money
}
Types

CartDigitalItem

Description

Cart digital item.

Fields
Field Name Description
entityId - String! The line-item ID.
parentEntityId - String The product is part of a bundle such as a product pick list, then the parentId or the main product id will populate.
productEntityId - Int! ID of the product.
variantEntityId - Int ID of the variant.
sku - String SKU of the variant.
name - String! The item's product name.
url - String! The product URL.
imageUrl - String URL of an image of this item, accessible on the internet.
brand - String The product brand.
quantity - Int! Quantity of this item.
isTaxable - Boolean! Whether the item is taxable.
discounts - [CartDiscount!]! List of discounts applied to this item.
discountedAmount - Money! The total value of all discounts applied to this item (excluding coupon).
couponAmount - Money! The total value of all coupons applied to this item.
listPrice - Money! The net item price before discounts and coupons. It is based on the product default price or sale price (if set) configured in BigCommerce Admin.
originalPrice - Money! An item’s original price is the same as the product default price in the admin panel.
salePrice - Money! Item's price after all discounts are applied. (The final price before tax calculation).
extendedListPrice - Money! Item's list price multiplied by the quantity.
extendedSalePrice - Money! Item's sale price multiplied by the quantity.
selectedOptions - [CartSelectedOption!]! The list of selected options for this product.
Example
{
  "entityId": "abc123",
  "parentEntityId": "xyz789",
  "productEntityId": 123,
  "variantEntityId": 987,
  "sku": "abc123",
  "name": "abc123",
  "url": "abc123",
  "imageUrl": "abc123",
  "brand": "xyz789",
  "quantity": 123,
  "isTaxable": false,
  "discounts": [CartDiscount],
  "discountedAmount": Money,
  "couponAmount": Money,
  "listPrice": Money,
  "originalPrice": Money,
  "salePrice": Money,
  "extendedListPrice": Money,
  "extendedSalePrice": Money,
  "selectedOptions": [CartSelectedOption]
}
Types

CartDiscount

Description

Discount applied to the cart.

Fields
Field Name Description
entityId - String! ID of the applied discount.
discountedAmount - Money! The discounted amount applied within a given context.
Example
{
  "entityId": "xyz789",
  "discountedAmount": Money
}
Types

CartGiftCertificate

Description

Cart gift certificate

Fields
Field Name Description
entityId - String! ID of this gift certificate.
name - String! GiftCertificate-provided name that will appear in the control panel.
theme - CartGiftCertificateTheme! Currently supports Birthday, Boy, Celebration, Christmas, General, and Girl.
amount - Money! Value must be between 1.00 and 1,000.00 in the store's default currency.
isTaxable - Boolean! Whether or not the gift certificate is taxable.
sender - CartGiftCertificateSender! Sender of the gift certificate.
recipient - CartGiftCertificateRecipient! Recipient of the gift certificate.
message - String Message that will be sent to the gift certificate's recipient. Limited to 200 characters.
Example
{
  "entityId": "xyz789",
  "name": "xyz789",
  "theme": "BIRTHDAY",
  "amount": Money,
  "isTaxable": false,
  "sender": CartGiftCertificateSender,
  "recipient": CartGiftCertificateRecipient,
  "message": "xyz789"
}
Types

CartGiftCertificateInput

Description

Cart gift certificate input object

Fields
Input Field Description
name - String! GiftCertificate-provided name that will appear in the control panel.
theme - CartGiftCertificateTheme! Currently supports Birthday, Boy, Celebration, Christmas, General, and Girl.
amount - BigDecimal! Value must be between 1.00 and 1,000.00 in the store's default currency.
quantity - Int! The total number of certificates
sender - CartGiftCertificateSenderInput! Sender of the gift certificate.
recipient - CartGiftCertificateRecipientInput! Recipient of the gift certificate.
message - String Message that will be sent to the gift certificate's recipient. Limited to 200 characters.
Example
{
  "name": "abc123",
  "theme": "BIRTHDAY",
  "amount": BigDecimal,
  "quantity": 123,
  "sender": CartGiftCertificateSenderInput,
  "recipient": CartGiftCertificateRecipientInput,
  "message": "xyz789"
}
Types

CartGiftCertificateRecipient

Description

Cart gift certificate recipient

Fields
Field Name Description
name - String! Contact's name.
email - String! Contact's email address.
Example
{
  "name": "xyz789",
  "email": "xyz789"
}
Types

CartGiftCertificateRecipientInput

Description

Cart gift certificate recipient input object

Fields
Input Field Description
name - String! Contact's name.
email - String! Contact's email address.
Example
{
  "name": "abc123",
  "email": "abc123"
}
Types

CartGiftCertificateSender

Description

Cart gift certificate sender

Fields
Field Name Description
name - String! Contact's name.
email - String! Contact's email address.
Example
{
  "name": "xyz789",
  "email": "xyz789"
}
Types

CartGiftCertificateSenderInput

Description

Cart gift certificate sender input object

Fields
Input Field Description
name - String! Contact's name.
email - String! Contact's email address.
Example
{
  "name": "xyz789",
  "email": "xyz789"
}
Types

CartGiftCertificateTheme

Description

Cart gift certificate theme

Values
Enum Value Description

BIRTHDAY

BOY

CELEBRATION

CHRISTMAS

GENERAL

GIRL
Example
"BIRTHDAY"
Types

CartGiftWrapping

Description

Gift wrapping for the item

Fields
Field Name Description
name - String! Name of the gift-wrapping option.
amount - Money! Gift-wrapping price per product.
message - String Custom gift message along with items wrapped in this wrapping option.
Example
{
  "name": "abc123",
  "amount": Money,
  "message": "xyz789"
}
Types

CartLineItemInput

Description

Cart line item input object

Fields
Input Field Description
quantity - Int! Total number of line items.
productEntityId - Int! The product id
variantEntityId - Int The variant id
selectedOptions - CartSelectedOptionsInput The list of selected options for this item.
Example
{
  "quantity": 123,
  "productEntityId": 987,
  "variantEntityId": 123,
  "selectedOptions": CartSelectedOptionsInput
}
Types

CartLineItems

Description

Cart line items

Fields
Field Name Description
physicalItems - [CartPhysicalItem!]! List of physical items.
digitalItems - [CartDigitalItem!]! List of digital items.
giftCertificates - [CartGiftCertificate!]! List of gift certificates.
customItems - [CartCustomItem!]! List of custom items.
totalQuantity - Int! Total number of line items.
Example
{
  "physicalItems": [CartPhysicalItem],
  "digitalItems": [CartDigitalItem],
  "giftCertificates": [CartGiftCertificate],
  "customItems": [CartCustomItem],
  "totalQuantity": 987
}
Types

CartMutations

Description

Cart mutations

Fields
Field Name Description
createCart - CreateCartResult Creates a cart and generates a cart ID.
Arguments
input - CreateCartInput!

Create cart input object
deleteCart - DeleteCartResult Deletes a Cart.
Arguments
input - DeleteCartInput!

Delete cart input object
addCartLineItems - AddCartLineItemsResult Adds line item(s) to the cart.
Arguments
input - AddCartLineItemsInput!

Add cart line items input object
updateCartLineItem - UpdateCartLineItemResult Updates line item in the cart.
Arguments
input - UpdateCartLineItemInput!

Update cart line item input object
deleteCartLineItem - DeleteCartLineItemResult Delete line item in the cart. Removing the last line item in the Cart deletes the Cart.
Arguments
input - DeleteCartLineItemInput!

Delete cart line item input object
updateCartCurrency - UpdateCartCurrencyResult Update currency of the cart.
Arguments
input - UpdateCartCurrencyInput!

Update cart currency input object
assignCartToCustomer - AssignCartToCustomerResult Assign cart to the customer.
Arguments
input - AssignCartToCustomerInput!

Assign cart to the customer input object.
unassignCartFromCustomer - UnassignCartFromCustomerResult Unassign cart from the customer.
Arguments
input - UnassignCartFromCustomerInput!

Unassign cart from the customer input object.
Example
{
  "createCart": CreateCartResult,
  "deleteCart": DeleteCartResult,
  "addCartLineItems": AddCartLineItemsResult,
  "updateCartLineItem": UpdateCartLineItemResult,
  "deleteCartLineItem": DeleteCartLineItemResult,
  "updateCartCurrency": UpdateCartCurrencyResult,
  "assignCartToCustomer": AssignCartToCustomerResult,
  "unassignCartFromCustomer": UnassignCartFromCustomerResult
}
Types

CartPhysicalItem

Description

Cart physical item.

Fields
Field Name Description
entityId - String! The line-item ID.
parentEntityId - String The product is part of a bundle such as a product pick list, then the parentId or the main product id will populate.
productEntityId - Int! ID of the product.
variantEntityId - Int ID of the variant.
sku - String SKU of the variant.
name - String! The item's product name.
url - String! The product URL.
imageUrl - String URL of an image of this item, accessible on the internet.
brand - String The product brand.
quantity - Int! Quantity of this item.
isTaxable - Boolean! Whether the item is taxable.
discounts - [CartDiscount!]! List of discounts applied to this item.
discountedAmount - Money! The total value of all discounts applied to this item (excluding coupon).
couponAmount - Money! The total value of all coupons applied to this item.
listPrice - Money! The net item price before discounts and coupons. It is based on the product default price or sale price (if set) configured in BigCommerce Admin.
originalPrice - Money! An item’s original price is the same as the product default price in the admin panel.
salePrice - Money! Item's price after all discounts are applied. (The final price before tax calculation).
extendedListPrice - Money! Item's list price multiplied by the quantity.
extendedSalePrice - Money! Item's sale price multiplied by the quantity.
isShippingRequired - Boolean! Whether this item requires shipping to a physical address.
selectedOptions - [CartSelectedOption!]! The list of selected options for this item.
giftWrapping - CartGiftWrapping Gift wrapping for this item.
Example
{
  "entityId": "xyz789",
  "parentEntityId": "xyz789",
  "productEntityId": 987,
  "variantEntityId": 123,
  "sku": "xyz789",
  "name": "xyz789",
  "url": "abc123",
  "imageUrl": "abc123",
  "brand": "abc123",
  "quantity": 987,
  "isTaxable": false,
  "discounts": [CartDiscount],
  "discountedAmount": Money,
  "couponAmount": Money,
  "listPrice": Money,
  "originalPrice": Money,
  "salePrice": Money,
  "extendedListPrice": Money,
  "extendedSalePrice": Money,
  "isShippingRequired": true,
  "selectedOptions": [CartSelectedOption],
  "giftWrapping": CartGiftWrapping
}
Types

CartSelectedCheckboxOption

Description

Selected checkbox option.

Fields
Field Name Description
entityId - Int! The product option ID.
name - String! The product option name.
value - String! The product option value.
valueEntityId - Int! The product option value ID.
Example
{
  "entityId": 987,
  "name": "xyz789",
  "value": "abc123",
  "valueEntityId": 987
}
Types

CartSelectedCheckboxOptionInput

Description

Cart selected checkbox option input object

Fields
Input Field Description
optionEntityId - Int! The product option ID.
optionValueEntityId - Int! The product option value ID.
Example
{"optionEntityId": 987, "optionValueEntityId": 987}
Types

CartSelectedDateFieldOption

Description

Selected date field option.

Fields
Field Name Description
entityId - Int! The product option ID.
name - String! The product option name.
date - DateTimeExtended! Date value.
Example
{
  "entityId": 987,
  "name": "abc123",
  "date": DateTimeExtended
}
Types

CartSelectedDateFieldOptionInput

Description

Cart selected date field option input object

Fields
Input Field Description
optionEntityId - Int! The product option ID.
date - DateTime! Date value.
Example
{
  "optionEntityId": 123,
  "date": "2007-12-03T10:15:30Z"
}
Types

CartSelectedFileUploadOption

Description

Selected file upload option.

Fields
Field Name Description
entityId - Int! The product option ID.
name - String! The product option name.
fileName - String! Uploaded file name.
Example
{
  "entityId": 987,
  "name": "xyz789",
  "fileName": "abc123"
}
Types

CartSelectedMultiLineTextFieldOption

Description

Selected multi-line text field option.

Fields
Field Name Description
entityId - Int! The product option ID.
name - String! The product option name.
text - String! Text value.
Example
{
  "entityId": 987,
  "name": "abc123",
  "text": "abc123"
}
Types

CartSelectedMultiLineTextFieldOptionInput

Description

Cart selected multiple line text field option input object

Fields
Input Field Description
optionEntityId - Int! The product option ID.
text - String! Text value.
Example
{"optionEntityId": 123, "text": "xyz789"}
Types

CartSelectedMultipleChoiceOption

Description

Selected multiple choice option.

Fields
Field Name Description
entityId - Int! The product option ID.
name - String! The product option name.
value - String! The product option value.
valueEntityId - Int! The product option value ID.
Example
{
  "entityId": 123,
  "name": "xyz789",
  "value": "abc123",
  "valueEntityId": 123
}
Types

CartSelectedMultipleChoiceOptionInput

Description

Cart selected multiple choice option input object

Fields
Input Field Description
optionEntityId - Int! The product option ID.
optionValueEntityId - Int! The product option value ID.
Example
{"optionEntityId": 123, "optionValueEntityId": 123}
Types

CartSelectedNumberFieldOption

Description

Selected number field option.

Fields
Field Name Description
entityId - Int! The product option ID.
name - String! The product option name.
number - Float! Number value.
Example
{
  "entityId": 123,
  "name": "abc123",
  "number": 987.65
}
Types

CartSelectedNumberFieldOptionInput

Description

Cart selected number field option input object

Fields
Input Field Description
optionEntityId - Int! The product option ID.
number - Float! Number value.
Example
{"optionEntityId": 123, "number": 987.65}
Types

CartSelectedOption

Description

Selected option for the item.

Fields
Field Name Description
entityId - Int! The product option ID.
name - String! The product option name.
Possible Types
CartSelectedOption Types

CartSelectedCheckboxOption

CartSelectedDateFieldOption

CartSelectedFileUploadOption

CartSelectedMultiLineTextFieldOption

CartSelectedMultipleChoiceOption

CartSelectedNumberFieldOption

CartSelectedTextFieldOption
Example
{"entityId": 987, "name": "abc123"}
Types

CartSelectedOptionsInput

Description

Selected product options.

Fields
Input Field Description
checkboxes - [CartSelectedCheckboxOptionInput!] List of selected checkbox options.
dateFields - [CartSelectedDateFieldOptionInput!] List of selected date field options.
multiLineTextFields - [CartSelectedMultiLineTextFieldOptionInput!] List of selected multi-line text field options.
multipleChoices - [CartSelectedMultipleChoiceOptionInput!] List of selected multiple choice options.
numberFields - [CartSelectedNumberFieldOptionInput!] List of selected number field options.
textFields - [CartSelectedTextFieldOptionInput!] List of selected text field options.
Example
{
  "checkboxes": [CartSelectedCheckboxOptionInput],
  "dateFields": [CartSelectedDateFieldOptionInput],
  "multiLineTextFields": [
    CartSelectedMultiLineTextFieldOptionInput
  ],
  "multipleChoices": [
    CartSelectedMultipleChoiceOptionInput
  ],
  "numberFields": [CartSelectedNumberFieldOptionInput],
  "textFields": [CartSelectedTextFieldOptionInput]
}
Types

CartSelectedTextFieldOption

Description

Selected text field option.

Fields
Field Name Description
entityId - Int! The product option ID.
name - String! The product option name.
text - String! Text value.
Example
{
  "entityId": 123,
  "name": "abc123",
  "text": "xyz789"
}
Types

CartSelectedTextFieldOptionInput

Description

Cart selected multiple line text field option input object

Fields
Input Field Description
optionEntityId - Int! The product option ID.
text - String! TODO
Example
{"optionEntityId": 123, "text": "xyz789"}
Types

Catalog

Description

Storefront catalog settings.

Fields
Field Name Description
productComparisonsEnabled - Boolean Product comparisons enabled.
Example
{"productComparisonsEnabled": true}
Types

CatalogProductOption

Description

Product Option

Fields
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.
isVariantOption - Boolean! Indicates whether it is a variant option or modifier.
Possible Types
CatalogProductOption Types

CheckboxOption

DateFieldOption

FileUploadFieldOption

MultiLineTextFieldOption

MultipleChoiceOption

NumberFieldOption

TextFieldOption
Example
{
  "entityId": 987,
  "displayName": "xyz789",
  "isRequired": true,
  "isVariantOption": false
}
Types

CatalogProductOptionValue

Description

Product Option Value

Fields
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.
isSelected - Boolean Indicates whether this value is selected based on sku/variantEntityId/optionValueIds overlay requested on the product node level.
Possible Types
CatalogProductOptionValue Types

MultipleChoiceOptionValue

ProductPickListOptionValue

SwatchOptionValue
Example
{
  "entityId": 987,
  "label": "xyz789",
  "isDefault": false,
  "isSelected": false
}
Types

Category

Description

Category

Fields
Field Name Description
id - ID! The ID of an object
entityId - Int! Unique ID for the category.
name - String! Category name.
path - String! Category path.
defaultImage - Image Default image for the category.
description - String! Category description.
breadcrumbs - BreadcrumbConnection! Category breadcrumbs.
Arguments
depth - Int!

The depth of the breadcrumbs.

before - String
after - String
first - Int
last - Int
products - ProductConnection! List of products associated with category
Arguments
before - String
after - String
first - Int
last - Int
hideOutOfStock - Boolean

When set to True, hides products which are out of stock. Defaults to False. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.

sortBy - CategoryProductSort

Product sorting by categories.
metafields - MetafieldConnection! Metafield data related to a category.
Arguments
namespace - String!

Metafield namespace filter

keys - [String!]

Labels for identifying metafield data values.

before - String
after - String
first - Int
last - Int
seo - SeoDetails! Category SEO details.
shopByPriceRanges - ShopByPriceConnection! Category shop by price money ranges. Alpha version. Do not use in production.
Arguments
currencyCode - currencyCode

Please select a currency

includeTax - Boolean

Tax will be included if enabled

before - String
after - String
first - Int
last - Int
defaultProductSort - CategoryProductSort Category default product sort.
Example
{
  "id": "4",
  "entityId": 987,
  "name": "abc123",
  "path": "xyz789",
  "defaultImage": Image,
  "description": "abc123",
  "breadcrumbs": BreadcrumbConnection,
  "products": ProductConnection,
  "metafields": MetafieldConnection,
  "seo": SeoDetails,
  "shopByPriceRanges": ShopByPriceConnection,
  "defaultProductSort": "A_TO_Z"
}
Types

CategoryConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [CategoryEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [CategoryEdge]
}
Types

CategoryEdge

Description

An edge in a connection.

Fields
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": "abc123"
}
Types

CategoryPageBannerConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [CategoryPageBannerEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [CategoryPageBannerEdge]
}
Types

CategoryPageBannerEdge

Description

An edge in a connection.

Fields
Field Name Description
node - Banner! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": Banner,
  "cursor": "abc123"
}
Types

CategoryProductSort

Description

Product sorting by categories.

Values
Enum Value Description

A_TO_Z

BEST_REVIEWED

BEST_SELLING

DEFAULT

FEATURED

HIGHEST_PRICE

LOWEST_PRICE

NEWEST

Z_TO_A
Example
"A_TO_Z"
Types

CategoryRedirect

Description

Redirect to a category.

Fields
Field Name Description
id - ID! The ID of an object.
entityId - Int! Entity id.
path - String! Relative destination url.
Example
{"id": 4, "entityId": 987, "path": "abc123"}
Types

CategorySearchFilter

Description

Category Filter

Fields
Field Name Description
displayProductCount - Boolean! Indicates whether to display product count next to the filter.
categories - CategorySearchFilterItemConnection! List of available categories.
Arguments
before - String
after - String
first - Int
last - Int
name - String! Display name for the filter.
isCollapsedByDefault - Boolean! Indicates whether filter is collapsed by default.
Example
{
  "displayProductCount": true,
  "categories": CategorySearchFilterItemConnection,
  "name": "abc123",
  "isCollapsedByDefault": true
}
Types

CategorySearchFilterItem

Description

Specific category filter item

Fields
Field Name Description
entityId - Int! Category ID.
name - String! Category name.
isSelected - Boolean! Indicates whether category is selected.
productCount - Int! Indicates how many products available for this filter.
subCategories - SubCategorySearchFilterItemConnection! List of available sub-categories.
Arguments
before - String
after - String
first - Int
last - Int
Example
{
  "entityId": 123,
  "name": "abc123",
  "isSelected": true,
  "productCount": 123,
  "subCategories": SubCategorySearchFilterItemConnection
}
Types

CategorySearchFilterItemConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [CategorySearchFilterItemEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [CategorySearchFilterItemEdge]
}
Types

CategorySearchFilterItemEdge

Description

An edge in a connection.

Fields
Field Name Description
node - CategorySearchFilterItem! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": CategorySearchFilterItem,
  "cursor": "xyz789"
}
Types

CategoryTreeItem

Description

An item in a tree of categories.

Fields
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.
hasChildren - Boolean! If a category has children.
children - [CategoryTreeItem!]! Subcategories of this category
Example
{
  "entityId": 987,
  "name": "abc123",
  "path": "xyz789",
  "description": "abc123",
  "productCount": 987,
  "image": Image,
  "hasChildren": false,
  "children": [CategoryTreeItem]
}
Types

Channel

Description

The Channel

Fields
Field Name Description
entityId - Long! The ID of the channel.
metafields - MetafieldConnection! Metafield data related to a channel.
Arguments
namespace - String!

Metafield namespace filter

keys - [String!]

Labels for identifying metafield data values.

before - String
after - String
first - Int
last - Int
Example
{"entityId": {}, "metafields": MetafieldConnection}
Types

CheckboxOption

Description

A simple yes/no question represented by a checkbox.

Fields
Field Name Description
checkedByDefault - Boolean! Indicates the default checked status.
label - String! Label of the checkbox option.
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.
isVariantOption - Boolean! Indicates whether it is a variant option or modifier.
Example
{
  "checkedByDefault": true,
  "label": "abc123",
  "entityId": 987,
  "displayName": "xyz789",
  "isRequired": false,
  "isVariantOption": false
}
Types

Checkout

Description

The checkout.

Fields
Field Name Description
id - ID! The ID of an object
entityId - String! Checkout ID.
billingAddress - CheckoutBillingAddress Billing address information.
cart - Cart Cart associated with the checkout.
shippingConsignments - [CheckoutShippingConsignment!] List of shipping consignments.
order - Order Order associated with the checkout.
shippingCostTotal - Money Total shipping cost before any discounts are applied.
giftWrappingCostTotal - Money Gift wrapping cost for all items, including or excluding tax.
handlingCostTotal - Money Handling cost for all consignments including or excluding tax.
taxTotal - Money Total amount of taxes applied.
taxes - [CheckoutTax!] List of taxes applied.
subtotal - Money Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings.
grandTotal - Money The total payable amount, before applying any store credit or gift certificate.
createdAt - DateTimeExtended! Time when the checkout was created.
updatedAt - DateTimeExtended! Time when the checkout was last updated.
customerMessage - String Shopper's message provided as details for the order to be created from the checkout.
outstandingBalance - Money GrandTotal subtract the store-credit amount.
coupons - [CheckoutCoupon!]! Coupons applied at checkout level.
promotions - [CheckoutPromotion!]! List of promotions
Example
{
  "id": "4",
  "entityId": "abc123",
  "billingAddress": CheckoutBillingAddress,
  "cart": Cart,
  "shippingConsignments": [CheckoutShippingConsignment],
  "order": Order,
  "shippingCostTotal": Money,
  "giftWrappingCostTotal": Money,
  "handlingCostTotal": Money,
  "taxTotal": Money,
  "taxes": [CheckoutTax],
  "subtotal": Money,
  "grandTotal": Money,
  "createdAt": DateTimeExtended,
  "updatedAt": DateTimeExtended,
  "customerMessage": "abc123",
  "outstandingBalance": Money,
  "coupons": [CheckoutCoupon],
  "promotions": [CheckoutPromotion]
}
Types

CheckoutAddress

Description

Checkout address.

Fields
Field Name Description
firstName - String The first name.
lastName - String The last name.
email - String Email address.
company - String Company name.
address1 - String Address line 1.
address2 - String Address line 2.
city - String Name of the city.
stateOrProvince - String State or province.
stateOrProvinceCode - String Code of the state or province.
countryCode - String! Country code.
postalCode - String Postal code.
phone - String Phone number.
customFields - [CheckoutAddressCustomField!]! List of custom fields.
Possible Types
CheckoutAddress Types

CheckoutBillingAddress

CheckoutConsignmentAddress
Example
{
  "firstName": "abc123",
  "lastName": "xyz789",
  "email": "abc123",
  "company": "abc123",
  "address1": "xyz789",
  "address2": "xyz789",
  "city": "abc123",
  "stateOrProvince": "xyz789",
  "stateOrProvinceCode": "abc123",
  "countryCode": "xyz789",
  "postalCode": "abc123",
  "phone": "xyz789",
  "customFields": [CheckoutAddressCustomField]
}
Types

CheckoutAddressCheckboxesCustomField

Description

Checkboxes custom field.

Fields
Field Name Description
valueEntityIds - [Int!]! List of custom field value IDs.
entityId - Int! Custom field ID.
Example
{"valueEntityIds": [123], "entityId": 987}
Types

CheckoutAddressCheckboxesCustomFieldInput

Description

Checkout address checkboxes custom field input object

Fields
Input Field Description
fieldEntityId - Int! The custom field ID.
fieldValueEntityIds - [Int!]! List of custom field value IDs.
Example
{"fieldEntityId": 123, "fieldValueEntityIds": [987]}
Types

CheckoutAddressCustomField

Description

Custom field of the checkout address.

Fields
Field Name Description
entityId - Int! Custom field ID.
Possible Types
CheckoutAddressCustomField Types

CheckoutAddressCheckboxesCustomField

CheckoutAddressDateCustomField

CheckoutAddressMultipleChoiceCustomField

CheckoutAddressNumberCustomField

CheckoutAddressPasswordCustomField

CheckoutAddressTextFieldCustomField
Example
{"entityId": 987}
Types

CheckoutAddressCustomFieldInput

Description

Checkout address custom field input object

Fields
Input Field Description
checkboxes - [CheckoutAddressCheckboxesCustomFieldInput!] List of checkboxes custom fields.
multipleChoices - [CheckoutAddressMultipleChoiceCustomFieldInput!] List of multiple choice custom fields.
numbers - [CheckoutAddressNumberCustomFieldInput!] List of number custom fields.
dates - [CheckoutAddressDateCustomFieldInput!] List of date custom fields.
texts - [CheckoutAddressTextCustomFieldInput!] List of text custom fields.
passwords - [CheckoutAddressPasswordCustomFieldInput!] List of password custom fields.
Example
{
  "checkboxes": [
    CheckoutAddressCheckboxesCustomFieldInput
  ],
  "multipleChoices": [
    CheckoutAddressMultipleChoiceCustomFieldInput
  ],
  "numbers": [CheckoutAddressNumberCustomFieldInput],
  "dates": [CheckoutAddressDateCustomFieldInput],
  "texts": [CheckoutAddressTextCustomFieldInput],
  "passwords": [CheckoutAddressPasswordCustomFieldInput]
}
Types

CheckoutAddressDateCustomField

Description

Date custom field.

Fields
Field Name Description
date - DateTimeExtended! Date value.
entityId - Int! Custom field ID.
Example
{"date": DateTimeExtended, "entityId": 123}
Types

CheckoutAddressDateCustomFieldInput

Description

Checkout address date custom field input object

Fields
Input Field Description
fieldEntityId - Int! The custom field ID.
date - DateTime! Date value.
Example
{
  "fieldEntityId": 987,
  "date": "2007-12-03T10:15:30Z"
}
Types

CheckoutAddressInput

Description

Checkout address input object

Fields
Input Field Description
firstName - String The first name
lastName - String The last name
email - String Email address
company - String Company name
address1 - String Address line 1
address2 - String Address line 2
city - String Name of the city
stateOrProvince - String State or province
stateOrProvinceCode - String Code of the state or province
countryCode - String! Country code
postalCode - String Postal code
phone - String Phone number
customFields - CheckoutAddressCustomFieldInput List of custom fields
shouldSaveAddress - Boolean! Should we save this address?
Example
{
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "xyz789",
  "company": "abc123",
  "address1": "abc123",
  "address2": "xyz789",
  "city": "abc123",
  "stateOrProvince": "xyz789",
  "stateOrProvinceCode": "abc123",
  "countryCode": "xyz789",
  "postalCode": "xyz789",
  "phone": "abc123",
  "customFields": CheckoutAddressCustomFieldInput,
  "shouldSaveAddress": true
}
Types

CheckoutAddressMultipleChoiceCustomField

Description

Multiple choice custom field.

Fields
Field Name Description
valueEntityId - Int! Custom field value ID.
entityId - Int! Custom field ID.
Example
{"valueEntityId": 987, "entityId": 123}
Types

CheckoutAddressMultipleChoiceCustomFieldInput

Description

Checkout address multiple choice custom field input object

Fields
Input Field Description
fieldEntityId - Int! The custom field ID.
fieldValueEntityId - Int! The custom field value ID.
Example
{"fieldEntityId": 987, "fieldValueEntityId": 123}
Types

CheckoutAddressNumberCustomField

Description

Number custom field.

Fields
Field Name Description
number - Float! Number value.
entityId - Int! Custom field ID.
Example
{"number": 123.45, "entityId": 123}
Types

CheckoutAddressNumberCustomFieldInput

Description

Checkout address number custom field input object

Fields
Input Field Description
fieldEntityId - Int! The custom field ID.
number - Float! Number value.
Example
{"fieldEntityId": 987, "number": 123.45}
Types

CheckoutAddressPasswordCustomField

Description

Password custom field.

Fields
Field Name Description
password - String! Password value.
entityId - Int! Custom field ID.
Example
{"password": "abc123", "entityId": 987}
Types

CheckoutAddressPasswordCustomFieldInput

Description

Checkout address password custom field input object

Fields
Input Field Description
fieldEntityId - Int! The custom field ID.
password - String! Password value.
Example
{"fieldEntityId": 987, "password": "xyz789"}
Types

CheckoutAddressTextCustomFieldInput

Description

Checkout address text custom field input object

Fields
Input Field Description
fieldEntityId - Int! The custom field ID.
text - String! Text value.
Example
{"fieldEntityId": 987, "text": "xyz789"}
Types

CheckoutAddressTextFieldCustomField

Description

Text custom field.

Fields
Field Name Description
text - String! Text value.
entityId - Int! Custom field ID.
Example
{"text": "xyz789", "entityId": 123}
Types

CheckoutAvailableShippingOption

Description

Available shipping option.

Fields
Field Name Description
entityId - String! Shipping option ID.
description - String! Shipping option description.
type - String! Shipping option type. Flat rate, UPS, etc.
imageUrl - String Shipping option image URL.
cost - Money! Shipping option cost.
transitTime - String An estimate of the arrival time.
isRecommended - Boolean! Is this shipping method the recommended shipping option or not.
Example
{
  "entityId": "abc123",
  "description": "abc123",
  "type": "abc123",
  "imageUrl": "abc123",
  "cost": Money,
  "transitTime": "xyz789",
  "isRecommended": true
}
Types

CheckoutBillingAddress

Description

Checkboxes billing address.

Fields
Field Name Description
entityId - String! Billing address ID.
firstName - String The first name.
lastName - String The last name.
email - String Email address.
company - String Company name.
address1 - String Address line 1.
address2 - String Address line 2.
city - String Name of the city.
stateOrProvince - String State or province.
stateOrProvinceCode - String Code of the state or province.
countryCode - String! Country code.
postalCode - String Postal code.
phone - String Phone number.
customFields - [CheckoutAddressCustomField!]! List of custom fields.
Example
{
  "entityId": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "abc123",
  "company": "xyz789",
  "address1": "xyz789",
  "address2": "abc123",
  "city": "xyz789",
  "stateOrProvince": "abc123",
  "stateOrProvinceCode": "abc123",
  "countryCode": "abc123",
  "postalCode": "abc123",
  "phone": "abc123",
  "customFields": [CheckoutAddressCustomField]
}
Types

CheckoutConsignmentAddress

Description

Checkboxes consignment address.

Fields
Field Name Description
firstName - String The first name.
lastName - String The last name.
email - String Email address.
company - String Company name.
address1 - String Address line 1.
address2 - String Address line 2.
city - String Name of the city.
stateOrProvince - String State or province.
stateOrProvinceCode - String Code of the state or province.
countryCode - String! Country code.
postalCode - String Postal code.
phone - String Phone number.
customFields - [CheckoutAddressCustomField!]! List of custom fields.
Example
{
  "firstName": "abc123",
  "lastName": "abc123",
  "email": "xyz789",
  "company": "xyz789",
  "address1": "abc123",
  "address2": "abc123",
  "city": "abc123",
  "stateOrProvince": "xyz789",
  "stateOrProvinceCode": "xyz789",
  "countryCode": "abc123",
  "postalCode": "xyz789",
  "phone": "xyz789",
  "customFields": [CheckoutAddressCustomField]
}
Types

CheckoutConsignmentLineItemInput

Description

Checkout consignment line item input object

Fields
Input Field Description
lineItemEntityId - String! The line item id
quantity - Int! The total number of consignment line items
Example
{
  "lineItemEntityId": "abc123",
  "quantity": 987
}
Types

CheckoutCoupon

Description

The checkout coupon.

Fields
Field Name Description
entityId - Int! The coupon ID.
code - String! The coupon code.
couponType - CouponType The coupon type.
discountedAmount - Money! The discounted amount applied within a given context.
Example
{
  "entityId": 123,
  "code": "abc123",
  "couponType": "FREE_SHIPPING",
  "discountedAmount": Money
}
Types

CheckoutMutations

Description

Checkout mutations

Fields
Field Name Description
addCheckoutBillingAddress - AddCheckoutBillingAddressResult Creates a checkout billing address.
Arguments
input - AddCheckoutBillingAddressInput!

Add checkout billing address input object
updateCheckoutBillingAddress - UpdateCheckoutBillingAddressResult Update a checkout billing address.
Arguments
input - UpdateCheckoutBillingAddressInput!

Update checkout billing address input object
updateCheckoutCustomerMessage - UpdateCheckoutCustomerMessageResult Updates a checkout customer message.
Arguments
input - UpdateCheckoutCustomerMessageInput!

Update checkout customer message input object
selectCheckoutShippingOption - SelectCheckoutShippingOptionResult Selects a checkout shipping option.
Arguments
input - SelectCheckoutShippingOptionInput!

Select checkout shipping option input object
applyCheckoutCoupon - ApplyCheckoutCouponResult Applies a checkout coupon.
Arguments
input - ApplyCheckoutCouponInput!

Apply checkout coupon input object
unapplyCheckoutCoupon - UnapplyCheckoutCouponResult Unapply a checkout coupon.
Arguments
input - UnapplyCheckoutCouponInput!

Unapply checkout coupon input object
applyCheckoutSpamProtection - ApplyCheckoutSpamProtectionResult Applies a checkout spam protection.
Arguments
input - ApplyCheckoutSpamProtectionInput!

Apply checkout spam protection input object
addCheckoutShippingConsignments - AddCheckoutShippingConsignmentsResult Creates a checkout shipping consignments.
Arguments
input - AddCheckoutShippingConsignmentsInput!

Apply checkout shipping consignments input object
updateCheckoutShippingConsignment - UpdateCheckoutShippingConsignmentResult Updates a checkout shipping consignments.
Arguments
input - UpdateCheckoutShippingConsignmentInput!

Update checkout shipping consignment input object
deleteCheckoutConsignment - DeleteCheckoutConsignmentResult Deletes a checkout consignment.
Arguments
input - DeleteCheckoutConsignmentInput!

Delete checkout consignment input object
completeCheckout - CompleteCheckoutResult Completes the checkout.
Arguments
input - CompleteCheckoutInput!

Complete checkout input object
Example
{
  "addCheckoutBillingAddress": AddCheckoutBillingAddressResult,
  "updateCheckoutBillingAddress": UpdateCheckoutBillingAddressResult,
  "updateCheckoutCustomerMessage": UpdateCheckoutCustomerMessageResult,
  "selectCheckoutShippingOption": SelectCheckoutShippingOptionResult,
  "applyCheckoutCoupon": ApplyCheckoutCouponResult,
  "unapplyCheckoutCoupon": UnapplyCheckoutCouponResult,
  "applyCheckoutSpamProtection": ApplyCheckoutSpamProtectionResult,
  "addCheckoutShippingConsignments": AddCheckoutShippingConsignmentsResult,
  "updateCheckoutShippingConsignment": UpdateCheckoutShippingConsignmentResult,
  "deleteCheckoutConsignment": DeleteCheckoutConsignmentResult,
  "completeCheckout": CompleteCheckoutResult
}
Types

CheckoutPromotion

Description

The checkout promotion

Fields
Field Name Description
banners - [CheckoutPromotionBanner!]! The checkout promotion banners.
Example
{"banners": [CheckoutPromotionBanner]}
Types

CheckoutPromotionBanner

Description

The checkout promotion banner

Fields
Field Name Description
entityId - Int! The checkout promotion banner ID.
type - CheckoutPromotionBannerType! Type of the banner.
locations - [CheckoutPromotionBannerLocation!]! The list of the locations where the banner will display.
text - String! Text of the banner.
Example
{
  "entityId": 987,
  "type": "APPLIED",
  "locations": ["CART_PAGE"],
  "text": "abc123"
}
Types

CheckoutPromotionBannerLocation

Description

Checkout promotion banner location.

Values
Enum Value Description

CART_PAGE

CHECKOUT_PAGE

HOME_PAGE

PRODUCT_PAGE
Example
"CART_PAGE"
Types

CheckoutPromotionBannerType

Description

Checkout promotion banner type.

Values
Enum Value Description

APPLIED

ELIGIBLE

PROMOTION

UPSELL
Example
"APPLIED"
Types

CheckoutSelectedShippingOption

Description

Selected shipping option.

Fields
Field Name Description
entityId - String! Shipping option ID.
description - String! Shipping option description.
type - String! Shipping option type. Flat rate, UPS, etc.
imageUrl - String Shipping option image URL.
cost - Money! Shipping option cost.
transitTime - String An estimate of the arrival time.
Example
{
  "entityId": "xyz789",
  "description": "abc123",
  "type": "xyz789",
  "imageUrl": "xyz789",
  "cost": Money,
  "transitTime": "xyz789"
}
Types

CheckoutSettings

Description

Checkout settings.

Fields
Field Name Description
reCaptchaEnabled - Boolean! Indicates whether ReCaptcha is enabled on checkout.
Example
{"reCaptchaEnabled": true}
Types

CheckoutShippingConsignment

Description

Checkout shipping consignment.

Fields
Field Name Description
entityId - String! Shipping consignment ID.
address - CheckoutConsignmentAddress! Shipping consignment address.
availableShippingOptions - [CheckoutAvailableShippingOption!] List of available shipping options.
selectedShippingOption - CheckoutSelectedShippingOption Selected shipping option.
coupons - [CheckoutCoupon!] List of coupons applied to this shipping consignment.
shippingCost - Money The shipping cost for the consignment.
handlingCost - Money The handling cost of shipping for the consignment.
lineItemIds - [String!]! List of line item IDs for the consignment.
Example
{
  "entityId": "xyz789",
  "address": CheckoutConsignmentAddress,
  "availableShippingOptions": [
    CheckoutAvailableShippingOption
  ],
  "selectedShippingOption": CheckoutSelectedShippingOption,
  "coupons": [CheckoutCoupon],
  "shippingCost": Money,
  "handlingCost": Money,
  "lineItemIds": ["xyz789"]
}
Types

CheckoutShippingConsignmentInput

Description

Checkout shipping consignments input object

Fields
Input Field Description
address - CheckoutAddressInput! Shipping consignment address.
lineItems - [CheckoutConsignmentLineItemInput!]! List of line items for the consignment.
Example
{
  "address": CheckoutAddressInput,
  "lineItems": [CheckoutConsignmentLineItemInput]
}
Types

CheckoutTax

Description

The checkout.

Fields
Field Name Description
name - String! Name of the tax.
amount - Money! Tax amount.
Example
{
  "name": "abc123",
  "amount": Money
}
Types

CollectionInfo

Description

Additional information about the collection.

Fields
Field Name Description
totalItems - Long Total items in the collection despite pagination.
Example
{"totalItems": {}}
Types

CompleteCheckoutInput

Description

Complete checkout input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
Example
{"checkoutEntityId": "xyz789"}
Types

CompleteCheckoutResult

Description

Complete checkout result

Fields
Field Name Description
orderEntityId - Int The Order ID created as a result of the checkout.
paymentAccessToken - String The access token to be used to complete a payment.
Example
{
  "orderEntityId": 123,
  "paymentAccessToken": "abc123"
}
Types

ContactField

Description

Contact field

Fields
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": "xyz789",
  "email": "xyz789",
  "phone": "abc123"
}
Types

ContactPage

Description

A contact page.

Fields
Field Name Description
id - ID! The ID of an object
path - String! The URL path of the page.
htmlBody - String! The body of the page.
plainTextSummary - String! The plain text summary of the page body.
Arguments
characterLimit - Int

The max number of characters for the plain text summary.
contactFields - [String!]! The contact fields that should be used on the page.
renderedRegions - RenderedRegionsByPageType! The rendered regions for the web page.
entityId - Int! Unique ID for the web page.
parentEntityId - Int Unique ID for the parent page.
name - String! Page name.
isVisibleInNavigation - Boolean! Whether or not the page should be visible in the navigation menu.
seo - SeoDetails! Page SEO details.
Example
{
  "id": 4,
  "path": "xyz789",
  "htmlBody": "xyz789",
  "plainTextSummary": "abc123",
  "contactFields": ["xyz789"],
  "renderedRegions": RenderedRegionsByPageType,
  "entityId": 987,
  "parentEntityId": 123,
  "name": "xyz789",
  "isVisibleInNavigation": true,
  "seo": SeoDetails
}
Types

Content

Description

The page content.

Fields
Field Name Description
renderedRegionsByPageType - RenderedRegionsByPageType! The rendered regions by specific page.
Arguments
pageType - PageType!

Rendered regions filter by page type.
renderedRegionsByPageTypeAndEntityId - RenderedRegionsByPageType! The rendered regions by specific page and id.
Arguments
entityId - Long!

Rendered regions filter by id.

entityPageType - EntityPageType!

Rendered regions filter by page type and id.
pages - PageConnection! Details of the pages.
Arguments
filters - WebPagesFiltersInput

Filters for querying web pages

before - String
after - String
first - Int
last - Int
page - WebPage Page details.
Arguments
entityId - Int!

Id of the page to fetch.
blog - Blog Blog details.
banners - Banners Banners details.
Example
{
  "renderedRegionsByPageType": RenderedRegionsByPageType,
  "renderedRegionsByPageTypeAndEntityId": RenderedRegionsByPageType,
  "pages": PageConnection,
  "page": WebPage,
  "blog": Blog,
  "banners": Banners
}
Types

CouponType

Description

The coupon type.

Values
Enum Value Description

FREE_SHIPPING

PERCENTAGE_DISCOUNT

PER_ITEM_DISCOUNT

PER_TOTAL_DISCOUNT

PROMOTION

SHIPPING_DISCOUNT
Example
"FREE_SHIPPING"
Types

CreateCartInput

Description

Create cart input object

Fields
Input Field Description
lineItems - [CartLineItemInput!] List of cart line items
giftCertificates - [CartGiftCertificateInput!] List of gift certificates
currencyCode - String ISO-4217 currency code
locale - String Locale of the cart
Example
{
  "lineItems": [CartLineItemInput],
  "giftCertificates": [CartGiftCertificateInput],
  "currencyCode": "xyz789",
  "locale": "xyz789"
}
Types

CreateCartResult

Description

Create cart result

Fields
Field Name Description
cart - Cart The Cart that is created as a result of mutation.
Example
{"cart": Cart}
Types

CreateWishlistInput

Description

Create wishlist input object

Fields
Input Field Description
name - String! A wishlist name
isPublic - Boolean! A wishlist visibility mode
items - [WishlistItemInput!] A wishlist items
Example
{
  "name": "abc123",
  "isPublic": false,
  "items": [WishlistItemInput]
}
Types

CreateWishlistResult

Description

Create wishlist

Fields
Field Name Description
result - Wishlist! The newly created wishlist
Example
{"result": Wishlist}
Types

Currency

Description

Currency details.

Fields
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": 987,
  "code": "ADP",
  "name": "abc123",
  "flagImage": "abc123",
  "isActive": true,
  "exchangeRate": 987.65,
  "isTransactional": true,
  "display": CurrencyDisplay
}
Types

CurrencyConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [CurrencyEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [CurrencyEdge]
}
Types

CurrencyDisplay

Description

Currency display settings.

Fields
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": "LEFT",
  "decimalToken": "abc123",
  "thousandsToken": "abc123",
  "decimalPlaces": 123
}
Types

CurrencyEdge

Description

An edge in a connection.

Fields
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

Description

Currency symbol position

Values
Enum Value Description

LEFT

RIGHT
Example
"LEFT"
Types

CustomField

Description

Custom field

Fields
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": "abc123",
  "value": "xyz789"
}
Types

CustomFieldConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [CustomFieldEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [CustomFieldEdge]
}
Types

CustomFieldEdge

Description

An edge in a connection.

Fields
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

Description

A customer that shops on a store

Fields
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.
wishlists - WishlistConnection! Customer wishlists.
Arguments
filters - WishlistFiltersInput

Wishlist filters input

before - String
after - String
first - Int
last - Int
Example
{
  "entityId": 123,
  "company": "abc123",
  "customerGroupId": 987,
  "email": "xyz789",
  "firstName": "xyz789",
  "lastName": "abc123",
  "notes": "xyz789",
  "phone": "xyz789",
  "taxExemptCategory": "abc123",
  "addressCount": 987,
  "attributeCount": 987,
  "storeCredit": [Money],
  "attributes": CustomerAttributes,
  "wishlists": WishlistConnection
}
Types

CustomerAttribute

Description

A custom, store-specific attribute for a customer

Fields
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": "abc123",
  "name": "abc123"
}
Types

CustomerAttributes

Description

Custom, store-specific customer attributes

Fields
Field Name Description
attribute - CustomerAttribute! A custom, store-specific attribute for a customer
Arguments
entityId - Int!

The ID of the customer attribute
Example
{"attribute": CustomerAttribute}
Types

DateFieldOption

Description

A calendar for allowing selection of a date.

Fields
Field Name Description
defaultValue - DateTime The default timestamp of date option.
earliest - DateTime The earliest timestamp of date option.
latest - DateTime The latest timestamp of date option.
limitDateBy - LimitDateOption! Limit date by
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.
isVariantOption - Boolean! Indicates whether it is a variant option or modifier.
Example
{
  "defaultValue": "2007-12-03T10:15:30Z",
  "earliest": "2007-12-03T10:15:30Z",
  "latest": "2007-12-03T10:15:30Z",
  "limitDateBy": "EARLIEST_DATE",
  "entityId": 987,
  "displayName": "xyz789",
  "isRequired": false,
  "isVariantOption": false
}
Types

DateTime

Description

ISO-8601 formatted date in UTC

Example
"2007-12-03T10:15:30Z"
Types

DateTimeExtended

Description

Date Time Extended

Fields
Field Name Description
utc - DateTime! ISO-8601 formatted date in UTC
Example
{"utc": "2007-12-03T10:15:30Z"}
Types

DeleteCartInput

Description

Delete cart input object

Fields
Input Field Description
cartEntityId - String! The cart id
Example
{"cartEntityId": "xyz789"}
Types

DeleteCartLineItemInput

Description

Delete cart line item input object

Fields
Input Field Description
cartEntityId - String! The cart id
lineItemEntityId - String! The line item id
Example
{
  "cartEntityId": "abc123",
  "lineItemEntityId": "abc123"
}
Types

DeleteCartLineItemResult

Description

Delete cart lien item result

Fields
Field Name Description
deletedLineItemEntityId - String The ID of the line item that is deleted as a result of mutation.
cart - Cart The Cart that is updated as a result of mutation.
deletedCartEntityId - String The ID of the Cart if it is deleted as a result of mutation.
Example
{
  "deletedLineItemEntityId": "xyz789",
  "cart": Cart,
  "deletedCartEntityId": "xyz789"
}
Types

DeleteCartResult

Description

Delete cart result

Fields
Field Name Description
deletedCartEntityId - String The ID of the Cart that is deleted as a result of mutation.
Example
{"deletedCartEntityId": "abc123"}
Types

DeleteCheckoutConsignmentInput

Description

Delete checkout consignment input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
consignmentEntityId - String! The consignment id
Example
{
  "checkoutEntityId": "abc123",
  "consignmentEntityId": "xyz789"
}
Types

DeleteCheckoutConsignmentResult

Description

Delete checkout consignment result

Fields
Field Name Description
checkout - Checkout The Checkout that is updated as a result of mutation.
Example
{"checkout": Checkout}
Types

DeleteWishlistItemsInput

Description

Delete wishlist items input object

Fields
Input Field Description
entityId - Int! The wishlist id
itemEntityIds - [Int!]! The wishlist item ids
Example
{"entityId": 987, "itemEntityIds": [987]}
Types

DeleteWishlistItemsResult

Description

Delete wishlist items

Fields
Field Name Description
result - Wishlist! The wishlist
Example
{"result": Wishlist}
Types

DeleteWishlistResult

Description

Delete wishlist

Fields
Field Name Description
result - String! The result of the operation
Example
{"result": "xyz789"}
Types

DeleteWishlistsInput

Description

Delete wishlists input object

Fields
Input Field Description
entityIds - [Int!]! The wishlist ids
Example
{"entityIds": [123]}
Types

DisplayField

Description

Display field

Fields
Field Name Description
shortDateFormat - String! Short date format.
extendedDateFormat - String! Extended date format.
Example
{
  "shortDateFormat": "xyz789",
  "extendedDateFormat": "abc123"
}
Types

Distance

Description

Distance

Fields
Field Name Description
value - Float! Distance in specified length unit
lengthUnit - LengthUnit! Length unit
Example
{"value": 987.65, "lengthUnit": "Kilometres"}
Types

DistanceFilter

Description

Filter locations by the distance

Fields
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! Length unit
Example
{
  "radius": 987.65,
  "longitude": 123.45,
  "latitude": 123.45,
  "lengthUnit": "Kilometres"
}
Types

EntityPageType

Description

Entity page type

Values
Enum Value Description

BLOG_POST

BRAND

CATEGORY

CONTACT_US

PAGE

PRODUCT
Example
"BLOG_POST"
Types

ExternalLinkPage

Description

An external link page.

Fields
Field Name Description
link - String! The URL that the page links to.
entityId - Int! Unique ID for the web page.
parentEntityId - Int Unique ID for the parent page.
name - String! Page name.
isVisibleInNavigation - Boolean! Whether or not the page should be visible in the navigation menu.
seo - SeoDetails! Page SEO details.
Example
{
  "link": "xyz789",
  "entityId": 123,
  "parentEntityId": 987,
  "name": "xyz789",
  "isVisibleInNavigation": false,
  "seo": SeoDetails
}
Types

FileUploadFieldOption

Description

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

Fields
Field Name Description
maxFileSize - Int! The maximum size of the file in kilobytes
fileTypes - [String!]! All possible file extensions. Empty means that all files allowed.
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.
isVariantOption - Boolean! Indicates whether it is a variant option or modifier.
Example
{
  "maxFileSize": 987,
  "fileTypes": ["xyz789"],
  "entityId": 987,
  "displayName": "abc123",
  "isRequired": true,
  "isVariantOption": false
}
Types

Float

Description

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

Example
987.65
Types

GiftWrapping

Description

Gift wrapping for product

Fields
Field Name Description
entityId - Int! Gift wrapping id.
name - String! Gift wrapping name.
allowComments - Boolean! Indicates whether commenting is allowed for the gift wrapping.
previewImageUrl - String Gift wrapping preview image url.
Example
{
  "entityId": 123,
  "name": "xyz789",
  "allowComments": true,
  "previewImageUrl": "xyz789"
}
Types

GiftWrappingConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [GiftWrappingEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [GiftWrappingEdge]
}
Types

GiftWrappingEdge

Description

An edge in a connection.

Fields
Field Name Description
node - GiftWrapping! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": GiftWrapping,
  "cursor": "xyz789"
}
Types

ID

Description

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
"4"
Types

Image

Description

Image

Fields
Field Name Description
url - String! Absolute path to image using store CDN.
Arguments
width - Int!

Desired width of the image.

height - Int

Desired height of the image.
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": "abc123",
  "altText": "abc123",
  "isDefault": true
}
Types

ImageConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [ImageEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [ImageEdge]
}
Types

ImageEdge

Description

An edge in a connection.

Fields
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": "abc123"
}
Types

Int

Description

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

Example
123
Types

Inventory

Description

An inventory

Fields
Field Name Description
locations - InventoryLocationConnection! Locations
Arguments
entityIds - [Int!]

Location ids filter

codes - [String!]

Location codes filter

typeIds - [String!]

Location type ids filter

serviceTypeIds - [String!]

Location service type ids filter

distanceFilter - DistanceFilter

Filter locations by the distance

countryCodes - [countryCode!]

Location country codes filter

states - [String!]

Location states filter

cities - [String!]

Location cities filter

before - String
after - String
first - Int
last - Int
Example
{"locations": InventoryLocationConnection}
Types

InventoryAddress

Description

Address

Fields
Field Name Description
entityId - Int! Address id.
code - String! Address code.
label - String! Address label.
description - String Address description.
address1 - String! Address line1.
address2 - String! Address line2.
city - String! Address city.
stateOrProvince - String! Address state.
countryCode - String! Country code.
postalCode - String! Address zip.
phone - String! Address phone.
email - String! Address email.
latitude - Float Address latitude.
longitude - Float Address longitude.
Example
{
  "entityId": 123,
  "code": "xyz789",
  "label": "abc123",
  "description": "xyz789",
  "address1": "xyz789",
  "address2": "xyz789",
  "city": "xyz789",
  "stateOrProvince": "xyz789",
  "countryCode": "abc123",
  "postalCode": "abc123",
  "phone": "xyz789",
  "email": "abc123",
  "latitude": 123.45,
  "longitude": 987.65
}
Types

InventoryByLocations

Description

Inventory By Locations

Fields
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": {},
  "availableToSell": {},
  "warningLevel": 987,
  "isInStock": true,
  "locationDistance": Distance,
  "locationEntityTypeId": "abc123",
  "locationEntityServiceTypeIds": [
    "xyz789"
  ],
  "locationEntityCode": "xyz789"
}
Types

InventoryLocation

Description

Location

Fields
Field Name Description
entityId - Int! Location id.
code - String! Location code.
label - String! Location label.
description - String Location description.
typeId - String Location type id.
serviceTypeIds - [String!]! Location service type ids. Deprecated. Will be substituted with pickup methods.
address - InventoryAddress Location address
operatingHours - OperatingHours Location OperatingHours
distance - Distance Distance between location and specified longitude and latitude
blackoutHours - [SpecialHour!]! Upcoming events Deprecated. Use specialHours instead
specialHours - [SpecialHour!]! Upcoming events
timeZone - String Time zone of location
metafields - MetafieldConnection! Metafield data related to a location.
Arguments
namespace - String!

Metafield namespace filter

keys - [String!]

Labels for identifying metafield data values.

before - String
after - String
first - Int
last - Int
Example
{
  "entityId": 987,
  "code": "xyz789",
  "label": "abc123",
  "description": "abc123",
  "typeId": "abc123",
  "serviceTypeIds": ["xyz789"],
  "address": InventoryAddress,
  "operatingHours": OperatingHours,
  "distance": Distance,
  "blackoutHours": [SpecialHour],
  "specialHours": [SpecialHour],
  "timeZone": "xyz789",
  "metafields": MetafieldConnection
}
Types

InventoryLocationConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [InventoryLocationEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [InventoryLocationEdge]
}
Types

InventoryLocationEdge

Description

An edge in a connection.

Fields
Field Name Description
node - InventoryLocation! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": InventoryLocation,
  "cursor": "abc123"
}
Types

InventorySettings

Description

Inventory settings from control panel.

Fields
Field Name Description
productOutOfStockBehavior - ProductOutOfStockBehavior The product out of stock behavior.
optionOutOfStockBehavior - OptionOutOfStockBehavior The option out of stock behavior.
stockLevelDisplay - StockLevelDisplay Hide or show inventory node for product
defaultOutOfStockMessage - String! Out of stock message.
hideInProductFiltering - Boolean! Flag to show or not on product filtering when option is out of stock
showPreOrderStockLevels - Boolean! Show pre-order inventory
showOutOfStockMessage - Boolean! Show out of stock message on product listing pages
updateStockBehavior - UpdateStockBehavior The behavior to use to update stock levels.
Example
{
  "productOutOfStockBehavior": "DO_NOTHING",
  "optionOutOfStockBehavior": "DO_NOTHING",
  "stockLevelDisplay": "DONT_SHOW",
  "defaultOutOfStockMessage": "abc123",
  "hideInProductFiltering": false,
  "showPreOrderStockLevels": true,
  "showOutOfStockMessage": false,
  "updateStockBehavior": "ORDER_COMPLETED_OR_SHIPPED"
}
Types

LengthUnit

Description

length unit

Values
Enum Value Description

Kilometres

Miles
Example
"Kilometres"
Types

LimitDateOption

Description

Limit date by

Values
Enum Value Description

EARLIEST_DATE

LATEST_DATE

NO_LIMIT

RANGE
Example
"EARLIEST_DATE"
Types

LimitInputBy

Description

Limit numbers by several options.

Values
Enum Value Description

HIGHEST_VALUE

LOWEST_VALUE

NO_LIMIT

RANGE
Example
"HIGHEST_VALUE"
Types

LocationConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [LocationEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [LocationEdge]
}
Types

LocationEdge

Description

An edge in a connection.

Fields
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": "xyz789"
}
Types

LoginResult

Description

Login result

Fields
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

Description

Logo field

Fields
Field Name Description
title - String! Logo title.
image - Image! Store logo image.
Example
{
  "title": "xyz789",
  "image": Image
}
Types

LogoutResult

Description

Logout result

Fields
Field Name Description
result - String! The result of a logout
Example
{"result": "abc123"}
Types

Long

Description

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

Example
{}
Types

ManualRedirect

Description

Redirect to manually input url.

Fields
Field Name Description
url - String! Url.
Example
{"url": "abc123"}
Types

Measurement

Description

Measurement

Fields
Field Name Description
value - Float! Unformatted weight measurement value.
unit - String! Unit of measurement.
Example
{"value": 123.45, "unit": "abc123"}
Types

MetafieldConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [MetafieldEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [MetafieldEdge]
}
Types

MetafieldEdge

Description

An edge in a connection.

Fields
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

Description

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

Fields
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": "4",
  "entityId": 987,
  "key": "abc123",
  "value": "abc123"
}
Types

Money

Description

A money object - includes currency code and a money amount

Fields
Field Name Description
currencyCode - String! Currency code of the current money.
value - BigDecimal! The amount of money.
formatted - String The formatted currency string for the current money. Deprecated. Don't use - it will be removed soon.
Example
{
  "currencyCode": "xyz789",
  "value": BigDecimal,
  "formatted": "xyz789"
}
Types

MoneyRange

Description

A min and max pair of money objects

Fields
Field Name Description
min - Money! Minimum money object.
max - Money! Maximum money object.
Example
{"min": Money, "max": Money}
Types

MultiLineTextFieldOption

Description

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

Fields
Field Name Description
defaultValue - String Default value of the multiline text field option.
minLength - Int The minimum number of characters.
maxLength - Int The maximum number of characters.
maxLines - Int The maximum number of lines.
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.
isVariantOption - Boolean! Indicates whether it is a variant option or modifier.
Example
{
  "defaultValue": "abc123",
  "minLength": 987,
  "maxLength": 123,
  "maxLines": 987,
  "entityId": 123,
  "displayName": "abc123",
  "isRequired": false,
  "isVariantOption": true
}
Types

MultipleChoiceOption

Description

An option type that has a fixed list of values.

Fields
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.
isVariantOption - Boolean! Indicates whether it is a variant option or modifier.
Example
{
  "displayStyle": "abc123",
  "values": ProductOptionValueConnection,
  "entityId": 123,
  "displayName": "abc123",
  "isRequired": true,
  "isVariantOption": false
}
Types

MultipleChoiceOptionValue

Description

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

Fields
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.
isSelected - Boolean Indicates whether this value is selected based on sku/variantEntityId/optionValueIds overlay requested on the product node level.
Example
{
  "entityId": 987,
  "label": "xyz789",
  "isDefault": true,
  "isSelected": true
}
Types

Node

Description

An object with an ID

Fields
Field Name Description
id - ID! The id of the object.
Possible Types
Node Types

Banner

Blog

BlogPost

Brand

Cart

Category

Checkout

ContactPage

NormalPage

Product

RawHtmlPage

Redirect

Variant
Example
{"id": "4"}
Types

NormalPage

Description

A normal page.

Fields
Field Name Description
id - ID! The ID of an object
path - String! The URL path of the page.
htmlBody - String! The body of the page.
plainTextSummary - String! The plain text summary of the page body.
Arguments
characterLimit - Int

The max number of characters for the plain text summary.
renderedRegions - RenderedRegionsByPageType! The rendered regions for the web page.
entityId - Int! Unique ID for the web page.
parentEntityId - Int Unique ID for the parent page.
name - String! Page name.
isVisibleInNavigation - Boolean! Whether or not the page should be visible in the navigation menu.
seo - SeoDetails! Page SEO details.
Example
{
  "id": 4,
  "path": "abc123",
  "htmlBody": "xyz789",
  "plainTextSummary": "abc123",
  "renderedRegions": RenderedRegionsByPageType,
  "entityId": 123,
  "parentEntityId": 987,
  "name": "xyz789",
  "isVisibleInNavigation": false,
  "seo": SeoDetails
}
Types

NumberFieldOption

Description

A single line text input field that only accepts numbers.

Fields
Field Name Description
defaultValue - Float Default value of the text field option.
lowest - Float The bottom limit of possible numbers.
highest - Float The top limit of possible numbers.
isIntegerOnly - Boolean! Allow whole numbers only.
limitNumberBy - LimitInputBy! Limit numbers by several options.
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.
isVariantOption - Boolean! Indicates whether it is a variant option or modifier.
Example
{
  "defaultValue": 987.65,
  "lowest": 123.45,
  "highest": 123.45,
  "isIntegerOnly": false,
  "limitNumberBy": "HIGHEST_VALUE",
  "entityId": 987,
  "displayName": "xyz789",
  "isRequired": false,
  "isVariantOption": false
}
Types

OperatingDay

Description

Operating day

Fields
Field Name Description
open - Boolean! Open.
opening - String! Opening.
closing - String! Closing.
Example
{
  "open": false,
  "opening": "xyz789",
  "closing": "xyz789"
}
Types

OperatingHours

Description

Operating hours

Fields
Field Name Description
sunday - OperatingDay Sunday.
monday - OperatingDay Monday.
tuesday - OperatingDay Tuesday.
wednesday - OperatingDay Wednesday.
thursday - OperatingDay Thursday.
friday - OperatingDay Friday.
saturday - OperatingDay Saturday.
Example
{
  "sunday": OperatingDay,
  "monday": OperatingDay,
  "tuesday": OperatingDay,
  "wednesday": OperatingDay,
  "thursday": OperatingDay,
  "friday": OperatingDay,
  "saturday": OperatingDay
}
Types

OptionConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [OptionEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [OptionEdge]
}
Types

OptionEdge

Description

An edge in a connection.

Fields
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": "abc123"
}
Types

OptionOutOfStockBehavior

Description

Behavior of the variant when stock is equal to 0

Values
Enum Value Description

DO_NOTHING

HIDE_OPTION

LABEL_OPTION
Example
"DO_NOTHING"
Types

OptionValueConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [OptionValueEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [OptionValueEdge]
}
Types

OptionValueEdge

Description

An edge in a connection.

Fields
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": "xyz789"
}
Types

OptionValueId

Description

A variant option value id input object

Fields
Input Field Description
optionEntityId - Int! A variant option id filter
valueEntityId - Int! A variant value id filter.
Example
{"optionEntityId": 987, "valueEntityId": 123}
Types

Order

Description

The order.

Fields
Field Name Description
entityId - Int! Order ID.
Example
{"entityId": 123}
Types

OtherSearchFilter

Description

Other Filter

Fields
Field Name Description
displayProductCount - Boolean! Indicates whether to display product count next to the filter.
freeShipping - OtherSearchFilterItem Free shipping filter.
isFeatured - OtherSearchFilterItem Is Featured filter.
isInStock - OtherSearchFilterItem Is In Stock filter.
name - String! Display name for the filter.
isCollapsedByDefault - Boolean! Indicates whether filter is collapsed by default.
Example
{
  "displayProductCount": true,
  "freeShipping": OtherSearchFilterItem,
  "isFeatured": OtherSearchFilterItem,
  "isInStock": OtherSearchFilterItem,
  "name": "abc123",
  "isCollapsedByDefault": false
}
Types

OtherSearchFilterItem

Description

Other Filter Item

Fields
Field Name Description
isSelected - Boolean! Indicates whether this filter is selected.
productCount - Int! Indicates how many products available for this filter.
Example
{"isSelected": true, "productCount": 987}
Types

PageConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [PageEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [PageEdge]
}
Types

PageEdge

Description

An edge in a connection.

Fields
Field Name Description
node - WebPage! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": WebPage,
  "cursor": "abc123"
}
Types

PageInfo

Description

Information about pagination in a connection.

Fields
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": true,
  "startCursor": "xyz789",
  "endCursor": "abc123"
}
Types

PageRedirect

Description

Redirect to a page.

Fields
Field Name Description
id - ID! The ID of an object.
entityId - Int! Entity id.
path - String! Relative destination url.
Example
{
  "id": "4",
  "entityId": 123,
  "path": "xyz789"
}
Types

PageType

Description

Page type

Values
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
Example
"ACCOUNT_ADDRESS"
Types

PopularBrandConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [PopularBrandEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [PopularBrandEdge]
}
Types

PopularBrandEdge

Description

An edge in a connection.

Fields
Field Name Description
node - PopularBrandType! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": PopularBrandType,
  "cursor": "xyz789"
}
Types

PopularBrandType

Description

PopularBrandType

Fields
Field Name Description
entityId - Int! Brand id
count - Int! Brand count
name - String! Brand name
path - String Brand URL as a relative path
Example
{
  "entityId": 987,
  "count": 987,
  "name": "xyz789",
  "path": "xyz789"
}
Types

PriceRanges

Description

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

Fields
Field Name Description
priceRange - MoneyRange! Product price min/max range.
retailPriceRange - MoneyRange Product retail price min/max range.
Example
{
  "priceRange": MoneyRange,
  "retailPriceRange": MoneyRange
}
Types

PriceSearchFilter

Description

Price Filter

Fields
Field Name Description
selected - PriceSearchFilterItem Selected price filters.
name - String! Display name for the filter.
isCollapsedByDefault - Boolean! Indicates whether filter is collapsed by default.
Example
{
  "selected": PriceSearchFilterItem,
  "name": "xyz789",
  "isCollapsedByDefault": false
}
Types

PriceSearchFilterInput

Description

Search by price range. At least a minPrice or maxPrice must be supplied.

Fields
Input Field Description
minPrice - Float Minimum price of the product.
maxPrice - Float Maximum price of the product.
Example
{"minPrice": 987.65, "maxPrice": 123.45}
Types

PriceSearchFilterItem

Description

Price filter range

Fields
Field Name Description
minPrice - Float Minimum price of the product.
maxPrice - Float Maximum price of the product.
Example
{"minPrice": 123.45, "maxPrice": 987.65}
Types

Prices

Description

The various prices that can be set on a product.

Fields
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.
bulkPricing - [BulkPricingTier!]! List of bulk pricing tiers applicable to a product or variant.
Example
{
  "price": Money,
  "salePrice": Money,
  "basePrice": Money,
  "retailPrice": Money,
  "mapPrice": Money,
  "priceRange": MoneyRange,
  "retailPriceRange": MoneyRange,
  "saved": Money,
  "bulkPricing": [BulkPricingTier]
}
Types

Product

Description

Product

Fields
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

The max number of characters for the description.
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

Tax will be included if enabled

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

Tax will be included if enabled
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. Use productOptions instead.
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.
availabilityV2 - ProductAvailability! The availability state of the product.
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
isPurchasable - Boolean

Whether the product can be purchased

entityIds - [Int!]

Ids of expected variants.

optionValueIds - [OptionValueId!]

A variant option value ids filter.
customFields - CustomFieldConnection! Custom fields of the product.
Arguments
names - [String!]

Product custom fields filter by names.

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
hideOutOfStock - Boolean

When set to True, hides products which are out of stock. Defaults to False. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.
inventory - ProductInventory! Inventory information of the product.
metafields - MetafieldConnection! Metafield data related to a product.
Arguments
namespace - String!

Metafield namespace filter

keys - [String!]

Labels for identifying metafield data values.

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

Product reviews sorting.

filters - ProductReviewsFiltersInput

Product reviews filters.

before - String
after - String
first - Int
last - Int
seo - SeoDetails! Product SEO details.
giftWrappingOptions - GiftWrappingConnection! Gift wrapping options available for the product.
Arguments
before - String
after - String
first - Int
last - Int
condition - ProductConditionType Product condition
showCartAction - Boolean! Whether or not the cart call to action should be visible for this product.
Example
{
  "id": 4,
  "entityId": 987,
  "sku": "xyz789",
  "path": "xyz789",
  "name": "abc123",
  "description": "xyz789",
  "plainTextDescription": "abc123",
  "warranty": "abc123",
  "minPurchaseQuantity": 123,
  "maxPurchaseQuantity": 123,
  "addToCartUrl": "xyz789",
  "addToWishlistUrl": "xyz789",
  "prices": Prices,
  "priceRanges": PriceRanges,
  "weight": Measurement,
  "height": Measurement,
  "width": Measurement,
  "depth": Measurement,
  "options": OptionConnection,
  "productOptions": ProductOptionConnection,
  "reviewSummary": Reviews,
  "type": "xyz789",
  "availability": "abc123",
  "availabilityDescription": "xyz789",
  "availabilityV2": ProductAvailability,
  "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,
  "giftWrappingOptions": GiftWrappingConnection,
  "condition": "NEW",
  "showCartAction": true
}
Types

ProductAttributeSearchFilter

Description

Product Attribute Filter

Fields
Field Name Description
displayProductCount - Boolean! Indicates whether to display product count next to the filter.
filterName - String! Filter name for building filter URLs
attributes - ProductAttributeSearchFilterItemConnection! List of available product attributes.
Arguments
before - String
after - String
first - Int
last - Int
name - String! Display name for the filter.
isCollapsedByDefault - Boolean! Indicates whether filter is collapsed by default.
Example
{
  "displayProductCount": false,
  "filterName": "xyz789",
  "attributes": ProductAttributeSearchFilterItemConnection,
  "name": "abc123",
  "isCollapsedByDefault": false
}
Types

ProductAttributeSearchFilterInput

Description

Filter by the attributes of products such as Product Options and Product Custom Fields. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.

Fields
Input Field Description
attribute - String! Product attributes
values - [String!]! Product attribute values
Example
{
  "attribute": "abc123",
  "values": ["xyz789"]
}
Types

ProductAttributeSearchFilterItem

Description

Specific product attribute filter item

Fields
Field Name Description
value - String! Product attribute value.
isSelected - Boolean! Indicates whether product attribute is selected.
productCount - Int! Indicates how many products available for this filter.
Example
{
  "value": "abc123",
  "isSelected": false,
  "productCount": 123
}
Types

ProductAttributeSearchFilterItemConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [ProductAttributeSearchFilterItemEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [ProductAttributeSearchFilterItemEdge]
}
Types

ProductAttributeSearchFilterItemEdge

Description

An edge in a connection.

Fields
Field Name Description
node - ProductAttributeSearchFilterItem! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": ProductAttributeSearchFilterItem,
  "cursor": "xyz789"
}
Types

ProductAvailability

Description

Product availability

Fields
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'.
Possible Types
ProductAvailability Types

ProductAvailable

ProductPreOrder

ProductUnavailable
Example
{
  "status": "Available",
  "description": "abc123"
}
Types

ProductAvailabilityStatus

Description

Product availability status

Values
Enum Value Description

Available

Preorder

Unavailable
Example
"Available"
Types

ProductAvailable

Description

Available Product

Fields
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": "Available",
  "description": "xyz789"
}
Types

ProductConditionType

Description

Product condition

Values
Enum Value Description

NEW

REFURBISHED

USED
Example
"NEW"
Types

ProductConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [ProductEdge] A list of edges.
collectionInfo - CollectionInfo Collection info
Example
{
  "pageInfo": PageInfo,
  "edges": [ProductEdge],
  "collectionInfo": CollectionInfo
}
Types

ProductEdge

Description

An edge in a connection.

Fields
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": "xyz789"
}
Types

ProductInventory

Description

Product Inventory Information

Fields
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

Description

Product Option

Fields
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": 123,
  "displayName": "abc123",
  "isRequired": true,
  "values": OptionValueConnection
}
Types

ProductOptionConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [ProductOptionEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [ProductOptionEdge]
}
Types

ProductOptionEdge

Description

An edge in a connection.

Fields
Field Name Description
node - CatalogProductOption! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": CatalogProductOption,
  "cursor": "xyz789"
}
Types

ProductOptionValue

Description

Product Option Value

Fields
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

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [ProductOptionValueEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [ProductOptionValueEdge]
}
Types

ProductOptionValueEdge

Description

An edge in a connection.

Fields
Field Name Description
node - CatalogProductOptionValue! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": CatalogProductOptionValue,
  "cursor": "abc123"
}
Types

ProductOutOfStockBehavior

Description

Behavior of the product when stock is equal to 0

Values
Enum Value Description

DO_NOTHING

HIDE_PRODUCT

HIDE_PRODUCT_AND_ACCESSIBLE

HIDE_PRODUCT_AND_REDIRECT
Example
"DO_NOTHING"
Types

ProductPickListOptionValue

Description

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

Fields
Field Name Description
productId - Int! The ID of the product associated with this option value.
defaultImage - Image Default image for a pick list product.
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.
isSelected - Boolean Indicates whether this value is selected based on sku/variantEntityId/optionValueIds overlay requested on the product node level.
Example
{
  "productId": 987,
  "defaultImage": Image,
  "entityId": 123,
  "label": "xyz789",
  "isDefault": true,
  "isSelected": true
}
Types

ProductPreOrder

Description

PreOrder Product

Fields
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": "Available",
  "description": "xyz789"
}
Types

ProductRedirect

Description

Redirect to a product.

Fields
Field Name Description
id - ID! The ID of an object.
entityId - Int! Entity id.
path - String! Relative destination url.
Example
{
  "id": "4",
  "entityId": 123,
  "path": "xyz789"
}
Types

ProductReviewsFiltersInput

Description

Product reviews filters.

Fields
Input Field Description
rating - ProductReviewsRatingFilterInput Product reviews filter by rating.
Example
{"rating": ProductReviewsRatingFilterInput}
Types

ProductReviewsRatingFilterInput

Description

Product reviews filter by rating.

Fields
Input Field Description
minRating - Int Minimum rating of the product.
maxRating - Int Maximum rating of the product.
Example
{"minRating": 123, "maxRating": 987}
Types

ProductReviewsSortInput

Description

Product reviews sorting.

Values
Enum Value Description

HIGHEST_RATING

LOWEST_RATING

NEWEST

OLDEST
Example
"HIGHEST_RATING"
Types

ProductUnavailable

Description

Unavailable Product

Fields
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": "Available",
  "description": "abc123"
}
Types

PublicWishlist

Description

Public Wishlist

Fields
Field Name Description
entityId - Int! The wishlist id.
name - String! The wishlist name.
token - String! The wishlist token.
items - WishlistItemConnection! A list of the wishlist items
Arguments
hideOutOfStock - Boolean

When set to True, hides products which are out of stock. Defaults to False. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.

before - String
after - String
first - Int
last - Int
Example
{
  "entityId": 987,
  "name": "xyz789",
  "token": "abc123",
  "items": WishlistItemConnection
}
Types

RatingSearchFilter

Description

Rating Filter

Fields
Field Name Description
ratings - RatingSearchFilterItemConnection! List of available ratings.
Arguments
before - String
after - String
first - Int
last - Int
name - String! Display name for the filter.
isCollapsedByDefault - Boolean! Indicates whether filter is collapsed by default.
Example
{
  "ratings": RatingSearchFilterItemConnection,
  "name": "xyz789",
  "isCollapsedByDefault": true
}
Types

RatingSearchFilterInput

Description

Filter by rating. At least a minRating or maxRating must be supplied. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.

Fields
Input Field Description
minRating - Float Minimum rating of the product.
maxRating - Float Maximum rating of the product.
Example
{"minRating": 123.45, "maxRating": 123.45}
Types

RatingSearchFilterItem

Description

Specific rating filter item

Fields
Field Name Description
value - String! Rating value.
isSelected - Boolean! Indicates whether rating is selected.
productCount - Int! Indicates how many products available for this filter.
Example
{
  "value": "xyz789",
  "isSelected": true,
  "productCount": 987
}
Types

RatingSearchFilterItemConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [RatingSearchFilterItemEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [RatingSearchFilterItemEdge]
}
Types

RatingSearchFilterItemEdge

Description

An edge in a connection.

Fields
Field Name Description
node - RatingSearchFilterItem! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": RatingSearchFilterItem,
  "cursor": "xyz789"
}
Types

RawHtmlPage

Description

A raw HTML page.

Fields
Field Name Description
id - ID! The ID of an object
path - String! The URL path of the page.
htmlBody - String! The body of the page.
plainTextSummary - String! The plain text summary of the page body.
Arguments
characterLimit - Int

The max number of characters for the plain text summary.
entityId - Int! Unique ID for the web page.
parentEntityId - Int Unique ID for the parent page.
name - String! Page name.
isVisibleInNavigation - Boolean! Whether or not the page should be visible in the navigation menu.
seo - SeoDetails! Page SEO details.
Example
{
  "id": "4",
  "path": "abc123",
  "htmlBody": "xyz789",
  "plainTextSummary": "abc123",
  "entityId": 123,
  "parentEntityId": 987,
  "name": "abc123",
  "isVisibleInNavigation": false,
  "seo": SeoDetails
}
Types

ReCaptchaSettings

Description

ReCaptcha settings.

Fields
Field Name Description
siteKey - String! ReCaptcha site key.
Example
{"siteKey": "xyz789"}
Types

Redirect

Description

Redirect.

Fields
Field Name Description
id - ID! The ID of an object.
fromPath - String! Redirected url.
to - RedirectTo! Additional information about redirect.
toUrl - String! Full destination url.
Example
{
  "id": "4",
  "fromPath": "xyz789",
  "to": ManualRedirect,
  "toUrl": "xyz789"
}
Types

RedirectTo

Description

Type of the redirect.

Types
Union Types

ManualRedirect

ProductRedirect

BrandRedirect

BlogPostRedirect

CategoryRedirect

PageRedirect
Example
ManualRedirect
Types

Region

Description

The region object

Fields
Field Name Description
name - String! The name of a region.
html - String! The rendered HTML content targeted at the region.
Example
{
  "name": "abc123",
  "html": "abc123"
}
Types

RelatedProductsConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [RelatedProductsEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [RelatedProductsEdge]
}
Types

RelatedProductsEdge

Description

An edge in a connection.

Fields
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": "xyz789"
}
Types

RenderedRegionsByPageType

Description

The rendered regions by specific page.

Fields
Field Name Description
regions - [Region!]! List of regions
Example
{"regions": [Region]}
Types

Review

Description

Review

Fields
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": {},
  "author": Author,
  "title": "xyz789",
  "text": "abc123",
  "rating": 123,
  "createdAt": DateTimeExtended
}
Types

ReviewConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [ReviewEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [ReviewEdge]
}
Types

ReviewEdge

Description

An edge in a connection.

Fields
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

Description

Review Rating Summary

Fields
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": 123.45, "numberOfReviews": 987, "summationOfRatings": 123}
Types

Route

Description

route

Fields
Field Name Description
node - Node Node
Example
{"node": Node}
Types

SearchProductFilter

Description

Search Product Filter

Fields
Field Name Description
name - String! Display name for the filter.
isCollapsedByDefault - Boolean! Indicates whether filter is collapsed by default.
Possible Types
SearchProductFilter Types

BrandSearchFilter

CategorySearchFilter

OtherSearchFilter

PriceSearchFilter

ProductAttributeSearchFilter

RatingSearchFilter
Example
{
  "name": "abc123",
  "isCollapsedByDefault": false
}
Types

SearchProductFilterConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [SearchProductFilterEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [SearchProductFilterEdge]
}
Types

SearchProductFilterEdge

Description

An edge in a connection.

Fields
Field Name Description
node - SearchProductFilter! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": SearchProductFilter,
  "cursor": "xyz789"
}
Types

SearchProducts

Description

Container for catalog search results, which may contain both products as well as a list of search filters for further refinement.

Fields
Field Name Description
products - ProductConnection! Details of the products.
Arguments
after - String
first - Int
filters - SearchProductFilterConnection! Available product filters.
Arguments
before - String
after - String
first - Int
last - Int
Example
{
  "products": ProductConnection,
  "filters": SearchProductFilterConnection
}
Types

SearchProductsFiltersInput

Description

Object containing available search filters for use when querying Products.

Fields
Input Field Description
searchTerm - String Textual search term. Used to search for products based on text entered by a shopper, typically in a search box. Searches against several fields on the product including Name, SKU, and Description.
price - PriceSearchFilterInput Search by price range. At least a minPrice or maxPrice must be supplied.
rating - RatingSearchFilterInput Filter by rating. At least a minRating or maxRating must be supplied. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.
categoryEntityId - Int Filter by products belonging to a single Category. This is intended for use when presenting a Category page in a PLP experience. This argument must be used in order for custom product sorts and custom product filtering settings targeted at a particular category to take effect.
categoryEntityIds - [Int!] Filter by products belonging to any of the specified Categories. Intended for Advanced Search and Faceted Search/Product Filtering use cases, not for a page for a specific Category.
searchSubCategories - Boolean Boolean argument to determine whether products within sub-Categories will be returned when filtering products by Category. Defaults to False if not supplied.
brandEntityIds - [Int!] Filter by products belonging to any of the specified Brands.
productAttributes - [ProductAttributeSearchFilterInput!] Filter by the attributes of products such as Product Options and Product Custom Fields. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.
isFreeShipping - Boolean Filters by Products which have explicit Free Shipping configured within the catalog. If not supplied, the Free Shipping status of products will not be considered when returning the list of products.
isFeatured - Boolean Filters by Products which have explicitly been marked as Featured within the catalog. If not supplied, the Featured status of products will not be considered when returning the list of products.
hideOutOfStock - Boolean When set to True, hides products which are out of stock. Defaults to False. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.
Example
{
  "searchTerm": "abc123",
  "price": PriceSearchFilterInput,
  "rating": RatingSearchFilterInput,
  "categoryEntityId": 123,
  "categoryEntityIds": [123],
  "searchSubCategories": false,
  "brandEntityIds": [987],
  "productAttributes": [
    ProductAttributeSearchFilterInput
  ],
  "isFreeShipping": false,
  "isFeatured": true,
  "hideOutOfStock": false
}
Types

SearchProductsSortInput

Description

Sort to use for the product results. Relevance is the default for textual search terms, and “Featured” is the default for category page contexts without a search term.

Values
Enum Value Description

A_TO_Z

BEST_REVIEWED

BEST_SELLING

FEATURED

HIGHEST_PRICE

LOWEST_PRICE

NEWEST

RELEVANCE

Z_TO_A
Example
"A_TO_Z"
Types

SearchQueries

Description

The Search queries.

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

Available search filters for use when querying products

sort - SearchProductsSortInput

The results are sorted by relevance if the sort argument is not provided.
Example
{"searchProducts": SearchProducts}
Types

SelectCheckoutShippingOptionDataInput

Description

Select checkout shipping option input data object

Fields
Input Field Description
shippingOptionEntityId - String! The shipping option id
Example
{"shippingOptionEntityId": "abc123"}
Types

SelectCheckoutShippingOptionInput

Description

Select checkout shipping option input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
consignmentEntityId - String! The consignment id
data - SelectCheckoutShippingOptionDataInput! Select checkout shipping option data object
Example
{
  "checkoutEntityId": "abc123",
  "consignmentEntityId": "xyz789",
  "data": SelectCheckoutShippingOptionDataInput
}
Types

SelectCheckoutShippingOptionResult

Description

Select checkout shipping option result

Fields
Field Name Description
checkout - Checkout The Checkout that is updated as a result of mutation.
Example
{"checkout": Checkout}
Types

SeoDetails

Description

Seo Details

Fields
Field Name Description
pageTitle - String! Page title.
metaDescription - String! Meta description.
metaKeywords - String! Meta keywords.
Example
{
  "pageTitle": "xyz789",
  "metaDescription": "abc123",
  "metaKeywords": "abc123"
}
Types

Settings

Description

Store settings information from the control panel.

Fields
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. Use logoV2 instead.
logoV2 - StoreLogo! 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 The tax display settings object
search - Search! Store search settings.
storefront - Storefront! Storefront settings.
inventory - InventorySettings Inventory settings.
reCaptcha - ReCaptchaSettings! ReCaptcha settings.
socialMediaLinks - [SocialMediaLink!]! The social media links of connected platforms to the storefront.
checkout - CheckoutSettings Checkout settings.
Example
{
  "storeName": "xyz789",
  "storeHash": "abc123",
  "status": "HIBERNATION",
  "logo": LogoField,
  "logoV2": StoreTextLogo,
  "contact": ContactField,
  "url": UrlField,
  "display": DisplayField,
  "channelId": {},
  "tax": TaxDisplaySettings,
  "search": Search,
  "storefront": Storefront,
  "inventory": InventorySettings,
  "reCaptcha": ReCaptchaSettings,
  "socialMediaLinks": [SocialMediaLink],
  "checkout": CheckoutSettings
}
Types

ShopByPriceConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [ShopByPriceEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [ShopByPriceEdge]
}
Types

ShopByPriceEdge

Description

An edge in a connection.

Fields
Field Name Description
node - ShopByPriceRange! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": ShopByPriceRange,
  "cursor": "xyz789"
}
Types

ShopByPriceRange

Description

Category shop by price money ranges

Fields
Field Name Description
ranges - MoneyRange! Category shop by price range.
Example
{"ranges": MoneyRange}
Types

Site

Description

A site

Fields
Field Name Description
search - SearchQueries! The Search queries.
categoryTree - [CategoryTreeItem!]! A tree of categories.
Arguments
rootEntityId - Int

A root category ID to be used to load the tree starting from a particular branch. If not supplied, starts at the top of the tree.
category - Category Retrieve a category object by the id.
Arguments
entityId - Int!

The category id
brands - BrandConnection! Details of the brand.
Arguments
before - String
after - String
first - Int
last - Int
productEntityIds - [Int!]

Filter by brands belonging to any of the specified Products.

entityIds - [Int!]

Filter by brand ids.
products - ProductConnection! Details of the products.
Arguments
before - String
after - String
first - Int
last - Int
ids - [ID!]

Global ids of expected products.

entityIds - [Int!]

Ids of expected products.

hideOutOfStock - Boolean

When set to True, hides products which are out of stock. Defaults to False. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.
newestProducts - ProductConnection! Details of the newest products.
Arguments
before - String
after - String
first - Int
last - Int
hideOutOfStock - Boolean

When set to True, hides products which are out of stock. Defaults to False. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.
bestSellingProducts - ProductConnection! Details of the best selling products.
Arguments
before - String
after - String
first - Int
last - Int
hideOutOfStock - Boolean

When set to True, hides products which are out of stock. Defaults to False. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.
featuredProducts - ProductConnection! Details of the featured products.
Arguments
before - String
after - String
first - Int
last - Int
hideOutOfStock - Boolean

When set to True, hides products which are out of stock. Defaults to False. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.
product - Product A single product object with variant pricing overlay capabilities.
Arguments
id - ID

Product global id filter.

entityId - Int

Product id filter.

variantEntityId - Int

Product filter by variant id.

optionValueIds - [OptionValueId!]

A variant option value ids filter.

sku - String

Product filter by sku.

useDefaultOptionSelections - Boolean

When set to True, returns products with default option selection overlay if one exists. Otherwise returns a base product. Defaults to False
route - Route! Route for a node
Arguments
path - String!

An url path to an expected entity.
settings - Settings Store settings.
content - Content! The page content.
currency - Currency Currency details.
Arguments
currencyCode - currencyCode!

Currency Code
currencies - CurrencyConnection! Store Currencies.
Arguments
before - String
after - String
first - Int
last - Int
publicWishlist - PublicWishlist Public Wishlist
Arguments
token - String!

A wishlist token filter
popularBrands - PopularBrandConnection! List of brands sorted by product count.
Arguments
before - String
after - String
first - Int
last - Int
cart - Cart The Cart of the current customer.
Arguments
entityId - String

Cart ID.
checkout - Checkout The checkout of the current customer.
Arguments
entityId - String

Checkout ID.
Example
{
  "search": SearchQueries,
  "categoryTree": [CategoryTreeItem],
  "category": Category,
  "brands": BrandConnection,
  "products": ProductConnection,
  "newestProducts": ProductConnection,
  "bestSellingProducts": ProductConnection,
  "featuredProducts": ProductConnection,
  "product": Product,
  "route": Route,
  "settings": Settings,
  "content": Content,
  "currency": Currency,
  "currencies": CurrencyConnection,
  "publicWishlist": PublicWishlist,
  "popularBrands": PopularBrandConnection,
  "cart": Cart,
  "checkout": Checkout
}
Types

SpecialHour

Description

Special hour

Fields
Field Name Description
label - String! Upcoming event name
open - Boolean! Is open
opening - DateTime Opening time
closing - DateTime Closing time
Example
{
  "label": "abc123",
  "open": true,
  "opening": "2007-12-03T10:15:30Z",
  "closing": "2007-12-03T10:15:30Z"
}
Types

StockLevelDisplay

Description

Stock level display setting

Values
Enum Value Description

DONT_SHOW

SHOW

SHOW_WHEN_LOW
Example
"DONT_SHOW"
Types

Storefront

Description

Storefront settings.

Fields
Field Name Description
catalog - Catalog Storefront catalog settings.
Example
{"catalog": Catalog}
Types

StorefrontStatusType

Description

Storefront Mode

Values
Enum Value Description

HIBERNATION

LAUNCHED

MAINTENANCE

PRE_LAUNCH
Example
"HIBERNATION"
Types

String

Description

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.

Example
"abc123"
Types

SubCategorySearchFilterItem

Description

Specific sub-category filter item

Fields
Field Name Description
entityId - Int! Category ID.
name - String! Category name.
isSelected - Boolean! Indicates whether category is selected.
productCount - Int! Indicates how many products available for this filter.
subCategories - SubCategorySearchFilterItemConnection! List of available sub-categories.
Arguments
before - String
after - String
first - Int
last - Int
Example
{
  "entityId": 123,
  "name": "abc123",
  "isSelected": false,
  "productCount": 123,
  "subCategories": SubCategorySearchFilterItemConnection
}
Types

SubCategorySearchFilterItemConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [SubCategorySearchFilterItemEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [SubCategorySearchFilterItemEdge]
}
Types

SubCategorySearchFilterItemEdge

Description

An edge in a connection.

Fields
Field Name Description
node - SubCategorySearchFilterItem! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": SubCategorySearchFilterItem,
  "cursor": "abc123"
}
Types

SwatchOptionValue

Description

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

Fields
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!

Desired width of the image.

height - Int

Desired height of the image.
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.
isSelected - Boolean Indicates whether this value is selected based on sku/variantEntityId/optionValueIds overlay requested on the product node level.
Example
{
  "hexColors": ["abc123"],
  "imageUrl": "abc123",
  "entityId": 987,
  "label": "xyz789",
  "isDefault": true,
  "isSelected": false
}
Types

TaxDisplaySettings

Description

The tax display settings object

Fields
Field Name Description
pdp - TaxPriceDisplay! Tax display setting for Product Details Page.
plp - TaxPriceDisplay! Tax display setting for Product List Page.
Example
{"pdp": "BOTH", "plp": "BOTH"}
Types

TaxPriceDisplay

Description

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

Values
Enum Value Description

BOTH

EX

INC
Example
"BOTH"
Types

TextFieldOption

Description

A single line text input field.

Fields
Field Name Description
defaultValue - String Default value of the text field option.
minLength - Int The minimum number of characters.
maxLength - Int The maximum number of characters.
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.
isVariantOption - Boolean! Indicates whether it is a variant option or modifier.
Example
{
  "defaultValue": "abc123",
  "minLength": 123,
  "maxLength": 987,
  "entityId": 123,
  "displayName": "abc123",
  "isRequired": true,
  "isVariantOption": false
}
Types

UnapplyCheckoutCouponDataInput

Description

Unapply checkout coupon data object

Fields
Input Field Description
couponCode - String! The checkout coupon code
Example
{"couponCode": "xyz789"}
Types

UnapplyCheckoutCouponInput

Description

Unapply checkout coupon input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
data - UnapplyCheckoutCouponDataInput! Unapply checkout coupon data object
Example
{
  "checkoutEntityId": "xyz789",
  "data": UnapplyCheckoutCouponDataInput
}
Types

UnapplyCheckoutCouponResult

Description

Unapply checkout coupon result

Fields
Field Name Description
checkout - Checkout The Checkout that is updated as a result of mutation.
Example
{"checkout": Checkout}
Types

UnassignCartFromCustomerInput

Description

Unassign cart from the customer input object.

Fields
Input Field Description
cartEntityId - String! The cart id.
Example
{"cartEntityId": "xyz789"}
Types

UnassignCartFromCustomerResult

Description

Unassign cart from the customer result.

Fields
Field Name Description
cart - Cart The Cart that is updated as a result of mutation.
Example
{"cart": Cart}
Types

UpdateCartCurrencyDataInput

Description

Update cart currency data object

Fields
Input Field Description
currencyCode - String! ISO-4217 currency code
Example
{"currencyCode": "abc123"}
Types

UpdateCartCurrencyInput

Description

Update cart currency input object

Fields
Input Field Description
cartEntityId - String! The cart id
data - UpdateCartCurrencyDataInput! Update cart currency data object
Example
{
  "cartEntityId": "xyz789",
  "data": UpdateCartCurrencyDataInput
}
Types

UpdateCartCurrencyResult

Description

Update cart currency result

Fields
Field Name Description
cart - Cart The Cart that is updated as a result of mutation.
Example
{"cart": Cart}
Types

UpdateCartLineItemDataInput

Description

Update cart line item data object

Fields
Input Field Description
lineItem - CartLineItemInput The cart line item
giftCertificate - CartGiftCertificateInput The gift certificate
Example
{
  "lineItem": CartLineItemInput,
  "giftCertificate": CartGiftCertificateInput
}
Types

UpdateCartLineItemInput

Description

Update cart line item input object

Fields
Input Field Description
cartEntityId - String! The cart id
lineItemEntityId - String! The line item id
data - UpdateCartLineItemDataInput! Update cart line item data object
Example
{
  "cartEntityId": "xyz789",
  "lineItemEntityId": "xyz789",
  "data": UpdateCartLineItemDataInput
}
Types

UpdateCartLineItemResult

Description

Update cart line item result

Fields
Field Name Description
cart - Cart The Cart that is updated as a result of mutation.
Example
{"cart": Cart}
Types

UpdateCheckoutBillingAddressDataInput

Description

Update checkout billing address data object

Fields
Input Field Description
address - CheckoutAddressInput! The checkout billing address
Example
{"address": CheckoutAddressInput}
Types

UpdateCheckoutBillingAddressInput

Description

Update checkout billing address input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
addressEntityId - String! The address id
data - UpdateCheckoutBillingAddressDataInput! Update checkout billing address data object
Example
{
  "checkoutEntityId": "xyz789",
  "addressEntityId": "abc123",
  "data": UpdateCheckoutBillingAddressDataInput
}
Types

UpdateCheckoutBillingAddressResult

Description

Update checkout billing address result

Fields
Field Name Description
checkout - Checkout The Checkout that is updated as a result of mutation.
Example
{"checkout": Checkout}
Types

UpdateCheckoutCustomerMessageDataInput

Description

Update checkout customer message data object

Fields
Input Field Description
message - String! The checkout customer message
Example
{"message": "xyz789"}
Types

UpdateCheckoutCustomerMessageInput

Description

Update checkout customer message input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
data - UpdateCheckoutCustomerMessageDataInput! Update checkout customer message data object
Example
{
  "checkoutEntityId": "xyz789",
  "data": UpdateCheckoutCustomerMessageDataInput
}
Types

UpdateCheckoutCustomerMessageResult

Description

Update checkout customer message result

Fields
Field Name Description
checkout - Checkout The Checkout that is updated as a result of mutation.
Example
{"checkout": Checkout}
Types

UpdateCheckoutShippingConsignmentDataInput

Description

Update checkout shipping consignment data object

Fields
Input Field Description
consignment - CheckoutShippingConsignmentInput! Checkout shipping consignment input object
Example
{"consignment": CheckoutShippingConsignmentInput}
Types

UpdateCheckoutShippingConsignmentInput

Description

Update checkout shipping consignment input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
consignmentEntityId - String! The consignment id
data - UpdateCheckoutShippingConsignmentDataInput! Update checkout shipping consignment data object
Example
{
  "checkoutEntityId": "abc123",
  "consignmentEntityId": "xyz789",
  "data": UpdateCheckoutShippingConsignmentDataInput
}
Types

UpdateCheckoutShippingConsignmentResult

Description

Update checkout shipping consignment result

Fields
Field Name Description
checkout - Checkout The Checkout that is updated as a result of mutation.
Example
{"checkout": Checkout}
Types

UpdateStockBehavior

Description

The behavior type for updating stock levels.

Values
Enum Value Description

ORDER_COMPLETED_OR_SHIPPED

ORDER_PLACED
Example
"ORDER_COMPLETED_OR_SHIPPED"
Types

UpdateWishlistInput

Description

Update wishlist input object

Fields
Input Field Description
entityId - Int! The wishlist id
data - WishlistUpdateDataInput! Wishlist data to update
Example
{"entityId": 123, "data": WishlistUpdateDataInput}
Types

UpdateWishlistResult

Description

Update wishlist

Fields
Field Name Description
result - Wishlist! The wishlist
Example
{"result": Wishlist}
Types

UrlField

Description

Url field

Fields
Field Name Description
vanityUrl - String! Store url.
cdnUrl - String! CDN url to fetch assets.
checkoutUrl - String Checkout url.
Example
{
  "vanityUrl": "abc123",
  "cdnUrl": "xyz789",
  "checkoutUrl": "abc123"
}
Types

Variant

Description

Variant

Fields
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

Tax will be included if enabled

currencyCode - currencyCode

Please select a currency
inventory - VariantInventory Variant inventory
metafields - MetafieldConnection! Metafield data related to a variant.
Arguments
namespace - String!

Metafield namespace filter

keys - [String!]

Labels for identifying metafield data values.

before - String
after - String
first - Int
last - Int
upc - String Universal product code.
mpn - String Manufacturer part number.
gtin - String Global trade item number.
isPurchasable - Boolean! Whether the product can be purchased
Example
{
  "id": 4,
  "entityId": 987,
  "sku": "abc123",
  "weight": Measurement,
  "height": Measurement,
  "width": Measurement,
  "depth": Measurement,
  "options": OptionConnection,
  "productOptions": ProductOptionConnection,
  "defaultImage": Image,
  "prices": Prices,
  "inventory": VariantInventory,
  "metafields": MetafieldConnection,
  "upc": "abc123",
  "mpn": "abc123",
  "gtin": "abc123",
  "isPurchasable": false
}
Types

VariantConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [VariantEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [VariantEdge]
}
Types

VariantEdge

Description

An edge in a connection.

Fields
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

Description

Variant Inventory

Fields
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!]

Location ids filter.

locationEntityCodes - [String!]

Location entity codes filter.

locationEntityTypeIds - [String!]

Location entity type ids filter.

locationEntityServiceTypeIds - [String!]

Location entity type ids filter.

distanceFilter - DistanceFilter

Filter locations by the distance

before - String
after - String
first - Int
last - Int
Example
{
  "aggregated": Aggregated,
  "isInStock": false,
  "byLocation": LocationConnection
}
Types

WebPage

Description

WebPage details.

Fields
Field Name Description
entityId - Int! Unique ID for the web page.
parentEntityId - Int Unique ID for the parent page.
name - String! Page name.
isVisibleInNavigation - Boolean! Whether or not the page should be visible in the navigation menu.
seo - SeoDetails! Page SEO details.
Possible Types
WebPage Types

BlogIndexPage

ContactPage

ExternalLinkPage

NormalPage

RawHtmlPage
Example
{
  "entityId": 123,
  "parentEntityId": 123,
  "name": "abc123",
  "isVisibleInNavigation": true,
  "seo": SeoDetails
}
Types

WebPageType

Description

Web page type

Values
Enum Value Description

BLOG

CONTACT

LINK

NORMAL

RAW
Example
"BLOG"
Types

WebPagesFiltersInput

Description

Object containing filters for querying web pages

Fields
Input Field Description
entityIds - [Int!] Ids of the expected pages.
pageType - WebPageType Type of the expected pages.
isVisibleInNavigation - Boolean Whether the expected pages are visible in the navigation bar.
Example
{"entityIds": [987], "pageType": "BLOG", "isVisibleInNavigation": true}
Types

Wishlist

Description

A wishlist

Fields
Field Name Description
entityId - Int! The wishlist id.
name - String! The wishlist name.
isPublic - Boolean! Is the wishlist public?
token - String! The wishlist token.
items - WishlistItemConnection! A list of the wishlist items
Arguments
hideOutOfStock - Boolean

When set to True, hides products which are out of stock. Defaults to False. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.

before - String
after - String
first - Int
last - Int
Example
{
  "entityId": 987,
  "name": "xyz789",
  "isPublic": true,
  "token": "xyz789",
  "items": WishlistItemConnection
}
Types

WishlistConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [WishlistEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [WishlistEdge]
}
Types

WishlistEdge

Description

An edge in a connection.

Fields
Field Name Description
node - Wishlist! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": Wishlist,
  "cursor": "xyz789"
}
Types

WishlistFiltersInput

Description

Wishlist filters input object

Fields
Input Field Description
entityIds - [Int!] A wishlist ids filter.
Example
{"entityIds": [123]}
Types

WishlistItem

Description

The wishlist item

Fields
Field Name Description
entityId - Int! Wishlist item id.
product - Product! A product included in the wishlist.
productEntityId - Int! An id of the product from the wishlist.
variantEntityId - Int An id of the specific product variant from the wishlist.
Example
{
  "entityId": 987,
  "product": Product,
  "productEntityId": 987,
  "variantEntityId": 987
}
Types

WishlistItemConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [WishlistItemEdge] A list of edges.
Example
{
  "pageInfo": PageInfo,
  "edges": [WishlistItemEdge]
}
Types

WishlistItemEdge

Description

An edge in a connection.

Fields
Field Name Description
node - WishlistItem! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": WishlistItem,
  "cursor": "xyz789"
}
Types

WishlistItemInput

Description

Wishlist item input object

Fields
Input Field Description
productEntityId - Int! An id of the product from the wishlist.
variantEntityId - Int An id of the specific product variant from the wishlist.
Example
{"productEntityId": 123, "variantEntityId": 123}
Types

WishlistMutations

Description

The wishlist mutations.

Fields
Field Name Description
createWishlist - CreateWishlistResult Create wishlist
Arguments
input - CreateWishlistInput!

Create wishlists input
addWishlistItems - AddWishlistItemsResult Add wishlist items
Arguments
input - AddWishlistItemsInput!

Add wishlist items input
deleteWishlistItems - DeleteWishlistItemsResult Delete wishlist items
Arguments
input - DeleteWishlistItemsInput!

Delete wishlist items input
updateWishlist - UpdateWishlistResult Update wishlist
Arguments
input - UpdateWishlistInput!

Update wishlist items input
deleteWishlists - DeleteWishlistResult Delete wishlist
Arguments
input - DeleteWishlistsInput!

Delete wishlists input
Example
{
  "createWishlist": CreateWishlistResult,
  "addWishlistItems": AddWishlistItemsResult,
  "deleteWishlistItems": DeleteWishlistItemsResult,
  "updateWishlist": UpdateWishlistResult,
  "deleteWishlists": DeleteWishlistResult
}
Types

WishlistUpdateDataInput

Description

Wishlist data to update

Fields
Input Field Description
name - String A new wishlist name
isPublic - Boolean A new wishlist visibility mode
Example
{"name": "xyz789", "isPublic": true}
Types

countryCode

Description

Country Code

Values
Enum Value Description

AD

AE

AF

AG

AI

AL

AM

AO

AQ

AR

AS

AT

AU

AW

AX

AZ

BA

BB

BD

BE

BF

BG

BH

BI

BJ

BL

BM

BN

BO

BQ

BR

BS

BT

BV

BW

BY

BZ

CA

CC

CD

CF

CG

CH

CI

CK

CL

CM

CN

CO

CR

CU

CV

CW

CX

CY

CZ

DE

DJ

DK

DM

DO

DZ

EC

EE

EG

EH

ER

ES

ET

FI

FJ

FK

FM

FO

FR

GA

GB

GD

GE

GF

GG

GH

GI

GL

GM

GN

GP

GQ

GR

GS

GT

GU

GW

GY

HK

HM

HN

HR

HT

HU

ID

IE

IL

IM

IN

IO

IQ

IR

IS

IT

JE

JM

JO

JP

KE

KG

KH

KI

KM

KN

KP

KR

KW

KY

KZ

LA

LB

LC

LI

LK

LR

LS

LT

LU

LV

LY

MA

MC

MD

ME

MF

MG

MH

MK

ML

MM

MN

MO

MP

MQ

MR

MS

MT

MU

MV

MW

MX

MY

MZ

NA

NC

NE

NF

NG

NI

NL

NO

NP

NR

NU

NZ

OM

PA

PE

PF

PG

PH

PK

PL

PM

PN

PR

PS

PT

PW

PY

QA

RE

RO

RS

RU

RW

SA

SB

SC

SD

SE

SG

SH

SI

SJ

SK

SL

SM

SN

SO

SR

SS

ST

SV

SX

SY

SZ

TC

TD

TF

TG

TH

TJ

TK

TL

TM

TN

TO

TR

TT

TV

TW

TZ

UA

UG

UM

US

UY

UZ

VA

VC

VE

VG

VI

VN

VU

WF

WS

YE

YT

ZA

ZM

ZW
Example
"AD"
Types

currencyCode

Description

Currency Code

Values
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

IRR

ISJ

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
Example
"ADP"
Types

sortBy

Description

Blog post sort

Values
Enum Value Description

NEWEST

OLDEST
Example
"NEWEST"
Documentation by Anvil SpectaQL