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
    }
    formFields {
      ...CustomerFormFieldValueFragment
    }
    addresses {
      ...AddressConnectionFragment
    }
    metafields {
      ...MetafieldConnectionFragment
    }
    orders {
      ...OrdersConnectionFragment
    }
  }
}
Response
{
  "data": {
    "customer": {
      "entityId": 123,
      "company": "abc123",
      "customerGroupId": 987,
      "email": "abc123",
      "firstName": "abc123",
      "lastName": "xyz789",
      "notes": "abc123",
      "phone": "abc123",
      "taxExemptCategory": "abc123",
      "addressCount": 987,
      "attributeCount": 123,
      "storeCredit": [Money],
      "attributes": CustomerAttributes,
      "wishlists": WishlistConnection,
      "formFields": [CustomerFormFieldValue],
      "addresses": AddressConnection,
      "metafields": MetafieldConnection,
      "orders": OrdersConnection
    }
  }
}
Queries

geography

Description

Geography information.

Response

Returns a Geography!

Example

Query
query geography {
  geography {
    countries {
      ...CountryFragment
    }
  }
}
Response
{"data": {"geography": {"countries": [Country]}}}
Queries

inventory

Description

An inventory

Response

Returns an Inventory!

Example

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

node

Description

Fetches an object given its ID

Response

Returns a Node

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

Example

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

site

Description

A site

Response

Returns a Site!

Example

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

store

Description

The current store.

Response

Returns a Store!

Example

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

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
    }
    createCartMetafield {
      ...CreateCartMetafieldResultFragment
    }
    updateCartMetafield {
      ...UpdateCartMetafieldResultFragment
    }
    deleteCartMetafield {
      ...DeleteCartMetafieldResultFragment
    }
    createCartRedirectUrls {
      ...CreateCartRedirectUrlsResultFragment
    }
  }
}
Response
{
  "data": {
    "cart": {
      "createCart": CreateCartResult,
      "deleteCart": DeleteCartResult,
      "addCartLineItems": AddCartLineItemsResult,
      "updateCartLineItem": UpdateCartLineItemResult,
      "deleteCartLineItem": DeleteCartLineItemResult,
      "updateCartCurrency": UpdateCartCurrencyResult,
      "assignCartToCustomer": AssignCartToCustomerResult,
      "unassignCartFromCustomer": UnassignCartFromCustomerResult,
      "createCartMetafield": CreateCartMetafieldResult,
      "updateCartMetafield": UpdateCartMetafieldResult,
      "deleteCartMetafield": DeleteCartMetafieldResult,
      "createCartRedirectUrls": CreateCartRedirectUrlsResult
    }
  }
}
Mutations

catalog

Description

The catalog mutations.

Response

Returns a CatalogMutations!

Example

Query
mutation catalog {
  catalog {
    addProductReview {
      ...AddProductReviewResultFragment
    }
  }
}
Response
{
  "data": {
    "catalog": {
      "addProductReview": AddProductReviewResult
    }
  }
}
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

customer

Description

The customer mutations.

Response

Returns a CustomerMutations!

Example

Query
mutation customer {
  customer {
    changePassword {
      ...ChangePasswordResultFragment
    }
    requestResetPassword {
      ...RequestResetPasswordResultFragment
    }
    resetPassword {
      ...ResetPasswordResultFragment
    }
    registerCustomer {
      ...RegisterCustomerResultFragment
    }
    updateCustomer {
      ...UpdateCustomerResultFragment
    }
    addCustomerAddress {
      ...AddCustomerAddressResultFragment
    }
    updateCustomerAddress {
      ...UpdateCustomerAddressResultFragment
    }
    deleteCustomerAddress {
      ...DeleteCustomerAddressResultFragment
    }
  }
}
Response
{
  "data": {
    "customer": {
      "changePassword": ChangePasswordResult,
      "requestResetPassword": RequestResetPasswordResult,
      "resetPassword": ResetPasswordResult,
      "registerCustomer": RegisterCustomerResult,
      "updateCustomer": UpdateCustomerResult,
      "addCustomerAddress": AddCustomerAddressResult,
      "updateCustomerAddress": UpdateCustomerAddressResult,
      "deleteCustomerAddress": DeleteCustomerAddressResult
    }
  }
}
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.
guestCartEntityId - String The guest cart entity ID which should be assigned to customer.

Example

Query
mutation login(
  $email: String!,
  $password: String!,
  $guestCartEntityId: String
) {
  login(
    email: $email,
    password: $password,
    guestCartEntityId: $guestCartEntityId
  ) {
    result
    customer {
      ...CustomerFragment
    }
    cart {
      ...CartFragment
    }
    customerAccessToken {
      ...CustomerAccessTokenFragment
    }
  }
}
Variables
{
  "email": "abc123",
  "password": "xyz789",
  "guestCartEntityId": "abc123"
}
Response
{
  "data": {
    "login": {
      "result": "xyz789",
      "customer": Customer,
      "cart": Cart,
      "customerAccessToken": CustomerAccessToken
    }
  }
}
Mutations

loginWithCustomerLoginJwt

Description

Login with Customer Login JWT.

Response

Returns a LoginWithCustomerLoginJwtResult!

Arguments
Name Description
jwt - String! Customer Login JWT, for more information: https://developer.bigcommerce.com/docs/start/authentication/customer-login.
guestCartEntityId - String The guest cart entity Id which should be assigned.

Example

Query
mutation loginWithCustomerLoginJwt(
  $jwt: String!,
  $guestCartEntityId: String
) {
  loginWithCustomerLoginJwt(
    jwt: $jwt,
    guestCartEntityId: $guestCartEntityId
  ) {
    redirectTo
    customer {
      ...CustomerFragment
    }
    cart {
      ...CartFragment
    }
    customerAccessToken {
      ...CustomerAccessTokenFragment
    }
  }
}
Variables
{
  "jwt": "abc123",
  "guestCartEntityId": "xyz789"
}
Response
{
  "data": {
    "loginWithCustomerLoginJwt": {
      "redirectTo": "abc123",
      "customer": Customer,
      "cart": Cart,
      "customerAccessToken": CustomerAccessToken
    }
  }
}
Mutations

logout

Description

Customer logout

Response

Returns a LogoutResult!

Example

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

submitContactUs

Description

Contact us mutation.

Response

Returns a SubmitContactUsResult!

Arguments
Name Description
reCaptchaV2 - ReCaptchaV2Input The reCaptchaV2 token.
input - SubmitContactUsInput! The content of the contact us form.

Example

Query
mutation submitContactUs(
  $reCaptchaV2: ReCaptchaV2Input,
  $input: SubmitContactUsInput!
) {
  submitContactUs(
    reCaptchaV2: $reCaptchaV2,
    input: $input
  ) {
    errors {
      ... on ValidationError {
        ...ValidationErrorFragment
      }
    }
  }
}
Variables
{
  "reCaptchaV2": ReCaptchaV2Input,
  "input": SubmitContactUsInput
}
Response
{
  "data": {
    "submitContactUs": {"errors": [ValidationError]}
  }
}
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

AccountCreationDisabledError

Description

An error due to customer registration being disabled on a storefront.

Fields
Field Name Description
message - String! A description of the error.
Example
{"message": "abc123"}
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
version - Int Version number. When provided, will reject the request if the version number is not the latest version of the cart, in order to prevent race conditions.
Example
{
  "cartEntityId": "xyz789",
  "data": AddCartLineItemsDataInput,
  "version": 987
}
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
version - Int Version number. When provided, will reject the request if the version number is not the latest version of the cart, in order to prevent race conditions.
Example
{
  "checkoutEntityId": "xyz789",
  "data": AddCheckoutBillingAddressDataInput,
  "version": 123
}
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
version - Int Version number. When provided, will reject the request if the version number is not the latest version of the cart, in order to prevent race conditions.
Example
{
  "checkoutEntityId": "abc123",
  "data": AddCheckoutShippingConsignmentsDataInput,
  "version": 987
}
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

AddCustomerAddressError

Description

Possible response error when attempting to use AddCustomerAddress mutation.

Types
Union Types

CustomerNotLoggedInError

CustomerAddressCreationError

ValidationError
Example
CustomerNotLoggedInError
Types

AddCustomerAddressInput

Description

Input for adding a customer address.

Fields
Input Field Description
firstName - String! First name of the address owner.
lastName - String! Last name of the address owner.
address1 - String! First line for the street address.
address2 - String Second line for the street address.
city - String! City.
company - String Company name associated with the address.
countryCode - String! 2-letter country code.
stateOrProvince - String Name of State or Province.
phone - String Phone number.
postalCode - String Postal code for the address. This is only required for certain countries.
formFields - CustomerFormFieldsInput Additional form fields defined by merchant.
Example
{
  "firstName": "xyz789",
  "lastName": "xyz789",
  "address1": "abc123",
  "address2": "abc123",
  "city": "abc123",
  "company": "abc123",
  "countryCode": "xyz789",
  "stateOrProvince": "abc123",
  "phone": "xyz789",
  "postalCode": "xyz789",
  "formFields": CustomerFormFieldsInput
}
Types

AddCustomerAddressResult

Description

Result of AddCustomerAddress mutation.

Fields
Field Name Description
address - CustomerAddress Customer address that was created.
errors - [AddCustomerAddressError!]! List of response errors when attempting to submit an address.
Example
{
  "address": CustomerAddress,
  "errors": [CustomerNotLoggedInError]
}
Types

AddProductReviewError

Description

Error coming from submitting a product review.

Types
Union Types

CustomerAlreadyReviewedProductError

NotAuthorizedToAddProductReviewError

ProductIdNotFoundError

InvalidInputFieldsError

UnexpectedAddReviewError
Example
CustomerAlreadyReviewedProductError
Types

AddProductReviewInput

Description

Input for the addProductReview mutation.

Fields
Input Field Description
productEntityId - Long! ID of the product to submit reviews for.
review - ProductReviewInput! The review to submit.
Example
{"productEntityId": {}, "review": ProductReviewInput}
Types

AddProductReviewResult

Description

Result of the addProductReview mutation.

Fields
Field Name Description
errors - [AddProductReviewError!]! Errors encountered while submitting the review.
Example
{"errors": [CustomerAlreadyReviewedProductError]}
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": 987, "items": [WishlistItemInput]}
Types

AddWishlistItemsResult

Description

Add wishlist items

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

AddressConnection

Description

A connection to a list of customer addresses.

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

AddressDoesNotExistError

Description

An error due to providing an invalid or non-existent address ID.

Fields
Field Name Description
message - String! Error message.
Example
{"message": "abc123"}
Types

AddressEdge

Description

An edge in a connection.

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

Aggregated

Description

Aggregated

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

AggregatedInventory

Description

Aggregated Product Inventory

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

AlreadyExistsError

Description

Subject that should be created as a result of mutation would cause duplicate.

Fields
Field Name Description
message - String! A description of the error
Example
{"message": "abc123"}
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
version - Int Version number. When provided, will reject the request if the version number is not the latest version of the cart, in order to prevent race conditions.
Example
{
  "checkoutEntityId": "xyz789",
  "data": ApplyCheckoutCouponDataInput,
  "version": 123
}
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.
version - Int Version number. When provided, will reject the request if the version number is not the latest version of the cart, in order to prevent race conditions.
Example
{"cartEntityId": "xyz789", "version": 987}
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": "abc123",
  "content": "abc123",
  "location": "BOTTOM"
}
Types

BannerConnection

Description

A connection to a list of items.

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

BannerEdge

Description

An edge in a connection.

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

BannerLocation

Description

Banner location

Values
Enum Value Description

BOTTOM

TOP
Example
"BOTTOM"
Types

Banners

Description

Banners details.

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

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

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

BaseOrder

Description

Base order fields.

Fields
Field Name Description
entityId - Int! Order ID.
orderedAt - DateTimeExtended! Date and time the order was placed.
updatedAt - DateTimeExtended! Date and time the order was last updated.
status - OrderStatus! Order status.
billingAddress - OrderBillingAddress! Billing address.
isTaxIncluded - Boolean! Indicates whether the taxes are included in the order total.
consignments - OrderConsignments Consignments.
subTotal - Money! Subtotal.
discounts - OrderDiscounts! Discounts.
wrappingCostTotal - Money! Total cost of wrapping.
shippingCostTotal - Money! Total cost of shipping.
handlingCostTotal - Money! Total cost of handling.
taxTotal - Money! Total tax.
taxes - [OrderTax!]! Taxes.
totalIncTax - Money! The final order total payable amount inclusive of tax, before applying any store credit or gift certificate.
customerMessage - String Message from customer
Possible Types
BaseOrder Types

Order

OrderWithPayments
Example
{
  "entityId": 123,
  "orderedAt": DateTimeExtended,
  "updatedAt": DateTimeExtended,
  "status": OrderStatus,
  "billingAddress": OrderBillingAddress,
  "isTaxIncluded": false,
  "consignments": OrderConsignments,
  "subTotal": Money,
  "discounts": OrderDiscounts,
  "wrappingCostTotal": Money,
  "shippingCostTotal": Money,
  "handlingCostTotal": Money,
  "taxTotal": Money,
  "taxes": [OrderTax],
  "totalIncTax": Money,
  "customerMessage": "xyz789"
}
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": "abc123",
  "path": "abc123",
  "isVisibleInNavigation": false,
  "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": "xyz789",
  "renderedRegions": RenderedRegionsByPageType,
  "entityId": 123,
  "parentEntityId": 123,
  "name": "xyz789",
  "isVisibleInNavigation": true,
  "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": 987,
  "name": "abc123",
  "tags": ["xyz789"],
  "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": "xyz789"}
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": [987], "tags": ["abc123"]}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Brand

Description

Brand

Fields
Field Name Description
id - ID! The ID of an object
entityId - Int! Id of the brand.
name - String! Name of the brand.
defaultImage - Image Default image for brand.
pageTitle - String! Page title for the brand. Use SEO details instead.
metaDesc - String! Meta description for the brand. Use SEO details instead.
metaKeywords - [String!]! Meta keywords for the brand. Use SEO details instead.
seo - SeoDetails! Brand SEO details.
searchKeywords - [String!]! Search keywords for the brand.
path - String! Path for the brand page.
products - ProductConnection! List of products associated with the brand.
Arguments
before - String
after - String
first - Int
last - Int
hideOutOfStock - Boolean

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

Metafield namespace filter

keys - [String!]

Labels for identifying metafield data values.

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

BrandConnection

Description

A connection to a list of items.

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

BrandEdge

Description

An edge in a connection.

Fields
Field Name Description
node - Brand! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": Brand,
  "cursor": "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": "abc123"
}
Types

BrandRedirect

Description

Redirect to a brand.

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

BrandSearchFilter

Description

Brand Filter

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

BrandSearchFilterItem

Description

Specific brand filter item

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

Breadcrumb

Description

Breadcrumb

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

BreadcrumbConnection

Description

A connection to a list of items.

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

BreadcrumbEdge

Description

An edge in a connection.

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

BulkPricingFixedPriceDiscount

Description

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

Fields
Field Name Description
price - BigDecimal! This price will override the current product price.
minimumQuantity - Int! Minimum item quantity that applies to this bulk pricing tier.
maximumQuantity - Int Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound.
Example
{
  "price": BigDecimal,
  "minimumQuantity": 987,
  "maximumQuantity": 987
}
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": 987,
  "maximumQuantity": 123
}
Types

BulkPricingTier

Description

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

Fields
Field Name Description
minimumQuantity - Int! Minimum item quantity that applies to this bulk pricing tier.
maximumQuantity - Int Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound.
Possible Types
BulkPricingTier Types

BulkPricingFixedPriceDiscount

BulkPricingPercentageDiscount

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

Cart

Description

A cart

Fields
Field Name Description
id - ID! The ID of an object
entityId - String! Cart ID.
currencyCode - String! ISO-4217 currency code.
isTaxIncluded - Boolean! Whether this item is taxable.
baseAmount - Money! Cost of cart's contents, before applying discounts.
discountedAmount - Money! Discounted amount.
amount - Money! Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable).
discounts - [CartDiscount!]! List of discounts applied to this cart.
lineItems - CartLineItems! List of line items.
createdAt - DateTimeExtended! Time when the cart was created.
updatedAt - DateTimeExtended! Time when the cart was last updated.
locale - String! Locale of the cart.
version - Int The current version of the cart, which is updated with every change.
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": true,
  "baseAmount": Money,
  "discountedAmount": Money,
  "amount": Money,
  "discounts": [CartDiscount],
  "lineItems": CartLineItems,
  "createdAt": DateTimeExtended,
  "updatedAt": DateTimeExtended,
  "locale": "abc123",
  "version": 123,
  "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. Use image field instead.
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.
image - Image Image for the item.
Example
{
  "entityId": "xyz789",
  "parentEntityId": "xyz789",
  "productEntityId": 987,
  "variantEntityId": 987,
  "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],
  "image": Image
}
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. None returned if all the above mentioned themes are disabled.
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": "abc123",
  "name": "abc123",
  "theme": "BIRTHDAY",
  "amount": Money,
  "isTaxable": false,
  "sender": CartGiftCertificateSender,
  "recipient": CartGiftCertificateRecipient,
  "message": "xyz789"
}
Types

CartGiftCertificateInput

Description

Cart gift certificate input object

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

CartGiftCertificateTheme

Description

Cart gift certificate theme

Values
Enum Value Description

BIRTHDAY

BOY

CELEBRATION

CHRISTMAS

GENERAL

GIRL

NONE
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": 987,
  "variantEntityId": 987,
  "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.
createCartMetafield - CreateCartMetafieldResult! Creates a metafield for cart object.
Arguments
input - CreateCartMetafieldInput!

Create cart's metafield input object.
updateCartMetafield - UpdateCartMetafieldResult! Updates a metafield for cart object.
Arguments
input - UpdateCartMetafieldInput!

Update cart's metafield input object.
deleteCartMetafield - DeleteCartMetafieldResult! Deletes a metafield for cart object.
Arguments
input - DeleteCartMetafieldInput!

Delete cart's metafield input object.
createCartRedirectUrls - CreateCartRedirectUrlsResult! Create single-use redirect URLs for a cart.
Arguments
input - CreateCartRedirectUrlsInput

Create cart redirect URLs input object.
Example
{
  "createCart": CreateCartResult,
  "deleteCart": DeleteCartResult,
  "addCartLineItems": AddCartLineItemsResult,
  "updateCartLineItem": UpdateCartLineItemResult,
  "deleteCartLineItem": DeleteCartLineItemResult,
  "updateCartCurrency": UpdateCartCurrencyResult,
  "assignCartToCustomer": AssignCartToCustomerResult,
  "unassignCartFromCustomer": UnassignCartFromCustomerResult,
  "createCartMetafield": CreateCartMetafieldResult,
  "updateCartMetafield": UpdateCartMetafieldResult,
  "deleteCartMetafield": DeleteCartMetafieldResult,
  "createCartRedirectUrls": CreateCartRedirectUrlsResult
}
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. Use image field instead.
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.
image - Image Image for the item.
Example
{
  "entityId": "xyz789",
  "parentEntityId": "abc123",
  "productEntityId": 987,
  "variantEntityId": 987,
  "sku": "abc123",
  "name": "xyz789",
  "url": "xyz789",
  "imageUrl": "xyz789",
  "brand": "abc123",
  "quantity": 123,
  "isTaxable": false,
  "discounts": [CartDiscount],
  "discountedAmount": Money,
  "couponAmount": Money,
  "listPrice": Money,
  "originalPrice": Money,
  "salePrice": Money,
  "extendedListPrice": Money,
  "extendedSalePrice": Money,
  "isShippingRequired": true,
  "selectedOptions": [CartSelectedOption],
  "giftWrapping": CartGiftWrapping,
  "image": Image
}
Types

CartRedirectUrls

Description

Cart redirect URLs.

Fields
Field Name Description
redirectedCheckoutUrl - String! The single-use URL to the BigCommerce hosted checkout for the cart. Should be generated just-in-time (within 30s).
embeddedCheckoutUrl - String! The single-use URL to the embedded checkout for the cart. Should be generated just-in-time (within 30s).
Example
{
  "redirectedCheckoutUrl": "abc123",
  "embeddedCheckoutUrl": "xyz789"
}
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": 123, "optionValueEntityId": 123}
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": 123,
  "name": "abc123",
  "date": DateTimeExtended
}
Types

CartSelectedDateFieldOptionInput

Description

Cart selected date field option input object

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

CartSelectedFileUploadOption

Description

Selected file upload option.

Fields
Field Name Description
entityId - Int! The product option ID.
name - String! The product option name.
fileName - String! Uploaded file name.
Example
{
  "entityId": 987,
  "name": "abc123",
  "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": "xyz789",
  "text": "xyz789"
}
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": 987, "text": "abc123"}
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": 987,
  "name": "xyz789",
  "value": "abc123",
  "valueEntityId": 123
}
Types

CartSelectedMultipleChoiceOptionInput

Description

Cart selected multiple choice option input object

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

CartSelectedNumberFieldOption

Description

Selected number field option.

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

CartSelectedNumberFieldOptionInput

Description

Cart selected number field option input object

Fields
Input Field Description
optionEntityId - Int! The product option ID.
number - Float! Number value.
Example
{"optionEntityId": 987, "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": "abc123"}
Types

CartSelectedOptionsInput

Description

Selected product options.

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

CartSelectedTextFieldOption

Description

Selected text field option.

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

CartSelectedTextFieldOptionInput

Description

Cart selected multiple line text field option input object

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

Catalog

Description

Storefront catalog settings.

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

CatalogMutations

Description

Catalog mutations

Fields
Field Name Description
addProductReview - AddProductReviewResult! Add a product review.
Arguments
reCaptchaV2 - ReCaptchaV2Input

The reCaptchaV2 token.

input - AddProductReviewInput!

The content of the product review.
Example
{"addProductReview": AddProductReviewResult}
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": 123,
  "displayName": "abc123",
  "isRequired": false,
  "isVariantOption": true
}
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": 123,
  "label": "abc123",
  "isDefault": true,
  "isSelected": true
}
Types

Category

Description

Category

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

The depth of the breadcrumbs.

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

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

sortBy - CategoryProductSort

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

Metafield namespace filter

keys - [String!]

Labels for identifying metafield data values.

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

Please select a currency

includeTax - Boolean

Tax will be included if enabled

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

CategoryConnection

Description

A connection to a list of items.

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

CategoryEdge

Description

An edge in a connection.

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

CategoryPageBannerConnection

Description

A connection to a list of items.

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

CategoryPageBannerEdge

Description

An edge in a connection.

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

CategoryProductSort

Description

Product sorting by categories.

Values
Enum Value Description

A_TO_Z

BEST_REVIEWED

BEST_SELLING

DEFAULT

FEATURED

HIGHEST_PRICE

LOWEST_PRICE

NEWEST

Z_TO_A
Example
"A_TO_Z"
Types

CategoryRedirect

Description

Redirect to a category.

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

CategorySearchFilter

Description

Category Filter

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

CategorySearchFilterItem

Description

Specific category filter item

Fields
Field Name Description
entityId - Int! Category ID.
name - String! Category name.
isSelected - Boolean! Indicates whether category is selected.
productCount - Int! Indicates how many products available for this filter.
subCategories - SubCategorySearchFilterItemConnection! List of available sub-categories.
Arguments
before - String
after - String
first - Int
last - Int
Example
{
  "entityId": 987,
  "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": "abc123"
}
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": 987,
  "image": Image,
  "hasChildren": false,
  "children": [CategoryTreeItem]
}
Types

ChangePasswordError

Description

An error that occurred while changing a password.

Types
Union Types

ValidationError

CustomerDoesNotExistError

CustomerPasswordError

CustomerNotLoggedInError
Example
ValidationError
Types

ChangePasswordInput

Description

The input for changing a customer password.

Fields
Input Field Description
currentPassword - String! The current password. Do not pass this directly in the query, use GraphQL variables.
newPassword - String! The new password. Do not pass this directly in the query, use GraphQL variables.
Example
{
  "currentPassword": "abc123",
  "newPassword": "xyz789"
}
Types

ChangePasswordResult

Description

The result of changing a password.

Fields
Field Name Description
errors - [ChangePasswordError!]! Errors encountered while changing the password.
Example
{"errors": [ValidationError]}
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": true,
  "label": "xyz789",
  "checkedOptionValueEntityId": 123,
  "uncheckedOptionValueEntityId": 123,
  "entityId": 123,
  "displayName": "xyz789",
  "isRequired": true,
  "isVariantOption": true
}
Types

CheckboxesFormField

Description

Checkboxes form field.

Fields
Field Name Description
options - [FormFieldOption!]! The options for the form field.
entityId - Int! The entity ID of the form field.
label - String! The label to display for the form field.
sortOrder - Int! The sort order priority of the form field.
isBuiltIn - Boolean! Indicates whether the form field is built-in.
isRequired - Boolean! Indicates whether the form field is required.
Example
{
  "options": [FormFieldOption],
  "entityId": 123,
  "label": "xyz789",
  "sortOrder": 123,
  "isBuiltIn": false,
  "isRequired": true
}
Types

CheckboxesFormFieldInput

Description

The user input for checkbox form fields.

Fields
Input Field Description
fieldEntityId - Int! The custom form field ID.
fieldValueEntityIds - [Int!]! The choice indexes of the form field values.
Example
{"fieldEntityId": 123, "fieldValueEntityIds": [987]}
Types

CheckboxesFormFieldValue

Description

Checkboxes custom form field result.

Fields
Field Name Description
valueEntityIds - [Int!]! List of checkbox value ids selected by customer.
values - [String!]! List of checkbox values selected by customer.
entityId - Int! Entity ID of a custom form field value on a customer or customer address.
name - String! The name of the form field that the value is for.
Example
{
  "valueEntityIds": [123],
  "values": ["xyz789"],
  "entityId": 987,
  "name": "abc123"
}
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
version - Int The current version of the checkout, which is updated with every change.
Example
{
  "id": "4",
  "entityId": "abc123",
  "billingAddress": CheckoutBillingAddress,
  "cart": Cart,
  "shippingConsignments": [CheckoutShippingConsignment],
  "order": Order,
  "shippingCostTotal": Money,
  "giftWrappingCostTotal": Money,
  "handlingCostTotal": Money,
  "taxTotal": Money,
  "taxes": [CheckoutTax],
  "subtotal": Money,
  "grandTotal": Money,
  "createdAt": DateTimeExtended,
  "updatedAt": DateTimeExtended,
  "customerMessage": "abc123",
  "outstandingBalance": Money,
  "coupons": [CheckoutCoupon],
  "promotions": [CheckoutPromotion],
  "version": 123
}
Types

CheckoutAddress

Description

Checkout address.

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

CheckoutBillingAddress

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

CheckoutAddressCheckboxesCustomField

Description

Checkboxes custom field.

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

CheckoutAddressCheckboxesCustomFieldInput

Description

Checkout address checkboxes custom field input object

Fields
Input Field Description
fieldEntityId - Int! The custom field ID.
fieldValueEntityIds - [Int!]! The choice indexes of the form field values.
Example
{"fieldEntityId": 123, "fieldValueEntityIds": [987]}
Types

CheckoutAddressCustomField

Description

Custom field of the checkout address.

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

CheckoutAddressCheckboxesCustomField

CheckoutAddressDateCustomField

CheckoutAddressMultipleChoiceCustomField

CheckoutAddressNumberCustomField

CheckoutAddressPasswordCustomField

CheckoutAddressTextFieldCustomField
Example
{"entityId": 987}
Types

CheckoutAddressCustomFieldInput

Description

Checkout address custom field input object

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

CheckoutAddressDateCustomField

Description

Date custom field.

Fields
Field Name Description
date - DateTimeExtended! Date value.
entityId - Int! Custom field ID.
Example
{"date": DateTimeExtended, "entityId": 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": 123,
  "date": "2007-12-03T10:15:30Z"
}
Types

CheckoutAddressInput

Description

Checkout address input object

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

CheckoutAddressMultipleChoiceCustomField

Description

Multiple choice custom field.

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

CheckoutAddressMultipleChoiceCustomFieldInput

Description

Checkout address multiple choice custom field input object

Fields
Input Field Description
fieldEntityId - Int! The custom field ID.
fieldValueEntityId - Int! The choice index of the form field value.
Example
{"fieldEntityId": 123, "fieldValueEntityId": 123}
Types

CheckoutAddressNumberCustomField

Description

Number custom field.

Fields
Field Name Description
number - Float! Number value.
entityId - Int! Custom field ID.
Example
{"number": 987.65, "entityId": 987}
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": "xyz789", "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": 123, "password": "abc123"}
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": "xyz789"}
Types

CheckoutAddressTextFieldCustomField

Description

Text custom field.

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

CheckoutAvailableShippingOption

Description

Available shipping option.

Fields
Field Name Description
entityId - String! Shipping option ID.
description - String! Shipping option description.
type - String! Shipping option type. Flat rate, UPS, etc.
imageUrl - String Shipping option image URL. Use image field instead.
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.
image - Image Shipping option image.
Example
{
  "entityId": "xyz789",
  "description": "xyz789",
  "type": "abc123",
  "imageUrl": "xyz789",
  "cost": Money,
  "transitTime": "abc123",
  "isRecommended": false,
  "image": Image
}
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": "abc123",
  "company": "xyz789",
  "address1": "abc123",
  "address2": "xyz789",
  "city": "xyz789",
  "stateOrProvince": "abc123",
  "stateOrProvinceCode": "abc123",
  "countryCode": "abc123",
  "postalCode": "abc123",
  "phone": "abc123",
  "customFields": [CheckoutAddressCustomField]
}
Types

CheckoutConsignmentAddress

Description

Checkboxes consignment address.

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

CheckoutMutations

Description

Checkout mutations

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

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

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

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

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

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

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

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

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

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

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

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

CheckoutPromotion

Description

The checkout promotion

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

CheckoutPromotionBanner

Description

The checkout promotion banner

Fields
Field Name Description
entityId - Int! The checkout promotion banner ID.
type - CheckoutPromotionBannerType! Type of the banner.
locations - [CheckoutPromotionBannerLocation!]! The list of the locations where the banner will display.
text - String! Text of the banner.
Example
{
  "entityId": 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. Use image field instead.
cost - Money! Shipping option cost.
transitTime - String An estimate of the arrival time.
image - Image Shipping option image.
Example
{
  "entityId": "abc123",
  "description": "xyz789",
  "type": "xyz789",
  "imageUrl": "abc123",
  "cost": Money,
  "transitTime": "xyz789",
  "image": Image
}
Types

CheckoutSettings

Description

Checkout settings.

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

CheckoutShippingConsignment

Description

Checkout shipping consignment.

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

CheckoutShippingConsignmentInput

Description

Checkout shipping consignments input object

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

CheckoutTax

Description

The checkout.

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

CollectionInfo

Description

Additional information about the collection.

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

CompleteCheckoutInput

Description

Complete checkout input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
Example
{"checkoutEntityId": "abc123"}
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": 987,
  "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": "abc123",
  "country": "abc123",
  "addressType": "xyz789",
  "email": "xyz789",
  "phone": "xyz789"
}
Types

ContactPage

Description

A contact page.

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

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

Country

Description

A country representation.

Fields
Field Name Description
entityId - Int! A country's ID.
code - String! The 2-letter ISO Alpha-2 code for a country.
name - String! A country's name.
statesOrProvinces - [StateOrProvince!]! A country's states or provinces.
Example
{
  "entityId": 123,
  "code": "xyz789",
  "name": "abc123",
  "statesOrProvinces": [StateOrProvince]
}
Types

CountryFiltersInput

Description

An input parameter to narrow down the countries you receive based on country name and code.

Fields
Input Field Description
name - String The name of a country that you can use to filter results.
code - String The 2-letter ISO Alpha-2 code for a country that you can use to filter results.
Example
{
  "name": "abc123",
  "code": "xyz789"
}
Types

CouponType

Description

The coupon type.

Values
Enum Value Description

FREE_SHIPPING

PERCENTAGE_DISCOUNT

PER_ITEM_DISCOUNT

PER_TOTAL_DISCOUNT

PROMOTION

SHIPPING_DISCOUNT
Example
"FREE_SHIPPING"
Types

CreateCartInput

Description

Create cart input object

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

CreateCartMetafieldDataInput

Description

Create cart's metafield data.

Fields
Input Field Description
key - String! Key for cart metafield.
value - String! Value for cart metafield.
Example
{
  "key": "xyz789",
  "value": "xyz789"
}
Types

CreateCartMetafieldError

Description

Error that occured as a result of createCartMetafieldMutation.

Types
Union Types

NotFoundError

AlreadyExistsError

ValidationError

LimitExceededError
Example
NotFoundError
Types

CreateCartMetafieldInput

Description

Input for create cart's metafield.

Fields
Input Field Description
cartEntityId - String! Cart id for which to create metafield.
data - CreateCartMetafieldDataInput! Create cart's metafield data.
Example
{
  "cartEntityId": "xyz789",
  "data": CreateCartMetafieldDataInput
}
Types

CreateCartMetafieldResult

Description

Result of creating metafield for cart.

Fields
Field Name Description
metafield - Metafields Metafield created for cart.
errors - [CreateCartMetafieldError!]! Errors found during creation of cart's metafield.
Example
{
  "metafield": Metafields,
  "errors": [NotFoundError]
}
Types

CreateCartRedirectUrlsError

Description

Error that occurs as a result of createCartRedirectUrlsMutation.

Types
Union Types

NotFoundError
Example
NotFoundError
Types

CreateCartRedirectUrlsInput

Description

Create cart redirect URLs input object.

Fields
Input Field Description
cartEntityId - String The cart id to create the redirect URLs for.
queryParams - [CreateCartRedirectUrlsQueryParamsInput!] The query parameters to pass when redirecting to the URLs.
Example
{
  "cartEntityId": "xyz789",
  "queryParams": [CreateCartRedirectUrlsQueryParamsInput]
}
Types

CreateCartRedirectUrlsQueryParamsInput

Description

Create cart redirect URLs query params input object.

Fields
Input Field Description
key - String! The key of the query parameter to pass.
value - String! The value of the query parameter to pass.
Example
{
  "key": "abc123",
  "value": "abc123"
}
Types

CreateCartRedirectUrlsResult

Description

Create cart redirect URLs result

Fields
Field Name Description
redirectUrls - CartRedirectUrls The redirect URLs created as a result of the mutation.
errors - [CreateCartRedirectUrlsError!]! Errors found during creation of cart redirect URLs.
Example
{
  "redirectUrls": CartRedirectUrls,
  "errors": [NotFoundError]
}
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": true,
  "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": true,
  "exchangeRate": 987.65,
  "isTransactional": true,
  "display": CurrencyDisplay
}
Types

CurrencyConnection

Description

A connection to a list of items.

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

CurrencyDisplay

Description

Currency display settings.

Fields
Field Name Description
symbol - String! Currency symbol.
symbolPlacement - CurrencySymbolPosition! Currency symbol.
decimalToken - String! Currency decimal token.
thousandsToken - String! Currency thousands token.
decimalPlaces - Int! Currency decimal places.
Example
{
  "symbol": "abc123",
  "symbolPlacement": "LEFT",
  "decimalToken": "abc123",
  "thousandsToken": "xyz789",
  "decimalPlaces": 123
}
Types

CurrencyEdge

Description

An edge in a connection.

Fields
Field Name Description
node - Currency! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": Currency,
  "cursor": "xyz789"
}
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": "xyz789",
  "value": "xyz789"
}
Types

CustomFieldConnection

Description

A connection to a list of items for custom fields.

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. Notes aren't supported in Storefront GQL API. This will output an empty string.
phone - String! The phone number of the customer.
taxExemptCategory - String! The tax exempt category of the customer.
addressCount - Int! Customer addresses count. Use addresses.collectionInfo.totalItems instead.
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
formFields - [CustomerFormFieldValue!]! The form field values of the customer.
addresses - AddressConnection! Customer addresses.
Arguments
before - String
after - String
first - Int
last - Int
metafields - MetafieldConnection! Metafield data related to a customer.
Arguments
namespace - String!

Metafield namespace filter.

keys - [String!]

Labels for identifying metafield data values.

before - String
after - String
first - Int
last - Int
orders - OrdersConnection The Orders for the customer.
Arguments
filters - OrdersFiltersInput

The filters for the customers orders.

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

CustomerAccessToken

Description

The customer token.

Fields
Field Name Description
value - String! The customer token value.
expiresAt - DateTime! The customer token expiration time.
Example
{
  "value": "abc123",
  "expiresAt": "2007-12-03T10:15:30Z"
}
Types

CustomerAddress

Description

Address that is associated with a customer account.

Fields
Field Name Description
entityId - Int! Customer address ID.
firstName - String! First name of the address owner.
lastName - String! Last name of the address owner.
address1 - String! First line for the street address.
address2 - String Second line for the street address.
city - String! City.
countryCode - String! 2-letter country code.
stateOrProvince - String Name of State or Province.
phone - String Phone number.
postalCode - String Postal code.
company - String Company name associated with the address.
formFields - [CustomerFormFieldValue!]! The form field values of the customer address.
Example
{
  "entityId": 123,
  "firstName": "xyz789",
  "lastName": "xyz789",
  "address1": "xyz789",
  "address2": "xyz789",
  "city": "abc123",
  "countryCode": "xyz789",
  "stateOrProvince": "xyz789",
  "phone": "abc123",
  "postalCode": "xyz789",
  "company": "abc123",
  "formFields": [CustomerFormFieldValue]
}
Types

CustomerAddressCreationError

Description

Unexpected error while creating a customer address.

Fields
Field Name Description
message - String! Error message.
Example
{"message": "abc123"}
Types

CustomerAddressDeletionError

Description

Unexpected error while deleting a customer address.

Fields
Field Name Description
message - String! Error message.
Example
{"message": "xyz789"}
Types

CustomerAddressUpdateError

Description

An unexpected error while updating an address for a customer.

Fields
Field Name Description
message - String! Error message.
Example
{"message": "xyz789"}
Types

CustomerAlreadyReviewedProductError

Description

An error resulting from a customer submitting multiple reviews to the same product.

Fields
Field Name Description
message - String! Error message.
Example
{"message": "abc123"}
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

CustomerDoesNotExistError

Description

An error due to customer not existing when attempting to update customer information.

Fields
Field Name Description
message - String! Error message.
Example
{"message": "abc123"}
Types

CustomerFormFieldValue

Description

Custom form field value as submitted by customer.

Fields
Field Name Description
entityId - Int! Entity ID of a custom form field value on a customer or customer address.
name - String! The name of the form field that the value is for.
Possible Types
CustomerFormFieldValue Types

CheckboxesFormFieldValue

DateFormFieldValue

MultilineTextFormFieldValue

MultipleChoiceFormFieldValue

NumberFormFieldValue

PasswordFormFieldValue

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

CustomerFormFieldsInput

Description

The input for the filled out customer form fields.

Fields
Input Field Description
checkboxes - [CheckboxesFormFieldInput!] List of checkboxes custom form fields input.
multipleChoices - [MultipleChoiceFormFieldInput!] List of multiple choice custom form fields input. This includes pick lists.
numbers - [NumberFormFieldInput!] List of number custom form fields input.
dates - [DateFormFieldInput!] List of date custom form fields input.
texts - [TextFormFieldInput!] List of text custom form fields input.
multilineTexts - [MultilineTextFormFieldInput!] List of multiline text custom form fields input.
passwords - [PasswordFormFieldInput!] List of password custom form fields input.
Example
{
  "checkboxes": [CheckboxesFormFieldInput],
  "multipleChoices": [MultipleChoiceFormFieldInput],
  "numbers": [NumberFormFieldInput],
  "dates": [DateFormFieldInput],
  "texts": [TextFormFieldInput],
  "multilineTexts": [MultilineTextFormFieldInput],
  "passwords": [PasswordFormFieldInput]
}
Types

CustomerMutations

Description

Mutations for customers domain.

Fields
Field Name Description
changePassword - ChangePasswordResult! Change the password for a customer.
Arguments
input - ChangePasswordInput!

Input for the change password operation.
requestResetPassword - RequestResetPasswordResult! Request reset password email.
Arguments
reCaptchaV2 - ReCaptchaV2Input

Recaptcha token.

input - RequestResetPasswordInput!

Input for the reset password email.
resetPassword - ResetPasswordResult! Reset customer password
Arguments
input - ResetPasswordInput!

Input for resetting customers password.
registerCustomer - RegisterCustomerResult! Register a new customer.
Arguments
reCaptchaV2 - ReCaptchaV2Input

Recaptcha token.

input - RegisterCustomerInput!

Input for the customer registration.
updateCustomer - UpdateCustomerResult! Update a customer.
Arguments
reCaptchaV2 - ReCaptchaV2Input

Recaptcha token.

input - UpdateCustomerInput!

Input for the customer update operation.
addCustomerAddress - AddCustomerAddressResult! Submit a customer address.
Arguments
reCaptchaV2 - ReCaptchaV2Input

Recaptcha token.

input - AddCustomerAddressInput!

Input for adding a customer address.
updateCustomerAddress - UpdateCustomerAddressResult! Update a customer address.
Arguments
reCaptchaV2 - ReCaptchaV2Input

Recaptcha token.

input - UpdateCustomerAddressInput!

Input for updating a customer address.
deleteCustomerAddress - DeleteCustomerAddressResult! Delete a customer address.
Arguments
reCaptchaV2 - ReCaptchaV2Input

Recaptcha token.

input - DeleteCustomerAddressInput!

Input for deleting a customer address.
Example
{
  "changePassword": ChangePasswordResult,
  "requestResetPassword": RequestResetPasswordResult,
  "resetPassword": ResetPasswordResult,
  "registerCustomer": RegisterCustomerResult,
  "updateCustomer": UpdateCustomerResult,
  "addCustomerAddress": AddCustomerAddressResult,
  "updateCustomerAddress": UpdateCustomerAddressResult,
  "deleteCustomerAddress": DeleteCustomerAddressResult
}
Types

CustomerNotLoggedInError

Description

An error due to not supplying a customer ID either via customer-id header (when using a customer impersonation token) or by logging into the storefront as a customer.

Fields
Field Name Description
message - String! Error message.
Example
{"message": "abc123"}
Types

CustomerPasswordError

Description

An error that occurred when a customer password is being changed or reset.

Fields
Field Name Description
message - String! Details of the error.
Example
{"message": "abc123"}
Types

CustomerRegistrationError

Description

An unexpected error while registering a customer.

Fields
Field Name Description
message - String! A description of the error.
Example
{"message": "xyz789"}
Types

CustomersSettings

Description

Customers settings.

Fields
Field Name Description
passwordComplexitySettings - PasswordComplexitySettings Settings that determine the minimum complexity required for a customer's password.
Example
{"passwordComplexitySettings": PasswordComplexitySettings}
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": true,
  "isVariantOption": true
}
Types

DateFormField

Description

Date form field.

Fields
Field Name Description
defaultDate - DateTime The default date value for the form field.
minDate - DateTime The earliest date that can be selected for the form field.
maxDate - DateTime The latest date that can be selected for the form field.
entityId - Int! The entity ID of the form field.
label - String! The label to display for the form field.
sortOrder - Int! The sort order priority of the form field.
isBuiltIn - Boolean! Indicates whether the form field is built-in.
isRequired - Boolean! Indicates whether the form field is required.
Example
{
  "defaultDate": "2007-12-03T10:15:30Z",
  "minDate": "2007-12-03T10:15:30Z",
  "maxDate": "2007-12-03T10:15:30Z",
  "entityId": 123,
  "label": "abc123",
  "sortOrder": 123,
  "isBuiltIn": true,
  "isRequired": true
}
Types

DateFormFieldInput

Description

The user input for date form fields.

Fields
Input Field Description
fieldEntityId - Int! The custom form field ID.
date - DateTime! The user date input for the form field in ISO-8601 format.
Example
{
  "fieldEntityId": 987,
  "date": "2007-12-03T10:15:30Z"
}
Types

DateFormFieldValue

Description

Date custom form field value.

Fields
Field Name Description
date - DateTimeExtended! The date submitted by a customer.
entityId - Int! Entity ID of a custom form field value on a customer or customer address.
name - String! The name of the form field that the value is for.
Example
{
  "date": DateTimeExtended,
  "entityId": 987,
  "name": "abc123"
}
Types

DateTime

Description

ISO-8601 formatted date in UTC. (e.g. 2024-01-01T00:00:00Z)

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

DateTimeExtended

Description

Date Time Extended

Fields
Field Name Description
utc - DateTime! ISO-8601 formatted date in UTC. (e.g. 2024-01-01T00:00:00Z)
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
version - Int Version number. When provided, will reject the request if the version number is not the latest version of the cart, in order to prevent race conditions.
Example
{
  "cartEntityId": "abc123",
  "lineItemEntityId": "abc123",
  "version": 987
}
Types

DeleteCartLineItemResult

Description

Delete cart lien item result

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

DeleteCartMetafieldError

Description

Error that occured as a result of deleteCartMetafield mutation.

Types
Union Types

NotFoundError

ValidationError

NotAuthorisedError
Example
NotFoundError
Types

DeleteCartMetafieldInput

Description

Input for delete cart's metafield mutation.

Fields
Input Field Description
cartEntityId - String! Id of the cart for which to delete metafield.
metafieldEntityId - Int! Id of metafield to delete.
Example
{
  "cartEntityId": "xyz789",
  "metafieldEntityId": 123
}
Types

DeleteCartMetafieldResult

Description

Result of deleting metafield for cart.

Fields
Field Name Description
deletedMetafieldEntityId - Int Id of metafield deleted for cart.
errors - [DeleteCartMetafieldError!]! Errors found during deletion of cart's metafield.
Example
{
  "deletedMetafieldEntityId": 123,
  "errors": [NotFoundError]
}
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": "xyz789"}
Types

DeleteCheckoutConsignmentInput

Description

Delete checkout consignment input object

Fields
Input Field Description
checkoutEntityId - String! The checkout id
consignmentEntityId - String! The consignment id
version - Int Version number. When provided, will reject the request if the version number is not the latest version of the cart, in order to prevent race conditions.
Example
{
  "checkoutEntityId": "abc123",
  "consignmentEntityId": "xyz789",
  "version": 123
}
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

DeleteCustomerAddressError

Description

Possible response errors when attempting to delete a customer address.

Types
Union Types

CustomerNotLoggedInError

CustomerAddressDeletionError
Example
CustomerNotLoggedInError
Types

DeleteCustomerAddressInput

Description

Input for deleting a customer address.

Fields
Input Field Description
addressEntityId - Int! Address entity ID for the customer address to delete.
Example
{"addressEntityId": 987}
Types

DeleteCustomerAddressResult

Description

Result of DeleteCustomerAddress mutation.

Fields
Field Name Description
errors - [DeleteCustomerAddressError!]! Response errors that occurred while attempting to delete a customer address.
Example
{"errors": [CustomerNotLoggedInError]}
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": [987]}
Types

DeleteWishlistItemsResult

Description

Delete wishlist items

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

DeleteWishlistResult

Description

Delete wishlist

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

DeleteWishlistsInput

Description

Delete wishlists input object

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

DisplayField

Description

Display field

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

Distance

Description

Distance

Fields
Field Name Description
value - Float! Distance in specified length unit
lengthUnit - LengthUnit! Length unit
Example
{"value": 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": 987.65,
  "latitude": 123.45,
  "lengthUnit": "Kilometres"
}
Types

EmailAlreadyInUseError

Description

An error due to the customer email already being in use when attempting registration.

Fields
Field Name Description
message - String! A description of the error.
Example
{"message": "abc123"}
Types

EntityPageType

Description

Entity page type

Values
Enum Value Description

BLOG_POST

BRAND

CATEGORY

CONTACT_US

PAGE

PRODUCT
Example
"BLOG_POST"
Types

Error

Description

An error object, indicating what went wrong with a mutation.

Fields
Field Name Description
message - String! A description of the error
Possible Types
Error Types

AccountCreationDisabledError

AddressDoesNotExistError

AlreadyExistsError

CustomerAddressCreationError

CustomerAddressDeletionError

CustomerAddressUpdateError

CustomerAlreadyReviewedProductError

CustomerDoesNotExistError

CustomerNotLoggedInError

CustomerPasswordError

CustomerRegistrationError

EmailAlreadyInUseError

InvalidInputFieldsError

LimitExceededError

NotAuthorisedError

NotAuthorizedToAddProductReviewError

NotFoundError

ProductIdNotFoundError

UnexpectedAddReviewError

UnexpectedUpdateCustomerError

ValidationError
Example
{"message": "abc123"}
Types

ExternalLinkPage

Description

An external link page.

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

Float

Description

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

Example
123.45
Types

FormField

Description

The details of a form field.

Fields
Field Name Description
entityId - Int! The entity ID of the form field.
label - String! The label to display for the form field.
sortOrder - Int! The sort order priority of the form field.
isBuiltIn - Boolean! Indicates whether the form field is built-in.
isRequired - Boolean! Indicates whether the form field is required.
Possible Types
FormField Types

CheckboxesFormField

DateFormField

MultilineTextFormField

NumberFormField

PasswordFormField

PicklistFormField

PicklistOrTextFormField

RadioButtonsFormField

TextFormField
Example
{
  "entityId": 987,
  "label": "abc123",
  "sortOrder": 123,
  "isBuiltIn": false,
  "isRequired": true
}
Types

FormFieldFiltersInput

Description

Object containing filters for querying form fields.

Fields
Input Field Description
entityIds - [Int!] Filter by form field entity IDs.
isRequired - Boolean Filter by required form fields.
isBuiltIn - Boolean Filter by built-in form fields.
Example
{"entityIds": [123], "isRequired": true, "isBuiltIn": false}
Types

FormFieldOption

Description

The details of an option for a checkbox or multiple choice form field.

Fields
Field Name Description
entityId - Int! The entity ID of the form field option.
label - String! The label to display for the form field option.
Example
{"entityId": 123, "label": "abc123"}
Types

FormFieldSortInput

Description

The sorting to use on form field results.

Values
Enum Value Description

FIELD_ID

SORT_ORDER
Example
"FIELD_ID"
Types

FormFields

Description

The types of form fields that can be queried.

Fields
Field Name Description
customer - [FormField!]! The customer form fields.
Arguments
filters - FormFieldFiltersInput

Search filters for use when querying customer form fields.

sortBy - FormFieldSortInput

Sorting to use when querying customer form fields.
shippingAddress - [FormField!]! The shipping address form fields.
Arguments
filters - FormFieldFiltersInput

Search filters for use when querying shipping address form fields.

sortBy - FormFieldSortInput

Sorting to use when querying shipping address form fields.
billingAddress - [FormField!]! The billing address form fields.
Arguments
filters - FormFieldFiltersInput

Search filters for use when querying billing address form fields.

sortBy - FormFieldSortInput

Sorting to use when querying billing address form fields.
Example
{
  "customer": [FormField],
  "shippingAddress": [FormField],
  "billingAddress": [FormField]
}
Types

GA4Provider

Description

Google Analytics 4 provider.

Fields
Field Name Description
tagId - String! Google Analytics 4 tag ID.
Example
{"tagId": "xyz789"}
Types

Geography

Description

Geography information.

Fields
Field Name Description
countries - [Country!] A list of available countries.
Arguments
filters - CountryFiltersInput

An input parameter to narrow down the countries you receive based on country name and code.
Example
{"countries": [Country]}
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": "abc123",
  "allowComments": false,
  "previewImageUrl": "xyz789"
}
Types

GiftWrappingConnection

Description

A connection to a list of items.

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

GiftWrappingEdge

Description

An edge in a connection.

Fields
Field Name Description
node - GiftWrapping! The item at the end of the edge.
cursor - String! A cursor for use in pagination.
Example
{
  "node": GiftWrapping,
  "cursor": "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
4
Types

Image

Description

Image

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

Desired width of the image.

height - Int

Desired height of the image.

lossy - Boolean

Should image have lossy compression.
urlOriginal - String! Absolute path to original image using store CDN.
Arguments
lossy - Boolean

Should image have lossy compression.