Schema

Types

#
Boolean
SCALAR
The `Boolean` scalar type represents `true` or `false`.
#
Float
SCALAR
The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).
#
ID
SCALAR
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.
#
Int
SCALAR
The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
#
ScalarMap
SCALAR
A map of scalars
#
String
SCALAR
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.
#
ArticleStatus
ENUM
Status of an article
Values
DISCONTINUED, DRAFT, PUBLISHED
#
AttributeType
ENUM
Values
BOOLEAN, COLOR, NUMBER, TEXT
#
ContentBlockStatus
ENUM
Values
DRAFT, PUBLISHED
#
FilterType
ENUM
Values
BOOLEAN, COLOR, NUMBER, TEXT
#
MeasurementUnit
ENUM
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
#
MediaPurpose
ENUM
Purpose of a Media object
Values
COVER
#
MediaType
ENUM
Type of a media object
Values
IMAGE, VIDEO
#
OrderStatus
ENUM
Values
CANCELED, CLOSED, NEW, SHIPPED
#
PageStatus
ENUM
Values
DRAFT, PUBLISHED
#
PaymentStatus
ENUM
Values
COMPLETE, PENDING
#
ProductOptionType
ENUM
Values
COLOR, TEXT
#
ProductStatus
ENUM
Status of a product
Values
DISCONTINUED, DRAFT, PUBLISHED
#
RelatedProductType
ENUM
Values
ACCESSORY, ALTERNATIVE, SUCCESSOR
#
ReservationStatus
ENUM
Values
CANCELLED, CLOSED, NEW, READY
#
ResolveUrlResultType
ENUM
Values
ARTICLE, BRAND, CATEGORY, PRODUCT
#
SearchResultItemType
ENUM
Values
PRODUCT
#
ShipmentStatus
ENUM
Values
DELIVERED, PENDING, SHIPPED
#
SortValue
ENUM
Values
ASC, DESC
#
SuggestionType
ENUM
Type of a suggestion entry
Values
ARTICLE, BRAND, CATEGORY, PRODUCT
#
__DirectiveLocation
ENUM
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
#
__TypeKind
ENUM
An enum describing what kind of type a given `__Type` is.
Values
SCALAR, OBJECT, INTERFACE, UNION, ENUM, INPUT_OBJECT, LIST, NON_NULL
#
AddToCartResult
OBJECT
Result of adding one or many articles to the cart
Interfaces
Fields
cart
errors
[ Error * ] *
#
Address
OBJECT
An address
Interfaces
Fields
city
company
country
name
phone
province
street
street2
zipCode
#
AppliedFilter
OBJECT
Generic filter returned from lists/search
Interfaces
Fields
id
label
type
values
#
Article
OBJECT
An article is a concrete shape of a product
Interfaces
Fields
attributes
[ Attribute * ] *
availabilities
baseUnit
brand
brandId
id
info
isBuyable
isMaster
labels
[ String * ] *
media
[ Media * ] *
prices
[ Price * ] *
product
productId
salesUnits
[ SalesUnit * ] *
sellers
[ Seller * ] *
sku
status
taxClass
title
#
ArticleInfo
OBJECT
Article information
Interfaces
Fields
description
#
Attribute
OBJECT
A concrete product attribute (value)
Interfaces
Fields
definition
value
#
AttributeDefinition
OBJECT
Definition of a product attribute
Interfaces
Fields
attributeType
id
label
#
AuthToken
OBJECT
Interfaces
Fields
expiresIn
value
#
Availability
OBJECT
Tells how many items of an article are available. Refers to the BaseUnit of the article.
Interfaces
Fields
value
warehouse
warehouseId
#
BaseUnit
OBJECT
The base unit is used for all internal calculations
Interfaces
Fields
id
interval
maxQuantity
minQuantity
standardQuantity
#
Brand
OBJECT
Brand
Interfaces
Fields
categories
categoryIds
[ String * ] *
description
id
media
[ Media * ] *
products
slug
title
#
BrandsResult
OBJECT
Paged result of a brand list
Interfaces
Fields
paging
results
[ Brand * ] *
#
Cart
OBJECT
An instance of a shopping cart
Interfaces
Fields
coupons
[ Coupon * ] *
createdAt
id
items
[ CartItem * ] *
paymentMethods
shippingMethods
totals
updatedAt
#
CartItem
OBJECT
A cart line item
Interfaces
Fields
article
articleId
cartId
children
[ CartItem * ] *
createdAt
id
parent
parentItemId
quantity
salesUnit
totals
#
CartsResult
OBJECT
Result of a carts query
Interfaces
Fields
paging
results
[ Cart * ] *
#
CategoriesResult
OBJECT
Paged result of a category list
Interfaces
Fields
paging
results
[ Category * ] *
#
Category
OBJECT
Categories are hierarchical containers for products
Interfaces
Fields
breadcrumbs
children
childrenIds
[ String ] *
description
id
media
[ Media * ] *
parent
parentId
products
slug
title
#
CategoryBreadcrumb
OBJECT
Breadcrumbs for hierarchical categories
Interfaces
Fields
id
slug
title
#
CheckoutState
OBJECT
Checkout state
Interfaces
Fields
billingAddress
email
id
paymentMethod
shippingAddress
shippingMethod
#
ContentBlock
OBJECT
A page can have multiple blocks, each of a specific type, which are optionally placed into slots
Interfaces
Fields
blockType
createdAt
data
id
key
locale
order
slot
updatedAt
#
ContentBlocksResult
OBJECT
Result of a contentBlocks query
Interfaces
Fields
paging
results
#
Country
OBJECT
Country
Interfaces
Fields
isoCode
name
#
Coupon
OBJECT
Users can apply coupons to a cart
Interfaces
Fields
key
label
value
#
Currency
OBJECT
Currency
Interfaces
Fields
name
symbol
#
Customer
OBJECT
Saved Customer
Interfaces
Fields
addresses
blocked
customerNumber
email
firstname
id
lastname
#
CustomerAddress
OBJECT
A saved address of a customer
Interfaces
Fields
city
company
country
id
isDefaultBillingAddress
isDefaultShippingAddress
name
phone
province
street
street2
zipCode
#
DeleteResult
OBJECT
Result of a mutation which deletes objects
Interfaces
Fields
error
success
#
DeviatingOpeningTime
OBJECT
Opening hours can deviate from regular times in order to be able to reflect public holidays, for example.
Interfaces
Fields
closed
date
from
until
#
Discount
OBJECT
Discounts can be applied by the system to either CartItems or the Cart as a whole
Interfaces
Fields
id
label
value
#
Error
OBJECT
General purpose error object
Interfaces
Fields
code
message
ref
#
Expense
OBJECT
Expenses are additional costs that will be charged to the customer
Interfaces
Fields
id
label
value
#
Features
OBJECT
A map of features supported by the project
Interfaces
Fields
core
#
FilterValue
OBJECT
Value of a (maybe) applied filter
Interfaces
Fields
count
id
label
#
Locale
OBJECT
Locale
Interfaces
Fields
isoCode
label
#
LoginResult
OBJECT
LoginResult
Interfaces
Fields
accessToken
customer
refreshToken
#
Manufacturer
OBJECT
Manufacturers build products. In most cases there is only one vendor in the system, but there may be many for marketplaces
Interfaces
Fields
id
name
#
ManufacturersResult
OBJECT
Result of a manufacturers query
Interfaces
Fields
paging
results
#
Media
OBJECT
A media object
Interfaces
Fields
mediaType
purpose
url
#
Meta
OBJECT
Meta data for SEO
Interfaces
Fields
description
robots
title
#
Mutation
OBJECT
Interfaces
Fields
addCustomerAddress
addToCart
addToWishlist
applyCoupon
cancelReservation
createCart
createReservation
createWishlist
deleteCart
deleteCustomerAddress
deleteWishlist
finishCheckout
login
removeFromCart
removeFromWishlist
startCheckout
updateCartItem
updateCheckout
updateCustomer
updateCustomerAddress
#
Order
OBJECT
Order
Interfaces
Fields
billingAddress
createdAt
id
items
paymentInfo
shippingAddress
shippingInfo
status
#
OrderItem
OBJECT
Order item
Interfaces
Fields
article
id
orderId
price
quantity
sku
title
#
OrderPaymentInfo
OBJECT
Container for payment information of an order
Interfaces
Fields
method
payments
[ Payment * ] *
#
OrderShippingInfo
OBJECT
Container for shipping information
Interfaces
Fields
method
shipments
[ Shipment * ] *
#
OrdersResult
OBJECT
Paged result of an order list
Interfaces
Fields
paging
results
[ Order * ]
#
Page
OBJECT
A page represents a page in the storefront, typically provided by a CMS
Interfaces
Fields
blocks
children
[ Page * ]
childrenIds
[ ID * ] *
createdAt
id
locale
meta
reference
referenceId
status
template
title
updatedAt
url
#
PagesResult
OBJECT
Result of a pages query
Interfaces
Fields
paging
results
[ Page * ] *
#
Paging
OBJECT
Paging information
Interfaces
Fields
total
#
Payment
OBJECT
Payment
Interfaces
Fields
status
#
PaymentMethod
OBJECT
Payment Method
Interfaces
Fields
description
expense
id
label
#
Price
OBJECT
Prices (and their related quantities) always refer to the BaseUnit of an article
Interfaces
Fields
currency
discount
grossValue
netValue
original
quantity
referencePrice
taxValue
validFrom
validUntil
#
Product
OBJECT
The product catalog consists of products. Products are made up of one or many articles. Products by their own are not buyable.
Interfaces
Fields
articleIds
[ String * ] *
articles
attributes
brand
brandId
categories
categoryIds
[ ID * ] *
createdAt
id
info
labels
[ String * ] *
manufacturer
manufacturerId
media
[ Media * ] *
options
relatedProducts
slug
status
title
updatedAt
#
ProductInfo
OBJECT
Product information
Interfaces
Fields
description
#
ProductOption
OBJECT
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
Fields
id
label
values
#
ProductOptionValue
OBJECT
Valud of a product option
Interfaces
Fields
label
value
#
ProductsResult
OBJECT
Paged result of a product list
Interfaces
Fields
paging
results
[ Product * ] *
#
Query
OBJECT
Interfaces
Fields
article
articleByField
brand
brandByField
brands
cart
carts
categories
category
categoryByField
contentBlock
contentBlocks
customer
features
manufacturer
manufacturerByField
manufacturers
order
orders
page
pageByField
pages
product
productByField
products
reservation
reservationByField
reservations
search
seller
sellerByField
sellers
session
shop
suggestions
warehouse
warehouseByField
warehouses
wishlist
wishlists
#
ReferencePrice
OBJECT
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
Fields
currency
grossValue
netValue
quantity
salesUnit
taxValue
#
RegistrationResult
OBJECT
RegistrationResult
Interfaces
Fields
accessToken
customer
refreshToken
#
RegularOpeningTime
OBJECT
Regular (recurring) opening times of a warehouse/store
Interfaces
Fields
dayOfWeek
from
until
#
RelatedProduct
OBJECT
A product which related to an other product
Interfaces
Fields
product
#
RelatedProductsResult
OBJECT
Paged result of a related-product list
Interfaces
Fields
paging
results
#
Reservation
OBJECT
A reservation of articles in specified quantites in a warehouse
Interfaces
Fields
articles
customer
customerId
email
firstname
id
lastname
phone
reservationNumber
validUntil
warehouse
warehouseId
#
ReservationsResult
OBJECT
Result of a reservations query
Interfaces
Fields
paging
results
#
ReservedArticle
OBJECT
A reserved article references an article in a specified quantity which is part of a reservation
Interfaces
Fields
article
articleID
id
quantity
#
SalesUnit
OBJECT
A sales unit is the unit in which an article is sold. Every article has to have at least SalesUnit, usually "piece"
Interfaces
Fields
conversion
id
#
SearchResult
OBJECT
Paged search result
Interfaces
Fields
filters
paging
results
#
SearchResultItem
OBJECT
A search result entry for product searches
Interfaces
Fields
image
referenceId
title
url
#
Seller
OBJECT
Sellers sell articles. In most cases there is only one vendor in the system, but there may be many for marketplaces
Interfaces
Fields
id
name
#
SellersResult
OBJECT
Result of a sellers query
Interfaces
Fields
paging
results
[ Seller * ] *
#
Session
OBJECT
Session
Interfaces
Fields
id
#
Shipment
OBJECT
Shipment
Interfaces
Fields
carrier
items
status
trackingNumber
#
ShipmentItem
OBJECT
A Shipment Item describes which articles have been shipped in which quantity
Interfaces
Fields
article
id
quantity
#
ShippingMethod
OBJECT
Shipping Method
Interfaces
Fields
description
expense
id
label
#
Shop
OBJECT
Shop specific settings and configuration
Interfaces
Fields
currencies
[ Currency * ] *
defaultLocale
locales
[ Locale * ] *
pricePrecision
#
Suggestion
OBJECT
Search Suggestion
Interfaces
Fields
resultId
slug
title
#
TaxClass
OBJECT
Tax class
Interfaces
Fields
country
id
name
value
#
TaxValue
OBJECT
An actual tax value, referring to a TaxClass
Interfaces
Fields
taxClass
value
#
Totals
OBJECT
Total amounts of a Cart or a CartItem
Interfaces
Fields
discounts
[ Discount * ] *
expenses
[ Expense * ] *
gross
net
taxes
#
Warehouse
OBJECT
A warehouse
Interfaces
Fields
id
name
openingTimes
#
WarehousesResult
OBJECT
Result of a warehouses query
Interfaces
Fields
paging
results
[ Warehouse * ] *
#
Wishlist
OBJECT
Wishlist
Interfaces
Fields
id
items
#
WishlistItem
OBJECT
Wishlist item
Interfaces
Fields
article
articleId
id
quantity
#
WishlistsResult
OBJECT
Paged result of a wishlist list
Interfaces
Fields
paging
results
#
__Directive
OBJECT
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
name
description
isRepeatable
locations
args
#
__EnumValue
OBJECT
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
Fields
name
description
isDeprecated
deprecationReason
#
__Field
OBJECT
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
Fields
name
description
args
type
isDeprecated
deprecationReason
#
__InputValue
OBJECT
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
Fields
name
description
type
defaultValue
isDeprecated
deprecationReason
#
__Schema
OBJECT
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
Fields
description
types
[ __Type * ] *
queryType
mutationType
subscriptionType
directives
#
__Type
OBJECT
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
kind
name
description
specifiedByURL
fields
interfaces
[ __Type * ]
possibleTypes
[ __Type * ]
enumValues
inputFields
ofType
#
AddToCartItemInput
INPUT_OBJECT
One item to be added to the cart
Input Fields
parentCartItemId
quantity
salesUnitId
sku
#
AddressInput
INPUT_OBJECT
Address data
Input Fields
city
company
country
name
phone
province
street
street2
zipCode
#
AroundLocationInput
INPUT_OBJECT
Fields to narrow down search results for warehouses around a location
Input Fields
latitude
longitude
radius
searchQuery
#
CartItemDataInput
INPUT_OBJECT
Cart item data
Input Fields
customization
positionText
#
FilterInput
INPUT_OBJECT
Generic filter input for lists/search
Input Fields
id
values
[ String * ] *
#
LoginInput
INPUT_OBJECT
Login data may either be a combination of username and password or a token
Input Fields
password
refreshToken
username
#
OrdersFilterInput
INPUT_OBJECT
Order list filters
Input Fields
from
status
until
#
PagingInput
INPUT_OBJECT
Paging specifier
Input Fields
limit
page
#
RegistrationInput
INPUT_OBJECT
Customer data for registration
Input Fields
addresses
company
email
firstname
lastname
password
salutation
#
ReservationContactDataInput
INPUT_OBJECT
Contact data required to create a reservation
Input Fields
email
firstname
lastname
phone
#
ReservationInput
INPUT_OBJECT
Data required to create a new reservation
Input Fields
articleId
quantity
#
SortInput
INPUT_OBJECT
Sort specifier
Input Fields
field
value
#
UpdateCartItemInput
INPUT_OBJECT
Update cart item data
Input Fields
quantity
salesUnitId
#
UpdateCheckoutInput
INPUT_OBJECT
Checkout data to be updated
Input Fields
billingAddress
email
paymentMethod
shippingAddress
shippingMethod
#
UpdateCustomerInput
INPUT_OBJECT
Customer data to be updated
Input Fields
email
firstname
lastname
#
AddressFields
INTERFACE
Interfaces
Fields
city
company
country
name
phone
province
street
street2
zipCode
Possible Types
Address, CustomerAddress
#
SellableInfo
INTERFACE
Interfaces
Fields
description
Possible Types
ArticleInfo, ProductInfo
#
OpeningTime
UNION
Opening times of a warehouse/store
#
PageReference
UNION
Possible Types
Article, Brand, Category, Product
#
SearchResultItemReference
UNION
Possible Types
Brand, Category, Product
#
SuggestionResult
UNION
Possible Types
Article, Brand, Category, Product

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