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
  • AttributeValue
  • AttributeValueTranslation
  • CustomField
  • CustomFieldTranslatedValue
  • CustomFieldValue
  • CustomFieldValueTranslation
  • OptionAttribute
  • Product

Was this helpful?

Export as PDF
  1. Overview
  2. Schema

Interfaces

Interfaces represent a parent for Objects providing definition of common fields.

PreviousObjectsNextScalars

Last updated 5 months ago

Was this helpful?

Attribute

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

Fields:

code

Readable id of Attribute.

Translatable name allowing to set different values in every active language.

scope

Scope of Attribute determining its values behavior.

metadata

Metadata allows describing the Attribute in an enhanced, custom way.

Implemented by:

AttributeValue

Represents a value defining a specific attribute.

Fields:

A value translations.

attribute

An Attribute describing the type of value.

Implemented by:

AttributeValueTranslation

Represents a translated attribute value for language.

Fields:

language

A language of a translation.

Implemented by:

CustomField

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

Fields:

code

Readable id of CustomField.

Implemented by:

CustomFieldTranslatedValue

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

Fields:

customField

A CustomField describing the type of value.

Implemented by:

CustomFieldValue

Represents a value defining a specific CustomField.

Fields:

customField

A CustomField describing the type of value.

A value translations.

Implemented by:

CustomFieldValueTranslation

Represents a translated custom field value for language.

Fields:

language

A language of a translation.

Implemented by:

OptionAttribute

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

Implements:

Fields:

A list of options of an Attribute. first argument cannot be lesser than 0 and higher than 200. The default value is 50.

customFields

Configured attribute custom fields.

Implemented by:

Product

Fields:

sku

sku

A list of categories Product belongs to. first argument cannot be lesser than 0 and its default value is 50.

template

Template of Product.

A list of Attribute values. first argument cannot be lesser than 0 and its default value is 50.

status

Status of Product.

createdAt

Creation date.

editedAt

Last edition date.

Implemented by:

name (languages: )

translations (languages: )

translations (languages: )

optionList (after: , first: )

categoryList (after: , first: )

attributeList (after: , first: , codes: )

Attribute
[AttributeValueTranslation!]!
Attribute!
CustomField!
CustomField!
[CustomFieldValueTranslation!]!
OptionConnection!
[CustomField!]!
OptionAttribute
AttributeCode!
[Language!]
[Language!]
Language!
CustomFieldCode!
[Language!]
Language!
String
Int
Sku!
String
Int
String
Int
[AttributeCode!]
DateTime!
DateTime
AttributeScope!
DateAttribute
FileAttribute
GalleryAttribute
ImageAttribute
MultiSelectAttribute
NumericAttribute
PriceAttribute
ProductRelationAttribute
SelectAttribute
TextareaAttribute
TextAttribute
UnitAttribute
DateAttributeValue
FileAttributeValue
GalleryAttributeValue
ImageAttributeValue
MultiSelectAttributeValue
NumericAttributeValue
PriceAttributeValue
ProductRelationAttributeValue
SelectAttributeValue
TextareaAttributeValue
TextAttributeValue
UnitAttributeValue
DateAttributeValueTranslation
FileAttributeValueTranslation
GalleryAttributeValueTranslation
ImageAttributeValueTranslation
MultiSelectAttributeValueTranslation
NumericAttributeValueTranslation
PriceAttributeValueTranslation
ProductRelationAttributeValueTranslation
SelectAttributeValueTranslation
TextareaAttributeValueTranslation
TextAttributeValueTranslation
UnitAttributeValueTranslation
ImageCustomField
TextareaCustomField
TextareaRTECustomField
TextCustomField
ImageCustomFieldTranslatedValue
TextareaCustomFieldTranslatedValue
TextareaRTECustomFieldTranslatedValue
TextCustomFieldTranslatedValue
ImageCustomFieldValue
TextareaCustomFieldValue
TextareaRTECustomFieldValue
TextCustomFieldValue
ImageCustomFieldValueTranslation
TextareaCustomFieldValueTranslation
TextareaRTECustomFieldValueTranslation
TextCustomFieldValueTranslation
MultiSelectAttribute
SelectAttribute
GroupingProduct
SimpleProduct
VariableProduct
[TranslatedString!]!
[Metadatum!]!
CategoryConnection!
Template!
AttributeValueConnection!
[ProductStatusTranslation!]!