GraphQL Admin API Reference

GraphQL Admin API Reference

Queries

client

Description

A client.

Response

Returns a Client

Example

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

store

Description

A store.

Response

Returns a Store!

Example

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

system

Description

System information.

Response

Returns a System!

Example

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

Mutations

appExtension

Description

App Extension mutations.

Response

Returns an AppExtensionMutations!

Example

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

metafield

Description

Metafield mutations.

Response

Returns a MetafieldMutations!

Example

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

product

Description

Product mutations.

Response

Returns a ProductMutations!

Example

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

settings

Description

Store settings mutations.

Response

Returns a StoreSettingsMutations

Example

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

sharedProductModifiers

Description

Shared product modifiers mutations.

Example

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

sharedProductOptions

Description

Shared product options mutations.

Response

Returns a SharedProductOptionsMutations!

Example

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

Types

Account

Description

An account.

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

AppExtension

Description

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

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

AppExtensionContext

Description

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

Values
Enum Value Description

LINK

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

PANEL

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

AppExtensionLabel

Description

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

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

AppExtensionLabelInput

Description

The label of the App Extension.

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

AppExtensionLabelLocale

Description

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

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

AppExtensionLabelLocaleInput

Description

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

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

AppExtensionModel

Description

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

Values
Enum Value Description

CUSTOMERS

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

ORDERS

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

PRODUCTS

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

PRODUCT_DESCRIPTION

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

AppExtensionMutations

Description

Mutations that create, update, and delete App Extensions.

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

AppExtensionsConnection

Description

A connection to a list of items.

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

AppExtensionsEdge

Description

An edge in a connection.

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

Boolean

Description

The Boolean scalar type represents true or false.

CheckboxProductModifier

Description

Checkbox product modifier.

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

Product overrides locale context input

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
}

CheckboxProductModifierForLocale

Description

Checkbox product modifier overrides.

Fields
Field Name Description
displayName - String Checkbox product modifier display name override for locale.
fieldValue - String Checkbox modifier field value override for locale.
Example
{
  "displayName": "abc123",
  "fieldValue": "xyz789"
}

CheckboxSharedProductModifier

Description

Checkbox shared product modifier.

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

Shared product modifier overrides locale context input.

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

CheckboxSharedProductModifierForLocale

Description

Checkbox shared product modifier overrides.

Fields
Field Name Description
displayName - String Checkbox shared product modifier display name override for locale.
fieldValue - String Checkbox shared product modifier field value override for locale.
Example
{
  "displayName": "xyz789",
  "fieldValue": "xyz789"
}

Client

Description

A client.

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

CreateAppExtensionInput

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

CreateAppExtensionResult

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

CreateMetafieldInput

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

CreateMetafieldResult

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

DataSolutionsMutations

Description

Data solutions mutations.

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

DataSolutionsSettings

Description

Data solutions settings.

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

DateFieldProductModifier

Description

Date field product modifier.

Fields
Field Name Description
overridesForLocale - DateFieldProductModifierForLocale Date field product modifier overrides for a locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "overridesForLocale": DateFieldProductModifierForLocale,
  "id": 4,
  "displayName": "abc123",
  "isRequired": false,
  "isShared": true
}

DateFieldProductModifierForLocale

Description

Date field product modifier overrides.

Fields
Field Name Description
displayName - String Date field product modifier display name override for locale.
Example
{"displayName": "xyz789"}

DateFieldSharedProductModifier

Description

Date field shared product modifier.

Fields
Field Name Description
overridesForLocale - DateFieldSharedProductModifierForLocale Date field shared product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Shared product modifier overrides locale context input.

id - ID! The ID of the object.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Is shared product modifier required.
Example
{
  "overridesForLocale": DateFieldSharedProductModifierForLocale,
  "id": 4,
  "displayName": "xyz789",
  "isRequired": false
}

DateFieldSharedProductModifierForLocale

Description

Date field shared product modifier overrides.

Fields
Field Name Description
displayName - String Date field shared product modifier display name override for locale.
Example
{"displayName": "abc123"}

DeleteAppExtensionInput

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

DeleteAppExtensionResult

Description

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

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

DeleteMetafieldInput

Description

Input for deleteMetafield mutation.

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

DeleteMetafieldResult

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

DropdownOptionValue

Description

Dropdown product option value

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

DropdownOptionValueForLocale

Description

Dropdown product option value override for locale

Fields
Field Name Description
id - ID! The ID of the object.
label - String! Option value label override for locale.
Example
{"id": 4, "label": "xyz789"}

DropdownProductModifier

Description

Dropdown product modifier.

Fields
Field Name Description
overridesForLocale - DropdownProductModifierForLocale Dropdown product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

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

DropdownProductModifierForLocale

Description

Dropdown product modifier overrides.

Fields
Field Name Description
displayName - String Dropdown product modifier display name override for locale.
values - [DropdownProductModifierValueForLocale!]! Dropdown product modifiers values overrides for locale.
Example
{
  "displayName": "abc123",
  "values": [DropdownProductModifierValueForLocale]
}

DropdownProductModifierValue

Description

Dropdown product modifier value.

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

DropdownProductModifierValueForLocale

Description

Dropdown product modifier value override for locale.

Fields
Field Name Description
id - ID! The ID of the object.
label - String! Dropdown product modifier value label override for locale.
Example
{
  "id": "4",
  "label": "abc123"
}

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

Product overrides locale context input

values - [ProductOptionValue!]! List of product option values.
Example
{
  "displayName": "abc123",
  "isShared": true,
  "id": "4",
  "overridesForLocale": ProductOptionForLocale,
  "values": [ProductOptionValue]
}

DropdownProductOptionForLocale

Description

Dropdown product option override for locale.

Fields
Field Name Description
displayName - String Option display name override for locale.
values - [ProductOptionValueForLocale!]! List of product option values overrides for locale.
Example
{
  "displayName": "abc123",
  "values": [ProductOptionValueForLocale]
}

DropdownSharedOptionValue

Description

Dropdown shared product option value

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

DropdownSharedOptionValueForLocale

Description

Dropdown shared product option value override for locale

Fields
Field Name Description
id - ID! The ID of the object.
label - String! Shared option value label override for locale.
Example
{"id": 4, "label": "xyz789"}

DropdownSharedProductModifier

Description

Dropdown shared product modifier.

Fields
Field Name Description
overridesForLocale - DropdownSharedProductModifierForLocale Dropdown shared product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Shared product modifier overrides locale context input.

values - [DropdownSharedProductModifierValue!]! Dropdown shared product modifiers values.
id - ID! The ID of the object.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Is shared product modifier required.
Example
{
  "overridesForLocale": DropdownSharedProductModifierForLocale,
  "values": [DropdownSharedProductModifierValue],
  "id": "4",
  "displayName": "abc123",
  "isRequired": false
}

DropdownSharedProductModifierForLocale

Description

Dropdown shared product modifier overrides.

Fields
Field Name Description
displayName - String Dropdown shared product modifier display name override for locale.
values - [DropdownSharedProductModifierValueForLocale!]! Dropdown shared product modifier values overrides for locale.
Example
{
  "displayName": "xyz789",
  "values": [DropdownSharedProductModifierValueForLocale]
}

DropdownSharedProductModifierValue

Description

Dropdown shared product modifier value.

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

DropdownSharedProductModifierValueForLocale

Description

Dropdown shared product modifier value override for locale.

Fields
Field Name Description
id - ID! The ID of the object.
label - String! Dropdown shared product modifier value label override for locale.
Example
{
  "id": "4",
  "label": "abc123"
}

DropdownSharedProductOption

Description

Dropdown shared product option

Fields
Field Name Description
displayName - String! Display name for the shared option.
id - ID! The ID of the object.
overridesForLocale - SharedProductOptionForLocale Shared option overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

values - [SharedProductOptionValue!]! List of shared product option values.
Example
{
  "displayName": "xyz789",
  "id": "4",
  "overridesForLocale": SharedProductOptionForLocale,
  "values": [SharedProductOptionValue]
}

DropdownSharedProductOptionForLocale

Description

Dropdown shared product option override for locale.

Fields
Field Name Description
displayName - String Shared option display name override for locale.
values - [SharedProductOptionValueForLocale!]! List of shared product option values overrides for locale.
Example
{
  "displayName": "abc123",
  "values": [SharedProductOptionValueForLocale]
}

EntityAlreadyExistsError

Description

Error indicating that the result of mutation would cause duplicate.

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

EntityError

Description

Common interface for all entity related mutations errors.

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

EntityAlreadyExistsError

EntityNotFoundError

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

EntityNotFoundError

Description

Error indicating that requested entity was not found.

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

Error

Description

Common interface for all errors.

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

FileUploadProductModifier

Description

File upload product modifier.

Fields
Field Name Description
overridesForLocale - FileUploadProductModifierForLocale File upload product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "overridesForLocale": FileUploadProductModifierForLocale,
  "id": "4",
  "displayName": "abc123",
  "isRequired": false,
  "isShared": false
}

FileUploadProductModifierForLocale

Description

File upload product modifier overrides.

Fields
Field Name Description
displayName - String File upload product modifier display name override for locale.
Example
{"displayName": "abc123"}

FileUploadSharedProductModifier

Description

File upload shared product modifier.

Fields
Field Name Description
overridesForLocale - FileUploadSharedProductModifierForLocale File upload shared product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Shared product modifier overrides locale context input.

id - ID! The ID of the object.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Is shared product modifier required.
Example
{
  "overridesForLocale": FileUploadSharedProductModifierForLocale,
  "id": "4",
  "displayName": "xyz789",
  "isRequired": true
}

FileUploadSharedProductModifierForLocale

Description

File upload shared product modifier overrides.

Fields
Field Name Description
displayName - String File upload shared product modifier display name override for locale.
Example
{"displayName": "abc123"}

Float

Description

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

Example
123.45

ID

Description

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

Example
"4"

Int

Description

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

Example
123

Long

Description

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

Example
{}

Metafield

Description

A metafield.

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

MetafieldMutations

Description

Metafield mutations.

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

MetafieldsConnection

Description

A connection to a list of items.

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

MetafieldsEdge

Description

An edge in a connection.

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

MetafieldsFiltersInput

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

MetafieldsPermissionSet

Description

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

Values
Enum Value Description

APP_ONLY

Private to the app that owns the field.

READ

Visible to other API consumers.

READ_AND_SF_ACCESS

Visible to other API consumers, including on storefront.

WRITE

Open for reading and writing by other API consumers.

WRITE_AND_SF_ACCESS

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

MetafieldsResourceType

Description

The type of resource with which the metafield is associated.

Values
Enum Value Description

BRAND

Metafield is associated with brand.

CART

Metafield is associated with cart.

CATEGORY

Metafield is associated with category.

CHANNEL

Metafield is associated with channel.

CUSTOMER

Metafield is associated with customer.

LOCATION

Metafield is associated with location.

ORDER

Metafield is associated with order.

PRODUCT

Metafield is associated with product.

VARIANT

Metafield is associated with variant.
Example
"BRAND"

MultilineTextFieldProductModifier

Description

Multiline text field product modifier.

Fields
Field Name Description
defaultValue - String Multiline text field modifier default value.
overridesForLocale - MultilineTextFieldProductModifierForLocale Multiline text field product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "defaultValue": "abc123",
  "overridesForLocale": MultilineTextFieldProductModifierForLocale,
  "id": 4,
  "displayName": "xyz789",
  "isRequired": false,
  "isShared": false
}

MultilineTextFieldProductModifierForLocale

Description

Multiline text field product modifier overrides.

Fields
Field Name Description
defaultValue - String Multiline text field modifier default value override for locale.
displayName - String Multiline text field product modifier display name override for locale.
Example
{
  "defaultValue": "abc123",
  "displayName": "xyz789"
}

MultilineTextFieldSharedProductModifier

Description

Multiline text field shared product modifier.

Fields
Field Name Description
defaultValue - String Multiline text field shared product modifier default value.
overridesForLocale - MultilineTextFieldSharedProductModifierForLocale Multiline text field shared product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Shared product modifier overrides locale context input.

id - ID! The ID of the object.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Is shared product modifier required.
Example
{
  "defaultValue": "xyz789",
  "overridesForLocale": MultilineTextFieldSharedProductModifierForLocale,
  "id": "4",
  "displayName": "xyz789",
  "isRequired": false
}

MultilineTextFieldSharedProductModifierForLocale

Description

Multiline text field shared product modifier overrides.

Fields
Field Name Description
defaultValue - String Multiline text field shared product modifier default value override for locale.
displayName - String Multiline text field shared product modifier display name override for locale.
Example
{
  "defaultValue": "abc123",
  "displayName": "xyz789"
}

NumbersOnlyTextFieldProductModifier

Description

Numbers only text field product modifier.

Fields
Field Name Description
defaultValue - Float Numbers only text field modifier default value.
overridesForLocale - NumbersOnlyTextFieldProductModifierForLocale Numbers only text field product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

id - ID! The ID of the object.
displayName - String! Product modifier display name.
isRequired - Boolean! Indicates whether product modifier is required.
isShared - Boolean! Indicates whether product modifier is shared or local.
Example
{
  "defaultValue": 987.65,
  "overridesForLocale": NumbersOnlyTextFieldProductModifierForLocale,
  "id": 4,
  "displayName": "xyz789",
  "isRequired": true,
  "isShared": true
}

NumbersOnlyTextFieldProductModifierForLocale

Description

Numbers only text field product modifier overrides.

Fields
Field Name Description
defaultValue - Float Numbers only text field modifier default value override for locale.
displayName - String Numbers only text field product modifier display name override for locale.
Example
{
  "defaultValue": 987.65,
  "displayName": "xyz789"
}

NumbersOnlyTextFieldSharedProductModifier

Description

Numbers only text field shared product modifier.

Fields
Field Name Description
defaultValue - Float Numbers only text field shared product modifier default value.
overridesForLocale - NumbersOnlyTextFieldSharedProductModifierForLocale Numbers only text field shared product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Shared product modifier overrides locale context input.

id - ID! The ID of the object.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Is shared product modifier required.
Example
{
  "defaultValue": 987.65,
  "overridesForLocale": NumbersOnlyTextFieldSharedProductModifierForLocale,
  "id": 4,
  "displayName": "abc123",
  "isRequired": true
}

NumbersOnlyTextFieldSharedProductModifierForLocale

Description

Numbers only text field shared product modifier overrides.

Fields
Field Name Description
defaultValue - Float Numbers only text field shared product modifier default value override for locale.
displayName - String Numbers only text field shared product modifier display name override for locale.
Example
{
  "defaultValue": 987.65,
  "displayName": "xyz789"
}

PageInfo

Description

Information about pagination in a connection.

Fields
Field Name Description
hasNextPage - Boolean! When paginating forwards, are there more items?
hasPreviousPage - Boolean! When paginating backwards, are there more items?
startCursor - String When paginating backwards, the cursor to continue.
endCursor - String When paginating forwards, the cursor to continue.
Example
{
  "hasNextPage": true,
  "hasPreviousPage": true,
  "startCursor": "xyz789",
  "endCursor": "xyz789"
}

PickListModifierValue

Description

Pick list product modifier value.

Fields
Field Name Description
id - ID! The ID of the object.
isDefault - Boolean! Indicates whether pick list product modifier value is selected by default.
label - String! Pick list product modifier value label.
Example
{
  "id": "4",
  "isDefault": false,
  "label": "abc123"
}

PickListModifierValueForLocale

Description

Pick list product modifier value overrides for locale.

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

PickListProductModifier

Description

Pick list product modifier.

Fields
Field Name Description
overridesForLocale - PickListProductModifierForLocale Pick list product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

values - [PickListModifierValue!]! Pick list 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": PickListProductModifierForLocale,
  "values": [PickListModifierValue],
  "id": 4,
  "displayName": "xyz789",
  "isRequired": true,
  "isShared": true
}

PickListProductModifierForLocale

Description

Pick list product modifier overrides.

Fields
Field Name Description
displayName - String Pick list product modifier display name override for locale.
values - [PickListModifierValueForLocale!]! Pick list product modifiers values overrides for locale.
Example
{
  "displayName": "xyz789",
  "values": [PickListModifierValueForLocale]
}

PreOrderSettings

Description

Product pre-order settings

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

PreOrderSettingsOverridesForLocale

Description

Product pre-order settings overrides for channel and locale

Fields
Field Name Description
message - String Pre-order message override.
Example
{"message": "xyz789"}

Product

Description

A product.

Fields
Field Name Description
id - ID! The ID of the object.
basicInformation - ProductBasicInformation! Product basic information.
isFeatured - Boolean! Indicates whether a product is marked as a featured product.
modifiers - ProductModifierConnection! List of product modifiers.
Arguments
before - String
after - String
first - Int
last - Int
urlPath - ProductUrlPath! Product path.
options - ProductOptionConnection! List of product options.
Arguments
before - String
after - String
first - Int
last - Int
overridesForLocale - ProductOverridesForLocale Product overrides for specific channel and locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

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

Channel ID.

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

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

ProductBasicInformationField

Description

Product basic information field names

Values
Enum Value Description

PRODUCT_DESCRIPTION_FIELD

The description field.

PRODUCT_NAME_FIELD

The name field.
Example
"PRODUCT_DESCRIPTION_FIELD"

ProductBasicInformationOverridesForLocale

Description

Product basic information overrides for channel and locale

Fields
Field Name Description
description - String Description override of the product for the specific channel and locale.
name - String Name override of the product for specific channel and locale.
Example
{
  "description": "abc123",
  "name": "xyz789"
}

ProductConnection

Description

A connection to a list of items.

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

ProductEdge

Description

An edge in a connection.

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

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.
Example
{
  "id": "4",
  "displayName": "abc123",
  "isRequired": true,
  "isShared": false
}

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

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

ProductMutations

Description

Product mutations.

Fields
Field Name Description
removeProductBasicInformationOverrides - RemoveProductBasicInformationOverridesResult Removes product's basic information overrides.
removeProductSeoInformationOverrides - RemoveProductSeoInformationOverridesResult Removes product's seo information overrides.
removeProductOptionsOverrides - RemoveProductOptionsOverridesResult Removes product's options overrides.
removeProductStorefrontDetailsOverrides - RemoveProductStorefrontDetailsOverridesResult Removes product's storefront details overrides.
removeProductPreOrderSettingsOverrides - RemoveProductPreOrderSettingsOverridesResult Removes product's pre-order settings overrides.
setProductBasicInformation - SetProductBasicInformationResult Sets product's basic information.
setProductIsFeatured - SetProductIsFeaturedResult Sets product's isFeatured flag.
Arguments
removeProductIsFeaturedOverride - RemoveProductIsFeaturedOverrideResult Removes product's isFeatured override.
setProductSeoInformation - SetProductSeoInformationResult Sets product's seo information.
Arguments
setProductStorefrontDetails - SetProductStorefrontDetailsResult Sets product's storefront details information.
setProductPreOrderSettings - SetProductPreOrderSettingsResult Sets product's pre-order settings information.
setProductOptionsInformation - SetProductOptionsInformationResult Sets product's options information.
setProductUrlPath - SetProductUrlPathResult Sets product's url path.
Arguments
removeProductUrlPathOverride - RemoveProductUrlPathOverrideResult Removes product's url path override.
setProductModifiersInformation - SetProductModifiersInformationResult Sets product's modifiers information.
removeProductModifiersOverrides - RemoveProductModifiersOverridesResult Remove product's modifiers overrides.
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
}

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

Product overrides locale context input

values - [ProductOptionValue!]! List of product option values.
Example
{
  "displayName": "xyz789",
  "isShared": true,
  "id": "4",
  "overridesForLocale": ProductOptionForLocale,
  "values": [ProductOptionValue]
}

ProductOptionConnection

Description

A connection to a list of items.

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

ProductOptionEdge

Description

An edge in a connection.

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

ProductOptionForLocale

Description

Product option overrides

Fields
Field Name Description
displayName - String Option display name override for locale.
values - [ProductOptionValueForLocale!]! List of product option values overrides for locale.
Example
{
  "displayName": "abc123",
  "values": [ProductOptionValueForLocale]
}

ProductOptionValue

Description

Product option value

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

ProductOptionValueForLocale

Description

Product option value override.

Fields
Field Name Description
id - ID! The ID of the object.
label - String! Option value label override for locale.
Example
{"id": 4, "label": "xyz789"}

ProductOverridesForChannel

Description

Product overrides for channel

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

ProductOverridesForLocale

Description

Product overrides for channel and locale

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

ProductOverridesLocaleContextInput

Description

Product overrides locale context input

Fields
Input Field Description
channelId - ID! Channel context.
locale - String! Locale context.
Example
{
  "channelId": "4",
  "locale": "xyz789"
}

ProductPreOrderSettingsField

Description

Product pre-order settings field names

Values
Enum Value Description

PRODUCT_PRE_ORDER_MESSAGE

The pre-order message.
Example
"PRODUCT_PRE_ORDER_MESSAGE"

ProductSeoInformation

Description

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

ProductSeoInformationField

Description

Product seo information field names

Values
Enum Value Description

PRODUCT_META_DESCRIPTION_FIELD

The meta description field.

PRODUCT_PAGE_TITLE_FIELD

The page title field.
Example
"PRODUCT_META_DESCRIPTION_FIELD"

ProductSeoInformationOverridesForLocale

Description

Product seo information overrides for channel and locale

Fields
Field Name Description
metaDescription - String Meta description override for the product per the specific channel and locale.
pageTitle - String Page title override for the product per specific channel and locale.
Example
{
  "metaDescription": "abc123",
  "pageTitle": "abc123"
}

ProductStorefrontDetailsField

Description

Product storefront details field names

Values
Enum Value Description

PRODUCT_AVAILABILITY_DESCRIPTION_FIELD

The availability description.

PRODUCT_SEARCH_KEYWORDS

The search keywords.

PRODUCT_WARRANTY

The warranty.
Example
"PRODUCT_AVAILABILITY_DESCRIPTION_FIELD"

ProductUrlPath

Description

Product url path.

Fields
Field Name Description
path - String! Product path value.
Example
{"path": "abc123"}

ProductUrlPathOverridesForLocale

Description

Product path overrides for locale.

Fields
Field Name Description
path - String Product path overrides for locale value.
Example
{"path": "abc123"}

ProductsFiltersInput

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

RadioButtonsModifierValue

Description

Radio buttons product modifier value.

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

RadioButtonsModifierValueForLocale

Description

Radio buttons product modifier value overrides for locale.

Fields
Field Name Description
id - ID! The ID of the object.
label - String! Radio buttons product modifier value label override for locale.
Example
{"id": 4, "label": "abc123"}

RadioButtonsOptionValue

Description

Radio buttons product option value

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

RadioButtonsOptionValueForLocale

Description

Radio buttons product option value override for locale

Fields
Field Name Description
id - ID! The ID of the object.
label - String! Option value label override for locale.
Example
{
  "id": "4",
  "label": "xyz789"
}

RadioButtonsProductModifier

Description

Radio buttons product modifier.

Fields
Field Name Description
overridesForLocale - RadioButtonsProductModifierForLocale Radio buttons product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

values - [RadioButtonsModifierValue!]! Radio buttons 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": RadioButtonsProductModifierForLocale,
  "values": [RadioButtonsModifierValue],
  "id": 4,
  "displayName": "xyz789",
  "isRequired": true,
  "isShared": false
}

RadioButtonsProductModifierForLocale

Description

Radio buttons product modifier overrides.

Fields
Field Name Description
displayName - String Radio buttons product modifier display name override for locale.
values - [RadioButtonsModifierValueForLocale!]! Radio buttons product modifiers values overrides for locale.
Example
{
  "displayName": "xyz789",
  "values": [RadioButtonsModifierValueForLocale]
}

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

Product overrides locale context input

values - [ProductOptionValue!]! List of product option values.
Example
{
  "displayName": "xyz789",
  "isShared": false,
  "id": "4",
  "overridesForLocale": ProductOptionForLocale,
  "values": [ProductOptionValue]
}

RadioButtonsProductOptionForLocale

Description

Radio buttons product option override for locale.

Fields
Field Name Description
displayName - String Option display name override for locale.
values - [ProductOptionValueForLocale!]! List of product option values overrides for locale.
Example
{
  "displayName": "abc123",
  "values": [ProductOptionValueForLocale]
}

RadioButtonsSharedOptionValue

Description

Radio buttons shared product option value

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

RadioButtonsSharedOptionValueForLocale

Description

Radio buttons shared product option value override for locale

Fields
Field Name Description
id - ID! The ID of the object.
label - String! Shared option value label override for locale.
Example
{
  "id": "4",
  "label": "xyz789"
}

RadioButtonsSharedProductModifier

Description

Radio buttons shared product modifier.

Fields
Field Name Description
overridesForLocale - RadioButtonsSharedProductModifierForLocale Radio buttons shared product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Shared product modifier overrides locale context input.

values - [RadioButtonsSharedProductModifierValue!]! Radio buttons shared product modifier values.
id - ID! The ID of the object.
displayName - String! Display name for the shared modifier.
isRequired - Boolean! Is shared product modifier required.
Example
{
  "overridesForLocale": RadioButtonsSharedProductModifierForLocale,
  "values": [RadioButtonsSharedProductModifierValue],
  "id": "4",
  "displayName": "xyz789",
  "isRequired": true
}

RadioButtonsSharedProductModifierForLocale

Description

Radio buttons shared product modifier overrides.

Fields
Field Name Description
displayName - String Radio buttons shared product modifier display name override for locale.
values - [RadioButtonsSharedProductModifierValueForLocale!]! Radio buttons shared product modifier values overrides for locale.
Example
{
  "displayName": "xyz789",
  "values": [
    RadioButtonsSharedProductModifierValueForLocale
  ]
}

RadioButtonsSharedProductModifierValue

Description

Radio buttons shared product modifier value.

Fields
Field Name Description
id - ID! The ID of the object.
isDefault - Boolean! Indicates whether radio buttons shared product modifier value is selected by default.
label - String! Radio buttons shared product modifier value label.
Example
{
  "id": 4,
  "isDefault": false,
  "label": "abc123"
}

RadioButtonsSharedProductModifierValueForLocale

Description

Radio buttons shared product modifier value overrides for locale.

Fields
Field Name Description
id - ID! The ID of the object.
label - String! Radio buttons shared product modifier value label override for locale.
Example
{"id": 4, "label": "xyz789"}

RadioButtonsSharedProductOption

Description

Radio buttons shared product option

Fields
Field Name Description
displayName - String! Display name for the shared option.
id - ID! The ID of the object.
overridesForLocale - SharedProductOptionForLocale Shared option overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

values - [SharedProductOptionValue!]! List of shared product option values.
Example
{
  "displayName": "xyz789",
  "id": 4,
  "overridesForLocale": SharedProductOptionForLocale,
  "values": [SharedProductOptionValue]
}

RadioButtonsSharedProductOptionForLocale

Description

Radio buttons shared product option override for locale.

Fields
Field Name Description
displayName - String Shared option display name override for locale.
values - [SharedProductOptionValueForLocale!]! List of shared product option values overrides for locale.
Example
{
  "displayName": "abc123",
  "values": [SharedProductOptionValueForLocale]
}

ReassignMetafieldOwnerError

Description

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

Example
EntityNotFoundError

ReassignMetafieldsOwnerInput

Description

Reassign metafields owner input.

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

ReassignMetafieldsOwnerResult

Description

Result of reassigning metafields to new owner.

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

RectangleListModifierValue

Description

Rectangle list product modifier value.

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

RectangleListModifierValueForLocale

Description

Rectangle list product modifier value overrides for locale.

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

RectangleListOptionValue

Description

Rectangle list product option value

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

RectangleListOptionValueForLocale

Description

Rectangle list product option value override for locale

Fields
Field Name Description
id - ID! The ID of the object.
label - String! Option value label override for locale.
Example
{
  "id": "4",
  "label": "xyz789"
}

RectangleListProductModifier

Description

Rectangle list product modifier.

Fields
Field Name Description
overridesForLocale - RectangleListProductModifierForLocale Rectangle list product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

values - [RectangleListModifierValue!]! Rectangle list 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": RectangleListProductModifierForLocale,
  "values": [RectangleListModifierValue],
  "id": "4",
  "displayName": "abc123",
  "isRequired": false,
  "isShared": false
}

RectangleListProductModifierForLocale

Description

Rectangle list product modifier overrides.

Fields
Field Name Description
displayName - String Rectangle list product modifier display name override for locale.
values - [RectangleListModifierValueForLocale!]! Rectangle list product modifiers values overrides for locale.
Example
{
  "displayName": "xyz789",
  "values": [RectangleListModifierValueForLocale]
}

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

Product overrides locale context input

values - [ProductOptionValue!]! List of product option values.
Example
{
  "displayName": "xyz789",
  "isShared": false,
  "id": "4",
  "overridesForLocale": ProductOptionForLocale,
  "values": [ProductOptionValue]
}

RectangleListProductOptionForLocale

Description

Rectangle list product option override for locale.

Fields
Field Name Description
displayName - String Option display name override for locale.
values - [ProductOptionValueForLocale!]! List of product option values overrides for locale.
Example
{
  "displayName": "abc123",
  "values": [ProductOptionValueForLocale]
}

RectangleListSharedOptionValue

Description

Rectangle list shared product option value

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

RectangleListSharedOptionValueForLocale

Description

Rectangle list shared product option value override for locale

Fields
Field Name Description
id - ID! The ID of the object.
label - String! Shared option value label override for locale.
Example
{
  "id": "4",
  "label": "abc123"
}

RectangleListSharedProductModifier

Description

Rectangle list shared product modifier.

Fields
Field Name Description
overridesForLocale - RectangleListSharedProductModifierForLocale Rectangle list shared product modifier overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Shared product modifier overrides locale context input.

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

RectangleListSharedProductModifierForLocale

Description

Rectangle list shared product modifier overrides.

Fields
Field Name Description
displayName - String Rectangle list shared product modifier display name override for locale.
values - [RectangleListSharedProductModifierValueForLocale!]! Rectangle list shared product modifiers values overrides for locale.
Example
{
  "displayName": "xyz789",
  "values": [
    RectangleListSharedProductModifierValueForLocale
  ]
}

RectangleListSharedProductModifierValue

Description

Rectangle list shared product modifier value.

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

RectangleListSharedProductModifierValueForLocale

Description

Rectangle list shared product modifier value overrides for locale.

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

RectangleListSharedProductOption

Description

Rectangle list shared product option

Fields
Field Name Description
displayName - String! Display name for the shared option.
id - ID! The ID of the object.
overridesForLocale - SharedProductOptionForLocale Shared option overrides for locale.
Arguments
localeContext - ProductOverridesLocaleContextInput!

Product overrides locale context input

values - [SharedProductOptionValue!]! List of shared product option values.
Example
{
  "displayName": "abc123",
  "id": 4,
  "overridesForLocale": SharedProductOptionForLocale,
  "values": [SharedProductOptionValue]
}

RectangleListSharedProductOptionForLocale

Description

Rectangle list shared product option override for locale.

Fields
Field Name Description
displayName - String Shared option display name override for locale.
values - [SharedProductOptionValueForLocale!]! List of shared product option values overrides for locale.
Example
{
  "displayName": "xyz789",
  "values": [SharedProductOptionValueForLocale]
}

RemoveCheckboxProductModifierOverridesField

Description

Checkbox product modifier overrides field name

Values
Enum Value Description

CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.

CHECKBOX_PRODUCT_MODIFIER_VALUE_FIELD

The value field.
Example
"CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveCheckboxProductModifierOverridesInput

Description

Checkbox product modifier overrides input

Fields
Input Field Description
fields - [RemoveCheckboxProductModifierOverridesField!] Checkbox product modifier fields to remove overrides for
Example
{"fields": ["CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveDateFieldProductModifierOverridesField

Description

Date field product modifier overrides field name

Values
Enum Value Description

DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveDateFieldProductModifierOverridesInput

Description

Date field product modifier overrides input

Fields
Input Field Description
fields - [RemoveDateFieldProductModifierOverridesField!] Date field product modifier fields to remove overrides for
Example
{"fields": ["DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveDropdownProductModifierOverridesField

Description

Dropdown product modifier overrides field name

Values
Enum Value Description

DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveDropdownProductModifierOverridesInput

Description

Dropdown product modifier overrides input

Fields
Input Field Description
fields - [RemoveDropdownProductModifierOverridesField!] Dropdown product modifier fields to remove overrides for
values - RemoveDropdownProductModifierValuesOverridesInput Dropdown product modifier values to remove overrides for
Example
{
  "fields": ["DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveDropdownProductModifierValuesOverridesInput
}

RemoveDropdownProductModifierValuesOverridesInput

Description

Dropdown product modifier values to remove overrides for

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

RemoveDropdownProductOptionOverridesField

Description

Dropdown product option overrides field names

Values
Enum Value Description

DROPDOWN_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"DROPDOWN_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveDropdownProductOptionOverridesInput

Description

Dropdown product option overrides input

Fields
Input Field Description
fields - [RemoveDropdownProductOptionOverridesField!] Dropdown product option fields to remove overrides for
values - RemoveDropdownProductOptionValuesOverridesInput Dropdown product option values to remove overrides for
Example
{
  "fields": ["DROPDOWN_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveDropdownProductOptionValuesOverridesInput
}

RemoveDropdownProductOptionValuesOverridesInput

Description

Dropdown product option values to remove overrides for

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

RemoveDropdownSharedProductOptionOverridesField

Description

Dropdown shared product option overrides field names

Values
Enum Value Description

DROPDOWN_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"DROPDOWN_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveDropdownSharedProductOptionOverridesInput

Description

Dropdown shared product option overrides input

Fields
Input Field Description
fields - [RemoveDropdownSharedProductOptionOverridesField!] Dropdown shared product option fields to remove overrides for
values - RemoveDropdownSharedProductOptionValuesOverridesInput Dropdown shared product option values to remove overrides for
Example
{
  "fields": ["DROPDOWN_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveDropdownSharedProductOptionValuesOverridesInput
}

RemoveDropdownSharedProductOptionValuesOverridesInput

Description

Dropdown shared product option values to remove overrides for

Fields
Input Field Description
ids - [ID!]! Dropdown shared product option values ids to remove overrides for
Example
{"ids": ["4"]}

RemoveFileUploadProductModifierOverridesField

Description

File upload product modifier overrides field name

Values
Enum Value Description

FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveFileUploadProductModifierOverridesInput

Description

File upload product modifier overrides input

Fields
Input Field Description
fields - [RemoveFileUploadProductModifierOverridesField!] File upload product modifier fields to remove overrides for
Example
{"fields": ["FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveMultiLineTextFieldProductModifierOverridesField

Description

MultiLine text field product modifier overrides field name

Values
Enum Value Description

MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field default value.

MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveMultiLineTextFieldProductModifierOverridesInput

Description

MultiLine text product modifier overrides input

Fields
Input Field Description
fields - [RemoveMultiLineTextFieldProductModifierOverridesField!] Multiline text field product modifier fields to remove overrides for
Example
{"fields": ["MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

RemoveNumberFieldProductModifierOverridesField

Description

Number field product modifier overrides field name

Values
Enum Value Description

NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field value.

NUMBER_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveNumberFieldProductModifierOverridesInput

Description

Numbers only text field product modifier overrides input

Fields
Input Field Description
fields - [RemoveNumberFieldProductModifierOverridesField!] Number field product modifier fields to remove overrides for
Example
{"fields": ["NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

RemovePickListProductModifierOverridesField

Description

Pick list product modifier overrides field name.

Values
Enum Value Description

PICK_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"PICK_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemovePickListProductModifierOverridesInput

Description

Pick list product modifier overrides input

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

RemovePickListProductModifierValueOverridesInput

Description

Pick list product modifier values to remove overrides for

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

RemoveProductBasicInformationOverridesInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! Product overrides locale context input
overridesToRemove - [ProductBasicInformationField!] Set of the product basic information fields which overrides should be removed. Empty value means all the product basic information fields overrides will be removed
productId - ID! The product which information should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "overridesToRemove": ["PRODUCT_DESCRIPTION_FIELD"],
  "productId": 4
}

RemoveProductBasicInformationOverridesResult

Description

Result of product basic information overrides mutation.

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

RemoveProductIsFeaturedOverrideInput

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

RemoveProductIsFeaturedOverrideResult

Description

Result of product basic information overrides mutation.

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

RemoveProductModifierOverridesDataInput

Description

Product modifiers overrides data input

Fields
Input Field Description
modifiers - [RemoveProductModifierOverridesInput!]! Product modifiers overrides data input
Example
{"modifiers": [RemoveProductModifierOverridesInput]}

RemoveProductModifierOverridesInput

Description

Product modifier overrides input

Fields
Input Field Description
modifierId - ID! The product modifier id which data should be removed.
data - RemoveProductModifierOverridesUnionDataInput! Product modifier overrides data input
Example
{
  "modifierId": "4",
  "data": RemoveProductModifierOverridesUnionDataInput
}

RemoveProductModifierOverridesUnionDataInput

Description

Product modifier overrides data input, only one type is allowed to be passed at once

Fields
Input Field Description
checkbox - RemoveCheckboxProductModifierOverridesInput Checkbox product modifier overrides input
dateField - RemoveDateFieldProductModifierOverridesInput Date field product modifier overrides input
dropdown - RemoveDropdownProductModifierOverridesInput Dropdown product modifier overrides input
fileUpload - RemoveFileUploadProductModifierOverridesInput File upload product modifier overrides input
multiLineTextField - RemoveMultiLineTextFieldProductModifierOverridesInput MultiLine text field product modifier overrides input
numberField - RemoveNumberFieldProductModifierOverridesInput Number field product modifier overrides input
pickList - RemovePickListProductModifierOverridesInput Pick list product modifier overrides input
radioButtons - RemoveRadioButtonsProductModifierOverridesInput Radio buttons product modifier overrides input
rectangleList - RemoveRectangleListProductModifierOverridesInput Rectangle list product modifier overrides input
swatch - RemoveSwatchProductModifierOverridesInput Swatch product modifier overrides input
textField - RemoveTextFieldProductModifierOverridesInput Text field product modifier overrides input
Example
{
  "checkbox": RemoveCheckboxProductModifierOverridesInput,
  "dateField": RemoveDateFieldProductModifierOverridesInput,
  "dropdown": RemoveDropdownProductModifierOverridesInput,
  "fileUpload": RemoveFileUploadProductModifierOverridesInput,
  "multiLineTextField": RemoveMultiLineTextFieldProductModifierOverridesInput,
  "numberField": RemoveNumberFieldProductModifierOverridesInput,
  "pickList": RemovePickListProductModifierOverridesInput,
  "radioButtons": RemoveRadioButtonsProductModifierOverridesInput,
  "rectangleList": RemoveRectangleListProductModifierOverridesInput,
  "swatch": RemoveSwatchProductModifierOverridesInput,
  "textField": RemoveTextFieldProductModifierOverridesInput
}

RemoveProductModifiersOverridesInput

Description

Product modifiers overrides data input

Fields
Input Field Description
productId - ID! The product id which modifiers data should be modified.
localeContext - ProductOverridesLocaleContextInput! Product modifiers overrides locale context input
data - RemoveProductModifierOverridesDataInput! Product modifiers overrides data input
Example
{
  "productId": "4",
  "localeContext": ProductOverridesLocaleContextInput,
  "data": RemoveProductModifierOverridesDataInput
}

RemoveProductModifiersOverridesResult

Description

Result of product modifier overrides remove.

Fields
Field Name Description
product - Product The product which was updated as a result of modifier overrides remove.
Example
{"product": Product}

RemoveProductOptionOverridesDataInput

Description

Product option overrides data input

Fields
Input Field Description
optionId - ID! The product option which overrides should be removed.
data - RemoveProductOptionOverridesUnionDataInput! Product option overrides data input
Example
{
  "optionId": "4",
  "data": RemoveProductOptionOverridesUnionDataInput
}

RemoveProductOptionOverridesUnionDataInput

Description

Product option overrides data input

Fields
Input Field Description
dropdown - RemoveDropdownProductOptionOverridesInput Dropdown product option overrides input
radioButtons - RemoveRadioButtonsProductOptionOverridesInput Radio buttons product option overrides input
rectangleList - RemoveRectangleListProductOptionOverridesInput Rectangle list product option overrides input
swatch - RemoveSwatchProductOptionOverridesInput Swatch product option overrides input
Example
{
  "dropdown": RemoveDropdownProductOptionOverridesInput,
  "radioButtons": RemoveRadioButtonsProductOptionOverridesInput,
  "rectangleList": RemoveRectangleListProductOptionOverridesInput,
  "swatch": RemoveSwatchProductOptionOverridesInput
}

RemoveProductOptionsOverridesDataInput

Description

Product options overrides data input

Fields
Input Field Description
options - [RemoveProductOptionOverridesDataInput!]! Product option overrides data input
Example
{"options": [RemoveProductOptionOverridesDataInput]}

RemoveProductOptionsOverridesInput

Fields
Input Field Description
data - RemoveProductOptionsOverridesDataInput! Product options overrides data input
localeContext - ProductOverridesLocaleContextInput! Product options overrides locale context input
productId - ID! The product which options overrides should be removed.
Example
{
  "data": RemoveProductOptionsOverridesDataInput,
  "localeContext": ProductOverridesLocaleContextInput,
  "productId": 4
}

RemoveProductOptionsOverridesResult

Description

Result of product options overrides mutation.

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

RemoveProductPreOrderSettingsOverridesInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! Product overrides locale context input
overridesToRemove - [ProductPreOrderSettingsField!] Set of the product pre-order settings fields which overrides should be removed. Empty value means all the product pre-order settings fields overrides will be removed
productId - ID! The product which information should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "overridesToRemove": ["PRODUCT_PRE_ORDER_MESSAGE"],
  "productId": "4"
}

RemoveProductPreOrderSettingsOverridesResult

Description

Result of product pre-order settings overrides mutation.

Fields
Field Name Description
product - Product The product which pre-order settings overrides were removed as a result of mutation.
Example
{"product": Product}

RemoveProductSeoInformationOverridesInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! Product overrides locale context input
overridesToRemove - [ProductSeoInformationField!] Set of the product seo information fields which overrides should be removed. Empty value means all the product seo information fields overrides will be removed
productId - ID! The product which information should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "overridesToRemove": ["PRODUCT_META_DESCRIPTION_FIELD"],
  "productId": "4"
}

RemoveProductSeoInformationOverridesResult

Description

Result of product seo information overrides mutation.

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

RemoveProductStorefrontDetailsOverridesInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! Product overrides locale context input
overridesToRemove - [ProductStorefrontDetailsField!] Set of the product storefront details fields which overrides should be removed. Empty value means all the product storefront details fields overrides will be removed
productId - ID! The product which information should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "overridesToRemove": ["PRODUCT_AVAILABILITY_DESCRIPTION_FIELD"],
  "productId": 4
}

RemoveProductStorefrontDetailsOverridesResult

Description

Result of product storefront details overrides mutation.

Fields
Field Name Description
product - Product The product which storefront details overrides were removed as a result of mutation.
Example
{"product": Product}

RemoveProductUrlPathOverrideInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! Product overrides locale context input.
productId - ID! The product which url path information should be removed.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "productId": "4"
}

RemoveProductUrlPathOverrideResult

Description

Result of product url path override mutation.

Fields
Field Name Description
product - Product The product which url path override was removed as a result of mutation.
Example
{"product": Product}

RemoveRadioButtonsProductModifierOverridesField

Description

Radio buttons product modifier overrides field name

Values
Enum Value Description

RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveRadioButtonsProductModifierOverridesInput

Description

Radio buttons product modifier overrides input

Fields
Input Field Description
fields - [RemoveRadioButtonsProductModifierOverridesField!] Radio buttons product modifier fields to remove overrides for
values - RemoveRadioButtonsProductModifierValueOverridesInput Radio buttons product modifier values to remove overrides for
Example
{
  "fields": ["RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveRadioButtonsProductModifierValueOverridesInput
}

RemoveRadioButtonsProductModifierValueOverridesInput

Description

Radio buttons product modifier values to remove overrides for

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

RemoveRadioButtonsProductOptionOverridesField

Description

Radio buttons product option overrides field names

Values
Enum Value Description

RADIO_BUTTONS_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"RADIO_BUTTONS_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveRadioButtonsProductOptionOverridesInput

Description

Radio buttons product option overrides input

Fields
Input Field Description
fields - [RemoveRadioButtonsProductOptionOverridesField!] Radio buttons product option fields to remove overrides for
values - RemoveRadioButtonsProductOptionValuesOverridesInput Radio buttons product option values to remove overrides for
Example
{
  "fields": ["RADIO_BUTTONS_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveRadioButtonsProductOptionValuesOverridesInput
}

RemoveRadioButtonsProductOptionValuesOverridesInput

Description

Radio buttons product option values to remove overrides for

Fields
Input Field Description
ids - [ID!]! Radio buttons product option values ids to remove overrides for
Example
{"ids": [4]}

RemoveRadioButtonsSharedProductOptionOverridesField

Description

Radio buttons shared product option overrides field names

Values
Enum Value Description

RADIO_BUTTONS_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"RADIO_BUTTONS_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveRadioButtonsSharedProductOptionOverridesInput

Description

Radio buttons shared product option overrides input

Fields
Input Field Description
fields - [RemoveRadioButtonsSharedProductOptionOverridesField!] Radio buttons shared product option fields to remove overrides for
values - RemoveRadioButtonsSharedProductOptionValuesOverridesInput Radio buttons shared product option values to remove overrides for
Example
{
  "fields": ["RADIO_BUTTONS_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveRadioButtonsSharedProductOptionValuesOverridesInput
}

RemoveRadioButtonsSharedProductOptionValuesOverridesInput

Description

Radio buttons shared product option values to remove overrides for

Fields
Input Field Description
ids - [ID!]! Radio buttons shared product option values ids to remove overrides for
Example
{"ids": ["4"]}

RemoveRectangleListProductModifierOverridesField

Description

Rectangle list product modifier overrides field name

Values
Enum Value Description

RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveRectangleListProductModifierOverridesInput

Description

Rectangle list product modifier overrides input

Fields
Input Field Description
fields - [RemoveRectangleListProductModifierOverridesField!] Rectangle list product modifier fields to remove overrides for
values - RemoveRectangleListProductModifierValueOverridesInput Rectangle list product modifier values to remove overrides for
Example
{
  "fields": ["RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveRectangleListProductModifierValueOverridesInput
}

RemoveRectangleListProductModifierValueOverridesInput

Description

Rectangle list product modifier values to remove overrides for

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

RemoveRectangleListProductOptionOverridesField

Description

Rectangle list product option overrides field names

Values
Enum Value Description

RECTANGLE_LIST_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"RECTANGLE_LIST_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveRectangleListProductOptionOverridesInput

Description

Rectangle list product option overrides input

Fields
Input Field Description
fields - [RemoveRectangleListProductOptionOverridesField!] Rectangle list product option fields to remove overrides for
values - RemoveRectangleListProductOptionValuesOverridesInput Rectangle list product option values to remove overrides for
Example
{
  "fields": ["RECTANGLE_LIST_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveRectangleListProductOptionValuesOverridesInput
}

RemoveRectangleListProductOptionValuesOverridesInput

Description

Rectangle list product option values to remove overrides for

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

RemoveRectangleListSharedProductOptionOverridesField

Description

Rectangle list shared product option overrides field names

Values
Enum Value Description

RECTANGLE_LIST_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"RECTANGLE_LIST_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveRectangleListSharedProductOptionOverridesInput

Description

Rectangle list shared product option overrides input

Fields
Input Field Description
fields - [RemoveRectangleListSharedProductOptionOverridesField!] Rectangle list shared product option fields to remove overrides for
values - RemoveRectangleListSharedProductOptionValuesOverridesInput Rectangle list shared product option values to remove overrides for
Example
{
  "fields": ["RECTANGLE_LIST_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveRectangleListSharedProductOptionValuesOverridesInput
}

RemoveRectangleListSharedProductOptionValuesOverridesInput

Description

Rectangle list shared product option values to remove overrides for

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

RemoveSharedCheckboxProductModifierOverridesField

Description

Shared checkbox product modifier overrides field name

Values
Enum Value Description

SHARED_CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.

SHARED_CHECKBOX_PRODUCT_MODIFIER_VALUE_FIELD

The value field.
Example
"SHARED_CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedCheckboxProductModifierOverridesInput

Description

Shared checkbox product modifier overrides input

Fields
Input Field Description
fields - [RemoveSharedCheckboxProductModifierOverridesField!] Checkbox product modifier fields to remove overrides for
Example
{"fields": ["SHARED_CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveSharedDateFieldProductModifierOverridesField

Description

Shared date field product modifier overrides field name

Values
Enum Value Description

SHARED_DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedDateFieldProductModifierOverridesInput

Description

Shared date field product modifier overrides input

Fields
Input Field Description
fields - [RemoveSharedDateFieldProductModifierOverridesField!] Date field product modifier fields to remove overrides for
Example
{"fields": ["SHARED_DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveSharedDropdownProductModifierOverridesField

Description

Shared dropdown product modifier overrides field name

Values
Enum Value Description

SHARED_DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedDropdownProductModifierOverridesInput

Description

Shared dropdown product modifier overrides input

Fields
Input Field Description
fields - [RemoveSharedDropdownProductModifierOverridesField!] Dropdown product modifier fields to remove overrides for
values - RemoveSharedDropdownProductModifierValuesOverridesInput Dropdown product modifier values to remove overrides for
Example
{
  "fields": ["SHARED_DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveSharedDropdownProductModifierValuesOverridesInput
}

RemoveSharedDropdownProductModifierValuesOverridesInput

Description

Shared dropdown product modifier values to remove overrides for

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

RemoveSharedFileUploadProductModifierOverridesField

Description

Shared file upload product modifier overrides field name

Values
Enum Value Description

SHARED_FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedFileUploadProductModifierOverridesInput

Description

Shared file upload product modifier overrides input

Fields
Input Field Description
fields - [RemoveSharedFileUploadProductModifierOverridesField!] File upload product modifier fields to remove overrides for
Example
{"fields": ["SHARED_FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}

RemoveSharedMultiLineTextFieldProductModifierOverridesField

Description

Shared multiLine text field product modifier overrides field name

Values
Enum Value Description

SHARED_MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field default value.

SHARED_MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveSharedMultiLineTextFieldProductModifierOverridesInput

Description

Shared multiLine text product modifier overrides input

Fields
Input Field Description
fields - [RemoveSharedMultiLineTextFieldProductModifierOverridesField!] Multiline text field product modifier fields to remove overrides for
Example
{"fields": ["SHARED_MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

RemoveSharedNumberFieldProductModifierOverridesField

Description

Shared number field product modifier overrides field name

Values
Enum Value Description

SHARED_NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field value.

SHARED_NUMBER_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveSharedNumberFieldProductModifierOverridesInput

Description

Shared numbers only text field product modifier overrides input

Fields
Input Field Description
fields - [RemoveSharedNumberFieldProductModifierOverridesField!] Number field product modifier fields to remove overrides for
Example
{"fields": ["SHARED_NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

RemoveSharedProductModifierOverridesDataInput

Description

Shared product modifiers overrides data input

Fields
Input Field Description
modifiers - [RemoveSharedProductModifierOverridesInput!]! Product modifiers overrides data input
Example
{"modifiers": [RemoveSharedProductModifierOverridesInput]}

RemoveSharedProductModifierOverridesInput

Description

Shared product modifier overrides input

Fields
Input Field Description
modifierId - ID! The shared product modifier id which data should be removed.
data - RemoveSharedProductModifierOverridesUnionDataInput! Product modifier overrides data input
Example
{
  "modifierId": 4,
  "data": RemoveSharedProductModifierOverridesUnionDataInput
}

RemoveSharedProductModifierOverridesUnionDataInput

Description

Shared product modifier overrides data input, only one type is allowed to be passed at once

Fields
Input Field Description
checkbox - RemoveSharedCheckboxProductModifierOverridesInput Checkbox product modifier overrides input
dateField - RemoveSharedDateFieldProductModifierOverridesInput Date field product modifier overrides input
dropdown - RemoveSharedDropdownProductModifierOverridesInput Dropdown product modifier overrides input
fileUpload - RemoveSharedFileUploadProductModifierOverridesInput File upload product modifier overrides input
multiLineTextField - RemoveSharedMultiLineTextFieldProductModifierOverridesInput MultiLine text field product modifier overrides input
numberField - RemoveSharedNumberFieldProductModifierOverridesInput Number field product modifier overrides input
radioButtons - RemoveSharedRadioButtonsProductModifierOverridesInput Radio buttons product modifier overrides input
rectangleList - RemoveSharedRectangleListProductModifierOverridesInput Rectangle list product modifier overrides input
swatch - RemoveSharedSwatchProductModifierOverridesInput Swatch product modifier overrides input
textField - RemoveSharedTextFieldProductModifierOverridesInput Text field product modifier overrides input
Example
{
  "checkbox": RemoveSharedCheckboxProductModifierOverridesInput,
  "dateField": RemoveSharedDateFieldProductModifierOverridesInput,
  "dropdown": RemoveSharedDropdownProductModifierOverridesInput,
  "fileUpload": RemoveSharedFileUploadProductModifierOverridesInput,
  "multiLineTextField": RemoveSharedMultiLineTextFieldProductModifierOverridesInput,
  "numberField": RemoveSharedNumberFieldProductModifierOverridesInput,
  "radioButtons": RemoveSharedRadioButtonsProductModifierOverridesInput,
  "rectangleList": RemoveSharedRectangleListProductModifierOverridesInput,
  "swatch": RemoveSharedSwatchProductModifierOverridesInput,
  "textField": RemoveSharedTextFieldProductModifierOverridesInput
}

RemoveSharedProductModifiersOverridesInput

Description

Shared product modifiers overrides data input

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput! Shared product modifiers overrides locale context input
data - RemoveSharedProductModifierOverridesDataInput! Shared product modifiers overrides data input
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": RemoveSharedProductModifierOverridesDataInput
}

RemoveSharedProductModifiersOverridesResult

Description

Result of shared product modifiers overrides remove.

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

RemoveSharedProductOptionOverridesDataInput

Description

Shared product option overrides data input

Fields
Input Field Description
optionId - ID! The product option which overrides should be removed.
data - RemoveSharedProductOptionOverridesUnionDataInput! Shared product option overrides data input
Example
{
  "optionId": 4,
  "data": RemoveSharedProductOptionOverridesUnionDataInput
}

RemoveSharedProductOptionOverridesUnionDataInput

Description

Shared product option overrides data input

Fields
Input Field Description
dropdown - RemoveDropdownSharedProductOptionOverridesInput Dropdown shared product option overrides input
radioButtons - RemoveRadioButtonsSharedProductOptionOverridesInput Radio buttons shared product option overrides input
rectangleList - RemoveRectangleListSharedProductOptionOverridesInput Rectangle list shared product option overrides input
swatch - RemoveSwatchSharedProductOptionOverridesInput Swatch shared product option overrides input
Example
{
  "dropdown": RemoveDropdownSharedProductOptionOverridesInput,
  "radioButtons": RemoveRadioButtonsSharedProductOptionOverridesInput,
  "rectangleList": RemoveRectangleListSharedProductOptionOverridesInput,
  "swatch": RemoveSwatchSharedProductOptionOverridesInput
}

RemoveSharedProductOptionsOverridesDataInput

Description

Shared product options overrides data input

Fields
Input Field Description
options - [RemoveSharedProductOptionOverridesDataInput!]! Product option overrides data input
Example
{"options": [RemoveSharedProductOptionOverridesDataInput]}

RemoveSharedProductOptionsOverridesInput

Fields
Input Field Description
data - RemoveSharedProductOptionsOverridesDataInput! Shared product options overrides data input
localeContext - ProductOverridesLocaleContextInput! Product options overrides locale context input
Example
{
  "data": RemoveSharedProductOptionsOverridesDataInput,
  "localeContext": ProductOverridesLocaleContextInput
}

RemoveSharedProductOptionsOverridesResult

Description

Result of shared product options overrides mutation.

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

RemoveSharedRadioButtonsProductModifierOverridesField

Description

Shared radio buttons product modifier overrides field name

Values
Enum Value Description

SHARED_RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedRadioButtonsProductModifierOverridesInput

Description

Shared radio buttons product modifier overrides input

Fields
Input Field Description
fields - [RemoveSharedRadioButtonsProductModifierOverridesField!] Radio buttons product modifier fields to remove overrides for
values - RemoveSharedRadioButtonsProductModifierValuesOverridesInput Radio buttons product modifier values to remove overrides for
Example
{
  "fields": ["SHARED_RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveSharedRadioButtonsProductModifierValuesOverridesInput
}

RemoveSharedRadioButtonsProductModifierValuesOverridesInput

Description

Shared radio buttons product modifier values to remove overrides for

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

RemoveSharedRectangleListProductModifierOverridesField

Description

Shared rectangle list product modifier overrides field name

Values
Enum Value Description

SHARED_RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedRectangleListProductModifierOverridesInput

Description

Shared rectangle list product modifier overrides input

Fields
Input Field Description
fields - [RemoveSharedRectangleListProductModifierOverridesField!] Rectangle list product modifier fields to remove overrides for
values - RemoveSharedRectangleListProductModifierValuesOverridesInput Rectangle list product modifier values to remove overrides for
Example
{
  "fields": ["SHARED_RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveSharedRectangleListProductModifierValuesOverridesInput
}

RemoveSharedRectangleListProductModifierValuesOverridesInput

Description

Shared rectangle list product modifier values to remove overrides for

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

RemoveSharedSwatchProductModifierOverridesField

Description

Shared swatch product modifier overrides field name

Values
Enum Value Description

SHARED_SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSharedSwatchProductModifierOverridesInput

Description

Shared swatch product modifier overrides input

Fields
Input Field Description
fields - [RemoveSharedSwatchProductModifierOverridesField!] Swatch product modifier fields to remove overrides for
values - RemoveSharedSwatchProductModifierValuesOverridesInput Swatch product modifier values to remove overrides for
Example
{
  "fields": ["SHARED_SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveSharedSwatchProductModifierValuesOverridesInput
}

RemoveSharedSwatchProductModifierValuesOverridesInput

Description

Shared swatch product modifier values to remove overrides for

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

RemoveSharedTextFieldProductModifierOverridesField

Description

Shared text field product modifier overrides field name

Values
Enum Value Description

SHARED_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field default value.

SHARED_TEXT_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SHARED_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveSharedTextFieldProductModifierOverridesInput

Description

Shared text field product modifier overrides input

Fields
Input Field Description
fields - [RemoveSharedTextFieldProductModifierOverridesField!] Number field product modifier fields to remove overrides for
Example
{"fields": ["SHARED_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

RemoveSwatchProductModifierOverridesField

Description

Swatch product modifier overrides field name

Values
Enum Value Description

SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"

RemoveSwatchProductModifierOverridesInput

Description

Swatch product modifier overrides input

Fields
Input Field Description
fields - [RemoveSwatchProductModifierOverridesField!] Swatch product modifier fields to remove overrides for
values - RemoveSwatchProductModifierValuesOverridesInput Swatch product modifier values to remove overrides for
Example
{
  "fields": ["SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
  "values": RemoveSwatchProductModifierValuesOverridesInput
}

RemoveSwatchProductModifierValuesOverridesInput

Description

Swatch product modifier values to remove overrides for

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

RemoveSwatchProductOptionOverridesField

Description

Swatch product option overrides field names

Values
Enum Value Description

SWATCH_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"SWATCH_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveSwatchProductOptionOverridesInput

Description

Swatch product option overrides input

Fields
Input Field Description
fields - [RemoveSwatchProductOptionOverridesField!] Swatch product option fields to remove overrides for
values - RemoveSwatchProductOptionValuesOverridesInput Swatch product option values to remove overrides for
Example
{
  "fields": ["SWATCH_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveSwatchProductOptionValuesOverridesInput
}

RemoveSwatchProductOptionValuesOverridesInput

Description

Swatch product option values to remove overrides for

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

RemoveSwatchSharedProductOptionOverridesField

Description

Swatch shared product option overrides field names

Values
Enum Value Description

SWATCH_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD

The display name field.
Example
"SWATCH_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"

RemoveSwatchSharedProductOptionOverridesInput

Description

Swatch shared product option overrides input

Fields
Input Field Description
fields - [RemoveSwatchSharedProductOptionOverridesField!] Swatch shared product option fields to remove overrides for
values - RemoveSwatchSharedProductOptionValuesOverridesInput Swatch shared product option values to remove overrides for
Example
{
  "fields": ["SWATCH_SHARED_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
  "values": RemoveSwatchSharedProductOptionValuesOverridesInput
}

RemoveSwatchSharedProductOptionValuesOverridesInput

Description

Swatch shared product option values to remove overrides for

Fields
Input Field Description
ids - [ID!]! Swatch shared product option values ids to remove overrides for
Example
{"ids": ["4"]}

RemoveTextFieldProductModifierOverridesField

Description

Text field product modifier overrides field name

Values
Enum Value Description

TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD

The field default value.

TEXT_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD

The display name field.
Example
"TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"

RemoveTextFieldProductModifierOverridesInput

Description

Text field product modifier overrides input

Fields
Input Field Description
fields - [RemoveTextFieldProductModifierOverridesField!] Number field product modifier fields to remove overrides for
Example
{"fields": ["TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}

ScopeConnection

Description

A connection to a list of items.

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

ScopeEdge

Description

An edge in a connection.

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

SetCheckboxProductModifierInformationInput

Description

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

SetDateFieldProductModifierInformationInput

Description

Date field product modifier information

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

SetDropdownProductModifierInformationInput

Description

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

SetDropdownProductModifierValueInformationInput

Description

Dropdown product modifier value information

Fields
Input Field Description
valueId - ID! The dropdown product modifier value id which data should be modified.
label - String! Label for the dropdown product modifier value
Example
{"valueId": 4, "label": "xyz789"}

SetDropdownProductOptionInformationInput

Description

Dropdown product option information

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

SetDropdownProductOptionValueInformationInput

Description

Dropdown product option value information

Fields
Input Field Description
valueId - ID! The dropdown product option value id which data should be modified.
label - String! Label for the dropdown product option value
Example
{
  "valueId": "4",
  "label": "xyz789"
}

SetFileUploadProductModifierInformationInput

Description

File upload product modifier information

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

SetMultiLineTextFieldProductModifierInformationInput

Description

MultiLine text product modifier information

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

SetNumberFieldProductModifierInformationInput

Description

Numbers only text field product modifier information

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

SetPickListProductModifierInformationInput

Description

Pick list product modifier information

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

SetPickListProductModifierValueInformationInput

Description

Pick list product modifier value information

Fields
Input Field Description
valueId - ID! The pick list product modifier value id which data should be modified
label - String! Label for the pick list product modifier value
Example
{
  "valueId": "4",
  "label": "abc123"
}

SetProductBasicInformationDataInput

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

SetProductBasicInformationInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput Product overrides locale context input
data - SetProductBasicInformationDataInput!
productId - ID! The product which information should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductBasicInformationDataInput,
  "productId": 4
}

SetProductBasicInformationResult

Description

Result of product basic information mutation.

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

SetProductIsFeaturedDataInput

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

SetProductIsFeaturedInput

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

SetProductIsFeaturedResult

Description

Result of product isFeatured mutation.

Fields
Field Name Description
product - Product The product which isFeatured flag was updated as a result of mutation.
Example
{"product": Product}

SetProductModifierInformationDataInput

Description

Product modifiers information data

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

SetProductModifierInformationInput

Description

Product modifier information

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

SetProductModifierInformationUnionDataInput

Description

Product modifier information, only one type is allowed to be passed at once

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

SetProductModifiersInformationInput

Description

Product modifiers information

Fields
Input Field Description
productId - ID! The product id which modifiers data should be modified.
localeContext - ProductOverridesLocaleContextInput Product modifiers overrides locale context input
data - SetProductModifierInformationDataInput! Product modifiers information
Example
{
  "productId": "4",
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductModifierInformationDataInput
}

SetProductModifiersInformationResult

Description

Result of product modifier mutation.

Fields
Field Name Description
product - Product The product which was updated as a result of modifier mutation.
Example
{"product": Product}

SetProductOptionInformationInput

Description

Product option information

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

SetProductOptionInformationUnionDataInput

Description

Product option information, only one type is allowed to be passed at once

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

SetProductOptionsInformationDataInput

Description

Product options information data

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

SetProductOptionsInformationInput

Description

Product options information

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput Product options overrides locale context input
data - SetProductOptionsInformationDataInput! Product options information
productId - ID! The product id which options data should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductOptionsInformationDataInput,
  "productId": 4
}

SetProductOptionsInformationResult

Description

Result of product options information mutation.

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

SetProductPreOrderSettingsDataInput

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

SetProductPreOrderSettingsInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput Product overrides locale context input
data - SetProductPreOrderSettingsDataInput! Product pre-order settings data
productId - ID! The product which information should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductPreOrderSettingsDataInput,
  "productId": "4"
}

SetProductPreOrderSettingsResult

Description

Result of product pre-order settings information mutation.

Fields
Field Name Description
product - Product The product which pre-order settings information was updated as a result of mutation.
Example
{"product": Product}

SetProductSeoInformationDataInput

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

SetProductSeoInformationInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput Product overrides locale context input
data - SetProductSeoInformationDataInput!
productId - ID! The product which information should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductSeoInformationDataInput,
  "productId": "4"
}

SetProductSeoInformationResult

Description

Result of product seo information mutation.

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

SetProductStorefrontDetailsDataInput

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

SetProductStorefrontDetailsInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput Product overrides locale context input
data - SetProductStorefrontDetailsDataInput! Product storefront details data
productId - ID! The product which information should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductStorefrontDetailsDataInput,
  "productId": "4"
}

SetProductStorefrontDetailsResult

Description

Result of product storefront details information mutation.

Fields
Field Name Description
product - Product The product which storefront details information was updated as a result of mutation.
Example
{"product": Product}

SetProductUrlPathDataInput

Fields
Input Field Description
path - String! Product url path.
Example
{"path": "abc123"}

SetProductUrlPathInput

Fields
Input Field Description
localeContext - ProductOverridesLocaleContextInput Product overrides locale context input.
data - SetProductUrlPathDataInput! Product url path data.
productId - ID! The product which url path should be modified.
Example
{
  "localeContext": ProductOverridesLocaleContextInput,
  "data": SetProductUrlPathDataInput,
  "productId": 4
}

SetProductUrlPathResult

Description

Result of product url path mutation.

Fields
Field Name Description
product - Product The product which url path was updated as a result of mutation.
Example
{"product": Product}

SetRadioButtonsProductModifierInformationInput

Description

Radio buttons product modifier information

Fields
Input Field Description
displayName - String Display name for the radio buttons product modifier
values - [SetRadioButtonsProductModifierValueInformationInput!] Radio buttons modifier values information
Example
{
  "displayName": "abc123",
  "values": [
    SetRadioButtonsProductModifierValueInformationInput
  ]
}

SetRadioButtonsProductModifierValueInformationInput

Description

Radio buttons product modifier value information

Fields
Input Field Description
valueId - ID! The radio buttons product modifier value id which data should be modified.
label - String! Label for the radio buttons product modifier value
Example
{
  "valueId": "4",
  "label": "xyz789"
}

SetRadioButtonsProductOptionInformationInput

Description

Radio buttons product option information

Fields
Input Field Description
displayName - String Display name for the radio buttons product option
values - [SetRadioButtonsProductOptionValueInformationInput!] Radio buttons product option values information
Example
{
  "displayName": "xyz789",
  "values": [
    SetRadioButtonsProductOptionValueInformationInput
  ]
}

SetRadioButtonsProductOptionValueInformationInput

Description

Radio buttons product option value information

Fields
Input Field Description
valueId - ID! The radio buttons product option value id which data should be modified.
label - String! Label for the radio buttons product option value
Example
{
  "valueId": "4",
  "label": "abc123"
}

SetRectangleListProductModifierInformationInput

Description

Rectangle list product modifier information

Fields
Input Field Description
displayName - String Display name for the rectangle list product modifier
values - [SetRectangleListProductModifierValueInformationInput!] Rectangle list modifier values information
Example
{
  "displayName": "xyz789",
  "values": [
    SetRectangleListProductModifierValueInformationInput
  ]
}

SetRectangleListProductModifierValueInformationInput

Description

Rectangle list product modifier value information

Fields
Input Field Description
valueId - ID! The rectangle list product modifier value id which data should be modified.
label - String! Label for the rectangle list product modifier value
Example
{"valueId": 4, "label": "abc123"}

SetRectangleListProductOptionInformationInput

Description

Rectangle list product option information

Fields
Input Field Description
displayName - String Display name for the rectangle list product option
values - [SetRectangleListProductOptionValueInformationInput!] Rectangle list product option values information
Example
{
  "displayName": "xyz789",
  "values": [
    SetRectangleListProductOptionValueInformationInput
  ]
}

SetRectangleListProductOptionValueInformationInput

Description

Rectangle list product option value information

Fields
Input Field Description
valueId - ID! The rectangle list product option value id which data should be modified.
label - String! Label for the rectangle list product option value
Example
{"valueId": 4, "label": "xyz789"}

SetSharedCheckboxProductModifierInformationInput

Description

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

SetSharedDateFieldProductModifierInformationInput

Description

Shared date field product modifier information

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

SetSharedDropdownProductModifierInformationInput

Description

Shared dropdown product modifier information

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

SetSharedDropdownProductModifierValueInformationInput

Description

Shared dropdown product modifier value information

Fields
Input Field Description
valueId - ID! The dropdown product modifier value id which data should be modified.
label - String! Label for the dropdown product modifier value
Example
{"valueId": 4, "label": "xyz789"}

SetSharedDropdownProductOptionInformationInput

Description

Dropdown product option information

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

SetSharedDropdownProductOptionValueInformationInput

Description

Dropdown product option value information

Fields
Input Field Description
valueId - ID! The dropdown product option value id which data should be modified.
label - String! Label for the dropdown product option value
Example
{
  "valueId": "4",
  "label": "abc123"
}

SetSharedFileUploadProductModifierInformationInput

Description

Shared file upload product modifier information

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

SetSharedMultiLineTextFieldProductModifierInformationInput

Description

Shared multiLine text product modifier information

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

SetSharedNumberFieldProductModifierInformationInput

Description

Shared numbers only text field product modifier information

Fields
Input Field Description
defaultValue - Float Default value for the numbers only text field product modifier
displayName - String Display name for the numbers only text field product modifier
Example
{
  "defaultValue": 123.45,
  "displayName": "xyz789"
}

SetSharedProductModifierInformationDataInput

Description

Shared product modifiers information data

Fields
Input Field Description
modifiers - [SetSharedProductModifierInformationInput!]! Shared product modifiers information data
Example
{"modifiers": [SetSharedProductModifierInformationInput]}

SetSharedProductModifierInformationInput

Description

Shared product modifier information

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

SetSharedProductModifierInformationUnionDataInput

Description

Shared product modifier information, only one type is allowed to be passed at once

Fields
<
Input Field Description
checkbox - SetSharedCheckboxProductModifierInformationInput Checkbox product modifier information
dateField - SetSharedDateFieldProductModifierInformationInput Date field product modifier information
dropdown - SetSharedDropdownProductModifierInformationInput Dropdown product modifier information
fileUpload - SetSharedFileUploadProductModifierInformationInput File upload product modifier information
multiLineTextField - SetSharedMultiLineTextFieldProductModifierInformationInput MultiLine text field product modifier information
numberField - SetSharedNumberFieldProductModifierInformationInput Number field product modifier information