Objects
Objects represent the resources you can access.
AttributeAddMetadataPayload
A payload for a mutation.
Fields:
attribute | Changed |
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 |
AttributeCreateFilePayload
A payload for a mutation.
Fields:
attribute | Created |
AttributeCreateGalleryPayload
A payload for a mutation.
Fields:
attribute | Created |
AttributeCreateImagePayload
A payload for a mutation.
Fields:
attribute | Created |
AttributeCreateMultiSelectPayload
A payload for a mutation.
Fields:
attribute | Created |
AttributeCreateNumericPayload
A payload for a mutation.
Fields:
attribute | Created |
AttributeCreatePricePayload
A payload for a mutation.
Fields:
attribute | Created |
AttributeCreateProductRelationPayload
A payload for a mutation.
Fields:
attribute | Created |
AttributeCreateSelectPayload
A payload for a mutation.
Fields:
attribute | Created |
AttributeCreateTextareaPayload
A payload for a mutation.
Fields:
attribute | Created |
AttributeCreateTextPayload
A payload for a mutation.
Fields:
attribute | Created |
AttributeCreateUnitPayload
A payload for a mutation.
Fields:
attribute | Created |
AttributeDateSetFormatPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeDeleteMetadataPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeDeletePayload
A payload for a mutation.
Fields:
code | Deleted |
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 |
AttributeMultiSelectDeleteOptionPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeMultiSelectSetOptionNamePayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeMultiSelectSetOptionsPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeOptionAddCustomFieldImagePayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeOptionAddCustomFieldTextareaPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeOptionAddCustomFieldTextareaRTEPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeOptionAddCustomFieldTextPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeOptionAddOptionCustomFieldValueTranslationsImagePayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeOptionAddOptionCustomFieldValueTranslationsTextareaPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeOptionAddOptionCustomFieldValueTranslationsTextareaRTEPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeOptionAddOptionCustomFieldValueTranslationsTextPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeOptionDeleteCustomFieldPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeOptionDeleteOptionCustomFieldValueTranslationsPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributePriceSetCurrencyPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeSelectAddOptionPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeSelectDeleteOptionPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeSelectSetOptionNamePayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeSelectSetOptionsPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeSetNamePayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeTextareaSetRichEditPayload
A payload for a mutation.
Fields:
attribute | Changed |
AttributeUnitSetUnitPayload
A payload for a mutation.
Fields:
attribute | Changed |
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 | |
name (languages: [Language!]) | Translatable name allowing to set different values in every active language. | |
attributeList (after: String, first: Int, codes: [AttributeCode!]) | A list of attribute values.
|
CategoryAddAttributeValueTranslationsDatePayload
A payload for a mutation.
Fields:
category | Changed |
CategoryAddAttributeValueTranslationsFilePayload
A payload for a mutation.
Fields:
category | Changed |
CategoryAddAttributeValueTranslationsGalleryPayload
A payload for a mutation.
Fields:
category | Changed |
CategoryAddAttributeValueTranslationsImagePayload
A payload for a mutation.
Fields:
category | Changed |
CategoryAddAttributeValueTranslationsMultiSelectPayload
A payload for a mutation.
Fields:
category | Changed |
CategoryAddAttributeValueTranslationsNumericPayload
A payload for a mutation.
Fields:
category | Changed |
CategoryAddAttributeValueTranslationsPricePayload
A payload for a mutation.
Fields:
category | Changed |
CategoryAddAttributeValueTranslationsProductRelationPayload
A payload for a mutation.
Fields:
category | Changed |
CategoryAddAttributeValueTranslationsSelectPayload
A payload for a mutation.
Fields:
category | Changed |
CategoryAddAttributeValueTranslationsTextareaPayload
A payload for a mutation.
Fields:
category | Changed |
CategoryAddAttributeValueTranslationsTextPayload
A payload for a mutation.
Fields:
category | Changed |
CategoryAddAttributeValueTranslationsUnitPayload
A payload for a mutation.
Fields:
category | Changed |
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:
CategoryCreatePayload
A payload for a mutation.
Fields:
category | Created |
CategoryDeleteAttributeValueTranslationsPayload
A payload for a mutation.
Fields:
category | Changed |
CategoryDeletePayload
A payload for a mutation.
Fields:
code | Deleted |
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 |
CategoryTree
Represent a tree of categories.
Fields:
code | Readable id of | |
name (languages: [Language!]) | Translatable name allowing to set different values in every active language. | |
A list of categories belonging to the |
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
The connection for CategoryTreeCode
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:
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 | |
translations (languages: [Language!]) | A value translations. |
DateAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value | A translation value of an |
FileAttribute
Represents a collection of multimedia files of any type.
Implements:
FileAttributeValue
An attribute value.
Implements:
Fields:
attribute | An | |
translations (languages: [Language!]) | A value translations. |
FileAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value | A translation value of an |
GalleryAttribute
Represents a collection of images.
Implements:
GalleryAttributeValue
An attribute value.
Implements:
Fields:
attribute | An | |
translations (languages: [Language!]) | A value translations. |
GalleryAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value | A translation value of an |
GroupedProduct
Represents a product grouped in GroupingProduct with a specific quantity for the set.
Fields:
quantity | Quantity of a grouped | |
product | Grouped |
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.
|
ImageAttribute
Represents an image.
Implements:
ImageAttributeValue
An attribute value.
Implements:
Fields:
attribute | An | |
translations (languages: [Language!]) | A value translations. |
ImageAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value | A translation value of an |
ImageCustomField
Represents an image.
Implements:
ImageCustomFieldTranslatedValue
Represents an image translated value.
Implements:
Fields:
customField | A | |
value | A value in the context language. |
ImageCustomFieldValue
A custom field value.
Implements:
Fields:
customField | A | |
translations (languages: [Language!]) | A value translations. |
ImageCustomFieldValueTranslation
Translation of a custom field value.
Implements:
Fields:
value | A translation value of a |
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:
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 | |
name | Given file name. | |
extension | File extension. | |
mime | Mime type of the file. | |
size | File size in bytes. | |
alt (languages: [Language!]) | Represents the alternate text for an image if it cannot be displayed. | |
title (languages: [Language!]) | 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 |
MultimediaDeletePayload
A payload for a mutation.
Fields:
path | Deleted |
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 | |
name | Name of |
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 |
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 |
MultimediaReplacePayload
A payload for a mutation.
Fields:
multimedia | Replacing |
MultimediaSetAltPayload
A payload for a mutation.
Fields:
multimedia | Changed |
MultimediaSetFolderPayload
A payload for a mutation.
Fields:
multimedia | Changed |
MultimediaSetNamePayload
A payload for a mutation.
Fields:
multimedia | Changed |
MultimediaSetTitlePayload
A payload for a mutation.
Fields:
multimedia | Changed |
MultiSelectAttribute
Represents a set of options allowing multiple choices.
Implements:
MultiSelectAttributeValue
An attribute value.
Implements:
Fields:
attribute | An | |
translations (languages: [Language!]) | 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 |
NumericAttribute
Represents a number.
Implements:
NumberAttributeValue
An attribute value.
Implements:
Fields:
attribute | An | |
translations (languages: [Language!]) | A value translations. |
NumericAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value | A translation value of an |
Option
Represents an option of a select and multi-select attribute.
Fields:
code | Readable id of | |
name (languages: [Language!]) | Translatable name allowing to set different values in every active language. | |
customFields |
|
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:
Represents an option of a select and multi-select attribute.
Fields:
code | Readable id of | |
name (languages: [Language!]) | 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 | |
name |
|
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 | |
translations (languages: [Language!]) | A value translations. |
PriceAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value | A translation value of an |
ProductAddAttributeValueTranslationsDatePayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddAttributeValueTranslationsFilePayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddAttributeValueTranslationsGalleryPayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddAttributeValueTranslationsImagePayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddAttributeValueTranslationsMultiSelectPayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddAttributeValueTranslationsNumericPayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddAttributeValueTranslationsPricePayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddAttributeValueTranslationsProductRelationPayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddAttributeValueTranslationsSelectPayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddAttributeValueTranslationsTextareaPayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddAttributeValueTranslationsTextPayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddAttributeValueTranslationsUnitPayload
A payload for a mutation.
Fields:
product | Changed |
ProductAddCategoriesPayload
A payload for a mutation.
Fields:
product | Changed |
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 |
ProductCreateSimplePayload
A payload for a mutation.
Fields:
product | Created |
ProductCreateVariablePayload
A payload for a mutation.
Fields:
product | Created |
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 |
ProductDeletedEdge
An edge in a connection.
Fields:
ProductDeletePayload
A payload for a mutation.
Fields:
sku | Deleted |
ProductEdge
An edge in a connection.
Fields:
ProductGroupingAddChildPayload
A payload for a mutation.
Fields:
product | Changed |
ProductGroupingRemoveChildPayload
A payload for a mutation.
Fields:
product | Changed |
ProductGroupingSetChildQuantityPayload
A payload for a mutation.
Fields:
product | Changed |
ProductRelationAttribute
Represents a relation to the collection of products.
Implements:
ProductRelationAttributeValue
An attribute value.
Implements:
Fields:
attribute | An | |
translations (languages: [Language!]) | A value translations. |
ProductRelationAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value | A translation value of an |
ProductRemoveCategoriesPayload
A payload for a mutation.
Fields:
product | Changed |
ProductSetTemplatePayload
A payload for a mutation.
Fields:
product | Changed |
ProductVariableAddVariantPayload
A payload for a mutation.
Fields:
product | Changed |
ProductVariableRemoveVariantPayload
A payload for a mutation.
Fields:
product | Changed |
ProductVariableSetBindingsPayload
A payload for a mutation.
Fields:
product | Changed |
Section
Represents a set of common attributes - technical data, SEO-related parameters, etc.
Fields:
code | Readable id of | |
A list of attributes used in the |
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:
SelectAttribute
Represents a set of options allowing single choice.
Implements:
SelectAttributeValue
An attribute value.
Implements:
Fields:
attribute | An | |
translations (languages: [Language!]) | 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 |
SimpleProduct
A simple product.
Implements:
Template
Represents a set of attributes specific to a market segment.
Fields:
code | Readable id of | |
A list of attributes used in the | ||
A list of sections used in the |
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:
TextareaAttribute
Represents a text.
Implements:
Fields:
richEdit | Is rich text editor enabled. |
TextareaAttributeValue
An attribute value.
Implements:
Fields:
attribute | An | |
translations (languages: [Language!]) | A value translations. |
TextareaAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value | A translation value of an | |
rawValue | Represents raw textarea value translation with attribute variables unresolved in form of |
TextareaCustomField
Represents a text.
Implements:
TextareaCustomFieldTranslatedValue
Represents a text translated value.
Implements:
Fields:
customField | A | |
value | A value in the context language. |
TextareaCustomFieldValue
A custom field value.
Implements:
Fields:
customField | A | |
translations (languages: [Language!]) | A value translations. |
TextareaCustomFieldValueTranslation
Translation of a custom field value.
Implements:
Fields:
value | A translation value of a |
TextareaRTECustomField
Represents a text with RTE enabled.
Implements:
TextareaRTECustomFieldTranslatedValue
Represents a text with RTE translated value.
Implements:
Fields:
customField | A | |
value | A value in the context language. |
TextareaRTECustomFieldValue
A custom field value.
Implements:
Fields:
customField | A | |
translations (languages: [Language!]) | A value translations. |
TextareaRTECustomFieldValueTranslation
Translation of a custom field value.
Implements:
Fields:
value | A translation value of a |
TextAttribute
Represents a short text of up to 255 chars.
Implements:
TextAttributeValue
An attribute value.
Implements:
Fields:
attribute | An | |
translations (languages: [Language!]) | A value translations. |
TextAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value | A translation value of an |
TextCustomField
Represents a short text of up to 255 chars.
Implements:
TextCustomFieldTranslatedValue
Represents a text translated value.
Implements:
Fields:
customField | A | |
value | A value in the context language. |
TextCustomFieldValue
A custom field value.
Implements:
Fields:
customField | A | |
translations (languages: [Language!]) | A value translations. |
TextCustomFieldValueTranslation
Translation of a custom field value.
Implements:
Fields:
value | A translation value of a |
TranslatedString
Represents a translated value.
Fields:
Unit
Represents a unit. Can be used to define specific scalar types like a Meter.
Fields:
UnitAttribute
Represents a numeric scalar unit.
Implements:
Fields:
unit | Unit of |
UnitAttributeValue
An attribute value.
Implements:
Fields:
attribute | An | |
translations (languages: [Language!]) | A value translations. |
UnitAttributeValueTranslation
Translation of an attribute value.
Implements:
Fields:
value | A translation value of an |
VariableProduct
A product representing multiple variants i.e. products of different sizes or colors.
Fields:
bindings | A list of attributes by which variants are bonded. | |
A list of variants in |
Last updated