GraphQL Admin API Reference
Queries
client
Description
A client.
Response
Returns a Client
Example
Query
query client {
client {
clientId
scopes {
...ScopeConnectionFragment
}
}
}
Response
{
"data": {
"client": {
"clientId": "xyz789",
"scopes": ScopeConnection
}
}
}
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": "xyz789",
"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}
}
}
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": "abc123"
}
AppExtensionContext
Description
Defines the action that the control panel performs after the user clicks the App Extension label.
Values
Enum Value | Description |
---|---|
|
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. |
|
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": "abc123",
"value": "xyz789"
}
AppExtensionLabelLocaleInput
Description
A developer-defined list of alternate link text values and their corresponding locale codes.
Fields
Input Field | Description |
---|---|
localeCode - String!
|
A locale code that corresponds with a control-panel supported language. For example, de-DE for German. See the App Extensions documentation for a list of currently supported languages and corresponding locale codes. |
value - String!
|
The link text value in the language of the locale code. Suggested length of ≤25 characters; limit 255 characters. |
Example
{
"localeCode": "abc123",
"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 |
---|---|
|
The App Extension appears on the supported customer-related pages and takes Customer properties as arguments. |
|
The App Extension appears on the supported orders-related pages and takes Orders properties as arguments. |
|
The App Extension appears on the supported products-related pages and takes Products properties as arguments. |
|
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
|
|
id - ID!
|
The ID of the object. |
displayName - String!
|
Product modifier display name. |
isRequired - Boolean!
|
Indicates whether product modifier is required. |
isShared - Boolean!
|
Indicates whether product modifier is shared or local. |
Example
{
"checkedByDefault": true,
"fieldValue": "xyz789",
"overridesForLocale": CheckboxProductModifierForLocale,
"id": "4",
"displayName": "xyz789",
"isRequired": true,
"isShared": true
}
CheckboxProductModifierForLocale
Client
CreateAppExtensionInput
Fields
Input Field | Description |
---|---|
context - AppExtensionContext!
|
Defines the action that the control panel performs after the user clicks the App Extension label. |
label - AppExtensionLabelInput!
|
The locale-aware link text options for the App Extension's menu item. The control panel user sees this text value wherever they have the option to open the App Extension. |
model - AppExtensionModel!
|
The entity type to which the App Extension relates; for example, Orders. The model corresponds with the page on which the App Extension appears. |
url - String!
|
A relative path with some meaning to your app, most commonly an internally-defined GET route. The path should contain a path parameter that the app expects to be templated into its route, defined as a JavaScript string template expression. For example, /customer/auth/${id} . Currently, id is the only supported parameter. Limit 255 characters. |
Example
{
"context": "LINK",
"label": AppExtensionLabelInput,
"model": "CUSTOMERS",
"url": "abc123"
}
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": "abc123",
"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
|
|
id - ID!
|
The ID of the object. |
displayName - String!
|
Product modifier display name. |
isRequired - Boolean!
|
Indicates whether product modifier is required. |
isShared - Boolean!
|
Indicates whether product modifier is shared or local. |
Example
{
"overridesForLocale": DateFieldProductModifierForLocale,
"id": 4,
"displayName": "abc123",
"isRequired": true,
"isShared": false
}
DateFieldProductModifierForLocale
Description
Date field product modifier overrides.
Fields
Field Name | Description |
---|---|
displayName - String
|
Date field 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
DropdownOptionValueForLocale
DropdownProductModifier
Description
Dropdown product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - DropdownProductModifierForLocale
|
Dropdown product modifier overrides for locale. |
Arguments
|
|
values - [DropdownProductModifierValue!]!
|
Dropdown product modifiers values. |
id - ID!
|
The ID of the object. |
displayName - String!
|
Product modifier display name. |
isRequired - Boolean!
|
Indicates whether product modifier is required. |
isShared - Boolean!
|
Indicates whether product modifier is shared or local. |
Example
{
"overridesForLocale": DropdownProductModifierForLocale,
"values": [DropdownProductModifierValue],
"id": 4,
"displayName": "xyz789",
"isRequired": false,
"isShared": true
}
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": "xyz789",
"values": [DropdownProductModifierValueForLocale]
}
DropdownProductModifierValue
Description
Dropdown product modifier value.
Example
{
"id": "4",
"isDefault": true,
"label": "xyz789"
}
DropdownProductModifierValueForLocale
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
|
|
values - [ProductOptionValue!]!
|
List of product option values. |
Example
{
"displayName": "abc123",
"isShared": false,
"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": "xyz789",
"values": [ProductOptionValueForLocale]
}
EntityAlreadyExistsError
EntityError
EntityNotFoundError
Error
Description
Common interface for all errors.
Fields
Field Name | Description |
---|---|
message - String!
|
Information about error. |
Possible Types
Error Types |
---|
Example
{"message": "xyz789"}
FileUploadProductModifier
Description
File upload product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - FileUploadProductModifierForLocale
|
File upload product modifier overrides for locale. |
Arguments
|
|
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": true,
"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"}
Float
Description
The Float
scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
ID
Description
The ID
scalar type represents a unique identifier, often used to re-fetch an object or as key for a cache.
Example
4
Int
Description
The Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
Long
Description
The Long
scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1.
Example
{}
Metafield
Description
A metafield.
Fields
Field Name | Description |
---|---|
id - ID!
|
The ID of the metafield. |
description - String!
|
Metafield description. |
key - String!
|
Metafield key. |
namespace - String!
|
Metafield namespace. |
permissionSet - MetafieldsPermissionSet!
|
Metafield permission set. |
resourceId - ID!
|
Resource id of an entity metafield related to. |
value - String!
|
Metafield value. |
ownerClientId - String!
|
Identifier of metafields owner. |
Example
{
"id": "4",
"description": "xyz789",
"key": "xyz789",
"namespace": "abc123",
"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 |
---|---|
|
Private to the app that owns the field. |
|
Visible to other API consumers. |
|
Visible to other API consumers, including on storefront. |
|
Open for reading and writing by other API consumers. |
|
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 |
---|---|
|
Metafield is associated with brand. |
|
Metafield is associated with cart. |
|
Metafield is associated with category. |
|
Metafield is associated with channel. |
|
Metafield is associated with customer. |
|
Metafield is associated with location. |
|
Metafield is associated with order. |
|
Metafield is associated with product. |
|
Metafield is associated with store. |
|
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
|
|
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": "abc123",
"isRequired": false,
"isShared": true
}
MultilineTextFieldProductModifierForLocale
Description
Multiline text field product modifier overrides.
Example
{
"defaultValue": "xyz789",
"displayName": "abc123"
}
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
|
|
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": 123.45,
"overridesForLocale": NumbersOnlyTextFieldProductModifierForLocale,
"id": 4,
"displayName": "abc123",
"isRequired": false,
"isShared": true
}
NumbersOnlyTextFieldProductModifierForLocale
Description
Numbers only text field product modifier overrides.
Example
{
"defaultValue": 987.65,
"displayName": "abc123"
}
PageInfo
Description
Information about pagination in a connection.
Fields
Field Name | Description |
---|---|
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
endCursor - String
|
When paginating forwards, the cursor to continue. |
Example
{
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "xyz789",
"endCursor": "xyz789"
}
PickListModifierValue
Description
Pick list product modifier value.
Example
{
"id": 4,
"isDefault": true,
"label": "xyz789"
}
PickListModifierValueForLocale
PickListProductModifier
Description
Pick list product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - PickListProductModifierForLocale
|
Pick list product modifier overrides for locale. |
Arguments
|
|
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": "abc123",
"isRequired": true,
"isShared": false
}
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": "abc123",
"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": "abc123"}
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. |
urlPath - ProductUrlPath!
|
Product path. |
options - ProductOptionConnection!
|
List of product options. |
overridesForLocale - ProductOverridesForLocale
|
Product overrides for specific channel and locale. |
Arguments
|
|
overridesForChannel - ProductOverridesForChannel
|
Product overrides for specific channel. |
Arguments
|
|
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
ProductBasicInformationField
Description
Product basic information field names
Values
Enum Value | Description |
---|---|
|
The description field. |
|
The name field. |
Example
"PRODUCT_DESCRIPTION_FIELD"
ProductBasicInformationOverridesForLocale
Description
Product basic information overrides for 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
ProductModifier
Description
A product modifier.
Fields
Field Name | Description |
---|---|
id - ID!
|
The ID of the object. |
displayName - String!
|
Product modifier display name. |
isRequired - Boolean!
|
Indicates whether product modifier is required. |
isShared - Boolean!
|
Indicates whether product modifier is shared or local. |
Possible Types
ProductModifier Types |
---|
Example
{
"id": "4",
"displayName": "abc123",
"isRequired": false,
"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": "xyz789"
}
ProductMutations
Description
Product mutations.
Fields
Field Name | Description |
---|---|
removeProductBasicInformationOverrides - RemoveProductBasicInformationOverridesResult
|
Removes product's basic information overrides. |
Arguments |
|
removeProductSeoInformationOverrides - RemoveProductSeoInformationOverridesResult
|
Removes product's seo information overrides. |
Arguments |
|
removeProductOptionsOverrides - RemoveProductOptionsOverridesResult
|
Removes product's options overrides. |
Arguments |
|
removeProductStorefrontDetailsOverrides - RemoveProductStorefrontDetailsOverridesResult
|
Removes product's storefront details overrides. |
Arguments |
|
removeProductPreOrderSettingsOverrides - RemoveProductPreOrderSettingsOverridesResult
|
Removes product's pre-order settings overrides. |
Arguments |
|
setProductBasicInformation - SetProductBasicInformationResult
|
Sets product's basic information. |
Arguments
|
|
setProductIsFeatured - SetProductIsFeaturedResult
|
Sets product's isFeatured flag. |
Arguments
|
|
removeProductIsFeaturedOverride - RemoveProductIsFeaturedOverrideResult
|
Removes product's isFeatured override. |
Arguments |
|
setProductSeoInformation - SetProductSeoInformationResult
|
Sets product's seo information. |
Arguments
|
|
setProductStorefrontDetails - SetProductStorefrontDetailsResult
|
Sets product's storefront details information. |
Arguments |
|
setProductPreOrderSettings - SetProductPreOrderSettingsResult
|
Sets product's pre-order settings information. |
Arguments
|
|
setProductOptionsInformation - SetProductOptionsInformationResult
|
Sets product's options information. |
Arguments |
|
setProductUrlPath - SetProductUrlPathResult
|
Sets product's url path. |
Arguments
|
|
removeProductUrlPathOverride - RemoveProductUrlPathOverrideResult
|
Removes product's url path override. |
Arguments |
|
setProductModifiersInformation - SetProductModifiersInformationResult
|
Sets product's modifiers information. |
Arguments |
|
removeProductModifiersOverrides - RemoveProductModifiersOverridesResult
|
Remove product's modifiers overrides. |
Arguments |
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
|
|
values - [ProductOptionValue!]!
|
List of product option values. |
Possible Types
ProductOption Types |
---|
Example
{
"displayName": "xyz789",
"isShared": false,
"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. |
Possible Types
ProductOptionForLocale Types |
---|
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. |
Possible Types
ProductOptionValue Types |
---|
Example
{
"id": 4,
"isDefault": false,
"label": "abc123"
}
ProductOptionValueForLocale
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
ProductPreOrderSettingsField
Description
Product pre-order settings field names
Values
Enum Value | Description |
---|---|
|
The pre-order message. |
Example
"PRODUCT_PRE_ORDER_MESSAGE"
ProductSeoInformation
ProductSeoInformationField
Description
Product seo information field names
Values
Enum Value | Description |
---|---|
|
The meta description field. |
|
The page title field. |
Example
"PRODUCT_META_DESCRIPTION_FIELD"
ProductSeoInformationOverridesForLocale
Description
Product seo information overrides for channel and locale
Example
{
"metaDescription": "abc123",
"pageTitle": "abc123"
}
ProductStorefrontDetailsField
Description
Product storefront details field names
Values
Enum Value | Description |
---|---|
|
The availability description. |
|
The search keywords. |
|
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": "xyz789"}
ProductsFiltersInput
Fields
Input Field | Description |
---|---|
ids - [ID!]
|
The unique identifiers of the products. |
Example
{"ids": [4]}
RadioButtonsModifierValue
Description
Radio buttons product modifier value.
Example
{
"id": 4,
"isDefault": true,
"label": "xyz789"
}
RadioButtonsModifierValueForLocale
RadioButtonsOptionValue
Description
Radio buttons product option value
Example
{
"id": "4",
"isDefault": false,
"label": "xyz789"
}
RadioButtonsOptionValueForLocale
RadioButtonsProductModifier
Description
Radio buttons product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - RadioButtonsProductModifierForLocale
|
Radio buttons product modifier overrides for locale. |
Arguments
|
|
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": true
}
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
|
|
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": "xyz789",
"values": [ProductOptionValueForLocale]
}
ReassignMetafieldOwnerError
Description
Errors that can occure while reassigning metafields owner. One of: EntityNotFound or EntityAlreadyExists.
Types
Union Types |
---|
Example
EntityNotFoundError
ReassignMetafieldsOwnerInput
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.
Example
{
"id": "4",
"isDefault": true,
"label": "abc123"
}
RectangleListModifierValueForLocale
RectangleListOptionValue
RectangleListOptionValueForLocale
RectangleListProductModifier
Description
Rectangle list product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - RectangleListProductModifierForLocale
|
Rectangle list product modifier overrides for locale. |
Arguments
|
|
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": "xyz789",
"isRequired": false,
"isShared": true
}
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
|
|
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]
}
RemoveCheckboxProductModifierOverridesField
Description
Checkbox product modifier overrides field name
Values
Enum Value | Description |
---|---|
|
The display name 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 |
---|---|
|
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 |
---|---|
|
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 |
---|---|
|
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"]}
RemoveFileUploadProductModifierOverridesField
Description
File upload product modifier overrides field name
Values
Enum Value | Description |
---|---|
|
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 |
---|---|
|
The field default value. |
|
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 |
---|---|
|
The field value. |
|
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 |
---|---|
|
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
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 |
---|---|
|
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 |
---|---|
|
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"]}
RemoveRectangleListProductModifierOverridesField
Description
Rectangle list product modifier overrides field name
Values
Enum Value | Description |
---|---|
|
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 |
---|---|
|
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]}
RemoveSwatchProductModifierOverridesField
Description
Swatch product modifier overrides field name
Values
Enum Value | Description |
---|---|
|
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 |
---|---|
|
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"]}
RemoveTextFieldProductModifierOverridesField
Description
Text field product modifier overrides field name
Values
Enum Value | Description |
---|---|
|
The field default value. |
|
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
SetCheckboxProductModifierInformationInput
SetDateFieldProductModifierInformationInput
Description
Date field product modifier information
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the date field product modifier |
Example
{"displayName": "xyz789"}
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
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": "xyz789",
"values": [
SetDropdownProductOptionValueInformationInput
]
}
SetDropdownProductOptionValueInformationInput
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
SetNumberFieldProductModifierInformationInput
Description
Numbers only text field product modifier information
Example
{
"defaultValue": 123.45,
"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": "abc123",
"values": [
SetPickListProductModifierValueInformationInput
]
}
SetPickListProductModifierValueInformationInput
SetProductBasicInformationDataInput
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": true}
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
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
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": "xyz789"}
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": "xyz789",
"values": [
SetRadioButtonsProductModifierValueInformationInput
]
}
SetRadioButtonsProductModifierValueInformationInput
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
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
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": "abc123",
"values": [
SetRectangleListProductOptionValueInformationInput
]
}
SetRectangleListProductOptionValueInformationInput
SetSwatchProductModifierInformationInput
Description
Swatch product modifier information
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the swatch product modifier |
values - [SetSwatchProductModifierValueInformationInput!]
|
Swatch modifier values information |
Example
{
"displayName": "xyz789",
"values": [
SetSwatchProductModifierValueInformationInput
]
}
SetSwatchProductModifierValueInformationInput
SetSwatchProductOptionInformationInput
Description
Swatch product option information
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the swatch product option |
values - [SetSwatchProductOptionValueInformationInput!]
|
Swatch product option values information |
Example
{
"displayName": "abc123",
"values": [SetSwatchProductOptionValueInformationInput]
}
SetSwatchProductOptionValueInformationInput
SetTextFieldProductModifierInformationInput
Store
Description
A store.
Fields
Field Name | Description |
---|---|
account - Account
|
An account. |
appExtensions - AppExtensionsConnection!
|
A list of App Extensions that the requesting API account has installed on the store. |
id - ID!
|
The ID of the object. |
metafield - Metafield
|
Single metafield. |
Arguments
|
|
metafields - MetafieldsConnection!
|
List of metafields. |
Arguments |
|
product - Product
|
Single product. |
Arguments
|
|
products - ProductConnection!
|
List of products. |
Arguments |
|
settings - StoreSettings
|
Store settings. |
sharedProductModifiers - SharedProductModifierConnection!
|
List of shared product modifiers. |
Arguments |
|
sharedProductOptions - SharedProductOptionConnection!
|
List of shared product options. |
Arguments |
|
storeHash - String!
|
Store hash. |
storeReferenceId - String!
|
Store reference ID. |
Example
{
"account": Account,
"appExtensions": AppExtensionsConnection,
"id": "4",
"metafield": Metafield,
"metafields": MetafieldsConnection,
"product": Product,
"products": ProductConnection,
"settings": StoreSettings,
"sharedProductModifiers": SharedProductModifierConnection,
"sharedProductOptions": SharedProductOptionConnection,
"storeHash": "abc123",
"storeReferenceId": "abc123"
}
StoreSettings
Description
Store settings.
Fields
Field Name | Description |
---|---|
dataSolutions - DataSolutionsSettings!
|
Data solutions. |
storeName - String!
|
Store name. |
Example
{
"dataSolutions": DataSolutionsSettings,
"storeName": "xyz789"
}
StoreSettingsMutations
Description
Store settings mutations.
Fields
Field Name | Description |
---|---|
dataSolutions - DataSolutionsMutations!
|
Data solutions mutations. |
Example
{"dataSolutions": DataSolutionsMutations}
StorefrontDetails
Description
A Storefront details.
Example
{
"warranty": "xyz789",
"availabilityDescription": "xyz789",
"searchKeywords": "abc123"
}
StorefrontDetailsOverridesForLocale
Description
A Storefront details overrides for channel and locale.
Example
{
"warranty": "xyz789",
"availabilityDescription": "abc123",
"searchKeywords": "xyz789"
}
String
Description
The String
scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
SwatchOptionValue
SwatchOptionValueForLocale
SwatchProductModifier
Description
Swatch product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - SwatchProductModifierForLocale
|
Swatch product modifier overrides for locale. |
Arguments
|
|
values - [SwatchProductModifierValue!]!
|
Swatch product modifiers values. |
id - ID!
|
The ID of the object. |
displayName - String!
|
Product modifier display name. |
isRequired - Boolean!
|
Indicates whether product modifier is required. |
isShared - Boolean!
|
Indicates whether product modifier is shared or local. |
Example
{
"overridesForLocale": SwatchProductModifierForLocale,
"values": [SwatchProductModifierValue],
"id": "4",
"displayName": "xyz789",
"isRequired": false,
"isShared": false
}
SwatchProductModifierForLocale
Description
Swatch product modifier overrides.
Fields
Field Name | Description |
---|---|
displayName - String
|
Swatch product modifier display name override for locale. |
values - [SwatchProductModifierValueForLocale!]!
|
Swatch product modifiers values overrides for locale. |
Example
{
"displayName": "xyz789",
"values": [SwatchProductModifierValueForLocale]
}
SwatchProductModifierValue
Description
Swatch product modifier value.
Example
{
"id": "4",
"isDefault": true,
"label": "xyz789"
}
SwatchProductModifierValueForLocale
SwatchProductOption
Description
Swatch product option
Fields
Field Name | Description |
---|---|
displayName - String!
|
Display name for the option. |
isShared - Boolean!
|
Indicates whether product option is shared or local. |
id - ID!
|
The ID of the object. |
overridesForLocale - ProductOptionForLocale
|
Option overrides for locale. |
Arguments
|
|
values - [ProductOptionValue!]!
|
List of product option values. |
Example
{
"displayName": "abc123",
"isShared": false,
"id": 4,
"overridesForLocale": ProductOptionForLocale,
"values": [ProductOptionValue]
}
SwatchProductOptionForLocale
Description
Swatch 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]
}
System
Description
System settings.
Fields
Field Name | Description |
---|---|
time - Long!
|
The current time. |
Example
{"time": {}}
TextFieldProductModifier
Description
Text field product modifier.
Fields
Field Name | Description |
---|---|
defaultValue - String
|
Text field modifier default value. |
overridesForLocale - TextFieldProductModifierForLocale
|
Text field product modifier overrides for locale. |
Arguments
|
|
id - ID!
|
The ID of the object. |
displayName - String!
|
Product modifier display name. |
isRequired - Boolean!
|
Indicates whether product modifier is required. |
isShared - Boolean!
|
Indicates whether product modifier is shared or local. |
Example
{
"defaultValue": "abc123",
"overridesForLocale": TextFieldProductModifierForLocale,
"id": 4,
"displayName": "abc123",
"isRequired": false,
"isShared": true
}
TextFieldProductModifierForLocale
Description
Text field product modifier overrides.
Example
{
"defaultValue": "xyz789",
"displayName": "xyz789"
}
UpdateAppExtensionDataInput
Fields
Input Field | Description |
---|---|
label - UpdateAppExtensionLabelInput
|
An object that contains all of the desired locale-aware link text options for an App Extension, including new link text options. |
url - String
|
A new relative path containing a supported path parameter that the app expects to be templated into its route, defined as a JavaScript string template expression. Currently, id is supported. Limit 255 characters. See the AppExtension response object schema for more detail. |
Example
{
"label": UpdateAppExtensionLabelInput,
"url": "abc123"
}
UpdateAppExtensionInput
Fields
Input Field | Description |
---|---|
data - UpdateAppExtensionDataInput!
|
The App Extension data to be changed. Currently, only the url and label properties can be updated. Changes to the label object overwrite existing values, rather than upserting. Be sure to send the whole label object you intend the App Extension to have, not just the changes. |
id - ID!
|
The ID of the object. |
Example
{
"data": UpdateAppExtensionDataInput,
"id": "4"
}
UpdateAppExtensionLabelInput
Description
The label of the App Extension.
Fields
Input Field | Description |
---|---|
defaultValue - String
|
The link text that the user sees when the control panel language is English or not defined by the developer in label.locales . The defaultValue should be in English. Suggested length of ≤25 characters; limit 255 characters. |
locales - [AppExtensionLabelLocaleInput!]
|
A list of alternate link text values and their corresponding locale codes. |
Example
{
"defaultValue": "abc123",
"locales": [AppExtensionLabelLocaleInput]
}
UpdateAppExtensionResult
Fields
Field Name | Description |
---|---|
appExtension - AppExtension
|
The response object properties available after updating an App Extension. |
Example
{"appExtension": AppExtension}
UpdateDataLayerInput
Fields
Input Field | Description |
---|---|
isDataLayerEnabled - Boolean!
|
is data layer enabled |
Example
{"isDataLayerEnabled": true}
UpdateDataLayerResult
Description
Result of mutation.
Fields
Field Name | Description |
---|---|
dataSolutions - DataSolutionsSettings
|
Data solutions object that is updated as a result of mutation. |
Example
{"dataSolutions": DataSolutionsSettings}
UpdateMetafieldDataInput
Fields
Input Field | Description |
---|---|
namespace - String
|
Namespace for the metafield. |
key - String
|
The name of the metafield. |
value - String
|
Value of the metafield. |
description - String
|
Description of the metafield. |
permissionSet - MetafieldsPermissionSet
|
Determines the visibility and writeability of the field by other API consumers. |
Example
{
"namespace": "xyz789",
"key": "xyz789",
"value": "abc123",
"description": "xyz789",
"permissionSet": "APP_ONLY"
}
UpdateMetafieldInput
Fields
Input Field | Description |
---|---|
id - ID!
|
Id of metafield to update. |
data - UpdateMetafieldDataInput!
|
Data to update. |
Example
{
"id": "4",
"data": UpdateMetafieldDataInput
}
UpdateMetafieldResult
Fields
Field Name | Description |
---|---|
metafield - Metafield
|
Updated metafield. |
Example
{"metafield": Metafield}
ValidationError
Description
Error indicating that the input is invalid.
Fields
Field Name | Description |
---|---|
message - String!
|
Information about error. |
Example
{"message": "abc123"}