1 of 55

GraphQL API

This doc provides an overview of our GraphQL API which is designed specifically with data integration in mind.

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

API returns data in JSON format.

contains Queries and Mutations.

Rate limit is: 250 req / min for media, and 500 req / min for everything else. Max 6 concurrent connections.

Overview

Query types

Overview of available query and field naming concepts representing how the data is provided.

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.

Note if you have an API key created with Segment products are also transferred to the end of the stream once are added to a Segment.

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.

All paginable collections are based on the standard. According to it every Edge of the graph next to the information of the resource(node) contains a cursor that allows fetching the next resource from the collection.

Stream queries

List of factors resulting in resource cursor update

Note that some updates though potentially could be interpreted as other resource updates as well, i.e. category name changes could result in updates of both product and category tree cursors, are limited to the specific resource to limit the overall amount of updates.

This is by design since a potentially small change could cause a snowball effect - one, simple category name change, could cause the need to reimport all products in the system, etc.

Error codes

The list of possible error codes to occur in course of executing API mutations.

General

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

Schema

The entire GraphQL schema is available to fetch from the API itself. It's called .

As with every other query, introspection of the Ergonode API requires .

The simplest way to discover the GraphQL API is to use supporting HTTP clients like . On one hand, they do support scoping through documentation schema, and on the other provide autocomplete functionality which makes writing queries really straightforward.

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

or just query the API:

Types reference:

Scalars

Scalars represent primitive values like Integer or String.

AttributeCode

Represents a lowercased, alphanumerical, and _ textual identifier of 1-128 chars in length. It cannot be id or start with esa_.

Enums

Enums represent a predefined sets o values.

AttributeScope

Represents the behavior of language translation of values.

Values:

Unions

Unions represent possible many types.

GroupedProductProduct

Represents a product grouped in GroupingProduct.

Types:

CHANGELOG

Breaking changes

The list of recent and upcoming breaking changes

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

Guides

Authentication

GraphQL API requires to be authenticated in order to process requests.

In order to obtain access to API resources, an API key is required to be sent along with the appropriate GraphQL query as an HTTP header - X-API-KEY.

Keys can be created in Ergonode System Settings in the API keys tab.

Basic query tutorial

Queries in GraphQL are created by opening curly brackets.

If we have more than one query, we need to name them and specify that this is the query, we do it as follows.

An example of a simple query that will return the value of "pageInfo" from the "productStream" branch, and from there provide the value of "endCursor". Additionally, from the "productStream" branch, it will return the value "totalCount". Think of it as a tree, a branch, and a leaf. To get information from a leaf, you must first reach it by going through all the steps one by one. Each subsequent indentation must be called using the next curly bracket. Until it's closed, we are constantly working within the same space.

For better understanding, I've stretched the code below to reflect these indents.

The query can also use arguments. The list of available parameters can be found in the API schema(documentation). Here, we will use the "first" argument.

Without using this argument, the system would return all the data it finds, here we want to limit ourselves to the first 2 results.

It is also possible, to refer to the same place with several arguments, in this example we wanted to get the first 2 results and the then results after something.

However, the above query will not work without a slight modification. If to a given object we refer more than once, we must use aliases. Below I used two aliases: "firstTwo" and "dataAfter". Remember to use a colon after the alias.

Remember that in this case, the "after" filter refers to the cursor, which in this case is "YXJyYXljb25uZWN0aW9uOjM0Mw==". In your case, it will be a completely different string.

Check available cursors with a query:

Note that in the query (the previous one, not the one about available cursors) we call the same "totalCount" data 2 times unnecessarily. We can simplify this by using fragments.

The following query will return us exactly the same data as the previous one.

Of course, if I'm querying only one thing, there's no point in throwing it into a fragment.

However, if there were more objects or the query was more complicated, fragments allow us to optimize it.

In GraphQL it is also possible to use variables, variables are usually passed on by programming languages, but for the sake of completeness, I will show you how to use them.

Before the first curly bracket, I open a round bracket and define ( with the $ sign ) a variable named x in it, then I make a colon and a space and define the type of the variable, in this example, it will be Int (Integer). I could be done here, but I still would like to define a default value, so I put an equals sign followed by "2".

Then in the place where the variable should be passed I simply call it bt $x:

Queries can also use directives. In other words, conditional statements.

I'm going to add a second variable to my query named condition and set its type to Boolean, with the default value true.

Then after pageInfo I placed @include(if: $condition) directive.

Since I have previously set the default value of the $condition variable to true, the condition will be met and the data will show up, but if I change it to false, the data will not.

Batching mutations

API mutations are designed to be very small and atomic on purpose - thanks to that design, you don't have to prefetch data to send it back to the server and worry only about the actual change you want to perform.

On the other hand, occasionally your intention is to create or change resources with data that a single mutation does not handle. GraphQL comes in handy here - thanks to its design you can batch mutations(and queries) which means that multiple operations can be performed in one, single request - this not only makes it easier to make updates but also speeds up operations.

mutation {
  create: productCreateSimple(input: {sku: "new_product", templateCode: "template"}) {
    __typename
  }
  assignDescription: productAddAttributeValueTranslationsTextarea(
    input: {
      sku: "new_product"
      attributeCode: "description"
      translations: [{ value: "Long description", language: "en_GB" }]
    }
  ) {
    __typename
  }
  assignShortDescription: productAddAttributeValueTranslationsTextarea(
    input: {
      sku: "new_product"
      attributeCode: "short_description"
      translations: [{ value: "Short description", language: "en_GB" }]
    }
  ) {
    __typename
  }
}

Batch mutations are executed synchronously which also means their order does matter. You need to create the product first in order to assign values to it.

All mutations in the batch are performed one after another and if one or more fails all the others will still be tried to execute. The batch result will contain requested data from each mutation as well as specific errors which occurred for those which failed.

Note that each mutation has an alias (create: (...)) - which means a custom name is assigned to it. Aliasing is required if there are at least two same mutations in one batch - productAddAttributeValueTranslationsTextarea in this case - this behavior allows differentiation of the data in the result which in another case would not be possible.

In the above example for simplicity, all mutations have been aliased in the example but it'd also suffice to only alias duplicates.

As tempting as it may sound to make one update of all data in the system bear in mind the fact of synchronicity of the batch process - it means that the process will last as long as there are some mutations left to be executed.

In practice, it means that too-long running processes are usually more faulty and also it's harder to handle potential errors. In most extreme cases, you can even reach timeout from your HTTP client or the server can drop the handling of the request as it takes too long to process.

A usually recommended approach would be to limit the batch to a single resource(product, attribute, multimedia) or with a similar intention in mind.

Integrating data

Note: the following examples are based on the API Stream integration concept - if you are not yet familiar with it check an overview of the Query types to understand the approach.

A simple example of integrating categories into the system from scratch:

Fetch the first page of the Category stream

first parameter put on limit how many categories are fetched in one result

example response:

Fetch the next page of the Category stream

Since we received information that the next page exists data.categoryStream.pageInfo.hasNextPage=true we should request the next resource. The query is very similar to the previous one except we are passing the appropriate cursor with the request:

after parameter represents the appropriate cursor that identifies a last-fetched resource. Available as either cursor field of the node or the endCursor of PageInfo object.

example response:

we do know that there is no next page, therefore, there is nothing to fetch at the very moment. We can retry the next request(for the retrieved cursor) with i.e., an increased interval not to waste resources.

A more complex example of integrating categories

Alternatively in some systems, we will want only to fetch the identifier of the resource using some sort of queueing system in order to distribute the consumption processes. In that case, we can just fetch our resource ID (code in the case of categories) and the PageInfo object:

and fetch it in the separate consuming process via a single resource query:

The rest of the process looks the same for the paginating over the stream.

Though given above content provides an example of handling categories you can use the same approach for every other resource available via streams like products, multimedia, and attributes.

Query examples

List of products with attributes and they values in product stream

This is how you can get a list of products with ALL attribute types, if you do not need all of them, simply remove any fragment that is not needed

List of 100 grouped products with simple and variable products in stream

This will allow you to get list of first 100 product no matter if they're simple or variable.

By default, the query would return the first 50 products if no "first" argument is used.

Please remember that the limit for "first" is 200

List of active languages

List of templates with attributes

List of all multimedia in stream

This query will return all multimedia in PIM and extra info about them.

query multimedia {
  multimediaStream {
    pageInfo {
      hasNextPage
      endCursor
    }
    edges {
      __typename
      node {
        name
        path
        alt {
          value
          language
        }
        extension
        mime
        size
        folder {
          name
        }
        url
      }
    }
  }
}

List of product relations for a specific product

In this example, we're using a specific product with SKU47.

For your query please use your own.

query productRelation {
  product(sku: "001") {
    sku
    createdAt
    editedAt
    attributeList {
      pageInfo {
        hasNextPage
        endCursor
      }
      edges {
        node {
          attribute {
            code
          }
          translations {
            ... on ProductRelationAttributeValueTranslation {
              language
              value {
                sku
              }
            }
          }
        }
      }
    }
  }
}

Get values of custom fields

Example query on how to get values of custom fields options

fragment Option on Option {
    code
    name(languages: ["en_US"]) {
        value
        language
    }
    customFields {
        __typename
        customField {
            code
        }
        translations(languages: ["en_US"]) {
            language
            ... on ImageCustomFieldValueTranslation {
                imageCustomFieldValue: value {
                    path
                }
            }
            ... on TextCustomFieldValueTranslation {
                textCustomFieldValue: value
            }
            ... on TextareaCustomFieldValueTranslation {
                textareaCustomFieldValue: value
            }
            ... on TextareaRTECustomFieldValueTranslation {
                textareaRTECustomFieldValue: value
            }
        }
    }
}

Create a simple product

This is how you can create a simple product via API.

Please note that for this to work, you need to create a template beforehand. This mutation can only assign products to an already existing template, and will NOT create a new one.

You can also assign a category to the newly created product in the same query.

While templateCode is required, categoryCodes is not. But if used, also needed to be created beforehand.

Create a grouping product

This is how you can create a simple product via API.

Please note that for this to work, you need to create a template beforehand. This mutation can only assign products to an already existing template, and will NOT create a new one.

mutation {
  productCreateGrouping(
    input: { sku: "SKU_GR_PRODUCT", templateCode: "Tshirts"}
  ) {
    __typename
  }
}

You can also assign a category to the newly created product in the same query.

While templateCode is required, categoryCodes is not. But if used, also needed to be created beforehand.

mutation {
  productCreateGrouping(
    input: { sku: "SKU_GR_PRODUCT", templateCode: "Tshirts", categoryCodes: "DELL"}
  ) {
    __typename
  }
}

Create a variable product

This is how you can create variable product via API.

Please note that for this to work, you need to create a template beforehand. This mutation can only assign the product to an already existing template, and will NOT create a new one.

While templateCode is required, categoryCodes is not. But if used, also needed to be created beforehand.

mutation {
  productCreateVariable(
    input: {
      sku: "SKU_VAR_PRODUCT"
      templateCode: "Tshirts"
      categoryCodes: "DELL"
    }
  ) {
    __typename
  }
}

Add a child product to grouping one

That's how you add child product to grouping one.

Please bear in mind, that quantity isn't required and if used, cannot be a string - must be Integer (so there's no quotation mark)

Both products must exist before this operation.

Set quantity of child product

Here's how you can set child product quantity via API.

mutation {
  productGroupingSetChildQuantity(
    input: { sku: "SKU_GR_PRODUCT", childSku: "SKU_test2", quantity: 2 }
  ) {
    __typename
  }
}

Remove a child product from grouping one

This is how you remove child product from grouping one via API.

Add a variant to variable product

Here's how to add variant to variable product via API.

Both products must exist before this operation.

Get products with variants, binding attributes and variants list

query {
  productStream (first:10, after:"") {
    pageInfo {
      hasNextPage
      endCursor
    }
    edges {
      node {
        ... on VariableProduct {
          sku
          bindings {
            code
            __typename
          }
          variantList {
            edges {
              node {
                sku
              }
            }
          }
        }
      }
    }
  }
}

Remove a variant product from variable one

This is how you can remove variant product from variable one via API

mutation {
  productVariableRemoveVariant(input: { sku: "SKU_VAR_PRODUCT", variantSku: "SKU_test2" }
  ) {
    __typename
  }
}

Multimedia create

This is how you can create multimedia via API.

To create multimedia via API you need to send the data by a multipart request with upload and query headers.

The folder to which multimedia will be uploaded must already exist.

Add images to the gallery attribute

mutation {
  productAddAttributeValueTranslationsGallery(
    input: {
      sku: "1"
      attributeCode: "gallery"
      translations: [
        { language: "pl_PL", value: ["1.jpg", "2.jpg", "3.jpg"] }
      ]
    }
  ) {
    __typename
  }
}

Attribute Gallery and Product identified with SKU must already exist.

value: is the path to an image, you can get it with query "multimediaStream"

Change the name of the multimedia

This is how you can change the name of single multimedia via API.

The MultimediaPath scalar type represents a textual combination of MultimediaFolderPath, and MultimediaName joined with '/' Multimedia identifier pointing to its exact location. If the file is in the root folder you need to skip MultimediaFolderPath in path.

mutation {
  multimediaSetName(
    input: {
      path: "multimedia.jpg"
      name: "multimedia_2.jpg"
    }
  ) {
    __typename
  }
}

Set alternative value for a multimedia

This is how you can set alternative value to a single multimedia via API.

mutation {
  multimediaSetAlt(
    input: {
      path: "multimedia.jpg"
      alt: { language: "en_GB", value: "Alternative value" }
    }
  ) {
    __typename
  }
}

Delete Multimedia

mutation {
  multimediaDelete(input: { path: "multimedia.jpg" }) {
    __typename
  }
}

Add a file to the product

Product, attribute, and file must already exist

value - path to the file

The MultimediaPath scalar type represents a textual combination of MultimediaFolderName, and MultimediaName joined with '/' Multimedia identifier pointing to its exact location.

Get attributes list by SKU

This is how you can query GraphQL API on product attributes by SKU

Create a product and assign / modify attributes values

This mutation assumes that below already exists in the system:

template with code template
textarea attribute with code description
textarea attribute with code short_description
text attribute with code text
pl_PL language is active

Note that each mutation is aliased (create: (...)). Aliasing is required if there are at least two same mutations in one batch - productAddAttributeValueTranslationsTextarea in this case.

For simplicity, all mutations have been aliased in the example but it'd also suffice to only alias duplicates.

Assign the template to a product

Both sku and template must already exist.

mutation {
  productSetTemplate(input: { sku: "SKU78", template: "template" }) {
    __typename
  }
}

Create a category

code - system name of the category

language - language code ex: pl_PL

value - translated name of the category (string)

Get category tree by category tree code

Get a specific category with values of the category attribute

Remember to change "buty" with your own category code (system name)

Set multiple options in multiselect attribute on specific product

Add option to select type attribute

Please keep in mind that to add the option attribute "Model" must first exist.

query catWithAttVal { category(code: "buty") { code attributeList { pageInfo { hasNextPage endCursor } edges { node { ...AttributeValue } } } } } fragment AttributeValue on AttributeValue { __typename attribute { code name { language value } } ... on TextAttributeValue { textAttributeValueTranslations: translations { value language } } ... on TextareaAttributeValue { textareaAttributeValueTranslations: translations { value language } } ... on DateAttributeValue { dateAttributeValueTranslations: translations { value language } } ... on UnitAttributeValue { unitAttribute: attribute { # unit might be useful in the value context unit { name symbol } } unitAttributeValueTranslations: translations { value language } } ... on PriceAttributeValue { priceAttribute: attribute { # currency might be useful in the price context currency } priceAttributeValueTranslations: translations { value language } } ... on NumberAttributeValue { numericAttributeValueTranslations: translations { value language } } ... on ProductRelationAttributeValue { productRelationAttributeValueTranslations: translations { value { sku } language } } ... on FileAttributeValue { fileAttributeValueTranslations: translations { value { ...Multimedia } language } } ... on GalleryAttributeValue { galleryAttributeValueTranslations: translations { value { ...Multimedia } language } } ... on ImageAttributeValue { imageAttributeValueTranslations: translations { value { ...Multimedia } language } } ... on MultiSelectAttributeValue { multiSelectAttributeValueTranslations: translations { translatedValue { ...OptionTranslatedValue } language } } ... on SelectAttributeValue { selectAttributeValueTranslations: translations { translatedValue { ...OptionTranslatedValue } language } } } fragment Multimedia on Multimedia { path name extension mime size alt { value language } title { value language } url } fragment OptionTranslatedValue on OptionTranslatedValue { code name }

{ "data": { "product": { "sku": "0123456789", "createdAt": "2024-04-04T11:44:54+00:00", "editedAt": "2024-04-04T13:33:46+00:00", "template": { "code": "GraphQL" }, "attributeList": { "pageInfo": { "hasNextPage": false, "endCursor": "YXJyYXljb25uZWN0aW9uOjQ=" }, "edges": [ { "node": { "SelectAttributeValue": [ { "language": "en_GB", "translatedValue": { "code": "blk", "name": "Black" } }, { "language": "pl_PL", "translatedValue": { "code": "blk", "name": "Czarny" } } ] } }, { "node": { "attribute": { "name": [ { "language": "en_GB", "value": "Short description" }, { "language": "pl_PL", "value": "Krótki opis" } ] }, "TextareaAttributeValue": [ { "language": "en_GB", "value": "Short countertop description" }, { "language": "pl_PL", "value": "Krótki opis blatu" } ] } }, { "node": { "priceAttribute": { "currency": "EUR" }, "priceAttributeValue": [ { "language": "en_GB", "value": 10.1 }, { "language": "pl_PL", "value": 9.99 } ] } }, { "node": { "GalleryAttributeValue": [ { "language": "en_GB", "value": [ { "path": "semir-beige-kapinos-stopnica-narozna-33x33-g1.webp", "name": "semir-beige-kapinos-stopnica-narozna-33x33-g1.webp", "extension": "webp", "mime": "image\/webp", "sizeInBytes": 46116, "alt": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ], "title": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ] }, { "path": "[email protected]", "name": "[email protected]", "extension": "webp", "mime": "image\/webp", "sizeInBytes": 158884, "alt": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ], "title": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ] } ] }, { "language": "pl_PL", "value": [ { "path": "semir-beige-kapinos-stopnica-narozna-33x33-g1.webp", "name": "semir-beige-kapinos-stopnica-narozna-33x33-g1.webp", "extension": "webp", "mime": "image\/webp", "sizeInBytes": 46116, "alt": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ], "title": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ] }, { "path": "[email protected]", "name": "[email protected]", "extension": "webp", "mime": "image\/webp", "sizeInBytes": 158884, "alt": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ], "title": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ] } ] }, { "language": "de_DE", "value": [ { "path": "semir-beige-kapinos-stopnica-narozna-33x33-g1.webp", "name": "semir-beige-kapinos-stopnica-narozna-33x33-g1.webp", "extension": "webp", "mime": "image\/webp", "sizeInBytes": 46116, "alt": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ], "title": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ] }, { "path": "[email protected]", "name": "[email protected]", "extension": "webp", "mime": "image\/webp", "sizeInBytes": 158884, "alt": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ], "title": [ { "language": "en_GB", "value": null }, { "language": "pl_PL", "value": null } ] } ] } ] } } ] }, "__typename": "SimpleProduct" } } }

Changelog

The changelog is a list of recent changes to GraphQL API schema.

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

2023-12-20

OptionAttribute interface added
SelectAttribute implements OptionAttribute
MultiSelectAttribute implements OptionAttribute

2023-09-07

Query.multimediaFolder added
MultimediaFolderCreateInput.createFolderPath added
MultimediaCreateInput.folderName removed

2023-08-23

MultiSelectAttribute.optionList added
MultiSelectAttribute.options becomes deprecated. Use MultiSelectAttribute.optionList instead
SelectAttribute.optionList added

2023-07-25

Query.multimedia added

2023-05-08

MultimediaFolder.path added
Mutation.multimediaMove added
Mutation.multimediaFolderCreate added

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

2022-11-09

Category.attributeList added
Mutation.categoryDeleteAttributeValueTranslations added
Mutation.categoryAddAttributeValueTranslationsText added

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

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

2022-08-01

Attribute.hint removed
Attribute.placeholder removed
Mutation.attributeSetHint removed

2022-07-14

Multimedia.title added
Mutation.multimediaSetTitle added

2022-06-09

ProductGroupingAddChildInput.quantity added
Mutation.productGroupingSetChildQuantity added
GroupingProduct.childrenList added

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

2022-03-15

Attribute.hint becomes deprecated
Attribute.placeholder becomes deprecated
Mutation.attributeSetHint 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

Mutations

Mutations allow modifing data on the server.

attributeAddMetadata

Adds Attribute metadata.

Input fields:

input

Returns:

attributeCreateDate

Creates DateAttribute

Input fields:

Returns:

attributeCreateFile

Creates FileAttribute

Input fields:

Returns:

attributeCreateGallery

Creates GalleryAttribute

Input fields:

Returns:

attributeCreateImage

Creates ImageAttribute

Input fields:

Returns:

attributeCreateMultiSelect

Creates MultiSelectAttribute

Input fields:

Returns:

attributeCreateNumeric

Creates NumericAttribute

Input fields:

Returns:

attributeCreatePrice

Creates PriceAttribute

Input fields:

Returns:

attributeCreateProductRelation

Creates ProductRelationAttribute

Input fields:

Returns:

attributeCreateSelect

Creates SelectAttribute

Input fields:

Returns:

attributeCreateTextarea

Creates TextareaAttribute

Input fields:

Returns:

attributeCreateText

Creates TextAttribute

Input fields:

Returns:

attributeCreateUnit

Creates UnitAttribute

Input fields:

Returns:

attributeDateSetFormat

Sets a DateAttribute format.

Input fields:

Returns:

attributeDelete

Deletes Attribute.

Input fields:

Returns:

attributeDeleteMetadata

Deletes Attribute metadata.

Input fields:

Returns:

attributeMultiSelectAddOption

Adds a MultiSelectAttribute option.

Input fields:

Returns:

attributeMultiSelectDeleteOption

Deletes a MultiSelectAttribute option.

Input fields:

Returns:

attributeMultiSelectSetOptionName

Sets a MultiSelectAttribute option name.

Input fields:

Returns:

attributeMultiSelectSetOptions

Sets a MultiSelectAttribute options.

Input fields:

Returns:

attributeOptionAddCustomFieldImage

Adds a custom field to OptionAttribute.

Input fields:

Returns:

attributeOptionAddCustomFieldTextarea

Adds a custom field to OptionAttribute.

Input fields:

Returns:

attributeOptionAddCustomFieldTextareaRTE

Adds a custom field to OptionAttribute.

Input fields:

Returns:

attributeOptionAddCustomFieldText

Adds a custom field to OptionAttribute.

Input fields:

Returns:

attributeOptionAddOptionCustomFieldValueTranslationsImage

Adds custom field value translations to an Option.

Input fields:

Returns:

attributeOptionAddOptionCustomFieldValueTranslationsTextarea

Adds custom field value translations to an Option.

Input fields:

Returns:

attributeOptionAddOptionCustomFieldValueTranslationsTextareaRTE

Adds custom field value translations to an Option.

Input fields:

Returns:

attributeOptionAddOptionCustomFieldValueTranslationsText

Adds custom field value translations to an Option.

Input fields:

Returns:

attributeOptionDeleteCustomField

Deletes custom field from an OptionAttribute.

Input fields:

Returns:

attributeOptionDeleteOptionCustomFieldValueTranslations

Deletes custom field value translations from a Option.

Input fields:

Returns:

attributePriceSetCurrency

Sets a PriceAttribute currency.

Input fields:

Returns:

attributeSelectAddOption

Adds a SelectAttribute option.

Input fields:

Returns:

attributeSelectDeleteOption

Deletes a SelectAttribute option.

Input fields:

Returns:

attributeSelectSetOptionName

Sets a SelectAttribute option name.

Input fields:

Returns:

attributeSelectSetOptions

Sets a SelectAttribute options.

Input fields:

Returns:

attributeSetName

Sets Attribute name.

Input fields:

Returns:

attributeTextareaSetRichEdit

Sets a TextareaAttribute richEdit.

Input fields:

Returns:

attributeUnitSetUnit

Sets an UnitAttribute unit.

Input fields:

Returns:

categoryAddAttributeValueTranslationsDate

Adds a DateAttribute value translations to a category.

Input fields:

Returns:

categoryAddAttributeValueTranslationsFile

Adds a FileAttribute value translations to a category.

Input fields:

Returns:

categoryAddAttributeValueTranslationsGallery

Adds a GalleryAttribute value translations to a category.

Input fields:

Returns:

categoryAddAttributeValueTranslationsImage

Adds a ImageAttribute value translations to a category.

Input fields:

Returns:

categoryAddAttributeValueTranslationsMultiSelect

Adds a MultiSelectAttribute value translations to a category.

Input fields:

Returns:

categoryAddAttributeValueTranslationsNumeric

Adds a NumericAttribute value translations to a category.

Input fields:

Returns:

categoryAddAttributeValueTranslationsPrice

Adds a PriceAttribute value translations to a category.

Input fields:

Returns:

categoryAddAttributeValueTranslationsProductRelation

Adds a ProductRelationAttribute value translations to a category.

Input fields:

Returns:

categoryAddAttributeValueTranslationsSelect

Adds a SelectAttribute value translations to a category.

Input fields:

Returns:

categoryAddAttributeValueTranslationsTextarea

Adds a TextareaAttribute value translations to a category.

Input fields:

Returns:

categoryAddAttributeValueTranslationsText

Adds a TextAttribute value translations to a category.

Input fields:

Returns:

categoryAddAttributeValueTranslationsUnit

Adds a UnitAttribute value translations to a category.

Input fields:

Returns:

categoryAttributeAddAttribute

Adds an Attribute as allowed to be used in Category.

Input fields:

Returns:

categoryAttributeRemoveAttribute

Removes an Attribute as allowed to be used in Category.

Input fields:

Returns:

categoryCreate

Creates a Category.

Input fields:

Returns:

categoryDeleteAttributeValueTranslations

Deletes an attribute value translations from a Category.

Input fields:

Returns:

categoryDelete

Deletes a Category.

Input fields:

Returns:

categorySetName

Sets a Category name.

Input fields:

Returns:

multimediaCreate

Creates a Multimedia.

Input fields:

Returns:

multimediaDelete

Deletes a Multimedia.

Input fields:

Returns:

multimediaFolderCreate

Creates a MultimediaFolder.

Input fields:

Returns:

multimediaFolderDelete

Deletes a MultimediaFolder.

Input fields:

Returns:

multimediaMove

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

Input fields:

Returns:

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:

Returns:

multimediaSetAlt

Sets a Multimedia alt.

Input fields:

Returns:

multimediaSetName

Sets a Multimedia name.

Input fields:

Returns:

multimediaSetTitle

Sets a Multimedia title.

Input fields:

Returns:

productAddAttributeValueTranslationsDate

Adds a DateAttribute value translations to a product.

Input fields:

Returns:

productAddAttributeValueTranslationsFile

Adds a FileAttribute value translations to a product.

Input fields:

Returns:

productAddAttributeValueTranslationsGallery

Adds a GalleryAttribute value translations to a product.

Input fields:

Returns:

productAddAttributeValueTranslationsImage

Adds a ImageAttribute value translations to a product.

Input fields:

Returns:

productAddAttributeValueTranslationsMultiSelect

Adds a MultiSelectAttribute value translations to a product.

Input fields:

Returns:

productAddAttributeValueTranslationsNumeric

Adds a NumericAttribute value translations to a product.

Input fields:

Returns:

productAddAttributeValueTranslationsPrice

Adds a PriceAttribute value translations to a product.

Input fields:

Returns:

productAddAttributeValueTranslationsProductRelation

Adds a ProductRelationAttribute value translations to a product.

Input fields:

Returns:

productAddAttributeValueTranslationsSelect

Adds a SelectAttribute value translations to a product.

Input fields:

Returns:

productAddAttributeValueTranslationsTextarea

Adds a TextareaAttribute value translations to a product.

Input fields:

Returns:

productAddAttributeValueTranslationsText

Adds a TextAttribute value translations to a product.

Input fields:

Returns:

productAddAttributeValueTranslationsUnit

Adds a UnitAttribute value translations to a product.

Input fields:

Returns:

productAddCategories

Adds a product to categories.

Input fields:

Returns:

productCreateGrouping

Creates a GroupingProduct.

Input fields:

Returns:

productCreateSimple

Creates a SimpleProduct.

Input fields:

Returns:

productCreateVariable

Creates a VariableProduct.

Input fields:

Returns:

productDeleteAttributeValueTranslations

Deletes an attribute value translations from a Product.

Input fields:

Returns:

productDelete

Deletes a product.

Input fields:

Returns:

productGroupingAddChild

Adds a child product to a GroupingProduct.

Input fields:

Returns:

productGroupingRemoveChild

Removes a child product from a GroupingProduct.

Input fields:

Returns:

productGroupingSetChildQuantity

Set a child product quantity of a GroupingProduct.

Input fields:

Returns:

productRemoveCategories

Removes a product from categories.

Input fields:

Returns:

productSetStatus

Sets a product status.

Input fields:

Returns:

productSetTemplate

Sets a product Template.

Input fields:

Returns:

productVariableAddVariant

Adds a variant product to a VariableProduct.

Input fields:

Returns:

productVariableRemoveVariant

Removes a variant product from a VariableProduct.

Input fields:

Returns:

productVariableSetBindings

Sets binding attributes to VariableProduct.

Input fields:

Returns:

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

AttributeCreateDateInput

Input fields:

AttributeCreateFileInput

Input fields:

AttributeCreateGalleryInput

Input fields:

AttributeCreateImageInput

Input fields:

AttributeCreateMultiSelectInput

Input fields:

AttributeCreateNumericInput

Input fields:

AttributeCreatePriceInput

Input fields:

AttributeCreateProductRelationInput

Input fields:

AttributeCreateSelectInput

Input fields:

AttributeCreateTextareaInput

Input fields:

AttributeCreateTextInput

Input fields:

AttributeCreateUnitInput

Input fields:

AttributeDateSetFormatInput

Input fields:

AttributeDeleteInput

Input fields:

AttributeDeleteMetadataInput

Input fields:

AttributeMultiSelectAddOptionInput

Input fields:

AttributeMultiSelectDeleteOptionInput

Input fields:

AttributeMultiSelectSetOptionNameInput

Input fields:

AttributeMultiSelectSetOptionsInput

Input fields:

AttributeOptionAddCustomFieldImageInput

Input fields:

AttributeOptionAddCustomFieldTextareaInput

Input fields:

AttributeOptionAddCustomFieldTextareaRTEInput

Input fields:

AttributeOptionAddCustomFieldTextInput

Input fields:

AttributeOptionAddOptionCustomFieldValueTranslationsImageInput

Input fields:

AttributeOptionAddOptionCustomFieldValueTranslationsTextareaInput

Input fields:

AttributeOptionAddOptionCustomFieldValueTranslationsTextareaRTEInput

Input fields:

AttributeOptionAddOptionCustomFieldValueTranslationsTextInput

Input fields:

AttributeOptionDeleteCustomFieldInput

Input fields:

AttributeOptionDeleteOptionCustomFieldValueTranslationsInput

Input fields:

AttributeOptionListFilterInput

Input fields:

AttributePriceSetCurrencyInput

Input fields:

AttributeSelectAddOptionInput

Input fields:

AttributeSelectDeleteOptionInput

Input fields:

AttributeSelectSetOptionNameInput

Input fields:

AttributeSelectSetOptionsInput

Input fields:

AttributeSetNameInput

Input fields:

AttributeTextareaSetRichEditInput

Input fields:

AttributeUnitSetUnitInput

Input fields:

CategoryAddAttributeValueTranslationsDateInput

Input fields:

CategoryAddAttributeValueTranslationsFileInput

Input fields:

CategoryAddAttributeValueTranslationsGalleryInput

Input fields:

CategoryAddAttributeValueTranslationsImageInput

Input fields:

CategoryAddAttributeValueTranslationsMultiSelectInput

Input fields:

CategoryAddAttributeValueTranslationsNumericInput

Input fields:

CategoryAddAttributeValueTranslationsPriceInput

Input fields:

CategoryAddAttributeValueTranslationsProductRelationInput

Input fields:

CategoryAddAttributeValueTranslationsSelectInput

Input fields:

CategoryAddAttributeValueTranslationsTextareaInput

Input fields:

CategoryAddAttributeValueTranslationsTextInput

Input fields:

CategoryAddAttributeValueTranslationsUnitInput

Input fields:

CategoryAttributeAddAttributeInput

Input fields:

CategoryAttributeRemoveAttributeInput

Input fields:

CategoryCreateInput

Input fields:

CategoryDeleteAttributeValueTranslationsInput

Input fields:

CategoryDeleteInput

Input fields:

CategorySetNameInput

Input fields:

DateValueTranslationInput

Input fields:

FileValueTranslationInput

Input fields:

GalleryValueTranslationInput

Input fields:

ImageCustomFieldValueTranslationInput

Input fields:

ImageValueTranslationInput

Input fields:

MetadatumInput

Input fields:

MultimediaCreateInput

Input fields:

MultimediaDeleteInput

Input fields:

MultimediaFolderCreateInput

Input fields:

MultimediaFolderDeleteInput

Input fields:

MultimediaMoveInput

Input fields:

MultimediaReplaceInput

Input fields:

MultimediaSetAltInput

Input fields:

MultimediaSetNameInput

Input fields:

MultimediaSetTitleInput

Input fields:

MultiSelectValueTranslationInput

Input fields:

NumericValueTranslationInput

Input fields:

OptionInput

Input fields:

PriceValueTranslationInput

Input fields:

ProductAddAttributeValueTranslationsDateInput

Input fields:

ProductAddAttributeValueTranslationsFileInput

Input fields:

ProductAddAttributeValueTranslationsGalleryInput

Input fields:

ProductAddAttributeValueTranslationsImageInput

Input fields:

ProductAddAttributeValueTranslationsMultiSelectInput

Input fields:

ProductAddAttributeValueTranslationsNumericInput

Input fields:

ProductAddAttributeValueTranslationsPriceInput

Input fields:

ProductAddAttributeValueTranslationsProductRelationInput

Input fields:

ProductAddAttributeValueTranslationsSelectInput

Input fields:

ProductAddAttributeValueTranslationsTextareaInput

Input fields:

ProductAddAttributeValueTranslationsTextInput

Input fields:

ProductAddAttributeValueTranslationsUnitInput

Input fields:

ProductAddCategoriesInput

Input fields:

ProductCreateGroupingInput

Input fields:

ProductCreateSimpleInput

Input fields:

ProductCreateVariableInput

Input fields:

ProductDeleteAttributeValueTranslationsInput

Input fields:

ProductDeleteInput

Input fields:

ProductGroupingAddChildInput

Input fields:

ProductGroupingRemoveChildInput

Input fields:

ProductGroupingSetChildQuantityInput

Input fields:

ProductRelationValueTranslationInput

Input fields:

ProductRemoveCategoriesInput

Input fields:

ProductSetStatusInput

Input fields:

ProductSetTemplateInput

Input fields:

ProductVariableAddVariantInput

Input fields:

ProductVariableRemoveVariantInput

Input fields:

ProductVariableSetBindingsInput

Input fields:

SelectValueTranslationInput

Input fields:

TextareaCustomFieldValueTranslationInput

Input fields:

TextareaRTECustomFieldValueTranslationInput

Input fields:

TextareaValueTranslationInput

Input fields:

TextCustomFieldValueTranslationInput

Input fields:

TextValueTranslationInput

Input fields:

TranslatedStringFilterInput

Input fields:

TranslatedStringInput

Input fields:

UnitValueTranslationInput

Input fields:

Objects

Objects represent the resources you can access.

AttributeAddMetadataPayload

A payload for a mutation.

Fields:

attribute

Changed Attribute.

AttributeConnection

The connection for

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

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

Fields:

AttributeValueEdge

An edge in a connection.

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

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

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

Fields:

CategoryTreeDeletedConnection

The connection for

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

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 with a specific quantity for the set.

Fields:

GroupedProductConnection

The connection for

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

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

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

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

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

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

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:

ProductSetStatusPayload

A payload for a mutation.

Fields:

ProductSetTemplatePayload

A payload for a mutation.

Fields:

ProductStatus

A product status.

Fields:

ProductStatusTranslation

A product status translation.

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

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

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:

GraphQL API

GraphQL API

Overview

Query types

Single resource

Streams

Lists

Collections

Stream queries

Error codes

General

Schema

Scalars

AttributeCode

Enums

AttributeScope

Unions

GroupedProductProduct

CHANGELOG

Breaking changes

2023-08-23

Guides

Authentication

Basic query tutorial

Batching mutations

Integrating data

A simple example of integrating categories into the system from scratch:

Fetch the first page of the Category stream

Fetch the next page of the Category stream

A more complex example of integrating categories

Query examples

List of products with attributes and they values in product stream

List of 100 grouped products with simple and variable products in stream

List of active languages

List of templates with attributes

List of all multimedia in stream

List of product relations for a specific product

Get values of custom fields

Create a simple product

Create a grouping product

Create a variable product

Add a child product to grouping one

Set quantity of child product

Remove a child product from grouping one

Add a variant to variable product

Get products with variants, binding attributes and variants list

Remove a variant product from variable one

Multimedia create

Add images to the gallery attribute

Change the name of the multimedia

Set alternative value for a multimedia

Delete Multimedia

Add a file to the product

Get attributes list by SKU

Create a product and assign / modify attributes values

Assign the template to a product

Create a category

Get category tree by category tree code

Get a specific category with values of the category attribute

Set multiple options in multiselect attribute on specific product

Add option to select type attribute

GraphQL API

Query types

Single resource

Streams

Lists

Collections

Stream queries

attributeStream

categoryStream

categoryTreeStream

multimediaStream

Set quantity of child product

Add images to the gallery attribute

Create a variable product

Assign the template to a product

Remove a variant product from variable one

Delete Multimedia

Get products with variants, binding attributes and variants list

Change the name of the multimedia