Objects
Objects represent the resources you can access.
AttributeAddMetadataPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeConnection
The connection for Attribute
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
AttributeEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
AttributeCreateDatePayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeCreateFilePayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeCreateGalleryPayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeCreateImagePayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeCreateMultiSelectPayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeCreateNumericPayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeCreatePricePayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeCreateProductRelationPayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeCreateSelectPayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeCreateTextareaPayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeCreateTextPayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeCreateUnitPayload
A payload for a mutation.
Fields:
attribute
Created Attribute.
AttributeDateSetFormatPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeDeleteMetadataPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeDeletePayload
A payload for a mutation.
Fields:
code
Deleted AttributeCode.
AttributeDeletedConnection
The connection for AttributeCode
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
AttributeDeletedEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
AttributeMultiSelectAddOptionPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeMultiSelectDeleteOptionPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeMultiSelectSetOptionNamePayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeMultiSelectSetOptionsPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeOptionAddCustomFieldImagePayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeOptionAddCustomFieldTextareaPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeOptionAddCustomFieldTextareaRTEPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeOptionAddCustomFieldTextPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeOptionAddOptionCustomFieldValueTranslationsImagePayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeOptionAddOptionCustomFieldValueTranslationsTextareaPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeOptionAddOptionCustomFieldValueTranslationsTextareaRTEPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeOptionAddOptionCustomFieldValueTranslationsTextPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeOptionDeleteCustomFieldPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeOptionDeleteOptionCustomFieldValueTranslationsPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributePriceSetCurrencyPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeSelectAddOptionPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeSelectDeleteOptionPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeSelectSetOptionNamePayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeSelectSetOptionsPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeSetNamePayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeTextareaSetRichEditPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeUnitSetUnitPayload
A payload for a mutation.
Fields:
attribute
Changed Attribute.
AttributeValueConnection
The connection for AttributeValue
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
AttributeValueEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
Category
Represents a category.
Fields:
code
Readable id of Category.
Translatable name allowing to set different values in every active language.
A list of attribute values.
first argument cannot be lesser than 0 and its default value is 50.
CategoryAddAttributeValueTranslationsDatePayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAddAttributeValueTranslationsFilePayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAddAttributeValueTranslationsGalleryPayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAddAttributeValueTranslationsImagePayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAddAttributeValueTranslationsMultiSelectPayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAddAttributeValueTranslationsNumericPayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAddAttributeValueTranslationsPricePayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAddAttributeValueTranslationsProductRelationPayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAddAttributeValueTranslationsSelectPayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAddAttributeValueTranslationsTextareaPayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAddAttributeValueTranslationsTextPayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAddAttributeValueTranslationsUnitPayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryAttributeAddAttributePayload
A payload for a mutation.
Fields:
categoryAttributeList
Updated list of attributes.
CategoryAttributeRemoveAttributePayload
A payload for a mutation.
Fields:
categoryAttributeList
Updated list of attributes.
CategoryConnection
The connection for Category
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
CategoryEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
CategoryCreatePayload
A payload for a mutation.
Fields:
category
Created Category.
CategoryDeleteAttributeValueTranslationsPayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryDeletePayload
A payload for a mutation.
Fields:
code
Deleted CategoryCode.
CategoryDeletedConnection
The connection for CategoryCode
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
CategoryDeletedEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
CategorySetNamePayload
A payload for a mutation.
Fields:
category
Changed Category.
CategoryTree
Represent a tree of categories.
Fields:
code
Readable id of CategoryTree.
Translatable name allowing to set different values in every active language.
A list of categories belonging to the CategoryTree.
first argument cannot be lesser than 0, higher than 1000 and its default value is 50.
CategoryTreeConnection
The connection for CategoryTree
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
CategoryTreeDeletedConnection
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
CategoryTreeDeletedEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
CategoryTreeEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
CategoryTreeLeaf
Represents a leaf (node) of a category tree.
Fields:
category
A leaf of the tree.
parentCategory
Parent leaf of to leaf.
CategoryTreeLeafConnection
The connection for CategoryTreeLeaf
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
CategoryTreeLeafEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
DateAttribute
Represents a date.
Implements:
Fields:
format
Represented date format.
DateAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value.
A value translations.
DateAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value
A translation value of an Attribute.
FileAttribute
Represents a collection of multimedia files of any type.
Implements:
FileAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value.
A value translations.
FileAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value
A translation value of an Attribute.
GalleryAttribute
Represents a collection of images.
Implements:
GalleryAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value.
A value translations.
GalleryAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value
A translation value of an Attribute.
GroupedProduct
Represents a product grouped in GroupingProduct with a specific quantity for the set.
Fields:
quantity
Quantity of a grouped Product.
product
Grouped Product.
GroupedProductConnection
The connection for GroupedProduct
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
GroupedProductEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
GroupingProduct
A product grouping other products. Can represent products like the ones with common features or promotional packages.
Implements:
Fields:
A list of children.
first argument cannot be lesser than 0 and its default value is 50.
ImageAttribute
Represents an image.
Implements:
ImageAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value.
A value translations.
ImageAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value
A translation value of an Attribute.
ImageCustomField
Represents an image.
Implements:
ImageCustomFieldTranslatedValue
Represents an image translated value.
Implements:
Fields:
customField
A CustomField describing the value.
value
A value in the context language.
ImageCustomFieldValue
A custom field value.
Implements:
Fields:
customField
A CustomField describing the value.
A value translations.
ImageCustomFieldValueTranslation
Translation of a custom field value.
Implements:
Fields:
value
A translation value of a CustomField.
LanguageConnection
The connection for Language
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
LanguageEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
Metadatum
Represents a metadatum of an attribute.
Fields:
key
A key of metadatum.
value
Metadata value.
Multimedia
Represents a multimedia file. The multimedia can be a text file, image, document file, etc.
Fields:
path
Readable id of Multimedia.
name
Given file name.
extension
File extension.
mime
Mime type of the file.
size
File size in bytes.
Represents the alternate text for an image if it cannot be displayed.
Represents the title tooltip value.
url
URL to download binary multimedia file.
folder
Folder where multimedia is stored.
MultimediaConnection
The connection for Multimedia
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
MultimediaCreatePayload
A payload for a mutation.
Fields:
multimedia
Created Multimedia.
MultimediaDeletePayload
A payload for a mutation.
Fields:
path
Deleted MultimediaPath.
MultimediaEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
MultimediaFolder
Represents a filesystem-like folder allowing to organize multimedia. Does not correspond to the physical file path or its URL.
Fields:
path
Readable id of MultimediaFolder.
name
Name of MultimediaFolder.
MultimediaFolderConnection
The connection for MultimediaFolder
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
MultimediaFolderCreatePayload
A payload for a mutation.
Fields:
multimediaFolder
Changed MultimediaFolder.
MultimediaFolderDeletePayload
A payload for a mutation.
Fields:
path
Deleted MultimediaFolderPath.
MultimediaFolderEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
MultimediaMovePayload
A payload for a mutation.
Fields:
multimedia
Changed Multimedia.
MultimediaReplacePayload
A payload for a mutation.
Fields:
multimedia
Replacing Multimedia.
MultimediaSetAltPayload
A payload for a mutation.
Fields:
multimedia
Changed Multimedia.
MultimediaSetFolderPayload
A payload for a mutation.
Fields:
multimedia
Changed Multimedia.
MultimediaSetNamePayload
A payload for a mutation.
Fields:
multimedia
Changed Multimedia.
MultimediaSetTitlePayload
A payload for a mutation.
Fields:
multimedia
Changed Multimedia.
MultiSelectAttribute
Represents a set of options allowing multiple choices.
Implements:
MultiSelectAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value/
A value translations.
MultiSelectAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
translatedValue
Represents simplified translated value containing scalar names in context language only.
value
A translation value of an Attribute.
NumericAttribute
Represents a number.
Implements:
NumberAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value.
A value translations.
NumericAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value
A translation value of an Attribute.
Option
Represents an option of a select and multi-select attribute.
Fields:
code
Readable id of Option.
Translatable name allowing to set different values in every active language.
customFields
CustomField values.
OptionConnection
The connection for Option
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
OptionEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
Represents an option of a select and multi-select attribute.
Fields:
code
Readable id of Option.
Translatable name allowing to set different values in every active language.
OptionTranslatedValue
Simple representation of an Option of select and multi-select attributes with the name in a specific language only.
Fields:
code
Code of Option.
name
Option name in the context language.
PageInfo
Information about pagination in a connection.
Fields:
startCursor
When paginating backwards, the cursor to continue.
endCursor
When paginating forwards, the cursor to continue.
hasPreviousPage
When paginating backwards, are there more items?
hasNextPage
When paginating forwards, are there more items?
PriceAttribute
Represents a positive price of a specific currency.
Implements:
Fields:
currency
The currency price is in.
PriceAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value.
A value translations.
PriceAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value
A translation value of an Attribute.
ProductAddAttributeValueTranslationsDatePayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddAttributeValueTranslationsFilePayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddAttributeValueTranslationsGalleryPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddAttributeValueTranslationsImagePayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddAttributeValueTranslationsMultiSelectPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddAttributeValueTranslationsNumericPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddAttributeValueTranslationsPricePayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddAttributeValueTranslationsProductRelationPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddAttributeValueTranslationsSelectPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddAttributeValueTranslationsTextareaPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddAttributeValueTranslationsTextPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddAttributeValueTranslationsUnitPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductAddCategoriesPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductConnection
The connection for Product
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
ProductCreateGroupingPayload
A payload for a mutation.
Fields:
product
Created Product.
ProductCreateSimplePayload
A payload for a mutation.
Fields:
product
Created Product.
ProductCreateVariablePayload
A payload for a mutation.
Fields:
product
Created Product.
ProductDeletedConnection
The connection for Sku
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
ProductDeleteAttributeValueTranslationsPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductDeletedEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
ProductDeletePayload
A payload for a mutation.
Fields:
sku
Deleted Sku.
ProductEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
ProductGroupingAddChildPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductGroupingRemoveChildPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductGroupingSetChildQuantityPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductRelationAttribute
Represents a relation to the collection of products.
Implements:
ProductRelationAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value.
A value translations.
ProductRelationAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value
A translation value of an Attribute.
ProductRemoveCategoriesPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductSetStatusPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductSetTemplatePayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductStatus
A product status.
Fields:
code
Readable id of ProductStatus.
translatedName
Represents translated name in the context language.
ProductStatusTranslation
A product status translation.
Fields:
language
Language of status.
value
Status value.
ProductVariableAddVariantPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductVariableRemoveVariantPayload
A payload for a mutation.
Fields:
product
Changed Product.
ProductVariableSetBindingsPayload
A payload for a mutation.
Fields:
product
Changed Product.
Section
Represents a set of common attributes - technical data, SEO-related parameters, etc.
Fields:
code
Readable id of Section.
A list of attributes used in the Section.
first argument cannot be lesser than 0 and its default value is 50.
SectionConnection
The connection for Section
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
SectionEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
SelectAttribute
Represents a set of options allowing single choice.
Implements:
SelectAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value.
A value translations.
SelectAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
translatedValue
Represents simplified translated value containing scalar names in context language only.
value
A translation value of an Attribute.
SimpleProduct
A simple product.
Implements:
Template
Represents a set of attributes specific to a market segment.
Fields:
code
Readable id of Template.
A list of attributes used in the Template.
first argument cannot be lesser than 0 and its default value is 50.
A list of sections used in the Template.
first argument cannot be lesser than 0 and its default value is 50.
TemplateConnection
The connection for Template
Fields:
edges
Edges of the connection.
pageInfo
Page info of the connection.
totalCount
Count of all edges in connection.
TemplateEdge
An edge in a connection.
Fields:
node
Node of the Edge.
cursor
The Edge cursor.
TextareaAttribute
Represents a text.
Implements:
Fields:
richEdit
Is rich text editor enabled.
TextareaAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value.
A value translations.
TextareaAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value
A translation value of an Attribute.
rawValue
Represents raw textarea value translation with attribute variables unresolved in form of {{#attribute_code}}.
TextareaCustomField
Represents a text.
Implements:
TextareaCustomFieldTranslatedValue
Represents a text translated value.
Implements:
Fields:
customField
A CustomField describing the value.
value
A value in the context language.
TextareaCustomFieldValue
A custom field value.
Implements:
Fields:
customField
A CustomField describing the value.
A value translations.
TextareaCustomFieldValueTranslation
Translation of a custom field value.
Implements:
Fields:
value
A translation value of a CustomField.
TextareaRTECustomField
Represents a text with RTE enabled.
Implements:
TextareaRTECustomFieldTranslatedValue
Represents a text with RTE translated value.
Implements:
Fields:
customField
A CustomField describing the value.
value
A value in the context language.
TextareaRTECustomFieldValue
A custom field value.
Implements:
Fields:
customField
A CustomField describing the value.
A value translations.
TextareaRTECustomFieldValueTranslation
Translation of a custom field value.
Implements:
Fields:
value
A translation value of a CustomField.
TextAttribute
Represents a short text of up to 255 chars.
Implements:
TextAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value.
A value translations.
TextAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value
A translation value of an Attribute.
TextCustomField
Represents a short text of up to 255 chars.
Implements:
TextCustomFieldTranslatedValue
Represents a text translated value.
Implements:
Fields:
customField
A CustomField describing the value.
value
A value in the context language.
TextCustomFieldValue
A custom field value.
Implements:
Fields:
customField
A CustomField describing the value.
A value translations.
TextCustomFieldValueTranslation
Translation of a custom field value.
Implements:
Fields:
value
A translation value of a CustomField.
TranslatedString
Represents a translated value.
Fields:
value
Tranlated value.
language
Language of translation.
Unit
Represents a unit. Can be used to define specific scalar types like a Meter.
Fields:
name
Name o Unit.
symbol
Symbol of Unit.
UnitAttribute
Represents a numeric scalar unit.
Implements:
Fields:
unit
Unit of Attribute.
UnitAttributeValue
An attribute value.
Implements:
Fields:
attribute
An Attribute describing the value.
A value translations.
UnitAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value
A translation value of an