GraphQL Admin API reference

Queries

client

Description

A client.

Response

Returns a Client

Example

Query
query client {
  client {
    clientId
    scopes {
      ...ScopeConnectionFragment
    }
  }
}
Response
{
  "data": {
    "client": {
      "clientId": "abc123",
      "scopes": ScopeConnection
    }
  }
}

node

Description

Fetches an object given its ID.

Response

Returns a Node

Arguments
Name Description
id - ID! The ID of the object.

Example

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

nodes

Description

Fetches objects given their IDs.

Response

Returns [Node]!

Arguments
Name Description
ids - [ID!]! The IDs of the objects.

Example

Query
query nodes($ids: [ID!]!) {
  nodes(ids: $ids) {
    id
  }
}
Variables
{"ids": [4]}
Response
{"data": {"nodes": [{"id": "4"}]}}

store

Description

A store.

Response

Returns a Store!

Example

Query
query store {
  store {
    account {
      ...AccountFragment
    }
    appExtensions {
      ...AppExtensionsConnectionFragment
    }
    id
    metafield {
      ...MetafieldFragment
    }
    metafields {
      ...MetafieldsConnectionFragment
    }
    product {
      ...ProductFragment
    }
    products {
      ...ProductConnectionFragment
    }
    settings {
      ...StoreSettingsFragment
    }
    sharedProductModifiers {
      ...SharedProductModifierConnectionFragment
    }
    sharedProductOptions {
      ...SharedProductOptionConnectionFragment
    }
    storeHash
    storeReferenceId
    webhook {
      ...WebhookFragment
    }
    webhooks {
      ...WebhooksConnectionFragment
    }
  }
}
Response
{
  "data": {
    "store": {
      "account": Account,
      "appExtensions": AppExtensionsConnection,
      "id": 4,
      "metafield": Metafield,
      "metafields": MetafieldsConnection,
      "product": Product,
      "products": ProductConnection,
      "settings": StoreSettings,
      "sharedProductModifiers": SharedProductModifierConnection,
      "sharedProductOptions": SharedProductOptionConnection,
      "storeHash": "xyz789",
      "storeReferenceId": "xyz789",
      "webhook": Webhook,
      "webhooks": WebhooksConnection
    }
  }
}

system

Description

System information.

Response

Returns a System!

Example

Query
query system {
  system {
    time
  }
}
Response
{"data": {"system": {"time": {}}}}

Mutations

appExtension

Description

App Extension mutations.

Response

Returns an AppExtensionMutations!

Example

Query
mutation appExtension {
  appExtension {
    createAppExtension {
      ...CreateAppExtensionResultFragment
    }
    updateAppExtension {
      ...UpdateAppExtensionResultFragment
    }
    deleteAppExtension {
      ...DeleteAppExtensionResultFragment
    }
  }
}
Response
{
  "data": {
    "appExtension": {
      "createAppExtension": CreateAppExtensionResult,
      "updateAppExtension": UpdateAppExtensionResult,
      "deleteAppExtension": DeleteAppExtensionResult
    }
  }
}

metafield

Description

Metafield mutations.

Response

Returns a MetafieldMutations!

Example

Query
mutation metafield {
  metafield {
    createMetafield {
      ...CreateMetafieldResultFragment
    }
    updateMetafield {
      ...UpdateMetafieldResultFragment
    }
    deleteMetafield {
      ...DeleteMetafieldResultFragment
    }
    reassignMetafieldsOwner {
      ...ReassignMetafieldsOwnerResultFragment
    }
  }
}
Response
{
  "data": {
    "metafield": {
      "createMetafield": CreateMetafieldResult,
      "updateMetafield": UpdateMetafieldResult,
      "deleteMetafield": DeleteMetafieldResult,
      "reassignMetafieldsOwner": ReassignMetafieldsOwnerResult
    }
  }
}

product

Description

Product mutations.

Response

Returns a ProductMutations!

Example

Query
mutation product {
  product {
    removeProductBasicInformationOverrides {
      ...RemoveProductBasicInformationOverridesResultFragment
    }
    removeProductSeoInformationOverrides {
      ...RemoveProductSeoInformationOverridesResultFragment
    }
    removeProductOptionsOverrides {
      ...RemoveProductOptionsOverridesResultFragment
    }
    removeProductStorefrontDetailsOverrides {
      ...RemoveProductStorefrontDetailsOverridesResultFragment
    }
    removeProductPreOrderSettingsOverrides {
      ...RemoveProductPreOrderSettingsOverridesResultFragment
    }
    setProductBasicInformation {
      ...SetProductBasicInformationResultFragment
    }
    setProductIsFeatured {
      ...SetProductIsFeaturedResultFragment
    }
    removeProductIsFeaturedOverride {
      ...RemoveProductIsFeaturedOverrideResultFragment
    }
    setProductSeoInformation {
      ...SetProductSeoInformationResultFragment
    }
    setProductStorefrontDetails {
      ...SetProductStorefrontDetailsResultFragment
    }
    setProductPreOrderSettings {
      ...SetProductPreOrderSettingsResultFragment
    }
    setProductOptionsInformation {
      ...SetProductOptionsInformationResultFragment
    }
    setProductUrlPath {
      ...SetProductUrlPathResultFragment
    }
    removeProductUrlPathOverride {
      ...RemoveProductUrlPathOverrideResultFragment
    }
    setProductModifiersInformation {
      ...SetProductModifiersInformationResultFragment
    }
    removeProductModifiersOverrides {
      ...RemoveProductModifiersOverridesResultFragment
    }
  }
}
Response
{
  "data": {
    "product": {
      "removeProductBasicInformationOverrides": RemoveProductBasicInformationOverridesResult,
      "removeProductSeoInformationOverrides": RemoveProductSeoInformationOverridesResult,
      "removeProductOptionsOverrides": RemoveProductOptionsOverridesResult,
      "removeProductStorefrontDetailsOverrides": RemoveProductStorefrontDetailsOverridesResult,
      "removeProductPreOrderSettingsOverrides": RemoveProductPreOrderSettingsOverridesResult,
      "setProductBasicInformation": SetProductBasicInformationResult,
      "setProductIsFeatured": SetProductIsFeaturedResult,
      "removeProductIsFeaturedOverride": RemoveProductIsFeaturedOverrideResult,
      "setProductSeoInformation": SetProductSeoInformationResult,
      "setProductStorefrontDetails": SetProductStorefrontDetailsResult,
      "setProductPreOrderSettings": SetProductPreOrderSettingsResult,
      "setProductOptionsInformation": SetProductOptionsInformationResult,
      "setProductUrlPath": SetProductUrlPathResult,
      "removeProductUrlPathOverride": RemoveProductUrlPathOverrideResult,
      "setProductModifiersInformation": SetProductModifiersInformationResult,
      "removeProductModifiersOverrides": RemoveProductModifiersOverridesResult
    }
  }
}

settings

Description

Store settings mutations.

Response

Returns a StoreSettingsMutations

Example

Query
mutation settings {
  settings {
    dataSolutions {
      ...DataSolutionsMutationsFragment
    }
  }
}
Response
{
  "data": {
    "settings": {"dataSolutions": DataSolutionsMutations}
  }
}

sharedProductModifiers

Description

Shared product modifiers mutations.

Example

Query
mutation sharedProductModifiers {
  sharedProductModifiers {
    setSharedProductModifiersInformation {
      ...SetSharedProductModifiersInformationResultFragment
    }
    removeSharedProductModifiersOverrides {
      ...RemoveSharedProductModifiersOverridesResultFragment
    }
  }
}
Response
{
  "data": {
    "sharedProductModifiers": {
      "setSharedProductModifiersInformation": SetSharedProductModifiersInformationResult,
      "removeSharedProductModifiersOverrides": RemoveSharedProductModifiersOverridesResult
    }
  }
}

sharedProductOptions

Description

Shared product options mutations.

Response

Returns a SharedProductOptionsMutations!

Example

Query
mutation sharedProductOptions {
  sharedProductOptions {
    setSharedProductOptionsInformation {
      ...SetSharedProductOptionsInformationResultFragment
    }
    removeSharedProductOptionsOverrides {
      ...RemoveSharedProductOptionsOverridesResultFragment
    }
  }
}
Response
{
  "data": {
    "sharedProductOptions": {
      "setSharedProductOptionsInformation": SetSharedProductOptionsInformationResult,
      "removeSharedProductOptionsOverrides": RemoveSharedProductOptionsOverridesResult
    }
  }
}

webhook

Description

Webhook mutations.

Response

Returns a WebhookMutations!

Example

Query
mutation webhook {
  webhook {
    createEventBridgeWebhook {
      ...CreateEventBridgeWebhookResultFragment
    }
    createPubSubWebhook {
      ...CreatePubSubWebhookResultFragment
    }
    createHttpsWebhook {
      ...CreateHttpsWebhookResultFragment
    }
    deleteWebhook {
      ...DeleteWebhookResultFragment
    }
    updatePubSubWebhook {
      ...UpdatePubSubWebhookResultFragment
    }
    updateEventBridgeWebhook {
      ...UpdateEventBridgeWebhookResultFragment
    }
    updateHttpsWebhook {
      ...UpdateHttpsWebhookResultFragment
    }
  }
}
Response
{
  "data": {
    "webhook": {
      "createEventBridgeWebhook": CreateEventBridgeWebhookResult,
      "createPubSubWebhook": CreatePubSubWebhookResult,
      "createHttpsWebhook": CreateHttpsWebhookResult,
      "deleteWebhook": DeleteWebhookResult,
      "updatePubSubWebhook": UpdatePubSubWebhookResult,
      "updateEventBridgeWebhook": UpdateEventBridgeWebhookResult,
      "updateHttpsWebhook": UpdateHttpsWebhookResult
    }
  }
}

Types

Account

Description

An account.

Fields
Field Name Description
id - ID! The ID of the object.
Example
{"id": 4}

AlreadyExistsError

Description

Error indicating that the result of the operation would cause duplicate.

Fields
Field Name Description
message - String! Information about error.
Example
{"message": "xyz789"}

AppExtension

Description

The response object for any query or mutation that returns an App Extension.

Fields
Field Name Description
id - ID! The ID of the object.
context - AppExtensionContext Defines the action that the control panel performs after the user clicks the App Extension label.
label - AppExtensionLabel! The locale-aware options for the App Extension menu item link text.
model - AppExtensionModel The entity type to which the App Extension relates; for example, Orders.
url - String! A relative path with some meaning to your app, most commonly an internally-defined GET route. The path should contain a supported path parameter that the app expects to be templated into its route, defined as a JavaScript string template literal. For example, '/customer/auth/${id}'. Currently, id is the only supported parameter. Limit 255 characters.
Example
{
  "id": 4,
  "context": "LINK",
  "label": AppExtensionLabel,
  "model": "CUSTOMERS",
  "url": "xyz789"
}

AppExtensionContext

Description

Defines the action that the control panel performs after the user clicks the App Extension label.

Values
Enum Value Description

LINK

The control panel navigates the user away from their current page to the parent app's page, where the app can render App Extension-specific content.

PANEL

The control panel opens a side panel on the user's current page, where the app can render content without navigating away.
Example
"LINK"

AppExtensionLabel

Description

An object that contains locale-aware link text for the App Extension URL. The control panel user sees this link text wherever they have the option to open the App Extension.

Fields
Field Name Description
defaultValue - String! The link text that the user sees when the control panel language is English or a language for which the developer has not defined a label in label.locales. The defaultValue should be in English. Suggested length of ≤25 characters; limit 255 characters.
locales - [AppExtensionLabelLocale!]! The list of locale-aware link text options for an App Extension, excluding the defaultValue.
Example
{
  "defaultValue": "abc123",
  "locales": [AppExtensionLabelLocale]
}

AppExtensionLabelInput

Description

The label of the App Extension.

Fields
Input Field Description
defaultValue - String! The link text that the user sees when the control panel language is English or not defined by the developer in label.locales. The defaultValue should be in English. Suggested length of ≤25 characters; limit 255 characters.
locales - [AppExtensionLabelLocaleInput!]! A list of alternate link text values and their corresponding locale codes.
Example
{
  "defaultValue": "xyz789",
  "locales": [AppExtensionLabelLocaleInput]
}

AppExtensionLabelLocale

Description

The locale-specific link text and corresponding locales for an App Extension.

Fields
Field Name Description
localeCode - String! The locale code for the link text; for example, pt-BR for Portuguese. The locale code should correspond with a control panel-supported language. See the App Extensions documentation for a list of currently supported languages and corresponding locale codes.
value - String! The link text that the user sees when the control panel language corresponds with the accompanying locale code. Suggested length of ≤25 characters; limit 255 characters.
Example
{
  "localeCode": "xyz789",
  "value": "xyz789"
}

AppExtensionLabelLocaleInput

Description

A developer-defined list of alternate link text values and their corresponding locale codes.

Fields
Input Field Description
localeCode - String! A locale code that corresponds with a control-panel supported language. For example, de-DE for German. See the App Extensions documentation for a list of currently supported languages and corresponding locale codes.
value - String! The link text value in the language of the locale code. Suggested length of ≤25 characters; limit 255 characters.
Example
{
  "localeCode": "xyz789",
  "value": "abc123"
}

AppExtensionModel

Description

The entity type to which an App Extension relates. The path parameter templated into the App Extension URL takes a model property as its argument. For example, an App Extension active on the CUSTOMERS model converts /auth/${id} into /auth/227 for the customer whose ID value is 227.

Values
Enum Value Description

CUSTOMERS

The App Extension appears on the supported customer-related pages and takes Customer properties as arguments.

ORDERS

The App Extension appears on the supported orders-related pages and takes Orders properties as arguments.

PRODUCTS

The App Extension appears on the supported products-related pages and takes Products properties as arguments.

PRODUCT_DESCRIPTION

The App Extension appears on the description field on supported Edit Products pages and takes Products properties as arguments.
Example
"CUSTOMERS"

AppExtensionMutations

Description

Mutations that create, update, and delete App Extensions.

Fields
Field Name Description
createAppExtension - CreateAppExtensionResult Registers a new App Extension to the store and associates it with the requesting API account.
Arguments
updateAppExtension - UpdateAppExtensionResult Updates an existing App Extension registered to the store and associates it with the requesting API account.
Arguments
deleteAppExtension - DeleteAppExtensionResult Deletes an App Extension that belongs to the store and requesting API account.
Arguments
Example
{
  "createAppExtension": CreateAppExtensionResult,
  "updateAppExtension": UpdateAppExtensionResult,
  "deleteAppExtension": DeleteAppExtensionResult
}

AppExtensionsConnection

Description

A connection to a list of items.

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

AppExtensionsEdge

Description

An edge in a connection.

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

Boolean

Description

The Boolean scalar type represents true or false.

Example
true

ChannelLocaleContext

Description

The storefront channel and locale that apply when you override or retrieve product custom fields from a channel locale.

Fields
Field Name Description
channelId - ID! Storefront channel ID.
locale - String! Locale in a storefront channel.
Example
{"channelId": 4, "locale": "xyz789"}

CheckboxSharedProductModifier

Description

Checkbox shared product modifier.

Fields
Field Name Description
checkedByDefault - Boolean! Indicates whether shared product modifier is checked by default.
fieldValue - String Checkbox shared product modifier field value.
overridesForLocale - CheckboxSharedProductModifierForLocale Overrides for the checkbox shared modifier in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared modifiers from a channel locale.

id - ID! ID of the shared modifier.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Indicates whether the shared modifier is required.
Example
{
  "checkedByDefault": false,
  "fieldValue": "xyz789",
  "overridesForLocale": CheckboxSharedProductModifierForLocale,
  "id": "4",
  "displayName": "abc123",
  "isRequired": true
}

CheckboxSharedProductModifierForLocale

Description

Overrides for the checkbox shared product modifier in a channel locale.

Fields
Field Name Description
displayName - String Display name for the shared modifier.
fieldValue - String Field value for the shared modifier.
Example
{
  "displayName": "abc123",
  "fieldValue": "xyz789"
}

Client

Description

A client.

Fields
Field Name Description
clientId - String Identifier of a client.
scopes - ScopeConnection List of client scopes.
Arguments
before - String
after - String
first - Int
last - Int
Example
{
  "clientId": "abc123",
  "scopes": ScopeConnection
}

CreateAppExtensionInput

Fields
Input Field Description
context - AppExtensionContext! Defines the action that the control panel performs after the user clicks the App Extension label.
label - AppExtensionLabelInput! The locale-aware link text options for the App Extension's menu item. The control panel user sees this text value wherever they have the option to open the App Extension.
model - AppExtensionModel! The entity type to which the App Extension relates; for example, Orders. The model corresponds with the page on which the App Extension appears.
url - String! A relative path with some meaning to your app, most commonly an internally-defined GET route. The path should contain a path parameter that the app expects to be templated into its route, defined as a JavaScript string template expression. For example, /customer/auth/${id}. Currently, id is the only supported parameter. Limit 255 characters.
Example
{
  "context": "LINK",
  "label": AppExtensionLabelInput,
  "model": "CUSTOMERS",
  "url": "xyz789"
}

CreateAppExtensionResult

Fields
Field Name Description
appExtension - AppExtension The response object properties available after creating an App Extension.
Example
{"appExtension": AppExtension}

CreateEventBridgeWebhookError

Description

Error object for create Amazon EventBridge webhook mutation.

Example
AlreadyExistsError

CreateEventBridgeWebhookInput

Fields
Input Field Description
destination - String! The fields used to create an Amazon EventBridge webhook.
isActive - Boolean If webhook is active or not.
scope - String! The scope of the event subscription.
Example
{
  "destination": "abc123",
  "isActive": false,
  "scope": "abc123"
}

CreateEventBridgeWebhookResult

Fields
Field Name Description
webhook - EventBridgeWebhook The result returned after creating an Amazon EventBridge webhook.
errors - [CreateEventBridgeWebhookError!]! The list of errors that occurred while creating an Amazon EventBridge webhook.
Example
{
  "webhook": EventBridgeWebhook,
  "errors": [AlreadyExistsError]
}

CreateHttpsWebhookError

Description

Error object for create HTTPS webhook mutation.

Example
AlreadyExistsError

CreateHttpsWebhookInput

Fields
Input Field Description
destination - String! URL must be active, return a 200 response, and be served on port 443.
headers - [HttpsWebhookHeaderInput!] You can define any number of custom headers to be attached to the event sent to the destination URL.
isActive - Boolean If webhook is active or not.
scope - String! The scope of the event subscription.
Example
{
  "destination": "abc123",
  "headers": [HttpsWebhookHeaderInput],
  "isActive": false,
  "scope": "xyz789"
}

CreateHttpsWebhookResult

Fields
Field Name Description
webhook - HttpsWebhook The webhook object returned as a result of a mutation.
errors - [CreateHttpsWebhookError!]! The list of errors that occurred while creating a HTTPS webhook.
Example
{
  "webhook": HttpsWebhook,
  "errors": [AlreadyExistsError]
}

CreateMetafieldErrors

Description

Union type for all 'createMetafield' mutation errors.

Example
AlreadyExistsError

CreateMetafieldInput

Fields
Input Field Description
namespace - String! Namespace for the metafield.
resourceId - ID The unique identifier for the resource with which the metafield is associated.
key - String! The name of the metafield.
value - String! Value of the metafield.
description - String Description of the metafield.
permissionSet - MetafieldsPermissionSet! Determines the visibility and writeability of the field by other API consumers.
Example
{
  "namespace": "abc123",
  "resourceId": "4",
  "key": "xyz789",
  "value": "xyz789",
  "description": "abc123",
  "permissionSet": "APP_ONLY"
}

CreateMetafieldResult

Fields
Field Name Description
metafield - Metafield Metafield that was created as a result of mutation.
errors - [CreateMetafieldErrors!]! The list of errors that occurred while creating a metafield.
Example
{
  "metafield": Metafield,
  "errors": [AlreadyExistsError]
}

CreatePubSubWebhookError

Description

Error object for create Google Cloud PubSub webhook mutation.

Example
AlreadyExistsError

CreatePubSubWebhookInput

Fields
Input Field Description
destination - String! The Google Cloud Pub/Sub topic where events will be delivered. The topic must have the BigCommerce service account principal & Pub/Sub Publish permission enabled.
isActive - Boolean If webhook is active or not.
scope - String! The scope of the event subscription.
Example
{
  "destination": "abc123",
  "isActive": false,
  "scope": "abc123"
}

CreatePubSubWebhookResult

Fields
Field Name Description
webhook - PubSubWebhook The webhook object returned as a result of a mutation.
errors - [CreatePubSubWebhookError!]! The list of errors that occurred while creating a Google Pub/Sub webhook.
Example
{
  "webhook": PubSubWebhook,
  "errors": [AlreadyExistsError]
}

DataSolutionsMutations

Description

Data solutions mutations.

Fields
Field Name Description
updateDataLayer - UpdateDataLayerResult Update data layer configuration.
Arguments
Example
{"updateDataLayer": UpdateDataLayerResult}

DataSolutionsSettings

Description

Data solutions settings.

Fields
Field Name Description
isDataLayerEnabled - Boolean! Indicates if a data layer(bodl) object is enabled for all storefronts.
Example
{"isDataLayerEnabled": true}

DateFieldSharedProductModifier

Description

Date field shared product modifier.

Fields
Field Name Description
overridesForLocale - DateFieldSharedProductModifierForLocale Overrides for the date field shared modifier in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared modifiers from a channel locale.

id - ID! ID of the shared modifier.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Indicates whether the shared modifier is required.
Example
{
  "overridesForLocale": DateFieldSharedProductModifierForLocale,
  "id": "4",
  "displayName": "abc123",
  "isRequired": true
}

DateFieldSharedProductModifierForLocale

Description

Overrides for the date field shared modifier in a channel locale.

Fields
Field Name Description
displayName - String Display name for the shared modifier.
Example
{"displayName": "xyz789"}

DateTime

Description

ISO-8601 formatted date in UTC

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

DeleteAppExtensionInput

Fields
Input Field Description
id - ID! The ID of the object.
Example
{"id": "4"}

DeleteAppExtensionResult

Description

The response object property available after deleting an App Extension; the currently available property is the ID of the deleted App Extension.

Fields
Field Name Description
deletedAppExtensionId - ID The ID of the object.
Example
{"deletedAppExtensionId": "4"}

DeleteMetafieldErrors

Description

Union type for all 'deleteMetafield' mutation errors.

Example
ValidationError

DeleteMetafieldInput

Description

Input for deleteMetafield mutation.

Fields
Input Field Description
id - ID! The ID of metafield to delete.
Example
{"id": "4"}

DeleteMetafieldResult

Fields
Field Name Description
deletedMetafieldId - ID The id of metafield that is deleted as a result of mutation.
errors - [DeleteMetafieldErrors!]! The list of errors that occurred while creating a metafield.
Example
{"deletedMetafieldId": 4, "errors": [ValidationError]}

DeleteWebhookError

Description

Error object for delete webhook mutation.

Types
Union Types

EntityNotFoundError

Example
EntityNotFoundError

DeleteWebhookInput

Fields
Input Field Description
webhookId - ID! The ID of the webhook to be deleted.
Example
{"webhookId": 4}

DeleteWebhookResult

Description

The webhook ID that is deleted as a result of a mutation.

Fields
Field Name Description
id - ID The ID of the deleted webhook.
errors - [DeleteWebhookError!]! The list of errors that occurred while deleting a webhook.
Example
{"id": 4, "errors": [EntityNotFoundError]}

DestinationNotAllowedError

Description

Error indicating that the destination has already been taken by other hook type.

Fields
Field Name Description
message - String! Information about error.
Example
{"message": "abc123"}

DropdownSharedOptionValue

Description

Dropdown shared option value.

Fields
Field Name Description
id - ID! ID of the shared option value.
isDefault - Boolean! Indicates whether this value is the chosen default value.
label - String! Label for the shared option value.
Example
{
  "id": 4,
  "isDefault": true,
  "label": "xyz789"
}

DropdownSharedOptionValueForLocale

Description

Overrides for the dropdown shared option values in a channel locale.

Fields
Field Name Description
id - ID! ID of the shared option value.
label - String! Label for the shared option value.
Example
{
  "id": "4",
  "label": "abc123"
}

DropdownSharedOptionValueOverridesForChannelLocale

Description

Overrides for the dropdown shared product option in a context of channel and locale.

Fields
Field Name Description
id - ID! ID of the dropdown shared option value in a context of channel and locale.
label - String Label for the dropdown shared option value in a context of channel and locale.
Example
{"id": 4, "label": "abc123"}

DropdownSharedProductModifier

Description

Dropdown shared product modifier.

Fields
Field Name Description
overridesForLocale - DropdownSharedProductModifierForLocale Overrides for the dropdown shared modifier in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared modifiers from a channel locale.

values - [DropdownSharedProductModifierValue!]! Dropdown shared modifier values.
id - ID! ID of the shared modifier.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Indicates whether the shared modifier is required.
Example
{
  "overridesForLocale": DropdownSharedProductModifierForLocale,
  "values": [DropdownSharedProductModifierValue],
  "id": "4",
  "displayName": "xyz789",
  "isRequired": false
}

DropdownSharedProductModifierForLocale

Description

Overrides for the dropdown shared modifier in a channel locale.

Fields
Field Name Description
displayName - String Display name for the shared modifier.
values - [DropdownSharedProductModifierValueForLocale!]! Shared modifier values.
Example
{
  "displayName": "abc123",
  "values": [DropdownSharedProductModifierValueForLocale]
}

DropdownSharedProductModifierValue

Description

Dropdown shared modifier value.

Fields
Field Name Description
id - ID! ID of the shared modifier value.
isDefault - Boolean! Indicates whether the shared modifier value is selected by default.
label - String! Label for the shared modifier value.
Example
{
  "id": "4",
  "isDefault": false,
  "label": "xyz789"
}

DropdownSharedProductModifierValueForLocale

Description

Overrides for values of the dropdown shared modifier in a channel locale.

Fields
Field Name Description
id - ID! ID of the shared modifier.
label - String! Label for the shared modifier.
Example
{
  "id": "4",
  "label": "abc123"
}

DropdownSharedProductOption

Description

Dropdown shared option.

Fields
Field Name Description
displayName - String! Display name for the shared option.
id - ID! ID of the shared option.
overridesForLocale - SharedProductOptionForLocale Shared option overrides for a channel locale. Use 'overrides' field instead
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared options from a channel locale.

overrides - SharedProductOptionOverridesConnection! Overrides for a dropdown shared product option in a context of channel and locale.
Arguments
context - SharedProductOptionOverridesContextInput

Dropdown shared product option overrides context.

before - String
after - String
first - Int
last - Int
values - [SharedProductOptionValue!]! List of shared option values.
Example
{
  "displayName": "xyz789",
  "id": "4",
  "overridesForLocale": SharedProductOptionForLocale,
  "overrides": SharedProductOptionOverridesConnection,
  "values": [SharedProductOptionValue]
}

DropdownSharedProductOptionForLocale

Description

Overrides for the dropdown shared option in a channel locale.

Fields
Field Name Description
displayName - String Display name for a shared option.
values - [SharedProductOptionValueForLocale!]! List of shared option values.
Example
{
  "displayName": "xyz789",
  "values": [SharedProductOptionValueForLocale]
}

EntityAlreadyExistsError

Description

Error indicating that the result of mutation would cause duplicate.

Fields
Field Name Description
id - ID! Id of an entity error is caused by.
message - String! Information about error.
Example
{"id": 4, "message": "abc123"}

EntityError

Description

Common interface for all entity related mutations errors.

Fields
Field Name Description
id - ID! Id of an entity error is caused by.
message - String! Information about error.
Possible Types
EntityError Types

EntityAlreadyExistsError

EntityNotFoundError

Example
{
  "id": "4",
  "message": "xyz789"
}

EntityNotFoundError

Description

Error indicating that requested entity was not found.

Fields
Field Name Description
id - ID! Id of an entity error is caused by.
message - String! Information about error.
Example
{"id": 4, "message": "abc123"}

Error

EventBridgeSourceNotFoundError

Description

Error indicating that requested Amazon EventBridge source was not found.

Fields
Field Name Description
source - String! Amazon EventBridge source arn.
message - String! Information about error.
Example
{
  "source": "xyz789",
  "message": "xyz789"
}

EventBridgeWebhook

Description

An Amazon EventBridge webhook.

Fields
Field Name Description
destination - String! Amazon EventBridge source arn.
clientId - String! ID of client application owning the webhook.
createdAt - DateTime The date and time of webhook creation.
id - ID! The ID of a webhook object.
scope - String! The scope of the event subscription.
status - WebhookStatus! The status of a webhook.
updatedAt - DateTime The date and time of the last webhook update.
Example
{
  "destination": "xyz789",
  "clientId": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "id": 4,
  "scope": "xyz789",
  "status": "ACTIVE",
  "updatedAt": "2007-12-03T10:15:30Z"
}

FileUploadSharedProductModifier

Description

File upload shared product modifier.

Fields
Field Name Description
overridesForLocale - FileUploadSharedProductModifierForLocale Overrides for a file upload shared modifier in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared modifiers from a channel locale.

id - ID! ID of the shared modifier.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Indicates whether the shared modifier is required.
Example
{
  "overridesForLocale": FileUploadSharedProductModifierForLocale,
  "id": 4,
  "displayName": "abc123",
  "isRequired": true
}

FileUploadSharedProductModifierForLocale

Description

Overrides for a file upload shared modifier in a channel locale.

Fields
Field Name Description
displayName - String Display name for the shared modifier.
Example
{"displayName": "xyz789"}

Float

Description

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

Example
987.65

HttpsWebhook

Description

An https webhook.

Fields
Field Name Description
destination - String! URL must be active, return a 200 response, and be served on port 443.
headers - [HttpsWebhookHeader!]! You can pass custom headers to validate webhooks being returned.
clientId - String! ID of client application owning the webhook.
createdAt - DateTime The date and time of webhook creation.
id - ID! The ID of a webhook object.
scope - String! The scope of the event subscription.
status - WebhookStatus! The status of a webhook.
updatedAt - DateTime The date and time of the last webhook update.
Example
{
  "destination": "abc123",
  "headers": [HttpsWebhookHeader],
  "clientId": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "id": "4",
  "scope": "abc123",
  "status": "ACTIVE",
  "updatedAt": "2007-12-03T10:15:30Z"
}

HttpsWebhookHeader

Description

The HTTP header to include with webhook event messages.

Fields
Field Name Description
key - String! Name of the custom header.
value - String! The input value of the returned webhook.
Example
{
  "key": "abc123",
  "value": "abc123"
}

HttpsWebhookHeaderInput

Description

The input HTTP header to be sent with the event message.

Fields
Input Field Description
key - String! The input key validates a returned webhook.
value - String! The input value of the returned webhook.
Example
{
  "key": "xyz789",
  "value": "xyz789"
}

ID

Description

The ID scalar type represents a unique identifier, often used to re-fetch an object or as key for a cache.

Example
"4"

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
987

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
{}

Metafield

Description

A metafield.

Fields
Field Name Description
id - ID! The ID of the metafield.
description - String! Metafield description.
key - String! Metafield key.
namespace - String! Metafield namespace.
permissionSet - MetafieldsPermissionSet! Metafield permission set.
resourceId - ID! Resource id of an entity metafield related to.
value - String! Metafield value.
ownerClientId - String! Identifier of metafields owner.
Example
{
  "id": "4",
  "description": "abc123",
  "key": "xyz789",
  "namespace": "xyz789",
  "permissionSet": "APP_ONLY",
  "resourceId": "4",
  "value": "xyz789",
  "ownerClientId": "xyz789"
}

MetafieldLimitExceededError

Description

This operation exceeds one of metafield's limits. Check metafields documentation for more information.

Fields
Field Name Description
limit - Int! The maximum number of metafields allowed.
message - String! Information about error.
Example
{"limit": 987, "message": "abc123"}

MetafieldMutations

Description

Metafield mutations.

Fields
Field Name Description
createMetafield - CreateMetafieldResult Create Metafield.
Arguments
updateMetafield - UpdateMetafieldResult Update Metafield.
Arguments
deleteMetafield - DeleteMetafieldResult Delete Metafield.
Arguments
reassignMetafieldsOwner - ReassignMetafieldsOwnerResult Reassign metafields to new client.
Arguments
Example
{
  "createMetafield": CreateMetafieldResult,
  "updateMetafield": UpdateMetafieldResult,
  "deleteMetafield": DeleteMetafieldResult,
  "reassignMetafieldsOwner": ReassignMetafieldsOwnerResult
}

MetafieldsConnection

Description

A connection to a list of items.

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

MetafieldsEdge

Description

An edge in a connection.

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

MetafieldsFiltersInput

Fields
Input Field Description
namespace - String Namespace for the metafield.
resourceIds - [ID!] The unique identifier for the resource with which the metafield is associated.
resourceType - MetafieldsResourceType The type of resource with which the metafield is associated.
Example
{
  "namespace": "xyz789",
  "resourceIds": [4],
  "resourceType": "BRAND"
}

MetafieldsPermissionSet

Description

Determines the visibility and writeability of the field by other API consumers.

Values
Enum Value Description

APP_ONLY

Private to the app that owns the field.

READ

Visible to other API consumers.

READ_AND_SF_ACCESS

Visible to other API consumers, including on storefront.

WRITE

Open for reading and writing by other API consumers.

WRITE_AND_SF_ACCESS

Open for reading and writing by other API consumers, including on storefront.
Example
"APP_ONLY"

MetafieldsResourceType

Description

The type of resource with which the metafield is associated.

Values
Enum Value Description

BRAND

Metafield is associated with brand.

CART

Metafield is associated with cart.

CATEGORY

Metafield is associated with category.

CHANNEL

Metafield is associated with channel.

CUSTOMER

Metafield is associated with customer.

LOCATION

Metafield is associated with location.

ORDER

Metafield is associated with order.

PRODUCT

Metafield is associated with product.

STORE

Metafield is associated with store.

VARIANT

Metafield is associated with variant.
Example
"BRAND"

MultilineTextFieldSharedProductModifier

Description

Multiline text field shared modifier.

Fields
Field Name Description
defaultValue - String Default value for the shared modifier.
overridesForLocale - MultilineTextFieldSharedProductModifierForLocale Overrides for the multiline text field shared modifier in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared modifiers from a channel locale.

id - ID! ID of the shared modifier.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Indicates whether the shared modifier is required.
Example
{
  "defaultValue": "abc123",
  "overridesForLocale": MultilineTextFieldSharedProductModifierForLocale,
  "id": 4,
  "displayName": "xyz789",
  "isRequired": true
}

MultilineTextFieldSharedProductModifierForLocale

Description

Overrides for the multiline text field shared modifier in a channel locale.

Fields
Field Name Description
defaultValue - String Default value for the shared modifier.
displayName - String Display name for the shared modifier.
Example
{
  "defaultValue": "xyz789",
  "displayName": "abc123"
}

Node

Description

An object with an ID.

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

EventBridgeWebhook

HttpsWebhook

PubSubWebhook

Example
{"id": 4}

NotAuthorizedFieldToUpdateMetafieldFieldError

Description

One of provided on update fields cannot be updated. Only 'key', 'value', and 'namespace' fields can be updated by not an entity owner with the 'write' permissions.

Fields
Field Name Description
message - String! Information about error.
Example
{"message": "abc123"}

NotAuthorizedToDeleteMetafieldError

Description

The metafield could not be deleted by you. You are not an owner and metafield's permission was set to read.

Fields
Field Name Description
message - String! Information about error.
Example
{"message": "abc123"}

NotAuthorizedToUpdateMetafieldError

Description

The read-only metafield cannot be updated by not an owner. The metafield's permissions are set to 'read'.

Fields
Field Name Description
message - String! Information about error.
Example
{"message": "xyz789"}

NumbersOnlyTextFieldSharedProductModifier

Description

Numbers-only text field shared product modifier.

Fields
Field Name Description
defaultValue - Float Default value for the shared modifier.
overridesForLocale - NumbersOnlyTextFieldSharedProductModifierForLocale Overrides for the shared modifier in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared modifiers from a channel locale.

id - ID! ID of the shared modifier.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Indicates whether the shared modifier is required.
Example
{
  "defaultValue": 123.45,
  "overridesForLocale": NumbersOnlyTextFieldSharedProductModifierForLocale,
  "id": "4",
  "displayName": "abc123",
  "isRequired": false
}

NumbersOnlyTextFieldSharedProductModifierForLocale

Description

Overrides for the numbers-only text field shared modifier in a channel locale.

Fields
Field Name Description
defaultValue - Float Default value for the shared modifier.
displayName - String Display name for the shared modifier.
Example
{
  "defaultValue": 987.65,
  "displayName": "abc123"
}

PageInfo

Description

Information about pagination in a connection.

Fields
Field Name Description
hasNextPage - Boolean! Indicates whether there are more items when paginating forwards.
hasPreviousPage - Boolean! Indicates whether there are more items when paginating backward.
startCursor - String The starting cursor when paginating backward.
endCursor - String The ending cursor when paginating forwards.
Example
{
  "hasNextPage": false,
  "hasPreviousPage": false,
  "startCursor": "abc123",
  "endCursor": "abc123"
}

PreOrderSettings

Description

Product pre-order settings.

Fields
Field Name Description
message - String Message about a pre-order for a product.
Example
{"message": "xyz789"}

PreOrderSettingsOverridesForLocale

Description

Overrides for pre-order settings in a channel locale.

Fields
Field Name Description
message - String Pre-order message in a channel locale.
Example
{"message": "xyz789"}

Product

Description

A product.

Fields
Field Name Description
id - ID! The ID of the product.
basicInformation - ProductBasicInformation! Basic product information.
isFeatured - Boolean! Indicates whether a product is marked as a featured product.
urlPath - ProductUrlPath! Product path.
overridesForLocale - ProductOverridesForLocale Overrides for the product in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve product information from a channel locale.

overridesForChannel - ProductOverridesForChannel Product overrides for a specific channel.
Arguments
channelId - ID!

Channel ID.

seoInformation - ProductSeoInformation! Product SEO information.
storefrontDetails - StorefrontDetails! Product storefront details.
preOrderSettings - PreOrderSettings! Product pre-order settings.
Example
{
  "id": 4,
  "basicInformation": ProductBasicInformation,
  "isFeatured": false,
  "urlPath": ProductUrlPath,
  "overridesForLocale": ProductOverridesForLocale,
  "overridesForChannel": ProductOverridesForChannel,
  "seoInformation": ProductSeoInformation,
  "storefrontDetails": StorefrontDetails,
  "preOrderSettings": PreOrderSettings
}

ProductBasicInformation

Description

The basic information about the product.

Fields
Field Name Description
description - String Description of the product.
name - String! Name of the product.
Example
{
  "description": "abc123",
  "name": "abc123"
}

ProductBasicInformationField

Description

Product basic information field names

Values
Enum Value Description

PRODUCT_DESCRIPTION_FIELD

The description field.

PRODUCT_NAME_FIELD

The name field.
Example
"PRODUCT_DESCRIPTION_FIELD"

ProductBasicInformationOverridesForLocale

Description

Overrides for basic product information in a channel locale.

Fields
Field Name Description
description - String Description for the product in a channel locale.
name - String Name for the product in a channel locale.
Example
{
  "description": "abc123",
  "name": "abc123"
}

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.
Example
{
  "pageInfo": PageInfo,
  "edges": [ProductEdge]
}

ProductEdge

Description

An edge in a connection.

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

ProductMutations

Description

Product mutations.

Fields
Field Name Description
removeProductBasicInformationOverrides - RemoveProductBasicInformationOverridesResult Removes overrides for product basic information from a locale.
removeProductSeoInformationOverrides - RemoveProductSeoInformationOverridesResult Removes overrides for product SEO information from a locale.
removeProductOptionsOverrides - RemoveProductOptionsOverridesResult Removes product option overrides from a locale.
removeProductStorefrontDetailsOverrides - RemoveProductStorefrontDetailsOverridesResult Removes overrides for product storefront details from a locale.
removeProductPreOrderSettingsOverrides - RemoveProductPreOrderSettingsOverridesResult Removes overrides for product pre-order settings from a locale.
setProductBasicInformation - SetProductBasicInformationResult Sets product basic information.
setProductIsFeatured - SetProductIsFeaturedResult Sets whether a product is marked as featured.
Arguments
removeProductIsFeaturedOverride - RemoveProductIsFeaturedOverrideResult Removes overrides for whether a product is featured from a locale.
setProductSeoInformation - SetProductSeoInformationResult Sets product SEO information.
Arguments
setProductStorefrontDetails - SetProductStorefrontDetailsResult Sets product storefront details.
setProductPreOrderSettings - SetProductPreOrderSettingsResult Sets product pre-order settings.
setProductOptionsInformation - SetProductOptionsInformationResult Sets product option information.
setProductUrlPath - SetProductUrlPathResult Sets a product URL path.
Arguments
removeProductUrlPathOverride - RemoveProductUrlPathOverrideResult Removes overrides for a product URL path from a locale.
setProductModifiersInformation - SetProductModifiersInformationResult Sets product modifier information.
removeProductModifiersOverrides - RemoveProductModifiersOverridesResult Remove product modifier overrides from a locale.
Example
{
  "removeProductBasicInformationOverrides": RemoveProductBasicInformationOverridesResult,
  "removeProductSeoInformationOverrides": RemoveProductSeoInformationOverridesResult,
  "removeProductOptionsOverrides": RemoveProductOptionsOverridesResult,
  "removeProductStorefrontDetailsOverrides": RemoveProductStorefrontDetailsOverridesResult,
  "removeProductPreOrderSettingsOverrides": RemoveProductPreOrderSettingsOverridesResult,
  "setProductBasicInformation": SetProductBasicInformationResult,
  "setProductIsFeatured": SetProductIsFeaturedResult,
  "removeProductIsFeaturedOverride": RemoveProductIsFeaturedOverrideResult,
  "setProductSeoInformation": SetProductSeoInformationResult,
  "setProductStorefrontDetails": SetProductStorefrontDetailsResult,
  "setProductPreOrderSettings": SetProductPreOrderSettingsResult,
  "setProductOptionsInformation": SetProductOptionsInformationResult,
  "setProductUrlPath": SetProductUrlPathResult,
  "removeProductUrlPathOverride": RemoveProductUrlPathOverrideResult,
  "setProductModifiersInformation": SetProductModifiersInformationResult,
  "removeProductModifiersOverrides": RemoveProductModifiersOverridesResult
}

ProductOverridesForChannel

Description

Product overrides for a channel.

Fields
Field Name Description
isFeatured - Boolean Product isFeatured override for a specific channel.
Example
{"isFeatured": true}

ProductOverridesForLocale

Description

Product overrides for a channel locale.

Fields
Field Name Description
basicInformation - ProductBasicInformationOverridesForLocale Basic information override of the product for a channel locale.
seoInformation - ProductSeoInformationOverridesForLocale Override for product SEO information in a channel locale.
storefrontDetails - StorefrontDetailsOverridesForLocale Product storefront details.
urlPath - ProductUrlPathOverridesForLocale Product path override.
preOrderSettings - PreOrderSettingsOverridesForLocale Pre-order settings override of the product for a channel locale.
Example
{
  "basicInformation": ProductBasicInformationOverridesForLocale,
  "seoInformation": ProductSeoInformationOverridesForLocale,
  "storefrontDetails": StorefrontDetailsOverridesForLocale,
  "urlPath": ProductUrlPathOverridesForLocale,
  "preOrderSettings": PreOrderSettingsOverridesForLocale
}

ProductOverridesLocaleContextInput

Description

Input for the context of a product override.

Fields
Input Field Description
channelId - ID! Storefront channel.
locale - String! Locale in the channel.
Example
{"channelId": 4, "locale": "abc123"}

ProductPreOrderSettingsField

Description

Product pre-order settings field names

Values
Enum Value Description

PRODUCT_PRE_ORDER_MESSAGE

The pre-order message.
Example
"PRODUCT_PRE_ORDER_MESSAGE"

ProductSeoInformation

Description

Product SEO information about the product.

Fields
Field Name Description
metaDescription - String Meta description for the product.
pageTitle - String Page title for the product.
Example
{
  "metaDescription": "xyz789",
  "pageTitle": "abc123"
}

ProductSeoInformationField

Description

Product SEO information field names.

Values
Enum Value Description

PRODUCT_META_DESCRIPTION_FIELD

The meta description field.

PRODUCT_PAGE_TITLE_FIELD

The page title field.
Example
"PRODUCT_META_DESCRIPTION_FIELD"

ProductSeoInformationOverridesForLocale

Description

Product SEO information overrides in a channel locale.

Fields
Field Name Description
metaDescription - String Override for a product meta description in a channel locale.
pageTitle - String Override for a product page title in a channel locale.
Example
{
  "metaDescription": "abc123",
  "pageTitle": "xyz789"
}

ProductStorefrontDetailsField

Description

Product storefront details field names

Values
Enum Value Description

PRODUCT_AVAILABILITY_DESCRIPTION_FIELD

The availability description.

PRODUCT_SEARCH_KEYWORDS

The search keywords.

PRODUCT_WARRANTY

The warranty.
Example
"PRODUCT_AVAILABILITY_DESCRIPTION_FIELD"

ProductUrlPath

Description

Product URL path.

Fields
Field Name Description
path - String! Value for the product URL path.
Example
{"path": "xyz789"}

ProductUrlPathOverridesForLocale

Description

Product path overrides in a channel locale.

Fields
Field Name Description
path - String Path override value in a channel locale.
Example
{"path": "abc123"}

ProductsFiltersInput

Fields
Input Field Description
ids - [ID!] The unique identifiers of the products.
Example
{"ids": ["4"]}

PubSubNoPermissionToPublishError

Description

Error indicating that requested Google Cloud Pub/Sub topic does not have permission to publish.

Fields
Field Name Description
topic - String! Google Cloud Pub/Sub topic name.
message - String! Information about error.
Example
{
  "topic": "abc123",
  "message": "abc123"
}

PubSubTopicNotFoundError

Description

Error indicating that requested Google Cloud Pub/Sub topic was not found.

Fields
Field Name Description
topic - String! Google Cloud Pub/Sub topic name.
message - String! Information about error.
Example
{
  "topic": "xyz789",
  "message": "abc123"
}

PubSubWebhook

Description

A Google Cloud PubSub webhook.

Fields
Field Name Description
destination - String! The Google Cloud PubSub topic that’s been enabled with Publisher permissions. See the PubSub config narrative page and https://cloud.google.com/pubsub/docs/create-topic#resource_names for more info.
clientId - String! ID of client application owning the webhook.
createdAt - DateTime The date and time of webhook creation.
id - ID! The ID of a webhook object.
scope - String! The scope of the event subscription.
status - WebhookStatus! The status of a webhook.
updatedAt - DateTime The date and time of the last webhook update.
Example
{
  "destination": "abc123",
  "clientId": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "id": 4,
  "scope": "abc123",
  "status": "ACTIVE",
  "updatedAt": "2007-12-03T10:15:30Z"
}

RadioButtonsSharedOptionValue

Description

Radio buttons shared option value

Fields
Field Name Description
id - ID! ID of the shared option value.
isDefault - Boolean! Indicates whether this value is the chosen default value.
label - String! Label for the shared option value.
Example
{
  "id": "4",
  "isDefault": false,
  "label": "xyz789"
}

RadioButtonsSharedOptionValueForLocale

Description

Overrides for values of the radio buttons shared option in a channel locale.

Fields
Field Name Description
id - ID! ID of the shared option value.
label - String! Label for the shared option value.
Example
{"id": 4, "label": "abc123"}

RadioButtonsSharedOptionValueOverridesForChannelLocale

Description

Overrides for the radio buttons shared product option in a context of channel and locale.

Fields
Field Name Description
id - ID! ID of the radio buttons shared option value in a context of channel and locale.
label - String Label for the radio buttons shared option value in a context of channel and locale.
Example
{"id": 4, "label": "xyz789"}

RadioButtonsSharedProductModifier

Description

Radio buttons shared product modifier.

Fields
Field Name Description
overridesForLocale - RadioButtonsSharedProductModifierForLocale Overrides for radio buttons shared modifiers in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared modifiers from a channel locale.

values - [RadioButtonsSharedProductModifierValue!]! Radio buttons shared product modifier values.
id - ID! ID of the shared modifier.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Indicates whether the shared modifier is required.
Example
{
  "overridesForLocale": RadioButtonsSharedProductModifierForLocale,
  "values": [RadioButtonsSharedProductModifierValue],
  "id": "4",
  "displayName": "abc123",
  "isRequired": false
}

RadioButtonsSharedProductModifierForLocale

Description

Overrides for radio buttons shared modifiers in a channel locale.

Fields
Field Name Description
displayName - String Display name for the shared modifier.
values - [RadioButtonsSharedProductModifierValueForLocale!]! Shared modifier values.
Example
{
  "displayName": "abc123",
  "values": [
    RadioButtonsSharedProductModifierValueForLocale
  ]
}

RadioButtonsSharedProductModifierValue

Description

Radio buttons shared modifier value.

Fields
Field Name Description
id - ID! ID of the shared modifier value.
isDefault - Boolean! Indicates whether the shared modifier value is selected by default.
label - String! Label for the shared modifier value.
Example
{
  "id": 4,
  "isDefault": false,
  "label": "xyz789"
}

RadioButtonsSharedProductModifierValueForLocale

Description

Overrides for values of the radio buttons shared modifier in a channel locale.

Fields
Field Name Description
id - ID! ID of the shared modifier.
label - String! Label for the shared modifier.
Example
{"id": 4, "label": "abc123"}

RadioButtonsSharedProductOption

Description

Radio buttons shared option.

Fields
Field Name Description
displayName - String! Display name for the shared option.
id - ID! ID of the shared option.
overridesForLocale - SharedProductOptionForLocale Shared option overrides for a channel locale. Use 'overrides' field instead
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared options from a channel locale.

overrides - SharedProductOptionOverridesConnection! Overrides for a radio buttons shared product option in a context of channel and locale.
Arguments
context - SharedProductOptionOverridesContextInput

Radio buttons shared product option overrides context.

before - String
after - String
first - Int
last - Int
values - [SharedProductOptionValue!]! List of shared option values.
Example
{
  "displayName": "xyz789",
  "id": "4",
  "overridesForLocale": SharedProductOptionForLocale,
  "overrides": SharedProductOptionOverridesConnection,
  "values": [SharedProductOptionValue]
}

RadioButtonsSharedProductOptionForLocale

Description

Override for the radio buttons shared option in a channel locale.

Fields
Field Name Description
displayName - String Display name for a shared option.
values - [SharedProductOptionValueForLocale!]! List of shared option values.
Example
{
  "displayName": "abc123",
  "values": [SharedProductOptionValueForLocale]
}

ReassignMetafieldOwnerError

Description

Errors that can occure while reassigning metafields owner. One of: EntityNotFound or EntityAlreadyExists.

Example
EntityNotFoundError

ReassignMetafieldsOwnerInput

Description

Reassign metafields owner input.

Fields
Input Field Description
newClientId - String! Identifier of client to which metafields should be reassigned to.
metafieldIds - [ID!]! Ids of metafields we want to reassign to new client.
Example
{
  "newClientId": "abc123",
  "metafieldIds": ["4"]
}

ReassignMetafieldsOwnerResult

Description

Result of reassigning metafields to new owner.

Fields
Field Name Description
metafieldIds - [ID!] Ids of metafields that were successfully reassigned to new owner.
errors - [ReassignMetafieldOwnerError!]! Errors that occurred during metafields reassignment.
Example
{"metafieldIds": [4], "errors": [EntityNotFoundError]}

RectangleListSharedOptionValue

Description

Rectangle list shared product option value

Fields
Field Name Description
id - ID! ID of the shared option value.
isDefault - Boolean! Indicates whether this value is the chosen default value.
label - String! Label for the shared option value.
Example
{
  "id": "4",
  "isDefault": true,
  "label": "abc123"
}

RectangleListSharedOptionValueForLocale

Description

Overrides for a rectangle list shared option value in a channel locale.

Fields
Field Name Description
id - ID! ID of the shared option value.
label - String! Label for the shared option value.
Example
{"id": 4, "label": "abc123"}

RectangleListSharedOptionValueOverridesForChannelLocale

Description

Overrides for the rectangle list shared product option in a context of channel and locale.

Fields
Field Name Description
id - ID! ID of the rectangle list shared option value in a context of channel and locale.
label - String Label for the rectangle list shared option value in a context of channel and locale.
Example
{
  "id": "4",
  "label": "xyz789"
}

RectangleListSharedProductModifier

Description

Rectangle list shared product modifier.

Fields
Field Name Description
overridesForLocale - RectangleListSharedProductModifierForLocale Overrides for the rectangle list shared modifier in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared modifiers from a channel locale.

values - [RectangleListSharedProductModifierValue!]! Rectangle list shared product modifiers values.
id - ID! ID of the shared modifier.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Indicates whether the shared modifier is required.
Example
{
  "overridesForLocale": RectangleListSharedProductModifierForLocale,
  "values": [RectangleListSharedProductModifierValue],
  "id": 4,
  "displayName": "xyz789",
  "isRequired": false
}

RectangleListSharedProductModifierForLocale

Description

Overrides for rectangle list shared modifiers in a channel locale.

Fields
Field Name Description
displayName - String Display name for the shared modifier.
values - [RectangleListSharedProductModifierValueForLocale!]! Shared modifier values.
Example
{
  "displayName": "abc123",
  "values": [
    RectangleListSharedProductModifierValueForLocale
  ]
}

RectangleListSharedProductModifierValue

Description

Rectangle list shared product modifier value.

Fields
Field Name Description
id - ID! The ID of the object.
isDefault - Boolean! Indicates whether rectangle list shared product modifier value is selected by default.
label - String! Rectangle list shared product modifier value label.
Example
{
  "id": 4,
  "isDefault": true,
  "label": "xyz789"
}

RectangleListSharedProductModifierValueForLocale

Description

Overrides for rectangle list shared product modifier value in a channel locale.

Fields
Field Name Description
id - ID! ID of the shared modifier.
label - String! Rectangle list shared product modifier value label override for a channel locale.
Example
{
  "id": "4",
  "label": "xyz789"
}

RectangleListSharedProductOption

Description

Rectangle list shared product option

Fields
Field Name Description
displayName - String! Display name for the shared option.
id - ID! ID of the shared option.
overridesForLocale - SharedProductOptionForLocale Shared option overrides for a channel locale. Use 'overrides' field instead
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared options from a channel locale.

overrides - SharedProductOptionOverridesConnection! Overrides for a rectangle list shared product option in a context of channel and locale.
Arguments
context - SharedProductOptionOverridesContextInput

Rectangle list shared product option overrides context.

before - String
after - String
first - Int
last - Int
values - [SharedProductOptionValue!]! List of shared option values.
Example
{
  "displayName": "abc123",
  "id": "4",
  "overridesForLocale": SharedProductOptionForLocale,
  "overrides": SharedProductOptionOverridesConnection,
  "values": [SharedProductOptionValue]
}

RectangleListSharedProductOptionForLocale

Description

Overrides for a rectangle list shared option in a channel locale.

Fields
Field Name Description
displayName - String Display name for a shared option.
values - [SharedProductOptionValueForLocale!]! List of shared option values.
Example
{
  "displayName": "xyz789",
  "values": [SharedProductOptionValueForLocale]
}

RemoveCheckboxProductModifierOverridesField

Description

Checkbox product modifier overrides field name

Values
Enum Value Description

CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.

CHECKBOX_PRODUCT_MODIFIER_VALUE_FIELD

The value field.
Example
"CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveCheckboxProductModifierOverridesInput

Description

Input that removes overrides for the checkbox product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveCheckboxProductModifierOverridesField!] Fields for the modifier.
Example
{"fields": ["CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveDateFieldProductModifierOverridesField

Description

Date field product modifier overrides field name

Values
Enum Value Description

DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveDateFieldProductModifierOverridesInput

Description

Input that removes overrides for the date field product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveDateFieldProductModifierOverridesField!] Fields for the modifier.
Example
{"fields": ["DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveDropdownProductModifierOverridesField

Description

Dropdown product modifier overrides field name

Values
Enum Value Description

DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveDropdownProductModifierOverridesInput

Description

Input that removes overrides for the dropdown product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveDropdownProductModifierOverridesField!] Fields for the modifier.
values - RemoveDropdownProductModifierValuesOverridesInput Values for the modifier.
Example
{
  "fields": ["DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveDropdownProductModifierValuesOverridesInput
}

RemoveDropdownProductModifierValuesOverridesInput

Description

Input that removes overrides for the values of a dropdown product modifier from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the modifier values.
Example
{"ids": [4]}

RemoveDropdownProductOptionOverridesField

Description

Dropdown product option overrides field names

Values
Enum Value Description

DROPDOWN_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"DROPDOWN_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveDropdownProductOptionOverridesInput

Description

Input that removes overrides for the dropdown product option from a channel locale.

Fields
Input Field Description
fields - [RemoveDropdownProductOptionOverridesField!] Product option fields that have overrides you want to remove.
values - RemoveDropdownProductOptionValuesOverridesInput Product option values that have overrides you want to remove.
Example
{
  "fields": ["DROPDOWN_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveDropdownProductOptionValuesOverridesInput
}

RemoveDropdownProductOptionValuesOverridesInput

Description

Input that removes overrides for the values of a dropdown product option from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the product option values that have overrides you want to remove.
Example
{"ids": ["4"]}

RemoveDropdownSharedProductOptionOverridesField

Description

Dropdown shared product option overrides field names

Values
Enum Value Description

DROPDOWN_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"DROPDOWN_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveDropdownSharedProductOptionOverridesInput

Description

Input that removes overrides for the dropdown shared product option from a channel locale.

Fields
Input Field Description
fields - [RemoveDropdownSharedProductOptionOverridesField!] Shared option fields that have overrides you want to remove.
values - RemoveDropdownSharedProductOptionValuesOverridesInput Shared option values that have overrides you want to remove.
Example
{
  "fields": ["DROPDOWN_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveDropdownSharedProductOptionValuesOverridesInput
}

RemoveDropdownSharedProductOptionValuesOverridesInput

Description

Input that removes overrides for the values of a dropdown shared product option from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the shared option values that have overrides you want to remove.
Example
{"ids": [4]}

RemoveFileUploadProductModifierOverridesField

Description

File upload product modifier overrides field name

Values
Enum Value Description

FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveFileUploadProductModifierOverridesInput

Description

Input that removes overrides for the file upload product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveFileUploadProductModifierOverridesField!] Fields for the modifier that have overrides you want to remove.
Example
{"fields": ["FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveMultiLineTextFieldProductModifierOverridesField

Description

MultiLine text field product modifier overrides field name

Values
Enum Value Description

MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field default value.

MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveMultiLineTextFieldProductModifierOverridesInput

Description

Input that removes overrides for the multiline text field product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveMultiLineTextFieldProductModifierOverridesField!] Fields for the modifier that have overrides you want to remove.
Example
{"fields": ["MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

RemoveNumberFieldProductModifierOverridesField

Description

Number field product modifier overrides field name

Values
Enum Value Description

NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field value.

NUMBER_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveNumberFieldProductModifierOverridesInput

Description

Input that removes overrides for the number-only text field product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveNumberFieldProductModifierOverridesField!] Fields for the modifier that have overrides you want to remove.
Example
{"fields": ["NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

RemovePickListProductModifierOverridesField

Description

Pick list product modifier overrides field name.

Values
Enum Value Description

PICK_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"PICK_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemovePickListProductModifierOverridesInput

Description

Pick list product modifier overrides input

Fields
Input Field Description
fields - [RemovePickListProductModifierOverridesField!] Pick list product modifier fields to remove overrides for
values - RemovePickListProductModifierValueOverridesInput Pick list product modifier values to remove overrides for
Example
{
  "fields": ["PICK_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemovePickListProductModifierValueOverridesInput
}

RemovePickListProductModifierValueOverridesInput

Description

Pick list product modifier values to remove overrides for

Fields
Input Field Description
ids - [ID!]! Pick list product modifier values ids to remove overrides for
Example
{"ids": [4]}

RemoveProductBasicInformationOverridesInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! The channel and locale that apply when you remove overrides from a channel locale.
overridesToRemove - [ProductBasicInformationField!] A set of fields for basic product information with overrides you want to remove. An empty value means you will remove all overrides.
productId - ID! The product that has overrides you want to remove.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "overridesToRemove": ["PRODUCT_DESCRIPTION_FIELD"],
  "productId": 4
}

RemoveProductBasicInformationOverridesResult

Description

Result of a mutation that removes overrides for product basic information from a channel locale.

Fields
Field Name Description
product - Product The product that had its overrides removed.
Example
{"product": Product}

RemoveProductIsFeaturedOverrideInput

Fields
Input Field Description
channelId - ID! Channel context.
productId - ID! The product which information should be modified.
Example
{
  "channelId": "4",
  "productId": "4"
}

RemoveProductIsFeaturedOverrideResult

Description

Result of a mutation that removes overrides for whether a product is featured in a channel locale.

Fields
Field Name Description
product - Product The product that had its override removed.
Example
{"product": Product}

RemoveProductModifierOverridesDataInput

Description

Input that removes overrides for product modifiers from a channel locale.

Fields
Input Field Description
modifiers - [RemoveProductModifierOverridesInput!]! Modifier overrides that you want to remove.
Example
{"modifiers": [RemoveProductModifierOverridesInput]}

RemoveProductModifierOverridesInput

Description

Input that has the product modifier overrides you want to remove.

Fields
Input Field Description
modifierId - ID! Product modifier ID.
data - RemoveProductModifierOverridesUnionDataInput! Product modifier override.
Example
{
  "modifierId": "4",
  "data": RemoveProductModifierOverridesUnionDataInput
}

RemoveProductModifierOverridesUnionDataInput

Description

Input that has product modifier overrides data. You can only use one type of modifier in a request.

Fields
Input Field Description
checkbox - RemoveCheckboxProductModifierOverridesInput Overrides for checkbox product modifiers.
dateField - RemoveDateFieldProductModifierOverridesInput Overrides for date field product modifiers.
dropdown - RemoveDropdownProductModifierOverridesInput Overrides for dropdown product modifiers.
fileUpload - RemoveFileUploadProductModifierOverridesInput Overrides for file upload product modifiers.
multiLineTextField - RemoveMultiLineTextFieldProductModifierOverridesInput Overrides for multiline text field product modifiers.
numberField - RemoveNumberFieldProductModifierOverridesInput Overrides for number field product modifiers.
pickList - RemovePickListProductModifierOverridesInput Overrides for pick list product modifiers.
radioButtons - RemoveRadioButtonsProductModifierOverridesInput Overrides for radio buttons product modifiers.
rectangleList - RemoveRectangleListProductModifierOverridesInput Overrides for rectangle list product modifiers.
swatch - RemoveSwatchProductModifierOverridesInput Overrides for swatch product modifiers.
textField - RemoveTextFieldProductModifierOverridesInput Overrides for text field product modifiers.
Example
{
  "checkbox": RemoveCheckboxProductModifierOverridesInput,
  "dateField": RemoveDateFieldProductModifierOverridesInput,
  "dropdown": RemoveDropdownProductModifierOverridesInput,
  "fileUpload": RemoveFileUploadProductModifierOverridesInput,
  "multiLineTextField": RemoveMultiLineTextFieldProductModifierOverridesInput,
  "numberField": RemoveNumberFieldProductModifierOverridesInput,
  "pickList": RemovePickListProductModifierOverridesInput,
  "radioButtons": RemoveRadioButtonsProductModifierOverridesInput,
  "rectangleList": RemoveRectangleListProductModifierOverridesInput,
  "swatch": RemoveSwatchProductModifierOverridesInput,
  "textField": RemoveTextFieldProductModifierOverridesInput
}

RemoveProductModifiersOverridesInput

Description

Input that removes overrides for product modifiers from a channel locale.

Fields
Input Field Description
productId - ID! ID for the product that has overrides you want to remove.
localeContext - ProductOverridesLocaleContextInput! The channel and locale that apply when you remove overrides from a channel locale.
data - RemoveProductModifierOverridesDataInput! Product modifier overrides you want to remove.
Example
{
  "productId": 4,
  "localeContext": ProductOverridesLocaleContextInput,
  "data": RemoveProductModifierOverridesDataInput
}

RemoveProductModifiersOverridesResult

Description

Result of a mutation that removes overrides for a product modifier from a channel locale.

Fields
Field Name Description
product - Product The product that had its overrides removed.
Example
{"product": Product}

RemoveProductOptionOverridesDataInput

Description

Input that removes overrides for product options from a channel locale.

Fields
Input Field Description
optionId - ID! ID for the option that has overrides you want to remove.
data - RemoveProductOptionOverridesUnionDataInput! Product option overrides you want to remove.
Example
{
  "optionId": 4,
  "data": RemoveProductOptionOverridesUnionDataInput
}

RemoveProductOptionOverridesUnionDataInput

Description

Input that removes overrides for product options from a channel locale.

Fields
Input Field Description
dropdown - RemoveDropdownProductOptionOverridesInput Dropdown product option that has overrides you want to remove.
radioButtons - RemoveRadioButtonsProductOptionOverridesInput Radio button product option that has overrides you want to remove.
rectangleList - RemoveRectangleListProductOptionOverridesInput Rectangle list product option that has overrides you want to remove.
swatch - RemoveSwatchProductOptionOverridesInput Swatch product option that has overrides you want to remove.
Example
{
  "dropdown": RemoveDropdownProductOptionOverridesInput,
  "radioButtons": RemoveRadioButtonsProductOptionOverridesInput,
  "rectangleList": RemoveRectangleListProductOptionOverridesInput,
  "swatch": RemoveSwatchProductOptionOverridesInput
}

RemoveProductOptionsOverridesDataInput

Description

Input that removes overrides for product options from a channel locale.

Fields
Input Field Description
options - [RemoveProductOptionOverridesDataInput!]! Product option overrides that you want to remove.
Example
{"options": [RemoveProductOptionOverridesDataInput]}

RemoveProductOptionsOverridesInput

Fields
Input Field Description
data - RemoveProductOptionsOverridesDataInput! Product options overrides you want to remove.
localeContext - ProductOverridesLocaleContextInput! The channel and locale that apply when you remove overrides from a channel locale.
productId - ID! The ID of the product that has overrides you want to remove.
Example
{
  "data": RemoveProductOptionsOverridesDataInput,
  "localeContext": ProductOverridesLocaleContextInput,
  "productId": 4
}

RemoveProductOptionsOverridesResult

Description

Result of a mutation that removes overrides for a product option from a channel locale.

Fields
Field Name Description
product - Product The product that had its overrides removed.
Example
{"product": Product}

RemoveProductPreOrderSettingsOverridesInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! The channel and locale that apply when you remove overrides from a channel locale.
overridesToRemove - [ProductPreOrderSettingsField!] Set of fields for product pre-order settings that have overrides you want to remove. Empty value means you will remove all overrides.
productId - ID! The ID of the product that has overrides you want to remove.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "overridesToRemove": ["PRODUCT_PRE_ORDER_MESSAGE"],
  "productId": "4"
}

RemoveProductPreOrderSettingsOverridesResult

Description

Result of a mutation that removes overrides for product pre-order settings from a channel locale.

Fields
Field Name Description
product - Product The product that had its overrides removed.
Example
{"product": Product}

RemoveProductSeoInformationOverridesInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! The channel and locale that apply when you remove overrides from a channel locale.
overridesToRemove - [ProductSeoInformationField!] Set of fields for product SEO information that have overrides you want to remove. Empty value means you will remove all overrides.
productId - ID! The product which information should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "overridesToRemove": ["PRODUCT_META_DESCRIPTION_FIELD"],
  "productId": 4
}

RemoveProductSeoInformationOverridesResult

Description

Result of a mutation that removes overrides for product SEO information from a channel locale.

Fields
Field Name Description
product - Product The product which seo information overrides was removed as a result of mutation.
Example
{"product": Product}

RemoveProductStorefrontDetailsOverridesInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! The channel and locale that apply when you remove overrides from a channel locale.
overridesToRemove - [ProductStorefrontDetailsField!] Set of fields for product storefront details that has overrides you want to remove. Empty value means you will remove all overrides.
productId - ID! The product which information should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "overridesToRemove": ["PRODUCT_AVAILABILITY_DESCRIPTION_FIELD"],
  "productId": 4
}

RemoveProductStorefrontDetailsOverridesResult

Description

Result of a mutation that removes overrides for product storefront details from a channel locale.

Fields
Field Name Description
product - Product The product that had its overrides removed.
Example
{"product": Product}

RemoveProductUrlPathOverrideInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! The channel and locale that apply when you remove overrides from a channel locale.
productId - ID! ID for the product that has a URL path override you want to remove.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "productId": 4
}

RemoveProductUrlPathOverrideResult

Description

Result of a mutation that removes overrides for a product url path from a channel locale.

Fields
Field Name Description
product - Product The product that had its overrides removed.
Example
{"product": Product}

RemoveRadioButtonsProductModifierOverridesField

Description

Radio buttons product modifier overrides field name

Values
Enum Value Description

RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveRadioButtonsProductModifierOverridesInput

Description

Input that removes overrides for the radio button product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveRadioButtonsProductModifierOverridesField!] Fields for the modifier that have overrides you want to remove.
values - RemoveRadioButtonsProductModifierValueOverridesInput Values for the modifier that have overrides you want to remove.
Example
{
  "fields": ["RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveRadioButtonsProductModifierValueOverridesInput
}

RemoveRadioButtonsProductModifierValueOverridesInput

Description

Input that removes overrides for values of the radio button product modifier from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the values that have overrides you want to remove.
Example
{"ids": [4]}

RemoveRadioButtonsProductOptionOverridesField

Description

Radio buttons product option overrides field names

Values
Enum Value Description

RADIO_BUTTONS_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"RADIO_BUTTONS_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveRadioButtonsProductOptionOverridesInput

Description

Input that removes overrides for the radio buttons product option from a channel locale.

Fields
Input Field Description
fields - [RemoveRadioButtonsProductOptionOverridesField!] Fields for the option that have overrides you want to remove.
values - RemoveRadioButtonsProductOptionValuesOverridesInput Values for the option that have overrides you want to remove.
Example
{
  "fields": ["RADIO_BUTTONS_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveRadioButtonsProductOptionValuesOverridesInput
}

RemoveRadioButtonsProductOptionValuesOverridesInput

Description

Input that removes overrides for values of the radio button product option from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the option values that have overrides you want to remove.
Example
{"ids": ["4"]}

RemoveRadioButtonsSharedProductOptionOverridesField

Description

Radio buttons shared product option overrides field names

Values
Enum Value Description

RADIO_BUTTONS_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"RADIO_BUTTONS_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveRadioButtonsSharedProductOptionOverridesInput

Description

Input that removes overrides for the radio button shared product option from a channel locale.

Fields
Input Field Description
fields - [RemoveRadioButtonsSharedProductOptionOverridesField!] Fields for the option that have overrides you want to remove.
values - RemoveRadioButtonsSharedProductOptionValuesOverridesInput Values for the option that have overrides you want to remove.
Example
{
  "fields": ["RADIO_BUTTONS_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveRadioButtonsSharedProductOptionValuesOverridesInput
}

RemoveRadioButtonsSharedProductOptionValuesOverridesInput

Description

Input that removes overrides for values of the radio buttons shared product option from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the option values that have overrides you want to remove.
Example
{"ids": ["4"]}

RemoveRectangleListProductModifierOverridesField

Description

Rectangle list product modifier overrides field name

Values
Enum Value Description

RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveRectangleListProductModifierOverridesInput

Description

Input that removes overrides for the rectangle list product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveRectangleListProductModifierOverridesField!] Fields for the modifier that have overrides you want to remove.
values - RemoveRectangleListProductModifierValueOverridesInput Values for the option that have overrides you want to remove.
Example
{
  "fields": ["RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveRectangleListProductModifierValueOverridesInput
}

RemoveRectangleListProductModifierValueOverridesInput

Description

Input that removes overrides for values of the rectangle list product modifier from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the modifier values that have overrides you want to remove.
Example
{"ids": [4]}

RemoveRectangleListProductOptionOverridesField

Description

Rectangle list product option overrides field names

Values
Enum Value Description

RECTANGLE_LIST_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"RECTANGLE_LIST_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveRectangleListProductOptionOverridesInput

Description

Input that removes overrides for the rectangle list product option from a channel locale.

Fields
Input Field Description
fields - [RemoveRectangleListProductOptionOverridesField!] Fields for the modifier that have overrides you want to remove.
values - RemoveRectangleListProductOptionValuesOverridesInput Values for the option that have overrides you want to remove.
Example
{
  "fields": ["RECTANGLE_LIST_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveRectangleListProductOptionValuesOverridesInput
}

RemoveRectangleListProductOptionValuesOverridesInput

Description

Input that removes overrides for values of the rectangle list product option from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the option values that have overrides you want to remove.
Example
{"ids": ["4"]}

RemoveRectangleListSharedProductOptionOverridesField

Description

Rectangle list shared product option overrides field names

Values
Enum Value Description

RECTANGLE_LIST_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"RECTANGLE_LIST_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveRectangleListSharedProductOptionOverridesInput

Description

Input that removes overrides for the rectangle list shared product option from a channel locale.

Fields
Input Field Description
fields - [RemoveRectangleListSharedProductOptionOverridesField!] Fields for the shared option that have overrides you want to remove.
values - RemoveRectangleListSharedProductOptionValuesOverridesInput Values for the shared option that have overrides you want to remove.
Example
{
  "fields": ["RECTANGLE_LIST_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveRectangleListSharedProductOptionValuesOverridesInput
}

RemoveRectangleListSharedProductOptionValuesOverridesInput

Description

Input that removes overrides for values of the rectangle list shared product option from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the shared option values that have overrides you want to remove.
Example
{"ids": [4]}

RemoveSharedCheckboxProductModifierOverridesField

Description

Shared checkbox product modifier overrides field name

Values
Enum Value Description

SHARED_CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.

SHARED_CHECKBOX_PRODUCT_MODIFIER_VALUE_FIELD

The value field.
Example
"SHARED_CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedCheckboxProductModifierOverridesInput

Description

Input that removes overrides for the checkbox shared product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveSharedCheckboxProductModifierOverridesField!] Fields for the shared modifier that have overrides you want to remove.
Example
{"fields": ["SHARED_CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveSharedDateFieldProductModifierOverridesField

Description

Shared date field product modifier overrides field name

Values
Enum Value Description

SHARED_DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedDateFieldProductModifierOverridesInput

Description

Input that removes overrides for the date field shared product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveSharedDateFieldProductModifierOverridesField!] Fields for the shared modifier that have overrides you want to remove.
Example
{"fields": ["SHARED_DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveSharedDropdownProductModifierOverridesField

Description

Shared dropdown product modifier overrides field name

Values
Enum Value Description

SHARED_DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedDropdownProductModifierOverridesInput

Description

Input that removes overrides for the dropdown shared product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveSharedDropdownProductModifierOverridesField!] Fields for the shared modifier that have overrides you want to remove.
values - RemoveSharedDropdownProductModifierValuesOverridesInput Values for the shared modifier that have overrides you want to remove.
Example
{
  "fields": ["SHARED_DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveSharedDropdownProductModifierValuesOverridesInput
}

RemoveSharedDropdownProductModifierValuesOverridesInput

Description

Input that removes overrides for values of the dropdown shared product modifier from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the shared modifier values that have overrides you want to remove.
Example
{"ids": ["4"]}

RemoveSharedFileUploadProductModifierOverridesField

Description

Shared file upload product modifier overrides field name

Values
Enum Value Description

SHARED_FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedFileUploadProductModifierOverridesInput

Description

Input that removes overrides for the file upload shared product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveSharedFileUploadProductModifierOverridesField!] Fields for the shared modifier that have overrides you want to remove.
Example
{"fields": ["SHARED_FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveSharedMultiLineTextFieldProductModifierOverridesField

Description

Shared multiLine text field product modifier overrides field name

Values
Enum Value Description

SHARED_MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field default value.

SHARED_MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveSharedMultiLineTextFieldProductModifierOverridesInput

Description

Input that removes overrides for the multiline shared product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveSharedMultiLineTextFieldProductModifierOverridesField!] Fields for the shared modifier that have overrides you want to remove.
Example
{"fields": ["SHARED_MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

RemoveSharedNumberFieldProductModifierOverridesField

Description

Shared number field product modifier overrides field name

Values
Enum Value Description

SHARED_NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field value.

SHARED_NUMBER_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveSharedNumberFieldProductModifierOverridesInput

Description

Input that removes overrides for the numbers-only text field shared product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveSharedNumberFieldProductModifierOverridesField!] Fields for the shared modifier that have overrides you want to remove.
Example
{"fields": ["SHARED_NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

RemoveSharedProductModifierOverridesDataInput

Description

Input that removes overrides for shared product modifiers from a channel locale.

Fields
Input Field Description
modifiers - [RemoveSharedProductModifierOverridesInput!]! Shared modifiers that have overrides you want to remove.
Example
{"modifiers": [RemoveSharedProductModifierOverridesInput]}

RemoveSharedProductModifierOverridesInput

Description

Input that removes overrides for the shared product modifier from a channel locale.

Fields
Input Field Description
modifierId - ID! ID of the shared modifiers that have overrides you want to remove.
data - RemoveSharedProductModifierOverridesUnionDataInput! Product modifier overrides that you want to remove.
Example
{
  "modifierId": "4",
  "data": RemoveSharedProductModifierOverridesUnionDataInput
}

RemoveSharedProductModifierOverridesUnionDataInput

Description

Input that has the shared product modifier overrides you want to remove. You can only use one type of shared modifier in a request.

Fields
Input Field Description
checkbox - RemoveSharedCheckboxProductModifierOverridesInput Overrides for checkbox shared modifiers.
dateField - RemoveSharedDateFieldProductModifierOverridesInput Overrides for datefield shared modifiers.
dropdown - RemoveSharedDropdownProductModifierOverridesInput Overrides for dropdown shared modifiers.
fileUpload - RemoveSharedFileUploadProductModifierOverridesInput Overrides for file upload shared modifiers.
multiLineTextField - RemoveSharedMultiLineTextFieldProductModifierOverridesInput Overrides for multiline text field shared modifiers.
numberField - RemoveSharedNumberFieldProductModifierOverridesInput Overrides for number field shared modifiers.
radioButtons - RemoveSharedRadioButtonsProductModifierOverridesInput Overrides for radio button shared modifiers.
rectangleList - RemoveSharedRectangleListProductModifierOverridesInput Overrides for rectangle list shared modifiers.
swatch - RemoveSharedSwatchProductModifierOverridesInput Overrides for swatch shared modifiers.
textField - RemoveSharedTextFieldProductModifierOverridesInput Overrides for text field shared modifiers.
Example
{
  "checkbox": RemoveSharedCheckboxProductModifierOverridesInput,
  "dateField": RemoveSharedDateFieldProductModifierOverridesInput,
  "dropdown": RemoveSharedDropdownProductModifierOverridesInput,
  "fileUpload": RemoveSharedFileUploadProductModifierOverridesInput,
  "multiLineTextField": RemoveSharedMultiLineTextFieldProductModifierOverridesInput,
  "numberField": RemoveSharedNumberFieldProductModifierOverridesInput,
  "radioButtons": RemoveSharedRadioButtonsProductModifierOverridesInput,
  "rectangleList": RemoveSharedRectangleListProductModifierOverridesInput,
  "swatch": RemoveSharedSwatchProductModifierOverridesInput,
  "textField": RemoveSharedTextFieldProductModifierOverridesInput
}

RemoveSharedProductModifiersOverridesInput

Description

Input that removes overrides for the shared product modifier from a channel locale.

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! The channel and locale that apply when you remove overrides from a channel locale.
data - RemoveSharedProductModifierOverridesDataInput! Shared modifier override.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": RemoveSharedProductModifierOverridesDataInput
}

RemoveSharedProductModifiersOverridesResult

Description

Result of a mutation that removes overrides for shared product modifiers from a channel locale.

Fields
Field Name Description
sharedProductModifiers - [SharedProductModifier!] List of shared product modifiers.
Example
{"sharedProductModifiers": [SharedProductModifier]}

RemoveSharedProductOptionOverridesDataInput

Description

Input that removes overrides for shared options from a channel locale.

Fields
Input Field Description
optionId - ID! ID of the shared option that has overrides you want to remove.
data - RemoveSharedProductOptionOverridesUnionDataInput! Shared option overrides that you want to remove.
Example
{
  "optionId": 4,
  "data": RemoveSharedProductOptionOverridesUnionDataInput
}

RemoveSharedProductOptionOverridesUnionDataInput

Description

Input that has the shared product option overrides you want to remove. You can only use one type of modifier in a request.

Fields
Input Field Description
dropdown - RemoveDropdownSharedProductOptionOverridesInput Overrides for dropdown shared options.
radioButtons - RemoveRadioButtonsSharedProductOptionOverridesInput Overrides for radio button shared options.
rectangleList - RemoveRectangleListSharedProductOptionOverridesInput Overrides for rectangle list shared options.
swatch - RemoveSwatchSharedProductOptionOverridesInput Overrides for swatch shared options.
Example
{
  "dropdown": RemoveDropdownSharedProductOptionOverridesInput,
  "radioButtons": RemoveRadioButtonsSharedProductOptionOverridesInput,
  "rectangleList": RemoveRectangleListSharedProductOptionOverridesInput,
  "swatch": RemoveSwatchSharedProductOptionOverridesInput
}

RemoveSharedProductOptionsOverridesDataInput

Description

Input that removes overrides for shared product options from a channel locale.

Fields
Input Field Description
options - [RemoveSharedProductOptionOverridesDataInput!]! Shared options that have overrides you want to remove.
Example
{"options": [RemoveSharedProductOptionOverridesDataInput]}

RemoveSharedProductOptionsOverridesInput

Fields
Input Field Description
data - RemoveSharedProductOptionsOverridesDataInput! Shared option override that you want to remove.
localeContext - ProductOverridesLocaleContextInput! The channel and locale that apply when you remove overrides from a channel locale.
Example
{
  "data": RemoveSharedProductOptionsOverridesDataInput,
  "localeContext": ProductOverridesLocaleContextInput
}

RemoveSharedProductOptionsOverridesResult

Description

Result of a mutation that removes overrides for shared product options from a channel locale.

Fields
Field Name Description
sharedProductOptions - [SharedProductOption!] List of shared product options.
Example
{"sharedProductOptions": [SharedProductOption]}

RemoveSharedRadioButtonsProductModifierOverridesField

Description

Shared radio buttons product modifier overrides field name

Values
Enum Value Description

SHARED_RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedRadioButtonsProductModifierOverridesInput

Description

Input that removes overrides for the radio button shared modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveSharedRadioButtonsProductModifierOverridesField!] Fields for the shared modifier that have overrides you want to remove.
values - RemoveSharedRadioButtonsProductModifierValuesOverridesInput Values of the shared modifier that have overrides you want to remove.
Example
{
  "fields": ["SHARED_RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveSharedRadioButtonsProductModifierValuesOverridesInput
}

RemoveSharedRadioButtonsProductModifierValuesOverridesInput

Description

Input that removes overrides for values of the radio button shared modifier from a channel locale.

Fields
Input Field Description
ids - [ID!]! Values of the shared modifier that have overrides you want to remove.
Example
{"ids": [4]}

RemoveSharedRectangleListProductModifierOverridesField

Description

Shared rectangle list product modifier overrides field name

Values
Enum Value Description

SHARED_RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedRectangleListProductModifierOverridesInput

Description

Input that removes overrides for rectangle list shared modifiers from a channel locale.

Fields
Input Field Description
fields - [RemoveSharedRectangleListProductModifierOverridesField!] Fields for the shared modifier that have overrides you want to remove.
values - RemoveSharedRectangleListProductModifierValuesOverridesInput Values of the shared modifier that have overrides you want to remove.
Example
{
  "fields": ["SHARED_RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveSharedRectangleListProductModifierValuesOverridesInput
}

RemoveSharedRectangleListProductModifierValuesOverridesInput

Description

Input that removes overrides for values of the rectangle list shared modifiers from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the shared modifier values that have overrides you want to remove.
Example
{"ids": [4]}

RemoveSharedSwatchProductModifierOverridesField

Description

Shared swatch product modifier overrides field name

Values
Enum Value Description

SHARED_SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedSwatchProductModifierOverridesInput

Description

Input that removes overrides for swatch shared modifiers from a channel locale.

Fields
Input Field Description
fields - [RemoveSharedSwatchProductModifierOverridesField!] Fields for the shared modifier that have overrides you want to remove.
values - RemoveSharedSwatchProductModifierValuesOverridesInput Values of the shared modifier that have overrides you want to remove.
Example
{
  "fields": ["SHARED_SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveSharedSwatchProductModifierValuesOverridesInput
}

RemoveSharedSwatchProductModifierValuesOverridesInput

Description

Input that removes overrides for values of the swatch shared modifier from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the shared modifier values that have overrides you want to remove.
Example
{"ids": ["4"]}

RemoveSharedTextFieldProductModifierOverridesField

Description

Shared text field product modifier overrides field name

Values
Enum Value Description

SHARED_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field default value.

SHARED_TEXT_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveSharedTextFieldProductModifierOverridesInput

Description

Input that removes overrides for text field shared modifiers from a channel locale.

Fields
Input Field Description
fields - [RemoveSharedTextFieldProductModifierOverridesField!] Fields for the shared modifier that have overrides you want to remove.
Example
{"fields": ["SHARED_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

RemoveSwatchProductModifierOverridesField

Description

Swatch product modifier overrides field name

Values
Enum Value Description

SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSwatchProductModifierOverridesInput

Description

Input that removes overrides for swatch product modifiers from a channel locale.

Fields
Input Field Description
fields - [RemoveSwatchProductModifierOverridesField!] Fields for the modifier that have overrides you want to remove.
values - RemoveSwatchProductModifierValuesOverridesInput Values of the modifier that have overrides you want to remove.
Example
{
  "fields": ["SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveSwatchProductModifierValuesOverridesInput
}

RemoveSwatchProductModifierValuesOverridesInput

Description

Input that removes overrides for values of the swatch product modifier from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the modifier values that have overrides you want to remove.
Example
{"ids": ["4"]}

RemoveSwatchProductOptionOverridesField

Description

Swatch product option overrides field names

Values
Enum Value Description

SWATCH_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"SWATCH_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveSwatchProductOptionOverridesInput

Description

Input that removes overrides for swatch product options from a channel locale.

Fields
Input Field Description
fields - [RemoveSwatchProductOptionOverridesField!] Fields for the product option that have overrides you want to remove.
values - RemoveSwatchProductOptionValuesOverridesInput Values for the product option that have overrides you want to remove.
Example
{
  "fields": ["SWATCH_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveSwatchProductOptionValuesOverridesInput
}

RemoveSwatchProductOptionValuesOverridesInput

Description

Input that removes overrides for values of the swatch product option from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the option values that have overrides you want to remove.
Example
{"ids": ["4"]}

RemoveSwatchSharedProductOptionOverridesField

Description

Swatch shared product option overrides field names

Values
Enum Value Description

SWATCH_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"SWATCH_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveSwatchSharedProductOptionOverridesInput

Description

Input that removes overrides for swatch shared product options from a channel locale.

Fields
Input Field Description
fields - [RemoveSwatchSharedProductOptionOverridesField!] Fields for the shared option that have overrides you want to remove.
values - RemoveSwatchSharedProductOptionValuesOverridesInput Values for the shared option that have overrides you want to remove.
Example
{
  "fields": ["SWATCH_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveSwatchSharedProductOptionValuesOverridesInput
}

RemoveSwatchSharedProductOptionValuesOverridesInput

Description

Input that removes overrides for values of the swatch shared product option from a channel locale.

Fields
Input Field Description
ids - [ID!]! IDs of the shared option values that have overrides you want to remove.
Example
{"ids": ["4"]}

RemoveTextFieldProductModifierOverridesField

Description

Text field product modifier overrides field name

Values
Enum Value Description

TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field default value.

TEXT_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveTextFieldProductModifierOverridesInput

Description

Input that removes overrides for text field product modifier from a channel locale.

Fields
Input Field Description
fields - [RemoveTextFieldProductModifierOverridesField!] Fields for the modifier that have overrides you want to remove.
Example
{"fields": ["TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

ScopeChangeNotAllowedError

Description

Error indicating that the scope change is not allowed for this webhook.

Fields
Field Name Description
message - String! Information about error.
Example
{"message": "xyz789"}

ScopeConnection

Description

A connection to a list of items.

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

ScopeEdge

Description

An edge in a connection.

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

SetCheckboxProductModifierInformationInput

Description

Input that sets checkbox product modifier information.

Fields
Input Field Description
displayName - String Display name for the checkbox product modifier.
value - String Field value for the checkbox product modifier.
Example
{
  "displayName": "abc123",
  "value": "xyz789"
}

SetDateFieldProductModifierInformationInput

Description

Input that sets date field product modifier information.

Fields
Input Field Description
displayName - String Display name for the date field product modifier.
Example
{"displayName": "xyz789"}

SetDropdownProductModifierInformationInput

Description

Input that sets dropdown product modifier information.

Fields
Input Field Description
displayName - String Display name for the dropdown product modifier.
values - [SetDropdownProductModifierValueInformationInput!] Dropdown modifier values information
Example
{
  "displayName": "xyz789",
  "values": [
    SetDropdownProductModifierValueInformationInput
  ]
}

SetDropdownProductModifierValueInformationInput

Description

Input that sets information for dropdown product modifier values.

Fields
Input Field Description
valueId - ID! ID of the value for the dropdown product modifier that you want to modify.
label - String! Label for the dropdown product modifier value.
Example
{"valueId": 4, "label": "abc123"}

SetDropdownProductOptionInformationInput

Description

Input that sets information for dropdown product options.

Fields
Input Field Description
displayName - String Display name for the dropdown product option.
values - [SetDropdownProductOptionValueInformationInput!] Dropdown product option values.
Example
{
  "displayName": "abc123",
  "values": [
    SetDropdownProductOptionValueInformationInput
  ]
}

SetDropdownProductOptionValueInformationInput

Description

Input that sets values for the dropdown product option.

Fields
Input Field Description
valueId - ID! ID of the value for the dropdown product option that you want to modify.
label - String! Label for the dropdown product option value.
Example
{"valueId": 4, "label": "abc123"}

SetFileUploadProductModifierInformationInput

Description

Input that sets information for the file upload product modifier.

Fields
Input Field Description
displayName - String Display name for the file upload product modifier.
Example
{"displayName": "xyz789"}

SetMultiLineTextFieldProductModifierInformationInput

Description

Input that sets information for the multiline text product modifier.

Fields
Input Field Description
displayName - String Display name for the product modifier.
defaultValue - String Default value for the product modifier.
Example
{
  "displayName": "xyz789",
  "defaultValue": "abc123"
}

SetNumberFieldProductModifierInformationInput

Description

Input that sets information for the numbers-only text field product modifier.

Fields
Input Field Description
defaultValue - Float Default value for the product modifier.
displayName - String Display name for the product modifier.
Example
{
  "defaultValue": 987.65,
  "displayName": "xyz789"
}

SetPickListProductModifierInformationInput

Description

Input that sets information for the pick list product modifier.

Fields
Input Field Description
displayName - String Display name for the product modifier.
values - [SetPickListProductModifierValueInformationInput!] Pick list modifier values.
Example
{
  "displayName": "xyz789",
  "values": [
    SetPickListProductModifierValueInformationInput
  ]
}

SetPickListProductModifierValueInformationInput

Description

Input that sets information for the pick list product modifier.

Fields
Input Field Description
valueId - ID! ID of the value for the product modifier that you want to modify.
label - String! Label for the product modifier value.
Example
{"valueId": 4, "label": "xyz789"}

SetProductBasicInformationDataInput

Fields
Input Field Description
description - String Input that sets information for the description of the product.
name - String Name of the product.
Example
{
  "description": "abc123",
  "name": "abc123"
}

SetProductBasicInformationInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput The channel and locale that apply when you set overrides for a channel locale.
data - SetProductBasicInformationDataInput!
productId - ID! ID of the product that has basic product information you want to set.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductBasicInformationDataInput,
  "productId": 4
}

SetProductBasicInformationResult

Description

Result of a mutation that sets product basic information.

Fields
Field Name Description
product - Product The product that had its overrides updated.
Example
{"product": Product}

SetProductIsFeaturedDataInput

Fields
Input Field Description
isFeatured - Boolean! Product isFeatured flag.
Example
{"isFeatured": false}

SetProductIsFeaturedInput

Fields
Input Field Description
channelId - ID ID of the channel where you want to set whether a product is marked as featured.
data - SetProductIsFeaturedDataInput!
productId - ID! ID of the product that has information you want to set.
Example
{
  "channelId": 4,
  "data": SetProductIsFeaturedDataInput,
  "productId": 4
}

SetProductIsFeaturedResult

Description

Result of a mutation that sets whether a product is marked as featured on the storefront.

Fields
Field Name Description
product - Product The product that had its isFeatured flag updated.
Example
{"product": Product}

SetProductModifierInformationDataInput

Description

Product modifiers information data

Fields
Input Field Description
modifiers - [SetProductModifierInformationInput!]! Product modifiers information data
Example
{"modifiers": [SetProductModifierInformationInput]}

SetProductModifierInformationInput

Description

Product modifier information

Fields
Input Field Description
modifierId - ID! The product modifier id which data should be modified.
data - SetProductModifierInformationUnionDataInput! Product modifier information of specific type
Example
{
  "modifierId": "4",
  "data": SetProductModifierInformationUnionDataInput
}

SetProductModifierInformationUnionDataInput

Description

Input that has the product modifier information you want to set. You can only use one type of modifier in a request.

Fields
Input Field Description
checkbox - SetCheckboxProductModifierInformationInput Checkbox product modifier information.
dateField - SetDateFieldProductModifierInformationInput Date field product modifier information.
dropdown - SetDropdownProductModifierInformationInput Dropdown product modifier information.
fileUpload - SetFileUploadProductModifierInformationInput File upload product modifier information.
multiLineTextField - SetMultiLineTextFieldProductModifierInformationInput Multiline text field product modifier information.
numberField - SetNumberFieldProductModifierInformationInput Number field product modifier information.
pickList - SetPickListProductModifierInformationInput Pick list product modifier information.
radioButtons - SetRadioButtonsProductModifierInformationInput Radio buttons product modifier information.
rectangleList - SetRectangleListProductModifierInformationInput Rectangle list product modifier information.
swatch - SetSwatchProductModifierInformationInput Swatch product modifier information.
textField - SetTextFieldProductModifierInformationInput Text field product modifier information.
Example
{
  "checkbox": SetCheckboxProductModifierInformationInput,
  "dateField": SetDateFieldProductModifierInformationInput,
  "dropdown": SetDropdownProductModifierInformationInput,
  "fileUpload": SetFileUploadProductModifierInformationInput,
  "multiLineTextField": SetMultiLineTextFieldProductModifierInformationInput,
  "numberField": SetNumberFieldProductModifierInformationInput,
  "pickList": SetPickListProductModifierInformationInput,
  "radioButtons": SetRadioButtonsProductModifierInformationInput,
  "rectangleList": SetRectangleListProductModifierInformationInput,
  "swatch": SetSwatchProductModifierInformationInput,
  "textField": SetTextFieldProductModifierInformationInput
}

SetProductModifiersInformationInput

Description

Input that has the product modifier information you want to set.

Fields
Input Field Description
productId - ID! ID of the product that has modifier information you want to set.
localeContext - ProductOverridesLocaleContextInput The channel and locale that apply when you set overrides for a channel locale.
data - SetProductModifierInformationDataInput! Product modifiers information.
Example
{
  "productId": 4,
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductModifierInformationDataInput
}

SetProductModifiersInformationResult

Description

Result of a mutation that sets product modifier information.

Fields
Field Name Description
product - Product The product that had its modifiers set.
Example
{"product": Product}

SetProductOptionInformationInput

Description

Input that has the product option information you want to set.

Fields
Input Field Description
optionId - ID! ID of the product option that has information you want to set.
data - SetProductOptionInformationUnionDataInput! Product option information of a specific type.
Example
{
  "optionId": "4",
  "data": SetProductOptionInformationUnionDataInput
}

SetProductOptionInformationUnionDataInput

Description

Input that has the product option information you want to set. You can only use one type of modifier in a request.

Fields
Input Field Description
dropdown - SetDropdownProductOptionInformationInput Dropdown product option information.
radioButtons - SetRadioButtonsProductOptionInformationInput Radio buttons product option information.
rectangleList - SetRectangleListProductOptionInformationInput Rectangle list product option information.
swatch - SetSwatchProductOptionInformationInput Swatch product option information.
Example
{
  "dropdown": SetDropdownProductOptionInformationInput,
  "radioButtons": SetRadioButtonsProductOptionInformationInput,
  "rectangleList": SetRectangleListProductOptionInformationInput,
  "swatch": SetSwatchProductOptionInformationInput
}

SetProductOptionsInformationDataInput

Description

Input that sets information for product options.

Fields
Input Field Description
options - [SetProductOptionInformationInput!]! Product option information that you want to set.
Example
{"options": [SetProductOptionInformationInput]}

SetProductOptionsInformationInput

Description

Input that has the product options information you want to set.

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput The channel and locale that apply when you set overrides for a channel locale.
data - SetProductOptionsInformationDataInput! Product options information.
productId - ID! ID of the product that has product options information you want to set.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductOptionsInformationDataInput,
  "productId": 4
}

SetProductOptionsInformationResult

Description

Result of a mutation that sets product options information.

Fields
Field Name Description
product - Product The product that had its options set.
Example
{"product": Product}

SetProductPreOrderSettingsDataInput

Fields
Input Field Description
message - String Product pre-order message.
Example
{"message": "abc123"}

SetProductPreOrderSettingsInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput The channel and locale that apply when you set overrides for a channel locale.
data - SetProductPreOrderSettingsDataInput! Data for the pre-order settings of a product.
productId - ID! ID of the product that has pre-order settings you want to set.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductPreOrderSettingsDataInput,
  "productId": 4
}

SetProductPreOrderSettingsResult

Description

Result of a mutation that sets product pre-order settings.

Fields
Field Name Description
product - Product The product that had its pre-order settings set.
Example
{"product": Product}

SetProductSeoInformationDataInput

Fields
Input Field Description
metaDescription - String Meta description for the product.
pageTitle - String Page title for the product.
Example
{
  "metaDescription": "abc123",
  "pageTitle": "abc123"
}

SetProductSeoInformationInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput The channel and locale that apply when you set overrides for a channel locale.
data - SetProductSeoInformationDataInput!
productId - ID! ID of the product that has SEO information you want to set.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductSeoInformationDataInput,
  "productId": "4"
}

SetProductSeoInformationResult

Description

Result of a mutation that sets product SEO information.

Fields
Field Name Description
product - Product The product that had its SEO information set.
Example
{"product": Product}

SetProductStorefrontDetailsDataInput

Fields
Input Field Description
availabilityDescription - String Product availability description.
searchKeywords - String Product search keywords.
warranty - String Product warranty.
Example
{
  "availabilityDescription": "xyz789",
  "searchKeywords": "xyz789",
  "warranty": "xyz789"
}

SetProductStorefrontDetailsInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput The channel and locale that apply when you set overrides for a channel locale.
data - SetProductStorefrontDetailsDataInput! Data for the storefront details of a product.
productId - ID! ID of the product that has storefront details you want to set.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductStorefrontDetailsDataInput,
  "productId": 4
}

SetProductStorefrontDetailsResult

Description

Result of a mutation that sets product storefront details.

Fields
Field Name Description
product - Product The product that had its storefront details set.
Example
{"product": Product}

SetProductUrlPathDataInput

Fields
Input Field Description
path - String! Product URL path.
Example
{"path": "xyz789"}

SetProductUrlPathInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput The channel and locale that apply when you set overrides for a channel locale.
data - SetProductUrlPathDataInput! Data for the product URL path.
productId - ID! ID of the product that has the URL path you want to set.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductUrlPathDataInput,
  "productId": "4"
}

SetProductUrlPathResult

Description

Result of a mutation that sets the product URL path.

Fields
Field Name Description
product - Product The product that had its URL path set.
Example
{"product": Product}

SetRadioButtonsProductModifierInformationInput

Description

Input that has information for the radio button product modifier you want to set.

Fields
Input Field Description
displayName - String Display name for the product modifier.
values - [SetRadioButtonsProductModifierValueInformationInput!] Values for the radio buttons modifier that has information you want to set.
Example
{
  "displayName": "xyz789",
  "values": [
    SetRadioButtonsProductModifierValueInformationInput
  ]
}

SetRadioButtonsProductModifierValueInformationInput

Description

Input that has the values for the radio buttons product modifier you want to set.

Fields
Input Field Description
valueId - ID! ID of the value for the product modifier that you want to set.
label - String! Label for the product modifier value that you want to set.
Example
{
  "valueId": "4",
  "label": "abc123"
}

SetRadioButtonsProductOptionInformationInput

Description

Input that has the radio buttons product options you want to set.

Fields
Input Field Description
displayName - String Display name for the product option that you want to set.
values - [SetRadioButtonsProductOptionValueInformationInput!] Values for the product option you want to set.
Example
{
  "displayName": "xyz789",
  "values": [
    SetRadioButtonsProductOptionValueInformationInput
  ]
}

SetRadioButtonsProductOptionValueInformationInput

Description

Input that has the values for the radio buttons product option you want to set.

Fields
Input Field Description
valueId - ID! ID of the value for the product option that you want to set.
label - String! Label for the product option value that you want to set.
Example
{
  "valueId": "4",
  "label": "xyz789"
}

SetRectangleListProductModifierInformationInput

Description

Input that has the rectangle list product modifier you want to set.

Fields
Input Field Description
displayName - String Display name for the product modifier that you want to set.
values - [SetRectangleListProductModifierValueInformationInput!] Values for the product modifier that you want to set.
Example
{
  "displayName": "xyz789",
  "values": [
    SetRectangleListProductModifierValueInformationInput
  ]
}

SetRectangleListProductModifierValueInformationInput

Description

Input that has the values for the rectangle list product modifier you want to set.

Fields
Input Field Description
valueId - ID! ID of the value for the product modifier that you want to set.
label - String! Label for the product modifier value that you want to set.
Example
{
  "valueId": "4",
  "label": "abc123"
}

SetRectangleListProductOptionInformationInput

Description

Input that has the rectangle list product option you want to set.

Fields
Input Field Description
displayName - String Display name for the product option that you want to set.
values - [SetRectangleListProductOptionValueInformationInput!] Values for the product options that you want to set.
Example
{
  "displayName": "abc123",
  "values": [
    SetRectangleListProductOptionValueInformationInput
  ]
}

SetRectangleListProductOptionValueInformationInput

Description

Input that has the rectangle list product option values you want to set.

Fields
Input Field Description
valueId - ID! ID of the value for the product option that you want to set.
label - String! Label for the product option value you want to set.
Example
{
  "valueId": "4",
  "label": "xyz789"
}

SetSharedCheckboxProductModifierInformationInput

Description

Input that has the shared checkbox modifier you want to set.

Fields
Input Field Description
displayName - String Display name for the shared modifier you want to set.
value - String Field value for the shared modifier you want to set.
Example
{
  "displayName": "xyz789",
  "value": "abc123"
}

SetSharedDateFieldProductModifierInformationInput

Description

Input that has the shared date field modifier you want to set.

Fields
Input Field Description
displayName - String Display name for the product modifier you want to set.
Example
{"displayName": "abc123"}

SetSharedDropdownProductModifierInformationInput

Description

Input that has the shared dropdown modifier you want to set.

Fields
Input Field Description
displayName - String Display name for the shared modifier you want to set.
values - [SetSharedDropdownProductModifierValueInformationInput!] Values for the shared modifier you want to set.
Example
{
  "displayName": "abc123",
  "values": [
    SetSharedDropdownProductModifierValueInformationInput
  ]
}

SetSharedDropdownProductModifierValueInformationInput

Description

Input that has the values for the shared dropdown modifier you want to set.

Fields
Input Field Description
valueId - ID! ID of the shared modifier value that you want to set.
label - String! Label for the values of the shared dropdown modifier you want to set.
Example
{"valueId": 4, "label": "xyz789"}

SetSharedDropdownProductOptionInformationInput

Description

Input that has the shared dropdown option you want to set.

Fields
Input Field Description
displayName - String Display name for the shared option you want to set.
values - [SetSharedDropdownProductOptionValueInformationInput!] Values for the shared option you want to set.
Example
{
  "displayName": "abc123",
  "values": [
    SetSharedDropdownProductOptionValueInformationInput
  ]
}

SetSharedDropdownProductOptionValueInformationInput

Description

Input that has the values for the shared dropdown option you want to set.

Fields
Input Field Description
valueId - ID! ID of the shared option value that you want to set.
label - String! Label for the shared option value you want to set.
Example
{
  "valueId": "4",
  "label": "abc123"
}

SetSharedFileUploadProductModifierInformationInput

Description

Input that has the shared file upload modifier you want to set.

Fields
Input Field Description
displayName - String Display name for the shared modifier you want to set.
Example
{"displayName": "xyz789"}

SetSharedMultiLineTextFieldProductModifierInformationInput

Description

Input that has the shared multiline text modifier you want to set.

Fields
Input Field Description
displayName - String Display name for the shared modifier you want to set.
defaultValue - String Default value for the shared modifier you want to set.
Example
{
  "displayName": "xyz789",
  "defaultValue": "abc123"
}

SetSharedNumberFieldProductModifierInformationInput

Description

Input that has the shared number field modifier you want to set.

Fields
Input Field Description
defaultValue - Float Default value for the shared modifier you want to set.
displayName - String Display name for the shared modifier you want to set.
Example
{
  "defaultValue": 123.45,
  "displayName": "abc123"
}

SetSharedProductModifierInformationDataInput

Description

Input that sets information for shared modifiers.

Fields
Input Field Description
modifiers - [SetSharedProductModifierInformationInput!]! Shared modifiers that you want to set.
Example
{"modifiers": [SetSharedProductModifierInformationInput]}

SetSharedProductModifierInformationInput

Description

Input that has the shared modifiers you want to set.

Fields
Input Field Description
modifierId - ID! ID of the shared modifier you want to set.
data - SetSharedProductModifierInformationUnionDataInput! Shared product modifier information of a specific type.
Example
{
  "modifierId": "4",
  "data": SetSharedProductModifierInformationUnionDataInput
}

SetSharedProductModifierInformationUnionDataInput

Description

Input that has the shared modifier information you want to set. You can only use one type of modifier in a request.

Fields
Input Field Description
checkbox - SetSharedCheckboxProductModifierInformationInput Checkbox product modifier information.
dateField - SetSharedDateFieldProductModifierInformationInput Date field product modifier information.
dropdown - SetSharedDropdownProductModifierInformationInput Dropdown product modifier information.
fileUpload - SetSharedFileUploadProductModifierInformationInput File upload product modifier information.
multiLineTextField - SetSharedMultiLineTextFieldProductModifierInformationInput Multiline text field product modifier information.
numberField - SetSharedNumberFieldProductModifierInformationInput Number field product modifier information.
radioButtons - SetSharedRadioButtonsProductModifierInformationInput Radio buttons product modifier information.
rectangleList - SetSharedRectangleListProductModifierInformationInput Rectangle list product modifier information.
swatch - SetSharedSwatchProductModifierInformationInput Swatch product modifier information.
textField - SetSharedTextFieldProductModifierInformationInput Text field product modifier information.
Example
{
  "checkbox": SetSharedCheckboxProductModifierInformationInput,
  "dateField": SetSharedDateFieldProductModifierInformationInput,
  "dropdown": SetSharedDropdownProductModifierInformationInput,
  "fileUpload": SetSharedFileUploadProductModifierInformationInput,
  "multiLineTextField": SetSharedMultiLineTextFieldProductModifierInformationInput,
  "numberField": SetSharedNumberFieldProductModifierInformationInput,
  "radioButtons": SetSharedRadioButtonsProductModifierInformationInput,
  "rectangleList": SetSharedRectangleListProductModifierInformationInput,
  "swatch": SetSharedSwatchProductModifierInformationInput,
  "textField": SetSharedTextFieldProductModifierInformationInput
}

SetSharedProductModifiersInformationInput

Description

Input that has the shared modifiers information you want to set.

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput The channel and locale that apply when you set overrides for a channel locale.
data - SetSharedProductModifierInformationDataInput! Shared product modifiers information.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetSharedProductModifierInformationDataInput
}

SetSharedProductModifiersInformationResult

Description

Result of a mutation that sets information for shared modifiers.

Fields
Field Name Description
sharedProductModifiers - [SharedProductModifier!] List of shared modifiers.
Example
{"sharedProductModifiers": [SharedProductModifier]}

SetSharedProductOptionInformationInput

Description

Input that has the shared options you want to set.

Fields
Input Field Description
optionId - ID! ID of the shared option you want to set.
data - SetSharedProductOptionInformationUnionDataInput! Shared product option information of a specific type.
Example
{
  "optionId": "4",
  "data": SetSharedProductOptionInformationUnionDataInput
}

SetSharedProductOptionInformationUnionDataInput

Description

Input that has the shared option information you want to set. You can only use one type of option in a request.

Fields
Input Field Description
dropdown - SetSharedDropdownProductOptionInformationInput Dropdown product option information.
radioButtons - SetSharedRadioButtonsProductOptionInformationInput Radio buttons product option information.
rectangleList - SetSharedRectangleListProductOptionInformationInput Rectangle list product option information.
swatch - SetSharedSwatchProductOptionInformationInput Swatch product option information.
Example
{
  "dropdown": SetSharedDropdownProductOptionInformationInput,
  "radioButtons": SetSharedRadioButtonsProductOptionInformationInput,
  "rectangleList": SetSharedRectangleListProductOptionInformationInput,
  "swatch": SetSharedSwatchProductOptionInformationInput
}

SetSharedProductOptionsInformationDataInput

Description

Input that sets shared options for a channel locale.

Fields
Input Field Description
options - [SetSharedProductOptionInformationInput!]! List of shared options.
Example
{"options": [SetSharedProductOptionInformationInput]}

SetSharedProductOptionsInformationInput

Description

Shared product options information

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput The channel and locale that apply when you set overrides for a channel locale.
data - SetSharedProductOptionsInformationDataInput! Shared product options information
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetSharedProductOptionsInformationDataInput
}

SetSharedProductOptionsInformationResult

Description

Result of a mutation that sets information for shared product options.

Fields
Field Name Description
sharedProductOptions - [SharedProductOption!] List of shared product options.
Example
{"sharedProductOptions": [SharedProductOption]}

SetSharedRadioButtonsProductModifierInformationInput

Description

Input that has the shared radio button modifier you want to set.

Fields
Input Field Description
displayName - String Display name for the shared modifier you want to set.
values - [SetSharedRadioButtonsProductModifierValueInformationInput!] Shared modifier values you want to set.
Example
{
  "displayName": "abc123",
  "values": [
    SetSharedRadioButtonsProductModifierValueInformationInput
  ]
}

SetSharedRadioButtonsProductModifierValueInformationInput

Description

Input that has the values for the shared radio buttons modifier you want to set.

Fields
Input Field Description
valueId - ID! ID of the shared modifier value that you want to set.
label - String! Label for the shared modifier value you want to set.
Example
{
  "valueId": "4",
  "label": "xyz789"
}

SetSharedRadioButtonsProductOptionInformationInput

Description

Input that has the shared radio buttons option you want to set.

Fields
Input Field Description
displayName - String Display name for the shared option you want to set.
values - [SetSharedRadioButtonsProductOptionValueInformationInput!] Shared option values you want to set.
Example
{
  "displayName": "xyz789",
  "values": [
    SetSharedRadioButtonsProductOptionValueInformationInput
  ]
}

SetSharedRadioButtonsProductOptionValueInformationInput

Description

Input that has the values for the shared radio buttons option you want to set.

Fields
Input Field Description
valueId - ID! ID of the value for the shared option that you want to set.
label - String! Label for the value of the shared option you want to set.
Example
{
  "valueId": "4",
  "label": "abc123"
}

SetSharedRectangleListProductModifierInformationInput

Description

Input that has the shared rectangle list modifier you want to set.

Fields
Input Field Description
displayName - String Display name for the shared modifier you want to set.
values - [SetSharedRectangleListProductModifierValueInformationInput!] Shared modifier values you want to set.
Example
{
  "displayName": "xyz789",
  "values": [
    SetSharedRectangleListProductModifierValueInformationInput
  ]
}

SetSharedRectangleListProductModifierValueInformationInput

Description

Input that has values for the shared rectangle list modifier you want to set.

Fields
Input Field Description
valueId - ID! ID of the value for the shared modifier you want to set.
label - String! Label for the shared modifier value.
Example
{"valueId": 4, "label": "abc123"}

SetSharedRectangleListProductOptionInformationInput

Description

Input that has the shared rectangle list option you want to set.

Fields
Input Field Description
displayName - String Display name for the shared option you want to set.
values - [SetSharedRectangleListProductOptionValueInformationInput!] Shared option values you want to set.
Example
{
  "displayName": "abc123",
  "values": [
    SetSharedRectangleListProductOptionValueInformationInput
  ]
}

SetSharedRectangleListProductOptionValueInformationInput

Description

Input that has the values for the shared rectangle list option you want to set.

Fields
Input Field Description
valueId - ID! ID of the value for the shared rectangle list option that you want to set.
label - String! Label for the rectangle list shared option value you want to set.
Example
{"valueId": 4, "label": "xyz789"}

SetSharedSwatchProductModifierInformationInput

Description

Input that has the shared swatch product modifier you want to set.

Fields
Input Field Description
displayName - String Display name for the shared modifier you want to set.
values - [SetSharedSwatchProductModifierValueInformationInput!] Shared modifier values you want to set.
Example
{
  "displayName": "abc123",
  "values": [
    SetSharedSwatchProductModifierValueInformationInput
  ]
}

SetSharedSwatchProductModifierValueInformationInput

Description

Input that has the values for the shared swatch modifier you want to set.

Fields
Input Field Description
valueId - ID! ID of the shared modifier value you want to set.
label - String! Label for the shared modifier value.
Example
{"valueId": 4, "label": "abc123"}

SetSharedSwatchProductOptionInformationInput

Description

Input that has the shared swatch option you want to set.

Fields
Input Field Description
displayName - String Display name for the shared option you want to set.
values - [SetSharedSwatchProductOptionValueInformationInput!] Values for the shared option you want to set.
Example
{
  "displayName": "abc123",
  "values": [
    SetSharedSwatchProductOptionValueInformationInput
  ]
}

SetSharedSwatchProductOptionValueInformationInput

Description

Input that has the shared swatch product option you want to set.

Fields
Input Field Description
valueId - ID! ID of the shared option value that you want to set.
label - String! Label for the shared option value you want to set.
Example
{"valueId": 4, "label": "abc123"}

SetSharedTextFieldProductModifierInformationInput

Description

Input that has the shared text field modifier you want to set.

Fields
Input Field Description
defaultValue - String Default value for the shared modifier you want to set.
displayName - String Display name for the shared modifier you want to set.
Example
{
  "defaultValue": "xyz789",
  "displayName": "abc123"
}

SetSwatchProductModifierInformationInput

Description

Input that has the swatch product modifier you want to set.

Fields
Input Field Description
displayName - String Display name for the product modifier you want to set.
values - [SetSwatchProductModifierValueInformationInput!] Modifier values you want to set.
Example
{
  "displayName": "abc123",
  "values": [
    SetSwatchProductModifierValueInformationInput
  ]
}

SetSwatchProductModifierValueInformationInput

Description

Input that has the values for the swatch product modifier you want to set.

Fields
Input Field Description
valueId - ID! ID of the product modifier value you want to set.
label - String! Label for the product modifier value you want to set.
Example
{"valueId": 4, "label": "abc123"}

SetSwatchProductOptionInformationInput

Description

Input that has the swatch product option you want to set.

Fields
Input Field Description
displayName - String Display name for the product option you want to set.
values - [SetSwatchProductOptionValueInformationInput!] Product option values you want to set.
Example
{
  "displayName": "abc123",
  "values": [SetSwatchProductOptionValueInformationInput]
}

SetSwatchProductOptionValueInformationInput

Description

Input that has values for the swatch product option you want to set.

Fields
Input Field Description
valueId - ID! ID of the product option value you want to set.
label - String! Label for the product option value you want to set.
Example
{"valueId": 4, "label": "abc123"}

SetTextFieldProductModifierInformationInput

Description

Input that has the text field product modifier you want to set.

Fields
Input Field Description
defaultValue - String Default value for the product modifier you want to set.
displayName - String Display name for the product modifier you want to set.
Example
{
  "defaultValue": "xyz789",
  "displayName": "abc123"
}

SharedProductModifier

Description

Shared modifier.

Fields
Field Name Description
id - ID! ID of the shared modifier.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Indicates whether the shared modifier is required.
Example
{
  "id": "4",
  "displayName": "xyz789",
  "isRequired": true
}

SharedProductModifierConnection

Description

A connection to a list of items.

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

SharedProductModifierEdge

Description

An edge in a connection.

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

SharedProductModifiersFiltersInput

Fields
Input Field Description
ids - [ID!] The unique identifiers of the shared modifiers.