Queries
Queries allow retrieving data from the server.
attribute
Finds an Attribute.
Returns: Attribute
Arguments:
code
The code of a searched Attribute.
attributeDeletedStream
Provides a stream of deleted attribute codes.
Returns: AttributeDeletedConnection
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: OptionConnection
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
Provides a stream of attributes.
Returns: AttributeConnection
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.
Returns: Category
Arguments:
code
The code of a searched Category.
categoryAttributeList
Provides a list of attributes allowed to be used in a category.
Returns: AttributeConnection
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
Provides a stream of deleted category codes.
Returns: CategoryDeletedConnection
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
Provides a stream of categories.
Returns: CategoryConnection
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.
Returns: CategoryTree
Arguments:
code
The code of a searched CategoryTree.
categoryTreeDeletedStream
Provides a stream of deleted category tree codes.
Returns: CategoryTreeDeletedConnection
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
Provides a stream of category trees.
Returns: CategoryTreeConnection
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.
Returns: LanguageConnection
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.
Returns: Multimedia
Arguments:
path
The path of a searched Multimedia.
multimediaFolder
Finds a MultimediaFolder.
Returns: MultimediaFolder
Arguments:
path
The path of a searched MultimediaFolder.
multimediaFolderList
Provides a list of multimedia folders.
Returns: MultimediaFolderConnection
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
Provides a stream of multimedia.
Returns: MultimediaConnection
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.
Returns: Product
Arguments:
sku
The sku of a searched Product.
productByUniqueAttribute
Finds a Product by unique attribute value.
Returns: Product
Arguments:
attributeCode
The code of unique attribute Product is searched by.
value
The value of unique attribute Product is searched by.
productDeletedStream
Provides a stream of deleted product SKUs.
Returns: ProductDeletedConnection
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
Provides a stream of products.
Returns: ProductConnection
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.
Returns: VariableProduct
Arguments:
variantSku
The Sku of variant to find a parent VariableProduct.
section
Finds a Section.
Returns: Section
Arguments:
code
The code of a searched Section.
sectionList
Provides a list of sections.
Returns: SectionConnection
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.
Returns: Template
Arguments:
code
The code of a searched Template.
templateList
Provides a list of templates.
Returns: TemplateConnection
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.
Last updated
Was this helpful?