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

Account

Description

An account.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.

Example

{"id": 4}

Types

AddImagesToProductInput

Fields

Input Field	Description
`productId` - `ID!`	The ID of the product.
`context` - `ChannelLocaleContextInput`	The storefront channel and locale that apply when you override or retrieve product images from a channel locale.
`ids` - `[ID!]!`	The unique identifier for the resource with which the product image is associated.

Example

{
  "productId": "4",
  "context": ChannelLocaleContextInput,
  "ids": ["4"]
}

Types

AddImagesToProductResult

Fields

Field Name	Description
`images` - `ProductImageConnection`	The images list with added and removed images.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{"images": ProductImageConnection}

Types

AlreadyExistsError

Description

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

Fields

Field Name	Description
`message` - `String!`	Information about error.

Example

{"message": "xyz789"}

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

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

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

BlogPostEntityRedirect

Description

Redirect to blog posts.

Fields

Field Name	Description
`blogPostId` - `ID!`	The ID of the object.

Example

{"blogPostId": "4"}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Example

true

Types

BrandEntityRedirect

Description

Redirect to brand.

Fields

Field Name	Description
`brandId` - `ID!`	The ID of the object.

Example

{"brandId": 4}

Types

CategoryEntityRedirect

Description

Redirect to category.

Fields

Field Name	Description
`categoryId` - `ID!`	The ID of the object.

Example

{"categoryId": "4"}

Types

Channel

Description

A channel.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.
`currencies` - `ChannelCurrencyCodes`	Currency Assignments for the channel.
`dateCreated` - `DateTime`	Date on which the channel was first created.
`dateModified` - `DateTime`	Date on which the channel was most recently changed.
`externalId` - `String!`	Associated ID within a system / platform outside of BC.
`iconUrl` - `String!`	Link to the platform icon.
`isListableFromUi` - `Boolean!`	Indicates if a channel can create listings from the BigCommerce UI. Default value for this field is based on the channel type and platform combination if not specified on create.
`isVisible` - `Boolean!`	Indicates if a channel is visible within the BigCommerce merchant admin UI (control panel). If false, the channel will not show in Channel Manager nor in any channels dropdown throughout the UI. Default value for this field is true if not specified on create.
`name` - `String!`	Name of the channel as it will appear to merchants in the control panel.
`platform` - `String!`	The name of the platform for the channel; channel platform and type must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#platform to check for valid combination.
`settings` - `ChannelSettings`	Channel-level settings.
`site` - `Site`	A site.
`status` - `ChannelStatus`	The status of the channel; channel type, platform, and status must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#status to check for valid combination.
`type` - `String!`	The type of channel; channel platform and type must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#platform to check for valid combination.

Example

{
  "id": "4",
  "currencies": ChannelCurrencyCodes,
  "dateCreated": "2007-12-03T10:15:30Z",
  "dateModified": "2007-12-03T10:15:30Z",
  "externalId": "abc123",
  "iconUrl": "abc123",
  "isListableFromUi": true,
  "isVisible": true,
  "name": "abc123",
  "platform": "xyz789",
  "settings": ChannelSettings,
  "site": Site,
  "status": "ACTIVE",
  "type": "abc123"
}

Types

ChannelCurrencyCodes

Description

Channel-level currency assignments

Fields

Field Name	Description
`defaultCurrencyCode` - `CurrencyCode`	Default currency for the channel in ISO 4217 three character alphabetic format. Will be used on storefront when other currencies cannot.
`enabledCurrencyCodes` - `[CurrencyCode!]!`	Currencies that are enabled for the given channel in ISO 4217 three character alphabetic format.

Example

{"defaultCurrencyCode": "AED", "enabledCurrencyCodes": ["AED"]}

Types

ChannelLocaleContext

Description

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

Fields

Field Name	Description
`channelId` - `ID!`	Storefront channel ID.
`locale` - `String!`	Locale in a storefront channel.

Example

{"channelId": 4, "locale": "abc123"}

Types

ChannelLocaleContextInput

Description

The storefront channel and locale that apply when you set overrides for a channel locale.

Fields

Input Field	Description
`channelId` - `ID!`	Storefront channel ID.
`locale` - `String!`	Locale in a storefront channel.

Example

{
  "channelId": "4",
  "locale": "abc123"
}

Types

ChannelMutations

Description

Channel mutations.

Fields

Field Name	Description
`createChannel` - `CreateChannelResult`	Creates a channel.
Arguments `input` - `CreateChannelInput!`

Example

{"createChannel": CreateChannelResult}

Types

ChannelSettings

Description

Channel-level settings.

Fields

Field Name	Description
`storeName` - `String`	Store name.

Example

{"storeName": "xyz789"}

Types

ChannelStatus

Description

Status of the channel.

Values

Enum Value	Description
`ACTIVE`	Channel is active.
`ARCHIVED`	Channel is archived.
`CONNECTED`	Channel is connected.
`DELETED`	Channel is deleted.
`DISCONNECTED`	Channel is disconnected.
`INACTIVE`	Channel is inactive.
`PRELAUNCH`	Channel is in pre-launch mode.
`TERMINATED`	Channel is terminated.

Example

"ACTIVE"

Types

ChannelsConnection

Description

A connection to a list of items.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[ChannelsEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [ChannelsEdge]
}

Types

ChannelsEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `Channel!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": Channel,
  "cursor": "xyz789"
}

Types

ChannelsFiltersInput

Fields

Input Field	Description
`available` - `Boolean`	Filter items based on whether the channel is currently available for integration. Setting this query parameter to true will return channels with the status of prelaunch, active, inactive, and connected. Setting this query parameter to false will return channels with the status of disconnected, archived, deleted, and terminated.
`dateCreated` - `DateFiltersInput`	Filter items by date created.
`dateModified` - `DateFiltersInput`	Filter items by date modified.
`ids` - `[ID!]`	The IDs of channels.
`platforms` - `[String!]`	Filter items by a list of platforms. For a list of supported platforms, see https://developer.bigcommerce.com/api-reference/store-management/channels#platform.
`statuses` - `[ChannelStatus!]`	Filter items by a list of statuses.
`types` - `[String!]`	Filter items by a list of types.

Example

{
  "available": true,
  "dateCreated": DateFiltersInput,
  "dateModified": DateFiltersInput,
  "ids": ["4"],
  "platforms": ["abc123"],
  "statuses": ["ACTIVE"],
  "types": ["xyz789"]
}

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": false,
  "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 product modifier in a channel locale.
Arguments `localeContext` - `ProductOverridesLocaleContextInput!` The channel and locale that apply when you override or retrieve shared product modifiers from a channel locale.
`id` - `ID!`	ID of the shared product modifier.
`displayName` - `String!`	Display name for the shared product modifier.
`isRequired` - `Boolean!`	Indicates whether the shared product modifier is required.

Example

{
  "checkedByDefault": true,
  "fieldValue": "abc123",
  "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 product modifier.
`fieldValue` - `String`	Field value for the shared product 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

CollectionInfo

Description

Collection information.

Fields

Field Name	Description
`totalItems` - `Long`	Total number of items in the collection.

Example

{"totalItems": {}}

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

Types

CreateAppExtensionResult

Fields

Field Name	Description
`appExtension` - `AppExtension`	The response object properties available after creating an App Extension.

Example

{"appExtension": AppExtension}

Types

CreateChannelInput

Fields

Input Field	Description
`externalId` - `String`	Associated ID within a system / platform outside of BC.
`isListableFromUi` - `Boolean`	Indicates if a channel can create listings from the BigCommerce UI. Default value for this field is based on the channel type and platform combination if not specified on create.
`isVisible` - `Boolean`	Indicates if a channel is visible within the BigCommerce merchant admin UI (control panel). If false, the channel will not show in Channel Manager nor in any channels dropdown throughout the UI. Default value for this field is true if not specified on create.
`name` - `String!`	Name of the channel as it will appear to merchants in the control panel.
`platform` - `String!`	The name of the platform for the channel; channel platform and type must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#platform to check for valid combination.
`status` - `ChannelStatus`	The status of the channel; channel type, platform, and status must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#status to check for valid combination. terminated is not valid for CREATE or UPDATE requests. deleted is not valid for CREATE requests.
`type` - `String!`	The type of channel; channel platform and type must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#platform to check for valid combination.

Example

{
  "externalId": "xyz789",
  "isListableFromUi": true,
  "isVisible": false,
  "name": "abc123",
  "platform": "abc123",
  "status": "ACTIVE",
  "type": "xyz789"
}

Types

CreateChannelResult

Fields

Field Name	Description
`channel` - `Channel`	The Channel that is created as a result of mutation.

Example

{"channel": Channel}

Types

CreateEventBridgeWebhookError

Description

Error object for create Amazon EventBridge webhook mutation.

Types

Union Types
`AlreadyExistsError`
`ValidationError`
`EventBridgeSourceNotFoundError`
`DestinationNotAllowedError`
`WebhooksLimitPerClientScopeReachedError`

Example

AlreadyExistsError

Types

CreateEventBridgeWebhookInput

Fields

Input Field	Description
`destination` - `String!`	The fields used to create an Amazon EventBridge webhook.
`eventFilters` - `[WebhookEventFilterUnionInput!]`	Event filters for webhook.
`isActive` - `Boolean`	If webhook is active or not.
`scope` - `String!`	The scope of the event subscription.

Example

{
  "destination": "xyz789",
  "eventFilters": [WebhookEventFilterUnionInput],
  "isActive": false,
  "scope": "xyz789"
}

Types

CreateEventBridgeWebhookResult

Fields

Field Name	Description
`webhook` - `EventBridgeWebhook`	The result returned after creating an Amazon EventBridge webhook.
`errors` - `[CreateEventBridgeWebhookError!]!`	The list of errors that occurred while creating an Amazon EventBridge webhook.

Example

{
  "webhook": EventBridgeWebhook,
  "errors": [AlreadyExistsError]
}

Types

CreateHttpsWebhookError

Description

Error object for create HTTPS webhook mutation.

Types

Union Types
`AlreadyExistsError`
`ValidationError`
`DestinationNotAllowedError`
`WebhooksLimitPerClientScopeReachedError`

Example

AlreadyExistsError

Types

CreateHttpsWebhookInput

Fields

Input Field	Description
`destination` - `String!`	URL must be active, return a 200 response, and be served on port 443.
`eventFilters` - `[WebhookEventFilterUnionInput!]`	Filters limiting events that trigger sending webhooks.
`headers` - `[HttpsWebhookHeaderInput!]`	You can define any number of custom headers to be attached to the event sent to the destination URL.
`isActive` - `Boolean`	If webhook is active or not.
`scope` - `String!`	The scope of the event subscription.

Example

{
  "destination": "xyz789",
  "eventFilters": [WebhookEventFilterUnionInput],
  "headers": [HttpsWebhookHeaderInput],
  "isActive": false,
  "scope": "xyz789"
}

Types

CreateHttpsWebhookResult

Fields

Field Name	Description
`webhook` - `HttpsWebhook`	The webhook object returned as a result of a mutation.
`errors` - `[CreateHttpsWebhookError!]!`	The list of errors that occurred while creating a HTTPS webhook.

Example

{
  "webhook": HttpsWebhook,
  "errors": [AlreadyExistsError]
}

Types

CreateMetafieldErrors

Description

Union type for all 'createMetafield' mutation errors.

Types

Union Types
`AlreadyExistsError`
`ValidationError`
`MetafieldLimitExceededError`

Example

AlreadyExistsError

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

Types

CreateMetafieldResult

Fields

Field Name	Description
`metafield` - `Metafield`	Metafield that was created as a result of mutation.
`errors` - `[CreateMetafieldErrors!]!`	The list of errors that occurred while creating a metafield.

Example

{
  "metafield": Metafield,
  "errors": [AlreadyExistsError]
}

Types

CreatePubSubWebhookError

Description

Error object for create Google Cloud PubSub webhook mutation.

Types

Union Types
`AlreadyExistsError`
`ValidationError`
`PubSubTopicNotFoundError`
`PubSubNoPermissionToPublishError`
`DestinationNotAllowedError`
`WebhooksLimitPerClientScopeReachedError`

Example

AlreadyExistsError

Types

CreatePubSubWebhookInput

Fields

Input Field	Description
`destination` - `String!`	The Google Cloud Pub/Sub topic where events will be delivered. The topic must have the BigCommerce service account principal & Pub/Sub Publish permission enabled.
`eventFilters` - `[WebhookEventFilterUnionInput!]`	Event filters for webhook.
`isActive` - `Boolean`	If webhook is active or not.
`scope` - `String!`	The scope of the event subscription.

Example

{
  "destination": "xyz789",
  "eventFilters": [WebhookEventFilterUnionInput],
  "isActive": false,
  "scope": "xyz789"
}

Types

CreatePubSubWebhookResult

Fields

Field Name	Description
`webhook` - `PubSubWebhook`	The webhook object returned as a result of a mutation.
`errors` - `[CreatePubSubWebhookError!]!`	The list of errors that occurred while creating a Google Pub/Sub webhook.

Example

{
  "webhook": PubSubWebhook,
  "errors": [AlreadyExistsError]
}

Types

CurrencyCode

Description

Currency Code.

Values

Enum Value	Description
`AED`
`AFN`
`ALL`
`AMD`
`ANG`
`AOA`
`ARS`
`AUD`
`AWG`
`AZN`
`BAM`
`BBD`
`BDT`
`BGN`
`BHD`
`BIF`
`BMD`
`BND`
`BOB`
`BOV`
`BRL`
`BSD`
`BTN`
`BWP`
`BYN`
`BYR`
`BZD`
`CAD`
`CDF`
`CHE`
`CHF`
`CHW`
`CLF`
`CLP`
`CNY`
`COP`
`COU`
`CRC`
`CUC`
`CUP`
`CVE`
`CZK`
`DJF`
`DKK`
`DOP`
`DZD`
`EGP`
`ERN`
`ETB`
`EUR`
`FJD`
`FKP`
`GBP`
`GEL`
`GHS`
`GIP`
`GMD`
`GNF`
`GTQ`
`GYD`
`HKD`
`HNL`
`HRK`
`HTG`
`HUF`
`IDR`
`ILS`
`INR`
`IQD`
`IRR`
`ISK`
`JMD`
`JOD`
`JPY`
`KES`
`KGS`
`KHR`
`KMF`
`KPW`
`KRW`
`KWD`
`KYD`
`KZT`
`LAK`
`LBP`
`LKR`
`LRD`
`LSL`
`LYD`
`MAD`
`MDL`
`MGA`
`MKD`
`MMK`
`MNT`
`MOP`
`MRO`
`MRU`
`MUR`
`MVR`
`MWK`
`MXN`
`MYR`
`MZN`
`NAD`
`NGN`
`NIO`
`NOK`
`NPR`
`NZD`
`OMR`
`PAB`
`PEN`
`PGK`
`PHP`
`PKR`
`PLN`
`PYG`
`QAR`
`RON`
`RSD`
`RUB`
`RWF`
`SAR`
`SBD`
`SCR`
`SDG`
`SEK`
`SGD`
`SHP`
`SLL`
`SOS`
`SRD`
`SSP`
`STD`
`STN`
`SVC`
`SYP`
`SZL`
`THB`
`TJS`
`TMT`
`TND`
`TOP`
`TRY`
`TTD`
`TWD`
`TZS`
`UAH`
`UGX`
`USD`
`USN`
`UYI`
`UYU`
`UZS`
`VEF`
`VES`
`VND`
`VUV`
`WST`
`XAF`
`XAG`
`XAU`
`XBA`
`XBB`
`XBC`
`XBD`
`XCD`
`XDR`
`XOF`
`XPD`
`XPF`
`XPT`
`XSU`
`XTS`
`XUA`
`XXX`
`YER`
`ZAR`
`ZMW`
`ZWL`

Example

"AED"

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

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

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

Types

DateFieldSharedProductModifier

Description

Date field shared product modifier.

Fields

Field Name	Description
`overridesForLocale` - `DateFieldSharedProductModifierForLocale`	Overrides for the date field shared product modifier in a channel locale.
Arguments `localeContext` - `ProductOverridesLocaleContextInput!` The channel and locale that apply when you override or retrieve shared product modifiers from a channel locale.
`id` - `ID!`	ID of the shared product modifier.
`displayName` - `String!`	Display name for the shared product modifier.
`isRequired` - `Boolean!`	Indicates whether the shared product modifier is required.

Example

{
  "overridesForLocale": DateFieldSharedProductModifierForLocale,
  "id": 4,
  "displayName": "xyz789",
  "isRequired": true
}

Types

DateFieldSharedProductModifierForLocale

Description

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

Fields

Field Name	Description
`displayName` - `String`	Display name for the shared product modifier.

Example

{"displayName": "abc123"}

Types

DateFiltersInput

Description

Filters for date.

Fields

Input Field	Description
`eq` - `DateTime`	Filter items with date equal to.
`gt` - `DateTime`	Filter items with date greater than.
`lt` - `DateTime`	Filter items with date less than.
`gte` - `DateTime`	Filter items with date greater than or equal to.
`lte` - `DateTime`	Filter items with date less than or equal to.

Example

{
  "eq": "2007-12-03T10:15:30Z",
  "gt": "2007-12-03T10:15:30Z",
  "lt": "2007-12-03T10:15:30Z",
  "gte": "2007-12-03T10:15:30Z",
  "lte": "2007-12-03T10:15:30Z"
}

Types

DateTime

Description

ISO-8601 formatted date in UTC

Example

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

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

DeleteMetafieldErrors

Description

Union type for all 'deleteMetafield' mutation errors.

Types

Union Types
`ValidationError`
`EntityNotFoundError`
`NotAuthorizedToDeleteMetafieldError`

Example

ValidationError

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.
`errors` - `[DeleteMetafieldErrors!]!`	The list of errors that occurred while creating a metafield.

Example

{"deletedMetafieldId": 4, "errors": [ValidationError]}

Types

DeleteWebhookError

Description

Error object for delete webhook mutation.

Types

Union Types
`EntityNotFoundError`

Example

EntityNotFoundError

Types

DeleteWebhookInput

Fields

Input Field	Description
`webhookId` - `ID!`	The ID of the webhook to be deleted.

Example

{"webhookId": 4}

Types

DeleteWebhookResult

Description

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

Fields

Field Name	Description
`id` - `ID`	The ID of the deleted webhook.
`errors` - `[DeleteWebhookError!]!`	The list of errors that occurred while deleting a webhook.

Example

{"id": 4, "errors": [EntityNotFoundError]}

Types

DestinationNotAllowedError

Description

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

Fields

Field Name	Description
`message` - `String!`	Information about error.

Example

{"message": "abc123"}

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": false,
  "isShared": true
}

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

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

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

Types

DropdownSharedProductModifier

Description

Dropdown shared product modifier.

Fields

Field Name	Description
`overridesForLocale` - `DropdownSharedProductModifierForLocale`	Overrides for the dropdown shared product modifier in a channel locale.
Arguments `localeContext` - `ProductOverridesLocaleContextInput!` The channel and locale that apply when you override or retrieve shared product modifiers from a channel locale.
`values` - `[DropdownSharedProductModifierValue!]!`	Dropdown shared product modifier values.
`id` - `ID!`	ID of the shared product modifier.
`displayName` - `String!`	Display name for the shared product modifier.
`isRequired` - `Boolean!`	Indicates whether the shared product modifier is required.

Example

{
  "overridesForLocale": DropdownSharedProductModifierForLocale,
  "values": [DropdownSharedProductModifierValue],
  "id": "4",
  "displayName": "xyz789",
  "isRequired": true
}

Types

DropdownSharedProductModifierForLocale

Description

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

Fields

Field Name	Description
`displayName` - `String`	Display name for the shared product modifier.
`values` - `[DropdownSharedProductModifierValueForLocale!]!`	Shared product modifier values.

Example

{
  "displayName": "abc123",
  "values": [DropdownSharedProductModifierValueForLocale]
}

Types

DropdownSharedProductModifierValue

Description

Dropdown shared product modifier value.

Fields

Field Name	Description
`id` - `ID!`	ID of the shared product modifier value.
`isDefault` - `Boolean!`	Indicates whether the shared product modifier value is selected by default.
`label` - `String!`	Label for the shared product modifier value.

Example

{
  "id": 4,
  "isDefault": false,
  "label": "xyz789"
}

Types

DropdownSharedProductModifierValueForLocale

Description

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

Fields

Field Name	Description
`id` - `ID!`	ID of the shared product modifier.
`label` - `String!`	Label for the shared product 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": "xyz789",
  "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": "abc123"}

Types

Error

Description

Common interface for all errors.

Fields

Field Name	Description
`message` - `String!`	Information about error.

Possible Types

Error Types
`AlreadyExistsError`
`DestinationNotAllowedError`
`EntityAlreadyExistsError`
`EntityNotFoundError`
`EventBridgeSourceNotFoundError`
`MetafieldLimitExceededError`
`NotAuthorizedFieldToUpdateMetafieldFieldError`
`NotAuthorizedToDeleteMetafieldError`
`NotAuthorizedToUpdateMetafieldError`
`PubSubNoPermissionToPublishError`
`PubSubTopicNotFoundError`
`ScopeChangeNotAllowedError`
`ValidationError`
`WebhooksLimitPerClientScopeReachedError`

Example

{"message": "xyz789"}

Types

EventBridgeSourceNotFoundError

Description

Error indicating that requested Amazon EventBridge source was not found.

Fields

Field Name	Description
`source` - `String!`	Amazon EventBridge source arn.
`message` - `String!`	Information about error.

Example

{
  "source": "xyz789",
  "message": "xyz789"
}

Types

EventBridgeWebhook

Description

An Amazon EventBridge webhook.

Fields

Field Name	Description
`destination` - `String!`	Amazon EventBridge source arn.
`clientId` - `String!`	ID of client application owning the webhook.
`createdAt` - `DateTime`	The date and time of webhook creation.
`eventFilters` - `[WebhookEventFilter!]!`	Event filters for webhook.
`id` - `ID!`	The ID of a webhook object.
`scope` - `String!`	The scope of the event subscription.
`status` - `WebhookStatus!`	The status of a webhook.
`updatedAt` - `DateTime`	The date and time of the last webhook update.

Example

{
  "destination": "xyz789",
  "clientId": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "eventFilters": [WebhookEventFilter],
  "id": "4",
  "scope": "xyz789",
  "status": "ACTIVE",
  "updatedAt": "2007-12-03T10:15:30Z"
}

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

Types

FileUploadSharedProductModifier

Description

File upload shared product modifier.

Fields

Field Name	Description
`overridesForLocale` - `FileUploadSharedProductModifierForLocale`	Overrides for a file upload shared product modifier in a channel locale.
Arguments `localeContext` - `ProductOverridesLocaleContextInput!` The channel and locale that apply when you override or retrieve shared product modifiers from a channel locale.
`id` - `ID!`	ID of the shared product modifier.
`displayName` - `String!`	Display name for the shared product modifier.
`isRequired` - `Boolean!`	Indicates whether the shared product modifier is required.

Example

{
  "overridesForLocale": FileUploadSharedProductModifierForLocale,
  "id": 4,
  "displayName": "xyz789",
  "isRequired": false
}

Types

FileUploadSharedProductModifierForLocale

Description

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

Fields

Field Name	Description
`displayName` - `String`	Display name for the shared product modifier.

Example

{"displayName": "abc123"}

Types

Float

Description

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

Example

123.45

Types

HttpsWebhook

Description

An https webhook.

Fields

Field Name	Description
`destination` - `String!`	URL must be active, return a 200 response, and be served on port 443.
`headers` - `[HttpsWebhookHeader!]!`	You can pass custom headers to validate webhooks being returned.
`clientId` - `String!`	ID of client application owning the webhook.
`createdAt` - `DateTime`	The date and time of webhook creation.
`eventFilters` - `[WebhookEventFilter!]!`	Event filters for webhook.
`id` - `ID!`	The ID of a webhook object.
`scope` - `String!`	The scope of the event subscription.
`status` - `WebhookStatus!`	The status of a webhook.
`updatedAt` - `DateTime`	The date and time of the last webhook update.

Example

{
  "destination": "xyz789",
  "headers": [HttpsWebhookHeader],
  "clientId": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "eventFilters": [WebhookEventFilter],
  "id": "4",
  "scope": "abc123",
  "status": "ACTIVE",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

HttpsWebhookHeader

Description

The HTTP header to include with webhook event messages.

Fields

Field Name	Description
`key` - `String!`	Name of the custom header.
`value` - `String!`	The input value of the returned webhook.

Example

{
  "key": "xyz789",
  "value": "xyz789"
}

Types

HttpsWebhookHeaderInput

Description

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

Fields

Input Field	Description
`key` - `String!`	The input key validates a returned webhook.
`value` - `String!`	The input value of the returned webhook.

Example

{
  "key": "abc123",
  "value": "xyz789"
}

Types

I18n

Description

Internationalization data.

Fields

Field Name	Description
`supportedLocales` - `SupportedLocaleConnection!`	List of supported locales.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{"supportedLocales": SupportedLocaleConnection}

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

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.
`createdAt` - `DateTime`	Date and time when the metafield was created.
`updatedAt` - `DateTime`	Date and time when the metafield was last updated.
`node` - `MetafieldsNodeType`	The specific data or value stored within a metafield, representing additional information about an associated resource.

Example

{
  "id": 4,
  "description": "abc123",
  "key": "abc123",
  "namespace": "abc123",
  "permissionSet": "APP_ONLY",
  "resourceId": 4,
  "value": "xyz789",
  "ownerClientId": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "node": Product
}

Types

MetafieldLimitExceededError

Description

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

Fields

Field Name	Description
`limit` - `Int!`	The maximum number of metafields allowed.
`message` - `String!`	Information about error.

Example

{"limit": 987, "message": "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

MetafieldsFiltersForResourceInput

Fields

Input Field	Description
`namespace` - `String`	The namespace used to group metafields.
`createdAt` - `DateFiltersInput`	The creation timestamp used to filter metafields based on when they were created.
`updatedAt` - `DateFiltersInput`	The update timestamp used to filter metafields based on when they were last modified.

Example

{
  "namespace": "abc123",
  "createdAt": DateFiltersInput,
  "updatedAt": DateFiltersInput
}

Types

MetafieldsFiltersInput

Fields

Input Field	Description
`namespace` - `String`	Namespace for the metafield.
`createdAt` - `DateFiltersInput`	Filter by create date of the metafield.
`updatedAt` - `DateFiltersInput`	Filter by update date of 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",
  "createdAt": DateFiltersInput,
  "updatedAt": DateFiltersInput,
  "resourceIds": ["4"],
  "resourceType": "BRAND"
}

Types

MetafieldsNodeType

Description

Represents the different types of nodes that can exist within a metafield structure. This union type is used to indicate the possible entities that can be associated with metafields.

Types

Union Types
`Product`

Example

Product

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": "abc123",
  "isRequired": true,
  "isShared": false
}

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

Types

MultilineTextFieldSharedProductModifier

Description

Multiline text field shared product modifier.

Fields

Field Name	Description
`defaultValue` - `String`	Default value for the shared product modifier.
`overridesForLocale` - `MultilineTextFieldSharedProductModifierForLocale`	Overrides for the multiline text field shared product modifier in a channel locale.
Arguments `localeContext` - `ProductOverridesLocaleContextInput!` The channel and locale that apply when you override or retrieve shared product modifiers from a channel locale.
`id` - `ID!`	ID of the shared product modifier.
`displayName` - `String!`	Display name for the shared product modifier.
`isRequired` - `Boolean!`	Indicates whether the shared product modifier is required.

Example

{
  "defaultValue": "abc123",
  "overridesForLocale": MultilineTextFieldSharedProductModifierForLocale,
  "id": "4",
  "displayName": "xyz789",
  "isRequired": false
}

Types

MultilineTextFieldSharedProductModifierForLocale

Description

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

Fields

Field Name	Description
`defaultValue` - `String`	Default value for the shared product modifier.
`displayName` - `String`	Display name for the shared product modifier.

Example

{
  "defaultValue": "abc123",
  "displayName": "xyz789"
}

Types

Node

Description

An object with an ID.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.

Possible Types

Node Types
`Channel`
`EventBridgeWebhook`
`HttpsWebhook`
`PubSubWebhook`

Example

{"id": 4}

Types

NotAuthorizedFieldToUpdateMetafieldFieldError

Description

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

Fields

Field Name	Description
`message` - `String!`	Information about error.

Example

{"message": "xyz789"}

Types

NotAuthorizedToDeleteMetafieldError

Description

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

Fields

Field Name	Description
`message` - `String!`	Information about error.

Example

{"message": "xyz789"}

Types

NotAuthorizedToUpdateMetafieldError

Description

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

Fields

Field Name	Description
`message` - `String!`	Information about error.

Example

{"message": "xyz789"}

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

Types

NumbersOnlyTextFieldSharedProductModifier

Description

Numbers-only text field shared product modifier.

Fields

Field Name	Description
`defaultValue` - `Float`	Default value for the shared product modifier.
`overridesForLocale` - `NumbersOnlyTextFieldSharedProductModifierForLocale`	Overrides for the shared product modifier in a channel locale.
Arguments `localeContext` - `ProductOverridesLocaleContextInput!` The channel and locale that apply when you override or retrieve shared product modifiers from a channel locale.
`id` - `ID!`	ID of the shared product modifier.
`displayName` - `String!`	Display name for the shared product modifier.
`isRequired` - `Boolean!`	Indicates whether the shared product modifier is required.

Example

{
  "defaultValue": 123.45,
  "overridesForLocale": NumbersOnlyTextFieldSharedProductModifierForLocale,
  "id": 4,
  "displayName": "xyz789",
  "isRequired": true
}

Types

NumbersOnlyTextFieldSharedProductModifierForLocale

Description

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

Fields

Field Name	Description
`defaultValue` - `Float`	Default value for the shared product modifier.
`displayName` - `String`	Display name for the shared product modifier.

Example

{
  "defaultValue": 987.65,
  "displayName": "xyz789"
}

Types

PageEntityRedirect

Description

Redirect to page.

Fields

Field Name	Description
`pageId` - `ID!`	The ID of the object.

Example

{"pageId": 4}

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

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

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": "abc123",
  "isRequired": true,
  "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": "xyz789",
  "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": "abc123"}

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.
`urlPath` - `ProductUrlPath!`	Product path.
`overridesForLocale` - `ProductOverridesForLocale`	Overrides for the product in a channel locale.
Arguments `localeContext` - `ProductOverridesLocaleContextInput!` The channel and locale that apply when you override or retrieve product information from a channel locale.
`overridesForChannel` - `ProductOverridesForChannel`	Product overrides for a specific channel.
Arguments `channelId` - `ID!` Channel ID.
`seoInformation` - `ProductSeoInformation!`	Product SEO information.
`storefrontDetails` - `StorefrontDetails!`	Product storefront details.
`preOrderSettings` - `PreOrderSettings!`	Product pre-order settings.
`customFields` - `ProductCustomFieldConnection!`	List of product custom fields.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`options` - `ProductOptionConnection!`	List of product options.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`modifiers` - `ProductModifierConnection!`	List of product modifiers.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`metafields` - `MetafieldsConnection!`	A collection of metafields associated with the product.
Arguments `filters` - `MetafieldsFiltersForResourceInput` `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`images` - `ProductImageConnection!`	List of product images.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int` `filters` - `ProductImagesFiltersInput` `sort` - `ProductImagesSortInput`
`imagesOverrides` - `ProductImagesOverridesItemConnection!`	List of product images overrides.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int` `filters` - `ProductImagesFiltersInput` `sort` - `ProductImagesSortInput` `context` - `ProductImagesOverridesContextInput!`

Example

{
  "id": 4,
  "basicInformation": ProductBasicInformation,
  "isFeatured": false,
  "urlPath": ProductUrlPath,
  "overridesForLocale": ProductOverridesForLocale,
  "overridesForChannel": ProductOverridesForChannel,
  "seoInformation": ProductSeoInformation,
  "storefrontDetails": StorefrontDetails,
  "preOrderSettings": PreOrderSettings,
  "customFields": ProductCustomFieldConnection,
  "options": ProductOptionConnection,
  "modifiers": ProductModifierConnection,
  "metafields": MetafieldsConnection,
  "images": ProductImageConnection,
  "imagesOverrides": ProductImagesOverridesItemConnection
}

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

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

ProductCustomField

Description

A product custom field.

Fields

Field Name	Description
`id` - `ID!`	The ID of the product custom field.
`name` - `String!`	Name of a product custom field.
`value` - `String!`	The value of a product custom field.
`overrides` - `ProductCustomFieldOverridesConnection!`	Overrides for product custom fields in a storefront channel locale.
Arguments `context` - `ProductCustomFieldOverridesContextInput` The storefront channel and locale that apply when you override or retrieve product custom fields from a channel locale. `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{
  "id": 4,
  "name": "xyz789",
  "value": "xyz789",
  "overrides": ProductCustomFieldOverridesConnection
}

Types

ProductCustomFieldConnection

Description

A connection to a list of product custom fields.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[ProductCustomFieldEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [ProductCustomFieldEdge]
}

Types

ProductCustomFieldEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `ProductCustomField!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": ProductCustomField,
  "cursor": "xyz789"
}

Types

ProductCustomFieldOverrides

Description

Overrides for product custom fields in a storefront channel locale.

Types

Union Types
`ProductCustomFieldOverridesForChannelLocale`

Example

ProductCustomFieldOverridesForChannelLocale

Types

ProductCustomFieldOverridesConnection

Description

A connection to a list of items.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[ProductCustomFieldOverridesEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [ProductCustomFieldOverridesEdge]
}

Types

ProductCustomFieldOverridesContextInput

Description

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

Fields

Input Field	Description
`channelId` - `ID`	Storefront channel ID.
`locale` - `String`	Locale in a storefront channel.

Example

{"channelId": 4, "locale": "abc123"}

Types

ProductCustomFieldOverridesEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `ProductCustomFieldOverrides!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": ProductCustomFieldOverridesForChannelLocale,
  "cursor": "xyz789"
}

Types

ProductCustomFieldOverridesForChannelLocale

Description

Overrides for product custom fields in a storefront channel locale.

Fields

Field Name	Description
`name` - `String`	Name of a product custom field in a storefront channel locale.
`value` - `String`	Value of a product custom field in a storefront channel locale.
`isVisible` - `Boolean`	Indicates whether a custom field is visible in a storefront channel locale.
`context` - `ChannelLocaleContext!`	The storefront channel and locale that apply when you override or retrieve product custom fields from a channel locale.

Example

{
  "name": "xyz789",
  "value": "abc123",
  "isVisible": false,
  "context": ChannelLocaleContext
}

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

Types

ProductEntityRedirect

Description

Redirect to product.

Fields

Field Name	Description
`productId` - `ID!`	The ID of the object.

Example

{"productId": "4"}

Types

ProductImage

Description

A product image.

Fields

Field Name	Description
`id` - `ID!`	The ID of the product image.
`altText` - `String`	The image description.
`isThumbnail` - `Boolean!`	Indicates whether the image is a thumbnail.
`sortOrder` - `Long!`	The order number of the image.
`dateCreated` - `String!`	The date the image was created.
`dateModified` - `String!`	The date the image was modified.
`imageFile` - `String!`	The image file name.
`urlZoom` - `String!`	The URL of the zoom image.
`urlStandard` - `String!`	The URL of the standard image.
`addedToProduct` - `Boolean!`	Indicates whether the image is added to the product and displayed on storefront.
`overrides` - `ProductImagesOverridesConnection!`	Collection of image overrides for a product in a context of channel and locale.
Arguments `context` - `ProductImagesOverridesInput` Filter by channel or locale. `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{
  "id": 4,
  "altText": "xyz789",
  "isThumbnail": true,
  "sortOrder": {},
  "dateCreated": "xyz789",
  "dateModified": "xyz789",
  "imageFile": "xyz789",
  "urlZoom": "xyz789",
  "urlStandard": "abc123",
  "addedToProduct": true,
  "overrides": ProductImagesOverridesConnection
}

Types

ProductImageConnection

Description

A connection to a list of images.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[ProductImageEdge]`	A list of edges.
`collectionInfo` - `CollectionInfo`	Information about the collection.

Example

{
  "pageInfo": PageInfo,
  "edges": [ProductImageEdge],
  "collectionInfo": CollectionInfo
}

Types

ProductImageEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `ProductImage!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": ProductImage,
  "cursor": "xyz789"
}

Types

ProductImageSortFieldInput

Description

The sort field for product images.

Values

Enum Value	Description
`DATE_CREATED`	Sort by the date the image was created.
`ID`	Sort by the image ID.
`SORT_ORDER`	Sort by the order number of the image.

Example

"DATE_CREATED"

Types

ProductImagesFiltersInput

Fields

Input Field	Description
`ids` - `[ID!]`	The unique identifier for the resource with which the product image is associated.
`addedToProduct` - `Boolean`	Indicates whether the image is added to the product and displayed on storefront.

Example

{"ids": ["4"], "addedToProduct": false}

Types

ProductImagesOverrides

Description

Collection of image overrides for a product in a context of channel and locale.

Types

Union Types
`ProductImagesOverridesForChannelLocale`

Example

ProductImagesOverridesForChannelLocale

Types

ProductImagesOverridesConnection

Description

A connection to a list of image overrides.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[ProductImagesOverridesEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [ProductImagesOverridesEdge]
}

Types

ProductImagesOverridesContextInput

Description

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

Fields

Input Field	Description
`channelId` - `ID!`	Storefront channel ID.
`locale` - `String!`	Locale in a storefront channel.

Example

{
  "channelId": "4",
  "locale": "abc123"
}

Types

ProductImagesOverridesEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `ProductImagesOverrides!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": ProductImagesOverridesForChannelLocale,
  "cursor": "abc123"
}

Types

ProductImagesOverridesForChannelLocale

Description

Overrides for product images in a context of channel and locale.

Fields

Field Name	Description
`context` - `ChannelLocaleContext!`	The storefront channel and locale that apply when you override or retrieve product images from a channel locale.
`altText` - `String`	Override of the image description.
`isThumbnail` - `Boolean`	Override of indicator whether the image is a thumbnail.
`sortOrder` - `Long`	Override of the image sort order.
`addedToProduct` - `Boolean`	Override of the image sort order.

Example

{
  "context": ChannelLocaleContext,
  "altText": "abc123",
  "isThumbnail": false,
  "sortOrder": {},
  "addedToProduct": false
}

Types

ProductImagesOverridesInput

Description

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

Fields

Input Field	Description
`channelId` - `ID`	Storefront channel ID.
`locale` - `String`	Locale in a storefront channel.

Example

{
  "channelId": "4",
  "locale": "xyz789"
}

Types

ProductImagesOverridesItem

Description

A product image override.

Fields

Field Name	Description
`id` - `ID!`	The ID of the product image.
`altText` - `String`	The image description.
`isThumbnail` - `Boolean!`	Indicates whether the image is a thumbnail.
`sortOrder` - `Long!`	The order number of the image.
`dateCreated` - `String!`	The date the image was created.
`dateModified` - `String!`	The date the image was modified.
`imageFile` - `String!`	The image file name.
`urlZoom` - `String!`	The URL of the zoom image.
`urlStandard` - `String!`	The URL of the standard image.
`addedToProduct` - `Boolean!`	Indicates whether the image is added to the product and displayed on storefront.

Example

{
  "id": 4,
  "altText": "abc123",
  "isThumbnail": false,
  "sortOrder": {},
  "dateCreated": "abc123",
  "dateModified": "abc123",
  "imageFile": "abc123",
  "urlZoom": "abc123",
  "urlStandard": "abc123",
  "addedToProduct": false
}

Types

ProductImagesOverridesItemConnection

Description

A connection to a list of images.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[ProductImagesOverridesItemEdge]`	A list of edges.
`collectionInfo` - `CollectionInfo`	Information about the collection.

Example

{
  "pageInfo": PageInfo,
  "edges": [ProductImagesOverridesItemEdge],
  "collectionInfo": CollectionInfo
}

Types

ProductImagesOverridesItemEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `ProductImagesOverridesItem!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": ProductImagesOverridesItem,
  "cursor": "abc123"
}

Types

ProductImagesSortInput

Description

The sort field for product images.

Fields

Input Field	Description
`field` - `ProductImageSortFieldInput`	The sort field for product images.
`direction` - `SortDirectionInput`	The sort direction for product images.

Example

{"field": "DATE_CREATED", "direction": "ASC"}

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

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 storefront channel locale.
Arguments `input` - `RemoveProductCustomFieldsOverridesInput!`
`updateProductCustomFields` - `UpdateProductCustomFieldsResult`	Updates product's custom fields.
Arguments `input` - `UpdateProductCustomFieldsInput!`
`addImagesToProduct` - `AddImagesToProductResult`	Adds images to a product.
Arguments `input` - `AddImagesToProductInput!`
`removeImagesFromProduct` - `RemoveImagesFromProductResult`	Removes images from a product images collection.
Arguments `input` - `RemoveImagesFromProductInput!`
`updateProductImageProperties` - `UpdateProductImagePropertiesResult`	Updates product images.
Arguments `input` - `UpdateProductImagePropertiesInput!`
`removeProductImagePropertiesOverrides` - `RemoveProductImagePropertiesOverridesResult`	Removes overrides for product images in a channel locale.
Arguments `input` - `RemoveProductImagePropertiesOverridesInput!`

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,
  "updateProductCustomFields": UpdateProductCustomFieldsResult,
  "addImagesToProduct": AddImagesToProductResult,
  "removeImagesFromProduct": RemoveImagesFromProductResult,
  "updateProductImageProperties": UpdateProductImagePropertiesResult,
  "removeProductImagePropertiesOverrides": RemoveProductImagePropertiesOverridesResult
}

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

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

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

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

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

PubSubNoPermissionToPublishError

Description

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

Fields

Field Name	Description
`topic` - `String!`	Google Cloud Pub/Sub topic name.
`message` - `String!`	Information about error.

Example

{
  "topic": "xyz789",
  "message": "xyz789"
}

Types

PubSubTopicNotFoundError

Description

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

Fields

Field Name	Description
`topic` - `String!`	Google Cloud Pub/Sub topic name.
`message` - `String!`	Information about error.

Example

{
  "topic": "xyz789",
  "message": "xyz789"
}

Types

PubSubWebhook

Description

A Google Cloud PubSub webhook.

Fields

Field Name	Description
`destination` - `String!`	The Google Cloud PubSub topic that’s been enabled with Publisher permissions. See the PubSub config narrative page and https://cloud.google.com/pubsub/docs/create-topic#resource_names for more info.
`clientId` - `String!`	ID of client application owning the webhook.
`createdAt` - `DateTime`	The date and time of webhook creation.
`eventFilters` - `[WebhookEventFilter!]!`	Event filters for webhook.
`id` - `ID!`	The ID of a webhook object.
`scope` - `String!`	The scope of the event subscription.
`status` - `WebhookStatus!`	The status of a webhook.
`updatedAt` - `DateTime`	The date and time of the last webhook update.

Example

{
  "destination": "xyz789",
  "clientId": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "eventFilters": [WebhookEventFilter],
  "id": "4",
  "scope": "abc123",
  "status": "ACTIVE",
  "updatedAt": "2007-12-03T10:15:30Z"
}

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

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": true,
  "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": "xyz789",
  "isShared": true,
  "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": "abc123"}

Types

RadioButtonsSharedProductModifier

Description

Radio buttons shared product modifier.

Fields

Field Name	Description
`overridesForLocale` - `RadioButtonsSharedProductModifierForLocale`	Overrides for radio buttons shared product modifiers in a channel locale.
Arguments `localeContext` - `ProductOverridesLocaleContextInput!` The channel and locale that apply when you override or retrieve shared product modifiers from a channel locale.
`values` - `[RadioButtonsSharedProductModifierValue!]!`	Radio buttons shared product modifier values.
`id` - `ID!`	ID of the shared product modifier.
`displayName` - `String!`	Display name for the shared product modifier.
`isRequired` - `Boolean!`	Indicates whether the shared product modifier is required.

Example

{
  "overridesForLocale": RadioButtonsSharedProductModifierForLocale,
  "values": [RadioButtonsSharedProductModifierValue],
  "id": "4",
  "displayName": "abc123",
  "isRequired": false
}

Types

RadioButtonsSharedProductModifierForLocale

Description

Overrides for radio buttons shared product modifiers in a channel locale.

Fields

Field Name	Description
`displayName` - `String`	Display name for the shared product modifier.
`values` - `[RadioButtonsSharedProductModifierValueForLocale!]!`	Shared product modifier values.

Example

{
  "displayName": "abc123",
  "values": [
    RadioButtonsSharedProductModifierValueForLocale
  ]
}

Types

RadioButtonsSharedProductModifierValue

Description

Radio buttons shared product modifier value.

Fields

Field Name	Description
`id` - `ID!`	ID of the shared product modifier value.
`isDefault` - `Boolean!`	Indicates whether the shared product modifier value is selected by default.
`label` - `String!`	Label for the shared product modifier value.

Example

{
  "id": "4",
  "isDefault": false,
  "label": "xyz789"
}

Types

RadioButtonsSharedProductModifierValueForLocale

Description

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

Fields

Field Name	Description
`id` - `ID!`	ID of the shared product modifier.
`label` - `String!`	Label for the shared product modifier.

Example

{"id": 4, "label": "abc123"}

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

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

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

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

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": "xyz789",
  "isRequired": true,
  "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": "abc123",
  "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": "xyz789",
  "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": "abc123",
  "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": false,
  "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 product modifier in a channel locale.
Arguments `localeContext` - `ProductOverridesLocaleContextInput!` The channel and locale that apply when you override or retrieve shared product modifiers from a channel locale.
`values` - `[RectangleListSharedProductModifierValue!]!`	Rectangle list shared product modifiers values.
`id` - `ID!`	ID of the shared product modifier.
`displayName` - `String!`	Display name for the shared product modifier.
`isRequired` - `Boolean!`	Indicates whether the shared product modifier is required.

Example

{
  "overridesForLocale": RectangleListSharedProductModifierForLocale,
  "values": [RectangleListSharedProductModifierValue],
  "id": "4",
  "displayName": "xyz789",
  "isRequired": false
}

Types

RectangleListSharedProductModifierForLocale

Description

Overrides for rectangle list shared product modifiers in a channel locale.

Fields

Field Name	Description
`displayName` - `String`	Display name for the shared product modifier.
`values` - `[RectangleListSharedProductModifierValueForLocale!]!`	Shared product 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": true,
  "label": "xyz789"
}

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 product modifier value.
`label` - `String!`	Rectangle list shared product modifier value label override for a channel locale.

Example

{
  "id": "4",
  "label": "xyz789"
}

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

RemoveImagesFromProductInput

Fields

Input Field	Description
`productId` - `ID!`	The ID of the product.
`context` - `ChannelLocaleContextInput`	The storefront channel and locale that apply when you override or retrieve product images from a channel locale.
`ids` - `[ID!]!`	The unique identifier for the resource with which the product image is associated.

Example

{
  "productId": "4",
  "context": ChannelLocaleContextInput,
  "ids": ["4"]
}

Types

RemoveImagesFromProductResult

Fields

Field Name	Description
`images` - `ProductImageConnection`	The images list with added and removed images.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{"images": ProductImageConnection}

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

The attributes of a custom field that you want to remove from an override.

Values

Enum Value	Description
`IS_VISIBLE`	The visibility flag of a custom field that you want to remove from an override.
`NAME`	The name of a custom field that you want to remove from an override.
`VALUE`	The value of a custom field that you want to remove from an override.

Example

"IS_VISIBLE"

Types

RemoveProductCustomFieldsOverridesChannelLocaleContextDataInput

Description

Input that removes overrides for product custom fields from a storefront channel locale.

Fields

Input Field	Description
`context` - `ChannelLocaleContextInput!`	The storefront channel and locale that apply when you remove overrides for product custom fields in a channel locale.
`attributes` - `[RemoveProductCustomFieldsOverridesAttribute!]`	The attributes of a custom field that you want to remove from an override.

Example

{
  "context": ChannelLocaleContextInput,
  "attributes": ["IS_VISIBLE"]
}

Types

RemoveProductCustomFieldsOverridesDataInput

Description

Input that removes overrides for product custom fields from a storefront channel locale.

Fields

Input Field	Description
`customFieldId` - `ID!`	ID of the custom field that has overrides you want to remove.
`channelLocaleContextData` - `RemoveProductCustomFieldsOverridesChannelLocaleContextDataInput!`	The data that applies when you remove overrides for product custom fields in a storefront channel locale.

Example

{
  "customFieldId": "4",
  "channelLocaleContextData": RemoveProductCustomFieldsOverridesChannelLocaleContextDataInput
}

Types

RemoveProductCustomFieldsOverridesInput

Fields

Input Field	Description
`productId` - `ID!`	ID of the product that has the custom field overrides you want to remove.
`data` - `[RemoveProductCustomFieldsOverridesDataInput!]!`

Example

{
  "productId": "4",
  "data": [RemoveProductCustomFieldsOverridesDataInput]
}

Types

RemoveProductCustomFieldsOverridesResult

Fields

Field Name	Description
`product` - `Product`	The product that has the custom field overrides that you removed.

Example

{"product": Product}

Types

RemoveProductImagePropertiesOverridesContextsInput

Description

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

Fields

Input Field	Description
`channelLocaleContext` - `ChannelLocaleContextInput`	The storefront channel and locale that apply when you override or retrieve product images from a channel locale.

Example

{"channelLocaleContext": ChannelLocaleContextInput}

Types

RemoveProductImagePropertiesOverridesDataInput

Description

The input data for removing product images in contexts.

Fields

Input Field	Description
`imageId` - `ID!`	The ID of the product image.
`contexts` - `[RemoveProductImagePropertiesOverridesContextsInput!]!`	The input data for removing product images in contexts.

Example

{
  "imageId": 4,
  "contexts": [
    RemoveProductImagePropertiesOverridesContextsInput
  ]
}

Types

RemoveProductImagePropertiesOverridesInput

Fields

Input Field	Description
`productId` - `ID!`	The ID of the product.
`data` - `[RemoveProductImagePropertiesOverridesDataInput!]!`

Example

{
  "productId": "4",
  "data": [RemoveProductImagePropertiesOverridesDataInput]
}

Types

RemoveProductImagePropertiesOverridesResult

Fields

Field Name	Description
`images` - `ProductImageConnection`	The images list with added and removed images.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{"images": ProductImageConnection}

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 product 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!`	Shared 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 product modifiers.
`dateField` - `RemoveSharedDateFieldProductModifierOverridesInput`	Overrides for date field shared product modifiers.
`dropdown` - `RemoveSharedDropdownProductModifierOverridesInput`	Overrides for dropdown shared product modifiers.
`fileUpload` - `RemoveSharedFileUploadProductModifierOverridesInput`	Overrides for file upload shared product modifiers.
`multiLineTextField` - `RemoveSharedMultiLineTextFieldProductModifierOverridesInput`	Overrides for multiline text field shared product modifiers.
`numberField` - `RemoveSharedNumberFieldProductModifierOverridesInput`	Overrides for number field shared product modifiers.
`radioButtons` - `RemoveSharedRadioButtonsProductModifierOverridesInput`	Overrides for radio button shared product modifiers.
`rectangleList` - `RemoveSharedRectangleListProductModifierOverridesInput`	Overrides for rectangle list shared product modifiers.
`swatch` - `RemoveSharedSwatchProductModifierOverridesInput`	Overrides for swatch shared product modifiers.
`textField` - `RemoveSharedTextFieldProductModifierOverridesInput`	Overrides for text field shared product 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 product 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

ScopeChangeNotAllowedError

Description

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

Fields

Field Name	Description
`message` - `String!`	Information about error.

Example

{"message": "xyz789"}

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

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

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

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

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

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

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

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

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

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

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

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

Types

SetSharedProductModifierInformationDataInput

Description

Input that sets information for shared product modifiers.

Fields

Input Field	Description
`modifiers` - `[SetSharedProductModifierInformationInput!]!`	Shared product modifiers that you want to set.

Example

{"modifiers": [SetSharedProductModifierInformationInput]}

Types

SetSharedProductModifierInformationInput

Description

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

Fields

Input Field	Description
`modifierId` - `ID!`	ID of the shared product 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 product modifier information you want to set. You can only use one type of modifier in a request.

Fields

Input Field	Description
`checkbox` - `SetSharedCheckboxProductModifierInformationInput`	Checkbox shared product modifier information.
`dateField` - `SetSharedDateFieldProductModifierInformationInput`	Date field shared product modifier information.
`dropdown` - `SetSharedDropdownProductModifierInformationInput`	Dropdown shared product modifier information.
`fileUpload` - `SetSharedFileUploadProductModifierInformationInput`	File upload shared product modifier information.
`multiLineTextField` - `SetSharedMultiLineTextFieldProductModifierInformationInput`	Multiline text field shared product modifier information.
`numberField` - `SetSharedNumberFieldProductModifierInformationInput`	Number field shared product modifier information.
`radioButtons` - `SetSharedRadioButtonsProductModifierInformationInput`	Radio buttons shared product modifier information.
`rectangleList` - `SetSharedRectangleListProductModifierInformationInput`	Rectangle list shared product modifier information.
`swatch` - `SetSharedSwatchProductModifierInformationInput`	Swatch shared product modifier information.
`textField` - `SetSharedTextFieldProductModifierInformationInput`	Text field shared 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 product 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 product modifiers.

Fields

Field Name	Description
`sharedProductModifiers` - `[SharedProductModifier!]`	List of shared product 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": "abc123",
  "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": "xyz789"
}

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

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

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

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

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

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

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

Types

SharedProductModifier

Description

Shared product modifier.

Fields

Field Name	Description
`id` - `ID!`	ID of the shared product modifier.
`displayName` - `String!`	Display name for the shared product modifier.
`isRequired` - `Boolean!`	Indicates whether the shared product modifier is required.

Possible Types

SharedProductModifier Types
`CheckboxSharedProductModifier`
`DateFieldSharedProductModifier`
`DropdownSharedProductModifier`
`FileUploadSharedProductModifier`
`MultilineTextFieldSharedProductModifier`
`NumbersOnlyTextFieldSharedProductModifier`
`RadioButtonsSharedProductModifier`
`RectangleListSharedProductModifier`
`SwatchSharedProductModifier`
`TextFieldSharedProductModifier`

Example

{
  "id": "4",
  "displayName": "abc123",
  "isRequired": false
}

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 product modifiers.

Example

{"ids": [4]}

Types

SharedProductModifiersMutations

Description

Shared product modifier mutations.

Fields

Field Name	Description
`setSharedProductModifiersInformation` - `SetSharedProductModifiersInformationResult`	Sets information for shared product modifiers.
Arguments `input` - `SetSharedProductModifiersInformationInput!`
`removeSharedProductModifiersOverrides` - `RemoveSharedProductModifiersOverridesResult`	Remove overrides for shared product 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": "abc123"
}

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

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

Site

Description

Site information.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.
`createdAt` - `DateTime!`	Time when site was created.
`redirects` - `SiteRedirectConnection!`	Site's redirects.
Arguments `filters` - `SiteRedirectsFiltersInput` Filters for redirects. `sort` - `SiteRedirectsSortInput` Sorter for redirects. `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`
`updatedAt` - `DateTime!`	Time when site was updated last time.
`urls` - `SiteUrls!`	Site urls.

Example

{
  "id": 4,
  "createdAt": "2007-12-03T10:15:30Z",
  "redirects": SiteRedirectConnection,
  "updatedAt": "2007-12-03T10:15:30Z",
  "urls": SiteUrls
}

Types

SiteCanonicalUrl

Description

Canonical Url.

Fields

Field Name	Description
`createdAt` - `DateTime!`	Time url was created at.
`updatedAt` - `DateTime!`	Time url was updated at.
`url` - `String!`	Url of the site.

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "url": "abc123"
}

Types

SiteCheckoutUrl

Description

Checkout Url.

Fields

Field Name	Description
`createdAt` - `DateTime!`	Time url was created at.
`isCustomized` - `Boolean!`	Whether url is customized.
`updatedAt` - `DateTime!`	Time url was updated at.
`url` - `String!`	Url of the site.

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "isCustomized": true,
  "updatedAt": "2007-12-03T10:15:30Z",
  "url": "xyz789"
}

Types

SiteManualRedirect

Description

Redirect to manually input url.

Fields

Field Name	Description
`url` - `String!`	Url.

Example

{"url": "abc123"}

Types

SitePrimaryUrl

Description

Primary Url.

Fields

Field Name	Description
`createdAt` - `DateTime!`	Time url was created at.
`updatedAt` - `DateTime!`	Time url was updated at.
`url` - `String!`	Url of the site.

Example

{
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "url": "abc123"
}

Types

SiteRedirect

Description

Site's redirect.

Fields

Field Name	Description
`id` - `ID!`	The ID of the object.
`fromPath` - `String!`	Redirected url.
`to` - `SiteRedirectTo`	Additional information about redirect.
`toUrl` - `String!`	Full destination URL for the redirect.

Example

{
  "id": "4",
  "fromPath": "xyz789",
  "to": SiteManualRedirect,
  "toUrl": "abc123"
}

Types

SiteRedirectConnection

Description

A connection to a list of items.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[SiteRedirectEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [SiteRedirectEdge]
}

Types

SiteRedirectEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `SiteRedirect!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": SiteRedirect,
  "cursor": "xyz789"
}

Types

SiteRedirectTo

Description

Type of the redirect.

Types

Union Types
`SiteManualRedirect`
`ProductEntityRedirect`
`BrandEntityRedirect`
`CategoryEntityRedirect`
`BlogPostEntityRedirect`
`PageEntityRedirect`

Example

SiteManualRedirect

Types

SiteRedirectsFiltersInput

Description

Filters for redirects

Fields

Input Field	Description
`fromPath` - `String`	Filter redirects based on given fromPath. Finds exact matches only.
`ids` - `[ID!]`	Filter items by a comma-separated list of redirect ids.
`searchTerm` - `String`	Filters redirects by the specified keyword. Will only search from the beginning of a URL path.

Example

{
  "fromPath": "abc123",
  "ids": ["4"],
  "searchTerm": "xyz789"
}

Types

SiteRedirectsSortInput

Description

Sorting by field.

Values

Enum Value	Description
`FIELD_TYPE`	Sorting by field type.
`FROM_PATH`	Sorting by fromPath field.

Example

"FIELD_TYPE"

Types

SiteUrls

Description

Site urls

Fields

Field Name	Description
`canonicalUrl` - `SiteCanonicalUrl!`	Canonical url of the site.
`checkoutUrl` - `SiteCheckoutUrl!`	Checkout url of the site.
`primaryUrl` - `SitePrimaryUrl!`	Primary url of the site.

Example

{
  "canonicalUrl": SiteCanonicalUrl,
  "checkoutUrl": SiteCheckoutUrl,
  "primaryUrl": SitePrimaryUrl
}

Types

SortDirectionInput

Description

The sort direction for collections.

Values

Enum Value	Description
`ASC`	Ascending sort direction.
`DESC`	Descending sort direction.

Example

"ASC"

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`
`channel` - `Channel`	A channel.
Arguments `id` - `ID!` The ID of the object.
`channels` - `ChannelsConnection!`	List of channels.
Arguments `filters` - `ChannelsFiltersInput` `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.
`webhook` - `Webhook`	Webhook fetch request.
Arguments `id` - `ID!` The ID of the object.
`webhooks` - `WebhooksConnection!`	Webhooks list fetch request.
Arguments `filters` - `WebhookFiltersInput` `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{
  "account": Account,
  "appExtensions": AppExtensionsConnection,
  "channel": Channel,
  "channels": ChannelsConnection,
  "id": 4,
  "metafield": Metafield,
  "metafields": MetafieldsConnection,
  "product": Product,
  "products": ProductConnection,
  "settings": StoreSettings,
  "sharedProductModifiers": SharedProductModifierConnection,
  "sharedProductOptions": SharedProductOptionConnection,
  "storeHash": "abc123",
  "storeReferenceId": "xyz789",
  "webhook": Webhook,
  "webhooks": WebhooksConnection
}

Types

StoreSettings

Description

Store settings.

Fields

Field Name	Description
`dataSolutions` - `DataSolutionsSettings!`	Data solutions.
`storeName` - `String!`	Store name.
`webhooks` - `WebhooksSettings!`	Webhooks store settings.

Example

{
  "dataSolutions": DataSolutionsSettings,
  "storeName": "xyz789",
  "webhooks": WebhooksSettings
}

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

"abc123"

Types

SupportedLocale

Description

A locale supported by the system.

Fields

Field Name	Description
`code` - `String!`	The code of the locale.
`englishName` - `String!`	The English name of the locale.
`hasBuiltInTranslations` - `Boolean!`	Indicates if the locale has built-in translations.

Example

{
  "code": "abc123",
  "englishName": "abc123",
  "hasBuiltInTranslations": false
}

Types

SupportedLocaleConnection

Description

A connection to a list of supported locales.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[SupportedLocaleEdge]`	A list of edges.

Example

{
  "pageInfo": PageInfo,
  "edges": [SupportedLocaleEdge]
}

Types

SupportedLocaleEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `SupportedLocale!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": SupportedLocale,
  "cursor": "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": true,
  "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": "xyz789",
  "isRequired": false,
  "isShared": false
}

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

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 product 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 product modifiers from a channel locale.
`values` - `[SwatchSharedProductModifierValue!]!`	Shared product modifier values.
`id` - `ID!`	ID of the shared product modifier.
`displayName` - `String!`	Display name for the shared product modifier.
`isRequired` - `Boolean!`	Indicates whether the shared product modifier is required.

Example

{
  "overridesForLocale": SwatchSharedProductModifierForLocale,
  "values": [SwatchSharedProductModifierValue],
  "id": "4",
  "displayName": "xyz789",
  "isRequired": true
}

Types

SwatchSharedProductModifierForLocale

Description

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

Fields

Field Name	Description
`displayName` - `String`	Display name for the shared product modifier.
`values` - `[SwatchSharedProductModifierValueForLocale!]!`	Shared product modifier values.

Example

{
  "displayName": "xyz789",
  "values": [SwatchSharedProductModifierValueForLocale]
}

Types

SwatchSharedProductModifierValue

Description

Swatch shared product modifier value.

Fields

Field Name	Description
`id` - `ID!`	The ID of the shared product modifier value.
`isDefault` - `Boolean!`	Indicates whether the shared product modifier value is selected by default.
`label` - `String!`	Label for the shared product modifier value.

Example

{
  "id": 4,
  "isDefault": true,
  "label": "xyz789"
}

Types

SwatchSharedProductModifierValueForLocale

Description

Overrides for the swatch shared product modifier for a channel locale.

Fields

Field Name	Description
`id` - `ID!`	ID of the shared product modifier value.
`label` - `String!`	Label for the shared product 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": "xyz789",
  "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": "abc123",
  "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": "xyz789",
  "overridesForLocale": TextFieldProductModifierForLocale,
  "id": "4",
  "displayName": "xyz789",
  "isRequired": true,
  "isShared": true
}

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

Types

TextFieldSharedProductModifier

Description

Text field shared product modifier.

Fields

Field Name	Description
`defaultValue` - `String`	Text field shared product modifier default value.
`overridesForLocale` - `TextFieldSharedProductModifierForLocale`	Text field shared product modifier overrides for a channel locale.
Arguments `localeContext` - `ProductOverridesLocaleContextInput!` The channel and locale that apply when you override or retrieve shared product modifiers from a channel locale.
`id` - `ID!`	ID of the shared product modifier.
`displayName` - `String!`	Display name for the shared product modifier.
`isRequired` - `Boolean!`	Indicates whether the shared product modifier is required.

Example

{
  "defaultValue": "xyz789",
  "overridesForLocale": TextFieldSharedProductModifierForLocale,
  "id": 4,
  "displayName": "abc123",
  "isRequired": true
}

Types

TextFieldSharedProductModifierForLocale

Description

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

Fields

Field Name	Description
`defaultValue` - `String`	Default value for the shared product modifier.
`displayName` - `String`	Display name for the shared product modifier.

Example

{
  "defaultValue": "xyz789",
  "displayName": "abc123"
}

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

UpdateEventBridgeWebhookDataInput

Fields

Input Field	Description
`destination` - `String`	Amazon EventBridge source arn.
`eventFilters` - `[WebhookEventFilterUnionInput!]`	Event filters for webhook.
`isActive` - `Boolean`	If webhook is active or not.
`scope` - `String`	The scope of the event subscription.

Example

{
  "destination": "xyz789",
  "eventFilters": [WebhookEventFilterUnionInput],
  "isActive": false,
  "scope": "abc123"
}

Types

UpdateEventBridgeWebhookError

Description

Error object for update Amazon EventBridge webhook mutation.

Types

Union Types
`AlreadyExistsError`
`ValidationError`
`EntityNotFoundError`
`EventBridgeSourceNotFoundError`
`DestinationNotAllowedError`
`ScopeChangeNotAllowedError`
`WebhooksLimitPerClientScopeReachedError`

Example

AlreadyExistsError

Types

UpdateEventBridgeWebhookInput

Fields

Input Field	Description
`id` - `ID!`	The ID of an object.
`data` - `UpdateEventBridgeWebhookDataInput!`

Example

{
  "id": "4",
  "data": UpdateEventBridgeWebhookDataInput
}

Types

UpdateEventBridgeWebhookResult

Description

The result of mutation.

Fields

Field Name	Description
`webhook` - `EventBridgeWebhook`	The webhook that is updated as a result of mutation.
`errors` - `[UpdateEventBridgeWebhookError!]!`	The errors that occurred during the update Amazon EventBridge webhook mutation.

Example

{
  "webhook": EventBridgeWebhook,
  "errors": [AlreadyExistsError]
}

Types

UpdateHttpsWebhookDataInput

Fields

Input Field	Description
`destination` - `String`	URL must be active, return a 200 response, and be served on port 443.
`eventFilters` - `[WebhookEventFilterUnionInput!]`	Event filters for webhook.
`headers` - `[HttpsWebhookHeaderInput!]`	You can define any number of custom headers to be attached to the event sent to the destination URL.
`isActive` - `Boolean`	If webhook is active or not.
`scope` - `String`	The scope of the event subscription.

Example

{
  "destination": "xyz789",
  "eventFilters": [WebhookEventFilterUnionInput],
  "headers": [HttpsWebhookHeaderInput],
  "isActive": true,
  "scope": "abc123"
}

Types

UpdateHttpsWebhookError

Description

Error object for update HTTPS webhook mutation.

Types

Union Types
`AlreadyExistsError`
`ValidationError`
`EntityNotFoundError`
`DestinationNotAllowedError`
`ScopeChangeNotAllowedError`
`WebhooksLimitPerClientScopeReachedError`

Example

AlreadyExistsError

Types

UpdateHttpsWebhookInput

Fields

Input Field	Description
`id` - `ID!`	The ID of webhook to be updated.
`data` - `UpdateHttpsWebhookDataInput!`

Example

{
  "id": "4",
  "data": UpdateHttpsWebhookDataInput
}

Types

UpdateHttpsWebhookResult

Description

Result of mutation.

Fields

Field Name	Description
`webhook` - `HttpsWebhook`	The Webhook that is updated as a result of mutation.
`errors` - `[UpdateHttpsWebhookError!]!`	The errors that occurred during the update HTTPS webhook mutation.

Example

{
  "webhook": HttpsWebhook,
  "errors": [AlreadyExistsError]
}

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

UpdateMetafieldErrors

Description

Union type for all 'updateMetafield' mutation's errors.

Types

Union Types
`ValidationError`
`EntityNotFoundError`
`AlreadyExistsError`
`NotAuthorizedFieldToUpdateMetafieldFieldError`
`NotAuthorizedToUpdateMetafieldError`

Example

ValidationError

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.
`errors` - `[UpdateMetafieldErrors!]!`	The list of errors that occurred while updating a metafield.

Example

{
  "metafield": Metafield,
  "errors": [ValidationError]
}

Types

UpdateProductCustomFieldChannelLocaleOverridesInput

Description

Input that updates the overrides for product custom fields in a storefront channel locale.

Fields

Input Field	Description
`context` - `ChannelLocaleContextInput!`	The storefront channel and locale that apply when you update overrides for product custom fields in a channel locale.
`data` - `UpdateProductCustomFieldsChannelLocaleDataInput!`

Example

{
  "context": ChannelLocaleContextInput,
  "data": UpdateProductCustomFieldsChannelLocaleDataInput
}

Types

UpdateProductCustomFieldOverridesInput

Description

Input that updates the overrides for product custom fields in a storefront channel locale.

Fields

Input Field	Description
`channelLocaleOverrides` - `UpdateProductCustomFieldChannelLocaleOverridesInput`	The data that applies when you update overrides for product custom fields in a storefront channel locale.

Example

{
  "channelLocaleOverrides": UpdateProductCustomFieldChannelLocaleOverridesInput
}

Types

UpdateProductCustomFieldsChannelLocaleDataInput

Fields

Input Field	Description
`name` - `String`	Name of the product's custom field in a storefront channel locale.
`value` - `String`	Value of the product's custom field in a storefront channel locale.
`isVisible` - `Boolean`	Indicates whether the product custom field is visible in a storefront channel locale.

Example

{
  "name": "xyz789",
  "value": "xyz789",
  "isVisible": true
}

Types

UpdateProductCustomFieldsDataInput

Description

Input that updates information for product custom fields.

Fields

Input Field	Description
`customFieldId` - `ID!`	ID of a product's custom field.
`name` - `String`	Name of the product's custom field.
`value` - `String`	Value of a product's custom field.
`overrides` - `[UpdateProductCustomFieldOverridesInput!]`	Overrides for product custom fields in a storefront channel locale.

Example

{
  "customFieldId": 4,
  "name": "abc123",
  "value": "abc123",
  "overrides": [UpdateProductCustomFieldOverridesInput]
}

Types

UpdateProductCustomFieldsInput

Fields

Input Field	Description
`productId` - `ID!`	ID of the product that has the custom fields you want to update.
`data` - `[UpdateProductCustomFieldsDataInput!]!`

Example

{
  "productId": "4",
  "data": [UpdateProductCustomFieldsDataInput]
}

Types

UpdateProductCustomFieldsResult

Fields

Field Name	Description
`product` - `Product`	Result of updating product custom fields.

Example

{"product": Product}

Types

UpdateProductImagePropertiesChannelLocaleOverridesDataInput

Fields

Input Field	Description
`sortOrder` - `Long`	The order number of the image.
`altText` - `String`	The image description.
`isThumbnail` - `Boolean`	Indicates whether the image is a thumbnail.

Example

{
  "sortOrder": {},
  "altText": "abc123",
  "isThumbnail": false
}

Types

UpdateProductImagePropertiesChannelLocaleOverridesInput

Description

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

Fields

Input Field	Description
`context` - `ChannelLocaleContextInput!`	The storefront channel and locale that apply when you override or retrieve product images from a channel locale.
`data` - `UpdateProductImagePropertiesChannelLocaleOverridesDataInput!`

Example

{
  "context": ChannelLocaleContextInput,
  "data": UpdateProductImagePropertiesChannelLocaleOverridesDataInput
}

Types

UpdateProductImagePropertiesDataInput

Description

The input data for updating product images.

Fields

Input Field	Description
`imageId` - `ID!`	The ID of the product image.
`sortOrder` - `Long`	The order number of the image.
`altText` - `String`	The image description.
`isThumbnail` - `Boolean`	Indicates whether the image is a thumbnail.
`overrides` - `[UpdateProductImagePropertiesOverridesInput!]`	The input data for updating product images in contexts.

Example

{
  "imageId": 4,
  "sortOrder": {},
  "altText": "xyz789",
  "isThumbnail": true,
  "overrides": [
    UpdateProductImagePropertiesOverridesInput
  ]
}

Types

UpdateProductImagePropertiesInput

Fields

Input Field	Description
`productId` - `ID!`	The ID of the product.
`data` - `[UpdateProductImagePropertiesDataInput!]!`

Example

{
  "productId": "4",
  "data": [UpdateProductImagePropertiesDataInput]
}

Types

UpdateProductImagePropertiesOverridesInput

Description

The input data for updating product images in contexts.

Fields

Input Field	Description
`channelLocaleOverrides` - `UpdateProductImagePropertiesChannelLocaleOverridesInput`	The input data for updating product images in channel and locale context.

Example

{
  "channelLocaleOverrides": UpdateProductImagePropertiesChannelLocaleOverridesInput
}

Types

UpdateProductImagePropertiesResult

Fields

Field Name	Description
`images` - `ProductImageConnection`	The images list with added and removed images.
Arguments `before` - `String` `after` - `String` `first` - `Int` `last` - `Int`

Example

{"images": ProductImageConnection}

Types

UpdatePubSubWebhookDataInput

Fields

Input Field	Description
`destination` - `String`	The Google Cloud Pub/Sub topic where events will be delivered. The topic must have the BigCommerce service account principal & Pub/Sub Publish permission enabled.
`eventFilters` - `[WebhookEventFilterUnionInput!]`	Event filters for webhook.
`isActive` - `Boolean`	If webhook is active or not.
`scope` - `String`	The scope of the event subscription.

Example

{
  "destination": "abc123",
  "eventFilters": [WebhookEventFilterUnionInput],
  "isActive": false,
  "scope": "xyz789"
}

Types

UpdatePubSubWebhookError

Description

Error object for update Google Cloud PubSub webhook mutation.

Types

Union Types
`AlreadyExistsError`
`ValidationError`
`EntityNotFoundError`
`PubSubTopicNotFoundError`
`PubSubNoPermissionToPublishError`
`DestinationNotAllowedError`
`ScopeChangeNotAllowedError`
`WebhooksLimitPerClientScopeReachedError`

Example

AlreadyExistsError

Types

UpdatePubSubWebhookInput

Fields

Input Field	Description
`id` - `ID!`	The ID of webhook to update.
`data` - `UpdatePubSubWebhookDataInput!`

Example

{"id": 4, "data": UpdatePubSubWebhookDataInput}

Types

UpdatePubSubWebhookResult

Description

Result of mutation.

Fields

Field Name	Description
`webhook` - `PubSubWebhook`	The Google PubSub webhook that is updated as a result of mutation.
`errors` - `[UpdatePubSubWebhookError!]!`	The errors that occurred during the update Google Pub/Sub webhook mutation.

Example

{
  "webhook": PubSubWebhook,
  "errors": [AlreadyExistsError]
}

Types

ValidationError

Description

Error indicating that the input is invalid.

Fields

Field Name	Description
`message` - `String!`	Information about error.

Example

{"message": "xyz789"}

Types

Webhook

Description

A webhook.

Fields

Field Name	Description
`clientId` - `String!`	ID of client application owning the webhook.
`createdAt` - `DateTime`	The date and time of webhook creation.
`eventFilters` - `[WebhookEventFilter!]!`	Event filters for webhook.
`id` - `ID!`	The ID of a webhook object.
`scope` - `String!`	The scope of the event subscription.
`status` - `WebhookStatus!`	The status of a webhook.
`updatedAt` - `DateTime`	The date and time of the last webhook update.

Possible Types

Webhook Types
`EventBridgeWebhook`
`HttpsWebhook`
`PubSubWebhook`

Example

{
  "clientId": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "eventFilters": [WebhookEventFilter],
  "id": "4",
  "scope": "abc123",
  "status": "ACTIVE",
  "updatedAt": "2007-12-03T10:15:30Z"
}

Types

WebhookEventDataFilter

Description

Filter for webhook events based on 'data' field in payload.

Fields

Field Name	Description
`path` - `[String!]!`	Path to the field relatively to data field. Could point only on nested field.
`values` - `WebhookEventDataFilterValuesUnion!`	Values of the field to filter.
`delivery` - `WebhookEventFilterOperationType`	Delivery of filter: INCLUDE or EXCLUDE given clientIds.

Example

{
  "path": ["abc123"],
  "values": WebhookEventDataFilterStringValues,
  "delivery": "IN"
}

Types

WebhookEventDataFilterDoubleValues

Description

Wrapper for double values of the field to filter.

Fields

Field Name	Description
`doubleValues` - `[Float!]!`	Double values of the field to filter.

Example

{"doubleValues": [123.45]}

Types

WebhookEventDataFilterInput

Description

Filter for webhook events based on 'data' field in payload.

Fields

Input Field	Description
`path` - `[String!]!`	Path to the field relatively to data field. Could point only on nested field.
`values` - `WebhookEventDataFilterValuesInput!`	Values of the field to filter.
`delivery` - `WebhookEventFilterOperationType!`	Values of the field to filter.

Example

{
  "path": ["xyz789"],
  "values": WebhookEventDataFilterValuesInput,
  "delivery": "IN"
}

Types

WebhookEventDataFilterLongValues

Description

Wrapper for long (int 64) values of the field to filter.

Fields

Field Name	Description
`longValues` - `[Long!]!`	Long (int 64) values of the field to filter.

Example

{"longValues": [{}]}

Types

WebhookEventDataFilterStringValues

Description

Wrapper for string values of the field to filter.

Fields

Field Name	Description
`stringValues` - `[String!]!`	String values of the field to filter.

Example

{"stringValues": ["abc123"]}

Types

WebhookEventDataFilterValuesInput

Description

Wrapper for all possible value wrappers. Only one of fields should be set.

Fields

Input Field	Description
`stringValues` - `[String!]`	String values.
`doubleValues` - `[Float!]`	Double values.
`longValues` - `[Long!]`	Long (int64) values.

Example

{
  "stringValues": ["xyz789"],
  "doubleValues": [987.65],
  "longValues": [{}]
}

Types

WebhookEventDataFilterValuesUnion

Description

Union type for al possible value wrappers.

Types

Union Types
`WebhookEventDataFilterStringValues`
`WebhookEventDataFilterLongValues`
`WebhookEventDataFilterDoubleValues`

Example

WebhookEventDataFilterStringValues

Types

WebhookEventFilter

Description

Filter for events that trigger sending webhook.

Fields

Field Name	Description
`delivery` - `WebhookEventFilterOperationType`	Delivery of filter: INCLUDE or EXCLUDE given clientIds.

Possible Types

WebhookEventFilter Types
`WebhookEventDataFilter`

Example

{"delivery": "IN"}

Types

WebhookEventFilterOperationType

Description

Delivery type of a filter. INCLUDE or EXCLUDE.

Values

Enum Value	Description
`IN`	Include only events matching criteria.
`NOT_IN`	Include events that don't matching criteria.

Example

"IN"

Types

WebhookEventFilterUnionInput

Description

Input for webhook's filters. Currently only clientIdFilter available.

Fields

Input Field	Description
`dataFilter` - `WebhookEventDataFilterInput`	Filter that limits webhooks to send events only for given values for given field.

Example

{"dataFilter": WebhookEventDataFilterInput}

Types

WebhookFiltersInput

Fields

Input Field	Description
`channelId` - `ID`	The webhook channel ID.
`destination` - `String`	The destination URL or topic where the event messages will be sent.
`status` - `WebhookStatus`	The status of a webhook.
`scope` - `String`	The scope of the event subscription.

Example

{
  "channelId": 4,
  "destination": "xyz789",
  "status": "ACTIVE",
  "scope": "abc123"
}

Types

WebhookMutations

Description

Operations that allow you to create, update, and delete webhooks on the server side.

Fields

Field Name	Description
`createEventBridgeWebhook` - `CreateEventBridgeWebhookResult`	Creates an Amazon EventBridge webhook.
Arguments `input` - `CreateEventBridgeWebhookInput!`
`createPubSubWebhook` - `CreatePubSubWebhookResult`	Creates Google Cloud PubSub webhook.
Arguments `input` - `CreatePubSubWebhookInput!`
`updatePubSubWebhook` - `UpdatePubSubWebhookResult`	Update a Google Cloud PubSub webhook.
Arguments `input` - `UpdatePubSubWebhookInput!`
`updateEventBridgeWebhook` - `UpdateEventBridgeWebhookResult`	Update an Amazon EventBridge webhook.
Arguments `input` - `UpdateEventBridgeWebhookInput!`
`createHttpsWebhook` - `CreateHttpsWebhookResult`	Creates an HTTPS webhook.
Arguments `input` - `CreateHttpsWebhookInput!`
`deleteWebhook` - `DeleteWebhookResult`	Deletes a webhook.
Arguments `input` - `DeleteWebhookInput!`
`updateHttpsWebhook` - `UpdateHttpsWebhookResult`	Update an https webhook.
Arguments `input` - `UpdateHttpsWebhookInput!`

Example

{
  "createEventBridgeWebhook": CreateEventBridgeWebhookResult,
  "createPubSubWebhook": CreatePubSubWebhookResult,
  "updatePubSubWebhook": UpdatePubSubWebhookResult,
  "updateEventBridgeWebhook": UpdateEventBridgeWebhookResult,
  "createHttpsWebhook": CreateHttpsWebhookResult,
  "deleteWebhook": DeleteWebhookResult,
  "updateHttpsWebhook": UpdateHttpsWebhookResult
}

Types

WebhookStatus

Description

Status of a webhook.

Values

Enum Value	Description
`ACTIVE`	Webhook is active.
`DISABLED`	Webhook is disabled.
`INACTIVE`	Webhook is inactive.

Example

"ACTIVE"

Types

WebhooksConnection

Description

A connection to a list of items.

Fields

Field Name	Description
`pageInfo` - `PageInfo!`	Information to aid in pagination.
`edges` - `[WebhooksEdge]`	A list of edges with webhooks.

Example

{
  "pageInfo": PageInfo,
  "edges": [WebhooksEdge]
}

Types

WebhooksEdge

Description

An edge in a connection.

Fields

Field Name	Description
`node` - `Webhook!`	The item at the end of the edge.
`cursor` - `String!`	A cursor for use in pagination.

Example

{
  "node": Webhook,
  "cursor": "abc123"
}

Types

WebhooksLimitPerClientScopeReachedError

Description

Error indicating that the limit of webhooks per store, client and scope was reached.

Fields

Field Name	Description
`limit` - `Int!`	Number of allowed webhooks with the same store, client and scope.
`message` - `String!`	Information about error.

Example

{"limit": 987, "message": "xyz789"}

Types

WebhooksSettings

Description

Webhooks store settings.

Fields

Field Name	Description
`gcpDeliveryAccount` - `String!`	Url of GCP account.

Example

{"gcpDeliveryAccount": "abc123"}

GraphQL Admin API reference

Queries

client

Description

Response

Example

Query

Response

i18n

Description

Response

Example

Query

Response

node

Description

Response

Arguments

Example

Query

Variables

Response

nodes

Description

Response

Arguments

Example

Query

Variables

Response

store

Description

Response

Example

Query

Response

system

Description

Response

Example

Query

Response

Mutations

appExtension

Description

Response

Example

Query

Response

channel

Description

Response

Example

Query

Response

metafield

Description

Response

Example

Query

Response

product

Description

Response

Example

Query

Response

settings

Description

Response

Example

Query

Response

sharedProductModifiers

Description

Response

Example

Query

Response

sharedProductOptions

`client`

`i18n`

`node`

`nodes`

`store`

`system`

`appExtension`

`channel`

`metafield`

`product`

`settings`

`sharedProductModifiers`

`sharedProductOptions`

`webhook`

`before` - `String`

`after` - `String`

`first` - `Int`

`last` - `Int`

`input` - `CreateAppExtensionInput!`

`input` - `UpdateAppExtensionInput!`