Objects

Objects represent the resources you can access.

AttributeAddMetadataPayload

A payload for a mutation.

Fields:

AttributeConnection

The connection for Attribute

Fields:

AttributeEdge

An edge in a connection.

Fields:

AttributeCreateDatePayload

A payload for a mutation.

Fields:

AttributeCreateFilePayload

A payload for a mutation.

Fields:

AttributeCreateGalleryPayload

A payload for a mutation.

Fields:

AttributeCreateImagePayload

A payload for a mutation.

Fields:

AttributeCreateMultiSelectPayload

A payload for a mutation.

Fields:

AttributeCreateNumericPayload

A payload for a mutation.

Fields:

AttributeCreatePricePayload

A payload for a mutation.

Fields:

AttributeCreateProductRelationPayload

A payload for a mutation.

Fields:

AttributeCreateSelectPayload

A payload for a mutation.

Fields:

AttributeCreateTextareaPayload

A payload for a mutation.

Fields:

AttributeCreateTextPayload

A payload for a mutation.

Fields:

AttributeCreateUnitPayload

A payload for a mutation.

Fields:

AttributeDateSetFormatPayload

A payload for a mutation.

Fields:

AttributeDeleteMetadataPayload

A payload for a mutation.

Fields:

AttributeDeletePayload

A payload for a mutation.

Fields:

AttributeDeletedConnection

The connection for AttributeCode

Fields:

AttributeDeletedEdge

An edge in a connection.

Fields:

AttributeMultiSelectAddOptionPayload

A payload for a mutation.

Fields:

AttributeMultiSelectDeleteOptionPayload

A payload for a mutation.

Fields:

AttributeMultiSelectSetOptionNamePayload

A payload for a mutation.

Fields:

AttributeMultiSelectSetOptionsPayload

A payload for a mutation.

Fields:

AttributeOptionAddCustomFieldImagePayload

A payload for a mutation.

Fields:

AttributeOptionAddCustomFieldTextareaPayload

A payload for a mutation.

Fields:

AttributeOptionAddCustomFieldTextareaRTEPayload

A payload for a mutation.

Fields:

AttributeOptionAddCustomFieldTextPayload

A payload for a mutation.

Fields:

AttributeOptionAddOptionCustomFieldValueTranslationsImagePayload

A payload for a mutation.

Fields:

AttributeOptionAddOptionCustomFieldValueTranslationsTextareaPayload

A payload for a mutation.

Fields:

AttributeOptionAddOptionCustomFieldValueTranslationsTextareaRTEPayload

A payload for a mutation.

Fields:

AttributeOptionAddOptionCustomFieldValueTranslationsTextPayload

A payload for a mutation.

Fields:

AttributeOptionDeleteCustomFieldPayload

A payload for a mutation.

Fields:

AttributeOptionDeleteOptionCustomFieldValueTranslationsPayload

A payload for a mutation.

Fields:

AttributePriceSetCurrencyPayload

A payload for a mutation.

Fields:

AttributeSelectAddOptionPayload

A payload for a mutation.

Fields:

AttributeSelectDeleteOptionPayload

A payload for a mutation.

Fields:

AttributeSelectSetOptionNamePayload

A payload for a mutation.

Fields:

AttributeSelectSetOptionsPayload

A payload for a mutation.

Fields:

AttributeSetNamePayload

A payload for a mutation.

Fields:

AttributeTextareaSetRichEditPayload

A payload for a mutation.

Fields:

AttributeUnitSetUnitPayload

A payload for a mutation.

Fields:

AttributeValueConnection

The connection for AttributeValue

Fields:

AttributeValueEdge

An edge in a connection.

Fields:

Category

Represents a category.

Fields:

CategoryAddAttributeValueTranslationsDatePayload

A payload for a mutation.

Fields:

CategoryAddAttributeValueTranslationsFilePayload

A payload for a mutation.

Fields:

CategoryAddAttributeValueTranslationsGalleryPayload

A payload for a mutation.

Fields:

CategoryAddAttributeValueTranslationsImagePayload

A payload for a mutation.

Fields:

CategoryAddAttributeValueTranslationsMultiSelectPayload

A payload for a mutation.

Fields:

CategoryAddAttributeValueTranslationsNumericPayload

A payload for a mutation.

Fields:

CategoryAddAttributeValueTranslationsPricePayload

A payload for a mutation.

Fields:

CategoryAddAttributeValueTranslationsProductRelationPayload

A payload for a mutation.

Fields:

CategoryAddAttributeValueTranslationsSelectPayload

A payload for a mutation.

Fields:

CategoryAddAttributeValueTranslationsTextareaPayload

A payload for a mutation.

Fields:

CategoryAddAttributeValueTranslationsTextPayload

A payload for a mutation.

Fields:

CategoryAddAttributeValueTranslationsUnitPayload

A payload for a mutation.

Fields:

CategoryAttributeAddAttributePayload

A payload for a mutation.

Fields:

CategoryAttributeRemoveAttributePayload

A payload for a mutation.

Fields:

CategoryConnection

The connection for Category

Fields:

CategoryEdge

An edge in a connection.

Fields:

CategoryCreatePayload

A payload for a mutation.

Fields:

CategoryDeleteAttributeValueTranslationsPayload

A payload for a mutation.

Fields:

CategoryDeletePayload

A payload for a mutation.

Fields:

CategoryDeletedConnection

The connection for CategoryCode

Fields:

CategoryDeletedEdge

An edge in a connection.

Fields:

CategorySetNamePayload

A payload for a mutation.

Fields:

CategoryTree

Represent a tree of categories.

Fields:

CategoryTreeConnection

The connection for CategoryTree

Fields:

CategoryTreeDeletedConnection

Fields:

CategoryTreeDeletedEdge

An edge in a connection.

Fields:

CategoryTreeEdge

An edge in a connection.

Fields:

CategoryTreeLeaf

Represents a leaf (node) of a category tree.

Fields:

CategoryTreeLeafConnection

The connection for CategoryTreeLeaf

Fields:

CategoryTreeLeafEdge

An edge in a connection.

Fields:

DateAttribute

Represents a date.

Implements:

Fields:

DateAttributeValue

An attribute value.

Implements:

Fields:

DateAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

FileAttribute

Represents a collection of multimedia files of any type.

Implements:

FileAttributeValue

An attribute value.

Implements:

Fields:

FileAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

GalleryAttribute

Represents a collection of images.

Implements:

GalleryAttributeValue

An attribute value.

Implements:

Fields:

GalleryAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

GroupedProduct

Represents a product grouped in GroupingProduct with a specific quantity for the set.

Fields:

GroupedProductConnection

The connection for GroupedProduct

Fields:

GroupedProductEdge

An edge in a connection.

Fields:

GroupingProduct

A product grouping other products. Can represent products like the ones with common features or promotional packages.

Implements:

Fields:

ImageAttribute

Represents an image.

Implements:

ImageAttributeValue

An attribute value.

Implements:

Fields:

ImageAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

ImageCustomField

Represents an image.

Implements:

ImageCustomFieldTranslatedValue

Represents an image translated value.

Implements:

Fields:

ImageCustomFieldValue

A custom field value.

Implements:

Fields:

ImageCustomFieldValueTranslation

Translation of a custom field value.

Implements:

Fields:

LanguageConnection

The connection for Language

Fields:

LanguageEdge

An edge in a connection.

Fields:

Metadatum

Represents a metadatum of an attribute.

Fields:

Multimedia

Represents a multimedia file. The multimedia can be a text file, image, document file, etc.

Fields:

MultimediaConnection

The connection for Multimedia

Fields:

MultimediaCreatePayload

A payload for a mutation.

Fields:

MultimediaDeletePayload

A payload for a mutation.

Fields:

MultimediaEdge

An edge in a connection.

Fields:

MultimediaFolder

Represents a filesystem-like folder allowing to organize multimedia. Does not correspond to the physical file path or its URL.

Fields:

MultimediaFolderConnection

The connection for MultimediaFolder

Fields:

MultimediaFolderCreatePayload

A payload for a mutation.

Fields:

MultimediaFolderDeletePayload

A payload for a mutation.

Fields:

MultimediaFolderEdge

An edge in a connection.

Fields:

MultimediaMovePayload

A payload for a mutation.

Fields:

MultimediaReplacePayload

A payload for a mutation.

Fields:

MultimediaSetAltPayload

A payload for a mutation.

Fields:

MultimediaSetFolderPayload

A payload for a mutation.

Fields:

MultimediaSetNamePayload

A payload for a mutation.

Fields:

MultimediaSetTitlePayload

A payload for a mutation.

Fields:

MultiSelectAttribute

Represents a set of options allowing multiple choices.

Implements:

MultiSelectAttributeValue

An attribute value.

Implements:

Fields:

MultiSelectAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

NumericAttribute

Represents a number.

Implements:

NumberAttributeValue

An attribute value.

Implements:

Fields:

NumericAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

Option

Represents an option of a select and multi-select attribute.

Fields:

OptionConnection

The connection for Option

Fields:

OptionEdge

An edge in a connection.

Fields:

Represents an option of a select and multi-select attribute.

Fields:

OptionTranslatedValue

Simple representation of an Option of select and multi-select attributes with the name in a specific language only.

Fields:

PageInfo

Information about pagination in a connection.

Fields:

PriceAttribute

Represents a positive price of a specific currency.

Implements:

Fields:

PriceAttributeValue

An attribute value.

Implements:

Fields:

PriceAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

ProductAddAttributeValueTranslationsDatePayload

A payload for a mutation.

Fields:

ProductAddAttributeValueTranslationsFilePayload

A payload for a mutation.

Fields:

ProductAddAttributeValueTranslationsGalleryPayload

A payload for a mutation.

Fields:

ProductAddAttributeValueTranslationsImagePayload

A payload for a mutation.

Fields:

ProductAddAttributeValueTranslationsMultiSelectPayload

A payload for a mutation.

Fields:

ProductAddAttributeValueTranslationsNumericPayload

A payload for a mutation.

Fields:

ProductAddAttributeValueTranslationsPricePayload

A payload for a mutation.

Fields:

ProductAddAttributeValueTranslationsProductRelationPayload

A payload for a mutation.

Fields:

ProductAddAttributeValueTranslationsSelectPayload

A payload for a mutation.

Fields:

ProductAddAttributeValueTranslationsTextareaPayload

A payload for a mutation.

Fields:

ProductAddAttributeValueTranslationsTextPayload

A payload for a mutation.

Fields:

ProductAddAttributeValueTranslationsUnitPayload

A payload for a mutation.

Fields:

ProductAddCategoriesPayload

A payload for a mutation.

Fields:

ProductConnection

The connection for Product

Fields:

ProductCreateGroupingPayload

A payload for a mutation.

Fields:

ProductCreateSimplePayload

A payload for a mutation.

Fields:

ProductCreateVariablePayload

A payload for a mutation.

Fields:

ProductDeletedConnection

The connection for Sku

Fields:

ProductDeleteAttributeValueTranslationsPayload

A payload for a mutation.

Fields:

ProductDeletedEdge

An edge in a connection.

Fields:

ProductDeletePayload

A payload for a mutation.

Fields:

ProductEdge

An edge in a connection.

Fields:

ProductGroupingAddChildPayload

A payload for a mutation.

Fields:

ProductGroupingRemoveChildPayload

A payload for a mutation.

Fields:

ProductGroupingSetChildQuantityPayload

A payload for a mutation.

Fields:

ProductRelationAttribute

Represents a relation to the collection of products.

Implements:

ProductRelationAttributeValue

An attribute value.

Implements:

Fields:

ProductRelationAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

ProductRemoveCategoriesPayload

A payload for a mutation.

Fields:

ProductSetTemplatePayload

A payload for a mutation.

Fields:

ProductVariableAddVariantPayload

A payload for a mutation.

Fields:

ProductVariableRemoveVariantPayload

A payload for a mutation.

Fields:

ProductVariableSetBindingsPayload

A payload for a mutation.

Fields:

Section

Represents a set of common attributes - technical data, SEO-related parameters, etc.

Fields:

SectionConnection

The connection for Section

Fields:

SectionEdge

An edge in a connection.

Fields:

SelectAttribute

Represents a set of options allowing single choice.

Implements:

SelectAttributeValue

An attribute value.

Implements:

Fields:

SelectAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

SimpleProduct

A simple product.

Implements:

Template

Represents a set of attributes specific to a market segment.

Fields:

TemplateConnection

The connection for Template

Fields:

TemplateEdge

An edge in a connection.

Fields:

TextareaAttribute

Represents a text.

Implements:

Fields:

TextareaAttributeValue

An attribute value.

Implements:

Fields:

TextareaAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

TextareaCustomField

Represents a text.

Implements:

TextareaCustomFieldTranslatedValue

Represents a text translated value.

Implements:

Fields:

TextareaCustomFieldValue

A custom field value.

Implements:

Fields:

TextareaCustomFieldValueTranslation

Translation of a custom field value.

Implements:

Fields:

TextareaRTECustomField

Represents a text with RTE enabled.

Implements:

TextareaRTECustomFieldTranslatedValue

Represents a text with RTE translated value.

Implements:

Fields:

TextareaRTECustomFieldValue

A custom field value.

Implements:

Fields:

TextareaRTECustomFieldValueTranslation

Translation of a custom field value.

Implements:

Fields:

TextAttribute

Represents a short text of up to 255 chars.

Implements:

TextAttributeValue

An attribute value.

Implements:

Fields:

TextAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

TextCustomField

Represents a short text of up to 255 chars.

Implements:

TextCustomFieldTranslatedValue

Represents a text translated value.

Implements:

Fields:

TextCustomFieldValue

A custom field value.

Implements:

Fields:

TextCustomFieldValueTranslation

Translation of a custom field value.

Implements:

Fields:

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:

UnitAttributeValue

An attribute value.

Implements:

Fields:

UnitAttributeValueTranslation

Translation of an attribute value.

Implements:

Fields:

VariableProduct

A product representing multiple variants i.e. products of different sizes or colors.

Fields:

Last updated