Schema
Types
The `Boolean` scalar type represents `true` or `false`.
The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).
The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.
The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
A map of scalars
The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Values
BOOLEAN, COLOR, NUMBER, TEXT
Values
DRAFT, PUBLISHED
Values
BOOLEAN, COLOR, NUMBER, TEXT
Values
ACRE, ARES, BARL, BCUF, BDFT, BUSL, CBME, CELI, CMET, DGEU, FOOT, GBGA, GBOU, GBPI, GBQA, GBTN, GGEU, GRAM, HECT, HUWG, INCH, ITEM, KILO, KMET, LITR, METR, MIBA, MILE, MILI, MMET, OZTR, PUND, SCMT, SMET, SMIL, SQFO, SQIN, SQKI, SQMI, SQYA, TONE, UCWT, USGA, USOU, USPI, USQA, USTN, YARD
Values
CANCELED, CLOSED, NEW, SHIPPED
Values
DRAFT, PUBLISHED
Values
COMPLETE, PENDING
Values
COLOR, TEXT
Values
ACCESSORY, ALTERNATIVE, SUCCESSOR
Values
CANCELLED, CLOSED, NEW, READY
Values
ARTICLE, BRAND, CATEGORY, PRODUCT
Values
PRODUCT
Values
DELIVERED, PENDING, SHIPPED
Values
ASC, DESC
A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.
Values
QUERY, MUTATION, SUBSCRIPTION, FIELD, FRAGMENT_DEFINITION, FRAGMENT_SPREAD, INLINE_FRAGMENT, VARIABLE_DEFINITION, SCHEMA, SCALAR, OBJECT, FIELD_DEFINITION, ARGUMENT_DEFINITION, INTERFACE, UNION, ENUM, ENUM_VALUE, INPUT_OBJECT, INPUT_FIELD_DEFINITION
An enum describing what kind of type a given `__Type` is.
Values
SCALAR, OBJECT, INTERFACE, UNION, ENUM, INPUT_OBJECT, LIST, NON_NULL
Result of adding one or many articles to the cart
Interfaces
–
An address
Interfaces
Generic filter returned from lists/search
Interfaces
–
An article is a concrete shape of a product
Interfaces
–
Fields
A concrete product attribute (value)
Interfaces
–
Definition of a product attribute
Interfaces
–
Tells how many items of an article are available. Refers to the BaseUnit of the article.
Interfaces
–
The base unit is used for all internal calculations
Interfaces
–
Brand
Interfaces
–
Paged result of a brand list
Interfaces
An instance of a shopping cart
Interfaces
–
Fields
A cart line item
Interfaces
–
Result of a carts query
Interfaces
Paged result of a category list
Interfaces
Categories are hierarchical containers for products
Interfaces
–
Breadcrumbs for hierarchical categories
Interfaces
–
Checkout state
Interfaces
–
Fields
A page can have multiple blocks, each of a specific type, which are optionally placed into slots
Interfaces
–
Result of a contentBlocks query
Interfaces
Saved Customer
Interfaces
–
A saved address of a customer
Interfaces
Result of a mutation which deletes objects
Interfaces
–
Opening hours can deviate from regular times in order to be able to reflect public holidays, for example.
Interfaces
–
Discounts can be applied by the system to either CartItems or the Cart as a whole
Interfaces
–
Expenses are additional costs that will be charged to the customer
Interfaces
–
Value of a (maybe) applied filter
Interfaces
–
LoginResult
Interfaces
–
Manufacturers build products. In most cases there is only one vendor in the system, but there may be many for marketplaces
Interfaces
–
Result of a manufacturers query
Interfaces
Interfaces
–
Fields
Order
Interfaces
–
Fields
Order item
Interfaces
–
Container for payment information of an order
Interfaces
–
Container for shipping information
Interfaces
–
Paged result of an order list
Interfaces
A page represents a page in the storefront, typically provided by a CMS
Interfaces
–
Fields
Result of a pages query
Interfaces
Payment Method
Interfaces
–
Prices (and their related quantities) always refer to the BaseUnit of an article
Interfaces
–
The product catalog consists of products. Products are made up of one or many articles. Products by their own are not buyable.
Interfaces
–
Fields
Product options make up variants. Each article must have all product options of the product defined as attributes. The value of an attribute matches the value of a ProductOptionValue
Interfaces
–
Paged result of a product list
Interfaces
Interfaces
–
Fields
A reference price provides a baseline with which prices of different articles can be compared, even though these articles might be sond in different SalesUnits.
Interfaces
–
RegistrationResult
Interfaces
–
Regular (recurring) opening times of a warehouse/store
Interfaces
–
A product which related to an other product
Interfaces
–
Paged result of a related-product list
Interfaces
A reservation of articles in specified quantites in a warehouse
Interfaces
–
Result of a reservations query
Interfaces
A reserved article references an article in a specified quantity which is part of a reservation
Interfaces
–
A sales unit is the unit in which an article is sold. Every article has to have at least SalesUnit, usually "piece"
Interfaces
–
Paged search result
Interfaces
A search result entry for product searches
Interfaces
–
Fields
Sellers sell articles. In most cases there is only one vendor in the system, but there may be many for marketplaces
Interfaces
–
Result of a sellers query
Interfaces
Shipment
Interfaces
–
A Shipment Item describes which articles have been shipped in which quantity
Interfaces
–
Shipping Method
Interfaces
–
Shop specific settings and configuration
Interfaces
–
Search Suggestion
Interfaces
–
An actual tax value, referring to a TaxClass
Interfaces
–
Total amounts of a Cart or a CartItem
Interfaces
–
Result of a warehouses query
Interfaces
Paged result of a wishlist list
Interfaces
A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
Interfaces
–
Fields
One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
Interfaces
–
Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
Interfaces
–
Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
Interfaces
–
A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
Interfaces
–
The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name, description and optional `specifiedByURL`, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.
Interfaces
–
Fields
One item to be added to the cart
Address data
Fields to narrow down search results for warehouses around a location
Generic filter input for lists/search
Login data may either be a combination of username and password or a token
Order list filters
Customer data for registration
Contact data required to create a reservation
Data required to create a new reservation
Update cart item data
Checkout data to be updated
Input Fields
Customer data to be updated
Interfaces
–
Fields
Interfaces
–
Fields
Opening times of a warehouse/store
Directives
deprecated
Marks an element of a GraphQL schema as no longer supported.
reason
include
Directs the executor to include this field or fragment only when the `if` argument is true.
if
skip
Directs the executor to skip this field or fragment when the `if` argument is true.
if
specifiedBy
Exposes a URL that specifies the behavior of this scalar.
url