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
customerGroupName
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": 987,
"company": "xyz789",
"customerGroupId": 123,
"customerGroupName": "abc123",
"email": "abc123",
"firstName": "xyz789",
"lastName": "abc123",
"notes": "abc123",
"phone": "xyz789",
"taxExemptCategory": "abc123",
"addressCount": 987,
"attributeCount": 987,
"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
shopperPreferences
Description
Shopper preferences.
Response
Returns a ShopperPreferences!
Example
Query
query shopperPreferences {
shopperPreferences {
locale {
...ShopperLocaleFragment
}
}
}
Response
{
"data": {
"shopperPreferences": {"locale": ShopperLocale}
}
}
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
analytics
Description
A mutation namespace for managing and recording analytics events.
Response
Returns an AnalyticsMutations!
Example
Query
mutation analytics {
analytics {
productViewedEvent {
...ProductViewedEventResultFragment
}
pageViewedEvent {
...PageViewedEventResultFragment
}
visitStartedEvent {
...VisitStartedEventResultFragment
}
}
}
Response
{
"data": {
"analytics": {
"productViewedEvent": ProductViewedEventResult,
"pageViewedEvent": PageViewedEventResult,
"visitStartedEvent": VisitStartedEventResult
}
}
}
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
}
}
}
generateSessionSyncJwt
Description
Generate Session Sync JWT Token.
Response
Returns a GenerateSessionSyncTokenResult!
Arguments
| Name | Description |
|---|---|
redirectTo - String!
|
The route where to redirect after generation of token |
cartId - String
|
The cartId for which token should be created. |
visitorId - UUID
|
The visitor Id. |
ipAddress - IpAddress
|
IP4 or IP6 compatible address to include in the session redirect url |
paymentWalletData - PaymentWalletDataInput
|
The payment wallet data. |
visitId - UUID
|
The visit Id. |
Example
Query
mutation generateSessionSyncJwt(
$redirectTo: String!,
$cartId: String,
$visitorId: UUID,
$ipAddress: IpAddress,
$paymentWalletData: PaymentWalletDataInput,
$visitId: UUID
) {
generateSessionSyncJwt(
redirectTo: $redirectTo,
cartId: $cartId,
visitorId: $visitorId,
ipAddress: $ipAddress,
paymentWalletData: $paymentWalletData,
visitId: $visitId
) {
result {
...GenerateSessionSyncTokenDataFragment
}
errors {
... on GenerateSessionSyncTokenCartNotFound {
...GenerateSessionSyncTokenCartNotFoundFragment
}
}
}
}
Variables
{
"redirectTo": "xyz789",
"cartId": "xyz789",
"visitorId": "32e943b4-3aae-4d71-9837-ddf318e1b489",
"ipAddress": IpAddress,
"paymentWalletData": PaymentWalletDataInput,
"visitId": "32e943b4-3aae-4d71-9837-ddf318e1b489"
}
Response
{
"data": {
"generateSessionSyncJwt": {
"result": GenerateSessionSyncTokenData,
"errors": [GenerateSessionSyncTokenCartNotFound]
}
}
}
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": "xyz789"
}
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": "abc123"
}
Response
{
"data": {
"loginWithCustomerLoginJwt": {
"redirectTo": "xyz789",
"customer": Customer,
"cart": Cart,
"customerAccessToken": CustomerAccessToken
}
}
}
logout
Description
Customer logout
Response
Returns a LogoutResult!
Arguments
| Name | Description |
|---|---|
cartEntityId - String
|
The customer cart entity ID which should be unassigned on logout. |
Example
Query
mutation logout($cartEntityId: String) {
logout(cartEntityId: $cartEntityId) {
result
cartUnassignResult {
...CartUnassignResultFragment
}
}
}
Variables
{"cartEntityId": "abc123"}
Response
{
"data": {
"logout": {
"result": "abc123",
"cartUnassignResult": CartUnassignResult
}
}
}
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]}
}
}
validateSessionSyncJwt
Description
Unwrapping encoded in jwt token session state.
Response
Returns a ValidateSessionSyncJwtResult!
Arguments
| Name | Description |
|---|---|
jwt - String!
|
jwt token session state with encoded session state. |
Example
Query
mutation validateSessionSyncJwt($jwt: String!) {
validateSessionSyncJwt(jwt: $jwt) {
content {
...SessionSyncJwtContentFragment
}
errors {
... on InvalidSessionSyncJwtError {
...InvalidSessionSyncJwtErrorFragment
}
... on JwtTokenExpiredError {
...JwtTokenExpiredErrorFragment
}
}
}
}
Variables
{"jwt": "xyz789"}
Response
{
"data": {
"validateSessionSyncJwt": {
"content": SessionSyncJwtContent,
"errors": [InvalidSessionSyncJwtError]
}
}
}
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 in user language. |
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": 123
}
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": "abc123",
"data": AddCheckoutBillingAddressDataInput,
"version": 987
}
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": "xyz789",
"data": AddCheckoutShippingConsignmentsDataInput,
"version": 123
}
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": "abc123",
"lastName": "abc123",
"address1": "xyz789",
"address2": "abc123",
"city": "abc123",
"company": "abc123",
"countryCode": "abc123",
"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": 123, "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!
|
A description of the error in user language. |
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 in user language. |
Example
{"message": "abc123"}
AnalyticsCommonEventInput
Description
A common input object for analytics events containing shared fields.
Fields
| Input Field | Description |
|---|---|
initiator - AnalyticsEventInitiatorInput!
|
Details about the initiator of the analytics event. |
request - AnalyticsEventRequestInput!
|
Request-related details for the analytics event. |
consent - AnalyticsEventConsentInput
|
Consent-related details for the analytics event. |
Example
{
"initiator": AnalyticsEventInitiatorInput,
"request": AnalyticsEventRequestInput,
"consent": AnalyticsEventConsentInput
}
AnalyticsEventConsentInput
Description
Input object for capturing user consent details in analytics events.
Example
{"targeting": true, "analytics": true, "functional": true}
AnalyticsEventInitiatorInput
Description
Input object representing the initiator of an analytics event.
Example
{
"visitId": "abc123",
"visitorId": "abc123"
}
AnalyticsEventRequestInput
Description
Input object containing request-related details for analytics events.
Fields
| Input Field | Description |
|---|---|
url - URL!
|
URL associated with the analytics event request. |
userAgent - String!
|
User agent string from the request header. |
refererUrl - URL
|
Referrer URL for the analytics event request. |
ip - IpAddress
|
IP address associated with the request. |
acceptLanguage - String
|
Accepted language preference from the request header. |
Example
{
"url": "http://www.test.com/",
"userAgent": "abc123",
"refererUrl": "http://www.test.com/",
"ip": IpAddress,
"acceptLanguage": "abc123"
}
AnalyticsMutations
Description
A collection of mutations related to analytics events, such as product views, page views, and visit starts.
Fields
| Field Name | Description |
|---|---|
productViewedEvent - ProductViewedEventResult!
|
Mutation to record a product view event in the analytics system. |
Arguments
|
|
pageViewedEvent - PageViewedEventResult!
|
Mutation to record a page view event in the analytics system. |
Arguments
|
|
visitStartedEvent - VisitStartedEventResult!
|
Mutation to record the start of a user visit in the analytics system. |
Arguments
|
|
Example
{
"productViewedEvent": ProductViewedEventResult,
"pageViewedEvent": PageViewedEventResult,
"visitStartedEvent": VisitStartedEventResult
}
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": 987
}
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": "xyz789",
"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": 123}
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 |
metafields - MetafieldConnection!
|
Metafield data related to an order. |
cartMetafields - MetafieldConnection!
|
Cart metafields associated with the order. |
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",
"metafields": MetafieldConnection,
"cartMetafields": MetafieldConnection
}
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": "abc123",
"description": "xyz789",
"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. |
breadcrumbs - BreadcrumbConnection!
|
Web page breadcrumbs. |
name - String!
|
Page name. |
isVisibleInNavigation - Boolean!
|
Whether or not the page should be visible in the navigation menu. |
seo - SeoDetails!
|
Page SEO details. |
children - PageConnection!
|
Details of the web page children. |
Arguments
|
|
Example
{
"id": "4",
"path": "abc123",
"renderedRegions": RenderedRegionsByPageType,
"entityId": 123,
"parentEntityId": 123,
"breadcrumbs": BreadcrumbConnection,
"name": "xyz789",
"isVisibleInNavigation": true,
"seo": SeoDetails,
"children": PageConnection
}
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": 123,
"name": "abc123",
"tags": ["abc123"],
"path": "xyz789",
"htmlBody": "abc123",
"plainTextSummary": "abc123",
"publishedDate": DateTimeExtended,
"author": "abc123",
"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.
Example
true
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": 123,
"name": "abc123",
"defaultImage": Image,
"pageTitle": "xyz789",
"metaDesc": "abc123",
"metaKeywords": ["abc123"],
"seo": SeoDetails,
"searchKeywords": ["abc123"],
"path": "xyz789",
"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": true,
"brands": BrandSearchFilterItemConnection,
"name": "abc123",
"isCollapsedByDefault": false
}
BrandSearchFilterItem
Description
Specific brand filter item
Example
{
"entityId": 123,
"name": "abc123",
"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": 123
}
BulkPricingPercentageDiscount
Description
Bulk pricing tier that reduces the price of the product or variant by a percentage.
Fields
| Field Name | Description |
|---|---|
percentOff - BigDecimal!
|
The percentage that will be removed from the product price. |
minimumQuantity - Int!
|
Minimum item quantity that applies to this bulk pricing tier. |
maximumQuantity - Int
|
Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. |
Example
{
"percentOff": BigDecimal,
"minimumQuantity": 987,
"maximumQuantity": 987
}
BulkPricingRelativePriceDiscount
Description
Bulk pricing tier that will subtract an amount from the price of the product or variant.
Fields
| Field Name | Description |
|---|---|
priceAdjustment - BigDecimal!
|
The price of the product/variant will be reduced by this priceAdjustment. |
minimumQuantity - Int!
|
Minimum item quantity that applies to this bulk pricing tier. |
maximumQuantity - Int
|
Maximum item quantity that applies to this bulk pricing tier - if not defined then the tier does not have an upper bound. |
Example
{
"priceAdjustment": BigDecimal,
"minimumQuantity": 123,
"maximumQuantity": 123
}
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": 123, "maximumQuantity": 987}
CacheControlScope
Description
Scope which describes how to cache the query
Values
| Enum Value | Description |
|---|---|
|
|
Public means that query result is available for all users. |
Example
"PUBLIC"
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. |
displayCurrencyCode - String!
|
ISO-4217 currency code. Applied DisplayCurrencyCode for the cart. |
isTaxIncluded - Boolean!
|
Whether this item is taxable. |
baseAmount - Money!
|
Cost of cart's contents, before applying discounts. |
baseAmountInDisplayCurrency - Money!
|
Base amount in display currency. |
discountedAmount - Money!
|
Discounted amount. |
discountedAmountInDisplayCurrency - Money!
|
Discounted amount in display currency. |
amount - Money!
|
Sum of line-items amounts, minus cart-level discounts and coupons. This amount includes taxes (where applicable). |
amountInDisplayCurrency - Money!
|
Amount in display currency. |
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",
"displayCurrencyCode": "xyz789",
"isTaxIncluded": false,
"baseAmount": Money,
"baseAmountInDisplayCurrency": Money,
"discountedAmount": Money,
"discountedAmountInDisplayCurrency": Money,
"amount": Money,
"amountInDisplayCurrency": Money,
"discounts": [CartDiscount],
"lineItems": CartLineItems,
"createdAt": DateTimeExtended,
"updatedAt": DateTimeExtended,
"locale": "xyz789",
"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. |
listPriceInDisplayCurrency - Money!
|
List price in display currency. |
extendedListPrice - Money!
|
Item's list price multiplied by the quantity. |
extendedListPriceInDisplayCurrency - Money!
|
Extended list price in display currency. |
Example
{
"entityId": "xyz789",
"sku": "xyz789",
"name": "xyz789",
"quantity": 987,
"listPrice": Money,
"listPriceInDisplayCurrency": Money,
"extendedListPrice": Money,
"extendedListPriceInDisplayCurrency": 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. Use path instead
|
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). |
discountedAmountInDisplayCurrency - Money!
|
Discounted amount in display currency. |
couponAmount - Money!
|
The total value of all coupons applied to this item. |
couponAmountInDisplayCurrency - Money!
|
Coupon amount in display currency. |
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. |
listPriceInDisplayCurrency - Money!
|
List price in display currency. |
originalPrice - Money!
|
An item’s original price is the same as the product default price in the admin panel. |
originalPriceInDisplayCurrency - Money!
|
Original price in display currency. |
salePrice - Money!
|
Item's price after all discounts are applied. (The final price before tax calculation). |
salePriceInDisplayCurrency - Money!
|
Sale price in display currency. |
extendedListPrice - Money!
|
Item's list price multiplied by the quantity. |
extendedListPriceInDisplayCurrency - Money!
|
Extended list price in display currency. |
extendedSalePrice - Money!
|
Item's sale price multiplied by the quantity. |
extendedSalePriceInDisplayCurrency - Money!
|
Extended sale price in display currency. |
selectedOptions - [CartSelectedOption!]!
|
The list of selected options for this product. |
path - String!
|
Relative URL path to product page. |
image - Image
|
Image for the item. |
baseCatalogProduct - Product
|
The base product information. |
catalogProductWithOptionSelections - Product
|
The product with option selections applied. |
Example
{
"entityId": "abc123",
"parentEntityId": "xyz789",
"productEntityId": 123,
"variantEntityId": 123,
"sku": "xyz789",
"name": "abc123",
"url": "xyz789",
"imageUrl": "xyz789",
"brand": "xyz789",
"quantity": 123,
"isTaxable": false,
"discounts": [CartDiscount],
"discountedAmount": Money,
"discountedAmountInDisplayCurrency": Money,
"couponAmount": Money,
"couponAmountInDisplayCurrency": Money,
"listPrice": Money,
"listPriceInDisplayCurrency": Money,
"originalPrice": Money,
"originalPriceInDisplayCurrency": Money,
"salePrice": Money,
"salePriceInDisplayCurrency": Money,
"extendedListPrice": Money,
"extendedListPriceInDisplayCurrency": Money,
"extendedSalePrice": Money,
"extendedSalePriceInDisplayCurrency": Money,
"selectedOptions": [CartSelectedOption],
"path": "xyz789",
"image": Image,
"baseCatalogProduct": Product,
"catalogProductWithOptionSelections": Product
}
CartDiscount
Description
Discount applied to the cart.
Example
{
"entityId": "xyz789",
"discountedAmount": Money,
"discountedAmountInDisplayCurrency": Money
}
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. |
amountInDisplayCurrency - Money!
|
Amount in display 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": "xyz789",
"theme": "BIRTHDAY",
"amount": Money,
"amountInDisplayCurrency": Money,
"isTaxable": true,
"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": "abc123",
"amount": Money,
"amountInDisplayCurrency": Money,
"message": "xyz789"
}
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": 987,
"productEntityId": 987,
"variantEntityId": 123,
"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": 123
}
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. Use path instead
|
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). |
discountedAmountInDisplayCurrency - Money!
|
Discounted amount in display currency. |
couponAmount - Money!
|
The total value of all coupons applied to this item. |
couponAmountInDisplayCurrency - Money!
|
Coupon amount in display currency. |
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. |
listPriceInDisplayCurrency - Money!
|
List price in display currency. |
originalPrice - Money!
|
An item’s original price is the same as the product default price in the admin panel. |
originalPriceInDisplayCurrency - Money!
|
Original price in display currency. |
salePrice - Money!
|
Item's price after all discounts are applied. (The final price before tax calculation). |
salePriceInDisplayCurrency - Money!
|
Sale price in display currency. |
extendedListPrice - Money!
|
Item's list price multiplied by the quantity. |
extendedListPriceInDisplayCurrency - Money!
|
Extended list price in display currency. |
extendedSalePrice - Money!
|
Item's sale price multiplied by the quantity. |
extendedSalePriceInDisplayCurrency - Money!
|
Extended sale price in display currency. |
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. |
path - String!
|
Relative URL path to product page. |
image - Image
|
Image for the item. |
baseCatalogProduct - Product
|
The base product information. |
catalogProductWithOptionSelections - Product
|
The product with option selections applied. |
Example
{
"entityId": "xyz789",
"parentEntityId": "xyz789",
"productEntityId": 987,
"variantEntityId": 123,
"sku": "xyz789",
"name": "xyz789",
"url": "abc123",
"imageUrl": "xyz789",
"brand": "abc123",
"quantity": 987,
"isTaxable": false,
"discounts": [CartDiscount],
"discountedAmount": Money,
"discountedAmountInDisplayCurrency": Money,
"couponAmount": Money,
"couponAmountInDisplayCurrency": Money,
"listPrice": Money,
"listPriceInDisplayCurrency": Money,
"originalPrice": Money,
"originalPriceInDisplayCurrency": Money,
"salePrice": Money,
"salePriceInDisplayCurrency": Money,
"extendedListPrice": Money,
"extendedListPriceInDisplayCurrency": Money,
"extendedSalePrice": Money,
"extendedSalePriceInDisplayCurrency": Money,
"isShippingRequired": true,
"selectedOptions": [CartSelectedOption],
"giftWrapping": CartGiftWrapping,
"path": "xyz789",
"image": Image,
"baseCatalogProduct": Product,
"catalogProductWithOptionSelections": Product
}
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": "xyz789",
"embeddedCheckoutUrl": "abc123"
}
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": 123,
"name": "abc123",
"value": "xyz789",
"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
CartUnassignError
Description
An error with cart unassign occurred during a logout.
Types
| Union Types |
|---|
Example
CartUnassignInaccessibleError
CartUnassignInaccessibleError
Description
Error indicating that there was an exception during cart unassign.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "abc123"}
CartUnassignNotAllowedError
Description
Error indicating that the request is a stateful while this operation can be performed only as stateless.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
CartUnassignResult
Description
Result of unassigning the cart during logout
Fields
| Field Name | Description |
|---|---|
cart - Cart
|
The cart which was unassigned. |
errors - [CartUnassignError!]!
|
List of errors which happened during unassign operation. |
Example
{
"cart": Cart,
"errors": [CartUnassignInaccessibleError]
}
Catalog
Description
Storefront catalog settings.
Fields
| Field Name | Description |
|---|---|
productComparisonsEnabled - Boolean
|
Product comparisons enabled. |
Example
{"productComparisonsEnabled": true}
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": 987,
"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": 987,
"label": "abc123",
"isDefault": false,
"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": 987,
"name": "xyz789",
"path": "xyz789",
"defaultImage": Image,
"description": "abc123",
"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
CategoryEntityIdsFilterInput
Description
Filter input for a list of integer IDs, that supports various matching behaviors.
Fields
| Input Field | Description |
|---|---|
entityIds - [Int!]!
|
List of integer IDs. |
matchBehavior - ListMatchBehavior!
|
Match behavior for the list of IDs. OR - match any of the IDs in the list. AND - match all the IDs in the list. Default = OR |
Example
{"entityIds": [987], "matchBehavior": "AND"}
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": "xyz789",
"isCollapsedByDefault": false
}
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": 123,
"name": "xyz789",
"isSelected": false,
"productCount": 987,
"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": "xyz789"
}
CategoryTreeItem
Description
An item in a tree of categories.
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
The id category. |
name - String!
|
The name of category. |
path - String!
|
Path assigned to this category |
description - String!
|
The description of this category. |
productCount - Int!
|
The number of products in this category. |
image - Image
|
The category image. |
hasChildren - Boolean!
|
If a category has children. |
children - [CategoryTreeItem!]!
|
Subcategories of this category |
Example
{
"entityId": 987,
"name": "xyz789",
"path": "xyz789",
"description": "xyz789",
"productCount": 123,
"image": Image,
"hasChildren": true,
"children": [CategoryTreeItem]
}
ChangePasswordError
Description
An error that occurred while changing a password.
Example
ValidationError
ChangePasswordInput
Description
The input for changing a customer password.
Example
{
"currentPassword": "xyz789",
"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": 987,
"uncheckedOptionValueEntityId": 987,
"entityId": 123,
"displayName": "abc123",
"isRequired": false,
"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": 987,
"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. |
currencyCode - String!
|
ISO-4217 currency code of the checkout. |
displayCurrencyCode - String!
|
ISO-4217 currency code. Applied DisplayCurrencyCode for the checkout. |
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. |
shippingCostTotalInDisplayCurrency - Money
|
Total shipping cost in display currency. |
giftWrappingCostTotal - Money
|
Gift wrapping cost for all items, including or excluding tax. |
giftWrappingCostTotalInDisplayCurrency - Money
|
Gift wrapping cost in display currency. |
handlingCostTotal - Money
|
Handling cost for all consignments including or excluding tax. |
handlingCostTotalInDisplayCurrency - Money
|
Handling cost in display currency. |
taxTotal - Money
|
Total amount of taxes applied. |
taxTotalInDisplayCurrency - Money
|
Total amount of taxes in display currency. |
taxes - [CheckoutTax!]
|
List of taxes applied. |
subtotal - Money
|
Subtotal of the checkout before applying item-level discounts. Tax inclusive based on the store settings. |
subtotalInDisplayCurrency - Money
|
Subtotal in display currency. |
grandTotal - Money
|
The total payable amount, before applying any store credit or gift certificate. |
grandTotalInDisplayCurrency - Money
|
Grand total in display currency. |
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. |
outstandingBalanceInDisplayCurrency - Money
|
Outstanding balance in display currency. |
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",
"currencyCode": "xyz789",
"displayCurrencyCode": "abc123",
"billingAddress": CheckoutBillingAddress,
"cart": Cart,
"shippingConsignments": [CheckoutShippingConsignment],
"order": Order,
"shippingCostTotal": Money,
"shippingCostTotalInDisplayCurrency": Money,
"giftWrappingCostTotal": Money,
"giftWrappingCostTotalInDisplayCurrency": Money,
"handlingCostTotal": Money,
"handlingCostTotalInDisplayCurrency": Money,
"taxTotal": Money,
"taxTotalInDisplayCurrency": Money,
"taxes": [CheckoutTax],
"subtotal": Money,
"subtotalInDisplayCurrency": Money,
"grandTotal": Money,
"grandTotalInDisplayCurrency": Money,
"createdAt": DateTimeExtended,
"updatedAt": DateTimeExtended,
"customerMessage": "abc123",
"outstandingBalance": Money,
"outstandingBalanceInDisplayCurrency": Money,
"coupons": [CheckoutCoupon],
"promotions": [CheckoutPromotion],
"version": 987
}
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": "xyz789",
"lastName": "abc123",
"email": "xyz789",
"company": "xyz789",
"address1": "abc123",
"address2": "xyz789",
"city": "abc123",
"stateOrProvince": "abc123",
"stateOrProvinceCode": "abc123",
"countryCode": "xyz789",
"postalCode": "abc123",
"phone": "abc123",
"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": "xyz789",
"address2": "abc123",
"city": "abc123",
"stateOrProvince": "abc123",
"stateOrProvinceCode": "xyz789",
"countryCode": "xyz789",
"postalCode": "abc123",
"phone": "abc123",
"customFields": CheckoutAddressCustomFieldInput,
"shouldSaveAddress": false
}
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. |
costInDisplayCurrency - Money!
|
Shipping option cost in display currency. |
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": "abc123",
"description": "xyz789",
"type": "xyz789",
"imageUrl": "abc123",
"cost": Money,
"costInDisplayCurrency": Money,
"transitTime": "abc123",
"isRecommended": true,
"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": "xyz789",
"firstName": "xyz789",
"lastName": "abc123",
"email": "abc123",
"company": "xyz789",
"address1": "xyz789",
"address2": "xyz789",
"city": "abc123",
"stateOrProvince": "xyz789",
"stateOrProvinceCode": "xyz789",
"countryCode": "abc123",
"postalCode": "xyz789",
"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": "xyz789",
"lastName": "xyz789",
"email": "abc123",
"company": "abc123",
"address1": "xyz789",
"address2": "abc123",
"city": "xyz789",
"stateOrProvince": "abc123",
"stateOrProvinceCode": "xyz789",
"countryCode": "xyz789",
"postalCode": "abc123",
"phone": "xyz789",
"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. |
discountedAmountInDisplayCurrency - Money!
|
Discounted amount in display currency. |
Example
{
"entityId": 123,
"code": "xyz789",
"couponType": "FREE_SHIPPING",
"discountedAmount": Money,
"discountedAmountInDisplayCurrency": 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": "xyz789"
}
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. |
costInDisplayCurrency - Money!
|
Shipping option cost in display currency. |
transitTime - String
|
An estimate of the arrival time. |
image - Image
|
Shipping option image. |
Example
{
"entityId": "abc123",
"description": "xyz789",
"type": "abc123",
"imageUrl": "abc123",
"cost": Money,
"costInDisplayCurrency": Money,
"transitTime": "xyz789",
"image": Image
}
CheckoutSettings
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. |
shippingCostInDisplayCurrency - Money
|
Shipping cost in display currency. |
handlingCost - Money
|
The handling cost of shipping for the consignment. |
handlingCostInDisplayCurrency - Money
|
Handling cost in display currency. |
lineItemIds - [String!]!
|
List of line item IDs for the consignment. |
Example
{
"entityId": "abc123",
"address": CheckoutConsignmentAddress,
"availableShippingOptions": [
CheckoutAvailableShippingOption
],
"selectedShippingOption": CheckoutSelectedShippingOption,
"coupons": [CheckoutCoupon],
"shippingCost": Money,
"shippingCostInDisplayCurrency": Money,
"handlingCost": Money,
"handlingCostInDisplayCurrency": Money,
"lineItemIds": ["xyz789"]
}
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": "xyz789",
"addressType": "xyz789",
"email": "abc123",
"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. |
breadcrumbs - BreadcrumbConnection!
|
Web page breadcrumbs. |
name - String!
|
Page name. |
isVisibleInNavigation - Boolean!
|
Whether or not the page should be visible in the navigation menu. |
seo - SeoDetails!
|
Page SEO details. |
children - PageConnection!
|
Details of the web page children. |
Arguments
|
|
Example
{
"id": "4",
"path": "abc123",
"htmlBody": "xyz789",
"plainTextSummary": "abc123",
"contactFields": ["abc123"],
"renderedRegions": RenderedRegionsByPageType,
"entityId": 123,
"parentEntityId": 123,
"breadcrumbs": BreadcrumbConnection,
"name": "abc123",
"isVisibleInNavigation": false,
"seo": SeoDetails,
"children": PageConnection
}
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. |
scripts - ScriptTypeConnection!
|
Collection of scripts |
Arguments |
|
Example
{
"renderedRegionsByPageType": RenderedRegionsByPageType,
"renderedRegionsByPageTypeAndEntityId": RenderedRegionsByPageType,
"pages": PageConnection,
"page": WebPage,
"blog": Blog,
"banners": Banners,
"scripts": ScriptTypeConnection
}
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": "abc123"
}
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": "abc123",
"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. |
ipAddress - IpAddress
|
IP4 or IP6 compatible address to include in the session redirect url |
visitorId - UUID
|
Visitor id to synchronise analytics data on session synchronization. |
visitId - UUID
|
Visit id to synchronise analytics data on session synchronization. |
Example
{
"cartEntityId": "xyz789",
"queryParams": [CreateCartRedirectUrlsQueryParamsInput],
"ipAddress": IpAddress,
"visitorId": "32e943b4-3aae-4d71-9837-ddf318e1b489",
"visitId": "32e943b4-3aae-4d71-9837-ddf318e1b489"
}
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": false,
"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!
|
Shopper selected currency. |
exchangeRate - Float!
|
Exchange rate relative to default currency. |
isTransactional - Boolean!
|
Indicates whether this currency is transactional. |
display - CurrencyDisplay!
|
Currency display settings. |
isDefault - Boolean!
|
Indicates whether this currency is selected as the default one in the control panel. |
Example
{
"entityId": 987,
"code": "ADP",
"name": "abc123",
"flagImage": "abc123",
"isActive": false,
"exchangeRate": 987.65,
"isTransactional": false,
"display": CurrencyDisplay,
"isDefault": false
}
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": "xyz789",
"symbolPlacement": "LEFT",
"decimalToken": "xyz789",
"thousandsToken": "xyz789",
"decimalPlaces": 987
}
CurrencyEdge
CurrencySettings
Description
Currency settings.
Fields
| Field Name | Description |
|---|---|
defaultCurrency - currencyCode!
|
The default currency. |
Example
{"defaultCurrency": "ADP"}
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": "xyz789"
}
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. |
customerGroupName - String
|
The customer group name 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,
"customerGroupName": "xyz789",
"email": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"notes": "abc123",
"phone": "abc123",
"taxExemptCategory": "abc123",
"addressCount": 987,
"attributeCount": 987,
"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. |
addressType - DestinationAddressType
|
Address type (Residential or Commercial). |
city - String!
|
City. |
country - String
|
Country name. |
countryId - Int
|
Country ID as available in BigCommerce Geography (https://developer.bigcommerce.com/docs/rest-management/geography/countries#get-all-countries). |
countryCode - String!
|
2-letter country code. |
stateOrProvince - String
|
Name of State or Province. |
stateId - Int
|
State Id as available in BigCommerce Geography (https://developer.bigcommerce.com/docs/rest-management/geography/states#get-all-states). |
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": 987,
"firstName": "abc123",
"lastName": "xyz789",
"address1": "abc123",
"address2": "xyz789",
"addressType": "COMMERCIAL",
"city": "xyz789",
"country": "abc123",
"countryId": 987,
"countryCode": "abc123",
"stateOrProvince": "abc123",
"stateId": 987,
"phone": "xyz789",
"postalCode": "xyz789",
"company": "abc123",
"formFields": [CustomerFormFieldValue]
}
CustomerAddressCreationError
Description
Unexpected error while creating a customer address.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
CustomerAddressDeletionError
Description
Unexpected error while deleting a customer address.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
CustomerAddressUpdateError
Description
An unexpected error while updating an address for a customer.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
CustomerAlreadyReviewedProductError
Description
An error resulting from a customer submitting multiple reviews to the same product.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
CustomerAttribute
Description
A custom, store-specific attribute for a customer
Example
{
"entityId": 123,
"value": "abc123",
"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!
|
A description of the error in user language. |
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": 123, "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!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
CustomerPasswordError
Description
An error that occurred when a customer password is being changed or reset.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
CustomerRegistrationError
Description
An unexpected error while registering a customer.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "abc123"}
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": 987,
"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": 987,
"label": "xyz789",
"sortOrder": 123,
"isBuiltIn": false,
"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": 987,
"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": 123}
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": [987]}
DestinationAddressType
Description
Destination address type (Residential or Commercial).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"COMMERCIAL"
DisplayField
Distance
Description
Distance
Fields
| Field Name | Description |
|---|---|
value - Float!
|
Distance in specified length unit |
lengthUnit - LengthUnit!
|
Length unit |
Example
{"value": 987.65, "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": 123.45,
"latitude": 987.65,
"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 in user language. |
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 in user language. |
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. |
breadcrumbs - BreadcrumbConnection!
|
Web page breadcrumbs. |
name - String!
|
Page name. |
isVisibleInNavigation - Boolean!
|
Whether or not the page should be visible in the navigation menu. |
seo - SeoDetails!
|
Page SEO details. |
children - PageConnection!
|
Details of the web page children. |
Arguments
|
|
Example
{
"link": "abc123",
"entityId": 123,
"parentEntityId": 123,
"breadcrumbs": BreadcrumbConnection,
"name": "xyz789",
"isVisibleInNavigation": false,
"seo": SeoDetails,
"children": PageConnection
}
FileUploadFieldOption
Description
A form allowing selection and uploading of a file from the user's local computer.
Fields
| Field Name | Description |
|---|---|
maxFileSize - Int!
|
The maximum size of the file in kilobytes |
fileTypes - [String!]!
|
All possible file extensions. Empty means that all files allowed. |
entityId - Int!
|
Unique ID for the option. |
displayName - String!
|
Display name for the option. |
isRequired - Boolean!
|
One of the option values is required to be selected for the checkout. |
isVariantOption - Boolean!
|
Indicates whether it is a variant option or modifier. |
Example
{
"maxFileSize": 987,
"fileTypes": ["xyz789"],
"entityId": 123,
"displayName": "xyz789",
"isRequired": true,
"isVariantOption": true
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
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": 987,
"isBuiltIn": false,
"isRequired": true
}
FormFieldFiltersInput
Description
Object containing filters for querying form fields.
Example
{"entityIds": [987], "isRequired": false, "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": "abc123"}
GenerateSessionSyncTokenCartNotFound
Description
Error that occurred as a result of generateSessionSyncJwtToken mutation when cartId is provided and not found.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "abc123"}
GenerateSessionSyncTokenData
GenerateSessionSyncTokenError
Description
Error that occurred as a result of generateSessionSyncJwtToken mutation.
Types
| Union Types |
|---|
Example
GenerateSessionSyncTokenCartNotFound
GenerateSessionSyncTokenResult
Description
Result of the generateSessionSyncJwtToken mutation.
Fields
| Field Name | Description |
|---|---|
result - GenerateSessionSyncTokenData
|
The result of the mutation when successful. |
errors - [GenerateSessionSyncTokenError!]!
|
The errors that occurred during the mutation. |
Example
{
"result": GenerateSessionSyncTokenData,
"errors": [GenerateSessionSyncTokenCartNotFound]
}
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": "xyz789",
"allowComments": false,
"previewImageUrl": "abc123"
}
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": "xyz789"
}
HstsSettings
Description
HSTS settings
Fields
| Field Name | Description |
|---|---|
hstsOnStorefrontEnabled - Boolean!
|
Flag indicating if HSTS is enabled on storefront. |
hstsInPreloadEnabled - Boolean!
|
Flag indicating if HSTS is enabled in preload. |
hstsInSubdomainsEnabled - Boolean!
|
Flag indicating if HSTS is enabled in subdomains. |
hstsMaxAgeDurationSeconds - Long!
|
Value of Max-Age header for HSTS. |
Example
{
"hstsOnStorefrontEnabled": true,
"hstsInPreloadEnabled": true,
"hstsInSubdomainsEnabled": false,
"hstsMaxAgeDurationSeconds": {}
}
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"
Image
Description
Image
Fields
| Field Name | Description |
|---|---|
url - String!
|
Absolute path to image using store CDN. |
urlOriginal - String!
|
Absolute path to original image using store CDN. |
Arguments
|
|
urlTemplate - String!
|
A templatized URL containing a {:size} parameter which can be replaced with a string specifying the desired image size in either inherent width (123w) or width and height (123x123). |
Arguments
|
|
altText - String!
|
Text description of an image that can be used for SEO and/or accessibility purposes. |
isDefault - Boolean!
|
Indicates whether this is the primary image. |
Example
{
"url": "abc123",
"urlOriginal": "xyz789",
"urlTemplate": "xyz789",
"altText": "abc123",
"isDefault": false
}
ImageConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ImageEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ImageEdge]
}
ImageEdge
InactivitySettings
Description
Inactivity settings from control panel
Fields
| Field Name | Description |
|---|---|
shopperInactivityDurationSeconds - Long
|
Duration in seconds indicating how long a shopper can be inactive before being logged out. |
shopperActivityExtendsDuration - Boolean
|
Flag informing if any shopper activity extends the inactivity duration. |
controlPanelInactivityDurationSeconds - Long
|
Duration in seconds indicating how long a control panel user can be inactive before being logged out. |
Example
{
"shopperInactivityDurationSeconds": {},
"shopperActivityExtendsDuration": false,
"controlPanelInactivityDurationSeconds": {}
}
InlineScript
Description
Represents a script that contains inline JavaScript code
Fields
| Field Name | Description |
|---|---|
scriptTag - String!
|
The HTML script tag containing the inline JavaScript code |
entityId - UUID!
|
Unique identifier for the script |
consentCategory - ScriptConsentCategory!
|
The consent category this script belongs to (e.g., Essential, Analytics) |
visibility - ScriptVisibility!
|
Where this script should be displayed in the storefront |
integrityHashes - [ScriptHash!]!
|
List of integrity hash values for security verification |
location - ScriptLocation!
|
Location in the page where the script should be placed (e.g., Head, Footer) |
Example
{
"scriptTag": "xyz789",
"entityId": "32e943b4-3aae-4d71-9837-ddf318e1b489",
"consentCategory": "ANALYTICS",
"visibility": "ALL_PAGES",
"integrityHashes": [ScriptHash],
"location": "FOOTER"
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
InvalidInputFieldsError
Description
Validation errors dealing with input parameters supplied to an rpc call.
Fields
| Field Name | Description |
|---|---|
fields - [String!]!
|
The input fields that had a validation issue. |
message - String!
|
A description of the error in user language. |
Example
{
"fields": ["xyz789"],
"message": "xyz789"
}
InvalidSessionSyncJwtError
Description
Invalid Jwt token.
Fields
| Field Name | Description |
|---|---|
errorType - InvalidSessionSyncJwtErrorType!
|
Enum with error type. |
message - String!
|
A description of the error in user language. |
Example
{"errorType": "OTHER", "message": "abc123"}
InvalidSessionSyncJwtErrorType
Description
Enum with error type.
Values
| Enum Value | Description |
|---|---|
|
|
Unknown issue with the token. |
|
|
Shopper IP of JWT token mismatch. |
|
|
Store ID of JWT token mismatch. |
Example
"OTHER"
Inventory
Description
An inventory
Fields
| Field Name | Description |
|---|---|
locations - InventoryLocationConnection!
|
Locations |
Arguments
|
|
Example
{"locations": InventoryLocationConnection}
InventoryAddress
Description
Address
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Address id. |
code - String!
|
Address code. |
label - String!
|
Address label. |
description - String
|
Address description. |
address1 - String!
|
Address line1. |
address2 - String!
|
Address line2. |
city - String!
|
Address city. |
stateOrProvince - String!
|
Address state. |
countryCode - String!
|
Country code. |
postalCode - String!
|
Address zip. |
phone - String!
|
Address phone. |
email - String!
|
Address email. |
latitude - Float
|
Address latitude. |
longitude - Float
|
Address longitude. |
Example
{
"entityId": 123,
"code": "abc123",
"label": "abc123",
"description": "abc123",
"address1": "xyz789",
"address2": "abc123",
"city": "xyz789",
"stateOrProvince": "xyz789",
"countryCode": "abc123",
"postalCode": "abc123",
"phone": "abc123",
"email": "xyz789",
"latitude": 123.45,
"longitude": 123.45
}
InventoryByLocations
Description
Inventory By Locations
Fields
| Field Name | Description |
|---|---|
locationEntityId - Long!
|
Location id. |
availableToSell - Long!
|
Number of available products in stock. |
warningLevel - Int!
|
Indicates a threshold low-stock level. |
isInStock - Boolean!
|
Indicates whether this product is in stock. |
locationDistance - Distance
|
Distance between location and specified longitude and latitude |
locationEntityTypeId - String
|
Location type id. |
locationEntityServiceTypeIds - [String!]!
|
Location service type ids. Deprecated. Will be substituted with pickup methods. |
locationEntityCode - String!
|
Location code. |
Example
{
"locationEntityId": {},
"availableToSell": {},
"warningLevel": 123,
"isInStock": false,
"locationDistance": Distance,
"locationEntityTypeId": "xyz789",
"locationEntityServiceTypeIds": [
"abc123"
],
"locationEntityCode": "xyz789"
}
InventoryLocation
Description
Location
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Location id. |
code - String!
|
Location code. |
label - String!
|
Location label. |
description - String
|
Location description. |
typeId - String
|
Location type id. |
serviceTypeIds - [String!]!
|
Location service type ids. Deprecated. Will be substituted with pickup methods. |
address - InventoryAddress
|
Location address |
operatingHours - OperatingHours
|
Location OperatingHours |
distance - Distance
|
Distance between location and specified longitude and latitude |
blackoutHours - [SpecialHour!]!
|
Upcoming events Deprecated. Use specialHours instead |
specialHours - [SpecialHour!]!
|
Upcoming events |
timeZone - String
|
Time zone of location |
metafields - MetafieldConnection!
|
Metafield data related to a location. |
Example
{
"entityId": 123,
"code": "xyz789",
"label": "abc123",
"description": "xyz789",
"typeId": "xyz789",
"serviceTypeIds": ["abc123"],
"address": InventoryAddress,
"operatingHours": OperatingHours,
"distance": Distance,
"blackoutHours": [SpecialHour],
"specialHours": [SpecialHour],
"timeZone": "abc123",
"metafields": MetafieldConnection
}
InventoryLocationConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [InventoryLocationEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [InventoryLocationEdge]
}
InventoryLocationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - InventoryLocation!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": InventoryLocation,
"cursor": "xyz789"
}
InventorySettings
Description
Inventory settings from control panel.
Fields
| Field Name | Description |
|---|---|
productOutOfStockBehavior - ProductOutOfStockBehavior
|
The product out of stock behavior. |
optionOutOfStockBehavior - OptionOutOfStockBehavior
|
The option out of stock behavior. |
stockLevelDisplay - StockLevelDisplay
|
Hide or show inventory node for product |
defaultOutOfStockMessage - String!
|
Out of stock message. |
hideInProductFiltering - Boolean!
|
Flag to show or not on product filtering when option is out of stock |
showPreOrderStockLevels - Boolean!
|
Show pre-order inventory |
showOutOfStockMessage - Boolean!
|
Show out of stock message on product listing pages |
updateStockBehavior - UpdateStockBehavior
|
The behavior to use to update stock levels. |
Example
{
"productOutOfStockBehavior": "DO_NOTHING",
"optionOutOfStockBehavior": "DO_NOTHING",
"stockLevelDisplay": "DONT_SHOW",
"defaultOutOfStockMessage": "xyz789",
"hideInProductFiltering": true,
"showPreOrderStockLevels": true,
"showOutOfStockMessage": false,
"updateStockBehavior": "ORDER_COMPLETED_OR_SHIPPED"
}
IpAddress
Description
IP4 or IP6 compatible ip address
Example
IpAddress
JwtTokenExpiredError
Description
JWT token is expired.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
LengthUnit
Description
length unit
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Kilometres"
LimitDateOption
Description
Limit date by
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"EARLIEST_DATE"
LimitExceededError
LimitInputBy
Description
Limit numbers by several options.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"HIGHEST_VALUE"
ListMatchBehavior
Description
Match behavior for search filters, where a list of values is provided. OR - match any of the values in the list. AND - match all the values in the list.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AND"
Locale
LocationConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [LocationEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [LocationEdge]
}
LocationEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - InventoryByLocations!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": InventoryByLocations,
"cursor": "xyz789"
}
LoginResult
Description
Login result.
Fields
| Field Name | Description |
|---|---|
result - String!
|
The result of a login Use customer node instead. |
customer - Customer
|
The currently logged in customer. |
cart - Cart
|
The cart that is assigned to the customer after login. |
customerAccessToken - CustomerAccessToken
|
The customer access token. This field can only be fetched in server-to-server context. |
Example
{
"result": "xyz789",
"customer": Customer,
"cart": Cart,
"customerAccessToken": CustomerAccessToken
}
LoginWithCustomerLoginJwtResult
Description
Result of login using customer login JWT.
Fields
| Field Name | Description |
|---|---|
redirectTo - String!
|
The URL to redirect to after login. |
customer - Customer
|
The currently logged in customer. |
cart - Cart
|
The cart that is assigned to the customer after login. |
customerAccessToken - CustomerAccessToken
|
The customer access token. This field can only be fetched in server-to-server context. |
Example
{
"redirectTo": "xyz789",
"customer": Customer,
"cart": Cart,
"customerAccessToken": CustomerAccessToken
}
LogoField
LogoutResult
Description
Logout result
Fields
| Field Name | Description |
|---|---|
result - String!
|
The result of a logout |
cartUnassignResult - CartUnassignResult!
|
The result of the cart unassign operation which can be performed during logout. |
Example
{
"result": "xyz789",
"cartUnassignResult": CartUnassignResult
}
Long
Description
The Long scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1.
Example
{}
ManualRedirect
Description
Redirect to manually input url.
Fields
| Field Name | Description |
|---|---|
url - String!
|
Url. |
Example
{"url": "abc123"}
Measurement
MetaPixelProvider
Description
Facebook Pixel analytics provider.
Fields
| Field Name | Description |
|---|---|
pixelId - String!
|
Identification number of Pixel. |
Example
{"pixelId": "xyz789"}
MetafieldConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [MetafieldEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [MetafieldEdge]
}
MetafieldEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - Metafields!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": Metafields,
"cursor": "xyz789"
}
Metafields
Description
Key/Value pairs of data attached tied to a resource entity (product, brand, category, etc.)
Example
{
"id": "4",
"entityId": 987,
"key": "abc123",
"value": "abc123"
}
Money
Description
A money object - includes currency code and a money amount
Fields
| Field Name | Description |
|---|---|
currencyCode - String!
|
Currency code of the current money. |
value - BigDecimal!
|
The amount of money. |
formatted - String
|
The formatted currency string for the current money. Deprecated. Don't use - it will be removed soon. |
formattedV2 - String
|
The formatted currency string for the current money. |
Example
{
"currencyCode": "abc123",
"value": BigDecimal,
"formatted": "xyz789",
"formattedV2": "abc123"
}
MoneyRange
MultiLineTextFieldOption
Description
A multi-line text input field, aka a text box.
Fields
| Field Name | Description |
|---|---|
defaultValue - String
|
Default value of the multiline text field option. |
minLength - Int
|
The minimum number of characters. |
maxLength - Int
|
The maximum number of characters. |
maxLines - Int
|
The maximum number of lines. |
entityId - Int!
|
Unique ID for the option. |
displayName - String!
|
Display name for the option. |
isRequired - Boolean!
|
One of the option values is required to be selected for the checkout. |
isVariantOption - Boolean!
|
Indicates whether it is a variant option or modifier. |
Example
{
"defaultValue": "abc123",
"minLength": 987,
"maxLength": 123,
"maxLines": 987,
"entityId": 987,
"displayName": "xyz789",
"isRequired": false,
"isVariantOption": false
}
MultilineTextFormField
Description
Multiline text form field.
Fields
| Field Name | Description |
|---|---|
defaultText - String
|
The default text value for the form field. |
rows - Int!
|
The amount of rows 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
{
"defaultText": "abc123",
"rows": 987,
"entityId": 987,
"label": "abc123",
"sortOrder": 987,
"isBuiltIn": false,
"isRequired": false
}
MultilineTextFormFieldInput
MultilineTextFormFieldValue
Description
Multiline text custom form field value.
Example
{
"multilineText": "xyz789",
"entityId": 123,
"name": "abc123"
}
MultipleChoiceFormFieldInput
MultipleChoiceFormFieldValue
Description
Multiple choice (includes radio button and pick list) custom form field result.
Fields
| Field Name | Description |
|---|---|
valueEntityId - Int!
|
The multiple choice value id selected by customer. |
value - String!
|
The multiple choice value 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
{
"valueEntityId": 987,
"value": "abc123",
"entityId": 987,
"name": "abc123"
}
MultipleChoiceOption
Description
An option type that has a fixed list of values.
Fields
| Field Name | Description |
|---|---|
displayStyle - String!
|
The chosen display style for this multiple choice option. |
values - ProductOptionValueConnection!
|
List of option values. |
entityId - Int!
|
Unique ID for the option. |
displayName - String!
|
Display name for the option. |
isRequired - Boolean!
|
One of the option values is required to be selected for the checkout. |
isVariantOption - Boolean!
|
Indicates whether it is a variant option or modifier. |
Example
{
"displayStyle": "abc123",
"values": ProductOptionValueConnection,
"entityId": 123,
"displayName": "abc123",
"isRequired": true,
"isVariantOption": true
}
MultipleChoiceOptionValue
Description
A simple multiple choice value comprised of an id and a label.
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Unique ID for the option value. |
label - String!
|
Label for the option value. |
isDefault - Boolean!
|
Indicates whether this value is the chosen default selected value. |
isSelected - Boolean
|
Indicates whether this value is selected based on sku/variantEntityId/optionValueIds overlay requested on the product node level. |
Example
{
"entityId": 987,
"label": "xyz789",
"isDefault": false,
"isSelected": false
}
Node
Description
An object with an ID
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The id of the object. |
Possible Types
| Node Types |
|---|
Example
{"id": 4}
NormalPage
Description
A normal page.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of an object |
path - String!
|
The URL path of the page. |
htmlBody - String!
|
The body of the page. |
plainTextSummary - String!
|
The plain text summary of the page body. |
Arguments
|
|
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. |
breadcrumbs - BreadcrumbConnection!
|
Web page breadcrumbs. |
name - String!
|
Page name. |
isVisibleInNavigation - Boolean!
|
Whether or not the page should be visible in the navigation menu. |
seo - SeoDetails!
|
Page SEO details. |
children - PageConnection!
|
Details of the web page children. |
Arguments
|
|
Example
{
"id": 4,
"path": "abc123",
"htmlBody": "xyz789",
"plainTextSummary": "abc123",
"renderedRegions": RenderedRegionsByPageType,
"entityId": 987,
"parentEntityId": 987,
"breadcrumbs": BreadcrumbConnection,
"name": "xyz789",
"isVisibleInNavigation": true,
"seo": SeoDetails,
"children": PageConnection
}
NotAuthorisedError
Description
The not authorized to perform operation error.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
NotAuthorizedToAddProductReviewError
Description
The not authorized to add product review error.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
NotFoundError
Description
Subject not found error.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
NumberFieldOption
Description
A single line text input field that only accepts numbers.
Fields
| Field Name | Description |
|---|---|
defaultValue - Float
|
Default value of the text field option. |
lowest - Float
|
The bottom limit of possible numbers. |
highest - Float
|
The top limit of possible numbers. |
isIntegerOnly - Boolean!
|
Allow whole numbers only. |
limitNumberBy - LimitInputBy!
|
Limit numbers by several options. |
entityId - Int!
|
Unique ID for the option. |
displayName - String!
|
Display name for the option. |
isRequired - Boolean!
|
One of the option values is required to be selected for the checkout. |
isVariantOption - Boolean!
|
Indicates whether it is a variant option or modifier. |
Example
{
"defaultValue": 123.45,
"lowest": 123.45,
"highest": 987.65,
"isIntegerOnly": true,
"limitNumberBy": "HIGHEST_VALUE",
"entityId": 987,
"displayName": "abc123",
"isRequired": true,
"isVariantOption": false
}
NumberFormField
Description
Number only form field.
Fields
| Field Name | Description |
|---|---|
defaultNumber - Float
|
The default number value for the form field. |
maxLength - Int
|
The maximum amount of characters that can be entered into text form field. |
minNumber - Int
|
The lowest allowed number to be entered in the form field. |
maxNumber - Int
|
The highest allowed number to be entered in 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
{
"defaultNumber": 987.65,
"maxLength": 987,
"minNumber": 123,
"maxNumber": 987,
"entityId": 987,
"label": "abc123",
"sortOrder": 987,
"isBuiltIn": true,
"isRequired": true
}
NumberFormFieldInput
NumberFormFieldValue
Description
Numbers custom form field value.
Example
{
"number": 987.65,
"entityId": 123,
"name": "abc123"
}
OperatingDay
OperatingHours
Description
Operating hours
Fields
| Field Name | Description |
|---|---|
sunday - OperatingDay
|
Sunday. |
monday - OperatingDay
|
Monday. |
tuesday - OperatingDay
|
Tuesday. |
wednesday - OperatingDay
|
Wednesday. |
thursday - OperatingDay
|
Thursday. |
friday - OperatingDay
|
Friday. |
saturday - OperatingDay
|
Saturday. |
Example
{
"sunday": OperatingDay,
"monday": OperatingDay,
"tuesday": OperatingDay,
"wednesday": OperatingDay,
"thursday": OperatingDay,
"friday": OperatingDay,
"saturday": OperatingDay
}
OptionConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [OptionEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OptionEdge]
}
OptionEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - ProductOption!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": ProductOption,
"cursor": "abc123"
}
OptionOutOfStockBehavior
Description
Behavior of the variant when stock is equal to 0
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DO_NOTHING"
OptionValueConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [OptionValueEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OptionValueEdge]
}
OptionValueEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - ProductOptionValue!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": ProductOptionValue,
"cursor": "abc123"
}
OptionValueId
Order
Description
A node for fetching orders.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of an object. |
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 |
metafields - MetafieldConnection!
|
Metafield data related to an order. |
cartMetafields - MetafieldConnection!
|
Cart metafields associated with the order. |
Example
{
"id": "4",
"entityId": 987,
"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": "abc123",
"metafields": MetafieldConnection,
"cartMetafields": MetafieldConnection
}
OrderAddress
Description
An address for an order.
Fields
| Field Name | Description |
|---|---|
firstName - String
|
First name. |
lastName - String
|
Last name. |
company - String
|
Company. |
address1 - String
|
Main address line. |
address2 - String
|
Secondary address line. |
city - String
|
City. |
stateOrProvince - String
|
State or province. |
stateOrProvinceCode - String
|
State or province code. |
country - String!
|
Country. |
countryCode - String!
|
Country code. |
postalCode - String!
|
Postal code. |
phone - String
|
Phone number. |
email - String
|
Email address. |
Possible Types
| OrderAddress Types |
|---|
Example
{
"firstName": "xyz789",
"lastName": "xyz789",
"company": "xyz789",
"address1": "abc123",
"address2": "xyz789",
"city": "abc123",
"stateOrProvince": "xyz789",
"stateOrProvinceCode": "xyz789",
"country": "xyz789",
"countryCode": "xyz789",
"postalCode": "abc123",
"phone": "xyz789",
"email": "xyz789"
}
OrderBillingAddress
Description
A billing address for an order.
Fields
| Field Name | Description |
|---|---|
firstName - String
|
First name. |
lastName - String
|
Last name. |
company - String
|
Company. |
address1 - String
|
Main address line. |
address2 - String
|
Secondary address line. |
city - String
|
City. |
stateOrProvince - String
|
State or province. |
stateOrProvinceCode - String
|
State or province code. |
country - String!
|
Country. |
countryCode - String!
|
Country code. |
postalCode - String!
|
Postal code. |
phone - String
|
Phone number. |
email - String
|
Email address. |
Example
{
"firstName": "xyz789",
"lastName": "xyz789",
"company": "abc123",
"address1": "xyz789",
"address2": "xyz789",
"city": "xyz789",
"stateOrProvince": "abc123",
"stateOrProvinceCode": "abc123",
"country": "abc123",
"countryCode": "abc123",
"postalCode": "abc123",
"phone": "xyz789",
"email": "abc123"
}
OrderConsignments
Description
A consignment for an order.
Fields
| Field Name | Description |
|---|---|
downloads - [OrderDownloadConsignment!]!
|
Download consignments. |
email - OrderEmailConsignments!
|
Email consignments. |
pickups - OrderPickupConsignmentConnection!
|
Pickup consignments. |
shipping - OrderShippingConsignmentConnection!
|
Shipping consignments. |
Example
{
"downloads": [OrderDownloadConsignment],
"email": OrderEmailConsignments,
"pickups": OrderPickupConsignmentConnection,
"shipping": OrderShippingConsignmentConnection
}
OrderCouponDiscount
OrderDateRangeFilterInput
OrderDigitalLineItem
Description
A digital line item for an order.
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Digital line item ID. |
productEntityId - Int!
|
ID of the product associated with the line item. |
name - String!
|
Digital line item display name. |
quantity - Int!
|
Quantity. |
subTotalListPrice - Money!
|
Line item's list price before discounts, as quoted by the manufacturer/distributor. |
subTotalSalePrice - Money!
|
Line item's price after all discounts are applied. (The final price before tax calculation). |
refundedQuantity - Int!
|
Refunded quantity. |
brand - String
|
Optional brand. |
downloadFileUrls - [String!]!
|
List of download file urls. |
downloadPageUrl - String
|
Optional page download url. |
productOptions - [OrderLineItemProductOption!]!
|
List of product options. |
image - Image
|
Image for the item. |
baseCatalogProduct - Product
|
The base product information. |
catalogProductWithOptionSelections - Product
|
The product with option selections applied. |
Example
{
"entityId": 123,
"productEntityId": 987,
"name": "abc123",
"quantity": 123,
"subTotalListPrice": Money,
"subTotalSalePrice": Money,
"refundedQuantity": 123,
"brand": "abc123",
"downloadFileUrls": ["xyz789"],
"downloadPageUrl": "abc123",
"productOptions": [OrderLineItemProductOption],
"image": Image,
"baseCatalogProduct": Product,
"catalogProductWithOptionSelections": Product
}
OrderDigitalLineItemConnection
Description
A connection to a list of digital line items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [OrderDigitalLineItemEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OrderDigitalLineItemEdge]
}
OrderDigitalLineItemEdge
Description
An edge in an digital line item connection.
Fields
| Field Name | Description |
|---|---|
node - OrderDigitalLineItem!
|
The digital line items. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": OrderDigitalLineItem,
"cursor": "abc123"
}
OrderDiscounts
Description
A discount for an order.
Fields
| Field Name | Description |
|---|---|
nonCouponDiscountTotal - Money!
|
Non-coupon discount total. |
couponDiscounts - [OrderCouponDiscount!]!
|
List of discounts for an order. |
Example
{
"nonCouponDiscountTotal": Money,
"couponDiscounts": [OrderCouponDiscount]
}
OrderDownloadConsignment
Description
A download consignment for an order.
Example
{
"recipientEmail": "abc123",
"lineItems": OrderDigitalLineItemConnection
}
OrderEmailConsignments
Description
An email consignment for an order.
Fields
| Field Name | Description |
|---|---|
giftCertificates - OrderGiftCertificateConsignmentConnection!
|
Gift certificates for the consignment. |
Example
{
"giftCertificates": OrderGiftCertificateConsignmentConnection
}
OrderFilterInput
OrderGiftCertificateConsignment
Description
A gift certificate consignment for an order.
Example
{
"recipientEmail": "xyz789",
"lineItems": OrderGiftCertificateLineItemConnection
}
OrderGiftCertificateConsignmentConnection
Description
A connection to a list of gift certificate consignments.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [OrderGiftCertificateConsignmentEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OrderGiftCertificateConsignmentEdge]
}
OrderGiftCertificateConsignmentEdge
Description
An edge in a gift certificate consignment connection.
Fields
| Field Name | Description |
|---|---|
node - OrderGiftCertificateConsignment!
|
The digital gift consignments. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": OrderGiftCertificateConsignment,
"cursor": "abc123"
}
OrderGiftCertificateLineItem
Description
A gift certificate line item for an order.
Example
{
"entityId": 123,
"name": "abc123",
"salePrice": Money,
"refundedQuantity": 987
}
OrderGiftCertificateLineItemConnection
Description
A connection to a list of gift certificate line items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [OrderGiftCertificateLineItemEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OrderGiftCertificateLineItemEdge]
}
OrderGiftCertificateLineItemEdge
Description
An edge in a gift certificate line item connection.
Fields
| Field Name | Description |
|---|---|
node - OrderGiftCertificateLineItem!
|
The digital gift certificates. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": OrderGiftCertificateLineItem,
"cursor": "abc123"
}
OrderLineItemInterface
Description
An interface for different order line item types
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Line item ID. |
name - String!
|
Line item display name. |
refundedQuantity - Int!
|
Refunded quantity. |
Possible Types
| OrderLineItemInterface Types |
|---|
Example
{
"entityId": 123,
"name": "xyz789",
"refundedQuantity": 123
}
OrderLineItemProductOption
OrderLineItemWrapping
OrderPhysicalLineItem
Description
A physical line item for an order.
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Line item ID. |
productEntityId - Int!
|
ID of the product associated with the line item. |
name - String!
|
Display name. |
quantity - Int!
|
Quantity. |
subTotalListPrice - Money!
|
Line item's list price before discounts, as quoted by the manufacturer/distributor. |
subTotalSalePrice - Money!
|
Line item's price after all discounts are applied. (The final price before tax calculation). |
refundedQuantity - Int!
|
Refunded quantity. |
parentLineItemEntityId - Int
|
ID of parent line item |
brand - String
|
Brand. |
wrapping - OrderLineItemWrapping
|
Wrapping. |
productOptions - [OrderLineItemProductOption!]!
|
Product options. |
image - Image
|
Image for the item. |
baseCatalogProduct - Product
|
The base product information. |
catalogProductWithOptionSelections - Product
|
The product with option selections applied. |
Example
{
"entityId": 123,
"productEntityId": 123,
"name": "abc123",
"quantity": 123,
"subTotalListPrice": Money,
"subTotalSalePrice": Money,
"refundedQuantity": 987,
"parentLineItemEntityId": 123,
"brand": "xyz789",
"wrapping": OrderLineItemWrapping,
"productOptions": [OrderLineItemProductOption],
"image": Image,
"baseCatalogProduct": Product,
"catalogProductWithOptionSelections": Product
}
OrderPhysicalLineItemConnection
Description
A connection to a list of physical line items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [OrderPhysicalLineItemEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OrderPhysicalLineItemEdge]
}
OrderPhysicalLineItemEdge
Description
An edge in a physical line item connection.
Fields
| Field Name | Description |
|---|---|
node - OrderPhysicalLineItem!
|
The digital physical line items. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": OrderPhysicalLineItem,
"cursor": "abc123"
}
OrderPickupConsignment
Description
A pickup consignment for an order.
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Consignment ID. |
pickupMethodName - String!
|
Pickup method display name. |
collectionInstructions - String!
|
Collection instructions. |
collectionTimeDescription - String!
|
Collection time description. |
locationName - String!
|
Location name. |
address - OrderPickupLocationAddress!
|
Pickup address. |
lineItems - OrderPhysicalLineItemConnection!
|
Physical line items for the consignment. |
Example
{
"entityId": 123,
"pickupMethodName": "xyz789",
"collectionInstructions": "xyz789",
"collectionTimeDescription": "xyz789",
"locationName": "abc123",
"address": OrderPickupLocationAddress,
"lineItems": OrderPhysicalLineItemConnection
}
OrderPickupConsignmentConnection
Description
A connection to a list of pickup consignment.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [OrderPickupConsignmentEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OrderPickupConsignmentEdge]
}
OrderPickupConsignmentEdge
Description
An edge in a pickup consignment.
Fields
| Field Name | Description |
|---|---|
node - OrderPickupConsignment!
|
The pickup consignments. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": OrderPickupConsignment,
"cursor": "abc123"
}
OrderPickupLocationAddress
Description
A location address for an order.
Fields
| Field Name | Description |
|---|---|
address1 - String!
|
Main address line. |
address2 - String
|
Secondary address line. |
city - String!
|
City. |
stateOrProvince - String
|
State or province. |
country - String!
|
Country. |
countryCode - String!
|
Country code. |
postalCode - String!
|
Postal code. |
email - String!
|
Email address. |
phone - String
|
Phone number. |
Example
{
"address1": "abc123",
"address2": "xyz789",
"city": "abc123",
"stateOrProvince": "xyz789",
"country": "xyz789",
"countryCode": "abc123",
"postalCode": "xyz789",
"email": "xyz789",
"phone": "xyz789"
}
OrderShipment
Description
A shipment for an order.
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Shipment ID. |
shippedAt - DateTimeExtended!
|
Date and time the shipment was shipped. |
shippingProviderName - String!
|
Shipping provider name. |
shippingMethodName - String!
|
Shipping method name. |
tracking - OrderShipmentTracking
|
Tracking information. |
Example
{
"entityId": 123,
"shippedAt": DateTimeExtended,
"shippingProviderName": "xyz789",
"shippingMethodName": "abc123",
"tracking": OrderShipmentUrlOnlyTracking
}
OrderShipmentConnection
Description
A connection to a list of order shipments.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [OrderShipmentEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OrderShipmentEdge]
}
OrderShipmentEdge
Description
An edge in an order shipments connection.
Fields
| Field Name | Description |
|---|---|
node - OrderShipment!
|
The order shipments. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": OrderShipment,
"cursor": "xyz789"
}
OrderShipmentNumberAndUrlTracking
OrderShipmentNumberOnlyTracking
Description
Tracking information for a shipment with only number provided.
Fields
| Field Name | Description |
|---|---|
number - String!
|
Tracking number. |
Example
{"number": "xyz789"}
OrderShipmentTracking
Description
Tracking information for a shipment.
Example
OrderShipmentUrlOnlyTracking
OrderShipmentUrlOnlyTracking
Description
Tracking information for a shipment with only url provided.
Fields
| Field Name | Description |
|---|---|
url - String!
|
Tracking URL. |
Example
{"url": "xyz789"}
OrderShippingAddress
Description
A shipping address for an order.
Fields
| Field Name | Description |
|---|---|
firstName - String
|
First name. |
lastName - String
|
Last name. |
company - String
|
Company. |
address1 - String
|
Main address line. |
address2 - String
|
Secondary address line. |
city - String
|
City. |
stateOrProvince - String
|
State or province. |
stateOrProvinceCode - String
|
State or province code. |
country - String!
|
Country. |
countryCode - String!
|
Country code. |
postalCode - String!
|
Postal code. |
phone - String
|
Phone number. |
email - String
|
Email address. |
Example
{
"firstName": "xyz789",
"lastName": "xyz789",
"company": "xyz789",
"address1": "xyz789",
"address2": "abc123",
"city": "xyz789",
"stateOrProvince": "abc123",
"stateOrProvinceCode": "xyz789",
"country": "abc123",
"countryCode": "xyz789",
"postalCode": "xyz789",
"phone": "xyz789",
"email": "abc123"
}
OrderShippingConsignment
Description
A shipping consignment for an order.
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Consignment ID. |
shippingAddress - OrderShippingAddress!
|
Address the consignment is shipping to. |
lineItems - OrderPhysicalLineItemConnection!
|
Physical line items for the consignment. |
shippingCost - Money!
|
Shipping cost. |
handlingCost - Money!
|
Handling cost. |
shipments - OrderShipmentConnection!
|
List of individual shipments for the consignment. |
Example
{
"entityId": 123,
"shippingAddress": OrderShippingAddress,
"lineItems": OrderPhysicalLineItemConnection,
"shippingCost": Money,
"handlingCost": Money,
"shipments": OrderShipmentConnection
}
OrderShippingConsignmentConnection
Description
A connection to a list of order shipping consignments.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [OrderShippingConsignmentEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OrderShippingConsignmentEdge]
}
OrderShippingConsignmentEdge
Description
An edge in an order shipping consignment connection.
Fields
| Field Name | Description |
|---|---|
node - OrderShippingConsignment!
|
The order shipping consignments. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": OrderShippingConsignment,
"cursor": "xyz789"
}
OrderStatus
Description
An extended order status including a label.
Fields
| Field Name | Description |
|---|---|
value - OrderStatusValue
|
Order status value. |
label - String!
|
Order status label. |
Example
{
"value": "AWAITING_FULFILLMENT",
"label": "abc123"
}
OrderStatusValue
Description
The current status of an order.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AWAITING_FULFILLMENT"
OrderTax
OrderWithPayments
Description
A node for fetching a single order with payment data.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of an object. |
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 |
metafields - MetafieldConnection!
|
Metafield data related to an order. |
cartMetafields - MetafieldConnection!
|
Cart metafields associated with the order. |
Example
{
"id": "4",
"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",
"metafields": MetafieldConnection,
"cartMetafields": MetafieldConnection
}
OrdersConnection
Description
A connection to a list of orders.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [OrdersEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [OrdersEdge]
}
OrdersEdge
OrdersFiltersInput
Description
Filter input for orders.
Fields
| Input Field | Description |
|---|---|
status - OrderStatusValue
|
Filter by order status. |
dateRange - OrderDateRangeFilterInput
|
Filter by date range. |
Example
{
"status": "AWAITING_FULFILLMENT",
"dateRange": OrderDateRangeFilterInput
}
OtherSearchFilter
Description
Other Filter
Fields
| Field Name | Description |
|---|---|
displayProductCount - Boolean!
|
Indicates whether to display product count next to the filter. |
freeShipping - OtherSearchFilterItem
|
Free shipping filter. |
isFeatured - OtherSearchFilterItem
|
Is Featured filter. |
isInStock - OtherSearchFilterItem
|
Is In Stock filter. |
name - String!
|
Display name for the filter. |
isCollapsedByDefault - Boolean!
|
Indicates whether filter is collapsed by default. |
Example
{
"displayProductCount": true,
"freeShipping": OtherSearchFilterItem,
"isFeatured": OtherSearchFilterItem,
"isInStock": OtherSearchFilterItem,
"name": "xyz789",
"isCollapsedByDefault": false
}
OtherSearchFilterItem
PageConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [PageEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [PageEdge]
}
PageEdge
PageInfo
Description
Information about pagination in a connection.
Fields
| Field Name | Description |
|---|---|
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
endCursor - String
|
When paginating forwards, the cursor to continue. |
Example
{
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123",
"endCursor": "abc123"
}
PageRedirect
PageType
Description
Page type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ACCOUNT_ADDRESS"
PageViewedEventInput
Description
Input object for fields related to a page-viewed event.
Fields
| Input Field | Description |
|---|---|
commonInput - AnalyticsCommonEventInput!
|
Common input fields for the page-viewed event. |
Example
{"commonInput": AnalyticsCommonEventInput}
PageViewedEventResult
Description
Represents the result of a page-viewed event, including execution status and any associated data.
Fields
| Field Name | Description |
|---|---|
executed - Boolean!
|
Indicates whether the page-viewed event was successfully executed. |
Example
{"executed": true}
PasswordComplexitySettings
Description
Settings that determine the minimum complexity required for a customer's password.
Fields
| Field Name | Description |
|---|---|
minimumPasswordLength - Int!
|
Minimum password length. |
requireLowerCase - Boolean!
|
Require lowercase characters. |
requireUpperCase - Boolean!
|
Require uppercase characters. |
requireNumbers - Boolean!
|
Require numbers. |
minimumNumbers - Int!
|
The minimum number of numbers required in passwords. |
requireSpecialCharacters - Boolean!
|
Require special characters. |
minimumSpecialCharacters - Int!
|
The minimum number of special characters required in passwords. |
Example
{
"minimumPasswordLength": 987,
"requireLowerCase": false,
"requireUpperCase": true,
"requireNumbers": false,
"minimumNumbers": 123,
"requireSpecialCharacters": false,
"minimumSpecialCharacters": 987
}
PasswordFormField
Description
Password form field.
Fields
| Field Name | Description |
|---|---|
defaultText - String
|
The default text value for the form field. |
maxLength - Int
|
The maximum amount of characters that can be entered into 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
{
"defaultText": "xyz789",
"maxLength": 987,
"entityId": 987,
"label": "xyz789",
"sortOrder": 987,
"isBuiltIn": false,
"isRequired": true
}
PasswordFormFieldInput
PasswordFormFieldValue
Description
Password custom form field value.
Example
{
"password": "abc123",
"entityId": 123,
"name": "abc123"
}
PaymentWalletDataInput
PicklistFormField
Description
Pick list form field. Similar to Radio Buttons, but should be rendered as a dropdown select.
Fields
| Field Name | Description |
|---|---|
choosePrefix - String!
|
The text to display before a user has made a selection. |
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
{
"choosePrefix": "xyz789",
"options": [FormFieldOption],
"entityId": 123,
"label": "xyz789",
"sortOrder": 987,
"isBuiltIn": true,
"isRequired": false
}
PicklistOrTextFormField
Description
Pick list or text form field. This field can either be rendered as text or a dropdown and is used for the State/Province field.
Fields
| Field Name | Description |
|---|---|
maxLength - Int
|
The maximum amount of characters that can be entered into the form field when it is a text type. |
picklistPrefix - String!
|
The text to display before a user has made a selection when it is a picklist type. |
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
{
"maxLength": 987,
"picklistPrefix": "xyz789",
"entityId": 123,
"label": "xyz789",
"sortOrder": 123,
"isBuiltIn": true,
"isRequired": true
}
PopularBrandConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [PopularBrandEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [PopularBrandEdge]
}
PopularBrandEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - PopularBrandType!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": PopularBrandType,
"cursor": "abc123"
}
PopularBrandType
PriceRanges
Description
The min and max range of prices that apply to this product.
Fields
| Field Name | Description |
|---|---|
priceRange - MoneyRange!
|
Product price min/max range. |
retailPriceRange - MoneyRange
|
Product retail price min/max range. |
Example
{
"priceRange": MoneyRange,
"retailPriceRange": MoneyRange
}
PriceSearchFilter
Description
Price Filter
Fields
| Field Name | Description |
|---|---|
selected - PriceSearchFilterItem
|
Selected price filters. |
name - String!
|
Display name for the filter. |
isCollapsedByDefault - Boolean!
|
Indicates whether filter is collapsed by default. |
Example
{
"selected": PriceSearchFilterItem,
"name": "abc123",
"isCollapsedByDefault": true
}
PriceSearchFilterInput
PriceSearchFilterItem
Prices
Description
The various prices that can be set on a product.
Fields
| Field Name | Description |
|---|---|
price - Money!
|
Calculated price of the product. Calculated price takes into account basePrice, salePrice, rules (modifier, option, option set) that apply to the product configuration, and customer group discounts. It represents the in-cart price for a product configuration without bulk pricing rules. |
salePrice - Money
|
Sale price of the product. |
basePrice - Money
|
Original price of the product. |
retailPrice - Money
|
Retail price of the product. |
mapPrice - Money
|
Minimum advertised price of the product. |
priceRange - MoneyRange!
|
Product price min/max range. |
retailPriceRange - MoneyRange
|
Product retail price min/max range. |
saved - Money
|
The difference between the retail price (MSRP) and the current price, which can be presented to the shopper as their savings. |
bulkPricing - [BulkPricingTier!]!
|
List of bulk pricing tiers applicable to a product or variant. |
Example
{
"price": Money,
"salePrice": Money,
"basePrice": Money,
"retailPrice": Money,
"mapPrice": Money,
"priceRange": MoneyRange,
"retailPriceRange": MoneyRange,
"saved": Money,
"bulkPricing": [BulkPricingTier]
}
PrivacySettings
Product
Description
Product
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of an object |
entityId - Int!
|
Id of the product. |
sku - String!
|
Default product variant when no options are selected. |
path - String!
|
Relative URL path to product page. |
name - String!
|
Name of the product. |
description - String!
|
Description of the product. |
plainTextDescription - String!
|
Description of the product in plain text. |
Arguments
|
|
warranty - String!
|
Warranty information of the product. |
minPurchaseQuantity - Int
|
Minimum purchasable quantity for this product in a single order. |
maxPurchaseQuantity - Int
|
Maximum purchasable quantity for this product in a single order. |
addToCartUrl - String!
|
Absolute URL path for adding a product to cart. |
addToWishlistUrl - String!
|
Absolute URL path for adding a product to customer's wishlist. Deprecated. |
prices - Prices
|
Prices object determined by supplied product ID, variant ID, and selected option IDs. |
Arguments
|
|
priceRanges - PriceRanges
|
The minimum and maximum price of this product based on variant pricing and/or modifier price rules. Use priceRanges inside prices node instead. |
Arguments
|
|
weight - Measurement
|
Weight of the product. |
height - Measurement
|
Height of the product. |
width - Measurement
|
Width of the product. |
depth - Measurement
|
Depth of the product. |
options - OptionConnection!
|
Product options. Use productOptions instead. |
productOptions - ProductOptionConnection!
|
Product options. |
reviewSummary - Reviews!
|
Summary of the product reviews, includes the total number of reviews submitted and summation of the ratings on the reviews (ratings range from 0-5 per review). |
type - String!
|
Type of product, ex: physical, digital |
availability - String!
|
The availability state of the product. Use status inside availabilityV2 instead. |
availabilityDescription - String!
|
A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. Use description inside availabilityV2 instead. |
availabilityV2 - ProductAvailability!
|
The availability state of the product. |
categories - CategoryConnection!
|
List of categories associated with the product. |
brand - Brand
|
Brand associated with the product. |
variants - VariantConnection!
|
Variants associated with the product. |
customFields - CustomFieldConnection!
|
Custom fields of the product. |
images - ImageConnection!
|
A list of the images for a product. |
defaultImage - Image
|
Default image for a product. |
relatedProducts - RelatedProductsConnection!
|
Related products for this product. |
Arguments
|
|
inventory - ProductInventory!
|
Inventory information of the product. |
metafields - MetafieldConnection!
|
Metafield data related to a product. |
upc - String
|
Universal product code. |
mpn - String
|
Manufacturer part number. |
gtin - String
|
Global trade item number. |
createdAt - DateTimeExtended!
|
Product creation date Alpha version. Do not use in production. |
reviews - ReviewConnection!
|
Reviews associated with the product. |
Arguments
|
|
seo - SeoDetails!
|
Product SEO details. |
giftWrappingOptions - GiftWrappingConnection!
|
Gift wrapping options available for the product. |
condition - ProductConditionType
|
Product condition |
showCartAction - Boolean!
|
Whether or not the cart call to action should be visible for this product. |
videos - VideoConnection!
|
A list of the videos for a product. |
Example
{
"id": "4",
"entityId": 123,
"sku": "xyz789",
"path": "abc123",
"name": "xyz789",
"description": "abc123",
"plainTextDescription": "abc123",
"warranty": "abc123",
"minPurchaseQuantity": 987,
"maxPurchaseQuantity": 123,
"addToCartUrl": "xyz789",
"addToWishlistUrl": "abc123",
"prices": Prices,
"priceRanges": PriceRanges,
"weight": Measurement,
"height": Measurement,
"width": Measurement,
"depth": Measurement,
"options": OptionConnection,
"productOptions": ProductOptionConnection,
"reviewSummary": Reviews,
"type": "abc123",
"availability": "abc123",
"availabilityDescription": "abc123",
"availabilityV2": ProductAvailability,
"categories": CategoryConnection,
"brand": Brand,
"variants": VariantConnection,
"customFields": CustomFieldConnection,
"images": ImageConnection,
"defaultImage": Image,
"relatedProducts": RelatedProductsConnection,
"inventory": ProductInventory,
"metafields": MetafieldConnection,
"upc": "xyz789",
"mpn": "abc123",
"gtin": "abc123",
"createdAt": DateTimeExtended,
"reviews": ReviewConnection,
"seo": SeoDetails,
"giftWrappingOptions": GiftWrappingConnection,
"condition": "NEW",
"showCartAction": true,
"videos": VideoConnection
}
ProductAttributeSearchFilter
Description
Product Attribute Filter
Fields
| Field Name | Description |
|---|---|
displayProductCount - Boolean!
|
Indicates whether to display product count next to the filter. |
filterName - String!
|
Filter name for building filter URLs |
attributes - ProductAttributeSearchFilterItemConnection!
|
List of available product attributes. |
name - String!
|
Display name for the filter. |
isCollapsedByDefault - Boolean!
|
Indicates whether filter is collapsed by default. |
Example
{
"displayProductCount": true,
"filterName": "xyz789",
"attributes": ProductAttributeSearchFilterItemConnection,
"name": "xyz789",
"isCollapsedByDefault": false
}
ProductAttributeSearchFilterInput
Description
Filter by the attributes of products such as Product Options and Product Custom Fields. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.
Fields
| Input Field | Description |
|---|---|
attribute - String!
|
Product attributes |
values - [String!]!
|
Product attribute values |
Example
{
"attribute": "xyz789",
"values": ["abc123"]
}
ProductAttributeSearchFilterItem
Description
Specific product attribute filter item
Example
{
"value": "xyz789",
"isSelected": true,
"productCount": 987
}
ProductAttributeSearchFilterItemConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ProductAttributeSearchFilterItemEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ProductAttributeSearchFilterItemEdge]
}
ProductAttributeSearchFilterItemEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - ProductAttributeSearchFilterItem!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": ProductAttributeSearchFilterItem,
"cursor": "abc123"
}
ProductAvailability
Description
Product availability
Fields
| Field Name | Description |
|---|---|
status - ProductAvailabilityStatus!
|
The availability state of the product. |
description - String!
|
A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. |
Possible Types
| ProductAvailability Types |
|---|
Example
{
"status": "Available",
"description": "abc123"
}
ProductAvailabilityStatus
Description
Product availability status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"Available"
ProductAvailable
Description
Available Product
Fields
| Field Name | Description |
|---|---|
status - ProductAvailabilityStatus!
|
The availability state of the product. |
description - String!
|
A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. |
Example
{
"status": "Available",
"description": "xyz789"
}
ProductConditionType
Description
Product condition
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NEW"
ProductConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ProductEdge!]
|
A list of edges. |
collectionInfo - CollectionInfo
|
Collection info |
Example
{
"pageInfo": PageInfo,
"edges": [ProductEdge],
"collectionInfo": CollectionInfo
}
ProductEdge
ProductIdNotFoundError
Description
Product ID did not map to any existing products.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "abc123"}
ProductInventory
Description
Product Inventory Information
Fields
| Field Name | Description |
|---|---|
isInStock - Boolean!
|
Indicates whether this product is in stock. |
hasVariantInventory - Boolean!
|
Indicates whether this product's inventory is being tracked on variant level. If true, you may wish to check the variants node to understand the true inventory of each individual variant, rather than relying on this product-level aggregate to understand how many items may be added to cart. |
aggregated - AggregatedInventory
|
Aggregated product inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront. |
Example
{
"isInStock": true,
"hasVariantInventory": false,
"aggregated": AggregatedInventory
}
ProductOption
Description
Product Option
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Unique ID for the option. |
displayName - String!
|
Display name for the option. |
isRequired - Boolean!
|
One of the option values is required to be selected for the checkout. |
values - OptionValueConnection!
|
Option values. |
Example
{
"entityId": 987,
"displayName": "xyz789",
"isRequired": false,
"values": OptionValueConnection
}
ProductOptionConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ProductOptionEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ProductOptionEdge]
}
ProductOptionEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - CatalogProductOption!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": CatalogProductOption,
"cursor": "abc123"
}
ProductOptionValue
ProductOptionValueConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ProductOptionValueEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ProductOptionValueEdge]
}
ProductOptionValueEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - CatalogProductOptionValue!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": CatalogProductOptionValue,
"cursor": "abc123"
}
ProductOutOfStockBehavior
Description
Behavior of the product when stock is equal to 0
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DO_NOTHING"
ProductPickListOptionValue
Description
A Product PickList Value - a product to be mapped to the base product if selected.
Fields
| Field Name | Description |
|---|---|
productId - Int!
|
The ID of the product associated with this option value. |
defaultImage - Image
|
Default image for a pick list product. |
entityId - Int!
|
Unique ID for the option value. |
label - String!
|
Label for the option value. |
isDefault - Boolean!
|
Indicates whether this value is the chosen default selected value. |
isSelected - Boolean
|
Indicates whether this value is selected based on sku/variantEntityId/optionValueIds overlay requested on the product node level. |
Example
{
"productId": 123,
"defaultImage": Image,
"entityId": 123,
"label": "abc123",
"isDefault": true,
"isSelected": true
}
ProductPreOrder
Description
PreOrder Product
Fields
| Field Name | Description |
|---|---|
message - String
|
The message to be shown in the store when a product is put into the pre-order availability state, e.g. "Expected release date is %%DATE%%" |
willBeReleasedAt - DateTimeExtended
|
Product release date |
status - ProductAvailabilityStatus!
|
The availability state of the product. |
description - String!
|
A few words telling the customer how long it will normally take to ship this product, such as 'Usually ships in 24 hours'. |
Example
{
"message": "xyz789",
"willBeReleasedAt": DateTimeExtended,
"status": "Available",
"description": "xyz789"
}
ProductRedirect
ProductReviewInput
Description
Content of the review to be added
Example
{
"author": "xyz789",
"title": "xyz789",
"text": "abc123",
"rating": 987,
"email": "xyz789"
}
ProductReviewsFiltersInput
Description
Product reviews filters.
Fields
| Input Field | Description |
|---|---|
rating - ProductReviewsRatingFilterInput
|
Product reviews filter by rating. |
Example
{"rating": ProductReviewsRatingFilterInput}
ProductReviewsRatingFilterInput
ProductReviewsSortInput
Description
Product reviews sorting.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"HIGHEST_RATING"
ProductViewed
Description
Input object for defining product-related details in analytics events.
Example
{
"productEntityId": 987,
"searchKeyword": "xyz789"
}
ProductViewedEventInput
Description
Input object for fields related to a product-viewed event.
Fields
| Input Field | Description |
|---|---|
commonInput - AnalyticsCommonEventInput!
|
Common input fields for the product-viewed event. |
productInput - ProductViewed!
|
Product-specific input fields for the event. |
Example
{
"commonInput": AnalyticsCommonEventInput,
"productInput": ProductViewed
}
ProductViewedEventResult
Description
Represents the result of a product-viewed event, including execution status and any associated data.
Fields
| Field Name | Description |
|---|---|
executed - Boolean!
|
Indicates whether the product-viewed event was successfully executed. |
Example
{"executed": false}
PublicWishlist
Description
Public Wishlist
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
The wishlist id. |
name - String!
|
The wishlist name. |
token - String!
|
The wishlist token. |
items - WishlistItemConnection!
|
A list of the wishlist items |
Arguments
|
|
Example
{
"entityId": 123,
"name": "xyz789",
"token": "abc123",
"items": WishlistItemConnection
}
RadioButtonsFormField
Description
Radio buttons 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": 987,
"label": "xyz789",
"sortOrder": 987,
"isBuiltIn": false,
"isRequired": false
}
RatingSearchFilter
Description
Rating Filter
Example
{
"ratings": RatingSearchFilterItemConnection,
"name": "abc123",
"isCollapsedByDefault": false
}
RatingSearchFilterInput
Description
Filter by rating. At least a minRating or maxRating must be supplied. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored.
Example
{"minRating": 123.45, "maxRating": 987.65}
RatingSearchFilterItem
Description
Specific rating filter item
Example
{
"value": "xyz789",
"isSelected": false,
"productCount": 987
}
RatingSearchFilterItemConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [RatingSearchFilterItemEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [RatingSearchFilterItemEdge]
}
RatingSearchFilterItemEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - RatingSearchFilterItem!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": RatingSearchFilterItem,
"cursor": "xyz789"
}
RawHtmlPage
Description
A raw HTML page.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of an object |
path - String!
|
The URL path of the page. |
htmlBody - String!
|
The body of the page. |
plainTextSummary - String!
|
The plain text summary of the page body. |
Arguments
|
|
entityId - Int!
|
Unique ID for the web page. |
parentEntityId - Int
|
Unique ID for the parent page. |
breadcrumbs - BreadcrumbConnection!
|
Web page breadcrumbs. |
name - String!
|
Page name. |
isVisibleInNavigation - Boolean!
|
Whether or not the page should be visible in the navigation menu. |
seo - SeoDetails!
|
Page SEO details. |
children - PageConnection!
|
Details of the web page children. |
Arguments
|
|
Example
{
"id": 4,
"path": "abc123",
"htmlBody": "xyz789",
"plainTextSummary": "xyz789",
"entityId": 123,
"parentEntityId": 123,
"breadcrumbs": BreadcrumbConnection,
"name": "xyz789",
"isVisibleInNavigation": false,
"seo": SeoDetails,
"children": PageConnection
}
ReCaptchaSettings
Description
ReCaptcha settings.
Fields
| Field Name | Description |
|---|---|
siteKey - String!
|
ReCaptcha site key. |
isEnabledOnStorefront - Boolean!
|
Indicates whether ReCaptcha is enabled on the storefront. |
isEnabledOnCheckout - Boolean!
|
Flag indicating if reCaptcha is enabled on checkout. |
failedLoginLockoutDurationSeconds - Long
|
Duration in seconds indicating how long a user is locked out after failed login attempts. |
Example
{
"siteKey": "xyz789",
"isEnabledOnStorefront": true,
"isEnabledOnCheckout": true,
"failedLoginLockoutDurationSeconds": {}
}
ReCaptchaV2Input
Description
Recaptcha input (in case Recaptcha is enabled on a store)
Fields
| Input Field | Description |
|---|---|
token - String!
|
Recaptcha token |
Example
{"token": "xyz789"}
Redirect
Description
Redirect.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of an object. |
fromPath - String!
|
Redirected url. |
to - RedirectTo!
|
Additional information about redirect. |
toUrl - String!
|
Full destination url. |
Example
{
"id": "4",
"fromPath": "abc123",
"to": ManualRedirect,
"toUrl": "abc123"
}
RedirectTo
Description
Type of the redirect.
Types
| Union Types |
|---|
Example
ManualRedirect
Region
RegisterCustomerError
Description
An error when registering a customer.
Example
EmailAlreadyInUseError
RegisterCustomerInput
Description
The values to use for customer registration.
Fields
| Input Field | Description |
|---|---|
firstName - String!
|
The first name of the customer. |
lastName - String!
|
The last name of the customer. |
email - String!
|
The email of the customer. |
password - String!
|
The password supplied by the customer. |
phone - String
|
The phone number of the customer. |
company - String
|
The company of the customer. |
address - AddCustomerAddressInput
|
The address of the customer. |
formFields - CustomerFormFieldsInput
|
The custom form fields that the customer filled out. |
Example
{
"firstName": "xyz789",
"lastName": "xyz789",
"email": "abc123",
"password": "xyz789",
"phone": "abc123",
"company": "xyz789",
"address": AddCustomerAddressInput,
"formFields": CustomerFormFieldsInput
}
RegisterCustomerResult
Description
The result of registering a customer.
Fields
| Field Name | Description |
|---|---|
customer - Customer
|
The customer that was registered. |
errors - [RegisterCustomerError!]!
|
The errors, if any, that occured during the registration. |
Example
{
"customer": Customer,
"errors": [EmailAlreadyInUseError]
}
RelatedProductsConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [RelatedProductsEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [RelatedProductsEdge]
}
RelatedProductsEdge
RenderedRegionsByPageType
Description
The rendered regions by specific page.
Fields
| Field Name | Description |
|---|---|
regions - [Region!]!
|
List of regions |
Example
{"regions": [Region]}
RequestResetPasswordError
Description
An error when requesting a reset password email.
Types
| Union Types |
|---|
Example
ValidationError
RequestResetPasswordInput
RequestResetPasswordResult
Description
The result of requesting a reset password email.
Fields
| Field Name | Description |
|---|---|
errors - [RequestResetPasswordError!]!
|
The errors, if any, that occured during the request. |
Example
{"errors": [ValidationError]}
ResetPasswordError
Description
An error when resetting a password.
Types
| Union Types |
|---|
Example
ValidationError
ResetPasswordInput
Description
Input for resetting a password.
Example
{
"customerEntityId": 123,
"token": "abc123",
"newPassword": "abc123"
}
ResetPasswordResult
Description
The result of resetting a password.
Fields
| Field Name | Description |
|---|---|
errors - [ResetPasswordError!]!
|
The errors, if any, that occurred during the request. |
Example
{"errors": [ValidationError]}
Review
Description
Review
Example
{
"entityId": {},
"author": Author,
"title": "abc123",
"text": "xyz789",
"rating": 987,
"createdAt": DateTimeExtended
}
ReviewConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ReviewEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ReviewEdge]
}
ReviewEdge
Reviews
Description
Review Rating Summary
Example
{"averageRating": 123.45, "numberOfReviews": 123, "summationOfRatings": 987}
Route
RouteRedirectBehavior
Description
Enum value to specify the desired behavior when encountering a redirect for the requested route.
Values
| Enum Value | Description |
|---|---|
|
|
If there is a dynamic/association redirect configured, the node node will return a resulting entity (category, product, etc.) that a redirect points to. If there is a static/manual redirect configured, the node node will return null, as there is no entity associated with it, the redirect node however will return the redirect details. |
|
|
No redirects are taken into account, relying on custom URLs only. If there is the same path for both redirect and entity URL configured, both redirect node and node node return respective non-null values. |
Example
"FOLLOW"
Script
Description
Interface representing scripts that can be added to a storefront
Fields
| Field Name | Description |
|---|---|
entityId - UUID!
|
Unique identifier for the script |
consentCategory - ScriptConsentCategory!
|
The consent category this script belongs to (e.g., Essential, Analytics) |
visibility - ScriptVisibility!
|
Where this script should be displayed in the storefront |
integrityHashes - [ScriptHash!]!
|
List of integrity hash values for security verification |
location - ScriptLocation!
|
Location in the page where the script should be placed (e.g., Head, Footer) |
Possible Types
| Script Types |
|---|
Example
{
"entityId": "32e943b4-3aae-4d71-9837-ddf318e1b489",
"consentCategory": "ANALYTICS",
"visibility": "ALL_PAGES",
"integrityHashes": [ScriptHash],
"location": "FOOTER"
}
ScriptConsentCategory
Description
Categorizes scripts according to privacy and consent requirements
Values
| Enum Value | Description |
|---|---|
|
|
Scripts used for analytics |
|
|
Scripts that are essential for core website functionality |
|
|
Scripts that enhance website functionality |
|
|
Scripts used for advertising and marketing purposes |
|
|
Scripts with an unspecified or unknown consent category |
Example
"ANALYTICS"
ScriptHash
Description
Represents a security hash for a script
Fields
| Field Name | Description |
|---|---|
hash - String!
|
The integrity hash value |
Example
{"hash": "abc123"}
ScriptLocation
Description
Defines where in the HTML document a script should be placed
Values
| Enum Value | Description |
|---|---|
|
|
Script will be placed in the footer section of the page |
|
|
Script will be placed in the head section of the page |
Example
"FOOTER"
ScriptTypeConnection
Description
Connection for paginated script results
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information about the current page of results |
edges - [ScriptTypeEdge!]
|
List of script edges containing script nodes |
Example
{
"pageInfo": PageInfo,
"edges": [ScriptTypeEdge]
}
ScriptTypeEdge
ScriptVisibility
Description
Defines which pages a script should be visible on
Values
| Enum Value | Description |
|---|---|
|
|
Script appears on all store pages |
|
|
Script appears only on checkout pages |
|
|
Script appears only on order confirmation pages |
|
|
Script appears only on storefront pages |
Example
"ALL_PAGES"
ScriptsFilters
Description
Filters for querying scripts
Fields
| Input Field | Description |
|---|---|
visibilities - [ScriptVisibility!]
|
Filter scripts by their visibility settings |
consentCategories - [ScriptConsentCategory!]
|
Filter scripts by their consent categories |
location - ScriptLocation
|
Filter scripts by their location on the page |
Example
{
"visibilities": ["ALL_PAGES"],
"consentCategories": ["ANALYTICS"],
"location": "FOOTER"
}
Search
Description
Store search settings.
Fields
| Field Name | Description |
|---|---|
productFilteringEnabled - Boolean!
|
Product filtering enabled. |
Example
{"productFilteringEnabled": false}
SearchProductFilter
SearchProductFilterConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [SearchProductFilterEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [SearchProductFilterEdge]
}
SearchProductFilterEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - SearchProductFilter!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": SearchProductFilter,
"cursor": "xyz789"
}
SearchProducts
Description
Container for catalog search results, which may contain both products as well as a list of search filters for further refinement.
Fields
| Field Name | Description |
|---|---|
products - ProductConnection!
|
Details of the products. |
filters - SearchProductFilterConnection!
|
Available product filters. |
Example
{
"products": ProductConnection,
"filters": SearchProductFilterConnection
}
SearchProductsFiltersInput
Description
Object containing available search filters for use when querying Products.
Fields
| Input Field | Description |
|---|---|
searchTerm - String
|
Textual search term. Used to search for products based on text entered by a shopper, typically in a search box. Searches against several fields on the product including Name, SKU, and Description. |
price - PriceSearchFilterInput
|
Search by price range. At least a minPrice or maxPrice must be supplied. |
rating - RatingSearchFilterInput
|
Filter by rating. At least a minRating or maxRating must be supplied. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored. |
categoryEntityId - Int
|
Filter by products belonging to a single Category. This is intended for use when presenting a Category page in a PLP experience. This argument must be used in order for custom product sorts and custom product filtering settings targeted at a particular category to take effect. |
categoryEntityIds - [Int!]
|
Filter by products belonging to any of the specified Categories. Intended for Advanced Search and Faceted Search/Product Filtering use cases, not for a page for a specific Category. |
searchSubCategories - Boolean
|
Boolean argument to determine whether products within sub-Categories will be returned when filtering products by Category. Defaults to False if not supplied. |
brandEntityIds - [Int!]
|
Filter by products belonging to any of the specified Brands. |
productAttributes - [ProductAttributeSearchFilterInput!]
|
Filter by the attributes of products such as Product Options and Product Custom Fields. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored. |
isFreeShipping - Boolean
|
Filters by Products which have explicit Free Shipping configured within the catalog. If not supplied, the Free Shipping status of products will not be considered when returning the list of products. |
isFeatured - Boolean
|
Filters by Products which have explicitly been marked as Featured within the catalog. If not supplied, the Featured status of products will not be considered when returning the list of products. |
hideOutOfStock - Boolean
|
When set to True, hides products which are out of stock. Defaults to False. This filter will do nothing unless your store has the Product Filtering feature available on your plan and enabled. If it is supplied when your store does not have the feature enabled, it will be silently ignored. |
categoryIdsFilter - CategoryEntityIdsFilterInput
|
Filter by products belonging to any or all of the specified Categories. Intended for Advanced Search and Faceted Search/Product Filtering use cases, not for a page for a specific Category. |
Example
{
"searchTerm": "abc123",
"price": PriceSearchFilterInput,
"rating": RatingSearchFilterInput,
"categoryEntityId": 123,
"categoryEntityIds": [123],
"searchSubCategories": false,
"brandEntityIds": [123],
"productAttributes": [
ProductAttributeSearchFilterInput
],
"isFreeShipping": false,
"isFeatured": true,
"hideOutOfStock": true,
"categoryIdsFilter": CategoryEntityIdsFilterInput
}
SearchProductsSortInput
Description
Sort to use for the product results. Relevance is the default for textual search terms, and “Featured” is the default for category page contexts without a search term.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"A_TO_Z"
SearchQueries
Description
The Search queries.
Fields
| Field Name | Description |
|---|---|
searchProducts - SearchProducts!
|
Details of the products and facets matching given search criteria. |
Arguments
|
|
Example
{"searchProducts": SearchProducts}
SecuritySettings
Description
Security settings from control panel
Fields
| Field Name | Description |
|---|---|
customCspHeader - String
|
Value of custom Content Security Policy header. |
xFrameOptions - String
|
Value of X-Frame-Options header. |
hsts - HstsSettings
|
HSTS settings from control panel |
Example
{
"customCspHeader": "abc123",
"xFrameOptions": "xyz789",
"hsts": HstsSettings
}
SegmentProvider
Description
Segment.com analytics provider.
Fields
| Field Name | Description |
|---|---|
writeKey - String!
|
Segment.com source identifier. |
Example
{"writeKey": "abc123"}
SelectCheckoutShippingOptionDataInput
Description
Select checkout shipping option input data object
Fields
| Input Field | Description |
|---|---|
shippingOptionEntityId - String!
|
The shipping option id |
Example
{"shippingOptionEntityId": "xyz789"}
SelectCheckoutShippingOptionInput
Description
Select checkout shipping option input object
Fields
| Input Field | Description |
|---|---|
checkoutEntityId - String!
|
The checkout id |
consignmentEntityId - String!
|
The consignment id |
data - SelectCheckoutShippingOptionDataInput!
|
Select checkout shipping option data object |
version - Int
|
Version number. When provided, will reject the request if the version number is not the latest version of the cart, in order to prevent race conditions. |
Example
{
"checkoutEntityId": "abc123",
"consignmentEntityId": "xyz789",
"data": SelectCheckoutShippingOptionDataInput,
"version": 123
}
SelectCheckoutShippingOptionResult
Description
Select checkout shipping option result
Fields
| Field Name | Description |
|---|---|
checkout - Checkout
|
The Checkout that is updated as a result of mutation. |
Example
{"checkout": Checkout}
SeoDetails
SessionSyncJwtContent
Description
Restored session state.
Fields
| Field Name | Description |
|---|---|
customer - Customer
|
Customer information. |
customerAccessToken - CustomerAccessToken
|
Customer access token. |
cart - Cart
|
Cart information. |
analytics - ValidateSessionSyncJwtAnalytics
|
Analytics information. |
redirectTo - String!
|
URL to redirect to. |
Example
{
"customer": Customer,
"customerAccessToken": CustomerAccessToken,
"cart": Cart,
"analytics": ValidateSessionSyncJwtAnalytics,
"redirectTo": "abc123"
}
Settings
Description
Store settings information from the control panel.
Fields
| Field Name | Description |
|---|---|
storeName - String!
|
The name of the store. |
storeHash - String!
|
The hash of the store. |
status - StorefrontStatusType!
|
The current store status. |
logo - LogoField!
|
Logo information for the store. Use logoV2 instead.
|
logoV2 - StoreLogo!
|
Logo information for the store. |
contact - ContactField
|
Contact information for the store. |
url - UrlField!
|
Store urls. |
display - DisplayField!
|
Store display format information. |
channelId - Long!
|
Channel ID. |
tax - TaxDisplaySettings
|
The tax display settings object |
search - Search!
|
Store search settings. |
storefront - Storefront!
|
Storefront settings. |
isGoogleAiPredictionEnabled - Boolean!
|
Flag indicating whether the Google AI (product recommendation is enabled). |
inventory - InventorySettings
|
Inventory settings. |
reCaptcha - ReCaptchaSettings!
|
ReCaptcha settings. |
socialMediaLinks - [SocialMediaLink!]!
|
The social media links of connected platforms to the storefront. |
checkout - CheckoutSettings
|
Checkout settings. |
statusMessage - String
|
The customer-facing message associated with the current storefront status. |
customers - CustomersSettings
|
Customers settings. |
locales - [Locale!]!
|
Store locales. |
faviconUrl - String
|
Store favicon url. |
webAnalytics - WebAnalytics
|
Analytics settings. |
currency - CurrencySettings!
|
Currency settings. |
formFields - FormFields!
|
The form fields to display on the storefront during customer registration or address creation. |
seo - SeoDetails
|
Store seo information. |
robotsTxt - String
|
The robots.txt file content for the store. |
security - SecuritySettings
|
Security settings from control panel |
privacy - PrivacySettings
|
Privacy settings from control panel |
inactivity - InactivitySettings
|
Inactivity settings from control panel |
shipping - Shipping
|
Store shipping settings. |
Example
{
"storeName": "xyz789",
"storeHash": "abc123",
"status": "HIBERNATION",
"logo": LogoField,
"logoV2": StoreTextLogo,
"contact": ContactField,
"url": UrlField,
"display": DisplayField,
"channelId": {},
"tax": TaxDisplaySettings,
"search": Search,
"storefront": Storefront,
"isGoogleAiPredictionEnabled": false,
"inventory": InventorySettings,
"reCaptcha": ReCaptchaSettings,
"socialMediaLinks": [SocialMediaLink],
"checkout": CheckoutSettings,
"statusMessage": "xyz789",
"customers": CustomersSettings,
"locales": [Locale],
"faviconUrl": "xyz789",
"webAnalytics": WebAnalytics,
"currency": CurrencySettings,
"formFields": FormFields,
"seo": SeoDetails,
"robotsTxt": "xyz789",
"security": SecuritySettings,
"privacy": PrivacySettings,
"inactivity": InactivitySettings,
"shipping": Shipping
}
Shipping
Description
Store shipping settings.
Fields
| Field Name | Description |
|---|---|
supportedShippingDestinations - SupportedShippingDestinations!
|
Store supported shipping destinations. |
Example
{
"supportedShippingDestinations": SupportedShippingDestinations
}
ShopByPriceConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ShopByPriceEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ShopByPriceEdge]
}
ShopByPriceEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - ShopByPriceRange!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": ShopByPriceRange,
"cursor": "xyz789"
}
ShopByPriceRange
Description
Category shop by price money ranges
Fields
| Field Name | Description |
|---|---|
ranges - MoneyRange!
|
Category shop by price range. |
Example
{"ranges": MoneyRange}
ShopperLocale
Description
Shopper locale.
Fields
| Field Name | Description |
|---|---|
resolved - String
|
Resolved shopper locale. |
Example
{"resolved": "abc123"}
ShopperPreferences
Description
Shopper preferences.
Fields
| Field Name | Description |
|---|---|
locale - ShopperLocale
|
Shopper locale. |
Example
{"locale": ShopperLocale}
Site
Description
A site
Fields
| Field Name | Description |
|---|---|
search - SearchQueries!
|
The Search queries. |
categoryTree - [CategoryTreeItem!]!
|
A tree of categories. |
Arguments
|
|
category - Category
|
Retrieve a category object by the id. |
Arguments
|
|
brands - BrandConnection!
|
Details of the brand. |
products - ProductConnection!
|
Details of the products. |
Arguments
|
|
newestProducts - ProductConnection!
|
Details of the newest products. |
Arguments
|
|
bestSellingProducts - ProductConnection!
|
Details of the best selling products. |
Arguments
|
|
featuredProducts - ProductConnection!
|
Details of the featured products. |
Arguments
|
|
product - Product
|
A single product object with variant pricing overlay capabilities. |
Arguments
|
|
route - Route!
|
Route for a node |
Arguments
|
|
settings - Settings
|
Store settings. |
content - Content!
|
The page content. |
currency - Currency
|
Currency details. |
Arguments
|
|
currencies - CurrencyConnection!
|
Store Currencies. |
publicWishlist - PublicWishlist
|
Public Wishlist |
Arguments
|
|
popularBrands - PopularBrandConnection!
|
List of brands sorted by product count. |
cart - Cart
|
The Cart of the current customer. |
Arguments
|
|
checkout - Checkout
|
The checkout of the current customer. |
Arguments
|
|
brand - Brand
|
Details of a brand. |
Arguments
|
|
order - OrderWithPayments
|
A single order. |
Arguments
|
|
Example
{
"search": SearchQueries,
"categoryTree": [CategoryTreeItem],
"category": Category,
"brands": BrandConnection,
"products": ProductConnection,
"newestProducts": ProductConnection,
"bestSellingProducts": ProductConnection,
"featuredProducts": ProductConnection,
"product": Product,
"route": Route,
"settings": Settings,
"content": Content,
"currency": Currency,
"currencies": CurrencyConnection,
"publicWishlist": PublicWishlist,
"popularBrands": PopularBrandConnection,
"cart": Cart,
"checkout": Checkout,
"brand": Brand,
"order": OrderWithPayments
}
SocialMediaLink
SpecialHour
SrcScript
Description
Represents a script loaded from an external source URL
Fields
| Field Name | Description |
|---|---|
src - String!
|
The source URL where the script is located |
entityId - UUID!
|
Unique identifier for the script |
consentCategory - ScriptConsentCategory!
|
The consent category this script belongs to (e.g., Essential, Analytics) |
visibility - ScriptVisibility!
|
Where this script should be displayed in the storefront |
integrityHashes - [ScriptHash!]!
|
List of integrity hash values for security verification |
location - ScriptLocation!
|
Location in the page where the script should be placed (e.g., Head, Footer) |
Example
{
"src": "abc123",
"entityId": "32e943b4-3aae-4d71-9837-ddf318e1b489",
"consentCategory": "ANALYTICS",
"visibility": "ALL_PAGES",
"integrityHashes": [ScriptHash],
"location": "FOOTER"
}
StateOrProvince
Description
A state or province representation.
Example
{
"entityId": 123,
"name": "xyz789",
"abbreviation": "abc123"
}
StockLevelDisplay
Description
Stock level display setting
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DONT_SHOW"
Store
Description
The Store
Fields
| Field Name | Description |
|---|---|
entityId - Long!
|
The ID of the store. |
metafields - MetafieldConnection!
|
Metafield data related to a store. |
Example
{"entityId": {}, "metafields": MetafieldConnection}
StoreImageLogo
Description
Store logo as image.
Fields
| Field Name | Description |
|---|---|
image - Image!
|
Logo image. |
Example
{"image": Image}
StoreLogo
Description
Store logo.
Types
| Union Types |
|---|
Example
StoreTextLogo
StoreTextLogo
Description
Store logo as text.
Fields
| Field Name | Description |
|---|---|
text - String!
|
Logo text. |
Example
{"text": "abc123"}
Storefront
Description
Storefront settings.
Fields
| Field Name | Description |
|---|---|
catalog - Catalog
|
Storefront catalog settings. |
Example
{"catalog": Catalog}
StorefrontStatusType
Description
Storefront Mode
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"HIBERNATION"
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
SubCategorySearchFilterItem
Description
Specific sub-category filter item
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Category ID. |
name - String!
|
Category name. |
isSelected - Boolean!
|
Indicates whether category is selected. |
productCount - Int!
|
Indicates how many products available for this filter. |
subCategories - SubCategorySearchFilterItemConnection!
|
List of available sub-categories. |
Example
{
"entityId": 123,
"name": "xyz789",
"isSelected": true,
"productCount": 987,
"subCategories": SubCategorySearchFilterItemConnection
}
SubCategorySearchFilterItemConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [SubCategorySearchFilterItemEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [SubCategorySearchFilterItemEdge]
}
SubCategorySearchFilterItemEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - SubCategorySearchFilterItem!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": SubCategorySearchFilterItem,
"cursor": "xyz789"
}
SubmitContactUsDataInput
Description
Input for contact us form
Example
{
"fullName": "xyz789",
"phoneNumber": "abc123",
"email": "xyz789",
"orderNumber": "xyz789",
"companyName": "xyz789",
"rmaNumber": "abc123",
"comments": "xyz789"
}
SubmitContactUsError
Description
Error that occurred when submitting the contact us email
Types
| Union Types |
|---|
Example
ValidationError
SubmitContactUsInput
Description
Input for contact us form
Fields
| Input Field | Description |
|---|---|
pageEntityId - Int!
|
The contact page we're sending on behalf of |
data - SubmitContactUsDataInput!
|
The form data we are submitting |
Example
{"pageEntityId": 987, "data": SubmitContactUsDataInput}
SubmitContactUsResult
Description
Result of submitting contact us form
Fields
| Field Name | Description |
|---|---|
errors - [SubmitContactUsError!]!
|
List of errors that occurred executing the mutation. |
Example
{"errors": [ValidationError]}
SupportedShippingDestinations
Description
Store supported shipping destinations.
Fields
| Field Name | Description |
|---|---|
countries - [Country!]
|
List of supported shipping countries. |
Example
{"countries": [Country]}
SwatchOptionValue
Description
A swatch option value - swatch values can be associated with a list of hexidecimal colors or an image.
Fields
| Field Name | Description |
|---|---|
hexColors - [String!]!
|
List of up to 3 hex encoded colors to associate with a swatch value. |
imageUrl - String
|
Absolute path of a swatch texture image. |
entityId - Int!
|
Unique ID for the option value. |
label - String!
|
Label for the option value. |
isDefault - Boolean!
|
Indicates whether this value is the chosen default selected value. |
isSelected - Boolean
|
Indicates whether this value is selected based on sku/variantEntityId/optionValueIds overlay requested on the product node level. |
Example
{
"hexColors": ["abc123"],
"imageUrl": "xyz789",
"entityId": 123,
"label": "xyz789",
"isDefault": false,
"isSelected": false
}
TaxDisplaySettings
Description
The tax display settings object
Fields
| Field Name | Description |
|---|---|
pdp - TaxPriceDisplay!
|
Tax display setting for Product Details Page. |
plp - TaxPriceDisplay!
|
Tax display setting for Product List Page. |
Example
{"pdp": "BOTH", "plp": "BOTH"}
TaxPriceDisplay
Description
Tax setting can be set included or excluded (Tax setting can also be set to both on PDP/PLP).
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BOTH"
TextFieldOption
Description
A single line text input field.
Fields
| Field Name | Description |
|---|---|
defaultValue - String
|
Default value of the text field option. |
minLength - Int
|
The minimum number of characters. |
maxLength - Int
|
The maximum number of characters. |
entityId - Int!
|
Unique ID for the option. |
displayName - String!
|
Display name for the option. |
isRequired - Boolean!
|
One of the option values is required to be selected for the checkout. |
isVariantOption - Boolean!
|
Indicates whether it is a variant option or modifier. |
Example
{
"defaultValue": "abc123",
"minLength": 123,
"maxLength": 123,
"entityId": 987,
"displayName": "xyz789",
"isRequired": true,
"isVariantOption": false
}
TextFormField
Description
A single line text form field.
Fields
| Field Name | Description |
|---|---|
defaultText - String
|
The default text value of the text form field. |
maxLength - Int
|
The maximum amount of characters that can be entered into 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
{
"defaultText": "abc123",
"maxLength": 987,
"entityId": 123,
"label": "abc123",
"sortOrder": 123,
"isBuiltIn": true,
"isRequired": false
}
TextFormFieldInput
TextFormFieldValue
Description
Text custom form field value.
Example
{
"text": "xyz789",
"entityId": 123,
"name": "abc123"
}
URL
Description
Scalar type representing a valid URL.
Example
"http://www.test.com/"
UUID
Description
Scalar type representing a universally unique identifier (UUID).
Example
"32e943b4-3aae-4d71-9837-ddf318e1b489"
UnapplyCheckoutCouponDataInput
Description
Unapply checkout coupon data object
Fields
| Input Field | Description |
|---|---|
couponCode - String!
|
The checkout coupon code |
Example
{"couponCode": "abc123"}
UnapplyCheckoutCouponInput
Description
Unapply checkout coupon input object
Fields
| Input Field | Description |
|---|---|
checkoutEntityId - String!
|
The checkout id |
data - UnapplyCheckoutCouponDataInput!
|
Unapply 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": UnapplyCheckoutCouponDataInput,
"version": 987
}
UnapplyCheckoutCouponResult
Description
Unapply checkout coupon result
Fields
| Field Name | Description |
|---|---|
checkout - Checkout
|
The Checkout that is updated as a result of mutation. |
Example
{"checkout": Checkout}
UnassignCartFromCustomerInput
Description
Unassign cart from the customer input object.
Example
{"cartEntityId": "abc123", "version": 123}
UnassignCartFromCustomerResult
Description
Unassign cart from the customer result.
Fields
| Field Name | Description |
|---|---|
cart - Cart
|
The Cart that is updated as a result of mutation. |
Example
{"cart": Cart}
UnexpectedAddReviewError
Description
Catch all error type for any unexpected responses from the AddProductReview mutation rpc.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
UnexpectedUpdateCustomerError
Description
An unexpected error when updating a customer.
Fields
| Field Name | Description |
|---|---|
message - String!
|
A description of the error in user language. |
Example
{"message": "xyz789"}
UpdateCartCurrencyDataInput
Description
Update cart currency data object
Fields
| Input Field | Description |
|---|---|
currencyCode - String!
|
ISO-4217 currency code |
Example
{"currencyCode": "abc123"}
UpdateCartCurrencyInput
Description
Update cart currency input object
Fields
| Input Field | Description |
|---|---|
cartEntityId - String!
|
The cart id |
data - UpdateCartCurrencyDataInput!
|
Update cart currency data object |
Example
{
"cartEntityId": "abc123",
"data": UpdateCartCurrencyDataInput
}
UpdateCartCurrencyResult
Description
Update cart currency result
Fields
| Field Name | Description |
|---|---|
cart - Cart
|
The Cart that is updated as a result of mutation. |
Example
{"cart": Cart}
UpdateCartLineItemDataInput
Description
Update cart line item data object
Fields
| Input Field | Description |
|---|---|
lineItem - CartLineItemInput
|
The cart line item |
giftCertificate - CartGiftCertificateInput
|
The gift certificate |
Example
{
"lineItem": CartLineItemInput,
"giftCertificate": CartGiftCertificateInput
}
UpdateCartLineItemInput
Description
Update cart line item input object
Fields
| Input Field | Description |
|---|---|
cartEntityId - String!
|
The cart id |
lineItemEntityId - String!
|
The line item id |
data - UpdateCartLineItemDataInput!
|
Update cart line item data object |
version - Int
|
Version number. When provided, will reject the request if the version number is not the latest version of the cart, in order to prevent race conditions. |
Example
{
"cartEntityId": "abc123",
"lineItemEntityId": "xyz789",
"data": UpdateCartLineItemDataInput,
"version": 987
}
UpdateCartLineItemResult
Description
Update cart line item result
Fields
| Field Name | Description |
|---|---|
cart - Cart
|
The Cart that is updated as a result of mutation. |
Example
{"cart": Cart}
UpdateCartMetafieldDataInput
UpdateCartMetafieldError
Description
Error that occured as a result of updateCartMetafield mutation.
Types
| Union Types |
|---|
Example
NotFoundError
UpdateCartMetafieldInput
Description
Input for update cart's metafield mutation.
Fields
| Input Field | Description |
|---|---|
cartEntityId - String!
|
Id of the cart for which to update metafield. |
metafieldEntityId - Int!
|
Id of metafield to update. |
data - UpdateCartMetafieldDataInput!
|
Data to update metafield. |
Example
{
"cartEntityId": "xyz789",
"metafieldEntityId": 987,
"data": UpdateCartMetafieldDataInput
}
UpdateCartMetafieldResult
Description
Result of updating metafield for cart.
Fields
| Field Name | Description |
|---|---|
metafield - Metafields
|
Successfully updated metafield for cart. |
errors - [UpdateCartMetafieldError!]!
|
Errors found during update of cart's metafield. |
Example
{
"metafield": Metafields,
"errors": [NotFoundError]
}
UpdateCheckoutBillingAddressDataInput
Description
Update checkout billing address data object
Fields
| Input Field | Description |
|---|---|
address - CheckoutAddressInput!
|
The checkout billing address |
Example
{"address": CheckoutAddressInput}
UpdateCheckoutBillingAddressInput
Description
Update checkout billing address input object
Fields
| Input Field | Description |
|---|---|
checkoutEntityId - String!
|
The checkout id |
addressEntityId - String!
|
The address id |
data - UpdateCheckoutBillingAddressDataInput!
|
Update checkout billing address data object |
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",
"addressEntityId": "abc123",
"data": UpdateCheckoutBillingAddressDataInput,
"version": 987
}
UpdateCheckoutBillingAddressResult
Description
Update checkout billing address result
Fields
| Field Name | Description |
|---|---|
checkout - Checkout
|
The Checkout that is updated as a result of mutation. |
Example
{"checkout": Checkout}
UpdateCheckoutCustomerMessageDataInput
Description
Update checkout customer message data object
Fields
| Input Field | Description |
|---|---|
message - String!
|
The checkout customer message |
Example
{"message": "xyz789"}
UpdateCheckoutCustomerMessageInput
Description
Update checkout customer message input object
Fields
| Input Field | Description |
|---|---|
checkoutEntityId - String!
|
The checkout id |
data - UpdateCheckoutCustomerMessageDataInput!
|
Update checkout customer message data object |
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": UpdateCheckoutCustomerMessageDataInput,
"version": 987
}
UpdateCheckoutCustomerMessageResult
Description
Update checkout customer message result
Fields
| Field Name | Description |
|---|---|
checkout - Checkout
|
The Checkout that is updated as a result of mutation. |
Example
{"checkout": Checkout}
UpdateCheckoutShippingConsignmentDataInput
Description
Update checkout shipping consignment data object
Fields
| Input Field | Description |
|---|---|
consignment - CheckoutShippingConsignmentInput!
|
Checkout shipping consignment input object |
Example
{"consignment": CheckoutShippingConsignmentInput}
UpdateCheckoutShippingConsignmentInput
Description
Update checkout shipping consignment input object
Fields
| Input Field | Description |
|---|---|
checkoutEntityId - String!
|
The checkout id |
consignmentEntityId - String!
|
The consignment id |
data - UpdateCheckoutShippingConsignmentDataInput!
|
Update checkout shipping consignment data object |
version - Int
|
Version number. When provided, will reject the request if the version number is not the latest version of the cart, in order to prevent race conditions. |
Example
{
"checkoutEntityId": "abc123",
"consignmentEntityId": "xyz789",
"data": UpdateCheckoutShippingConsignmentDataInput,
"version": 123
}
UpdateCheckoutShippingConsignmentResult
Description
Update checkout shipping consignment result
Fields
| Field Name | Description |
|---|---|
checkout - Checkout
|
The Checkout that is updated as a result of mutation. |
Example
{"checkout": Checkout}
UpdateCustomerAddressDataInput
Description
Data fields to update on address.
Fields
| Input Field | Description |
|---|---|
firstName - String
|
First name of 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": "abc123",
"lastName": "abc123",
"address1": "abc123",
"address2": "abc123",
"city": "abc123",
"company": "abc123",
"countryCode": "abc123",
"stateOrProvince": "abc123",
"phone": "xyz789",
"postalCode": "xyz789",
"formFields": CustomerFormFieldsInput
}
UpdateCustomerAddressError
Description
Possible response error when attempting to use UpdateCustomerAddress mutation.
Example
CustomerNotLoggedInError
UpdateCustomerAddressInput
Description
Input for updating a customer address.
Fields
| Input Field | Description |
|---|---|
addressEntityId - Int!
|
ID of the address to update. |
data - UpdateCustomerAddressDataInput!
|
Data fields to update on address. |
Example
{
"addressEntityId": 123,
"data": UpdateCustomerAddressDataInput
}
UpdateCustomerAddressResult
Description
Result of UpdateCustomerAddress mutation.
Fields
| Field Name | Description |
|---|---|
address - CustomerAddress
|
Customer address that was updated. |
errors - [UpdateCustomerAddressError!]!
|
List of response errors when attempting to update an address. |
Example
{
"address": CustomerAddress,
"errors": [CustomerNotLoggedInError]
}
UpdateCustomerError
Description
An error when updating a customer.
Example
UnexpectedUpdateCustomerError
UpdateCustomerInput
Description
The values to use for customer update operation.
Fields
| Input Field | Description |
|---|---|
firstName - String
|
The first name of the customer. |
lastName - String
|
The last name of the customer. |
email - String
|
The email of the customer. |
phone - String
|
The phone number of the customer. |
company - String
|
The company of the customer. |
formFields - CustomerFormFieldsInput
|
The custom form fields that the customer filled out. |
Example
{
"firstName": "abc123",
"lastName": "xyz789",
"email": "xyz789",
"phone": "abc123",
"company": "abc123",
"formFields": CustomerFormFieldsInput
}
UpdateCustomerResult
Description
The result of updating a customer.
Fields
| Field Name | Description |
|---|---|
customer - Customer
|
The customer that was updated. |
errors - [UpdateCustomerError!]!
|
The errors, if any, that occured during the update operation. |
Example
{
"customer": Customer,
"errors": [UnexpectedUpdateCustomerError]
}
UpdateStockBehavior
Description
The behavior type for updating stock levels.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ORDER_COMPLETED_OR_SHIPPED"
UpdateWishlistInput
Description
Update wishlist input object
Fields
| Input Field | Description |
|---|---|
entityId - Int!
|
The wishlist id |
data - WishlistUpdateDataInput!
|
Wishlist data to update |
Example
{"entityId": 123, "data": WishlistUpdateDataInput}
UpdateWishlistResult
Description
Update wishlist
Fields
| Field Name | Description |
|---|---|
result - Wishlist!
|
The wishlist |
Example
{"result": Wishlist}
UrlField
ValidateSessionSyncJwtAnalytics
ValidateSessionSyncJwtError
Description
An union error for restoring a session errors.
Types
| Union Types |
|---|
Example
InvalidSessionSyncJwtError
ValidateSessionSyncJwtResult
Description
Restored session state or errors.
Fields
| Field Name | Description |
|---|---|
content - SessionSyncJwtContent
|
Restored session state. |
errors - [ValidateSessionSyncJwtError!]!
|
Restored session errors. |
Example
{
"content": SessionSyncJwtContent,
"errors": [InvalidSessionSyncJwtError]
}
ValidationError
Description
Validation error that occurred during a graphql request
Fields
| Field Name | Description |
|---|---|
path - [String!]!
|
Path to the field that caused the error, if applicable |
message - String!
|
A description of the error in user language. |
Example
{
"path": ["abc123"],
"message": "abc123"
}
Variant
Description
Variant
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of an object |
entityId - Int!
|
Id of the variant. |
sku - String!
|
Sku of the variant. |
weight - Measurement
|
The variant's weight. If a weight was not explicitly specified on the variant, this will be the product's weight. |
height - Measurement
|
The variant's height. If a height was not explicitly specified on the variant, this will be the product's height. |
width - Measurement
|
The variant's width. If a width was not explicitly specified on the variant, this will be the product's width. |
depth - Measurement
|
The variant's depth. If a depth was not explicitly specified on the variant, this will be the product's depth. |
options - OptionConnection!
|
The options which define a variant. |
productOptions - ProductOptionConnection!
|
Product options that compose this variant. |
defaultImage - Image
|
Default image for a variant. |
prices - Prices
|
Variant prices |
Arguments
|
|
inventory - VariantInventory
|
Variant inventory |
metafields - MetafieldConnection!
|
Metafield data related to a variant. |
upc - String
|
Universal product code. |
mpn - String
|
Manufacturer part number. |
gtin - String
|
Global trade item number. |
isPurchasable - Boolean!
|
Whether the product can be purchased |
Example
{
"id": "4",
"entityId": 123,
"sku": "abc123",
"weight": Measurement,
"height": Measurement,
"width": Measurement,
"depth": Measurement,
"options": OptionConnection,
"productOptions": ProductOptionConnection,
"defaultImage": Image,
"prices": Prices,
"inventory": VariantInventory,
"metafields": MetafieldConnection,
"upc": "xyz789",
"mpn": "abc123",
"gtin": "abc123",
"isPurchasable": false
}
VariantConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [VariantEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [VariantEdge]
}
VariantEdge
VariantInventory
Description
Variant Inventory
Fields
| Field Name | Description |
|---|---|
aggregated - Aggregated
|
Aggregated product variant inventory information. This data may not be available if not set or if the store's Inventory Settings have disabled displaying stock levels on the storefront. |
isInStock - Boolean!
|
Indicates whether this product is in stock. |
byLocation - LocationConnection
|
Inventory by locations. |
Arguments
|
|
Example
{
"aggregated": Aggregated,
"isInStock": false,
"byLocation": LocationConnection
}
Video
VideoConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [VideoEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [VideoEdge]
}
VideoEdge
VisitStartedEventInput
Description
Input object for fields related to a visit-started event.
Fields
| Input Field | Description |
|---|---|
commonInput - AnalyticsCommonEventInput!
|
Common input fields for the visit-started event. |
Example
{"commonInput": AnalyticsCommonEventInput}
VisitStartedEventResult
Description
Represents the result of a visit-started event, including execution status and any associated data.
Fields
| Field Name | Description |
|---|---|
executed - Boolean!
|
Indicates whether the visit-started event was successfully executed. |
Example
{"executed": true}
WebAnalytics
Description
Analytics settings.
Fields
| Field Name | Description |
|---|---|
ga4 - GA4Provider
|
Google Analytics 4 provider data. |
segment - SegmentProvider
|
Segment.com analytics provider data. |
metaPixel - MetaPixelProvider
|
Facebook Pixel analytics provider data. |
Example
{
"ga4": GA4Provider,
"segment": SegmentProvider,
"metaPixel": MetaPixelProvider
}
WebPage
Description
WebPage details.
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
Unique ID for the web page. |
parentEntityId - Int
|
Unique ID for the parent page. |
breadcrumbs - BreadcrumbConnection!
|
Web page breadcrumbs. |
name - String!
|
Page name. |
isVisibleInNavigation - Boolean!
|
Whether or not the page should be visible in the navigation menu. |
seo - SeoDetails!
|
Page SEO details. |
children - PageConnection!
|
Details of the web page children. |
Arguments
|
|
Possible Types
| WebPage Types |
|---|
Example
{
"entityId": 123,
"parentEntityId": 123,
"breadcrumbs": BreadcrumbConnection,
"name": "abc123",
"isVisibleInNavigation": true,
"seo": SeoDetails,
"children": PageConnection
}
WebPageChildrenFiltersInput
Description
Object containing filters for querying web pages
Fields
| Input Field | Description |
|---|---|
entityIds - [Int!]
|
Ids of the expected pages. |
pageType - WebPageType
|
Type of the expected pages. |
isVisibleInNavigation - Boolean
|
Whether the expected pages are visible in the navigation bar. |
Example
{"entityIds": [123], "pageType": "BLOG", "isVisibleInNavigation": false}
WebPageType
Description
Web page type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BLOG"
WebPagesFiltersInput
Description
Object containing filters for querying web pages
Fields
| Input Field | Description |
|---|---|
entityIds - [Int!]
|
Ids of the expected pages. |
pageType - WebPageType
|
Type of the expected pages. |
isVisibleInNavigation - Boolean
|
Whether the expected pages are visible in the navigation bar. |
parentEntityIds - [Int!]
|
Parent IDs of the expected pages. |
Example
{
"entityIds": [987],
"pageType": "BLOG",
"isVisibleInNavigation": false,
"parentEntityIds": [123]
}
Wishlist
Description
A wishlist
Fields
| Field Name | Description |
|---|---|
entityId - Int!
|
The wishlist id. |
name - String!
|
The wishlist name. |
isPublic - Boolean!
|
Is the wishlist public? |
token - String!
|
The wishlist token. |
items - WishlistItemConnection!
|
A list of the wishlist items |
Arguments
|
|
Example
{
"entityId": 123,
"name": "abc123",
"isPublic": true,
"token": "xyz789",
"items": WishlistItemConnection
}
WishlistConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [WishlistEdge!]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [WishlistEdge]
}
WishlistEdge
WishlistFiltersInput
Description
Wishlist filters input object
Example
{"entityIds": [123], "productEntityIds": [123], "variantEntityIds": [987]}
WishlistItem
Description
The wishlist item
Example
{
"entityId": 987,
"product": Product,
"productEntityId": 123,
"variantEntityId": 987
}
WishlistItemConnection
Description
A connection to a list of items.
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [WishlistItemEdge!]
|
A list of edges. |
collectionInfo - CollectionInfo
|
Collection info |
Example
{
"pageInfo": PageInfo,
"edges": [WishlistItemEdge],
"collectionInfo": CollectionInfo
}
WishlistItemEdge
Description
An edge in a connection.
Fields
| Field Name | Description |
|---|---|
node - WishlistItem!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": WishlistItem,
"cursor": "xyz789"
}
WishlistItemInput
WishlistItemsFiltersInput
WishlistMutations
Description
The wishlist mutations.
Fields
| Field Name | Description |
|---|---|
createWishlist - CreateWishlistResult
|
Create wishlist |
Arguments
|
|
addWishlistItems - AddWishlistItemsResult
|
Add wishlist items |
Arguments
|
|
deleteWishlistItems - DeleteWishlistItemsResult
|
Delete wishlist items |
Arguments
|
|
updateWishlist - UpdateWishlistResult
|
Update wishlist |
Arguments
|
|
deleteWishlists - DeleteWishlistResult
|
Delete wishlist |
Arguments
|
|
Example
{
"createWishlist": CreateWishlistResult,
"addWishlistItems": AddWishlistItemsResult,
"deleteWishlistItems": DeleteWishlistItemsResult,
"updateWishlist": UpdateWishlistResult,
"deleteWishlists": DeleteWishlistResult
}
WishlistUpdateDataInput
countryCode
Description
Country Code
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AD"
currencyCode
Description
Currency Code
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADP"
sortBy
Description
Blog post sort
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NEWEST"