Input objects
Input objects represent a set of fields allowing describing mutation.
AttributeAddMetadataInput
Input fields:
code | The code of | |
metadata | Metadata to be set. |
AttributeCreateDateInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of | |
format | Format of |
AttributeCreateFileInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of |
AttributeCreateGalleryInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of |
AttributeCreateImageInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of |
AttributeCreateMultiSelectInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of | |
options | Options of |
AttributeCreateNumericInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of |
AttributeCreatePriceInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of | |
currency | Currency of |
AttributeCreateProductRelationInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of |
AttributeCreateSelectInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of | |
options | Options of |
AttributeCreateTextareaInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of | |
richEdit | Is rich edit enabled. |
AttributeCreateTextInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of |
AttributeCreateUnitInput
Input fields:
code | Code of | |
scope | Scope of | |
name | Name of | |
unitName | Unit name for |
AttributeDateSetFormatInput
Input fields:
code | The code of | |
format | Format of |
AttributeDeleteInput
Input fields:
code | The code of |
AttributeDeleteMetadataInput
Input fields:
code | The code of | |
metadataKeys | Metadata keys to be deleted. |
AttributeMultiSelectAddOptionInput
Input fields:
code | The code of | |
option | Option to be added. |
AttributeMultiSelectDeleteOptionInput
Input fields:
code | The code of | |
optionCode | Option to be deleted. |
AttributeMultiSelectSetOptionNameInput
Input fields:
code | The code of | |
optionCode | Option to be changed. | |
optionName | Option name to be set. |
AttributeMultiSelectSetOptionsInput
Input fields:
code | The code of | |
options | Options to be set. |
AttributeOptionAddCustomFieldImageInput
Input fields:
code | The code of | |
customFieldCode | Code of the custom field to be configured. |
AttributeOptionAddCustomFieldTextareaInput
Input fields:
code | The code of | |
customFieldCode | Code of the custom field to be configured. |
AttributeOptionAddCustomFieldTextareaRTEInput
Input fields:
code | The code of | |
customFieldCode | Code of the custom field to be configured. |
AttributeOptionAddCustomFieldTextInput
Input fields:
code | The code of | |
customFieldCode | Code of the custom field to be configured. |
AttributeOptionAddOptionCustomFieldValueTranslationsImageInput
Input fields:
code | The code of | |
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 | |
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 | |
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 | |
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 | |
customFieldCode | Code of the custom field to be deleted. |
AttributeOptionDeleteOptionCustomFieldValueTranslationsInput
Input fields:
code | The code of | |
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 | |
currency | Currency to be set. |
AttributeSelectAddOptionInput
Input fields:
code | The code of | |
option | Option to be added. |
AttributeSelectDeleteOptionInput
Input fields:
code | The code of | |
optionCode | Option to be deleted. |
AttributeSelectSetOptionNameInput
Input fields:
code | The code of | |
optionCode | Option to be changed. | |
optionName | Option name to be set. |
AttributeSelectSetOptionsInput
Input fields:
code | The code of | |
options | Options to be set. |
AttributeSetNameInput
Input fields:
code | The code of | |
name | Name to be set. |
AttributeTextareaSetRichEditInput
Input fields:
code | The code of | |
richEdit | Is rich edit enabled. |
AttributeUnitSetUnitInput
Input fields:
code | The code of | |
unitName | Unit to be set. |
CategoryAddAttributeValueTranslationsDateInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAddAttributeValueTranslationsFileInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAddAttributeValueTranslationsGalleryInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAddAttributeValueTranslationsImageInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAddAttributeValueTranslationsMultiSelectInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAddAttributeValueTranslationsNumericInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAddAttributeValueTranslationsPriceInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAddAttributeValueTranslationsProductRelationInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAddAttributeValueTranslationsSelectInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAddAttributeValueTranslationsTextareaInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAddAttributeValueTranslationsTextInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAddAttributeValueTranslationsUnitInput
Input fields:
categoryCode | The code of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
CategoryAttributeAddAttributeInput
Input fields:
attributeCode | The code of |
CategoryAttributeRemoveAttributeInput
Input fields:
attributeCode | The code of |
CategoryCreateInput
Input fields:
code | The code of | |
name | The name of |
CategoryDeleteAttributeValueTranslationsInput
Input fields:
code | The code of | |
attributeCode | The code of | |
languages | Languages the translations to be deleted in. |
CategoryDeleteInput
Input fields:
code | The code of |
CategorySetNameInput
Input fields:
code | The code of | |
name | Name to be set. |
DateValueTranslationInput
Input fields:
language | ||
value | Translation value to be set. |
FileValueTranslationInput
Input fields:
language | ||
value | Translation value to be set. |
GalleryValueTranslationInput
Input fields:
language | ||
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 | ||
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 | |
folderPath | Folder |
MultimediaDeleteInput
Input fields:
path | The path of |
MultimediaFolderCreateInput
Input fields:
name | The name of | |
folderPath | Folder | |
createFolderPath | Creates folderPath if does not exist. Defaults to |
MultimediaFolderDeleteInput
Input fields:
path | The path of |
MultimediaMoveInput
Input fields:
path | The path of | |
folderPath | Folder |
MultimediaReplaceInput
Input fields:
path | The path of |
MultimediaSetAltInput
Input fields:
path | The path of | |
alt | Alt to be set. |
MultimediaSetNameInput
Input fields:
path | The path of | |
name | Name to be set. |
MultimediaSetTitleInput
Input fields:
path | The path of | |
title | Title to be set. |
MultiSelectValueTranslationInput
Input fields:
language | ||
value | Translation value to be set. |
NumericValueTranslationInput
Input fields:
language | ||
value | Translation value to be set. |
OptionInput
Input fields:
code | Code of the | |
name | Name to be set. |
PriceValueTranslationInput
Input fields:
language | ||
value | Translation value to be set. |
ProductAddAttributeValueTranslationsDateInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
ProductAddAttributeValueTranslationsFileInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
ProductAddAttributeValueTranslationsGalleryInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
ProductAddAttributeValueTranslationsImageInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
ProductAddAttributeValueTranslationsMultiSelectInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
ProductAddAttributeValueTranslationsNumericInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
ProductAddAttributeValueTranslationsPriceInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
ProductAddAttributeValueTranslationsProductRelationInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. | |
twoWayRelation | Determines behavior of the value. Defaults to |
ProductAddAttributeValueTranslationsSelectInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
ProductAddAttributeValueTranslationsTextareaInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
ProductAddAttributeValueTranslationsTextInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
ProductAddAttributeValueTranslationsUnitInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
translations | Translations of the value to be added. |
ProductAddCategoriesInput
Input fields:
sku | The sku of | |
categoryCodes | Categories to be added. |
ProductCreateGroupingInput
Input fields:
sku | Sku of | |
templateCode | Template of | |
categoryCode | Categories of |
ProductCreateSimpleInput
Input fields:
sku | Sku of | |
templateCode | Template of | |
categoryCode | Categories of |
ProductCreateVariableInput
Input fields:
sku | Sku of | |
templateCode | Template of | |
categoryCode | Categories of |
ProductDeleteAttributeValueTranslationsInput
Input fields:
sku | The sku of | |
attributeCode | The code of | |
languages | Languages the translations to be deleted in. |
ProductDeleteInput
Input fields:
sku | The sku of |
ProductGroupingAddChildInput
Input fields:
sku | The sku of | |
childSku | Child to be added. | |
quantity | Quantity the child to be added in. |
ProductGroupingRemoveChildInput
Input fields:
sku | The sku of | |
childSku | Child to be removed. |
ProductGroupingSetChildQuantityInput
Input fields:
sku | The sku of | |
childSku | Child quantity to be modified. | |
quantity | Quantity to be set. |
ProductRelationValueTranslationInput
Input fields:
language | ||
value | Translation value to be set. |
ProductRemoveCategoriesInput
Input fields:
sku | The sku of | |
categoryCodes | Categories to be removed. |
ProductSetTemplateInput
Input fields:
sku | The sku of | |
template | Template to be set. |
ProductVariableAddVariantInput
Input fields:
sku | The sku of | |
variantSku | Variant to be added. |
ProductVariableRemoveVariantInput
Input fields:
sku | The sku of | |
variantSku | Variant to be removed. |
ProductVariableSetBindingsInput
Input fields:
sku | The sku of | |
bindingCodes | Binding attributes to be set. |
SelectValueTranslationInput
Input fields:
language | ||
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 | ||
value | Translation value to be set.
Accepts Attribute Variables in format |
TextCustomFieldValueTranslationInput
Input fields:
language | Language the translation to be added in. | |
value | Translation value to be set. |
TextValueTranslationInput
Input fields:
language | ||
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 | ||
value | Translation value to be set. |
Last updated