Product
(OBJECT)
Product
link GraphQL Schema definition
- type Product {
- # product internal ID
- : ID!
- # main product title
- : String
- # producer
- : Producer
- # main product image
- : Url
- # link to the eshop product
- : Url!
- # short description (only plain text)
- : String
- # long description (allowed html format)
- : String
- # main product category
- : Category
- # attribute category
- : Category
- # assigned to categories
- : [Category]
- # product EAN
- : Ean
- # display the product in the store to customers
- : Boolean!
- # product identificator from supplier or data source
- : String
- # product net price (excl. tax)
- : Price
- # final price of product including tax, discounts and all other price components.
- : Price
- # warehouse item
- : [WarehouseItem]
- # attributes
- : [Attribute]
- # product indicators (badges like 'new', 'sale')
- : [Indicator]
- # tax rate for currency price
- : Percentage
- # product image gallery
- : [Url]
- # product packaging details, dimensions, weight and number of packages
- : [Package]
- # the smallest sales unit of an product
- : SalesUnit
- # quantity per sales unit
- : Float
- # SEO product title for HTML tag TITLE
- : String
- # SEO meta description of product
- : String
- # SEO-friendly URL identificator (raw slug)
- : String
- # internal admin note for product
- : String
- }
link Require by
- Mutationset of methods and entities to create and/or modify entities with this API.
- OrderItemProduct contained within order
- ProductListPageable list of products (cursor)
- Query Querying retrieves data (read access). Batching of multiple queries is not supported with this API. To modify data or perform operations @see Mutation definition. As of GraphQL nature, for each query you need to specify fields returned. To make this simpler you may use predefined fragments of data (default datasets) which honor the _<ObjectName> convention. You may combine predefined fragments with specific field enumeration in your queries. @see fragments.graphql You may need to distinguish between cursors i.e. pageable lists of items (SomeobjectList objects) returned and simple sets of items (array of objects). General rule is that lists are used for 'content generated by public' and are retrieved by getObjectList queries, simple sets are used for 'items created/managed by administrator' and retrieved by listObjects calls. Please note for cursors you may not request more than 30 items at once (i.e. page size is limited to max. 30 items). Querying retrieves data (read access).
- WarehouseItemProduct warehouse item