The API is available at /api/graphql/ URL path of your instance.

API returns data in JSON format.

productStream

• product created

• product property updated

  • attribute value

  • product added or removed from a category

  • template assignment

  • status changed

  • a variant has been added or removed

  • grouped product has been added or removed

• product added to a segment

• variable product variant added to a segment

• grouping product grouped product added to a segment

• product related in product relation attribute added to a segment

attributeStream

• attribute created

• attribute property updated

  • name

  • metadata

  • option added, modified, or removed from an attribute

  • unit attribute unit

  • price attribute currency

  • textarea attribute richEdit property

categoryStream

• category created

• category property updated

  • name

  • attribute value

categoryTreeStream

• category tree created

• category tree property updated

  • name

  • category tree structure

multimediaStream

• multimedia created

• multimedia property updated

  • name

  • folder assignment

General

• 128f9cb0-28bd-4843-a570-d2bd4671c495 The resource is referenced from other resources.

• e78b3ed7-db49-4e81-9f29-ecc2985072f4 Currency is not supported.

• 79876042-fe47-4035-ba10-ce07706433fd Template with given TemplateCode does not exist.

• 4b5f8783-1273-4ddb-8e05-e0ecf685d924 Unit with given UnitName does not exist.

• 9ff3fdc4-b214-49db-8718-39c315e33d45 Too short input value.

• d94b19cc-114f-4f44-9cc4-4138e80a87b9 Too long input value.

• c1051bb4-d103-4f74-8988-acbcafc7fdc3 The input value cannot be blank.

• ea4e51d1-3342-48bd-87f1-9e672cd90cad The numeric value is too low.

• 1a9da513-2640-4f84-9b6a-4d99dcddc628 Value is not a valid date format.

• d6d40d78-bf28-4773-8c0d-4411be1e8fa6 Translation language is not active.

• 756b1212-697c-468d-a9ad-50dd783bb169 Too many elements in a collection.

• 491b2811-7e4d-49f7-adbe-a42622031f1c Language has to be passed when setting a value for local scope Attribute.

• 786446ad-32b8-40a9-9bb5-e5445196ffd5 Value is not unique for the given attribute.

• a16b966e-e884-4075-9de7-4720cad1022a Value does not match Regex.

• aa82dbed-9098-4d4b-af22-3a0dde5d47bb Multimedia extension is not acceptable.

• e47e5afd-c7ef-4a5d-bb3e-0076269951d4 Value contains banned words.

• 25db6569-d15d-41a2-a32d-61b67308d285 Attribute code has to represent a unique attribute.

Attribute

• 4a9205b6-8f3c-4e85-960d-9835aaa1e9ab Attribute with given AttributeCode does not exist.

• 62adb4f9-217d-4d9e-b117-0a30b4b33f3b Attribute with given AttributeCode exists already.

• 25f77355-4443-4850-b8cd-7d3ec7ef5a7a Attribute already has Option with given OptionCode.

• bc1a2fc6-4910-4e47-a3aa-1fdbcd2d364b Attribute does not contain Option with given OptionCode.

• 50084892-e811-4358-820e-f005917f769b Attribute with given AttributeCode is not valid according to context.

• 72e93c59-575a-4062-914b-5e143f2810f0 Attribute metadata limit exceeded.

• ea5e8ce4-8ab7-442d-87ca-db500cad7be2 Attribute metadata payload keys duplicates.

• 7cc10e50-3d49-43c6-a847-3b8363f9ed83 Invalid attribute scope.

Category

• 6d2e1555-7d1b-47a7-8d2d-47ea2e33bfe6 Category with given CategoryCode does not exist.

• ef49c353-7fec-4f5a-beb7-47d392606a15 Category with given CategoryCode exists already.

• b2943d95-24e6-4b0c-9f09-f86ea635d8cb Categories do not have Attribute enabled in configuration.

• c18fa865-07a5-4fcb-a6af-8c44b5c643bd Attribute is used in Category as value.

Multimedia

• d62579bf-6fde-4396-9f12-bc71d6394746 Multimedia exists already within MultimediaPath.

• eabcf146-a4e7-425c-999f-9e04a6c8a988 Multimedia with given MultimediaPath does not exist.

• 9670b62d-5db8-4de8-81bd-7d6119625df0 Multimedia file should be an image.

• df8637af-d466-48c6-a59d-e7126250a654 Multimedia file uploaded is too large.

• dd4722d6-9371-42a2-9c35-87b2a03009e7 Multimedia file uploaded extension is not supported.

• 9465e18e-be76-46e8-ab9f-1db22426ab06 Multimedia file is corrupted and its extension does not match MIME type.

• ef0dd12b-f075-4bbb-8535-4f299452cf30 Multimedia with the given extension in MultimediaName does not match the Multimedia file MIME type.

• d64f83eb-32ae-48f6-a46d-ffa4fcba6ee3 MultimediaFolder with given MultimediaFolderPath does not exist.

• 54c25a35-59da-4215-aa61-997bb80d303f MultimediaFolder with given MultimediaFolderPath exists already.

Product

• bb87ccb2-0433-40d9-976d-f4f388299840 Product relation cannot reference self.

• a339fa44-2bf8-48df-84a5-ad83a4ba74be Product type is invalid.

• 01b70d39-8e58-4406-a1c8-f63d84f29af6 Product with given Sku does not exist.

• c63cc7a9-1298-4520-a5ad-6c0a9c478a00 Product with given Sku exists already.

• 7e270f10-73b7-4b82-991f-80bda5bc70a3 VariableProduct needs to have bindings in order to add variants.

• d3209a3d-23a5-4c53-bf6b-4b72cd42d376 Product cannot be added as a VariableProduct variant as do not have the required attributes.

• 18b2cb49-313d-4251-96bd-e031351a95b8 VariableProduct has variants already and its binding attributes cannot be changed.

• 3b96fc99-792e-4698-aee1-a3d95ad97b05 Product attribute value is a bond to VariableProduct and cannot be changed.

• 0786e099-07ce-4b4e-bf92-d04442c130e5 Another Product is bonded to VariableProduct with the same set of value of binding attributes.

• bfff5187-1ac6-45f8-8516-7d59ab030c09 Cannot remove attribute value as it's a binding attribute.

• 72b36b5b-5c2f-44c6-85f3-ecadc04ea1b3 Product is already a Variant.

• 6406a966-10e9-4096-abfd-bf6764909fd2 Product does not have given child.

Attribute

An attribute represents a type of value that can be assigned to a product.

Fields:

Implemented by:

AttributeValue

Represents a value defining a specific attribute.

Fields:

Implemented by:

AttributeValueTranslation

Represents a translated attribute value for language.

Fields:

Implemented by:

CustomField

A custom field represents a type of value that can be assigned to an attribute option.

Fields:

Implemented by:

CustomFieldTranslatedValue

Represents a value defining a specific CustomField in specific language only.

Fields:

Implemented by:

CustomFieldValue

Represents a value defining a specific CustomField.

Fields:

Implemented by:

CustomFieldValueTranslation

Represents a translated custom field value for language.

Fields:

Implemented by:

OptionAttribute

An attribute with a predefined set of values(options).

Implements:

Fields:

Implemented by:

Product

Fields:

Implemented by:

Single resource

Returns resource identified by the unique inedntifier

• product(sku: "simple_product") {…} - sku(Sku) for product

• attribute(code: "attribute_code") {...} - code(AttributeCode) for the attribute

Streams

*Stream (paginable)

Streams allow fetching the collection of resources.

Streams are designed specifically for integrations - once you create a new resource or edit existing ones, a resource is automatically transferred to the end of the stream - a given resource at a given moment is available in the stream only once. The stream gives you the power of importing resources in time without worrying about dealing with nitty-gritty details like edition date etc. As an example, we do have a product stream with the following SKUs [1, 2, 3 {endCursor}]. Once product 2 gets updated the stream will look like the following [1, 3 {endCursorFromInitialState}, 2]. Once you'd add product 4 again the stream would look like [1, 3 {endCursorFromInitialState}, 2, 4]. Thanks to using this powerful design of the cursor approach and our providing method you are sure you don't miss a resource once fetching continuously unlike it's risky on classic paginal collections.

• productStream(first: 1, after: “cursor”) {…}

Lists

*List (paginable)

Lists allow fetching the collection(list) of the resources.

The list should always be fetched and updated entirely at once. The list represents finite resources not growing in time.

• languageList(first: 1, after: "cursor") {…}

• Product.attributeList

Collections

Usually available from other resources levels i.e. bindings of the variable product

• VariableProduct.bindings

Every API resource is presented in the current state at the moment of fetching.

Alternatively, in order to obtain the full types definition download the schema

or just query the API:

{
  __schema {
    queryType {
      name
    }
    mutationType {
      name
    }
    subscriptionType {
      name
    }
    types {
      ...FullType 
    }
    directives {
      name
      description
      locations
      args {
        ...InputValue 
      }
    }
  }
}
fragment FullType on __Type {
  kind
  name
  description
  fields(includeDeprecated: true) {
    name
    description
    args {
      ...InputValue 
    } 
    type {
      ...TypeRef
    }
    isDeprecated
    deprecationReason
  }
  inputFields {
    ...InputValue
  }
  interfaces {
    ...TypeRef
  }
  enumValues(includeDeprecated: true) {
    name
    description
    isDeprecated
    deprecationReason
  }
  possibleTypes {
    ...TypeRef 
  }
}
fragment InputValue on __InputValue {
  name
  description
  type {
    ...TypeRef 
  }
  defaultValue
}
fragment TypeRef on __Type {
  kind
  name
  ofType {
    kind
    name
    ofType {
      kind
      name
      ofType {
        kind
        name
        ofType
        {
          kind
          name
          ofType {
            kind
            name
            ofType {
              kind
              name
              ofType {
                kind
                name
              }
            }
          }
        }
      }
    }
  }
}

Types reference:

attribute

Finds an Attribute.

Arguments:

attributeDeletedStream

Arguments:

attributeOptionList

Provides a list of attribute options.

Arguments:

attributeStream

Arguments:

category

Finds a Category.

Arguments:

categoryAttributeList

Provides a list of attributes allowed to be used in a category.

Arguments:

categoryDeletedStream

Arguments:

categoryStream

Arguments:

categoryTree

Finds a CategoryTree.

Arguments:

categoryTreeDeletedStream

Arguments:

categoryTreeStream

Arguments:

languageList

Provides a list of active languages.

Arguments:

multimedia

Finds a Multimedia.

Arguments:

multimediaFolder

Finds a MultimediaFolder.

Arguments:

multimediaFolderList

Provides a list of multimedia folders.

Arguments:

multimediaStream

Arguments:

product

Finds a Product.

Arguments:

productByUniqueAttribute

Finds a Product by unique attribute value.

Arguments:

productDeletedStream

Arguments:

productStream

Arguments:

productVariantParent

Finds a parent VariableProduct identified by variant Sku.

Arguments:

section

Finds a Section.

Arguments:

sectionList

Provides a list of sections.

Arguments:

template

Finds a Template.

Arguments:

templateList

Provides a list of templates.

Arguments:

At Ergonode we strive to make your integration process as fluent as possible but from time to time we discover a flaw in the design of the schema or introduce a really cool new feature that is impossible to be provided in a fully-compatible non-breaking way.

In such a situation, we will always aim to not break your integration with the new release and provide you with a transition period of approximately 3-months to adjust your consumer. Every such change shall be communicated in the following list.

2023-08-23

Breaking change scheduled for 04-2024

• MultiSelectAttribute.options is going to be removed

• SelectAttribute.options is going to be removed

2023-05-08

Breaking change scheduled for 09-2023

• MultimediaCreateInput.folderName is going to be removed

• Mutation.multimediaSetFolder is going to be removed

2022-09-26

Breaking changes scheduled for 02-2023

• AttributeValue.valueTranslations is going to be removed

2022-08-09

Breaking changes scheduled for 12-2022

• Attribute.label is going to be removed

• Option.label is going to be removed

• OptionInput.label is going to be removed

• Mutation.attributeSetLabel is going to be removed

• label field is going to be removed from Attribute create mutation input objects

  • AttributeCreateDateInput

  • AttributeCreateFileInput

  • AttributeCreateGalleryInput

  • AttributeCreateImageInput

  • AttributeCreateMultiSelectInput

  • AttributeCreateNumericInput

  • AttributeCreatePriceInput

  • AttributeCreateProductRelationInput

  • AttributeCreateSelectInput

  • AttributeCreateTextareaInput

  • AttributeCreateTextInput

  • AttributeCreateUnitInput

2022-06-09

Breaking changes scheduled for 10-2022

• GroupingProduct.childList is going to be removed

• Template.name is going to be removed

• Template.defaultLabel is going to be removed

2022-05-04

Breaking changes scheduled for 08-2022

• TranslatedAttributeValue.inherited is going to be removed

• Query.languageTreeLeafList is going to be removed

2022-03-15

Breaking change scheduled for 07-2022

• Attribute.hint is going to be removed

• Attribute.placeholder is going to be removed

• Mutation.attributeSetHint is going to be removed

• Mutation.attributeSetPlaceholder is going to be removed

• placeholder and hint fields are going to be removed from Attribute create mutation input objects

  • AttributeCreateDateInput

  • AttributeCreateFileInput

  • AttributeCreateGalleryInput

  • AttributeCreateImageInput

  • AttributeCreateMultiSelectInput

  • AttributeCreateNumericInput

  • AttributeCreatePriceInput

  • AttributeCreateProductRelationInput

  • AttributeCreateSelectInput

  • AttributeCreateTextareaInput

  • AttributeCreateTextInput

  • AttributeCreateUnitInput

2022-01-31

Breaking change scheduled for 05-2022

• Option.attribute is going to be removed

2022-01-18

Breaking change scheduled for 05-2022

• AttributeValue.value is going to be removed

• AttributeValue.code is going to be removed

2024-11-21

• Query.productVariantParent added

• Product.status added

• Mutation.productSetStatus added

2024-10-16

• Query.productByUniqueAttribute added

2024-07-15

• ProductAddAttributeValueTranslationsProductRelationInput.twoWayRelation added

2024-06-25

• Mutation.multimediaFolderDelete added

• Query.attributeOptionList added

2024-04-16

• MultiSelectAttribute.options removed

• SelectAttribute.options removed

2024-01-25

• OptionAttribute.optionList argument codes added

• Template.sectionList added

• Query.section added

• Query.sectionList added

• Query.template added

2023-12-20

• OptionAttribute interface added

• SelectAttribute implements OptionAttribute

• MultiSelectAttribute implements OptionAttribute

• OptionAttribute.customFields added

• Option.customFields added

• Mutation.attributeOptionAddCustomFieldImage added

• Mutation.attributeOptionAddCustomFieldText added

• Mutation.attributeOptionAddCustomFieldTextarea added

• Mutation.attributeOptionAddCustomFieldTextareaRTE added

• Mutation.attributeOptionAddOptionCustomFieldValueTranslationsImage added

• Mutation.attributeOptionAddOptionCustomFieldValueTranslationsText added

• Mutation.attributeOptionAddOptionCustomFieldValueTranslationsTextarea added

• Mutation.attributeOptionAddOptionCustomFieldValueTranslationsTextareaRTE added

• Mutation.attributeOptionDeleteCustomField added

• Mutation.attributeOptionDeleteOptionCustomFieldValueTranslations added

2023-09-07

• Query.multimediaFolder added

• MultimediaFolderCreateInput.createFolderPath added

• MultimediaCreateInput.folderName removed

• Mutation.multimediaSetFolder removed

2023-08-23

• MultiSelectAttribute.optionList added

• MultiSelectAttribute.options becomes deprecated. Use MultiSelectAttribute.optionList instead

• SelectAttribute.optionList added

• SelectAttribute.options becomes deprecated. Use SelectAttribute.optionList instead

• Mutation.attributeMultiSelectAddOption added

• Mutation.attributeMultiSelectDeleteOption added

• Mutation.attributeMultiSelectSetOptionName added

• Mutation.attributeSelectAddOption added

• Mutation.attributeSelectDeleteOption added

• Mutation.attributeSelectSetOptionName added

• Mutation.multimediaReplace added

2023-07-25

• Query.multimedia added

2023-05-08

• MultimediaFolder.path added

• Mutation.multimediaMove added

• Mutation.multimediaFolderCreate added

• MultimediaCreateInput.folderPath added

• MultimediaCreateInput.folderName becomes deprecated. If passed together with folderPath this argument becomes disregarded

• Mutation.multimediaSetFolder becomes deprecated

2023-04-17

• MultiSelectAttributeValueTranslation.translatedValue added

• SelectAttributeValueTranslation.translatedValue added

2023-02-28

• AttributeValue.valueTranslations removed

• TextareaAttributeValueTranslation.rawValue added

2023-02-22

• Attribute.metadata added

• Mutation.attributeAddMetadata added

• Mutation.attributeDeleteMetadata added

2023-02-14

• Mutation.multimediaSetFolder added

2022-12-21

• Query.categoryAttributeList added

• Mutation.categoryAttributeAddAttribute added

• Mutation.categoryAttributeRemoveAttribute added

2022-12-07

• Mutation.attributeSetLabel removed

• OptionInput.label removed

• Option.label removed

• Attribute.label removed

• label removed from Attribute create mutation input objects

  • AttributeCreateDateInput

  • AttributeCreateFileInput

  • AttributeCreateGalleryInput

  • AttributeCreateImageInput

  • AttributeCreateMultiSelectInput

  • AttributeCreateNumericInput

  • AttributeCreatePriceInput

  • AttributeCreateProductRelationInput

  • AttributeCreateSelectInput

  • AttributeCreateTextareaInput

  • AttributeCreateTextInput

  • AttributeCreateUnitInput

2022-11-09

• Category.attributeList added

• Mutation.categoryDeleteAttributeValueTranslations added

• Mutation.categoryAddAttributeValueTranslationsText added

• Mutation.categoryAddAttributeValueTranslationsTextarea added

• Mutation.categoryAddAttributeValueTranslationsNumeric added

• Mutation.categoryAddAttributeValueTranslationsPrice added

• Mutation.categoryAddAttributeValueTranslationsUnit added

• Mutation.categoryAddAttributeValueTranslationsImage added

• Mutation.categoryAddAttributeValueTranslationsGallery added

• Mutation.categoryAddAttributeValueTranslationsFile added

• Mutation.categoryAddAttributeValueTranslationsProductRelation added

• Mutation.categoryAddAttributeValueTranslationsDate added

• Mutation.categoryAddAttributeValueTranslationsSelect added

• Mutation.categoryAddAttributeValueTranslationsMultiSelect added

• GroupingProduct.childList removed

• Template.name removed

• Template.defaultLabel removed

2022-10-19

• MultimediaCreateInput.folderName added

2022-09-26

• AttributeValue.translations added - represents the translation value type per Attribute type. MultiSelectAttributeValue and SelectAttributeValue instead of simple OptionCode provides entire Option

• AttributeValue.valueTranslations becomes deprecated

• AttributeValue implementations per Attribute type added

2022-08-11

• TranslatedAttributeValue.inherited removed

• Query.languageTreeLeafList removed

2022-08-09

• Template.attributeList added

• Query.templateList added

• Attribute.name added - represents the same value as Attribute.label field

• Attribute.label becomes deprecated

• Option.name added - represents the same value as Option.label field

• Option.label becomes deprecated

• OptionInput.name added

  • if passed together with label field it takes precedence

• Mutation.attributeSetName added

• Mutation.attributeSetLabel becomes deprecated

• name field added in Attribute create mutation input objects. It replaces label field. If passed together with it name takes precedence

  • AttributeCreateDateInput

  • AttributeCreateFileInput

  • AttributeCreateGalleryInput

  • AttributeCreateImageInput

  • AttributeCreateMultiSelectInput

  • AttributeCreateNumericInput

  • AttributeCreatePriceInput

  • AttributeCreateProductRelationInput

  • AttributeCreateSelectInput

  • AttributeCreateTextareaInput

  • AttributeCreateTextInput

  • AttributeCreateUnitInput

2022-08-01

• Attribute.hint removed

• Attribute.placeholder removed

• Mutation.attributeSetHint removed

• Mutation.attributeSetPlaceholder removed

• placeholder and hint fields removed from Attribute create mutation input objects

  • AttributeCreateDateInput

  • AttributeCreateFileInput

  • AttributeCreateGalleryInput

  • AttributeCreateImageInput

  • AttributeCreateMultiSelectInput

  • AttributeCreateNumericInput

  • AttributeCreatePriceInput

  • AttributeCreateProductRelationInput

  • AttributeCreateSelectInput

  • AttributeCreateTextareaInput

  • AttributeCreateTextInput

  • AttributeCreateUnitInput

2022-07-14

• Multimedia.title added

• Mutation.multimediaSetTitle added

2022-06-09

• ProductGroupingAddChildInput.quantity added

• Mutation.productGroupingSetChildQuantity added

• GroupingProduct.childrenList added

• GroupingProduct.childList becomes deprecated

• Template.name becomes deprecated

• Template.defaultLabel becomes deprecated

2022-05-10

• AttributeValue.code removed

• AttributeValue.value removed

• Option.attribute removed

2022-05-04

• TranslatedAttributeValue.inherited becomes deprecated

• Query.languageTree becomes deprecated

• Query.languageList added

• language field becomes nullable for(valid for global attributes only)

  • DateValueTranslationInput

  • FileValueTranslationInput

  • GalleryValueTranslationInput

  • ImageValueTranslationInput

  • MultiSelectValueTranslationInput

  • NumericValueTranslationInput

  • PriceValueTranslationInput

  • ProductRelationValueTranslationInput

  • SelectValueTranslationInput

  • TextareaValueTranslationInput

  • TextValueTranslationInput

  • UnitValueTranslationInput

2022-03-15

• Attribute.hint becomes deprecated

• Attribute.placeholder becomes deprecated

• Mutation.attributeSetHint becomes deprecated

• Mutation.attributeSetPlaceholder becomes deprecated

2022-01-31

• Option.attribute becomes deprecated

2022-01-18

• AttributeValue.valueTranslations added

• AttributeValue.value becomes deprecated

2022-01-04

• Mutation schema has been added to the API. For a full list of mutations available use an introspection

  • every existing API key has preserved its read access but did not receive write access. In order to obtain write access create a new key with it

GroupedProductProduct

Represents a product grouped in GroupingProduct.

Types:

attributeAddMetadata

Adds Attribute metadata.

Input fields:

attributeCreateDate

Creates DateAttribute

Input fields:

attributeCreateFile

Creates FileAttribute

Input fields:

attributeCreateGallery

Creates GalleryAttribute

Input fields:

attributeCreateImage

Creates ImageAttribute

Input fields:

attributeCreateMultiSelect

Creates MultiSelectAttribute

Input fields:

attributeCreateNumeric

Creates NumericAttribute

Input fields:

attributeCreatePrice

Creates PriceAttribute

Input fields:

attributeCreateProductRelation

Creates ProductRelationAttribute

Input fields:

attributeCreateSelect

Creates SelectAttribute

Input fields:

attributeCreateTextarea

Creates TextareaAttribute

Input fields:

attributeCreateText

Creates TextAttribute

Input fields:

attributeCreateUnit

Creates UnitAttribute

Input fields:

attributeDateSetFormat

Sets a DateAttribute format.

Input fields:

attributeDelete

Deletes Attribute.

Input fields:

attributeDeleteMetadata

Deletes Attribute metadata.

Input fields:

attributeMultiSelectAddOption

Adds a MultiSelectAttribute option.

Input fields:

attributeMultiSelectDeleteOption

Deletes a MultiSelectAttribute option.

Input fields:

attributeMultiSelectSetOptionName

Sets a MultiSelectAttribute option name.

Input fields:

attributeMultiSelectSetOptions

Sets a MultiSelectAttribute options.

Input fields:

attributeOptionAddCustomFieldImage

Adds a custom field to OptionAttribute.

Input fields:

attributeOptionAddCustomFieldTextarea

Adds a custom field to OptionAttribute.

Input fields:

attributeOptionAddCustomFieldTextareaRTE

Adds a custom field to OptionAttribute.

Input fields:

attributeOptionAddCustomFieldText

Adds a custom field to OptionAttribute.

Input fields:

attributeOptionAddOptionCustomFieldValueTranslationsImage

Adds custom field value translations to an Option.

Input fields:

attributeOptionAddOptionCustomFieldValueTranslationsTextarea

Adds custom field value translations to an Option.

Input fields:

attributeOptionAddOptionCustomFieldValueTranslationsTextareaRTE

Adds custom field value translations to an Option.

Input fields:

attributeOptionAddOptionCustomFieldValueTranslationsText

Adds custom field value translations to an Option.

Input fields:

attributeOptionDeleteCustomField

Deletes custom field from an OptionAttribute.

Input fields:

attributeOptionDeleteOptionCustomFieldValueTranslations

Deletes custom field value translations from a Option.

Input fields:

attributePriceSetCurrency

Sets a PriceAttribute currency.

Input fields:

attributeSelectAddOption

Adds a SelectAttribute option.

Input fields:

attributeSelectDeleteOption

Deletes a SelectAttribute option.

Input fields:

attributeSelectSetOptionName

Sets a SelectAttribute option name.

Input fields:

attributeSelectSetOptions

Sets a SelectAttribute options.

Input fields:

attributeSetName

Sets Attribute name.

Input fields:

attributeTextareaSetRichEdit

Sets a TextareaAttribute richEdit.

Input fields:

attributeUnitSetUnit

Sets an UnitAttribute unit.

Input fields:

categoryAddAttributeValueTranslationsDate

Adds a DateAttribute value translations to a category.

Input fields:

categoryAddAttributeValueTranslationsFile

Adds a FileAttribute value translations to a category.

Input fields:

categoryAddAttributeValueTranslationsGallery

Adds a GalleryAttribute value translations to a category.

Input fields:

categoryAddAttributeValueTranslationsImage

Adds a ImageAttribute value translations to a category.

Input fields:

categoryAddAttributeValueTranslationsMultiSelect

Adds a MultiSelectAttribute value translations to a category.

Input fields:

categoryAddAttributeValueTranslationsNumeric

Adds a NumericAttribute value translations to a category.

Input fields:

categoryAddAttributeValueTranslationsPrice

Adds a PriceAttribute value translations to a category.

Input fields:

categoryAddAttributeValueTranslationsProductRelation

Adds a ProductRelationAttribute value translations to a category.

Input fields:

categoryAddAttributeValueTranslationsSelect

Adds a SelectAttribute value translations to a category.

Input fields:

categoryAddAttributeValueTranslationsTextarea

Adds a TextareaAttribute value translations to a category.

Input fields:

categoryAddAttributeValueTranslationsText

Adds a TextAttribute value translations to a category.

Input fields:

categoryAddAttributeValueTranslationsUnit

Adds a UnitAttribute value translations to a category.

Input fields:

categoryAttributeAddAttribute

Adds an Attribute as allowed to be used in Category.

Input fields:

categoryAttributeRemoveAttribute

Removes an Attribute as allowed to be used in Category.

Input fields:

categoryCreate

Creates a Category.

Input fields:

categoryDeleteAttributeValueTranslations

Deletes an attribute value translations from a Category.

Input fields:

categoryDelete

Deletes a Category.

Input fields:

categorySetName

Sets a Category name.

Input fields:

multimediaCreate

Creates a Multimedia.

Input fields:

multimediaDelete

Deletes a Multimedia.

Input fields:

multimediaFolderCreate

Creates a MultimediaFolder.

Input fields:

multimediaFolderDelete

Deletes a MultimediaFolder.

Input fields:

multimediaMove

Moves a Multimedia to MultimediaFolder. Multimedia.path identifier is changed as a result.

Input fields:

multimediaReplace

Replaces a Multimedia with given MultimediaPath. As a result new Multimedia is created, all relations to it are replaced with a new resource, and the existing one is deleted.

Input fields:

multimediaSetAlt

Sets a Multimedia alt.

Input fields:

multimediaSetName

Sets a Multimedia name.

Input fields:

multimediaSetTitle

Sets a Multimedia title.

Input fields:

productAddAttributeValueTranslationsDate

Adds a DateAttribute value translations to a product.

Input fields:

productAddAttributeValueTranslationsFile

Adds a FileAttribute value translations to a product.

Input fields:

productAddAttributeValueTranslationsGallery

Adds a GalleryAttribute value translations to a product.

Input fields:

productAddAttributeValueTranslationsImage

Adds a ImageAttribute value translations to a product.

Input fields:

productAddAttributeValueTranslationsMultiSelect

Adds a MultiSelectAttribute value translations to a product.

Input fields:

productAddAttributeValueTranslationsNumeric

Adds a NumericAttribute value translations to a product.

Input fields:

productAddAttributeValueTranslationsPrice

Adds a PriceAttribute value translations to a product.

Input fields:

productAddAttributeValueTranslationsProductRelation

Adds a ProductRelationAttribute value translations to a product.

Input fields:

productAddAttributeValueTranslationsSelect

Adds a SelectAttribute value translations to a product.

Input fields:

productAddAttributeValueTranslationsTextarea

Adds a TextareaAttribute value translations to a product.

Input fields:

productAddAttributeValueTranslationsText

Adds a TextAttribute value translations to a product.

Input fields:

productAddAttributeValueTranslationsUnit

Adds a UnitAttribute value translations to a product.

Input fields:

productAddCategories

Adds a product to categories.

Input fields:

productCreateGrouping

Creates a GroupingProduct.

Input fields:

productCreateSimple

Creates a SimpleProduct.

Input fields:

productCreateVariable

Creates a VariableProduct.

Input fields:

productDeleteAttributeValueTranslations

Deletes an attribute value translations from a Product.

Input fields:

productDelete

Deletes a product.

Input fields:

productGroupingAddChild

Adds a child product to a GroupingProduct.

Input fields:

productGroupingRemoveChild

Removes a child product from a GroupingProduct.

Input fields:

productGroupingSetChildQuantity

Set a child product quantity of a GroupingProduct.

Input fields:

productRemoveCategories

Removes a product from categories.

Input fields:

productSetStatus

Sets a product status.

Input fields:

productSetTemplate

Sets a product Template.

Input fields:

productVariableAddVariant

Adds a variant product to a VariableProduct.

Input fields:

productVariableRemoveVariant

Removes a variant product from a VariableProduct.

Input fields:

productVariableSetBindings

Sets binding attributes to VariableProduct.

Input fields:

AttributeCode

Boolean

Represents true or false.

CategoryCode

CategoryTreeCode

Currency

Represents a currency code in ISO 4217 format. Example: PLN.

CustomFieldCode

DateFormat

Represents a date formatted in one of the: yyyy-MM-dd, yy-MM-dd, dd.MM.yy, dd.MM.yyyy, MM/dd/yy, MM/dd/yyyy, MMMM dd, yyyy, dd MMMM yyyy, dd MMM yyyy

DateTime

Represents an ISO 8601 date. Example: 2021-04-09T17:25:26+00:00

Float

Represents signed double-precision fractional values as specified by IEEE 754.

Int

Represents non-fractional signed whole numeric values.

Language

Represents a 5 chars LCID language code. Example: pl_PL.

MetadatumKey

MultimediaFolderName

MultimediaFolderPath

MultimediaName

MultimediaPath

OptionCode

SectionCode

Sku

StatusCode

String

Represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

TemplateCode

UnitName

AttributeScope

Values:

LOCAL

Value translation is set individually in every language.

GLOBAL

Value translation is the same in every language.

TwoWayRelation

Values:

None

Do not modify related products.

New

Set backward relations to the modified product only in its newly related products. Already related products remain unmodified.

All