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
}
}
}
node
Description
Fetches an object given its ID.
nodes
Description
Fetches objects given their IDs.
store
Description
A store.
Response
Returns a Store!
Example
Query
query store {
store {
account {
...AccountFragment
}
appExtensions {
...AppExtensionsConnectionFragment
}
channel {
...ChannelFragment
}
channels {
...ChannelsConnectionFragment
}
id
metafield {
...MetafieldFragment
}
metafields {
...MetafieldsConnectionFragment
}
product {
...ProductFragment
}
products {
...ProductConnectionFragment
}
settings {
...StoreSettingsFragment
}
sharedProductModifiers {
...SharedProductModifierConnectionFragment
}
sharedProductOptions {
...SharedProductOptionConnectionFragment
}
storeHash
storeReferenceId
webhook {
...WebhookFragment
}
webhooks {
...WebhooksConnectionFragment
}
}
}
Response
{
"data": {
"store": {
"account": Account,
"appExtensions": AppExtensionsConnection,
"channel": Channel,
"channels": ChannelsConnection,
"id": 4,
"metafield": Metafield,
"metafields": MetafieldsConnection,
"product": Product,
"products": ProductConnection,
"settings": StoreSettings,
"sharedProductModifiers": SharedProductModifierConnection,
"sharedProductOptions": SharedProductOptionConnection,
"storeHash": "abc123",
"storeReferenceId": "abc123",
"webhook": Webhook,
"webhooks": WebhooksConnection
}
}
}
system
Description
System information.
Response
Returns a System!
Example
Query
query system {
system {
time
}
}
Response
{"data": {"system": {"time": {}}}}
Mutations
appExtension
Description
App Extension mutations.
Response
Returns an AppExtensionMutations!
Example
Query
mutation appExtension {
appExtension {
createAppExtension {
...CreateAppExtensionResultFragment
}
updateAppExtension {
...UpdateAppExtensionResultFragment
}
deleteAppExtension {
...DeleteAppExtensionResultFragment
}
}
}
Response
{
"data": {
"appExtension": {
"createAppExtension": CreateAppExtensionResult,
"updateAppExtension": UpdateAppExtensionResult,
"deleteAppExtension": DeleteAppExtensionResult
}
}
}
channel
Description
Channel mutations.
Response
Returns a ChannelMutations!
Example
Query
mutation channel {
channel {
createChannel {
...CreateChannelResultFragment
}
}
}
Response
{
"data": {
"channel": {"createChannel": CreateChannelResult}
}
}
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
}
updateProductOptions {
...UpdateProductOptionsResultFragment
}
setProductUrlPath {
...SetProductUrlPathResultFragment
}
updateProductsProperties {
...UpdateProductsPropertiesResultFragment
}
removeProductUrlPathOverride {
...RemoveProductUrlPathOverrideResultFragment
}
setProductModifiersInformation {
...SetProductModifiersInformationResultFragment
}
removeProductModifiersOverrides {
...RemoveProductModifiersOverridesResultFragment
}
removeProductCustomFieldsOverrides {
...RemoveProductCustomFieldsOverridesResultFragment
}
updateProductCustomFields {
...UpdateProductCustomFieldsResultFragment
}
}
}
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,
"updateProductOptions": UpdateProductOptionsResult,
"setProductUrlPath": SetProductUrlPathResult,
"updateProductsProperties": UpdateProductsPropertiesResult,
"removeProductUrlPathOverride": RemoveProductUrlPathOverrideResult,
"setProductModifiersInformation": SetProductModifiersInformationResult,
"removeProductModifiersOverrides": RemoveProductModifiersOverridesResult,
"removeProductCustomFieldsOverrides": RemoveProductCustomFieldsOverridesResult,
"updateProductCustomFields": UpdateProductCustomFieldsResult
}
}
}
settings
Description
Store settings mutations.
Response
Returns a StoreSettingsMutations
Example
Query
mutation settings {
settings {
dataSolutions {
...DataSolutionsMutationsFragment
}
}
}
Response
{
"data": {
"settings": {"dataSolutions": DataSolutionsMutations}
}
}
webhook
Description
Webhook mutations.
Response
Returns a WebhookMutations!
Example
Query
mutation webhook {
webhook {
createEventBridgeWebhook {
...CreateEventBridgeWebhookResultFragment
}
createPubSubWebhook {
...CreatePubSubWebhookResultFragment
}
createHttpsWebhook {
...CreateHttpsWebhookResultFragment
}
deleteWebhook {
...DeleteWebhookResultFragment
}
updatePubSubWebhook {
...UpdatePubSubWebhookResultFragment
}
updateEventBridgeWebhook {
...UpdateEventBridgeWebhookResultFragment
}
updateHttpsWebhook {
...UpdateHttpsWebhookResultFragment
}
}
}
Response
{
"data": {
"webhook": {
"createEventBridgeWebhook": CreateEventBridgeWebhookResult,
"createPubSubWebhook": CreatePubSubWebhookResult,
"createHttpsWebhook": CreateHttpsWebhookResult,
"deleteWebhook": DeleteWebhookResult,
"updatePubSubWebhook": UpdatePubSubWebhookResult,
"updateEventBridgeWebhook": UpdateEventBridgeWebhookResult,
"updateHttpsWebhook": UpdateHttpsWebhookResult
}
}
}
Types
Account
Description
An account.
Fields
Field Name | Description |
---|---|
id - ID!
|
The ID of the object. |
Example
{"id": 4}
AlreadyExistsError
Description
Error indicating that the result of the operation would cause duplicate.
Fields
Field Name | Description |
---|---|
message - String!
|
Information about error. |
Example
{"message": "abc123"}
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 |
---|---|
|
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": "abc123",
"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": "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": "xyz789"
}
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": "xyz789"
}
BlogPostEntityRedirect
Description
Redirect to blog posts.
Fields
Field Name | Description |
---|---|
blogPostId - ID!
|
The ID of the object. |
Example
{"blogPostId": "4"}
Boolean
Description
The Boolean
scalar type represents true
or false
.
Example
true
BrandEntityRedirect
Description
Redirect to brand.
Fields
Field Name | Description |
---|---|
brandId - ID!
|
The ID of the object. |
Example
{"brandId": 4}
CategoryEntityRedirect
Description
Redirect to category.
Fields
Field Name | Description |
---|---|
categoryId - ID!
|
The ID of the object. |
Example
{"categoryId": 4}
Channel
Description
A channel.
Fields
Field Name | Description |
---|---|
id - ID!
|
The ID of the object. |
currencies - ChannelCurrencyCodes
|
Currency Assignments for the channel. |
dateCreated - DateTime
|
Date on which the channel was first created. |
dateModified - DateTime
|
Date on which the channel was most recently changed. |
externalId - String!
|
Associated ID within a system / platform outside of BC. |
iconUrl - String!
|
Link to the platform icon. |
isListableFromUi - Boolean!
|
Indicates if a channel can create listings from the BigCommerce UI. Default value for this field is based on the channel type and platform combination if not specified on create. |
isVisible - Boolean!
|
Indicates if a channel is visible within the BigCommerce merchant admin UI (control panel). If false, the channel will not show in Channel Manager nor in any channels dropdown throughout the UI. Default value for this field is true if not specified on create. |
name - String!
|
Name of the channel as it will appear to merchants in the control panel. |
platform - String!
|
The name of the platform for the channel; channel platform and type must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#platform to check for valid combination. |
settings - ChannelSettings
|
Channel-level settings. |
site - Site
|
A site. |
status - ChannelStatus
|
The status of the channel; channel type, platform, and status must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#status to check for valid combination. |
type - String!
|
The type of channel; channel platform and type must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#platform to check for valid combination. |
Example
{
"id": "4",
"currencies": ChannelCurrencyCodes,
"dateCreated": "2007-12-03T10:15:30Z",
"dateModified": "2007-12-03T10:15:30Z",
"externalId": "xyz789",
"iconUrl": "abc123",
"isListableFromUi": true,
"isVisible": false,
"name": "abc123",
"platform": "xyz789",
"settings": ChannelSettings,
"site": Site,
"status": "ACTIVE",
"type": "abc123"
}
ChannelContext
Description
Overrides context of a channel.
Fields
Field Name | Description |
---|---|
channelId - ID!
|
Storefront channel ID. |
Example
{"channelId": 4}
ChannelContextInput
Description
Input that updates the overrides for a channel.
Fields
Input Field | Description |
---|---|
channelId - ID!
|
The ID of the channel. |
Example
{"channelId": "4"}
ChannelCurrencyCodes
Description
Channel-level currency assignments
Fields
Field Name | Description |
---|---|
defaultCurrencyCode - CurrencyCode
|
Default currency for the channel in ISO 4217 three character alphabetic format. Will be used on storefront when other currencies cannot. |
enabledCurrencyCodes - [CurrencyCode!]!
|
Currencies that are enabled for the given channel in ISO 4217 three character alphabetic format. |
Example
{"defaultCurrencyCode": "AED", "enabledCurrencyCodes": ["AED"]}
ChannelLocaleContext
ChannelLocaleContextInput
ChannelMutations
Description
Channel mutations.
Fields
Field Name | Description |
---|---|
createChannel - CreateChannelResult
|
Creates a channel. |
Arguments
|
Example
{"createChannel": CreateChannelResult}
ChannelSettings
Description
Channel-level settings.
Fields
Field Name | Description |
---|---|
storeName - String
|
Store name. |
Example
{"storeName": "xyz789"}
ChannelStatus
Description
Status of the channel.
Values
Enum Value | Description |
---|---|
|
Channel is active. |
|
Channel is archived. |
|
Channel is connected. |
|
Channel is deleted. |
|
Channel is disconnected. |
|
Channel is inactive. |
|
Channel is in pre-launch mode. |
|
Channel is terminated. |
Example
"ACTIVE"
ChannelsConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ChannelsEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ChannelsEdge]
}
ChannelsEdge
ChannelsFiltersInput
Fields
Input Field | Description |
---|---|
available - Boolean
|
Filter items based on whether the channel is currently available for integration. Setting this query parameter to true will return channels with the status of prelaunch, active, inactive, and connected. Setting this query parameter to false will return channels with the status of disconnected, archived, deleted, and terminated. |
dateCreated - DateFiltersInput
|
Filter items by date created. |
dateModified - DateFiltersInput
|
Filter items by date modified. |
ids - [ID!]
|
The IDs of channels. |
platforms - [String!]
|
Filter items by a list of platforms. For a list of supported platforms, see https://developer.bigcommerce.com/api-reference/store-management/channels#platform. |
statuses - [ChannelStatus!]
|
Filter items by a list of statuses. |
types - [String!]
|
Filter items by a list of types. |
Example
{
"available": false,
"dateCreated": DateFiltersInput,
"dateModified": DateFiltersInput,
"ids": ["4"],
"platforms": ["xyz789"],
"statuses": ["ACTIVE"],
"types": ["abc123"]
}
CheckboxProductModifier
Description
Checkbox product modifier.
Fields
Field Name | Description |
---|---|
checkedByDefault - Boolean!
|
Indicates whether the modifier is checked by default. |
fieldValue - String
|
Checkbox modifier field value. |
overridesForLocale - CheckboxProductModifierForLocale
|
Overrides for the checkbox product modifier in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - CheckboxProductModifierOverridesConnection!
|
Overrides for a checkbox product modifier in a context of channel and 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": "abc123",
"overridesForLocale": CheckboxProductModifierForLocale,
"overrides": CheckboxProductModifierOverridesConnection,
"id": "4",
"displayName": "xyz789",
"isRequired": false,
"isShared": false
}
CheckboxProductModifierForLocale
CheckboxProductModifierOverrides
Description
Overrides for a checkbox product modifier.
Types
Union Types |
---|
Example
CheckboxProductModifierOverridesForChannelLocale
CheckboxProductModifierOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [CheckboxProductModifierOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [CheckboxProductModifierOverridesEdge]
}
CheckboxProductModifierOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - CheckboxProductModifierOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": CheckboxProductModifierOverridesForChannelLocale,
"cursor": "xyz789"
}
CheckboxProductModifierOverridesForChannelLocale
Description
Overrides for a checkbox product modifier in a context of channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product modifier overrides context for channel and locale. |
displayName - String
|
Display name override for the product modifier in a context of a channel and locale. |
fieldValue - String
|
Field value override in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"displayName": "xyz789",
"fieldValue": "xyz789"
}
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}
CreateChannelInput
Fields
Input Field | Description |
---|---|
externalId - String
|
Associated ID within a system / platform outside of BC. |
isListableFromUi - Boolean
|
Indicates if a channel can create listings from the BigCommerce UI. Default value for this field is based on the channel type and platform combination if not specified on create. |
isVisible - Boolean
|
Indicates if a channel is visible within the BigCommerce merchant admin UI (control panel). If false, the channel will not show in Channel Manager nor in any channels dropdown throughout the UI. Default value for this field is true if not specified on create. |
name - String!
|
Name of the channel as it will appear to merchants in the control panel. |
platform - String!
|
The name of the platform for the channel; channel platform and type must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#platform to check for valid combination. |
status - ChannelStatus
|
The status of the channel; channel type, platform, and status must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#status to check for valid combination. terminated is not valid for CREATE or UPDATE requests. deleted is not valid for CREATE requests. |
type - String!
|
The type of channel; channel platform and type must be a valid combination. Please visit https://developer.bigcommerce.com/api-reference/store-management/channels#platform to check for valid combination. |
Example
{
"externalId": "xyz789",
"isListableFromUi": false,
"isVisible": true,
"name": "xyz789",
"platform": "xyz789",
"status": "ACTIVE",
"type": "xyz789"
}
CreateChannelResult
Fields
Field Name | Description |
---|---|
channel - Channel
|
The Channel that is created as a result of mutation. |
Example
{"channel": Channel}
CreateEventBridgeWebhookError
Description
Error object for create Amazon EventBridge webhook mutation.
Example
AlreadyExistsError
CreateEventBridgeWebhookInput
Fields
Input Field | Description |
---|---|
destination - String!
|
The fields used to create an Amazon EventBridge webhook. |
eventFilters - [WebhookEventFilterUnionInput!]
|
Event filters for webhook. |
isActive - Boolean
|
If webhook is active or not. |
scope - String!
|
The scope of the event subscription. |
Example
{
"destination": "xyz789",
"eventFilters": [WebhookEventFilterUnionInput],
"isActive": true,
"scope": "abc123"
}
CreateEventBridgeWebhookResult
Fields
Field Name | Description |
---|---|
webhook - EventBridgeWebhook
|
The result returned after creating an Amazon EventBridge webhook. |
errors - [CreateEventBridgeWebhookError!]!
|
The list of errors that occurred while creating an Amazon EventBridge webhook. |
Example
{
"webhook": EventBridgeWebhook,
"errors": [AlreadyExistsError]
}
CreateHttpsWebhookError
Description
Error object for create HTTPS webhook mutation.
Types
Union Types |
---|
Example
AlreadyExistsError
CreateHttpsWebhookInput
Fields
Input Field | Description |
---|---|
destination - String!
|
URL must be active, return a 200 response, and be served on port 443. |
eventFilters - [WebhookEventFilterUnionInput!]
|
Filters limiting events that trigger sending webhooks. |
headers - [HttpsWebhookHeaderInput!]
|
You can define any number of custom headers to be attached to the event sent to the destination URL. |
isActive - Boolean
|
If webhook is active or not. |
scope - String!
|
The scope of the event subscription. |
Example
{
"destination": "xyz789",
"eventFilters": [WebhookEventFilterUnionInput],
"headers": [HttpsWebhookHeaderInput],
"isActive": false,
"scope": "xyz789"
}
CreateHttpsWebhookResult
Fields
Field Name | Description |
---|---|
webhook - HttpsWebhook
|
The webhook object returned as a result of a mutation. |
errors - [CreateHttpsWebhookError!]!
|
The list of errors that occurred while creating a HTTPS webhook. |
Example
{
"webhook": HttpsWebhook,
"errors": [AlreadyExistsError]
}
CreateMetafieldErrors
Description
Union type for all 'createMetafield' mutation errors.
Types
Union Types |
---|
Example
AlreadyExistsError
CreateMetafieldInput
Fields
Input Field | Description |
---|---|
namespace - String!
|
Namespace for the metafield. |
resourceId - ID
|
The unique identifier for the resource with which the metafield is associated. |
key - String!
|
The name of the metafield. |
value - String!
|
Value of the metafield. |
description - String
|
Description of the metafield. |
permissionSet - MetafieldsPermissionSet!
|
Determines the visibility and writeability of the field by other API consumers. |
Example
{
"namespace": "abc123",
"resourceId": 4,
"key": "abc123",
"value": "xyz789",
"description": "xyz789",
"permissionSet": "APP_ONLY"
}
CreateMetafieldResult
Fields
Field Name | Description |
---|---|
metafield - Metafield
|
Metafield that was created as a result of mutation. |
errors - [CreateMetafieldErrors!]!
|
The list of errors that occurred while creating a metafield. |
Example
{
"metafield": Metafield,
"errors": [AlreadyExistsError]
}
CreatePubSubWebhookError
Description
Error object for create Google Cloud PubSub webhook mutation.
Example
AlreadyExistsError
CreatePubSubWebhookInput
Fields
Input Field | Description |
---|---|
destination - String!
|
The Google Cloud Pub/Sub topic where events will be delivered. The topic must have the BigCommerce service account principal & Pub/Sub Publish permission enabled. |
eventFilters - [WebhookEventFilterUnionInput!]
|
Event filters for webhook. |
isActive - Boolean
|
If webhook is active or not. |
scope - String!
|
The scope of the event subscription. |
Example
{
"destination": "xyz789",
"eventFilters": [WebhookEventFilterUnionInput],
"isActive": true,
"scope": "abc123"
}
CreatePubSubWebhookResult
Fields
Field Name | Description |
---|---|
webhook - PubSubWebhook
|
The webhook object returned as a result of a mutation. |
errors - [CreatePubSubWebhookError!]!
|
The list of errors that occurred while creating a Google Pub/Sub webhook. |
Example
{
"webhook": PubSubWebhook,
"errors": [AlreadyExistsError]
}
CurrencyCode
Description
Currency Code.
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AED"
DataSolutionsMutations
Description
Data solutions mutations.
Fields
Field Name | Description |
---|---|
updateDataLayer - UpdateDataLayerResult
|
Update data layer configuration. |
Arguments
|
Example
{"updateDataLayer": UpdateDataLayerResult}
DataSolutionsSettings
Description
Data solutions settings.
Fields
Field Name | Description |
---|---|
isDataLayerEnabled - Boolean!
|
Indicates if a data layer(bodl) object is enabled for all storefronts. |
Example
{"isDataLayerEnabled": true}
DateFieldProductModifier
Description
Date field product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - DateFieldProductModifierForLocale
|
Overrides for the date field product modifier in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - DateFieldProductModifierOverridesConnection!
|
Overrides for a date field product modifier in a context of channel and 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,
"overrides": DateFieldProductModifierOverridesConnection,
"id": 4,
"displayName": "xyz789",
"isRequired": true,
"isShared": false
}
DateFieldProductModifierForLocale
Description
Override for a date field product modifier in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Display name for the product modifier in a channel locale. |
Example
{"displayName": "abc123"}
DateFieldProductModifierOverrides
Description
Overrides for a date field product modifier.
Types
Union Types |
---|
Example
DateFieldProductModifierOverridesForChannelLocale
DateFieldProductModifierOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [DateFieldProductModifierOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [DateFieldProductModifierOverridesEdge]
}
DateFieldProductModifierOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - DateFieldProductModifierOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": DateFieldProductModifierOverridesForChannelLocale,
"cursor": "xyz789"
}
DateFieldProductModifierOverridesForChannelLocale
Description
Overrides for a date field product modifier in a context of channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product modifier overrides context for channel and locale. |
displayName - String
|
Display name override for the product modifier in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"displayName": "xyz789"
}
DateFiltersInput
Description
Filters for date.
Fields
Input Field | Description |
---|---|
eq - DateTime
|
Filter items with date equal to. |
gt - DateTime
|
Filter items with date greater than. |
lt - DateTime
|
Filter items with date less than. |
gte - DateTime
|
Filter items with date greater than or equal to. |
lte - DateTime
|
Filter items with date less than or equal to. |
Example
{
"eq": "2007-12-03T10:15:30Z",
"gt": "2007-12-03T10:15:30Z",
"lt": "2007-12-03T10:15:30Z",
"gte": "2007-12-03T10:15:30Z",
"lte": "2007-12-03T10:15:30Z"
}
DateTime
Description
ISO-8601 formatted date in UTC
Example
"2007-12-03T10:15:30Z"
DeleteAppExtensionInput
Fields
Input Field | Description |
---|---|
id - ID!
|
The ID of the object. |
Example
{"id": 4}
DeleteAppExtensionResult
Description
The response object property available after deleting an App Extension; the currently available property is the ID of the deleted App Extension.
Fields
Field Name | Description |
---|---|
deletedAppExtensionId - ID
|
The ID of the object. |
Example
{"deletedAppExtensionId": "4"}
DeleteMetafieldErrors
Description
Union type for all 'deleteMetafield' mutation errors.
Types
Union Types |
---|
Example
ValidationError
DeleteMetafieldInput
Description
Input for deleteMetafield mutation.
Fields
Input Field | Description |
---|---|
id - ID!
|
The ID of metafield to delete. |
Example
{"id": "4"}
DeleteMetafieldResult
Fields
Field Name | Description |
---|---|
deletedMetafieldId - ID
|
The id of metafield that is deleted as a result of mutation. |
errors - [DeleteMetafieldErrors!]!
|
The list of errors that occurred while creating a metafield. |
Example
{"deletedMetafieldId": 4, "errors": [ValidationError]}
DeleteWebhookError
Description
Error object for delete webhook mutation.
Types
Union Types |
---|
Example
EntityNotFoundError
DeleteWebhookInput
Fields
Input Field | Description |
---|---|
webhookId - ID!
|
The ID of the webhook to be deleted. |
Example
{"webhookId": 4}
DeleteWebhookResult
Description
The webhook ID that is deleted as a result of a mutation.
Fields
Field Name | Description |
---|---|
id - ID
|
The ID of the deleted webhook. |
errors - [DeleteWebhookError!]!
|
The list of errors that occurred while deleting a webhook. |
Example
{"id": 4, "errors": [EntityNotFoundError]}
DestinationNotAllowedError
Description
Error indicating that the destination has already been taken by other hook type.
Fields
Field Name | Description |
---|---|
message - String!
|
Information about error. |
Example
{"message": "xyz789"}
DropdownOptionValue
DropdownOptionValueForLocale
DropdownOptionValueOverridesForChannelLocale
Description
Overrides for the dropdown product option in a context of channel and locale.
Example
{"id": 4, "label": "xyz789"}
DropdownProductModifier
Description
Dropdown product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - DropdownProductModifierForLocale
|
Overrides for the dropdown product modifier in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - DropdownProductModifierOverridesConnection!
|
Overrides for a dropdown product modifier in a context of channel and 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,
"overrides": DropdownProductModifierOverridesConnection,
"values": [DropdownProductModifierValue],
"id": 4,
"displayName": "xyz789",
"isRequired": false,
"isShared": false
}
DropdownProductModifierForLocale
Description
Override for a dropdown product modifier in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Display name for the product modifier in a channel locale. |
values - [DropdownProductModifierValueForLocale!]!
|
Modifier values for a dropdown product modifier in a channel locale. |
Example
{
"displayName": "abc123",
"values": [DropdownProductModifierValueForLocale]
}
DropdownProductModifierOverrides
Description
Overrides for a dropdown product modifier.
Types
Union Types |
---|
Example
DropdownProductModifierOverridesForChannelLocale
DropdownProductModifierOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [DropdownProductModifierOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [DropdownProductModifierOverridesEdge]
}
DropdownProductModifierOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - DropdownProductModifierOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": DropdownProductModifierOverridesForChannelLocale,
"cursor": "abc123"
}
DropdownProductModifierOverridesForChannelLocale
Description
Overrides for a dropdown product modifier in a context of channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product modifier overrides context for channel and locale. |
displayName - String
|
Display name override for the product modifier in a context of a channel and locale. |
values - [DropdownProductModifierValueOverridesForChannelLocale!]!
|
List of product modifier values overrides in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"displayName": "xyz789",
"values": [
DropdownProductModifierValueOverridesForChannelLocale
]
}
DropdownProductModifierValue
Description
Dropdown product modifier value.
Example
{
"id": "4",
"isDefault": false,
"label": "xyz789"
}
DropdownProductModifierValueForLocale
DropdownProductModifierValueOverridesForChannelLocale
Description
Overrides for the dropdown product modifier in a context of channel and locale.
Example
{"id": 4, "label": "xyz789"}
DropdownProductOption
Description
Dropdown product option.
Fields
Field Name | Description |
---|---|
displayName - String!
|
Display name for the option. |
isShared - Boolean!
|
Indicates whether product option is shared or local. |
id - ID!
|
The ID of the object. |
overridesForLocale - ProductOptionForLocale
|
Option overrides for a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - ProductOptionOverridesConnection!
|
Overrides for a dropdown product option in a context of channel and locale. |
Arguments
|
|
values - [ProductOptionValue!]!
|
List of product option values. |
Example
{
"displayName": "xyz789",
"isShared": true,
"id": 4,
"overridesForLocale": ProductOptionForLocale,
"overrides": ProductOptionOverridesConnection,
"values": [ProductOptionValue]
}
DropdownProductOptionForLocale
Description
Override for the dropdown product option in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Display name for the product option. |
values - [ProductOptionValueForLocale!]!
|
List of product option values. |
Example
{
"displayName": "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": "abc123"}
EventBridgeSourceNotFoundError
EventBridgeWebhook
Description
An Amazon EventBridge webhook.
Fields
Field Name | Description |
---|---|
destination - String!
|
Amazon EventBridge source arn. |
clientId - String!
|
ID of client application owning the webhook. |
createdAt - DateTime
|
The date and time of webhook creation. |
eventFilters - [WebhookEventFilter!]!
|
Event filters for webhook. |
id - ID!
|
The ID of a webhook object. |
scope - String!
|
The scope of the event subscription. |
status - WebhookStatus!
|
The status of a webhook. |
updatedAt - DateTime
|
The date and time of the last webhook update. |
Example
{
"destination": "xyz789",
"clientId": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"eventFilters": [WebhookEventFilter],
"id": "4",
"scope": "xyz789",
"status": "ACTIVE",
"updatedAt": "2007-12-03T10:15:30Z"
}
FileUploadProductModifier
Description
File upload product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - FileUploadProductModifierForLocale
|
Overrides for the file upload product modifier in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - FileUploadProductModifierOverridesConnection!
|
Overrides for a file upload product modifier in a context of channel and 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,
"overrides": FileUploadProductModifierOverridesConnection,
"id": 4,
"displayName": "xyz789",
"isRequired": false,
"isShared": true
}
FileUploadProductModifierForLocale
Description
Override for a file upload product modifier in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Display name for the file upload product modifier in a channel locale. |
Example
{"displayName": "abc123"}
FileUploadProductModifierOverrides
Description
Overrides for a file upload product modifier.
Types
Union Types |
---|
Example
FileUploadProductModifierOverridesForChannelLocale
FileUploadProductModifierOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [FileUploadProductModifierOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [FileUploadProductModifierOverridesEdge]
}
FileUploadProductModifierOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - FileUploadProductModifierOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": FileUploadProductModifierOverridesForChannelLocale,
"cursor": "xyz789"
}
FileUploadProductModifierOverridesForChannelLocale
Description
Overrides for a file upload product modifier in a context of channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product modifier overrides context for channel and locale. |
displayName - String
|
Display name override for the product modifier in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"displayName": "abc123"
}
Float
Description
The Float
scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
HttpsWebhook
Description
An https webhook.
Fields
Field Name | Description |
---|---|
destination - String!
|
URL must be active, return a 200 response, and be served on port 443. |
headers - [HttpsWebhookHeader!]!
|
You can pass custom headers to validate webhooks being returned. |
clientId - String!
|
ID of client application owning the webhook. |
createdAt - DateTime
|
The date and time of webhook creation. |
eventFilters - [WebhookEventFilter!]!
|
Event filters for webhook. |
id - ID!
|
The ID of a webhook object. |
scope - String!
|
The scope of the event subscription. |
status - WebhookStatus!
|
The status of a webhook. |
updatedAt - DateTime
|
The date and time of the last webhook update. |
Example
{
"destination": "abc123",
"headers": [HttpsWebhookHeader],
"clientId": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"eventFilters": [WebhookEventFilter],
"id": "4",
"scope": "xyz789",
"status": "ACTIVE",
"updatedAt": "2007-12-03T10:15:30Z"
}
HttpsWebhookHeader
HttpsWebhookHeaderInput
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. |
createdAt - DateTime
|
Date and time when the metafield was created. |
updatedAt - DateTime
|
Date and time when the metafield was last updated. |
Example
{
"id": "4",
"description": "abc123",
"key": "xyz789",
"namespace": "abc123",
"permissionSet": "APP_ONLY",
"resourceId": "4",
"value": "abc123",
"ownerClientId": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"updatedAt": "2007-12-03T10:15:30Z"
}
MetafieldLimitExceededError
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. |
createdAt - DateFiltersInput
|
Filter by create date of the metafield. |
updatedAt - DateFiltersInput
|
Filter by update date of the metafield. |
resourceIds - [ID!]
|
The unique identifier for the resource with which the metafield is associated. |
resourceType - MetafieldsResourceType
|
The type of resource with which the metafield is associated. |
Example
{
"namespace": "abc123",
"createdAt": DateFiltersInput,
"updatedAt": DateFiltersInput,
"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
|
Default value for the product modifier. |
overridesForLocale - MultilineTextFieldProductModifierForLocale
|
Overrides for the product modifier in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - MultilineTextFieldProductModifierOverridesConnection!
|
Overrides for a multiline text product modifier in a context of channel and 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,
"overrides": MultilineTextFieldProductModifierOverridesConnection,
"id": "4",
"displayName": "abc123",
"isRequired": false,
"isShared": false
}
MultilineTextFieldProductModifierForLocale
Description
Override for a multiline text field product modifier in a channel locale.
Example
{
"defaultValue": "abc123",
"displayName": "abc123"
}
MultilineTextFieldProductModifierOverrides
Description
Overrides for a multiline text product modifier.
Types
Union Types |
---|
Example
MultilineTextFieldProductModifierOverridesForChannelLocale
MultilineTextFieldProductModifierOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [MultilineTextFieldProductModifierOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [
MultilineTextFieldProductModifierOverridesEdge
]
}
MultilineTextFieldProductModifierOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - MultilineTextFieldProductModifierOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": MultilineTextFieldProductModifierOverridesForChannelLocale,
"cursor": "xyz789"
}
MultilineTextFieldProductModifierOverridesForChannelLocale
Description
Overrides for a multiline text product modifier in a context of channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product modifier overrides context for channel and locale. |
defaultValue - String
|
Default value override in a context of a channel and locale. |
displayName - String
|
Display name override for the product modifier in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"defaultValue": "xyz789",
"displayName": "abc123"
}
Node
Description
An object with an ID.
Fields
Field Name | Description |
---|---|
id - ID!
|
The ID of the object. |
Possible Types
Node Types |
---|
Example
{"id": 4}
NotAuthorizedFieldToUpdateMetafieldFieldError
Description
One of provided on update fields cannot be updated. Only 'key', 'value', and 'namespace' fields can be updated by not an entity owner with the 'write' permissions.
Fields
Field Name | Description |
---|---|
message - String!
|
Information about error. |
Example
{"message": "xyz789"}
NotAuthorizedToDeleteMetafieldError
Description
The metafield could not be deleted by you. You are not an owner and metafield's permission was set to read.
Fields
Field Name | Description |
---|---|
message - String!
|
Information about error. |
Example
{"message": "xyz789"}
NotAuthorizedToUpdateMetafieldError
Description
The read-only metafield cannot be updated by not an owner. The metafield's permissions are set to 'read'.
Fields
Field Name | Description |
---|---|
message - String!
|
Information about error. |
Example
{"message": "abc123"}
NumbersOnlyTextFieldProductModifier
Description
Numbers-only text field product modifier.
Fields
Field Name | Description |
---|---|
defaultValue - Float
|
Default value for the product modifier. |
overridesForLocale - NumbersOnlyTextFieldProductModifierForLocale
|
Overrides for the product modifier in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - NumbersOnlyTextFieldProductModifierOverridesConnection!
|
Overrides for a numbers-only product modifier in a context of channel and 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,
"overrides": NumbersOnlyTextFieldProductModifierOverridesConnection,
"id": "4",
"displayName": "xyz789",
"isRequired": true,
"isShared": false
}
NumbersOnlyTextFieldProductModifierForLocale
NumbersOnlyTextFieldProductModifierOverrides
Description
Overrides for a numbers-only product modifier.
Types
Union Types |
---|
|
Example
NumbersOnlyTextFieldProductModifierOverridesForChannelLocale
NumbersOnlyTextFieldProductModifierOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [NumbersOnlyTextFieldProductModifierOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [
NumbersOnlyTextFieldProductModifierOverridesEdge
]
}
NumbersOnlyTextFieldProductModifierOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - NumbersOnlyTextFieldProductModifierOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": NumbersOnlyTextFieldProductModifierOverridesForChannelLocale,
"cursor": "xyz789"
}
NumbersOnlyTextFieldProductModifierOverridesForChannelLocale
Description
Overrides for a numbers-only product modifier in a context of channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product modifier overrides context for channel and locale. |
defaultValue - Float
|
Default value override in a context of a channel and locale. |
displayName - String
|
Display name override for the product modifier in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"defaultValue": 987.65,
"displayName": "abc123"
}
PageEntityRedirect
Description
Redirect to page.
Fields
Field Name | Description |
---|---|
pageId - ID!
|
The ID of the object. |
Example
{"pageId": 4}
PageInfo
Description
Information about pagination in a connection.
Fields
Field Name | Description |
---|---|
hasNextPage - Boolean!
|
Indicates whether there are more items when paginating forwards. |
hasPreviousPage - Boolean!
|
Indicates whether there are more items when paginating backward. |
startCursor - String
|
The starting cursor when paginating backward. |
endCursor - String
|
The ending cursor when paginating forwards. |
Example
{
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789",
"endCursor": "xyz789"
}
PickListModifierValue
Description
Pick list product modifier value.
Example
{
"id": 4,
"isDefault": true,
"label": "abc123"
}
PickListModifierValueForLocale
PickListProductModifier
Description
Pick list product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - PickListProductModifierForLocale
|
Overrides for the pick list product modifier in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - PickListProductModifierOverridesConnection!
|
Overrides for a pick list product modifier in a context of channel and locale. |
Arguments
|
|
values - [PickListModifierValue!]!
|
Values for the product modifier. |
id - ID!
|
The ID of the object. |
displayName - String!
|
Product modifier display name. |
isRequired - Boolean!
|
Indicates whether product modifier is required. |
isShared - Boolean!
|
Indicates whether product modifier is shared or local. |
Example
{
"overridesForLocale": PickListProductModifierForLocale,
"overrides": PickListProductModifierOverridesConnection,
"values": [PickListModifierValue],
"id": "4",
"displayName": "abc123",
"isRequired": false,
"isShared": false
}
PickListProductModifierForLocale
Description
Overrides for the pick list product modifier in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Display name for the product modifier. |
values - [PickListModifierValueForLocale!]!
|
Values for the product modifier. |
Example
{
"displayName": "xyz789",
"values": [PickListModifierValueForLocale]
}
PickListProductModifierOverrides
Description
Overrides for a pick list product modifier.
Types
Union Types |
---|
Example
PickListProductModifierOverridesForChannelLocale
PickListProductModifierOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [PickListProductModifierOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [PickListProductModifierOverridesEdge]
}
PickListProductModifierOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - PickListProductModifierOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": PickListProductModifierOverridesForChannelLocale,
"cursor": "abc123"
}
PickListProductModifierOverridesForChannelLocale
Description
Overrides for a pick list product modifier in a context of channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product modifier overrides context for channel and locale. |
displayName - String
|
Display name override for the product modifier in a context of a channel and locale. |
values - [PickListProductModifierValueOverridesForChannelLocale!]!
|
List of product modifier values overrides in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"displayName": "xyz789",
"values": [
PickListProductModifierValueOverridesForChannelLocale
]
}
PickListProductModifierValueOverridesForChannelLocale
Description
Overrides for the pick list product modifier in a context of channel and locale.
Example
{"id": 4, "label": "abc123"}
PreOrderSettings
Description
Product pre-order settings.
Fields
Field Name | Description |
---|---|
message - String
|
Message about a pre-order for a product. |
Example
{"message": "xyz789"}
PreOrderSettingsOverridesForLocale
Description
Overrides for pre-order settings in a channel locale.
Fields
Field Name | Description |
---|---|
message - String
|
Pre-order message in a channel locale. |
Example
{"message": "xyz789"}
Product
Description
A product.
Fields
Field Name | Description |
---|---|
id - ID!
|
The ID of the product. |
basicInformation - ProductBasicInformation!
|
Basic product information. |
isFeatured - Boolean!
|
Indicates whether a product is marked as a featured product. |
urlPath - ProductUrlPath!
|
Product path. |
overridesForLocale - ProductOverridesForLocale
|
Overrides for the product in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overridesForChannel - ProductOverridesForChannel
|
Product overrides for a specific channel. Use 'overrides' field instead |
Arguments
|
|
seoInformation - ProductSeoInformation!
|
Product SEO information. |
storefrontDetails - StorefrontDetails!
|
Product storefront details. |
preOrderSettings - PreOrderSettings!
|
Product pre-order settings. |
customFields - ProductCustomFieldConnection!
|
List of product custom fields. |
options - ProductOptionConnection!
|
List of product options. |
modifiers - ProductModifierConnection!
|
List of product modifiers. |
overrides - ProductOverridesConnection!
|
Product overrides data. |
Arguments
|
Example
{
"id": 4,
"basicInformation": ProductBasicInformation,
"isFeatured": true,
"urlPath": ProductUrlPath,
"overridesForLocale": ProductOverridesForLocale,
"overridesForChannel": ProductOverridesForChannel,
"seoInformation": ProductSeoInformation,
"storefrontDetails": StorefrontDetails,
"preOrderSettings": PreOrderSettings,
"customFields": ProductCustomFieldConnection,
"options": ProductOptionConnection,
"modifiers": ProductModifierConnection,
"overrides": ProductOverridesConnection
}
ProductBasicInformation
ProductBasicInformationField
Description
Product basic information field names
Values
Enum Value | Description |
---|---|
|
The description field. |
|
The name field. |
Example
"PRODUCT_DESCRIPTION_FIELD"
ProductBasicInformationOverridesForChannelLocale
ProductBasicInformationOverridesForLocale
ProductChannelLocaleOverrides
Description
Overrides for the product of a channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
The field contains override identifiers. |
basicInformation - ProductBasicInformationOverridesForChannelLocale
|
Overrides for the product information fields. |
seoInformation - ProductSeoInformationOverridesForChannelLocale
|
Overrides for the product SEO information fields. |
storefrontDetails - ProductStorefrontDetailsOverridesForChannelLocale
|
Overrides for storefront details fields. |
preOrderSettings - ProductPreOrderSettingsOverridesForChannelLocale
|
Overrides for pre-order settings fields. |
Example
{
"context": ChannelLocaleContext,
"basicInformation": ProductBasicInformationOverridesForChannelLocale,
"seoInformation": ProductSeoInformationOverridesForChannelLocale,
"storefrontDetails": ProductStorefrontDetailsOverridesForChannelLocale,
"preOrderSettings": ProductPreOrderSettingsOverridesForChannelLocale
}
ProductChannelOverrides
Description
Overrides for the product of a channel.
Fields
Field Name | Description |
---|---|
context - ChannelContext!
|
The field contains override identifiers. |
isFeatured - Boolean
|
Override for featured field. |
Example
{"context": ChannelContext, "isFeatured": false}
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]
}
ProductCustomField
Description
A product custom field.
Fields
Field Name | Description |
---|---|
id - ID!
|
The ID of the product custom field. |
name - String!
|
Name of a product custom field. |
value - String!
|
The value of a product custom field. |
overrides - ProductCustomFieldOverridesConnection!
|
Overrides for product custom fields in a storefront channel locale. |
Arguments
|
Example
{
"id": 4,
"name": "abc123",
"value": "abc123",
"overrides": ProductCustomFieldOverridesConnection
}
ProductCustomFieldConnection
Description
A connection to a list of product custom fields.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ProductCustomFieldEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ProductCustomFieldEdge]
}
ProductCustomFieldEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - ProductCustomField!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": ProductCustomField,
"cursor": "xyz789"
}
ProductCustomFieldOverrides
Description
Overrides for product custom fields in a storefront channel locale.
Types
Union Types |
---|
Example
ProductCustomFieldOverridesForChannelLocale
ProductCustomFieldOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ProductCustomFieldOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ProductCustomFieldOverridesEdge]
}
ProductCustomFieldOverridesContextInput
ProductCustomFieldOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - ProductCustomFieldOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": ProductCustomFieldOverridesForChannelLocale,
"cursor": "xyz789"
}
ProductCustomFieldOverridesForChannelLocale
Description
Overrides for product custom fields in a storefront channel locale.
Fields
Field Name | Description |
---|---|
name - String
|
Name of a product custom field in a storefront channel locale. |
value - String
|
Value of a product custom field in a storefront channel locale. |
isVisible - Boolean
|
Indicates whether a custom field is visible in a storefront channel locale. |
context - ChannelLocaleContext!
|
The storefront channel and locale that apply when you override or retrieve product custom fields from a channel locale. |
Example
{
"name": "xyz789",
"value": "abc123",
"isVisible": false,
"context": ChannelLocaleContext
}
ProductEdge
ProductEntityRedirect
Description
Redirect to product.
Fields
Field Name | Description |
---|---|
productId - ID!
|
The ID of the object. |
Example
{"productId": 4}
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": "xyz789",
"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": "abc123"
}
ProductModifierOverridesContextInput
ProductMutations
Description
Product mutations.
Fields
Field Name | Description |
---|---|
removeProductBasicInformationOverrides - RemoveProductBasicInformationOverridesResult
|
Removes overrides for product basic information from a locale. |
Arguments |
|
removeProductSeoInformationOverrides - RemoveProductSeoInformationOverridesResult
|
Removes overrides for product SEO information from a locale. |
Arguments |
|
removeProductOptionsOverrides - RemoveProductOptionsOverridesResult
|
Removes product option overrides from a locale. |
Arguments |
|
removeProductStorefrontDetailsOverrides - RemoveProductStorefrontDetailsOverridesResult
|
Removes overrides for product storefront details from a locale. |
Arguments |
|
removeProductPreOrderSettingsOverrides - RemoveProductPreOrderSettingsOverridesResult
|
Removes overrides for product pre-order settings from a locale. |
Arguments |
|
setProductBasicInformation - SetProductBasicInformationResult
|
Sets product basic information. |
Arguments
|
|
setProductIsFeatured - SetProductIsFeaturedResult
|
Sets whether a product is marked as featured. |
Arguments
|
|
removeProductIsFeaturedOverride - RemoveProductIsFeaturedOverrideResult
|
Removes overrides for whether a product is featured from a locale. |
Arguments |
|
setProductSeoInformation - SetProductSeoInformationResult
|
Sets product SEO information. |
Arguments
|
|
setProductStorefrontDetails - SetProductStorefrontDetailsResult
|
Sets product storefront details. |
Arguments |
|
setProductPreOrderSettings - SetProductPreOrderSettingsResult
|
Sets product pre-order settings. |
Arguments
|
|
setProductOptionsInformation - SetProductOptionsInformationResult
|
Sets product option information. Use 'updateProductOptions' mutation instead |
Arguments |
|
updateProductOptions - UpdateProductOptionsResult
|
Updates product's options. |
Arguments
|
|
setProductUrlPath - SetProductUrlPathResult
|
Sets a product URL path. |
Arguments
|
|
updateProductsProperties - UpdateProductsPropertiesResult
|
Updates properties of multiple products. |
Arguments
|
|
removeProductUrlPathOverride - RemoveProductUrlPathOverrideResult
|
Removes overrides for a product URL path from a locale. |
Arguments |
|
setProductModifiersInformation - SetProductModifiersInformationResult
|
Sets product modifier information. |
Arguments |
|
removeProductModifiersOverrides - RemoveProductModifiersOverridesResult
|
Remove product modifier overrides from a locale. |
Arguments |
|
removeProductCustomFieldsOverrides - RemoveProductCustomFieldsOverridesResult
|
Removes overrides for product custom fields from a storefront channel locale. |
Arguments |
|
updateProductCustomFields - UpdateProductCustomFieldsResult
|
Updates product's custom fields. |
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,
"updateProductOptions": UpdateProductOptionsResult,
"setProductUrlPath": SetProductUrlPathResult,
"updateProductsProperties": UpdateProductsPropertiesResult,
"removeProductUrlPathOverride": RemoveProductUrlPathOverrideResult,
"setProductModifiersInformation": SetProductModifiersInformationResult,
"removeProductModifiersOverrides": RemoveProductModifiersOverridesResult,
"removeProductCustomFieldsOverrides": RemoveProductCustomFieldsOverridesResult,
"updateProductCustomFields": UpdateProductCustomFieldsResult
}
ProductOption
Description
Product option
Fields
Field Name | Description |
---|---|
displayName - String!
|
Display name for the option. |
isShared - Boolean!
|
Indicates whether product option is shared or local. |
id - ID!
|
The ID of the object. |
overridesForLocale - ProductOptionForLocale
|
Option overrides for a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - ProductOptionOverridesConnection!
|
Overrides for a product option in a context of channel and locale. |
Arguments
|
|
values - [ProductOptionValue!]!
|
List of product option values. |
Possible Types
ProductOption Types |
---|
Example
{
"displayName": "abc123",
"isShared": true,
"id": "4",
"overridesForLocale": ProductOptionForLocale,
"overrides": ProductOptionOverridesConnection,
"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": "abc123"
}
ProductOptionForLocale
Description
Product option overrides in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Display name for the product option. |
values - [ProductOptionValueForLocale!]!
|
List of product option values. |
Possible Types
ProductOptionForLocale Types |
---|
Example
{
"displayName": "abc123",
"values": [ProductOptionValueForLocale]
}
ProductOptionOverrides
Description
Overrides for product option in a context of channel and locale.
Types
Union Types |
---|
Example
ProductOptionOverridesForChannelLocale
ProductOptionOverridesConnection
Description
A connection to a list of product option overrides.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ProductOptionOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ProductOptionOverridesEdge]
}
ProductOptionOverridesContextInput
ProductOptionOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - ProductOptionOverrides!
|
A cursor for use in pagination. |
cursor - String!
|
The item at the end of the edge. |
Example
{
"node": ProductOptionOverridesForChannelLocale,
"cursor": "xyz789"
}
ProductOptionOverridesForChannelLocale
Description
Option overrides for a channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product option overrides context for channel and locale. |
displayName - String
|
Display name override for the product option in a context of a channel and locale. |
values - [ProductOptionValueOverridesForChannelLocale!]!
|
List of product option values overrides in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"displayName": "xyz789",
"values": [ProductOptionValueOverridesForChannelLocale]
}
ProductOptionValue
Description
Product option value.
Fields
Field Name | Description |
---|---|
id - ID!
|
ID of the product option value. |
isDefault - Boolean!
|
Indicates whether this value is selected by default. |
label - String!
|
Label for the option value. |
Possible Types
ProductOptionValue Types |
---|
Example
{
"id": "4",
"isDefault": false,
"label": "abc123"
}
ProductOptionValueForLocale
ProductOptionValueOverridesForChannelLocale
ProductOverrides
Description
Product overrides data.
Types
Union Types |
---|
Example
ProductChannelOverrides
ProductOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [ProductOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [ProductOverridesEdge]
}
ProductOverridesContextInput
ProductOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - ProductOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": ProductChannelOverrides,
"cursor": "xyz789"
}
ProductOverridesForChannel
Description
Product overrides for a channel.
Fields
Field Name | Description |
---|---|
isFeatured - Boolean
|
Product isFeatured override for a specific channel. |
Example
{"isFeatured": true}
ProductOverridesForLocale
Description
Product overrides for a channel locale.
Fields
Field Name | Description |
---|---|
basicInformation - ProductBasicInformationOverridesForLocale
|
Basic information override of the product for a channel locale. |
seoInformation - ProductSeoInformationOverridesForLocale
|
Override for product SEO information in a channel locale. |
storefrontDetails - StorefrontDetailsOverridesForLocale
|
Product storefront details. |
urlPath - ProductUrlPathOverridesForLocale
|
Product path override. |
preOrderSettings - PreOrderSettingsOverridesForLocale
|
Pre-order settings override of the product for a channel locale. |
Example
{
"basicInformation": ProductBasicInformationOverridesForLocale,
"seoInformation": ProductSeoInformationOverridesForLocale,
"storefrontDetails": StorefrontDetailsOverridesForLocale,
"urlPath": ProductUrlPathOverridesForLocale,
"preOrderSettings": PreOrderSettingsOverridesForLocale
}
ProductOverridesLocaleContextInput
ProductPreOrderSettingsField
Description
Product pre-order settings field names
Values
Enum Value | Description |
---|---|
|
The pre-order message. |
Example
"PRODUCT_PRE_ORDER_MESSAGE"
ProductPreOrderSettingsOverridesForChannelLocale
Description
Overrides for pre-order settings fields of a channel and locale.
Fields
Field Name | Description |
---|---|
preorderMessage - String
|
Override for the pre-order message field. |
Example
{"preorderMessage": "abc123"}
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"
ProductSeoInformationOverridesForChannelLocale
ProductSeoInformationOverridesForLocale
Description
Product SEO information overrides in a channel locale.
Example
{
"metaDescription": "abc123",
"pageTitle": "xyz789"
}
ProductStorefrontDetailsField
Description
Product storefront details field names
Values
Enum Value | Description |
---|---|
|
The availability description. |
|
The search keywords. |
|
The warranty. |
Example
"PRODUCT_AVAILABILITY_DESCRIPTION_FIELD"
ProductStorefrontDetailsOverridesForChannelLocale
Description
Overrides for storefront details of a channel locale.
Example
{
"warranty": "abc123",
"availabilityDescription": "abc123",
"searchKeywords": "abc123"
}
ProductUrlPath
Description
Product URL path.
Fields
Field Name | Description |
---|---|
path - String!
|
Value for the product URL path. |
Example
{"path": "abc123"}
ProductUrlPathOverridesForLocale
Description
Product path overrides in a channel locale.
Fields
Field Name | Description |
---|---|
path - String
|
Path override value in a channel locale. |
Example
{"path": "xyz789"}
ProductsFiltersInput
Fields
Input Field | Description |
---|---|
ids - [ID!]
|
The unique identifiers of the products. |
Example
{"ids": [4]}
PubSubNoPermissionToPublishError
PubSubTopicNotFoundError
PubSubWebhook
Description
A Google Cloud PubSub webhook.
Fields
Field Name | Description |
---|---|
destination - String!
|
The Google Cloud PubSub topic that’s been enabled with Publisher permissions. See the PubSub config narrative page and https://cloud.google.com/pubsub/docs/create-topic#resource_names for more info. |
clientId - String!
|
ID of client application owning the webhook. |
createdAt - DateTime
|
The date and time of webhook creation. |
eventFilters - [WebhookEventFilter!]!
|
Event filters for webhook. |
id - ID!
|
The ID of a webhook object. |
scope - String!
|
The scope of the event subscription. |
status - WebhookStatus!
|
The status of a webhook. |
updatedAt - DateTime
|
The date and time of the last webhook update. |
Example
{
"destination": "abc123",
"clientId": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"eventFilters": [WebhookEventFilter],
"id": "4",
"scope": "abc123",
"status": "ACTIVE",
"updatedAt": "2007-12-03T10:15:30Z"
}
RadioButtonsModifierValue
Description
Value of the radio buttons product modifier.
Example
{
"id": 4,
"isDefault": true,
"label": "abc123"
}
RadioButtonsModifierValueForLocale
Description
Overrides for a radio button product modifier value in a channel locale.
Example
{
"id": "4",
"label": "abc123"
}
RadioButtonsOptionValue
RadioButtonsOptionValueForLocale
RadioButtonsOptionValueOverridesForChannelLocale
RadioButtonsProductModifier
Description
Radio buttons product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - RadioButtonsProductModifierForLocale
|
Overrides for the product modifier in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - RadioButtonsProductModifierOverridesConnection!
|
Overrides for a radio buttons product modifier in a context of channel and locale. |
Arguments
|
|
values - [RadioButtonsModifierValue!]!
|
Product modifier values. |
id - ID!
|
The ID of the object. |
displayName - String!
|
Product modifier display name. |
isRequired - Boolean!
|
Indicates whether product modifier is required. |
isShared - Boolean!
|
Indicates whether product modifier is shared or local. |
Example
{
"overridesForLocale": RadioButtonsProductModifierForLocale,
"overrides": RadioButtonsProductModifierOverridesConnection,
"values": [RadioButtonsModifierValue],
"id": 4,
"displayName": "xyz789",
"isRequired": false,
"isShared": false
}
RadioButtonsProductModifierForLocale
Description
Overrides for the radio buttons product modifier in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Override for the product modifier display name in a channel locale. |
values - [RadioButtonsModifierValueForLocale!]!
|
Override for the product modifier values in a channel locale. |
Example
{
"displayName": "xyz789",
"values": [RadioButtonsModifierValueForLocale]
}
RadioButtonsProductModifierOverrides
Description
Overrides for a radio buttons product modifier.
Types
Union Types |
---|
Example
RadioButtonsProductModifierOverridesForChannelLocale
RadioButtonsProductModifierOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [RadioButtonsProductModifierOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [RadioButtonsProductModifierOverridesEdge]
}
RadioButtonsProductModifierOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - RadioButtonsProductModifierOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": RadioButtonsProductModifierOverridesForChannelLocale,
"cursor": "xyz789"
}
RadioButtonsProductModifierOverridesForChannelLocale
Description
Overrides for a radio buttons product modifier in a context of channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product modifier overrides context for channel and locale. |
displayName - String
|
Display name override for the product modifier in a context of a channel and locale. |
values - [RadioButtonsProductModifierValueOverridesForChannelLocale!]!
|
List of product modifier values overrides in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"displayName": "abc123",
"values": [
RadioButtonsProductModifierValueOverridesForChannelLocale
]
}
RadioButtonsProductModifierValueOverridesForChannelLocale
Description
Overrides for the radio buttons product modifier in a context of channel and locale.
Example
{"id": 4, "label": "xyz789"}
RadioButtonsProductOption
Description
Radio buttons product option.
Fields
Field Name | Description |
---|---|
displayName - String!
|
Display name for the option. |
isShared - Boolean!
|
Indicates whether product option is shared or local. |
id - ID!
|
The ID of the object. |
overridesForLocale - ProductOptionForLocale
|
Option overrides for a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - ProductOptionOverridesConnection!
|
Overrides for a radio buttons product option in a context of channel and locale. |
Arguments
|
|
values - [ProductOptionValue!]!
|
List of product option values. |
Example
{
"displayName": "abc123",
"isShared": true,
"id": 4,
"overridesForLocale": ProductOptionForLocale,
"overrides": ProductOptionOverridesConnection,
"values": [ProductOptionValue]
}
RadioButtonsProductOptionForLocale
Description
Override for the radio buttons product option in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Display name for the product option. |
values - [ProductOptionValueForLocale!]!
|
List of product option values. |
Example
{
"displayName": "abc123",
"values": [ProductOptionValueForLocale]
}
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
Value for the rectangle list product modifier.
Example
{
"id": 4,
"isDefault": true,
"label": "xyz789"
}
RectangleListModifierValueForLocale
RectangleListOptionValue
RectangleListOptionValueForLocale
RectangleListOptionValueOverridesForChannelLocale
RectangleListProductModifier
Description
Rectangle list product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - RectangleListProductModifierForLocale
|
Overrides for a rectangle list product modifier in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - RectangleListProductModifierOverridesConnection!
|
Overrides for a rectangle list product modifier in a context of channel and locale. |
Arguments
|
|
values - [RectangleListModifierValue!]!
|
Values for a rectangle list product modifier. |
id - ID!
|
The ID of the object. |
displayName - String!
|
Product modifier display name. |
isRequired - Boolean!
|
Indicates whether product modifier is required. |
isShared - Boolean!
|
Indicates whether product modifier is shared or local. |
Example
{
"overridesForLocale": RectangleListProductModifierForLocale,
"overrides": RectangleListProductModifierOverridesConnection,
"values": [RectangleListModifierValue],
"id": "4",
"displayName": "xyz789",
"isRequired": true,
"isShared": false
}
RectangleListProductModifierForLocale
Description
Overrides for a rectangle list product modifier in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Display name for the product modifier. |
values - [RectangleListModifierValueForLocale!]!
|
Values for the rectangle list product modifier. |
Example
{
"displayName": "xyz789",
"values": [RectangleListModifierValueForLocale]
}
RectangleListProductModifierOverrides
Description
Overrides for a rectangle list product modifier.
Types
Union Types |
---|
Example
RectangleListProductModifierOverridesForChannelLocale
RectangleListProductModifierOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [RectangleListProductModifierOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [RectangleListProductModifierOverridesEdge]
}
RectangleListProductModifierOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - RectangleListProductModifierOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": RectangleListProductModifierOverridesForChannelLocale,
"cursor": "abc123"
}
RectangleListProductModifierOverridesForChannelLocale
Description
Overrides for a rectangle list product modifier in a context of channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product modifier overrides context for channel and locale. |
displayName - String
|
Display name override for the product modifier in a context of a channel and locale. |
values - [RectangleListProductModifierValueOverridesForChannelLocale!]!
|
List of product modifier values overrides in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"displayName": "abc123",
"values": [
RectangleListProductModifierValueOverridesForChannelLocale
]
}
RectangleListProductModifierValueOverridesForChannelLocale
Description
Overrides for the rectangle list product modifier in a context of channel and locale.
Example
{"id": 4, "label": "xyz789"}
RectangleListProductOption
Description
Rectangle list product option.
Fields
Field Name | Description |
---|---|
displayName - String!
|
Display name for the option. |
isShared - Boolean!
|
Indicates whether product option is shared or local. |
id - ID!
|
The ID of the object. |
overridesForLocale - ProductOptionForLocale
|
Option overrides for a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - ProductOptionOverridesConnection!
|
Overrides for a rectangle list product option in a context of channel and locale. |
Arguments
|
|
values - [ProductOptionValue!]!
|
List of product option values. |
Example
{
"displayName": "xyz789",
"isShared": false,
"id": "4",
"overridesForLocale": ProductOptionForLocale,
"overrides": ProductOptionOverridesConnection,
"values": [ProductOptionValue]
}
RectangleListProductOptionForLocale
Description
Override for a rectangle list product option in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Display name for the product option. |
values - [ProductOptionValueForLocale!]!
|
List of product option values. |
Example
{
"displayName": "abc123",
"values": [ProductOptionValueForLocale]
}
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
Input that removes overrides for the checkbox product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveCheckboxProductModifierOverridesField!]
|
Fields for the modifier. |
Example
{"fields": ["CHECKBOX_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}
RemoveDateFieldProductModifierOverridesField
Description
Date field product modifier overrides field name
Values
Enum Value | Description |
---|---|
|
The display name field. |
Example
"DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"
RemoveDateFieldProductModifierOverridesInput
Description
Input that removes overrides for the date field product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveDateFieldProductModifierOverridesField!]
|
Fields for the modifier. |
Example
{"fields": ["DATE_FIELD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}
RemoveDropdownProductModifierOverridesField
Description
Dropdown product modifier overrides field name
Values
Enum Value | Description |
---|---|
|
The display name field. |
Example
"DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"
RemoveDropdownProductModifierOverridesInput
Description
Input that removes overrides for the dropdown product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveDropdownProductModifierOverridesField!]
|
Fields for the modifier. |
values - RemoveDropdownProductModifierValuesOverridesInput
|
Values for the modifier. |
Example
{
"fields": ["DROPDOWN_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
"values": RemoveDropdownProductModifierValuesOverridesInput
}
RemoveDropdownProductModifierValuesOverridesInput
Description
Input that removes overrides for the values of a dropdown product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
ids - [ID!]!
|
IDs of the modifier values. |
Example
{"ids": ["4"]}
RemoveDropdownProductOptionOverridesField
Description
Dropdown product option overrides field names
Values
Enum Value | Description |
---|---|
|
The display name field. |
Example
"DROPDOWN_PRODUCT_OPTION_DISPLAY_NAME_FIELD"
RemoveDropdownProductOptionOverridesInput
Description
Input that removes overrides for the dropdown product option from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveDropdownProductOptionOverridesField!]
|
Product option fields that have overrides you want to remove. |
values - RemoveDropdownProductOptionValuesOverridesInput
|
Product option values that have overrides you want to remove. |
Example
{
"fields": ["DROPDOWN_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
"values": RemoveDropdownProductOptionValuesOverridesInput
}
RemoveDropdownProductOptionValuesOverridesInput
Description
Input that removes overrides for the values of a dropdown product option from a channel locale.
Fields
Input Field | Description |
---|---|
ids - [ID!]!
|
IDs of the product option values that have overrides you want to remove. |
Example
{"ids": [4]}
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
Input that removes overrides for the file upload product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveFileUploadProductModifierOverridesField!]
|
Fields for the modifier that have overrides you want to remove. |
Example
{"fields": ["FILE_UPLOAD_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"]}
RemoveMultiLineTextFieldProductModifierOverridesField
Description
MultiLine text field product modifier overrides field name
Values
Enum Value | Description |
---|---|
|
The field default value. |
|
The display name field. |
Example
"MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"
RemoveMultiLineTextFieldProductModifierOverridesInput
Description
Input that removes overrides for the multiline text field product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveMultiLineTextFieldProductModifierOverridesField!]
|
Fields for the modifier that have overrides you want to remove. |
Example
{"fields": ["MULTILINE_TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}
RemoveNumberFieldProductModifierOverridesField
Description
Number field product modifier overrides field name
Values
Enum Value | Description |
---|---|
|
The field value. |
|
The display name field. |
Example
"NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"
RemoveNumberFieldProductModifierOverridesInput
Description
Input that removes overrides for the number-only text field product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveNumberFieldProductModifierOverridesField!]
|
Fields for the modifier that have overrides you want to remove. |
Example
{"fields": ["NUMBER_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}
RemovePickListProductModifierOverridesField
Description
Pick list product modifier overrides field name.
Values
Enum Value | Description |
---|---|
|
The display name field. |
Example
"PICK_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"
RemovePickListProductModifierOverridesInput
Description
Pick list product modifier overrides input
Fields
Input Field | Description |
---|---|
fields - [RemovePickListProductModifierOverridesField!]
|
Pick list product modifier fields to remove overrides for |
values - RemovePickListProductModifierValueOverridesInput
|
Pick list product modifier values to remove overrides for |
Example
{
"fields": ["PICK_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
"values": RemovePickListProductModifierValueOverridesInput
}
RemovePickListProductModifierValueOverridesInput
Description
Pick list product modifier values to remove overrides for
Fields
Input Field | Description |
---|---|
ids - [ID!]!
|
Pick list product modifier values ids to remove overrides for |
Example
{"ids": [4]}
RemoveProductBasicInformationOverridesInput
Fields
Input Field | Description |
---|---|
localeContext - ProductOverridesLocaleContextInput!
|
The channel and locale that apply when you remove overrides from a channel locale. |
overridesToRemove - [ProductBasicInformationField!]
|
A set of fields for basic product information with overrides you want to remove. An empty value means you will remove all overrides. |
productId - ID!
|
The product that has overrides you want to remove. |
Example
{
"localeContext": ProductOverridesLocaleContextInput,
"overridesToRemove": ["PRODUCT_DESCRIPTION_FIELD"],
"productId": "4"
}
RemoveProductBasicInformationOverridesResult
Description
Result of a mutation that removes overrides for product basic information from a channel locale.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its overrides removed. |
Example
{"product": Product}
RemoveProductCustomFieldsOverridesAttribute
Description
The attributes of a custom field that you want to remove from an override.
Values
Enum Value | Description |
---|---|
|
The visibility flag of a custom field that you want to remove from an override. |
|
The name of a custom field that you want to remove from an override. |
|
The value of a custom field that you want to remove from an override. |
Example
"IS_VISIBLE"
RemoveProductCustomFieldsOverridesChannelLocaleContextDataInput
Description
Input that removes overrides for product custom fields from a storefront channel locale.
Fields
Input Field | Description |
---|---|
context - ChannelLocaleContextInput!
|
The storefront channel and locale that apply when you remove overrides for product custom fields in a channel locale. |
attributes - [RemoveProductCustomFieldsOverridesAttribute!]
|
The attributes of a custom field that you want to remove from an override. |
Example
{
"context": ChannelLocaleContextInput,
"attributes": ["IS_VISIBLE"]
}
RemoveProductCustomFieldsOverridesDataInput
Description
Input that removes overrides for product custom fields from a storefront channel locale.
Fields
Input Field | Description |
---|---|
customFieldId - ID!
|
ID of the custom field that has overrides you want to remove. |
channelLocaleContextData - RemoveProductCustomFieldsOverridesChannelLocaleContextDataInput!
|
The data that applies when you remove overrides for product custom fields in a storefront channel locale. |
Example
{
"customFieldId": 4,
"channelLocaleContextData": RemoveProductCustomFieldsOverridesChannelLocaleContextDataInput
}
RemoveProductCustomFieldsOverridesInput
Fields
Input Field | Description |
---|---|
productId - ID!
|
ID of the product that has the custom field overrides you want to remove. |
data - [RemoveProductCustomFieldsOverridesDataInput!]!
|
Example
{
"productId": "4",
"data": [RemoveProductCustomFieldsOverridesDataInput]
}
RemoveProductCustomFieldsOverridesResult
Fields
Field Name | Description |
---|---|
product - Product
|
The product that has the custom field overrides that you removed. |
Example
{"product": Product}
RemoveProductIsFeaturedOverrideInput
RemoveProductIsFeaturedOverrideResult
Description
Result of a mutation that removes overrides for whether a product is featured in a channel locale.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its override removed. |
Example
{"product": Product}
RemoveProductModifierOverridesDataInput
Description
Input that removes overrides for product modifiers from a channel locale.
Fields
Input Field | Description |
---|---|
modifiers - [RemoveProductModifierOverridesInput!]!
|
Modifier overrides that you want to remove. |
Example
{"modifiers": [RemoveProductModifierOverridesInput]}
RemoveProductModifierOverridesInput
Description
Input that has the product modifier overrides you want to remove.
Fields
Input Field | Description |
---|---|
modifierId - ID!
|
Product modifier ID. |
data - RemoveProductModifierOverridesUnionDataInput!
|
Product modifier override. |
Example
{
"modifierId": 4,
"data": RemoveProductModifierOverridesUnionDataInput
}
RemoveProductModifierOverridesUnionDataInput
Description
Input that has product modifier overrides data. You can only use one type of modifier in a request.
Fields
Input Field | Description |
---|---|
checkbox - RemoveCheckboxProductModifierOverridesInput
|
Overrides for checkbox product modifiers. |
dateField - RemoveDateFieldProductModifierOverridesInput
|
Overrides for date field product modifiers. |
dropdown - RemoveDropdownProductModifierOverridesInput
|
Overrides for dropdown product modifiers. |
fileUpload - RemoveFileUploadProductModifierOverridesInput
|
Overrides for file upload product modifiers. |
multiLineTextField - RemoveMultiLineTextFieldProductModifierOverridesInput
|
Overrides for multiline text field product modifiers. |
numberField - RemoveNumberFieldProductModifierOverridesInput
|
Overrides for number field product modifiers. |
pickList - RemovePickListProductModifierOverridesInput
|
Overrides for pick list product modifiers. |
radioButtons - RemoveRadioButtonsProductModifierOverridesInput
|
Overrides for radio buttons product modifiers. |
rectangleList - RemoveRectangleListProductModifierOverridesInput
|
Overrides for rectangle list product modifiers. |
swatch - RemoveSwatchProductModifierOverridesInput
|
Overrides for swatch product modifiers. |
textField - RemoveTextFieldProductModifierOverridesInput
|
Overrides for text field product modifiers. |
Example
{
"checkbox": RemoveCheckboxProductModifierOverridesInput,
"dateField": RemoveDateFieldProductModifierOverridesInput,
"dropdown": RemoveDropdownProductModifierOverridesInput,
"fileUpload": RemoveFileUploadProductModifierOverridesInput,
"multiLineTextField": RemoveMultiLineTextFieldProductModifierOverridesInput,
"numberField": RemoveNumberFieldProductModifierOverridesInput,
"pickList": RemovePickListProductModifierOverridesInput,
"radioButtons": RemoveRadioButtonsProductModifierOverridesInput,
"rectangleList": RemoveRectangleListProductModifierOverridesInput,
"swatch": RemoveSwatchProductModifierOverridesInput,
"textField": RemoveTextFieldProductModifierOverridesInput
}
RemoveProductModifiersOverridesInput
Description
Input that removes overrides for product modifiers from a channel locale.
Fields
Input Field | Description |
---|---|
productId - ID!
|
ID for the product that has overrides you want to remove. |
localeContext - ProductOverridesLocaleContextInput!
|
The channel and locale that apply when you remove overrides from a channel locale. |
data - RemoveProductModifierOverridesDataInput!
|
Product modifier overrides you want to remove. |
Example
{
"productId": "4",
"localeContext": ProductOverridesLocaleContextInput,
"data": RemoveProductModifierOverridesDataInput
}
RemoveProductModifiersOverridesResult
Description
Result of a mutation that removes overrides for a product modifier from a channel locale.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its overrides removed. |
Example
{"product": Product}
RemoveProductOptionOverridesDataInput
Description
Input that removes overrides for product options from a channel locale.
Fields
Input Field | Description |
---|---|
optionId - ID!
|
ID for the option that has overrides you want to remove. |
data - RemoveProductOptionOverridesUnionDataInput!
|
Product option overrides you want to remove. |
Example
{
"optionId": 4,
"data": RemoveProductOptionOverridesUnionDataInput
}
RemoveProductOptionOverridesUnionDataInput
Description
Input that removes overrides for product options from a channel locale.
Fields
Input Field | Description |
---|---|
dropdown - RemoveDropdownProductOptionOverridesInput
|
Dropdown product option that has overrides you want to remove. |
radioButtons - RemoveRadioButtonsProductOptionOverridesInput
|
Radio button product option that has overrides you want to remove. |
rectangleList - RemoveRectangleListProductOptionOverridesInput
|
Rectangle list product option that has overrides you want to remove. |
swatch - RemoveSwatchProductOptionOverridesInput
|
Swatch product option that has overrides you want to remove. |
Example
{
"dropdown": RemoveDropdownProductOptionOverridesInput,
"radioButtons": RemoveRadioButtonsProductOptionOverridesInput,
"rectangleList": RemoveRectangleListProductOptionOverridesInput,
"swatch": RemoveSwatchProductOptionOverridesInput
}
RemoveProductOptionsOverridesDataInput
Description
Input that removes overrides for product options from a channel locale.
Fields
Input Field | Description |
---|---|
options - [RemoveProductOptionOverridesDataInput!]!
|
Product option overrides that you want to remove. |
Example
{"options": [RemoveProductOptionOverridesDataInput]}
RemoveProductOptionsOverridesInput
Fields
Input Field | Description |
---|---|
data - RemoveProductOptionsOverridesDataInput!
|
Product options overrides you want to remove. |
localeContext - ProductOverridesLocaleContextInput!
|
The channel and locale that apply when you remove overrides from a channel locale. |
productId - ID!
|
The ID of the product that has overrides you want to remove. |
Example
{
"data": RemoveProductOptionsOverridesDataInput,
"localeContext": ProductOverridesLocaleContextInput,
"productId": "4"
}
RemoveProductOptionsOverridesResult
Description
Result of a mutation that removes overrides for a product option from a channel locale.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its overrides removed. |
Example
{"product": Product}
RemoveProductPreOrderSettingsOverridesInput
Fields
Input Field | Description |
---|---|
localeContext - ProductOverridesLocaleContextInput!
|
The channel and locale that apply when you remove overrides from a channel locale. |
overridesToRemove - [ProductPreOrderSettingsField!]
|
Set of fields for product pre-order settings that have overrides you want to remove. Empty value means you will remove all overrides. |
productId - ID!
|
The ID of the product that has overrides you want to remove. |
Example
{
"localeContext": ProductOverridesLocaleContextInput,
"overridesToRemove": ["PRODUCT_PRE_ORDER_MESSAGE"],
"productId": "4"
}
RemoveProductPreOrderSettingsOverridesResult
Description
Result of a mutation that removes overrides for product pre-order settings from a channel locale.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its overrides removed. |
Example
{"product": Product}
RemoveProductSeoInformationOverridesInput
Fields
Input Field | Description |
---|---|
localeContext - ProductOverridesLocaleContextInput!
|
The channel and locale that apply when you remove overrides from a channel locale. |
overridesToRemove - [ProductSeoInformationField!]
|
Set of fields for product SEO information that have overrides you want to remove. Empty value means you will remove all overrides. |
productId - ID!
|
The product which information should be modified. |
Example
{
"localeContext": ProductOverridesLocaleContextInput,
"overridesToRemove": ["PRODUCT_META_DESCRIPTION_FIELD"],
"productId": "4"
}
RemoveProductSeoInformationOverridesResult
Description
Result of a mutation that removes overrides for product SEO information from a channel locale.
Fields
Field Name | Description |
---|---|
product - Product
|
The product which seo information overrides was removed as a result of mutation. |
Example
{"product": Product}
RemoveProductStorefrontDetailsOverridesInput
Fields
Input Field | Description |
---|---|
localeContext - ProductOverridesLocaleContextInput!
|
The channel and locale that apply when you remove overrides from a channel locale. |
overridesToRemove - [ProductStorefrontDetailsField!]
|
Set of fields for product storefront details that has overrides you want to remove. Empty value means you will remove all overrides. |
productId - ID!
|
The product which information should be modified. |
Example
{
"localeContext": ProductOverridesLocaleContextInput,
"overridesToRemove": ["PRODUCT_AVAILABILITY_DESCRIPTION_FIELD"],
"productId": 4
}
RemoveProductStorefrontDetailsOverridesResult
Description
Result of a mutation that removes overrides for product storefront details from a channel locale.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its overrides removed. |
Example
{"product": Product}
RemoveProductUrlPathOverrideInput
Fields
Input Field | Description |
---|---|
localeContext - ProductOverridesLocaleContextInput!
|
The channel and locale that apply when you remove overrides from a channel locale. |
productId - ID!
|
ID for the product that has a URL path override you want to remove. |
Example
{
"localeContext": ProductOverridesLocaleContextInput,
"productId": 4
}
RemoveProductUrlPathOverrideResult
Description
Result of a mutation that removes overrides for a product url path from a channel locale.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its overrides removed. |
Example
{"product": Product}
RemoveRadioButtonsProductModifierOverridesField
Description
Radio buttons product modifier overrides field name
Values
Enum Value | Description |
---|---|
|
The display name field. |
Example
"RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"
RemoveRadioButtonsProductModifierOverridesInput
Description
Input that removes overrides for the radio button product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveRadioButtonsProductModifierOverridesField!]
|
Fields for the modifier that have overrides you want to remove. |
values - RemoveRadioButtonsProductModifierValueOverridesInput
|
Values for the modifier that have overrides you want to remove. |
Example
{
"fields": ["RADIO_BUTTONS_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
"values": RemoveRadioButtonsProductModifierValueOverridesInput
}
RemoveRadioButtonsProductModifierValueOverridesInput
Description
Input that removes overrides for values of the radio button product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
ids - [ID!]!
|
IDs of the values that have overrides you want to remove. |
Example
{"ids": [4]}
RemoveRadioButtonsProductOptionOverridesField
Description
Radio buttons product option overrides field names
Values
Enum Value | Description |
---|---|
|
The display name field. |
Example
"RADIO_BUTTONS_PRODUCT_OPTION_DISPLAY_NAME_FIELD"
RemoveRadioButtonsProductOptionOverridesInput
Description
Input that removes overrides for the radio buttons product option from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveRadioButtonsProductOptionOverridesField!]
|
Fields for the option that have overrides you want to remove. |
values - RemoveRadioButtonsProductOptionValuesOverridesInput
|
Values for the option that have overrides you want to remove. |
Example
{
"fields": ["RADIO_BUTTONS_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
"values": RemoveRadioButtonsProductOptionValuesOverridesInput
}
RemoveRadioButtonsProductOptionValuesOverridesInput
Description
Input that removes overrides for values of the radio button product option from a channel locale.
Fields
Input Field | Description |
---|---|
ids - [ID!]!
|
IDs of the option values that have overrides you want to remove. |
Example
{"ids": ["4"]}
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
Input that removes overrides for the rectangle list product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveRectangleListProductModifierOverridesField!]
|
Fields for the modifier that have overrides you want to remove. |
values - RemoveRectangleListProductModifierValueOverridesInput
|
Values for the option that have overrides you want to remove. |
Example
{
"fields": ["RECTANGLE_LIST_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
"values": RemoveRectangleListProductModifierValueOverridesInput
}
RemoveRectangleListProductModifierValueOverridesInput
Description
Input that removes overrides for values of the rectangle list product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
ids - [ID!]!
|
IDs of the modifier values that have overrides you want to remove. |
Example
{"ids": ["4"]}
RemoveRectangleListProductOptionOverridesField
Description
Rectangle list product option overrides field names
Values
Enum Value | Description |
---|---|
|
The display name field. |
Example
"RECTANGLE_LIST_PRODUCT_OPTION_DISPLAY_NAME_FIELD"
RemoveRectangleListProductOptionOverridesInput
Description
Input that removes overrides for the rectangle list product option from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveRectangleListProductOptionOverridesField!]
|
Fields for the modifier that have overrides you want to remove. |
values - RemoveRectangleListProductOptionValuesOverridesInput
|
Values for the option that have overrides you want to remove. |
Example
{
"fields": ["RECTANGLE_LIST_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
"values": RemoveRectangleListProductOptionValuesOverridesInput
}
RemoveRectangleListProductOptionValuesOverridesInput
Description
Input that removes overrides for values of the rectangle list product option from a channel locale.
Fields
Input Field | Description |
---|---|
ids - [ID!]!
|
IDs of the option values that have overrides you want to remove. |
Example
{"ids": [4]}
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
Input that removes overrides for swatch product modifiers from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveSwatchProductModifierOverridesField!]
|
Fields for the modifier that have overrides you want to remove. |
values - RemoveSwatchProductModifierValuesOverridesInput
|
Values of the modifier that have overrides you want to remove. |
Example
{
"fields": ["SWATCH_PRODUCT_MODIFIER_DISPLAY_NAME_FIELD"],
"values": RemoveSwatchProductModifierValuesOverridesInput
}
RemoveSwatchProductModifierValuesOverridesInput
Description
Input that removes overrides for values of the swatch product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
ids - [ID!]!
|
IDs of the modifier values that have overrides you want to remove. |
Example
{"ids": [4]}
RemoveSwatchProductOptionOverridesField
Description
Swatch product option overrides field names
Values
Enum Value | Description |
---|---|
|
The display name field. |
Example
"SWATCH_PRODUCT_OPTION_DISPLAY_NAME_FIELD"
RemoveSwatchProductOptionOverridesInput
Description
Input that removes overrides for swatch product options from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveSwatchProductOptionOverridesField!]
|
Fields for the product option that have overrides you want to remove. |
values - RemoveSwatchProductOptionValuesOverridesInput
|
Values for the product option that have overrides you want to remove. |
Example
{
"fields": ["SWATCH_PRODUCT_OPTION_DISPLAY_NAME_FIELD"],
"values": RemoveSwatchProductOptionValuesOverridesInput
}
RemoveSwatchProductOptionValuesOverridesInput
Description
Input that removes overrides for values of the swatch product option from a channel locale.
Fields
Input Field | Description |
---|---|
ids - [ID!]!
|
IDs of the option values that have overrides you want to remove. |
Example
{"ids": ["4"]}
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
Input that removes overrides for text field product modifier from a channel locale.
Fields
Input Field | Description |
---|---|
fields - [RemoveTextFieldProductModifierOverridesField!]
|
Fields for the modifier that have overrides you want to remove. |
Example
{"fields": ["TEXT_FIELD_PRODUCT_MODIFIER_DEFAULT_VALUE_FIELD"]}
ScopeChangeNotAllowedError
Description
Error indicating that the scope change is not allowed for this webhook.
Fields
Field Name | Description |
---|---|
message - String!
|
Information about error. |
Example
{"message": "abc123"}
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
Input that sets date field product modifier information.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the date field product modifier. |
Example
{"displayName": "abc123"}
SetDropdownProductModifierInformationInput
Description
Input that sets dropdown product modifier information.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the dropdown product modifier. |
values - [SetDropdownProductModifierValueInformationInput!]
|
Dropdown modifier values information |
Example
{
"displayName": "xyz789",
"values": [
SetDropdownProductModifierValueInformationInput
]
}
SetDropdownProductModifierValueInformationInput
Description
Input that sets information for dropdown product modifier values.
Example
{
"valueId": "4",
"label": "xyz789"
}
SetDropdownProductOptionInformationInput
Description
Input that sets information for dropdown product options.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the dropdown product option. |
values - [SetDropdownProductOptionValueInformationInput!]
|
Dropdown product option values. |
Example
{
"displayName": "abc123",
"values": [
SetDropdownProductOptionValueInformationInput
]
}
SetDropdownProductOptionValueInformationInput
SetFileUploadProductModifierInformationInput
Description
Input that sets information for the file upload product modifier.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the file upload product modifier. |
Example
{"displayName": "xyz789"}
SetMultiLineTextFieldProductModifierInformationInput
SetNumberFieldProductModifierInformationInput
Description
Input that sets information for the numbers-only text field product modifier.
Example
{
"defaultValue": 987.65,
"displayName": "xyz789"
}
SetPickListProductModifierInformationInput
Description
Input that sets information for the pick list product modifier.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the product modifier. |
values - [SetPickListProductModifierValueInformationInput!]
|
Pick list modifier values. |
Example
{
"displayName": "xyz789",
"values": [
SetPickListProductModifierValueInformationInput
]
}
SetPickListProductModifierValueInformationInput
SetProductBasicInformationDataInput
SetProductBasicInformationInput
Fields
Input Field | Description |
---|---|
localeContext - ProductOverridesLocaleContextInput
|
The channel and locale that apply when you set overrides for a channel locale. |
data - SetProductBasicInformationDataInput!
|
|
productId - ID!
|
ID of the product that has basic product information you want to set. |
Example
{
"localeContext": ProductOverridesLocaleContextInput,
"data": SetProductBasicInformationDataInput,
"productId": "4"
}
SetProductBasicInformationResult
Description
Result of a mutation that sets product basic information.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its overrides updated. |
Example
{"product": Product}
SetProductIsFeaturedDataInput
Fields
Input Field | Description |
---|---|
isFeatured - Boolean!
|
Product isFeatured flag. |
Example
{"isFeatured": true}
SetProductIsFeaturedInput
Fields
Input Field | Description |
---|---|
channelId - ID
|
ID of the channel where you want to set whether a product is marked as featured. |
data - SetProductIsFeaturedDataInput!
|
|
productId - ID!
|
ID of the product that has information you want to set. |
Example
{
"channelId": "4",
"data": SetProductIsFeaturedDataInput,
"productId": 4
}
SetProductIsFeaturedResult
Description
Result of a mutation that sets whether a product is marked as featured on the storefront.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its isFeatured flag updated. |
Example
{"product": Product}
SetProductModifierInformationDataInput
Description
Product modifiers information data
Fields
Input Field | Description |
---|---|
modifiers - [SetProductModifierInformationInput!]!
|
Product modifiers information data |
Example
{"modifiers": [SetProductModifierInformationInput]}
SetProductModifierInformationInput
Description
Product modifier information
Fields
Input Field | Description |
---|---|
modifierId - ID!
|
The product modifier id which data should be modified. |
data - SetProductModifierInformationUnionDataInput!
|
Product modifier information of specific type |
Example
{
"modifierId": 4,
"data": SetProductModifierInformationUnionDataInput
}
SetProductModifierInformationUnionDataInput
Description
Input that has the product modifier information you want to set. You can only use one type of modifier in a request.
Fields
Input Field | Description |
---|---|
checkbox - SetCheckboxProductModifierInformationInput
|
Checkbox product modifier information. |
dateField - SetDateFieldProductModifierInformationInput
|
Date field product modifier information. |
dropdown - SetDropdownProductModifierInformationInput
|
Dropdown product modifier information. |
fileUpload - SetFileUploadProductModifierInformationInput
|
File upload product modifier information. |
multiLineTextField - SetMultiLineTextFieldProductModifierInformationInput
|
Multiline text field product modifier information. |
numberField - SetNumberFieldProductModifierInformationInput
|
Number field product modifier information. |
pickList - SetPickListProductModifierInformationInput
|
Pick list product modifier information. |
radioButtons - SetRadioButtonsProductModifierInformationInput
|
Radio buttons product modifier information. |
rectangleList - SetRectangleListProductModifierInformationInput
|
Rectangle list product modifier information. |
swatch - SetSwatchProductModifierInformationInput
|
Swatch product modifier information. |
textField - SetTextFieldProductModifierInformationInput
|
Text field product modifier information. |
Example
{
"checkbox": SetCheckboxProductModifierInformationInput,
"dateField": SetDateFieldProductModifierInformationInput,
"dropdown": SetDropdownProductModifierInformationInput,
"fileUpload": SetFileUploadProductModifierInformationInput,
"multiLineTextField": SetMultiLineTextFieldProductModifierInformationInput,
"numberField": SetNumberFieldProductModifierInformationInput,
"pickList": SetPickListProductModifierInformationInput,
"radioButtons": SetRadioButtonsProductModifierInformationInput,
"rectangleList": SetRectangleListProductModifierInformationInput,
"swatch": SetSwatchProductModifierInformationInput,
"textField": SetTextFieldProductModifierInformationInput
}
SetProductModifiersInformationInput
Description
Input that has the product modifier information you want to set.
Fields
Input Field | Description |
---|---|
productId - ID!
|
ID of the product that has modifier information you want to set. |
localeContext - ProductOverridesLocaleContextInput
|
The channel and locale that apply when you set overrides for a channel locale. |
data - SetProductModifierInformationDataInput!
|
Product modifiers information. |
Example
{
"productId": 4,
"localeContext": ProductOverridesLocaleContextInput,
"data": SetProductModifierInformationDataInput
}
SetProductModifiersInformationResult
Description
Result of a mutation that sets product modifier information.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its modifiers set. |
Example
{"product": Product}
SetProductOptionInformationInput
Description
Input that has the product option information you want to set.
Fields
Input Field | Description |
---|---|
optionId - ID!
|
ID of the product option that has information you want to set. |
data - SetProductOptionInformationUnionDataInput!
|
Product option information of a specific type. |
Example
{
"optionId": "4",
"data": SetProductOptionInformationUnionDataInput
}
SetProductOptionInformationUnionDataInput
Description
Input that has the product option information you want to set. You can only use one type of modifier in a request.
Fields
Input Field | Description |
---|---|
dropdown - SetDropdownProductOptionInformationInput
|
Dropdown product option information. |
radioButtons - SetRadioButtonsProductOptionInformationInput
|
Radio buttons product option information. |
rectangleList - SetRectangleListProductOptionInformationInput
|
Rectangle list product option information. |
swatch - SetSwatchProductOptionInformationInput
|
Swatch product option information. |
Example
{
"dropdown": SetDropdownProductOptionInformationInput,
"radioButtons": SetRadioButtonsProductOptionInformationInput,
"rectangleList": SetRectangleListProductOptionInformationInput,
"swatch": SetSwatchProductOptionInformationInput
}
SetProductOptionsInformationDataInput
Description
Input that sets information for product options.
Fields
Input Field | Description |
---|---|
options - [SetProductOptionInformationInput!]!
|
Product option information that you want to set. |
Example
{"options": [SetProductOptionInformationInput]}
SetProductOptionsInformationInput
Description
Input that has the product options information you want to set.
Fields
Input Field | Description |
---|---|
localeContext - ProductOverridesLocaleContextInput
|
The channel and locale that apply when you set overrides for a channel locale. |
data - SetProductOptionsInformationDataInput!
|
Product options information. |
productId - ID!
|
ID of the product that has product options information you want to set. |
Example
{
"localeContext": ProductOverridesLocaleContextInput,
"data": SetProductOptionsInformationDataInput,
"productId": 4
}
SetProductOptionsInformationResult
Description
Result of a mutation that sets product options information.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its options set. |
Example
{"product": Product}
SetProductPreOrderSettingsDataInput
Fields
Input Field | Description |
---|---|
message - String
|
Product pre-order message. |
Example
{"message": "xyz789"}
SetProductPreOrderSettingsInput
Fields
Input Field | Description |
---|---|
localeContext - ProductOverridesLocaleContextInput
|
The channel and locale that apply when you set overrides for a channel locale. |
data - SetProductPreOrderSettingsDataInput!
|
Data for the pre-order settings of a product. |
productId - ID!
|
ID of the product that has pre-order settings you want to set. |
Example
{
"localeContext": ProductOverridesLocaleContextInput,
"data": SetProductPreOrderSettingsDataInput,
"productId": 4
}
SetProductPreOrderSettingsResult
Description
Result of a mutation that sets product pre-order settings.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its pre-order settings set. |
Example
{"product": Product}
SetProductSeoInformationDataInput
SetProductSeoInformationInput
Fields
Input Field | Description |
---|---|
localeContext - ProductOverridesLocaleContextInput
|
The channel and locale that apply when you set overrides for a channel locale. |
data - SetProductSeoInformationDataInput!
|
|
productId - ID!
|
ID of the product that has SEO information you want to set. |
Example
{
"localeContext": ProductOverridesLocaleContextInput,
"data": SetProductSeoInformationDataInput,
"productId": 4
}
SetProductSeoInformationResult
Description
Result of a mutation that sets product SEO information.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its SEO information set. |
Example
{"product": Product}
SetProductStorefrontDetailsDataInput
SetProductStorefrontDetailsInput
Fields
Input Field | Description |
---|---|
localeContext - ProductOverridesLocaleContextInput
|
The channel and locale that apply when you set overrides for a channel locale. |
data - SetProductStorefrontDetailsDataInput!
|
Data for the storefront details of a product. |
productId - ID!
|
ID of the product that has storefront details you want to set. |
Example
{
"localeContext": ProductOverridesLocaleContextInput,
"data": SetProductStorefrontDetailsDataInput,
"productId": 4
}
SetProductStorefrontDetailsResult
Description
Result of a mutation that sets product storefront details.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its storefront details set. |
Example
{"product": Product}
SetProductUrlPathDataInput
Fields
Input Field | Description |
---|---|
path - String!
|
Product URL path. |
Example
{"path": "abc123"}
SetProductUrlPathInput
Fields
Input Field | Description |
---|---|
localeContext - ProductOverridesLocaleContextInput
|
The channel and locale that apply when you set overrides for a channel locale. |
data - SetProductUrlPathDataInput!
|
Data for the product URL path. |
productId - ID!
|
ID of the product that has the URL path you want to set. |
Example
{
"localeContext": ProductOverridesLocaleContextInput,
"data": SetProductUrlPathDataInput,
"productId": 4
}
SetProductUrlPathResult
Description
Result of a mutation that sets the product URL path.
Fields
Field Name | Description |
---|---|
product - Product
|
The product that had its URL path set. |
Example
{"product": Product}
SetRadioButtonsProductModifierInformationInput
Description
Input that has information for the radio button product modifier you want to set.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the product modifier. |
values - [SetRadioButtonsProductModifierValueInformationInput!]
|
Values for the radio buttons modifier that has information you want to set. |
Example
{
"displayName": "abc123",
"values": [
SetRadioButtonsProductModifierValueInformationInput
]
}
SetRadioButtonsProductModifierValueInformationInput
Description
Input that has the values for the radio buttons product modifier you want to set.
Example
{"valueId": 4, "label": "abc123"}
SetRadioButtonsProductOptionInformationInput
Description
Input that has the radio buttons product options you want to set.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the product option that you want to set. |
values - [SetRadioButtonsProductOptionValueInformationInput!]
|
Values for the product option you want to set. |
Example
{
"displayName": "xyz789",
"values": [
SetRadioButtonsProductOptionValueInformationInput
]
}
SetRadioButtonsProductOptionValueInformationInput
Description
Input that has the values for the radio buttons product option you want to set.
Example
{"valueId": 4, "label": "abc123"}
SetRectangleListProductModifierInformationInput
Description
Input that has the rectangle list product modifier you want to set.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the product modifier that you want to set. |
values - [SetRectangleListProductModifierValueInformationInput!]
|
Values for the product modifier that you want to set. |
Example
{
"displayName": "abc123",
"values": [
SetRectangleListProductModifierValueInformationInput
]
}
SetRectangleListProductModifierValueInformationInput
Description
Input that has the values for the rectangle list product modifier you want to set.
Example
{"valueId": 4, "label": "xyz789"}
SetRectangleListProductOptionInformationInput
Description
Input that has the rectangle list product option you want to set.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the product option that you want to set. |
values - [SetRectangleListProductOptionValueInformationInput!]
|
Values for the product options that you want to set. |
Example
{
"displayName": "xyz789",
"values": [
SetRectangleListProductOptionValueInformationInput
]
}
SetRectangleListProductOptionValueInformationInput
Description
Input that has the rectangle list product option values you want to set.
Example
{
"valueId": "4",
"label": "xyz789"
}
SetSwatchProductModifierInformationInput
Description
Input that has the swatch product modifier you want to set.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the product modifier you want to set. |
values - [SetSwatchProductModifierValueInformationInput!]
|
Modifier values you want to set. |
Example
{
"displayName": "abc123",
"values": [
SetSwatchProductModifierValueInformationInput
]
}
SetSwatchProductModifierValueInformationInput
SetSwatchProductOptionInformationInput
Description
Input that has the swatch product option you want to set.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the product option you want to set. |
values - [SetSwatchProductOptionValueInformationInput!]
|
Product option values you want to set. |
Example
{
"displayName": "xyz789",
"values": [SetSwatchProductOptionValueInformationInput]
}
SetSwatchProductOptionValueInformationInput
SetTextFieldProductModifierInformationInput
Description
Input that has the text field product modifier you want to set.
Example
{
"defaultValue": "abc123",
"displayName": "xyz789"
}
Site
Description
Site information.
Fields
Field Name | Description |
---|---|
id - ID!
|
The ID of the object. |
createdAt - DateTime!
|
Time when site was created. |
redirects - SiteRedirectConnection!
|
Site's redirects. |
Arguments
|
|
updatedAt - DateTime!
|
Time when site was updated last time. |
urls - SiteUrls!
|
Site urls. |
Example
{
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"redirects": SiteRedirectConnection,
"updatedAt": "2007-12-03T10:15:30Z",
"urls": SiteUrls
}
SiteCanonicalUrl
SiteCheckoutUrl
Description
Checkout Url.
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"isCustomized": false,
"updatedAt": "2007-12-03T10:15:30Z",
"url": "abc123"
}
SiteManualRedirect
Description
Redirect to manually input url.
Fields
Field Name | Description |
---|---|
url - String!
|
Url. |
Example
{"url": "abc123"}
SitePrimaryUrl
SiteRedirect
Description
Site's redirect.
Fields
Field Name | Description |
---|---|
id - ID!
|
The ID of the object. |
fromPath - String!
|
Redirected url. |
to - SiteRedirectTo
|
Additional information about redirect. |
toUrl - String!
|
Full destination URL for the redirect. |
Example
{
"id": "4",
"fromPath": "xyz789",
"to": SiteManualRedirect,
"toUrl": "abc123"
}
SiteRedirectConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [SiteRedirectEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [SiteRedirectEdge]
}
SiteRedirectEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - SiteRedirect!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": SiteRedirect,
"cursor": "xyz789"
}
SiteRedirectTo
Description
Type of the redirect.
Example
SiteManualRedirect
SiteRedirectsFiltersInput
Description
Filters for redirects
Example
{
"fromPath": "abc123",
"ids": [4],
"searchTerm": "abc123"
}
SiteRedirectsSortInput
Description
Sorting by field.
Values
Enum Value | Description |
---|---|
|
Sorting by field type. |
|
Sorting by fromPath field. |
Example
"FIELD_TYPE"
SiteUrls
Description
Site urls
Fields
Field Name | Description |
---|---|
canonicalUrl - SiteCanonicalUrl!
|
Canonical url of the site. |
checkoutUrl - SiteCheckoutUrl!
|
Checkout url of the site. |
primaryUrl - SitePrimaryUrl!
|
Primary url of the site. |
Example
{
"canonicalUrl": SiteCanonicalUrl,
"checkoutUrl": SiteCheckoutUrl,
"primaryUrl": SitePrimaryUrl
}
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. |
channel - Channel
|
A channel. |
Arguments
|
|
channels - ChannelsConnection!
|
List of channels. |
Arguments |
|
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. |
webhook - Webhook
|
Webhook fetch request. |
Arguments
|
|
webhooks - WebhooksConnection!
|
Webhooks list fetch request. |
Arguments |
Example
{
"account": Account,
"appExtensions": AppExtensionsConnection,
"channel": Channel,
"channels": ChannelsConnection,
"id": "4",
"metafield": Metafield,
"metafields": MetafieldsConnection,
"product": Product,
"products": ProductConnection,
"settings": StoreSettings,
"sharedProductModifiers": SharedProductModifierConnection,
"sharedProductOptions": SharedProductOptionConnection,
"storeHash": "abc123",
"storeReferenceId": "abc123",
"webhook": Webhook,
"webhooks": WebhooksConnection
}
StoreSettings
Description
Store settings.
Fields
Field Name | Description |
---|---|
dataSolutions - DataSolutionsSettings!
|
Data solutions. |
storeName - String!
|
Store name. |
webhooks - WebhooksSettings!
|
Webhooks store settings. |
Example
{
"dataSolutions": DataSolutionsSettings,
"storeName": "abc123",
"webhooks": WebhooksSettings
}
StoreSettingsMutations
Description
Store settings mutations.
Fields
Field Name | Description |
---|---|
dataSolutions - DataSolutionsMutations!
|
Data solutions mutations. |
Example
{"dataSolutions": DataSolutionsMutations}
StorefrontDetails
Description
Storefront details.
Example
{
"warranty": "xyz789",
"availabilityDescription": "abc123",
"searchKeywords": "abc123"
}
StorefrontDetailsOverridesForLocale
Description
Overrides for storefront details in a channel locale.
Example
{
"warranty": "abc123",
"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
"xyz789"
SwatchOptionValue
SwatchOptionValueForLocale
SwatchOptionValueOverridesForChannelLocale
SwatchProductModifier
Description
Swatch product modifier.
Fields
Field Name | Description |
---|---|
overridesForLocale - SwatchProductModifierForLocale
|
Overrides for swatch product modifiers in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - SwatchProductModifierOverridesConnection!
|
Overrides for a swatch product modifier in a context of channel and 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,
"overrides": SwatchProductModifierOverridesConnection,
"values": [SwatchProductModifierValue],
"id": 4,
"displayName": "xyz789",
"isRequired": false,
"isShared": true
}
SwatchProductModifierForLocale
Description
Overrides for the swatch product modifier in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Display name for the product modifier. |
values - [SwatchProductModifierValueForLocale!]!
|
Product modifier values. |
Example
{
"displayName": "xyz789",
"values": [SwatchProductModifierValueForLocale]
}
SwatchProductModifierOverrides
Description
Overrides for a swatch product modifier.
Types
Union Types |
---|
Example
SwatchProductModifierOverridesForChannelLocale
SwatchProductModifierOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [SwatchProductModifierOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [SwatchProductModifierOverridesEdge]
}
SwatchProductModifierOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - SwatchProductModifierOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": SwatchProductModifierOverridesForChannelLocale,
"cursor": "abc123"
}
SwatchProductModifierOverridesForChannelLocale
Description
Overrides for a swatch product modifier in a context of channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product modifier overrides context for channel and locale. |
displayName - String
|
Display name override for the product modifier in a context of a channel and locale. |
values - [SwatchProductModifierValueOverridesForChannelLocale!]!
|
List of product modifier values overrides in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"displayName": "xyz789",
"values": [
SwatchProductModifierValueOverridesForChannelLocale
]
}
SwatchProductModifierValue
SwatchProductModifierValueForLocale
SwatchProductModifierValueOverridesForChannelLocale
Description
Overrides for the swatch product modifier in a context of channel and locale.
Example
{
"id": "4",
"label": "abc123"
}
SwatchProductOption
Description
Swatch product option.
Fields
Field Name | Description |
---|---|
displayName - String!
|
Display name for the option. |
isShared - Boolean!
|
Indicates whether product option is shared or local. |
id - ID!
|
The ID of the object. |
overridesForLocale - ProductOptionForLocale
|
Option overrides for a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - ProductOptionOverridesConnection!
|
Overrides for a swatch product option in a context of channel and locale. |
Arguments
|
|
values - [ProductOptionValue!]!
|
List of product option values. |
Example
{
"displayName": "xyz789",
"isShared": true,
"id": "4",
"overridesForLocale": ProductOptionForLocale,
"overrides": ProductOptionOverridesConnection,
"values": [ProductOptionValue]
}
SwatchProductOptionForLocale
Description
Override for the swatch product option in a channel locale.
Fields
Field Name | Description |
---|---|
displayName - String
|
Display name for the product option. |
values - [ProductOptionValueForLocale!]!
|
List of product option values. |
Example
{
"displayName": "abc123",
"values": [ProductOptionValueForLocale]
}
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
|
Default value for the modifier. |
overridesForLocale - TextFieldProductModifierForLocale
|
Overrides for the modifier in a channel locale. Use 'overrides' field instead |
Arguments
|
|
overrides - TextFieldProductModifierOverridesConnection!
|
Overrides for a text field product modifier in a context of channel and 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": "xyz789",
"overridesForLocale": TextFieldProductModifierForLocale,
"overrides": TextFieldProductModifierOverridesConnection,
"id": 4,
"displayName": "xyz789",
"isRequired": true,
"isShared": false
}
TextFieldProductModifierForLocale
TextFieldProductModifierOverrides
Description
Overrides for a text field product modifier.
Types
Union Types |
---|
Example
TextFieldProductModifierOverridesForChannelLocale
TextFieldProductModifierOverridesConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [TextFieldProductModifierOverridesEdge]
|
A list of edges. |
Example
{
"pageInfo": PageInfo,
"edges": [TextFieldProductModifierOverridesEdge]
}
TextFieldProductModifierOverridesEdge
Description
An edge in a connection.
Fields
Field Name | Description |
---|---|
node - TextFieldProductModifierOverrides!
|
The item at the end of the edge. |
cursor - String!
|
A cursor for use in pagination. |
Example
{
"node": TextFieldProductModifierOverridesForChannelLocale,
"cursor": "abc123"
}
TextFieldProductModifierOverridesForChannelLocale
Description
Overrides for a text field product modifier in a context of channel and locale.
Fields
Field Name | Description |
---|---|
context - ChannelLocaleContext!
|
Product modifier overrides context for channel and locale. |
defaultValue - String
|
Default value override in a context of a channel and locale. |
displayName - String
|
Display name override for the product modifier in a context of a channel and locale. |
Example
{
"context": ChannelLocaleContext,
"defaultValue": "xyz789",
"displayName": "abc123"
}
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": false}
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}
UpdateDropdownProductOptionChannelLocaleOverridesDataInput
Fields
Input Field | Description |
---|---|
displayName - String
|
Localized display name of the dropdown product option in a specific channel and locale. |
values - [UpdateDropdownProductOptionValueChannelLocaleOverridesInput!]
|
List of localized dropdown product option values for a specific channel and locale. |
Example
{
"displayName": "xyz789",
"values": [
UpdateDropdownProductOptionValueChannelLocaleOverridesInput
]
}
UpdateDropdownProductOptionChannelLocaleOverridesInput
Description
Input for updating localized overrides of a dropdown product option in a specific storefront channel and locale.
Fields
Input Field | Description |
---|---|
context - ChannelLocaleContextInput!
|
The storefront channel and locale where the dropdown product option overrides apply. |
data - UpdateDropdownProductOptionChannelLocaleOverridesDataInput!
|
Example
{
"context": ChannelLocaleContextInput,
"data": UpdateDropdownProductOptionChannelLocaleOverridesDataInput
}
UpdateDropdownProductOptionInput
Description
Input for updating a dropdown product option, including its values and overrides.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the dropdown product option. |
values - [UpdateDropdownProductOptionValueInput!]
|
List of dropdown product option values. |
overrides - [UpdateDropdownProductOptionOverridesInput!]
|
Overrides for the dropdown product option in different storefront channels and locales. |
Example
{
"displayName": "abc123",
"values": [UpdateDropdownProductOptionValueInput],
"overrides": [UpdateDropdownProductOptionOverridesInput]
}
UpdateDropdownProductOptionOverridesInput
Description
Input for specifying overrides for a dropdown product option in storefront channels and locales.
Fields
Input Field | Description |
---|---|
channelLocaleOverrides - UpdateDropdownProductOptionChannelLocaleOverridesInput
|
List of channel and locale-specific overrides for the dropdown product option. |
Example
{
"channelLocaleOverrides": UpdateDropdownProductOptionChannelLocaleOverridesInput
}
UpdateDropdownProductOptionValueChannelLocaleOverridesInput
Description
Input for overriding dropdown product option values in a specific storefront channel and locale.
Example
{
"valueId": "4",
"label": "xyz789"
}
UpdateDropdownProductOptionValueInput
UpdateEventBridgeWebhookDataInput
Fields
Input Field | Description |
---|---|
destination - String
|
Amazon EventBridge source arn. |
eventFilters - [WebhookEventFilterUnionInput!]
|
Event filters for webhook. |
isActive - Boolean
|
If webhook is active or not. |
scope - String
|
The scope of the event subscription. |
Example
{
"destination": "abc123",
"eventFilters": [WebhookEventFilterUnionInput],
"isActive": true,
"scope": "abc123"
}
UpdateEventBridgeWebhookError
Description
Error object for update Amazon EventBridge webhook mutation.
Example
AlreadyExistsError
UpdateEventBridgeWebhookInput
Fields
Input Field | Description |
---|---|
id - ID!
|
The ID of an object. |
data - UpdateEventBridgeWebhookDataInput!
|
Example
{"id": 4, "data": UpdateEventBridgeWebhookDataInput}
UpdateEventBridgeWebhookResult
Description
The result of mutation.
Fields
Field Name | Description |
---|---|
webhook - EventBridgeWebhook
|
The webhook that is updated as a result of mutation. |
errors - [UpdateEventBridgeWebhookError!]!
|
The errors that occurred during the update Amazon EventBridge webhook mutation. |
Example
{
"webhook": EventBridgeWebhook,
"errors": [AlreadyExistsError]
}
UpdateHttpsWebhookDataInput
Fields
Input Field | Description |
---|---|
destination - String
|
URL must be active, return a 200 response, and be served on port 443. |
eventFilters - [WebhookEventFilterUnionInput!]
|
Event filters for webhook. |
headers - [HttpsWebhookHeaderInput!]
|
You can define any number of custom headers to be attached to the event sent to the destination URL. |
isActive - Boolean
|
If webhook is active or not. |
scope - String
|
The scope of the event subscription. |
Example
{
"destination": "xyz789",
"eventFilters": [WebhookEventFilterUnionInput],
"headers": [HttpsWebhookHeaderInput],
"isActive": true,
"scope": "xyz789"
}
UpdateHttpsWebhookError
Description
Error object for update HTTPS webhook mutation.
Example
AlreadyExistsError
UpdateHttpsWebhookInput
Fields
Input Field | Description |
---|---|
id - ID!
|
The ID of webhook to be updated. |
data - UpdateHttpsWebhookDataInput!
|
Example
{"id": 4, "data": UpdateHttpsWebhookDataInput}
UpdateHttpsWebhookResult
Description
Result of mutation.
Fields
Field Name | Description |
---|---|
webhook - HttpsWebhook
|
The Webhook that is updated as a result of mutation. |
errors - [UpdateHttpsWebhookError!]!
|
The errors that occurred during the update HTTPS webhook mutation. |
Example
{
"webhook": HttpsWebhook,
"errors": [AlreadyExistsError]
}
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"
}
UpdateMetafieldErrors
Description
Union type for all 'updateMetafield' mutation's errors.
Example
ValidationError
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. |
errors - [UpdateMetafieldErrors!]!
|
The list of errors that occurred while updating a metafield. |
Example
{
"metafield": Metafield,
"errors": [ValidationError]
}
UpdateProductCustomFieldChannelLocaleOverridesInput
Description
Input that updates the overrides for product custom fields in a storefront channel locale.
Fields
Input Field | Description |
---|---|
context - ChannelLocaleContextInput!
|
The storefront channel and locale that apply when you update overrides for product custom fields in a channel locale. |
data - UpdateProductCustomFieldsChannelLocaleDataInput!
|
Example
{
"context": ChannelLocaleContextInput,
"data": UpdateProductCustomFieldsChannelLocaleDataInput
}
UpdateProductCustomFieldOverridesInput
Description
Input that updates the overrides for product custom fields in a storefront channel locale.
Fields
Input Field | Description |
---|---|
channelLocaleOverrides - UpdateProductCustomFieldChannelLocaleOverridesInput
|
The data that applies when you update overrides for product custom fields in a storefront channel locale. |
Example
{
"channelLocaleOverrides": UpdateProductCustomFieldChannelLocaleOverridesInput
}
UpdateProductCustomFieldsChannelLocaleDataInput
Fields
Input Field | Description |
---|---|
name - String
|
Name of the product's custom field in a storefront channel locale. |
value - String
|
Value of the product's custom field in a storefront channel locale. |
isVisible - Boolean
|
Indicates whether the product custom field is visible in a storefront channel locale. |
Example
{
"name": "xyz789",
"value": "xyz789",
"isVisible": false
}
UpdateProductCustomFieldsDataInput
Description
Input that updates information for product custom fields.
Fields
Input Field | Description |
---|---|
customFieldId - ID!
|
ID of a product's custom field. |
name - String
|
Name of the product's custom field. |
value - String
|
Value of a product's custom field. |
overrides - [UpdateProductCustomFieldOverridesInput!]
|
Overrides for product custom fields in a storefront channel locale. |
Example
{
"customFieldId": 4,
"name": "abc123",
"value": "xyz789",
"overrides": [UpdateProductCustomFieldOverridesInput]
}
UpdateProductCustomFieldsInput
Fields
Input Field | Description |
---|---|
productId - ID!
|
ID of the product that has the custom fields you want to update. |
data - [UpdateProductCustomFieldsDataInput!]!
|
Example
{
"productId": 4,
"data": [UpdateProductCustomFieldsDataInput]
}
UpdateProductCustomFieldsResult
Fields
Field Name | Description |
---|---|
product - Product
|
Result of updating product custom fields. |
Example
{"product": Product}
UpdateProductOptionDataInput
Description
Input for updating product options, including different types of options.
Fields
Input Field | Description |
---|---|
dropdown - UpdateDropdownProductOptionInput
|
Dropdown option data to update. |
radioButtons - UpdateRadioButtonsProductOptionInput
|
Radio button option data to update. |
rectangleList - UpdateRectangleListProductOptionInput
|
Rectangle list option data to update. |
swatch - UpdateSwatchProductOptionInput
|
Swatch option data to update. |
Example
{
"dropdown": UpdateDropdownProductOptionInput,
"radioButtons": UpdateRadioButtonsProductOptionInput,
"rectangleList": UpdateRectangleListProductOptionInput,
"swatch": UpdateSwatchProductOptionInput
}
UpdateProductOptionInput
Description
Input for updating product option information.
Fields
Input Field | Description |
---|---|
optionId - ID!
|
ID of the product option to be updated. |
optionData - UpdateProductOptionDataInput!
|
Data associated with the product option to be updated. |
Example
{
"optionId": "4",
"optionData": UpdateProductOptionDataInput
}
UpdateProductOptionsInput
Fields
Input Field | Description |
---|---|
productId - ID!
|
ID of the product whose options are being updated. |
data - [UpdateProductOptionInput!]!
|
Example
{"productId": 4, "data": [UpdateProductOptionInput]}
UpdateProductOptionsResult
Fields
Field Name | Description |
---|---|
product - Product
|
The product for which the options were updated. |
Example
{"product": Product}
UpdateProductPropertiesBasicInformationDataInput
UpdateProductPropertiesChannelLocaleOverridesDataInput
Description
Input that updates the overrides for a product in a channel & locale.
Fields
Input Field | Description |
---|---|
basicInformation - UpdateProductPropertiesBasicInformationDataInput
|
Basic information for the product. |
seoInformation - UpdateProductPropertiesSeoInformationDataInput
|
SEO information for the product. |
storefrontDetails - UpdateProductPropertiesStorefrontDetailsDataInput
|
Storefront details for the product. |
preOrderSettings - UpdateProductPropertiesPreOrderSettingsDataInput
|
Pre Order settings for the product. |
Example
{
"basicInformation": UpdateProductPropertiesBasicInformationDataInput,
"seoInformation": UpdateProductPropertiesSeoInformationDataInput,
"storefrontDetails": UpdateProductPropertiesStorefrontDetailsDataInput,
"preOrderSettings": UpdateProductPropertiesPreOrderSettingsDataInput
}
UpdateProductPropertiesChannelLocaleOverridesInput
Description
Input that updates the overrides for a product in a channel & locale.
Fields
Input Field | Description |
---|---|
context - ChannelLocaleContextInput!
|
Channel & locale context. |
data - UpdateProductPropertiesChannelLocaleOverridesDataInput!
|
Data to update. |
Example
{
"context": ChannelLocaleContextInput,
"data": UpdateProductPropertiesChannelLocaleOverridesDataInput
}
UpdateProductPropertiesChannelOverridesDataInput
Description
Input that updates the overrides for a channel.
Fields
Input Field | Description |
---|---|
isFeatured - Boolean
|
Indicates whether the product in channel is featured. |
Example
{"isFeatured": true}
UpdateProductPropertiesChannelOverridesInput
Description
Input that updates the overrides for a channel.
Fields
Input Field | Description |
---|---|
context - ChannelContextInput!
|
Channel context. |
data - UpdateProductPropertiesChannelOverridesDataInput!
|
Example
{
"context": ChannelContextInput,
"data": UpdateProductPropertiesChannelOverridesDataInput
}
UpdateProductPropertiesDataInput
Description
Input that updates the properties for a product.
Fields
Input Field | Description |
---|---|
productId - ID!
|
Product ID. |
isFeatured - Boolean
|
Indicates whether the product is featured. |
basicInformation - UpdateProductPropertiesBasicInformationDataInput
|
Basic information for the product. |
seoInformation - UpdateProductPropertiesSeoInformationDataInput
|
SEO information for the product. |
storefrontDetails - UpdateProductPropertiesStorefrontDetailsDataInput
|
Storefront details for the product. |
preOrderSettings - UpdateProductPropertiesPreOrderSettingsDataInput
|
Pre Order Settings for the product. |
overrides - [UpdateProductPropertiesOverridesInput!]
|
List of overrides for product properties in a channel locale context. |
Example
{
"productId": 4,
"isFeatured": false,
"basicInformation": UpdateProductPropertiesBasicInformationDataInput,
"seoInformation": UpdateProductPropertiesSeoInformationDataInput,
"storefrontDetails": UpdateProductPropertiesStorefrontDetailsDataInput,
"preOrderSettings": UpdateProductPropertiesPreOrderSettingsDataInput,
"overrides": [UpdateProductPropertiesOverridesInput]
}
UpdateProductPropertiesOverridesInput
Description
Input that updates overrides for product properties in a channel locale context.
Fields
Input Field | Description |
---|---|
channelLocaleOverrides - UpdateProductPropertiesChannelLocaleOverridesInput
|
The data that applies when you update overrides for product properties in a channel locale context. |
channelOverrides - UpdateProductPropertiesChannelOverridesInput
|
The data that applies when you update overrides for product properties in a channe contextl. |
Example
{
"channelLocaleOverrides": UpdateProductPropertiesChannelLocaleOverridesInput,
"channelOverrides": UpdateProductPropertiesChannelOverridesInput
}
UpdateProductPropertiesPreOrderSettingsDataInput
Description
Pre Order Settings data input in Product property mutation group.
Fields
Input Field | Description |
---|---|
message - String
|
Product pre-order message. |
Example
{"message": "xyz789"}
UpdateProductPropertiesSeoInformationDataInput
UpdateProductPropertiesStorefrontDetailsDataInput
Description
Storefront Details data input in Product property mutation group.
Example
{
"availabilityDescription": "abc123",
"searchKeywords": "xyz789",
"warranty": "xyz789"
}
UpdateProductsPropertiesInput
Fields
Input Field | Description |
---|---|
data - [UpdateProductPropertiesDataInput!]!
|
Example
{"data": [UpdateProductPropertiesDataInput]}
UpdateProductsPropertiesResult
Fields
Field Name | Description |
---|---|
products - [Product!]
|
List of updated products. |
Example
{"products": [Product]}
UpdatePubSubWebhookDataInput
Fields
Input Field | Description |
---|---|
destination - String
|
The Google Cloud Pub/Sub topic where events will be delivered. The topic must have the BigCommerce service account principal & Pub/Sub Publish permission enabled. |
eventFilters - [WebhookEventFilterUnionInput!]
|
Event filters for webhook. |
isActive - Boolean
|
If webhook is active or not. |
scope - String
|
The scope of the event subscription. |
Example
{
"destination": "abc123",
"eventFilters": [WebhookEventFilterUnionInput],
"isActive": true,
"scope": "abc123"
}
UpdatePubSubWebhookError
Description
Error object for update Google Cloud PubSub webhook mutation.
Example
AlreadyExistsError
UpdatePubSubWebhookInput
Fields
Input Field | Description |
---|---|
id - ID!
|
The ID of webhook to update. |
data - UpdatePubSubWebhookDataInput!
|
Example
{"id": 4, "data": UpdatePubSubWebhookDataInput}
UpdatePubSubWebhookResult
Description
Result of mutation.
Fields
Field Name | Description |
---|---|
webhook - PubSubWebhook
|
The Google PubSub webhook that is updated as a result of mutation. |
errors - [UpdatePubSubWebhookError!]!
|
The errors that occurred during the update Google Pub/Sub webhook mutation. |
Example
{
"webhook": PubSubWebhook,
"errors": [AlreadyExistsError]
}
UpdateRadioButtonsProductOptionChannelLocaleOverridesDataInput
Fields
Input Field | Description |
---|---|
displayName - String
|
Localized display name of the radio button product option in a specific channel and locale. |
values - [UpdateRadioButtonsProductOptionValueChannelLocaleOverridesInput!]
|
List of localized radio button product option values for a specific channel and locale. |
Example
{
"displayName": "xyz789",
"values": [
UpdateRadioButtonsProductOptionValueChannelLocaleOverridesInput
]
}
UpdateRadioButtonsProductOptionChannelLocaleOverridesInput
Description
Input for updating localized overrides of a radio button product option in a specific storefront channel and locale.
Fields
Input Field | Description |
---|---|
context - ChannelLocaleContextInput!
|
The storefront channel and locale where the radio button product option overrides apply. |
data - UpdateRadioButtonsProductOptionChannelLocaleOverridesDataInput!
|
Example
{
"context": ChannelLocaleContextInput,
"data": UpdateRadioButtonsProductOptionChannelLocaleOverridesDataInput
}
UpdateRadioButtonsProductOptionInput
Description
Input for updating a radio button product option, including its values and overrides.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the radio button product option. |
values - [UpdateRadioButtonsProductOptionValueInput!]
|
List of radio button product option values. |
overrides - [UpdateRadioButtonsProductOptionOverridesInput!]
|
Overrides for the radio button product option in different storefront channels and locales. |
Example
{
"displayName": "xyz789",
"values": [UpdateRadioButtonsProductOptionValueInput],
"overrides": [
UpdateRadioButtonsProductOptionOverridesInput
]
}
UpdateRadioButtonsProductOptionOverridesInput
Description
Input for specifying overrides for a radio button product option in storefront channels and locales.
Fields
Input Field | Description |
---|---|
channelLocaleOverrides - UpdateRadioButtonsProductOptionChannelLocaleOverridesInput
|
List of channel and locale-specific overrides for the radio button product option. |
Example
{
"channelLocaleOverrides": UpdateRadioButtonsProductOptionChannelLocaleOverridesInput
}
UpdateRadioButtonsProductOptionValueChannelLocaleOverridesInput
Description
Input for overriding radio button product option values in a specific storefront channel and locale.
Example
{"valueId": 4, "label": "xyz789"}
UpdateRadioButtonsProductOptionValueInput
UpdateRectangleListProductOptionChannelLocaleOverridesDataInput
Fields
Input Field | Description |
---|---|
displayName - String
|
Localized display name of the rectangle list product option in a specific channel and locale. |
values - [UpdateRectangleListProductOptionValueChannelLocaleOverridesInput!]
|
List of localized rectangle list product option values for a specific channel and locale. |
Example
{
"displayName": "xyz789",
"values": [
UpdateRectangleListProductOptionValueChannelLocaleOverridesInput
]
}
UpdateRectangleListProductOptionChannelLocaleOverridesInput
Description
Input for updating localized overrides of a rectangle list product option in a specific storefront channel and locale.
Fields
Input Field | Description |
---|---|
context - ChannelLocaleContextInput!
|
The storefront channel and locale where the rectangle list product option overrides apply. |
data - UpdateRectangleListProductOptionChannelLocaleOverridesDataInput!
|
Example
{
"context": ChannelLocaleContextInput,
"data": UpdateRectangleListProductOptionChannelLocaleOverridesDataInput
}
UpdateRectangleListProductOptionInput
Description
Input for updating a rectangle list product option, including its values and overrides.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the rectangle list product option. |
values - [UpdateRectangleListProductOptionValueInput!]
|
List of rectangle list product option values. |
overrides - [UpdateRectangleListProductOptionOverridesInput!]
|
Overrides for the rectangle list product option in different storefront channels and locales. |
Example
{
"displayName": "abc123",
"values": [UpdateRectangleListProductOptionValueInput],
"overrides": [
UpdateRectangleListProductOptionOverridesInput
]
}
UpdateRectangleListProductOptionOverridesInput
Description
Input for specifying overrides for a rectangle list product option in storefront channels and locales.
Fields
Input Field | Description |
---|---|
channelLocaleOverrides - UpdateRectangleListProductOptionChannelLocaleOverridesInput
|
List of channel and locale-specific overrides for the rectangle list product option. |
Example
{
"channelLocaleOverrides": UpdateRectangleListProductOptionChannelLocaleOverridesInput
}
UpdateRectangleListProductOptionValueChannelLocaleOverridesInput
Description
Input for overriding rectangle list product option values in a specific storefront channel and locale.
Example
{
"valueId": "4",
"label": "xyz789"
}
UpdateRectangleListProductOptionValueInput
UpdateSwatchProductOptionChannelLocaleOverridesDataInput
Fields
Input Field | Description |
---|---|
displayName - String
|
Localized display name of the swatch product option in a specific channel and locale. |
values - [UpdateSwatchProductOptionValueChannelLocaleOverridesInput!]
|
List of localized swatch product option values for a specific channel and locale. |
Example
{
"displayName": "abc123",
"values": [
UpdateSwatchProductOptionValueChannelLocaleOverridesInput
]
}
UpdateSwatchProductOptionChannelLocaleOverridesInput
Description
Input for updating localized overrides of a swatch product option in a specific storefront channel and locale.
Fields
Input Field | Description |
---|---|
context - ChannelLocaleContextInput!
|
The storefront channel and locale where the swatch product option overrides apply. |
data - UpdateSwatchProductOptionChannelLocaleOverridesDataInput!
|
Example
{
"context": ChannelLocaleContextInput,
"data": UpdateSwatchProductOptionChannelLocaleOverridesDataInput
}
UpdateSwatchProductOptionInput
Description
Input for updating a swatch product option, including its values and overrides.
Fields
Input Field | Description |
---|---|
displayName - String
|
Display name for the swatch product option. |
values - [UpdateSwatchProductOptionValueInput!]
|
List of swatch product option values. |
overrides - [UpdateSwatchProductOptionOverridesInput!]
|
Overrides for the swatch product option in different storefront channels and locales. |
Example
{
"displayName": "abc123",
"values": [UpdateSwatchProductOptionValueInput],
"overrides": [UpdateSwatchProductOptionOverridesInput]
}
UpdateSwatchProductOptionOverridesInput
Description
Input for specifying overrides for a swatch product option in storefront channels and locales.
Fields
Input Field | Description |
---|---|
channelLocaleOverrides - UpdateSwatchProductOptionChannelLocaleOverridesInput
|
List of channel and locale-specific overrides for the swatch product option. |
Example
{
"channelLocaleOverrides": UpdateSwatchProductOptionChannelLocaleOverridesInput
}
UpdateSwatchProductOptionValueChannelLocaleOverridesInput
Description
Input for overriding swatch product option values in a specific storefront channel and locale.
Example
{
"valueId": "4",
"label": "abc123"
}
UpdateSwatchProductOptionValueInput
ValidationError
Description
Error indicating that the input is invalid.
Fields
Field Name | Description |
---|---|
message - String!
|
Information about error. |
Example
{"message": "xyz789"}
Webhook
Description
A webhook.
Fields
Field Name | Description |
---|---|
clientId - String!
|
ID of client application owning the webhook. |
createdAt - DateTime
|
The date and time of webhook creation. |
eventFilters - [WebhookEventFilter!]!
|
Event filters for webhook. |
id - ID!
|
The ID of a webhook object. |
scope - String!
|
The scope of the event subscription. |
status - WebhookStatus!
|
The status of a webhook. |
updatedAt - DateTime
|
The date and time of the last webhook update. |
Possible Types
Webhook Types |
---|
Example
{
"clientId": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"eventFilters": [WebhookEventFilter],
"id": 4,
"scope": "xyz789",
"status": "ACTIVE",
"updatedAt": "2007-12-03T10:15:30Z"
}
WebhookEventDataFilter
Description
Filter for webhook events based on 'data' field in payload.
Fields
Field Name | Description |
---|---|
path - [String!]!
|
Path to the field relatively to data field. Could point only on nested field. |
values - WebhookEventDataFilterValuesUnion!
|
Values of the field to filter. |
delivery - WebhookEventFilterOperationType
|
Delivery of filter: INCLUDE or EXCLUDE given clientIds. |
Example
{
"path": ["xyz789"],
"values": WebhookEventDataFilterStringValues,
"delivery": "IN"
}
WebhookEventDataFilterDoubleValues
Description
Wrapper for double values of the field to filter.
Fields
Field Name | Description |
---|---|
doubleValues - [Float!]!
|
Double values of the field to filter. |
Example
{"doubleValues": [987.65]}
WebhookEventDataFilterInput
Description
Filter for webhook events based on 'data' field in payload.
Fields
Input Field | Description |
---|---|
path - [String!]!
|
Path to the field relatively to data field. Could point only on nested field. |
values - WebhookEventDataFilterValuesInput!
|
Values of the field to filter. |
delivery - WebhookEventFilterOperationType!
|
Values of the field to filter. |
Example
{
"path": ["abc123"],
"values": WebhookEventDataFilterValuesInput,
"delivery": "IN"
}
WebhookEventDataFilterLongValues
Description
Wrapper for long (int 64) values of the field to filter.
Fields
Field Name | Description |
---|---|
longValues - [Long!]!
|
Long (int 64) values of the field to filter. |
Example
{"longValues": [{}]}
WebhookEventDataFilterStringValues
Description
Wrapper for string values of the field to filter.
Fields
Field Name | Description |
---|---|
stringValues - [String!]!
|
String values of the field to filter. |
Example
{"stringValues": ["xyz789"]}
WebhookEventDataFilterValuesInput
Description
Wrapper for all possible value wrappers. Only one of fields should be set.
Example
{
"stringValues": ["xyz789"],
"doubleValues": [123.45],
"longValues": [{}]
}
WebhookEventDataFilterValuesUnion
Description
Union type for al possible value wrappers.
Example
WebhookEventDataFilterStringValues
WebhookEventFilter
Description
Filter for events that trigger sending webhook.
Fields
Field Name | Description |
---|---|
delivery - WebhookEventFilterOperationType
|
Delivery of filter: INCLUDE or EXCLUDE given clientIds. |
Possible Types
WebhookEventFilter Types |
---|
Example
{"delivery": "IN"}
WebhookEventFilterOperationType
Description
Delivery type of a filter. INCLUDE or EXCLUDE.
Values
Enum Value | Description |
---|---|
|
Include only events matching criteria. |
|
Include events that don't matching criteria. |
Example
"IN"
WebhookEventFilterUnionInput
Description
Input for webhook's filters. Currently only clientIdFilter available.
Fields
Input Field | Description |
---|---|
dataFilter - WebhookEventDataFilterInput
|
Filter that limits webhooks to send events only for given values for given field. |
Example
{"dataFilter": WebhookEventDataFilterInput}
WebhookFiltersInput
Fields
Input Field | Description |
---|---|
channelId - ID
|
The webhook channel ID. |
destination - String
|
The destination URL or topic where the event messages will be sent. |
status - WebhookStatus
|
The status of a webhook. |
scope - String
|
The scope of the event subscription. |
Example
{
"channelId": "4",
"destination": "xyz789",
"status": "ACTIVE",
"scope": "xyz789"
}
WebhookMutations
Description
Operations that allow you to create, update, and delete webhooks on the server side.
Fields
Field Name | Description |
---|---|
createEventBridgeWebhook - CreateEventBridgeWebhookResult
|
Creates an Amazon EventBridge webhook. |
Arguments
|
|
createPubSubWebhook - CreatePubSubWebhookResult
|
Creates Google Cloud PubSub webhook. |
Arguments
|
|
createHttpsWebhook - CreateHttpsWebhookResult
|
Creates an HTTPS webhook. |
Arguments
|
|
deleteWebhook - DeleteWebhookResult
|
Deletes a webhook. |
Arguments
|
|
updatePubSubWebhook - UpdatePubSubWebhookResult
|
Update a Google Cloud PubSub webhook. |
Arguments
|
|
updateEventBridgeWebhook - UpdateEventBridgeWebhookResult
|
Update an Amazon EventBridge webhook. |
Arguments
|
|
updateHttpsWebhook - UpdateHttpsWebhookResult
|
Update an https webhook. |
Arguments
|
Example
{
"createEventBridgeWebhook": CreateEventBridgeWebhookResult,
"createPubSubWebhook": CreatePubSubWebhookResult,
"createHttpsWebhook": CreateHttpsWebhookResult,
"deleteWebhook": DeleteWebhookResult,
"updatePubSubWebhook": UpdatePubSubWebhookResult,
"updateEventBridgeWebhook": UpdateEventBridgeWebhookResult,
"updateHttpsWebhook": UpdateHttpsWebhookResult
}
WebhookStatus
Description
Status of a webhook.
Values
Enum Value | Description |
---|---|
|
Webhook is active. |
|
Webhook is disabled. |
|
Webhook is inactive. |
Example
"ACTIVE"
WebhooksConnection
Description
A connection to a list of items.
Fields
Field Name | Description |
---|---|
pageInfo - PageInfo!
|
Information to aid in pagination. |
edges - [WebhooksEdge]
|
A list of edges with webhooks. |
Example
{
"pageInfo": PageInfo,
"edges": [WebhooksEdge]
}
WebhooksEdge
WebhooksSettings
Description
Webhooks store settings.
Fields
Field Name | Description |
---|---|
gcpDeliveryAccount - String!
|
Url of GCP account. |
Example
{"gcpDeliveryAccount": "xyz789"}