GraphQL Admin API Reference

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

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
  }
}
Response
{
  "data": {
    "store": {
      "account": Account,
      "appExtensions": AppExtensionsConnection,
      "id": "4",
      "metafield": Metafield,
      "metafields": MetafieldsConnection,
      "product": Product,
      "products": ProductConnection,
      "settings": StoreSettings,
      "sharedProductModifiers": SharedProductModifierConnection,
      "sharedProductOptions": SharedProductOptionConnection,
      "storeHash": "abc123",
      "storeReferenceId": "abc123"
    }
  }
}
Queries

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

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

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
    }
    removeProductCustomFieldsOverrides {
      ...RemoveProductCustomFieldsOverridesResultFragment
    }
  }
}
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,
      "removeProductCustomFieldsOverrides": RemoveProductCustomFieldsOverridesResult
    }
  }
}
Mutations

settings

Description

Store settings mutations.

Response

Returns a StoreSettingsMutations

Example

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

sharedProductModifiers

Description

Shared product modifiers mutations.

Response

Returns a SharedProductModifiersMutations!

Example

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

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

Types

Account

Description

An account.

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

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

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"
Types

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": "xyz789",
  "locales": [AppExtensionLabelLocale]
}
Types

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]
}
Types

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"
}
Types

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

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"
Types

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
input - CreateAppExtensionInput!
updateAppExtension - UpdateAppExtensionResult Updates an existing App Extension registered to the store and associates it with the requesting API account.
Arguments
input - UpdateAppExtensionInput!
deleteAppExtension - DeleteAppExtensionResult Deletes an App Extension that belongs to the store and requesting API account.
Arguments
input - DeleteAppExtensionInput!
Example
{
  "createAppExtension": CreateAppExtensionResult,
  "updateAppExtension": UpdateAppExtensionResult,
  "deleteAppExtension": DeleteAppExtensionResult
}
Types

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]
}
Types

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

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

ChannelLocaleContextInput

Description

ChannelLocale context input.

Fields
Input Field Description
channelId - ID! ChannelId of the ChannelLocale input.
locale - String! Locale of the ChannelLocale input.
Example
{
  "channelId": "4",
  "locale": "abc123"
}
Types

CheckboxProductModifier

Description

Checkbox product modifier.

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

The channel and locale that apply when you override or retrieve product modifiers from a channel locale.
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "checkedByDefault": true,
  "fieldValue": "xyz789",
  "overridesForLocale": CheckboxProductModifierForLocale,
  "id": 4,
  "displayName": "xyz789",
  "isRequired": true,
  "isShared": false
}
Types

CheckboxProductModifierForLocale

Description

Override for a checkbox product modifier in a channel locale.

Fields
Field Name Description
displayName - String Display name for the product modifier.
fieldValue - String Value of the product modifier field.
Example
{
  "displayName": "xyz789",
  "fieldValue": "abc123"
}
Types

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

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

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

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"
}
Types

CreateAppExtensionResult

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

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": "xyz789",
  "resourceId": "4",
  "key": "abc123",
  "value": "abc123",
  "description": "xyz789",
  "permissionSet": "APP_ONLY"
}
Types

CreateMetafieldResult

Fields
Field Name Description
metafield - Metafield Metafield that was created as a result of mutation.
Example
{"metafield": Metafield}
Types

DataSolutionsMutations

Description

Data solutions mutations.

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

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

DateFieldProductModifier

Description

Date field product modifier.

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

The channel and locale that apply when you override or retrieve product modifiers from a channel locale.
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "overridesForLocale": DateFieldProductModifierForLocale,
  "id": "4",
  "displayName": "abc123",
  "isRequired": false,
  "isShared": false
}
Types

DateFieldProductModifierForLocale

Description

Override for a date field product modifier in a channel locale.

Fields
Field Name Description
displayName - String Display name for the product modifier in a channel locale.
Example
{"displayName": "xyz789"}
Types

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": false
}
Types

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

DeleteAppExtensionInput

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

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"}
Types

DeleteMetafieldInput

Description

Input for deleteMetafield mutation.

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

DeleteMetafieldResult

Fields
Field Name Description
deletedMetafieldId - ID The id of metafield that is deleted as a result of mutation.
Example
{"deletedMetafieldId": "4"}
Types

DropdownOptionValue

Description

Dropdown product option value

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

DropdownOptionValueForLocale

Description

Override for a dropdown product option value in a channel locale.

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

DropdownProductModifier

Description

Dropdown product modifier.

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

The channel and locale that apply when you override or retrieve product modifiers from a channel locale.
values - [DropdownProductModifierValue!]! Dropdown product modifiers values.
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "overridesForLocale": DropdownProductModifierForLocale,
  "values": [DropdownProductModifierValue],
  "id": "4",
  "displayName": "xyz789",
  "isRequired": true,
  "isShared": false
}
Types

DropdownProductModifierForLocale

Description

Override for a dropdown product modifier in a channel locale.

Fields
Field Name Description
displayName - String Display name for the product modifier in a channel locale.
values - [DropdownProductModifierValueForLocale!]! Modifier values for a dropdown product modifier in a channel locale.
Example
{
  "displayName": "xyz789",
  "values": [DropdownProductModifierValueForLocale]
}
Types

DropdownProductModifierValue

Description

Dropdown product modifier value.

Fields
Field Name Description
id - ID! The ID of the product modifier value.
isDefault - Boolean! Indicates whether the dropdown product modifier value is selected by default.
label - String! Label for the dropdown product modifier value.
Example
{
  "id": "4",
  "isDefault": true,
  "label": "abc123"
}
Types

DropdownProductModifierValueForLocale

Description

Override for a dropdown product modifier value in a channel locale.

Fields
Field Name Description
id - ID! ID of the product modifier value in a channel locale.
label - String! Label for the product modifier value in a channel locale.
Example
{
  "id": "4",
  "label": "abc123"
}
Types

DropdownProductOption

Description

Dropdown product option.

Fields
Field Name Description
displayName - String! Display name for the option.
isShared - Boolean! Indicates whether product option is shared or local.
id - ID! The ID of the object.
overridesForLocale - ProductOptionForLocale Option overrides for a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve product options from a channel locale.
values - [ProductOptionValue!]! List of product option values.
Example
{
  "displayName": "xyz789",
  "isShared": true,
  "id": "4",
  "overridesForLocale": ProductOptionForLocale,
  "values": [ProductOptionValue]
}
Types

DropdownProductOptionForLocale

Description

Override for the dropdown product option in a channel locale.

Fields
Field Name Description
displayName - String Display name for the product option.
values - [ProductOptionValueForLocale!]! List of product option values.
Example
{
  "displayName": "abc123",
  "values": [ProductOptionValueForLocale]
}
Types

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

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"
}
Types

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

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]
}
Types

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

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

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.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared options from a channel locale.
values - [SharedProductOptionValue!]! List of shared option values.
Example
{
  "displayName": "abc123",
  "id": "4",
  "overridesForLocale": SharedProductOptionForLocale,
  "values": [SharedProductOptionValue]
}
Types

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]
}
Types

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"}
Types

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"
}
Types

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

Error

Description

Common interface for all errors.

Fields
Field Name Description
message - String! Information about error.
Possible Types
Error Types

EntityAlreadyExistsError

EntityNotFoundError

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

FileUploadProductModifier

Description

File upload product modifier.

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

The channel and locale that apply when you override or retrieve product information for a channel locale.
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "overridesForLocale": FileUploadProductModifierForLocale,
  "id": "4",
  "displayName": "abc123",
  "isRequired": false,
  "isShared": false
}
Types

FileUploadProductModifierForLocale

Description

Override for a file upload product modifier in a channel locale.

Fields
Field Name Description
displayName - String Display name for the file upload product modifier in a channel locale.
Example
{"displayName": "abc123"}
Types

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

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

Float

Description

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

Example
987.65
Types

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"
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
123
Types

Long

Description

The Long scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1.

Example
{}
Types

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": "xyz789",
  "key": "abc123",
  "namespace": "abc123",
  "permissionSet": "APP_ONLY",
  "resourceId": "4",
  "value": "abc123",
  "ownerClientId": "xyz789"
}
Types

MetafieldMutations

Description

Metafield mutations.

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

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]
}
Types

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

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"
}
Types

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"
Types

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"
Types

MultilineTextFieldProductModifier

Description

Multiline text field product modifier.

Fields
Field Name Description
defaultValue - String Default value for the product modifier.
overridesForLocale - MultilineTextFieldProductModifierForLocale Overrides for the product modifier in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve product modifiers from a channel locale.
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "defaultValue": "xyz789",
  "overridesForLocale": MultilineTextFieldProductModifierForLocale,
  "id": 4,
  "displayName": "xyz789",
  "isRequired": false,
  "isShared": true
}
Types

MultilineTextFieldProductModifierForLocale

Description

Override for a multiline text field product modifier in a channel locale.

Fields
Field Name Description
defaultValue - String Default value for the product modifier in a channel locale.
displayName - String Display name for the product modifier in a channel locale.
Example
{
  "defaultValue": "abc123",
  "displayName": "abc123"
}
Types

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": "xyz789",
  "overridesForLocale": MultilineTextFieldSharedProductModifierForLocale,
  "id": "4",
  "displayName": "abc123",
  "isRequired": true
}
Types

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

NumbersOnlyTextFieldProductModifier

Description

Numbers-only text field product modifier.

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

The channel and locale that apply when you override or retrieve product modifiers from a channel locale.
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "defaultValue": 987.65,
  "overridesForLocale": NumbersOnlyTextFieldProductModifierForLocale,
  "id": 4,
  "displayName": "xyz789",
  "isRequired": false,
  "isShared": true
}
Types

NumbersOnlyTextFieldProductModifierForLocale

Description

Override for a numbers-only text field product modifier in a channel locale.

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

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

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"
}
Types

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

PickListModifierValue

Description

Pick list product modifier value.

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

PickListModifierValueForLocale

Description

Overrides for the pick list product modifier value in a channel locale.

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

PickListProductModifier

Description

Pick list product modifier.

Fields
Field Name Description
overridesForLocale - PickListProductModifierForLocale Overrides for the pick list product modifier in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve product modifiers from a channel locale.
values - [PickListModifierValue!]! Values for the product modifier.
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "overridesForLocale": PickListProductModifierForLocale,
  "values": [PickListModifierValue],
  "id": 4,
  "displayName": "xyz789",
  "isRequired": false,
  "isShared": false
}
Types

PickListProductModifierForLocale

Description

Overrides for the pick list product modifier in a channel locale.

Fields
Field Name Description
displayName - String Display name for the product modifier.
values - [PickListModifierValueForLocale!]! Values for the product modifier.
Example
{
  "displayName": "abc123",
  "values": [PickListModifierValueForLocale]
}
Types

PreOrderSettings

Description

Product pre-order settings.

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

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"}
Types

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.
modifiers - ProductModifierConnection! List of product modifiers.
Arguments
before - String
after - String
first - Int
last - Int
urlPath - ProductUrlPath! Product path.
options - ProductOptionConnection! List of product options.
Arguments
before - String
after - String
first - Int
last - Int
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,
  "modifiers": ProductModifierConnection,
  "urlPath": ProductUrlPath,
  "options": ProductOptionConnection,
  "overridesForLocale": ProductOverridesForLocale,
  "overridesForChannel": ProductOverridesForChannel,
  "seoInformation": ProductSeoInformation,
  "storefrontDetails": StorefrontDetails,
  "preOrderSettings": PreOrderSettings
}
Types

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

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"
Types

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

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]
}
Types

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

ProductModifier

Description

A product modifier.

Fields
Field Name Description
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Possible Types
ProductModifier Types

CheckboxProductModifier

DateFieldProductModifier

DropdownProductModifier

FileUploadProductModifier

MultilineTextFieldProductModifier

NumbersOnlyTextFieldProductModifier

PickListProductModifier

RadioButtonsProductModifier

RectangleListProductModifier

SwatchProductModifier

TextFieldProductModifier
Example
{
  "id": "4",
  "displayName": "xyz789",
  "isRequired": true,
  "isShared": false
}
Types

ProductModifierConnection

Description

A connection to a list of items.

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

ProductModifierEdge

Description

An edge in a connection.

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

ProductMutations

Description

Product mutations.

Fields
Field Name Description
removeProductBasicInformationOverrides - RemoveProductBasicInformationOverridesResult Removes overrides for product basic information from a locale.
Arguments
input - RemoveProductBasicInformationOverridesInput!
removeProductSeoInformationOverrides - RemoveProductSeoInformationOverridesResult Removes overrides for product SEO information from a locale.
Arguments
input - RemoveProductSeoInformationOverridesInput!
removeProductOptionsOverrides - RemoveProductOptionsOverridesResult Removes product option overrides from a locale.
Arguments
input - RemoveProductOptionsOverridesInput!
removeProductStorefrontDetailsOverrides - RemoveProductStorefrontDetailsOverridesResult Removes overrides for product storefront details from a locale.
Arguments
input - RemoveProductStorefrontDetailsOverridesInput!
removeProductPreOrderSettingsOverrides - RemoveProductPreOrderSettingsOverridesResult Removes overrides for product pre-order settings from a locale.
Arguments
input - RemoveProductPreOrderSettingsOverridesInput!
setProductBasicInformation - SetProductBasicInformationResult Sets product basic information.
Arguments
input - SetProductBasicInformationInput!
setProductIsFeatured - SetProductIsFeaturedResult Sets whether a product is marked as featured.
Arguments
input - SetProductIsFeaturedInput!
removeProductIsFeaturedOverride - RemoveProductIsFeaturedOverrideResult Removes overrides for whether a product is featured from a locale.
Arguments
input - RemoveProductIsFeaturedOverrideInput!
setProductSeoInformation - SetProductSeoInformationResult Sets product SEO information.
Arguments
input - SetProductSeoInformationInput!
setProductStorefrontDetails - SetProductStorefrontDetailsResult Sets product storefront details.
Arguments
input - SetProductStorefrontDetailsInput!
setProductPreOrderSettings - SetProductPreOrderSettingsResult Sets product pre-order settings.
Arguments
input - SetProductPreOrderSettingsInput!
setProductOptionsInformation - SetProductOptionsInformationResult Sets product option information.
Arguments
input - SetProductOptionsInformationInput!
setProductUrlPath - SetProductUrlPathResult Sets a product URL path.
Arguments
input - SetProductUrlPathInput!
removeProductUrlPathOverride - RemoveProductUrlPathOverrideResult Removes overrides for a product URL path from a locale.
Arguments
input - RemoveProductUrlPathOverrideInput!
setProductModifiersInformation - SetProductModifiersInformationResult Sets product modifier information.
Arguments
input - SetProductModifiersInformationInput!
removeProductModifiersOverrides - RemoveProductModifiersOverridesResult Remove product modifier overrides from a locale.
Arguments
input - RemoveProductModifiersOverridesInput!
removeProductCustomFieldsOverrides - RemoveProductCustomFieldsOverridesResult Removes overrides for product custom fields from a channel locale.
Arguments
input - RemoveProductCustomFieldsOverridesInput!
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,
  "removeProductCustomFieldsOverrides": RemoveProductCustomFieldsOverridesResult
}
Types

ProductOption

Description

Product option

Fields
Field Name Description
displayName - String! Display name for the option.
isShared - Boolean! Indicates whether product option is shared or local.
id - ID! The ID of the object.
overridesForLocale - ProductOptionForLocale Option overrides for a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve product options from a channel locale.
values - [ProductOptionValue!]! List of product option values.
Possible Types
ProductOption Types

DropdownProductOption

RadioButtonsProductOption

RectangleListProductOption

SwatchProductOption
Example
{
  "displayName": "xyz789",
  "isShared": false,
  "id": "4",
  "overridesForLocale": ProductOptionForLocale,
  "values": [ProductOptionValue]
}
Types

ProductOptionConnection

Description

A connection to a list of items.

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

ProductOptionEdge

Description

An edge in a connection.

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

ProductOptionForLocale

Description

Product option overrides in a channel locale.

Fields
Field Name Description
displayName - String Display name for the product option.
values - [ProductOptionValueForLocale!]! List of product option values.
Possible Types
ProductOptionForLocale Types

DropdownProductOptionForLocale

RadioButtonsProductOptionForLocale

RectangleListProductOptionForLocale

SwatchProductOptionForLocale
Example
{
  "displayName": "abc123",
  "values": [ProductOptionValueForLocale]
}
Types

ProductOptionValue

Description

Product option value.

Fields
Field Name Description
id - ID! ID of the product option value.
isDefault - Boolean! Indicates whether this value is selected by default.
label - String! Label for the option value.
Possible Types
ProductOptionValue Types

DropdownOptionValue

RadioButtonsOptionValue

RectangleListOptionValue

SwatchOptionValue
Example
{
  "id": 4,
  "isDefault": true,
  "label": "abc123"
}
Types

ProductOptionValueForLocale

Description

Override for the product option value in a channel locale.

Fields
Field Name Description
id - ID! ID of the product option value.
label - String! Label for the option value.
Possible Types
ProductOptionValueForLocale Types

DropdownOptionValueForLocale

RadioButtonsOptionValueForLocale

RectangleListOptionValueForLocale

SwatchOptionValueForLocale
Example
{"id": 4, "label": "abc123"}
Types

ProductOverridesForChannel

Description

Product overrides for a channel.

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

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

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

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"
Types

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

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"
Types

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

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"
Types

ProductUrlPath

Description

Product URL path.

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

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"}
Types

ProductsFiltersInput

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

RadioButtonsModifierValue

Description

Value of the radio buttons product modifier.

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

RadioButtonsModifierValueForLocale

Description

Overrides for a radio button product modifier value in a channel locale.

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

RadioButtonsOptionValue

Description

Radio buttons product option value

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

RadioButtonsOptionValueForLocale

Description

Override for a radio button product option value in a channel locale.

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

RadioButtonsProductModifier

Description

Radio buttons product modifier.

Fields
Field Name Description
overridesForLocale - RadioButtonsProductModifierForLocale Overrides for the product modifier in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve product modifiers from a channel locale.
values - [RadioButtonsModifierValue!]! Product modifier values.
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "overridesForLocale": RadioButtonsProductModifierForLocale,
  "values": [RadioButtonsModifierValue],
  "id": 4,
  "displayName": "xyz789",
  "isRequired": false,
  "isShared": false
}
Types

RadioButtonsProductModifierForLocale

Description

Overrides for the radio buttons product modifier in a channel locale.

Fields
Field Name Description
displayName - String Override for the product modifier display name in a channel locale.
values - [RadioButtonsModifierValueForLocale!]! Override for the product modifier values in a channel locale.
Example
{
  "displayName": "xyz789",
  "values": [RadioButtonsModifierValueForLocale]
}
Types

RadioButtonsProductOption

Description

Radio buttons product option.

Fields
Field Name Description
displayName - String! Display name for the option.
isShared - Boolean! Indicates whether product option is shared or local.
id - ID! The ID of the object.
overridesForLocale - ProductOptionForLocale Option overrides for a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve product options from a channel locale.
values - [ProductOptionValue!]! List of product option values.
Example
{
  "displayName": "abc123",
  "isShared": false,
  "id": "4",
  "overridesForLocale": ProductOptionForLocale,
  "values": [ProductOptionValue]
}
Types

RadioButtonsProductOptionForLocale

Description

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

Fields
Field Name Description
displayName - String Display name for the product option.
values - [ProductOptionValueForLocale!]! List of product option values.
Example
{
  "displayName": "abc123",
  "values": [ProductOptionValueForLocale]
}
Types

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"
}
Types

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

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

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
  ]
}
Types

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

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

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.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared options from a channel locale.
values - [SharedProductOptionValue!]! List of shared option values.
Example
{
  "displayName": "abc123",
  "id": "4",
  "overridesForLocale": SharedProductOptionForLocale,
  "values": [SharedProductOptionValue]
}
Types

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]
}
Types

ReassignMetafieldOwnerError

Description

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

Types
Union Types

EntityNotFoundError

EntityAlreadyExistsError

ValidationError
Example
EntityNotFoundError
Types

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]
}
Types

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]
}
Types

RectangleListModifierValue

Description

Value for the rectangle list product modifier.

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

RectangleListModifierValueForLocale

Description

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

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

RectangleListOptionValue

Description

Rectangle list product option value

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

RectangleListOptionValueForLocale

Description

Overrides for the rectangle list product option value in a channel locale.

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

RectangleListProductModifier

Description

Rectangle list product modifier.

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

The channel and locale that apply when you override or retrieve product modifiers from a channel locale.
values - [RectangleListModifierValue!]! Values for a rectangle list product modifier.
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "overridesForLocale": RectangleListProductModifierForLocale,
  "values": [RectangleListModifierValue],
  "id": 4,
  "displayName": "abc123",
  "isRequired": false,
  "isShared": true
}
Types

RectangleListProductModifierForLocale

Description

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

Fields
Field Name Description
displayName - String Display name for the product modifier.
values - [RectangleListModifierValueForLocale!]! Values for the rectangle list product modifier.
Example
{
  "displayName": "xyz789",
  "values": [RectangleListModifierValueForLocale]
}
Types

RectangleListProductOption

Description

Rectangle list product option.

Fields
Field Name Description
displayName - String! Display name for the option.
isShared - Boolean! Indicates whether product option is shared or local.
id - ID! The ID of the object.
overridesForLocale - ProductOptionForLocale Option overrides for a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve product options from a channel locale.
values - [ProductOptionValue!]! List of product option values.
Example
{
  "displayName": "abc123",
  "isShared": false,
  "id": "4",
  "overridesForLocale": ProductOptionForLocale,
  "values": [ProductOptionValue]
}
Types

RectangleListProductOptionForLocale

Description

Override for a rectangle list product option in a channel locale.

Fields
Field Name Description
displayName - String Display name for the product option.
values - [ProductOptionValueForLocale!]! List of product option values.
Example
{
  "displayName": "xyz789",
  "values": [ProductOptionValueForLocale]
}
Types

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

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"
}
Types

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

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": "xyz789",
  "values": [
    RectangleListSharedProductModifierValueForLocale
  ]
}
Types

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

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

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.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared options from a channel locale.
values - [SharedProductOptionValue!]! List of shared option values.
Example
{
  "displayName": "abc123",
  "id": "4",
  "overridesForLocale": SharedProductOptionForLocale,
  "values": [SharedProductOptionValue]
}
Types

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]
}
Types

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"
Types

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"]}
Types

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"
Types

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"]}
Types

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"
Types

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

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"]}
Types

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"
Types

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

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]}
Types

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"
Types

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

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]}
Types

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"
Types

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"]}
Types

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"
Types

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"]}
Types

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"
Types

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"]}
Types

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"
Types

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

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"]}
Types

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

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

RemoveProductCustomFieldsOverridesAttribute

Description

Custom field remove overrides attribute.

Values
Enum Value Description

IS_VISIBLE

 IsVisible Custom field remove overrides attribute.

NAME

 Name Custom field remove overrides attribute.

VALUE

 Value Custom field remove overrides attribute.
Example
"IS_VISIBLE"
Types

RemoveProductCustomFieldsOverridesChannelLocaleContextDataInput

Description

Custom field remove overrides locale data.

Fields
Input Field Description
context - ChannelLocaleContextInput! Custom field remove overrides locale data context.
attributes - [RemoveProductCustomFieldsOverridesAttribute!] Custom field remove overrides locale data attributes.
Example
{
  "context": ChannelLocaleContextInput,
  "attributes": ["IS_VISIBLE"]
}
Types

RemoveProductCustomFieldsOverridesDataInput

Description

Custom fields remove overrides data input.

Fields
Input Field Description
customFieldId - ID! Custom field Id to remove overrides for.
channelLocaleContextData - RemoveProductCustomFieldsOverridesChannelLocaleContextDataInput! Custom field remove overrides channel locale context data.
Example
{
  "customFieldId": 4,
  "channelLocaleContextData": RemoveProductCustomFieldsOverridesChannelLocaleContextDataInput
}
Types

RemoveProductCustomFieldsOverridesInput

Fields
Input Field Description
productId - ID! The product which custom fields overrides must be removed.
data - [RemoveProductCustomFieldsOverridesDataInput!]!
Example
{
  "productId": 4,
  "data": [RemoveProductCustomFieldsOverridesDataInput]
}
Types

RemoveProductCustomFieldsOverridesResult

Fields
Field Name Description
product - Product The product which custom fields overrides was removed.
Example
{"product": Product}
Types

RemoveProductIsFeaturedOverrideInput

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

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

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]}
Types

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

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

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

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

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

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

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]}
Types

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"
}
Types

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

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

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

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"
}
Types

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

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"
}
Types

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

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

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

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"
Types

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

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"]}
Types

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"
Types

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

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]}
Types

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"
Types

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

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]}
Types

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"
Types

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

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"]}
Types

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"
Types

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

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"]}
Types

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"
Types

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

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]}
Types

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"
Types

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"]}
Types

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"
Types

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"]}
Types

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"
Types

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

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]}
Types

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"
Types

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"]}
Types

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"
Types

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"]}
Types

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"
Types

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"]}
Types

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]}
Types

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

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

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

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]}
Types

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

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

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]}
Types

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

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]}
Types

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"
Types

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

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"]}
Types

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"
Types

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

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]}
Types

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"
Types

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

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]}
Types

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"
Types

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"]}
Types

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"
Types

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

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]}
Types

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"
Types

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

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]}
Types

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"
Types

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

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"]}
Types

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"
Types

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"]}
Types

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]
}
Types

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

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

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"}
Types

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
  ]
}
Types

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

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": "xyz789",
  "values": [
    SetDropdownProductOptionValueInformationInput
  ]
}
Types

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

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

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"
}
Types

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

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
  ]
}
Types

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"
}
Types

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

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

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

SetProductIsFeaturedDataInput

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

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

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

SetProductModifierInformationDataInput

Description

Product modifiers information data

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

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

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

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

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

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

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

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]}
Types

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"
}
Types

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

SetProductPreOrderSettingsDataInput

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

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"
}
Types

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

SetProductSeoInformationDataInput

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

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

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

SetProductStorefrontDetailsDataInput

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

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"
}
Types

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

SetProductUrlPathDataInput

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

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

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

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
  ]
}
Types

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

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
  ]
}
Types

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

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
  ]
}
Types

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

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
  ]
}
Types

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

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

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"}
Types

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
  ]
}
Types

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"}
Types

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": "xyz789",
  "values": [
    SetSharedDropdownProductOptionValueInformationInput
  ]
}
Types

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"}
Types

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

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

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

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]}
Types

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

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

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

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]}
Types

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

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

SetSharedProductOptionsInformationDataInput

Description

Input that sets shared options for a channel locale.

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

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

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]}
Types

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": "xyz789",
  "values": [
    SetSharedRadioButtonsProductModifierValueInformationInput
  ]
}
Types

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

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": "abc123",
  "values": [
    SetSharedRadioButtonsProductOptionValueInformationInput
  ]
}
Types

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

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": "abc123",
  "values": [
    SetSharedRectangleListProductModifierValueInformationInput
  ]
}
Types

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

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": "xyz789",
  "values": [
    SetSharedRectangleListProductOptionValueInformationInput
  ]
}
Types

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

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": "xyz789",
  "values": [
    SetSharedSwatchProductModifierValueInformationInput
  ]
}
Types

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"
}
Types

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
  ]
}
Types

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"}
Types

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

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": "xyz789",
  "values": [
    SetSwatchProductModifierValueInformationInput
  ]
}
Types

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"}
Types

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": "xyz789",
  "values": [SetSwatchProductOptionValueInformationInput]
}
Types

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"
}
Types

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

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.
Possible Types
SharedProductModifier Types

CheckboxSharedProductModifier

DateFieldSharedProductModifier

DropdownSharedProductModifier

FileUploadSharedProductModifier

MultilineTextFieldSharedProductModifier

NumbersOnlyTextFieldSharedProductModifier

RadioButtonsSharedProductModifier

RectangleListSharedProductModifier

SwatchSharedProductModifier

TextFieldSharedProductModifier
Example
{
  "id": 4,
  "displayName": "abc123",
  "isRequired": true
}
Types

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]
}
Types

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"
}
Types

SharedProductModifiersFiltersInput

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

SharedProductModifiersMutations

Description

Shared modifier mutations.

Fields
Field Name Description
setSharedProductModifiersInformation - SetSharedProductModifiersInformationResult Sets information for shared modifiers.
Arguments
input - SetSharedProductModifiersInformationInput!
removeSharedProductModifiersOverrides - RemoveSharedProductModifiersOverridesResult Remove overrides for shared modifiers from a channel locale.
Arguments
input - RemoveSharedProductModifiersOverridesInput!
Example
{
  "setSharedProductModifiersInformation": SetSharedProductModifiersInformationResult,
  "removeSharedProductModifiersOverrides": RemoveSharedProductModifiersOverridesResult
}
Types

SharedProductOption

Description

Shared options.

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.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared options from a channel locale.
values - [SharedProductOptionValue!]! List of shared option values.
Possible Types
SharedProductOption Types

DropdownSharedProductOption

RadioButtonsSharedProductOption

RectangleListSharedProductOption

SwatchSharedProductOption
Example
{
  "displayName": "xyz789",
  "id": "4",
  "overridesForLocale": SharedProductOptionForLocale,
  "values": [SharedProductOptionValue]
}
Types

SharedProductOptionConnection

Description

A connection to a list of items.

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

SharedProductOptionEdge

Description

An edge in a connection.

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

SharedProductOptionForLocale

Description

Overrides for shared options in a channel locale.

Fields
Field Name Description
displayName - String Display name for a shared option.
values - [SharedProductOptionValueForLocale!]! List of shared option values.
Possible Types
SharedProductOptionForLocale Types

DropdownSharedProductOptionForLocale

RadioButtonsSharedProductOptionForLocale

RectangleListSharedProductOptionForLocale

SwatchSharedProductOptionForLocale
Example
{
  "displayName": "xyz789",
  "values": [SharedProductOptionValueForLocale]
}
Types

SharedProductOptionValue

Description

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.
Possible Types
SharedProductOptionValue Types

DropdownSharedOptionValue

RadioButtonsSharedOptionValue

RectangleListSharedOptionValue

SwatchSharedOptionValue
Example
{
  "id": "4",
  "isDefault": true,
  "label": "abc123"
}
Types

SharedProductOptionValueForLocale

Description

Overrides for shared option values in a locale.

Fields
Field Name Description
id - ID! ID of the shared option value.
label - String! Label for the shared option value.
Possible Types
SharedProductOptionValueForLocale Types

DropdownSharedOptionValueForLocale

RadioButtonsSharedOptionValueForLocale

RectangleListSharedOptionValueForLocale

SwatchSharedOptionValueForLocale
Example
{"id": 4, "label": "abc123"}
Types

SharedProductOptionsFiltersInput

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

SharedProductOptionsMutations

Description

Shared product option mutations.

Fields
Field Name Description
setSharedProductOptionsInformation - SetSharedProductOptionsInformationResult Sets shared product option information.
Arguments
input - SetSharedProductOptionsInformationInput!
removeSharedProductOptionsOverrides - RemoveSharedProductOptionsOverridesResult Removes overrides for shared product options from a channel locale.
Arguments
input - RemoveSharedProductOptionsOverridesInput!
Example
{
  "setSharedProductOptionsInformation": SetSharedProductOptionsInformationResult,
  "removeSharedProductOptionsOverrides": RemoveSharedProductOptionsOverridesResult
}
Types

Store

Description

A store.

Fields
Field Name Description
account - Account An account.
appExtensions - AppExtensionsConnection! A list of App Extensions that the requesting API account has installed on the store.
Arguments
before - String
after - String
first - Int
last - Int
id - ID! The ID of the object.
metafield - Metafield Single metafield.
Arguments
id - ID!

The id of the metafield.
metafields - MetafieldsConnection! List of metafields.
Arguments
filters - MetafieldsFiltersInput
before - String
after - String
first - Int
last - Int
product - Product Single product.
Arguments
id - ID!

The ID of the object.
products - ProductConnection! List of products.
Arguments
filters - ProductsFiltersInput
before - String
after - String
first - Int
last - Int
settings - StoreSettings Store settings.
sharedProductModifiers - SharedProductModifierConnection! List of shared product modifiers.
Arguments
filters - SharedProductModifiersFiltersInput
before - String
after - String
first - Int
last - Int
sharedProductOptions - SharedProductOptionConnection! List of shared product options.
Arguments
filters - SharedProductOptionsFiltersInput
before - String
after - String
first - Int
last - Int
storeHash - String! Store hash.
storeReferenceId - String! Store reference ID.
Example
{
  "account": Account,
  "appExtensions": AppExtensionsConnection,
  "id": 4,
  "metafield": Metafield,
  "metafields": MetafieldsConnection,
  "product": Product,
  "products": ProductConnection,
  "settings": StoreSettings,
  "sharedProductModifiers": SharedProductModifierConnection,
  "sharedProductOptions": SharedProductOptionConnection,
  "storeHash": "xyz789",
  "storeReferenceId": "xyz789"
}
Types

StoreSettings

Description

Store settings.

Fields
Field Name Description
dataSolutions - DataSolutionsSettings! Data solutions.
storeName - String! Store name.
Example
{
  "dataSolutions": DataSolutionsSettings,
  "storeName": "abc123"
}
Types

StoreSettingsMutations

Description

Store settings mutations.

Fields
Field Name Description
dataSolutions - DataSolutionsMutations! Data solutions mutations.
Example
{"dataSolutions": DataSolutionsMutations}
Types

StorefrontDetails

Description

Storefront details.

Fields
Field Name Description
warranty - String Product warranty.
availabilityDescription - String Description about product availability.
searchKeywords - String Product search keywords.
Example
{
  "warranty": "abc123",
  "availabilityDescription": "xyz789",
  "searchKeywords": "xyz789"
}
Types

StorefrontDetailsOverridesForLocale

Description

Overrides for storefront details in a channel locale.

Fields
Field Name Description
warranty - String Product warranty.
availabilityDescription - String Description about product availability.
searchKeywords - String Product search keywords.
Example
{
  "warranty": "xyz789",
  "availabilityDescription": "xyz789",
  "searchKeywords": "xyz789"
}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"
Types

SwatchOptionValue

Description

Swatch product option value

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

SwatchOptionValueForLocale

Description

Overrides for swatch product option value in a channel locale.

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

SwatchProductModifier

Description

Swatch product modifier.

Fields
Field Name Description
overridesForLocale - SwatchProductModifierForLocale Overrides for swatch product modifiers in a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve product modifiers from a channel locale.
values - [SwatchProductModifierValue!]! Swatch product modifiers values.
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "overridesForLocale": SwatchProductModifierForLocale,
  "values": [SwatchProductModifierValue],
  "id": 4,
  "displayName": "abc123",
  "isRequired": true,
  "isShared": true
}
Types

SwatchProductModifierForLocale

Description

Overrides for the swatch product modifier in a channel locale.

Fields
Field Name Description
displayName - String Display name for the product modifier.
values - [SwatchProductModifierValueForLocale!]! Product modifier values.
Example
{
  "displayName": "xyz789",
  "values": [SwatchProductModifierValueForLocale]
}
Types

SwatchProductModifierValue

Description

Swatch product modifier value.

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

SwatchProductModifierValueForLocale

Description

Overrides for the swatch product modifier value in a channel locale.

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

SwatchProductOption

Description

Swatch product option.

Fields
Field Name Description
displayName - String! Display name for the option.
isShared - Boolean! Indicates whether product option is shared or local.
id - ID! The ID of the object.
overridesForLocale - ProductOptionForLocale Option overrides for a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve product options from a channel locale.
values - [ProductOptionValue!]! List of product option values.
Example
{
  "displayName": "xyz789",
  "isShared": false,
  "id": "4",
  "overridesForLocale": ProductOptionForLocale,
  "values": [ProductOptionValue]
}
Types

SwatchProductOptionForLocale

Description

Override for the swatch product option in a channel locale.

Fields
Field Name Description
displayName - String Display name for the product option.
values - [ProductOptionValueForLocale!]! List of product option values.
Example
{
  "displayName": "abc123",
  "values": [ProductOptionValueForLocale]
}
Types

SwatchSharedOptionValue

Description

Swatch 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": false,
  "label": "abc123"
}
Types

SwatchSharedOptionValueForLocale

Description

Override for a swatch 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": "xyz789"}
Types

SwatchSharedProductModifier

Description

Swatch shared modifier.

Fields
Field Name Description
overridesForLocale - SwatchSharedProductModifierForLocale Swatch shared product modifier overrides for a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared modifiers from a channel locale.
values - [SwatchSharedProductModifierValue!]! 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": SwatchSharedProductModifierForLocale,
  "values": [SwatchSharedProductModifierValue],
  "id": "4",
  "displayName": "xyz789",
  "isRequired": true
}
Types

SwatchSharedProductModifierForLocale

Description

Overrides for the swatch shared modifier in a channel locale.

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

SwatchSharedProductModifierValue

Description

Swatch shared product modifier value.

Fields
Field Name Description
id - ID! The 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": true,
  "label": "abc123"
}
Types

SwatchSharedProductModifierValueForLocale

Description

Overrides for the swatch shared modifier for a channel locale.

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

SwatchSharedProductOption

Description

Swatch 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.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared options from a channel locale.
values - [SharedProductOptionValue!]! List of shared option values.
Example
{
  "displayName": "abc123",
  "id": 4,
  "overridesForLocale": SharedProductOptionForLocale,
  "values": [SharedProductOptionValue]
}
Types

SwatchSharedProductOptionForLocale

Description

Override for a swatch 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]
}
Types

System

Description

System settings.

Fields
Field Name Description
time - Long! The current time.
Example
{"time": {}}
Types

TextFieldProductModifier

Description

Text field product modifier.

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

The channel and locale that apply when you override or retrieve product modifiers from a channel locale.
id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "defaultValue": "abc123",
  "overridesForLocale": TextFieldProductModifierForLocale,
  "id": "4",
  "displayName": "abc123",
  "isRequired": false,
  "isShared": false
}
Types

TextFieldProductModifierForLocale

Description

Overrides for a text field product modifier in a channel locale.

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

TextFieldSharedProductModifier

Description

Text field product modifier.

Fields
Field Name Description
defaultValue - String Text field modifier default value.
overridesForLocale - TextFieldSharedProductModifierForLocale Text field product modifier overrides for a channel locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

The channel and locale that apply when you override or retrieve shared options 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": "xyz789",
  "overridesForLocale": TextFieldSharedProductModifierForLocale,
  "id": 4,
  "displayName": "xyz789",
  "isRequired": true
}
Types

TextFieldSharedProductModifierForLocale

Description

Overrides for the 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": "xyz789"
}
Types

UpdateAppExtensionDataInput

Fields
Input Field Description
label - UpdateAppExtensionLabelInput An object that contains all of the desired locale-aware link text options for an App Extension, including new link text options.
url - String A new relative path containing a supported path parameter that the app expects to be templated into its route, defined as a JavaScript string template expression. Currently, id is supported. Limit 255 characters. See the AppExtension response object schema for more detail.
Example
{
  "label": UpdateAppExtensionLabelInput,
  "url": "xyz789"
}
Types

UpdateAppExtensionInput

Fields
Input Field Description
data - UpdateAppExtensionDataInput! The App Extension data to be changed. Currently, only the url and label properties can be updated. Changes to the label object overwrite existing values, rather than upserting. Be sure to send the whole label object you intend the App Extension to have, not just the changes.
id - ID! The ID of the object.
Example
{
  "data": UpdateAppExtensionDataInput,
  "id": "4"
}
Types

UpdateAppExtensionLabelInput

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]
}
Types

UpdateAppExtensionResult

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

UpdateDataLayerInput

Fields
Input Field Description
isDataLayerEnabled - Boolean! is data layer enabled
Example
{"isDataLayerEnabled": false}
Types

UpdateDataLayerResult

Description

Result of mutation.

Fields
Field Name Description
dataSolutions - DataSolutionsSettings Data solutions object that is updated as a result of mutation.
Example
{"dataSolutions": DataSolutionsSettings}
Types

UpdateMetafieldDataInput

Fields
Input Field Description
namespace - String Namespace for the metafield.
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": "xyz789",
  "key": "abc123",
  "value": "xyz789",
  "description": "xyz789",
  "permissionSet": "APP_ONLY"
}
Types

UpdateMetafieldInput

Fields
Input Field Description
id - ID! Id of metafield to update.
data - UpdateMetafieldDataInput! Data to update.
Example
{"id": 4, "data": UpdateMetafieldDataInput}
Types

UpdateMetafieldResult

Fields
Field Name Description
metafield - Metafield Updated metafield.
Example
{"metafield": Metafield}
Types

ValidationError

Description

Error indicating that the input is invalid.

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