GraphQL Storefront 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": 987,
      "company": "xyz789",
      "customerGroupId": 123,
      "email": "abc123",
      "firstName": "xyz789",
      "lastName": "xyz789",
      "notes": "abc123",
      "phone": "abc123",
      "taxExemptCategory": "xyz789",
      "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
    }
    brand {
      ...BrandFragment
    }
    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,
      "brand": Brand,
      "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": "abc123"
}

Response

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

Mutations

`logout`

Description

Customer logout

Response

Returns a LogoutResult!

Example

Query

mutation logout {
  logout {
    result
  }
}

Response

{"data": {"logout": {"result": "abc123"}}}

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

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": 123, "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": "abc123",
  "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": "abc123",
  "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": "xyz789"}

Types

Banner

Description

Banner details.

Fields

Field Name	Description
`id` - `ID!`	The ID of the banner.
`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": "abc123"
}

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": "xyz789",
  "description": "xyz789",
  "path": "abc123",
  "isVisibleInNavigation": true,
  "posts": BlogPostConnection,
  "post": BlogPost,
  "renderedRegions": RenderedRegionsByPageType
}

Types

BlogIndexPage

Description

A blog index page.

Fields

Field Name	Description
`id` - `ID!`	The ID of an object
`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

{
  "id": "4",
  "path": "abc123",
  "renderedRegions": RenderedRegionsByPageType,
  "entityId": 123,
  "parentEntityId": 987,
  "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": "xyz789",
  "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": 123, "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.

Example

true

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": "abc123",
  "defaultImage": Image,
  "pageTitle": "abc123",
  "metaDesc": "abc123",
  "metaKeywords": ["abc123"],
  "seo": SeoDetails,
  "searchKeywords": ["xyz789"],
  "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": "abc123"
}

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": true,
  "brands": BrandSearchFilterItemConnection,
  "name": "xyz789",
  "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": 987,
  "name": "abc123",
  "isSelected": true,
  "productCount": 123
}

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": 987,
  "name": "xyz789",
  "path": "abc123"
}

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": 987,
  "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": 123
}

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

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": 123}

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.
`metafields` - `MetafieldConnection!`	Metafield data related to a cart.
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": "xyz789",
  "currencyCode": "abc123",
  "isTaxIncluded": false,
  "baseAmount": Money,
  "discountedAmount": Money,
  "amount": Money,
  "discounts": [CartDiscount],
  "lineItems": CartLineItems,
  "createdAt": DateTimeExtended,
  "updatedAt": DateTimeExtended,
  "locale": "abc123",
  "metafields": MetafieldConnection
}

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": "abc123",
  "productEntityId": 123,
  "variantEntityId": 123,
  "sku": "xyz789",
  "name": "xyz789",
  "url": "abc123",
  "imageUrl": "xyz789",
  "brand": "xyz789",
  "quantity": 987,
  "isTaxable": true,
  "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": true,
  "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": "xyz789",
  "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": "abc123"
}

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

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": "xyz789",
  "amount": Money,
  "message": "abc123"
}

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": 123,
  "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": 987,
  "sku": "xyz789",
  "name": "abc123",
  "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": false,
  "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": 123,
  "name": "xyz789",
  "value": "xyz789",
  "valueEntityId": 123
}

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": "xyz789",
  "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": 123,
  "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": 987
}

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": 987,
  "name": "xyz789",
  "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": 123.45}

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": 123, "name": "xyz789"}

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": 987, "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": false,
  "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": true
}

Types

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": 123,
  "path": "xyz789"
}

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": "xyz789",
  "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": false,
  "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": "xyz789",
  "path": "xyz789",
  "description": "xyz789",
  "productCount": 123,
  "image": Image,
  "hasChildren": true,
  "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.
`checkedOptionValueEntityId` - `Int!`	Option value entity ID used for specifying the checkbox is checked.
`uncheckedOptionValueEntityId` - `Int!`	Option value entity ID used for specifying the checkbox is not checked.
`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": false,
  "label": "xyz789",
  "checkedOptionValueEntityId": 987,
  "uncheckedOptionValueEntityId": 987,
  "entityId": 987,
  "displayName": "abc123",
  "isRequired": false,
  "isVariantOption": true
}

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": "xyz789",
  "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": "xyz789",
  "lastName": "xyz789",
  "email": "abc123",
  "company": "abc123",
  "address1": "xyz789",
  "address2": "abc123",
  "city": "abc123",
  "stateOrProvince": "xyz789",
  "stateOrProvinceCode": "abc123",
  "countryCode": "abc123",
  "postalCode": "xyz789",
  "phone": "abc123",
  "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": [987], "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": 987, "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": 123}

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

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": "xyz789",
  "lastName": "xyz789",
  "email": "abc123",
  "company": "abc123",
  "address1": "xyz789",
  "address2": "abc123",
  "city": "xyz789",
  "stateOrProvince": "xyz789",
  "stateOrProvinceCode": "abc123",
  "countryCode": "abc123",
  "postalCode": "xyz789",
  "phone": "xyz789",
  "customFields": CheckoutAddressCustomFieldInput,
  "shouldSaveAddress": false
}

Types

CheckoutAddressMultipleChoiceCustomField

Description

Multiple choice custom field.

Fields

Field Name	Description
`valueEntityId` - `Int!`	Custom field value ID.
`entityId` - `Int!`	Custom field ID.

Example

{"valueEntityId": 123, "entityId": 987}

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

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": 987.65}

Types

CheckoutAddressPasswordCustomField

Description

Password custom field.

Fields

Field Name	Description
`password` - `String!`	Password value.
`entityId` - `Int!`	Custom field ID.

Example

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

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": 123, "text": "abc123"}

Types

CheckoutAddressTextFieldCustomField

Description

Text custom field.

Fields

Field Name	Description
`text` - `String!`	Text value.
`entityId` - `Int!`	Custom field ID.

Example

{"text": "abc123", "entityId": 987}

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": "xyz789",
  "description": "xyz789",
  "type": "xyz789",
  "imageUrl": "xyz789",
  "cost": Money,
  "transitTime": "abc123",
  "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": "xyz789",
  "lastName": "abc123",
  "email": "xyz789",
  "company": "abc123",
  "address1": "xyz789",
  "address2": "xyz789",
  "city": "xyz789",
  "stateOrProvince": "xyz789",
  "stateOrProvinceCode": "xyz789",
  "countryCode": "xyz789",
  "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": "abc123",
  "address1": "abc123",
  "address2": "xyz789",
  "city": "abc123",
  "stateOrProvince": "abc123",
  "stateOrProvinceCode": "xyz789",
  "countryCode": "xyz789",
  "postalCode": "abc123",
  "phone": "abc123",
  "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": "xyz789",
  "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": 123,
  "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": "xyz789",
  "type": "xyz789",
  "imageUrl": "abc123",
  "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": "abc123",
  "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": "xyz789",
  "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": "xyz789"
}

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": "xyz789",
  "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": "abc123",
  "htmlBody": "abc123",
  "plainTextSummary": "xyz789",
  "contactFields": ["abc123"],
  "renderedRegions": RenderedRegionsByPageType,
  "entityId": 123,
  "parentEntityId": 123,
  "name": "abc123",
  "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": "abc123",
  "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": "xyz789",
  "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": 123,
  "code": "ADP",
  "name": "abc123",
  "flagImage": "abc123",
  "isActive": false,
  "exchangeRate": 123.45,
  "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": "xyz789",
  "decimalPlaces": 987
}

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": 987,
  "name": "abc123",
  "value": "abc123"
}

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

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": 987,
  "company": "xyz789",
  "customerGroupId": 123,
  "email": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "notes": "abc123",
  "phone": "abc123",
  "taxExemptCategory": "xyz789",
  "addressCount": 123,
  "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": 123,
  "value": "xyz789",
  "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": 123,
  "displayName": "abc123",
  "isRequired": false,
  "isVariantOption": true
}

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": "xyz789",
  "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": "abc123",
  "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": "xyz789",
  "consignmentEntityId": "abc123"
}

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": 123, "itemEntityIds": [123]}

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": [987]}

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": 123.45, "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": 987,
  "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": 123,
  "fileTypes": ["xyz789"],
  "entityId": 123,
  "displayName": "xyz789",
  "isRequired": true,
  "isVariantOption": true
}

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

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

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

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

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

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": 987,
  "code": "xyz789",
  "label": "xyz789",
  "description": "abc123",
  "address1": "abc123",
  "address2": "abc123",
  "city": "abc123",
  "stateOrProvince": "abc123",
  "countryCode": "xyz789",
  "postalCode": "xyz789",
  "phone": "abc123",
  "email": "xyz789",
  "latitude": 987.65,
  "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": 123,
  "isInStock": true,
  "locationDistance": Distance,
  "locationEntityTypeId": "abc123",
  "locationEntityServiceTypeIds": [
    "abc123"
  ],
  "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": 123,
  "code": "abc123",
  "label": "xyz789",
  "description": "abc123",
  "typeId": "xyz789",
  "serviceTypeIds": ["abc123"],
  "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": "xyz789"
}

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": "xyz789",
  "hideInProductFiltering": true,
  "showPreOrderStockLevels": true,
  "showOutOfStockMessage": true,
  "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

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

Types

Measurement

Description

Measurement

Fields

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

Example

{"value": 987.65, "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": "xyz789"
}

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 metafield.
`entityId` - `Int!`	The ID of the metafield when referencing via our backend API.
`key` - `String!`	A label for identifying metafield's data value.
`value` - `String!`	A metafield's value.

Example

{
  "id": "4",
  "entityId": 123,
  "key": "xyz789",
  "value": "xyz789"
}

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": 123,
  "maxLength": 987,
  "maxLines": 123,
  "entityId": 123,
  "displayName": "abc123",
  "isRequired": true,
  "isVariantOption": false
}

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": "xyz789",
  "values": ProductOptionValueConnection,
  "entityId": 987,
  "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": "abc123",
  "isDefault": false,
  "isSelected": false
}

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`
`BlogIndexPage`
`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": "abc123",
  "plainTextSummary": "xyz789",
  "renderedRegions": RenderedRegionsByPageType,
  "entityId": 123,
  "parentEntityId": 123,
  "name": "abc123",
  "isVisibleInNavigation": true,
  "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": 123,
  "displayName": "abc123",
  "isRequired": true,
  "isVariantOption": false
}

Types

OperatingDay

Description

Operating day

Fields

Field Name	Description
`open` - `Boolean!`	Open.
`opening` - `String!`	Opening.
`closing` - `String!`	Closing.

Example

{
  "open": true,
  "opening": "xyz789",
  "closing": "abc123"
}

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

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

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": 123}

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

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": false,
  "hasPreviousPage": false,
  "startCursor": "abc123",
  "endCursor": "xyz789"
}

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

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": 123,
  "name": "abc123",
  "path": "abc123"
}

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": true
}

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": 987.65}

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": 987.65, "maxPrice": 123.45}

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`