LogoLogo
User ManualChangelogRoadmapAboutYouTube
GraphQL API
GraphQL API
  • GraphQL API
  • Overview
    • Query types
      • Stream queries
    • Error codes
    • Schema
      • Queries
      • Mutations
      • Objects
      • Interfaces
      • Scalars
      • Input objects
      • Enums
      • Unions
  • CHANGELOG
    • Changelog
    • Breaking changes
  • Guides
    • Authentication
    • Basic query tutorial
    • Batching mutations
    • Integrating data
  • Query examples
    • List of products with attributes and they values in product stream
    • Get information about specific product and specific attribute values in specific language
    • List of 100 grouped products with simple and variable products in stream
    • List of grouped products with simple and variable products AFTER some end cursor
    • 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
Powered by GitBook
On this page
  • attribute
  • attributeDeletedStream
  • attributeOptionList
  • attributeStream
  • category
  • categoryAttributeList
  • categoryDeletedStream
  • categoryStream
  • categoryTree
  • categoryTreeDeletedStream
  • categoryTreeStream
  • languageList
  • multimedia
  • multimediaFolder
  • multimediaFolderList
  • multimediaStream
  • product
  • productByUniqueAttribute
  • productDeletedStream
  • productStream
  • productVariantParent
  • section
  • sectionList
  • template
  • templateList

Was this helpful?

Export as PDF
  1. Overview
  2. Schema

Queries

Queries allow retrieving data from the server.

PreviousSchemaNextMutations

Last updated 5 months ago

Was this helpful?

attribute

Finds an Attribute.

Returns:

Arguments:

code

The code of a searched Attribute.

attributeDeletedStream

Provides a of deleted attribute codes.

Returns:

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 200. The default value is 50.

attributeOptionList

Provides a list of attribute options.

Returns:

Arguments:

code

The code of a searched Attribute.

filters

Filters for the query.

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 200. The default value is 50.

attributeStream

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 200. The default value is 50.

category

Finds a Category.

Arguments:

code

The code of a searched Category.

categoryAttributeList

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

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 500. The default value is 50.

categoryDeletedStream

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 200. The default value is 50.

categoryStream

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 200. The default value is 50.

categoryTree

Finds a CategoryTree.

Arguments:

code

The code of a searched CategoryTree.

categoryTreeDeletedStream

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 200. The default value is 50.

categoryTreeStream

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 200. The default value is 50.

languageList

Provides a list of active languages.

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 1000. The default value is 50.

multimedia

Finds a Multimedia.

Arguments:

path

The path of a searched Multimedia.

multimediaFolder

Finds a MultimediaFolder.

Arguments:

path

The path of a searched MultimediaFolder.

multimediaFolderList

Provides a list of multimedia folders.

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 300. The default value is 50.

multimediaStream

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 200. The default value is 50.

product

Finds a Product.

Arguments:

sku

The sku of a searched Product.

productByUniqueAttribute

Finds a Product by unique attribute value.

Arguments:

attributeCode

The code of unique attribute Product is searched by.

value

The value of unique attribute Product is searched by.

productDeletedStream

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 200. The default value is 50.

productStream

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 200. The default value is 50.

productVariantParent

Finds a parent VariableProduct identified by variant Sku.

Arguments:

variantSku

The Sku of variant to find a parent VariableProduct.

section

Finds a Section.

Arguments:

code

The code of a searched Section.

sectionList

Provides a list of sections.

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 100. The default value is 50.

template

Finds a Template.

Arguments:

code

The code of a searched Template.

templateList

Provides a list of templates.

Arguments:

after

Provides elements after the specified cursor.

first

Provides up to first n results. Value cannot be less than 0 and higher than 100. The default value is 50.

Provides a of attributes.

Returns:

Returns:

Returns:

Provides a of deleted category codes.

Returns:

Provides a of categories.

Returns:

Returns:

Provides a of deleted category tree codes.

Returns:

Provides a of category trees.

Returns:

Returns:

Returns:

Returns:

Returns:

Provides a of multimedia.

Returns:

Returns:

Returns:

Provides a of deleted product SKUs.

Returns:

Provides a of products.

Returns:

Returns:

Returns:

Returns:

Returns:

Returns:

Product
Product
Attribute
AttributeCode!
String
Int
AttributeCode!
String
Int
String
Int
CategoryCode!
String
Int
String
Int
String
Int
CategoryTreeCode!
String
Int
String
Int
String
Int
MultimediaPath!
MultimediaFolderPath!
String
Int
String
Int
Sku!
AttributeCode!
String!
String
Int
String
Int
Sku!
SectionCode!
String
Int
TemplateCode!
String
Int
AttributeConnection
Category
AttributeConnection
CategoryDeletedConnection
CategoryConnection
CategoryTree
CategoryTreeDeletedConnection
CategoryTreeConnection
LanguageConnection
Multimedia
MultimediaFolder
MultimediaFolderConnection
MultimediaConnection
ProductDeletedConnection
ProductConnection
VariableProduct
Section
SectionConnection
Template
TemplateConnection
AttributeDeletedConnection
OptionConnection
stream
stream
stream
stream
stream
stream
stream
stream
stream
AttributeOptionListFilterInput