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
}
}
}
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
}
}
}
geography
Description
Geography information.
Response
Returns a Geography!
Example
Query
query geography {
geography {
countries {
...CountryFragment
}
}
}
Response
{"data": {"geography": {"countries": [Country]}}}
inventory
Description
An inventory
Response
Returns an Inventory!
Example
Query
query inventory {
inventory {
locations {
...InventoryLocationConnectionFragment
}
}
}
Response
{
"data": {
"inventory": {
"locations": InventoryLocationConnection
}
}
}
node
Description
Fetches an object given its ID
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
}
}
}
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
}
}
}
catalog
Description
The catalog mutations.
Response
Returns a CatalogMutations!
Example
Query
mutation catalog {
catalog {
addProductReview {
...AddProductReviewResultFragment
}
}
}
Response
{
"data": {
"catalog": {
"addProductReview": AddProductReviewResult
}
}
}
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
}
}
}
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
}
}
}
login
Description
Customer login.
Response
Returns a LoginResult!
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
}
}
}
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
}
}
}
logout
Description
Customer logout
Response
Returns a LogoutResult!
Example
Query
mutation logout {
logout {
result
}
}
Response
{"data": {"logout": {"result": "abc123"}}}
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]}
}
}
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"}
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]
}
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
}
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}
AddCheckoutBillingAddressDataInput
Description
Add checkout billing address data object
Fields
Input Field | Description |
---|---|
address - CheckoutAddressInput!
|
The checkout billing address |
Example
{"address": CheckoutAddressInput}
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
}
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}
AddCheckoutShippingConsignmentsDataInput
Description
Add checkout shipping consignments data object
Fields
Input Field | Description |
---|---|
consignments - [CheckoutShippingConsignmentInput!]!
|
The list of shipping consignments |
Example
{"consignments": [CheckoutShippingConsignmentInput]}
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
}
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}
AddCustomerAddressError
Description
Possible response error when attempting to use AddCustomerAddress mutation.
Types
Union Types |
---|
Example
CustomerNotLoggedInError
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
}
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]
}
AddProductReviewError
Description
Error coming from submitting a product review.
Example
CustomerAlreadyReviewedProductError
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}
AddProductReviewResult
Description
Result of the addProductReview mutation.
Fields
Field Name | Description |
---|---|
errors - [AddProductReviewError!]!
|
Errors encountered while submitting the review. |
Example
{"errors": [CustomerAlreadyReviewedProductError]}
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]}
AddWishlistItemsResult
Description
Add wishlist items
Fields
Field Name | Description |
---|---|
result - Wishlist!
|
The wishlist |
Example
{"result": Wishlist}
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
}
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"}
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"
}
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}
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}
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"}
ApplyCheckoutCouponDataInput
Description
Apply checkout coupon data object
Fields
Input Field | Description |
---|---|
couponCode - String!
|
The checkout coupon code |
Example
{"couponCode": "xyz789"}
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
}
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}
ApplyCheckoutSpamProtectionDataInput
Description
Apply checkout spam protection data object
Fields
Input Field | Description |
---|---|
token - String!
|
The checkout spam protection token |
Example
{"token": "xyz789"}
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
}
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}
AssignCartToCustomerInput
Description
Assign cart to the customer input object.
Example
{"cartEntityId": "xyz789", "version": 987}
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}
Author
Description
Author
Fields
Field Name | Description |
---|---|
name - String!
|
Author name. |
Example
{"name": "xyz789"}
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"
}
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]
}
BannerEdge
BannerLocation
Description
Banner location
Values
Enum Value | Description |
---|---|
|
|
|
Example
"BOTTOM"
Banners
Description
Banners details.
Fields
Field Name | Description |
---|---|
homePage - BannerConnection!
|
List of home page banners. |
searchPage - BannerConnection!
|
List of search page banners. |
categoryPage - CategoryPageBannerConnection!
|
List of category page banners. |
brandPage - BrandPageBannerConnection!
|
List of brand page banners. |
Example
{
"homePage": BannerConnection,
"searchPage": BannerConnection,
"categoryPage": CategoryPageBannerConnection,
"brandPage": BrandPageBannerConnection
}
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 |
---|
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"
}
BigDecimal
Description
The BigDecimal
scalar type represents signed fractional values with arbitrary precision.
Example
BigDecimal
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. |
post - BlogPost
|
Blog post details. |
Arguments
|
|
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
}
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
}
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
|
|
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
}
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
}
BlogPostEdge
BlogPostRedirect
BlogPostsFiltersInput
Boolean
Description
The Boolean
scalar type represents true
or false
.
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
|
|
metafields - MetafieldConnection!
|
Metafield data related to a brand. |
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
}
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]
}
BrandEdge
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]
}
BrandPageBannerEdge
BrandRedirect
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. |
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
}
BrandSearchFilterItem
Description
Specific brand filter item
Example
{
"entityId": 987,
"name": "xyz789",
"isSelected": false,
"productCount": 123
}
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]
}
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"
}
Breadcrumb
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]
}
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"
}
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
}
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
}
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
}
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 |
---|
Example
{"minimumQuantity": 987, "maximumQuantity": 987}
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. |
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
}
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
}
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
}
CartDiscount
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"
}
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"
}
CartGiftCertificateRecipient
CartGiftCertificateRecipientInput
CartGiftCertificateSender
CartGiftCertificateSenderInput
CartGiftCertificateTheme
Description
Cart gift certificate theme
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BIRTHDAY"
CartGiftWrapping
Description
Gift wrapping for the item
Example
{
"name": "xyz789",
"amount": Money,
"message": "abc123"
}
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
}
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
}
CartMutations
Description
Cart mutations
Fields
Field Name | Description |
---|---|
createCart - CreateCartResult
|
Creates a cart and generates a cart ID. |
Arguments
|
|
deleteCart - DeleteCartResult
|
Deletes a Cart. |
Arguments
|
|
addCartLineItems - AddCartLineItemsResult
|
Adds line item(s) to the cart. |
Arguments
|
|
updateCartLineItem - UpdateCartLineItemResult
|
Updates line item in the cart. |
Arguments
|
|
deleteCartLineItem - DeleteCartLineItemResult
|
Delete line item in the cart. Removing the last line item in the Cart deletes the Cart. |
Arguments
|
|
updateCartCurrency - UpdateCartCurrencyResult
|
Update currency of the cart. |
Arguments
|
|
assignCartToCustomer - AssignCartToCustomerResult
|
Assign cart to the customer. |
Arguments
|
|
unassignCartFromCustomer - UnassignCartFromCustomerResult
|
Unassign cart from the customer. |
Arguments
|
|
createCartMetafield - CreateCartMetafieldResult!
|
Creates a metafield for cart object. |
Arguments
|
|
updateCartMetafield - UpdateCartMetafieldResult!
|
Updates a metafield for cart object. |
Arguments
|
|
deleteCartMetafield - DeleteCartMetafieldResult!
|
Deletes a metafield for cart object. |
Arguments
|
|
createCartRedirectUrls - CreateCartRedirectUrlsResult!
|
Create single-use redirect URLs for a cart. |
Arguments
|
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
}
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
}
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"
}
CartSelectedCheckboxOption
Description
Selected checkbox option.
Example
{
"entityId": 123,
"name": "xyz789",
"value": "xyz789",
"valueEntityId": 123
}
CartSelectedCheckboxOptionInput
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
}
CartSelectedDateFieldOptionInput
CartSelectedFileUploadOption
CartSelectedMultiLineTextFieldOption
CartSelectedMultiLineTextFieldOptionInput
CartSelectedMultipleChoiceOption
Description
Selected multiple choice option.
Example
{
"entityId": 987,
"name": "xyz789",
"value": "abc123",
"valueEntityId": 123
}
CartSelectedMultipleChoiceOptionInput
CartSelectedNumberFieldOption
CartSelectedNumberFieldOptionInput
CartSelectedOption
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]
}
CartSelectedTextFieldOption
CartSelectedTextFieldOptionInput
Catalog
Description
Storefront catalog settings.
Fields
Field Name | Description |
---|---|
productComparisonsEnabled - Boolean
|
Product comparisons enabled. |
Example
{"productComparisonsEnabled": false}
CatalogMutations
Description
Catalog mutations
Fields
Field Name | Description |
---|---|
addProductReview - AddProductReviewResult!
|
Add a product review. |
Arguments
|
Example
{"addProductReview": AddProductReviewResult}
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 |
---|
Example
{
"entityId": 123,
"displayName": "abc123",
"isRequired": false,
"isVariantOption": true
}
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 |
---|
Example
{
"entityId": 123,
"label": "abc123",
"isDefault": true,
"isSelected": true
}
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. |
products - ProductConnection!
|
List of products associated with category |
Arguments
|
|
metafields - MetafieldConnection!
|
Metafield data related to a category. |
seo - SeoDetails!
|
Category SEO details. |
shopByPriceRanges - ShopByPriceConnection!
|
Category shop by price money ranges. Alpha version. Do not use in production. |
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"
}
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]
}
CategoryEdge
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]
}
CategoryPageBannerEdge
CategoryProductSort
Description
Product sorting by categories.
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"A_TO_Z"
CategoryRedirect
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. |
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
}
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. |
Example
{
"entityId": 987,
"name": "abc123",
"isSelected": false,
"productCount": 123,
"subCategories": SubCategorySearchFilterItemConnection
}
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]
}
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"
}
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]
}
ChangePasswordError
Description
An error that occurred while changing a password.
Example
ValidationError
ChangePasswordInput
Description
The input for changing a customer password.
Example
{
"currentPassword": "abc123",
"newPassword": "xyz789"
}
ChangePasswordResult
Description
The result of changing a password.
Fields
Field Name | Description |
---|---|
errors - [ChangePasswordError!]!
|
Errors encountered while changing the password. |
Example
{"errors": [ValidationError]}
Channel
Description
The Channel
Fields
Field Name | Description |
---|---|
entityId - Long!
|
The ID of the channel. |
metafields - MetafieldConnection!
|
Metafield data related to a channel. |
Example
{"entityId": {}, "metafields": MetafieldConnection}
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
}
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
}
CheckboxesFormFieldInput
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"
}
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
}
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 |
---|
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]
}
CheckoutAddressCheckboxesCustomField
CheckoutAddressCheckboxesCustomFieldInput
CheckoutAddressCustomField
Description
Custom field of the checkout address.
Fields
Field Name | Description |
---|---|
entityId - Int!
|
Custom field ID. |
Possible Types
CheckoutAddressCustomField Types |
---|
Example
{"entityId": 987}
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]
}
CheckoutAddressDateCustomField
Description
Date custom field.
Fields
Field Name | Description |
---|---|
date - DateTimeExtended!
|
Date value. |
entityId - Int!
|
Custom field ID. |
Example
{"date": DateTimeExtended, "entityId": 987}
CheckoutAddressDateCustomFieldInput
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
}
CheckoutAddressMultipleChoiceCustomField
CheckoutAddressMultipleChoiceCustomFieldInput
CheckoutAddressNumberCustomField
CheckoutAddressNumberCustomFieldInput
CheckoutAddressPasswordCustomField
CheckoutAddressPasswordCustomFieldInput
CheckoutAddressTextCustomFieldInput
CheckoutAddressTextFieldCustomField
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
}
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]
}
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]
}
CheckoutConsignmentLineItemInput
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
}
CheckoutMutations
Description
Checkout mutations
Fields
Field Name | Description |
---|---|
addCheckoutBillingAddress - AddCheckoutBillingAddressResult
|
Creates a checkout billing address. |
Arguments
|
|
updateCheckoutBillingAddress - UpdateCheckoutBillingAddressResult
|
Update a checkout billing address. |
Arguments
|
|
updateCheckoutCustomerMessage - UpdateCheckoutCustomerMessageResult
|
Updates a checkout customer message. |
Arguments
|
|
selectCheckoutShippingOption - SelectCheckoutShippingOptionResult
|
Selects a checkout shipping option. |
Arguments
|
|
applyCheckoutCoupon - ApplyCheckoutCouponResult
|
Applies a checkout coupon. |
Arguments
|
|
unapplyCheckoutCoupon - UnapplyCheckoutCouponResult
|
Unapply a checkout coupon. |
Arguments
|
|
applyCheckoutSpamProtection - ApplyCheckoutSpamProtectionResult
|
Applies a checkout spam protection. |
Arguments
|
|
addCheckoutShippingConsignments - AddCheckoutShippingConsignmentsResult
|
Creates a checkout shipping consignments. |
Arguments
|
|
updateCheckoutShippingConsignment - UpdateCheckoutShippingConsignmentResult
|
Updates a checkout shipping consignments. |
Arguments
|
|
deleteCheckoutConsignment - DeleteCheckoutConsignmentResult
|
Deletes a checkout consignment. |
Arguments
|
|
completeCheckout - CompleteCheckoutResult
|
Completes the checkout. |
Arguments
|
Example
{
"addCheckoutBillingAddress": AddCheckoutBillingAddressResult,
"updateCheckoutBillingAddress": UpdateCheckoutBillingAddressResult,
"updateCheckoutCustomerMessage": UpdateCheckoutCustomerMessageResult,
"selectCheckoutShippingOption": SelectCheckoutShippingOptionResult,
"applyCheckoutCoupon": ApplyCheckoutCouponResult,
"unapplyCheckoutCoupon": UnapplyCheckoutCouponResult,
"applyCheckoutSpamProtection": ApplyCheckoutSpamProtectionResult,
"addCheckoutShippingConsignments": AddCheckoutShippingConsignmentsResult,
"updateCheckoutShippingConsignment": UpdateCheckoutShippingConsignmentResult,
"deleteCheckoutConsignment": DeleteCheckoutConsignmentResult,
"completeCheckout": CompleteCheckoutResult
}
CheckoutPromotion
Description
The checkout promotion
Fields
Field Name | Description |
---|---|
banners - [CheckoutPromotionBanner!]!
|
The checkout promotion banners. |
Example
{"banners": [CheckoutPromotionBanner]}
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"
}
CheckoutPromotionBannerLocation
Description
Checkout promotion banner location.
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"CART_PAGE"
CheckoutPromotionBannerType
Description
Checkout promotion banner type.
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"APPLIED"
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
}
CheckoutSettings
Description
Checkout settings.
Fields
Field Name | Description |
---|---|
reCaptchaEnabled - Boolean!
|
Indicates whether ReCaptcha is enabled on checkout. |
Example
{"reCaptchaEnabled": false}
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"]
}
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]
}
CheckoutTax
CollectionInfo
Description
Additional information about the collection.
Fields
Field Name | Description |
---|---|
totalItems - Long
|
Total items in the collection despite pagination. |
Example
{"totalItems": {}}
CompleteCheckoutInput
Description
Complete checkout input object
Fields
Input Field | Description |
---|---|
checkoutEntityId - String!
|
The checkout id |
Example
{"checkoutEntityId": "abc123"}
CompleteCheckoutResult
ContactField
Description
Contact field
Example
{
"address": "abc123",
"country": "abc123",
"addressType": "xyz789",
"email": "xyz789",
"phone": "xyz789"
}
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
|
|
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
}
Content
Description
The page content.
Fields
Field Name | Description |
---|---|
renderedRegionsByPageType - RenderedRegionsByPageType!
|
The rendered regions by specific page. |
Arguments
|
|
renderedRegionsByPageTypeAndEntityId - RenderedRegionsByPageType!
|
The rendered regions by specific page and id. |
Arguments
|
|
pages - PageConnection!
|
Details of the pages. |
Arguments
|
|
page - WebPage
|
Page details. |
Arguments
|
|
blog - Blog
|
Blog details. |
banners - Banners
|
Banners details. |
Example
{
"renderedRegionsByPageType": RenderedRegionsByPageType,
"renderedRegionsByPageTypeAndEntityId": RenderedRegionsByPageType,
"pages": PageConnection,
"page": WebPage,
"blog": Blog,
"banners": Banners
}
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]
}
CountryFiltersInput
Description
An input parameter to narrow down the countries you receive based on country name and code.
Example
{
"name": "abc123",
"code": "xyz789"
}
CouponType
Description
The coupon type.
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FREE_SHIPPING"
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"
}
CreateCartMetafieldDataInput
CreateCartMetafieldError
Description
Error that occured as a result of createCartMetafieldMutation.
Types
Union Types |
---|
Example
NotFoundError
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
}
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]
}
CreateCartRedirectUrlsError
Description
Error that occurs as a result of createCartRedirectUrlsMutation.
Types
Union Types |
---|
Example
NotFoundError
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]
}
CreateCartRedirectUrlsQueryParamsInput
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]
}
CreateCartResult
Description
Create cart result
Fields
Field Name | Description |
---|---|
cart - Cart
|
The Cart that is created as a result of mutation. |
Example
{"cart": Cart}
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]
}
CreateWishlistResult
Description
Create wishlist
Fields
Field Name | Description |
---|---|
result - Wishlist!
|
The newly created wishlist |
Example
{"result": Wishlist}
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
}
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]
}
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
}
CurrencyEdge
CurrencySymbolPosition
Description
Currency symbol position
Values
Enum Value | Description |
---|---|
|
|
|
Example
"LEFT"
CustomField
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]
}
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"
}
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
|
|
formFields - [CustomerFormFieldValue!]!
|
The form field values of the customer. |
addresses - AddressConnection!
|
Customer addresses. |
metafields - MetafieldConnection!
|
Metafield data related to a customer. |
orders - OrdersConnection
|
The Orders for the customer. |
Arguments
|
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
}
CustomerAccessToken
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]
}
CustomerAddressCreationError
Description
Unexpected error while creating a customer address.
Fields
Field Name | Description |
---|---|
message - String!
|
Error message. |
Example
{"message": "abc123"}
CustomerAddressDeletionError
Description
Unexpected error while deleting a customer address.
Fields
Field Name | Description |
---|---|
message - String!
|
Error message. |
Example
{"message": "xyz789"}
CustomerAddressUpdateError
Description
An unexpected error while updating an address for a customer.
Fields
Field Name | Description |
---|---|
message - String!
|
Error message. |
Example
{"message": "xyz789"}
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"}
CustomerAttribute
Description
A custom, store-specific attribute for a customer
Example
{
"entityId": 123,
"value": "xyz789",
"name": "abc123"
}
CustomerAttributes
Description
Custom, store-specific customer attributes
Fields
Field Name | Description |
---|---|
attribute - CustomerAttribute!
|
A custom, store-specific attribute for a customer |
Arguments
|
Example
{"attribute": CustomerAttribute}
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"}
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 |
---|
Example
{"entityId": 987, "name": "abc123"}
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]
}
CustomerMutations
Description
Mutations for customers domain.
Fields
Field Name | Description |
---|---|
changePassword - ChangePasswordResult!
|
Change the password for a customer. |
Arguments
|
|
requestResetPassword - RequestResetPasswordResult!
|
Request reset password email. |
Arguments
|
|
resetPassword - ResetPasswordResult!
|
Reset customer password |
Arguments
|
|
registerCustomer - RegisterCustomerResult!
|
Register a new customer. |
Arguments
|
|
updateCustomer - UpdateCustomerResult!
|
Update a customer. |
Arguments
|
|
addCustomerAddress - AddCustomerAddressResult!
|
Submit a customer address. |
Arguments
|
|
updateCustomerAddress - UpdateCustomerAddressResult!
|
Update a customer address. |
Arguments
|
|
deleteCustomerAddress - DeleteCustomerAddressResult!
|
Delete a customer address. |
Arguments
|
Example
{
"changePassword": ChangePasswordResult,
"requestResetPassword": RequestResetPasswordResult,
"resetPassword": ResetPasswordResult,
"registerCustomer": RegisterCustomerResult,
"updateCustomer": UpdateCustomerResult,
"addCustomerAddress": AddCustomerAddressResult,
"updateCustomerAddress": UpdateCustomerAddressResult,
"deleteCustomerAddress": DeleteCustomerAddressResult
}
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"}
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"}
CustomerRegistrationError
Description
An unexpected error while registering a customer.
Fields
Field Name | Description |
---|---|
message - String!
|
A description of the error. |
Example
{"message": "xyz789"}
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}
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
}
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
}
DateFormFieldInput
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"
}
DateTime
Description
ISO-8601 formatted date in UTC. (e.g. 2024-01-01T00:00:00Z)
Example
"2007-12-03T10:15:30Z"
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"}
DeleteCartInput
Description
Delete cart input object
Fields
Input Field | Description |
---|---|
cartEntityId - String!
|
The cart id |
Example
{"cartEntityId": "xyz789"}
DeleteCartLineItemInput
Description
Delete cart line item input object
Example
{
"cartEntityId": "abc123",
"lineItemEntityId": "abc123",
"version": 987
}
DeleteCartLineItemResult
Description
Delete cart lien item result
Example
{
"deletedLineItemEntityId": "xyz789",
"cart": Cart,
"deletedCartEntityId": "abc123"
}
DeleteCartMetafieldError
Description
Error that occured as a result of deleteCartMetafield mutation.
Types
Union Types |
---|
Example
NotFoundError
DeleteCartMetafieldInput
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]
}
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"}
DeleteCheckoutConsignmentInput
Description
Delete checkout consignment input object
Example
{
"checkoutEntityId": "abc123",
"consignmentEntityId": "xyz789",
"version": 123
}
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}
DeleteCustomerAddressError
Description
Possible response errors when attempting to delete a customer address.
Types
Union Types |
---|
Example
CustomerNotLoggedInError
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}
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]}
DeleteWishlistItemsInput
DeleteWishlistItemsResult
Description
Delete wishlist items
Fields
Field Name | Description |
---|---|
result - Wishlist!
|
The wishlist |
Example
{"result": Wishlist}
DeleteWishlistResult
Description
Delete wishlist
Fields
Field Name | Description |
---|---|
result - String!
|
The result of the operation |
Example
{"result": "xyz789"}
DeleteWishlistsInput
Description
Delete wishlists input object
Fields
Input Field | Description |
---|---|
entityIds - [Int!]!
|
The wishlist ids |
Example
{"entityIds": [123]}
DisplayField
Distance
Description
Distance
Fields
Field Name | Description |
---|---|
value - Float!
|
Distance in specified length unit |
lengthUnit - LengthUnit!
|
Length unit |
Example
{"value": 123.45, "lengthUnit": "Kilometres"}
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"
}
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"}
EntityPageType
Description
Entity page type
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BLOG_POST"
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 |
---|
Example
{"message": "abc123"}
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
}
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
}
Float
Description
The Float
scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
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. |
Example
{
"entityId": 987,
"label": "abc123",
"sortOrder": 123,
"isBuiltIn": false,
"isRequired": true
}
FormFieldFiltersInput
Description
Object containing filters for querying form fields.
Example
{"entityIds": [123], "isRequired": true, "isBuiltIn": false}
FormFieldOption
FormFieldSortInput
Description
The sorting to use on form field results.
Values
Enum Value | Description |
---|---|
|
|
|
Example
"FIELD_ID"
FormFields
Description
The types of form fields that can be queried.
Fields
Field Name | Description |
---|---|
customer - [FormField!]!
|
The customer form fields. |
Arguments
|
|
shippingAddress - [FormField!]!
|
The shipping address form fields. |
Arguments
|
|
billingAddress - [FormField!]!
|
The billing address form fields. |
Arguments
|
Example
{
"customer": [FormField],
"shippingAddress": [FormField],
"billingAddress": [FormField]
}
GA4Provider
Description
Google Analytics 4 provider.
Fields
Field Name | Description |
---|---|
tagId - String!
|
Google Analytics 4 tag ID. |
Example
{"tagId": "xyz789"}
Geography
Description
Geography information.
Fields
Field Name | Description |
---|---|
countries - [Country!]
|
A list of available countries. |
Arguments
|
Example
{"countries": [Country]}
GiftWrapping
Description
Gift wrapping for product
Example
{
"entityId": 123,
"name": "abc123",
"allowComments": false,
"previewImageUrl": "xyz789"
}
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]
}
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"
}
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