Input objects

Input objects represent a set of fields allowing describing mutation.

AttributeAddMetadataInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
metadata	[MetadatumInput!]!	Metadata to be set.

AttributeCreateDateInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.
format	DateFormat!	Format of Attribute.

AttributeCreateFileInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.

AttributeCreateGalleryInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.

AttributeCreateImageInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.

AttributeCreateMultiSelectInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.
options	[OptionInput!]!	Options of Attribute.

AttributeCreateNumericInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.

AttributeCreatePriceInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.
currency	Currency!	Currency of Attribute.

AttributeCreateProductRelationInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.

AttributeCreateSelectInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.
options	[OptionInput!]!	Options of Attribute.

AttributeCreateTextareaInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.
richEdit	Boolean!	Is rich edit enabled.

AttributeCreateTextInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.

AttributeCreateUnitInput

Input fields:

code	AttributeCode!	Code of Attribute.
scope	AttributeScope!	Scope of Attribute.
name	[TranslatedStringInput!]	Name of Attribute.
unitName	UnitName!	Unit name for Attribute.

AttributeDateSetFormatInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
format	DateFormat!	Format of Attribute.

AttributeDeleteInput

Input fields:

code

AttributeCode!

The code of Attribute the mutation to be performed on.

AttributeDeleteMetadataInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
metadataKeys	[MetadatumKey!]!	Metadata keys to be deleted.

AttributeMultiSelectAddOptionInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
option	OptionInput!	Option to be added.

AttributeMultiSelectDeleteOptionInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
optionCode	OptionCode!	Option to be deleted.

AttributeMultiSelectSetOptionNameInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
optionCode	OptionCode!	Option to be changed.
optionName	[TranslatedStringInput!]!	Option name to be set.

AttributeMultiSelectSetOptionsInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
options	[OptionInput!]!	Options to be set.

AttributeOptionAddCustomFieldImageInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
customFieldCode	CustomFieldCode!	Code of the custom field to be configured.

AttributeOptionAddCustomFieldTextareaInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
customFieldCode	CustomFieldCode!	Code of the custom field to be configured.

AttributeOptionAddCustomFieldTextareaRTEInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
customFieldCode	CustomFieldCode!	Code of the custom field to be configured.

AttributeOptionAddCustomFieldTextInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
customFieldCode	CustomFieldCode!	Code of the custom field to be configured.

AttributeOptionAddOptionCustomFieldValueTranslationsImageInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
optionCode	OptionCode!	Option to be changed.
customFieldCode	CustomFieldCode!	Code of the custom field to be configured.
translations	[ImageCustomFieldValueTranslationInput!]!	Translations of the value to be added.

AttributeOptionAddOptionCustomFieldValueTranslationsTextareaInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
optionCode	OptionCode!	Option to be changed.
customFieldCode	CustomFieldCode!	Code of the custom field to be configured.
translations	[TextareaCustomFieldValueTranslationInput!]!	Translations of the value to be added.

AttributeOptionAddOptionCustomFieldValueTranslationsTextareaRTEInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
optionCode	OptionCode!	Option to be changed.
customFieldCode	CustomFieldCode!	Code of the custom field to be configured.
translations	[TextareaRTECustomFieldValueTranslationInput!]!	Translations of the value to be added.

AttributeOptionAddOptionCustomFieldValueTranslationsTextInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
optionCode	OptionCode!	Option to be changed.
customFieldCode	CustomFieldCode!	Code of the custom field to be configured.
translations	[TextCustomFieldValueTranslationInput!]!	Translations of the value to be added.

AttributeOptionDeleteCustomFieldInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
customFieldCode	CustomFieldCode!	Code of the custom field to be deleted.

AttributeOptionDeleteOptionCustomFieldValueTranslationsInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
optionCode	OptionCode!	Option to be changed.
customFieldCode	CustomFieldCode!	Code of the custom field changed.
languages	[Language!]!	Languages the translations to be deleted in.

AttributeOptionListFilterInput

Input fields:

optionCodes	[OptionCode!]	Option codes to be filtered by.
optionNames	[TranslatedStringFilterInput!]	Option names to be filtered by.

AttributePriceSetCurrencyInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
currency	Currency!	Currency to be set.

AttributeSelectAddOptionInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
option	OptionInput!	Option to be added.

AttributeSelectDeleteOptionInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
optionCode	OptionCode!	Option to be deleted.

AttributeSelectSetOptionNameInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
optionCode	OptionCode!	Option to be changed.
optionName	[TranslatedStringInput!]!	Option name to be set.

AttributeSelectSetOptionsInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
options	[OptionInput!]!	Options to be set.

AttributeSetNameInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
name	[TranslatedStringInput!]!	Name to be set.

AttributeTextareaSetRichEditInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
richEdit	Boolean!	Is rich edit enabled.

AttributeUnitSetUnitInput

Input fields:

code	AttributeCode!	The code of Attribute the mutation to be performed on.
unitName	UnitName!	Unit to be set.

CategoryAddAttributeValueTranslationsDateInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[DateValueTranlationInput!]!	Translations of the value to be added.

CategoryAddAttributeValueTranslationsFileInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[FileValueTranlationInput!]!	Translations of the value to be added.

CategoryAddAttributeValueTranslationsGalleryInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[GalleryValueTranlationInput!]!	Translations of the value to be added.

CategoryAddAttributeValueTranslationsImageInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[ImageValueTranlationInput!]!	Translations of the value to be added.

CategoryAddAttributeValueTranslationsMultiSelectInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[MultiSelectValueTranlationInput!]!	Translations of the value to be added.

CategoryAddAttributeValueTranslationsNumericInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[NumericValueTranlationInput!]!	Translations of the value to be added.

CategoryAddAttributeValueTranslationsPriceInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[PriceValueTranlationInput!]!	Translations of the value to be added.

CategoryAddAttributeValueTranslationsProductRelationInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[ProductRelationValueTranlationInput!]!	Translations of the value to be added.

CategoryAddAttributeValueTranslationsSelectInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[SelectValueTranlationInput!]!	Translations of the value to be added.

CategoryAddAttributeValueTranslationsTextareaInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[TextareaValueTranlationInput!]!	Translations of the value to be added.

CategoryAddAttributeValueTranslationsTextInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[TextValueTranlationInput!]!	Translations of the value to be added.

CategoryAddAttributeValueTranslationsUnitInput

Input fields:

categoryCode	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[UnitValueTranlationInput!]!	Translations of the value to be added.

CategoryAttributeAddAttributeInput

Input fields:

attributeCode

AttributeCode!

The code of Attribute to be added.

CategoryAttributeRemoveAttributeInput

Input fields:

attributeCode

AttributeCode!

The code of Attribute to be removed.

CategoryCreateInput

Input fields:

code	CategoryCode!	The code of Category.
name	[TranslatedStringInput!]	The name of Category.

CategoryDeleteAttributeValueTranslationsInput

Input fields:

code	CategoryCode!	The code of Category the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute deleting value from.
languages	[Language!]	Languages the translations to be deleted in.

CategoryDeleteInput

Input fields:

code

CategoryCode!

The code of Category the mutation to be performed on.

CategorySetNameInput

Input fields:

code	CategoryCode!	The code of Category the mutation to be performed on.
name	[TranslatedStringInput!]!	Name to be set.

DateValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	String!	Translation value to be set.

FileValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	[MultimediaPath!]!	Translation value to be set.

GalleryValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	[MultimediaPath!]!	Translation value to be set.

ImageCustomFieldValueTranslationInput

Input fields:

language	Language!	Language the translation to be added in.
value	MultimediaPath!	Translation value to be set.

ImageValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	MultimediaPath!	Translation value to be set.

MetadatumInput

Input fields:

key	MetadatumKey!	Key of the metadata value to be set on.
value	String!	Value to be set.

MultimediaCreateInput

Input fields:

name	MultimediaName!	The name of Multimedia.
folderPath	MultimediaFolderPath	Folder Multimedia to be put in.

MultimediaDeleteInput

Input fields:

path

MultimediaPath!

The path of Multimedia the mutation to be performed on.

MultimediaFolderCreateInput

Input fields:

name	MultimediaFolderName!	The name of MultimediaFolder.
folderPath	MultimediaFolderPath	Folder MultimediaFolder to be put in.
createFolderPath	Boolean!	Creates folderPath if does not exist. Defaults to false.

MultimediaFolderDeleteInput

Input fields:

path

MultimediaFolderPath!

The path of MultimediaFolder the mutation to be performed on.

MultimediaMoveInput

Input fields:

path	MultimediaPath!	The path of Multimedia the mutation to be performed on.
folderPath	MultimediaFolderPath	Folder Multimedia to be put in.

MultimediaReplaceInput

Input fields:

path

MultimediaPath!

The path of Multimedia the mutation to be performed on.

MultimediaSetAltInput

Input fields:

path	MultimediaPath!	The path of Multimedia the mutation to be performed on.
alt	[TranslatedStringInput!]!	Alt to be set.

MultimediaSetNameInput

Input fields:

path	MultimediaPath!	The path of Multimedia the mutation to be performed on.
name	MultimediaName!	Name to be set.

MultimediaSetTitleInput

Input fields:

path	MultimediaPath!	The path of Multimedia the mutation to be performed on.
title	[TranslatedStringInput!]!	Title to be set.

MultiSelectValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	[OptionCode!]!	Translation value to be set.

NumericValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	Float!	Translation value to be set.

OptionInput

Input fields:

code	OptionCode!	Code of the Option to be used.
name	[TranslatedStringInput!]	Name to be set.

PriceValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	Float!	Translation value to be set.

ProductAddAttributeValueTranslationsDateInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[DateValueTranlationInput!]!	Translations of the value to be added.

ProductAddAttributeValueTranslationsFileInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[FileValueTranslationInput!]!	Translations of the value to be added.

ProductAddAttributeValueTranslationsGalleryInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[GalleryValueTranslationInput!]!	Translations of the value to be added.

ProductAddAttributeValueTranslationsImageInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[ImageValueTranslationInput!]!	Translations of the value to be added.

ProductAddAttributeValueTranslationsMultiSelectInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[MultiSelectValueTranslationInput!]!	Translations of the value to be added.

ProductAddAttributeValueTranslationsNumericInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[NumericValueTranslationInput!]!	Translations of the value to be added.

ProductAddAttributeValueTranslationsPriceInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[PriceValueTranslationInput!]!	Translations of the value to be added.

ProductAddAttributeValueTranslationsProductRelationInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[ProductRelationValueTranslationInput!]!	Translations of the value to be added.
twoWayRelation	TwoWayRelation	Determines behavior of the value. Defaults to None

ProductAddAttributeValueTranslationsSelectInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[SelectValueTranslationInput!]!	Translations of the value to be added.

ProductAddAttributeValueTranslationsTextareaInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[TextareaValueTranslationInput!]!	Translations of the value to be added.

ProductAddAttributeValueTranslationsTextInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[TextValueTranslationInput!]!	Translations of the value to be added.

ProductAddAttributeValueTranslationsUnitInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute adding value to.
translations	[UnitValueTranslationInput!]!	Translations of the value to be added.

ProductAddCategoriesInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
categoryCodes	[CategoryCode!]!	Categories to be added.

ProductCreateGroupingInput

Input fields:

sku	Sku!	Sku of Product.
templateCode	TemplateCode!	Template of Product.
categoryCode	[CategoryCode!]	Categories of Product.

ProductCreateSimpleInput

Input fields:

sku	Sku!	Sku of Product.
templateCode	TemplateCode!	Template of Product.
categoryCode	[CategoryCode!]	Categories of Product.

ProductCreateVariableInput

Input fields:

sku	Sku!	Sku of Product.
templateCode	TemplateCode!	Template of Product.
categoryCode	[CategoryCode!]	Categories of Product.

ProductDeleteAttributeValueTranslationsInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
attributeCode	AttributeCode!	The code of Attribute deleting value from.
languages	[Language!]	Languages the translations to be deleted in.

ProductDeleteInput

Input fields:

sku

Sku!

The sku of Product the mutation to be performed on.

ProductGroupingAddChildInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
childSku	Sku!	Child to be added.
quantity	Int	Quantity the child to be added in.

ProductGroupingRemoveChildInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
childSku	Sku!	Child to be removed.

ProductGroupingSetChildQuantityInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
childSku	Sku!	Child quantity to be modified.
quantity	Int!	Quantity to be set.

ProductRelationValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	[Sku!]!	Translation value to be set.

ProductRemoveCategoriesInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
categoryCodes	[CategoryCode!]!	Categories to be removed.

ProductSetTemplateInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
template	TemplateCode!	Template to be set.

ProductVariableAddVariantInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
variantSku	Sku!	Variant to be added.

ProductVariableRemoveVariantInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
variantSku	Sku!	Variant to be removed.

ProductVariableSetBindingsInput

Input fields:

sku	Sku!	The sku of Product the mutation to be performed on.
bindingCodes	[AttributeCode!]!	Binding attributes to be set.

SelectValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	OptionCode!	Translation value to be set.

TextareaCustomFieldValueTranslationInput

Input fields:

language	Language!	Language the translation to be added in.
value	String!	Translation value to be set.

TextareaRTECustomFieldValueTranslationInput

Input fields:

language	Language!	Language the translation to be added in.
value	String!	Translation value to be set.

TextareaValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	String!	Translation value to be set. Accepts Attribute Variables in format {{#attribute_code}}.

TextCustomFieldValueTranslationInput

Input fields:

language	Language!	Language the translation to be added in.
value	String!	Translation value to be set.

TextValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	String!	Translation value to be set.

TranslatedStringFilterInput

Input fields:

language	Language!	Language the translation to be filtered in.
value	String!	Translation value to be filtered by.

TranslatedStringInput

Input fields:

language	Language!	Language the translation to be added in.
value	String!	Translation value to be set.

UnitValueTranslationInput

Input fields:

language	Language	Language the translation to be added in. Allowed empty only in case of GLOBAL scope.
value	Float!	Translation value to be set.