Input objects

Input objects represent a set of fields allowing describing mutation.

AttributeAddMetadataInput

Input fields:

code

The code of Attribute the mutation to be performed on.

metadata

Metadata to be set.

AttributeCreateDateInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

format

Format of Attribute.

AttributeCreateFileInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

AttributeCreateGalleryInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

AttributeCreateImageInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

AttributeCreateMultiSelectInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

options

Options of Attribute.

AttributeCreateNumericInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

AttributeCreatePriceInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

currency

Currency of Attribute.

AttributeCreateProductRelationInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

AttributeCreateSelectInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

options

Options of Attribute.

AttributeCreateTextareaInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

richEdit

Is rich edit enabled.

AttributeCreateTextInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

AttributeCreateUnitInput

Input fields:

code

Code of Attribute.

scope

Scope of Attribute.

name

Name of Attribute.

unitName

Unit name for Attribute.

AttributeDateSetFormatInput

Input fields:

code

The code of Attribute the mutation to be performed on.

format

Format of Attribute.

AttributeDeleteInput

Input fields:

code

The code of Attribute the mutation to be performed on.

AttributeDeleteMetadataInput

Input fields:

code

The code of Attribute the mutation to be performed on.

metadataKeys

Metadata keys to be deleted.

AttributeMultiSelectAddOptionInput

Input fields:

code

The code of Attribute the mutation to be performed on.

option

Option to be added.

AttributeMultiSelectDeleteOptionInput

Input fields:

code

The code of Attribute the mutation to be performed on.

optionCode

Option to be deleted.

AttributeMultiSelectSetOptionNameInput

Input fields:

code

The code of Attribute the mutation to be performed on.

optionCode

Option to be changed.

optionName

Option name to be set.

AttributeMultiSelectSetOptionsInput

Input fields:

code

The code of Attribute the mutation to be performed on.

options

Options to be set.

AttributeOptionAddCustomFieldImageInput

Input fields:

code

The code of Attribute the mutation to be performed on.

customFieldCode

Code of the custom field to be configured.

AttributeOptionAddCustomFieldTextareaInput

Input fields:

code

The code of Attribute the mutation to be performed on.

customFieldCode

Code of the custom field to be configured.

AttributeOptionAddCustomFieldTextareaRTEInput

Input fields:

code

The code of Attribute the mutation to be performed on.

customFieldCode

Code of the custom field to be configured.

AttributeOptionAddCustomFieldTextInput

Input fields:

code

The code of Attribute the mutation to be performed on.

customFieldCode

Code of the custom field to be configured.

AttributeOptionAddOptionCustomFieldValueTranslationsImageInput

Input fields:

code

The code of Attribute the mutation to be performed on.

optionCode

Option to be changed.

customFieldCode

Code of the custom field to be configured.

translations

Translations of the value to be added.

AttributeOptionAddOptionCustomFieldValueTranslationsTextareaInput

Input fields:

code

The code of Attribute the mutation to be performed on.

optionCode

Option to be changed.

customFieldCode

Code of the custom field to be configured.

translations

Translations of the value to be added.

AttributeOptionAddOptionCustomFieldValueTranslationsTextareaRTEInput

Input fields:

code

The code of Attribute the mutation to be performed on.

optionCode

Option to be changed.

customFieldCode

Code of the custom field to be configured.

translations

Translations of the value to be added.

AttributeOptionAddOptionCustomFieldValueTranslationsTextInput

Input fields:

code

The code of Attribute the mutation to be performed on.

optionCode

Option to be changed.

customFieldCode

Code of the custom field to be configured.

translations

Translations of the value to be added.

AttributeOptionDeleteCustomFieldInput

Input fields:

code

The code of Attribute the mutation to be performed on.

customFieldCode

Code of the custom field to be deleted.

AttributeOptionDeleteOptionCustomFieldValueTranslationsInput

Input fields:

code

The code of Attribute the mutation to be performed on.

optionCode

Option to be changed.

customFieldCode

Code of the custom field changed.

languages

Languages the translations to be deleted in.

AttributeOptionListFilterInput

Input fields:

optionCodes

Option codes to be filtered by.

optionNames

Option names to be filtered by.

AttributePriceSetCurrencyInput

Input fields:

code

The code of Attribute the mutation to be performed on.

currency

Currency to be set.

AttributeSelectAddOptionInput

Input fields:

code

The code of Attribute the mutation to be performed on.

option

Option to be added.

AttributeSelectDeleteOptionInput

Input fields:

code

The code of Attribute the mutation to be performed on.

optionCode

Option to be deleted.

AttributeSelectSetOptionNameInput

Input fields:

code

The code of Attribute the mutation to be performed on.

optionCode

Option to be changed.

optionName

Option name to be set.

AttributeSelectSetOptionsInput

Input fields:

code

The code of Attribute the mutation to be performed on.

options

Options to be set.

AttributeSetNameInput

Input fields:

code

The code of Attribute the mutation to be performed on.

name

Name to be set.

AttributeTextareaSetRichEditInput

Input fields:

code

The code of Attribute the mutation to be performed on.

richEdit

Is rich edit enabled.

AttributeUnitSetUnitInput

Input fields:

code

The code of Attribute the mutation to be performed on.

unitName

Unit to be set.

CategoryAddAttributeValueTranslationsDateInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAddAttributeValueTranslationsFileInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAddAttributeValueTranslationsGalleryInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAddAttributeValueTranslationsImageInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAddAttributeValueTranslationsMultiSelectInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAddAttributeValueTranslationsNumericInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAddAttributeValueTranslationsPriceInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAddAttributeValueTranslationsProductRelationInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAddAttributeValueTranslationsSelectInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAddAttributeValueTranslationsTextareaInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAddAttributeValueTranslationsTextInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAddAttributeValueTranslationsUnitInput

Input fields:

categoryCode

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

CategoryAttributeAddAttributeInput

Input fields:

attributeCode

The code of Attribute to be added.

CategoryAttributeRemoveAttributeInput

Input fields:

attributeCode

The code of Attribute to be removed.

CategoryCreateInput

Input fields:

code

The code of Category.

name

The name of Category.

CategoryDeleteAttributeValueTranslationsInput

Input fields:

code

The code of Category the mutation to be performed on.

attributeCode

The code of Attribute deleting value from.

languages

Languages the translations to be deleted in.

CategoryDeleteInput

Input fields:

code

The code of Category the mutation to be performed on.

CategorySetNameInput

Input fields:

code

The code of Category the mutation to be performed on.

name

Name to be set.

DateValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set.

FileValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set.

GalleryValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set.

ImageCustomFieldValueTranslationInput

Input fields:

language

Language the translation to be added in.

value

Translation value to be set.

ImageValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set.

MetadatumInput

Input fields:

key

Key of the metadata value to be set on.

value

Value to be set.

MultimediaCreateInput

Input fields:

name

The name of Multimedia.

folderPath

Folder Multimedia to be put in.

MultimediaDeleteInput

Input fields:

path

The path of Multimedia the mutation to be performed on.

MultimediaFolderCreateInput

Input fields:

name

The name of MultimediaFolder.

folderPath

Folder MultimediaFolder to be put in.

createFolderPath

Creates folderPath if does not exist. Defaults to false.

MultimediaFolderDeleteInput

Input fields:

path

The path of MultimediaFolder the mutation to be performed on.

MultimediaMoveInput

Input fields:

path

The path of Multimedia the mutation to be performed on.

folderPath

Folder Multimedia to be put in.

MultimediaReplaceInput

Input fields:

path

The path of Multimedia the mutation to be performed on.

MultimediaSetAltInput

Input fields:

path

The path of Multimedia the mutation to be performed on.

alt

Alt to be set.

MultimediaSetNameInput

Input fields:

path

The path of Multimedia the mutation to be performed on.

name

Name to be set.

MultimediaSetTitleInput

Input fields:

path

The path of Multimedia the mutation to be performed on.

title

Title to be set.

MultiSelectValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set.

NumericValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set.

OptionInput

Input fields:

code

Code of the Option to be used.

name

Name to be set.

PriceValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set.

ProductAddAttributeValueTranslationsDateInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

ProductAddAttributeValueTranslationsFileInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

ProductAddAttributeValueTranslationsGalleryInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

ProductAddAttributeValueTranslationsImageInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

ProductAddAttributeValueTranslationsMultiSelectInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

ProductAddAttributeValueTranslationsNumericInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

ProductAddAttributeValueTranslationsPriceInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

ProductAddAttributeValueTranslationsProductRelationInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

twoWayRelation

Determines behavior of the value. Defaults to None

ProductAddAttributeValueTranslationsSelectInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

ProductAddAttributeValueTranslationsTextareaInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

ProductAddAttributeValueTranslationsTextInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

ProductAddAttributeValueTranslationsUnitInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute adding value to.

translations

Translations of the value to be added.

ProductAddCategoriesInput

Input fields:

sku

The sku of Product the mutation to be performed on.

categoryCodes

Categories to be added.

ProductCreateGroupingInput

Input fields:

sku

Sku of Product.

templateCode

Template of Product.

categoryCode

Categories of Product.

ProductCreateSimpleInput

Input fields:

sku

Sku of Product.

templateCode

Template of Product.

categoryCode

Categories of Product.

ProductCreateVariableInput

Input fields:

sku

Sku of Product.

templateCode

Template of Product.

categoryCode

Categories of Product.

ProductDeleteAttributeValueTranslationsInput

Input fields:

sku

The sku of Product the mutation to be performed on.

attributeCode

The code of Attribute deleting value from.

languages

Languages the translations to be deleted in.

ProductDeleteInput

Input fields:

sku

The sku of Product the mutation to be performed on.

ProductGroupingAddChildInput

Input fields:

sku

The sku of Product the mutation to be performed on.

childSku

Child to be added.

quantity

Quantity the child to be added in.

ProductGroupingRemoveChildInput

Input fields:

sku

The sku of Product the mutation to be performed on.

childSku

Child to be removed.

ProductGroupingSetChildQuantityInput

Input fields:

sku

The sku of Product the mutation to be performed on.

childSku

Child quantity to be modified.

quantity

Quantity to be set.

ProductRelationValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set.

ProductRemoveCategoriesInput

Input fields:

sku

The sku of Product the mutation to be performed on.

categoryCodes

Categories to be removed.

ProductSetTemplateInput

Input fields:

sku

The sku of Product the mutation to be performed on.

template

Template to be set.

ProductVariableAddVariantInput

Input fields:

sku

The sku of Product the mutation to be performed on.

variantSku

Variant to be added.

ProductVariableRemoveVariantInput

Input fields:

sku

The sku of Product the mutation to be performed on.

variantSku

Variant to be removed.

ProductVariableSetBindingsInput

Input fields:

sku

The sku of Product the mutation to be performed on.

bindingCodes

Binding attributes to be set.

SelectValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set.

TextareaCustomFieldValueTranslationInput

Input fields:

language

Language the translation to be added in.

value

Translation value to be set.

TextareaRTECustomFieldValueTranslationInput

Input fields:

language

Language the translation to be added in.

value

Translation value to be set.

TextareaValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set. Accepts Attribute Variables in format {{#attribute_code}}.

TextCustomFieldValueTranslationInput

Input fields:

language

Language the translation to be added in.

value

Translation value to be set.

TextValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set.

TranslatedStringFilterInput

Input fields:

language

Language the translation to be filtered in.

value

Translation value to be filtered by.

TranslatedStringInput

Input fields:

language

Language the translation to be added in.

value

Translation value to be set.

UnitValueTranslationInput

Input fields:

language

Language the translation to be added in. Allowed empty only in case of GLOBAL scope.

value

Translation value to be set.

Last updated