Schema

–

company

–

country

–

name

–

phone

–

province

–

street

–

street2

–

zipCode

–

AppliedFilter

OBJECT

Generic filter returned from lists/search

Interfaces

–

Fields

id

ID *

–

label

–

type

FilterType *

–

values

[ FilterValue * ] *

–

Article

OBJECT

An article is a concrete shape of a product

Interfaces

–

Fields

attributes

[ Attribute * ] *

–

availabilities

[ Availability * ] *

–

baseUnit

BaseUnit *

–

brand

–

brandId

ID *

–

id

ID *

–

info

ArticleInfo *

–

isBuyable

–

isMaster

–

labels

[ String * ] *

–

media

[ Media * ] *

–

prices

[ Price * ] *

–

product

Product

–

productId

ID *

–

salesUnits

[ SalesUnit * ] *

–

sellers

[ Seller * ] *

–

sku

–

status

ArticleStatus *

–

taxClass

TaxClass *

–

title

–

ArticleInfo

OBJECT

Article information

Interfaces

SellableInfo

Fields

description

–

Attribute

OBJECT

A concrete product attribute (value)

Interfaces

–

Fields

definition

AttributeDefinition *

–

value

–

AttributeDefinition

OBJECT

Definition of a product attribute

Interfaces

–

Fields

attributeType

AttributeType *

–

id

ID *

–

label

–

AuthToken

OBJECT

Interfaces

–

Fields

expiresIn

Int

–

value

–

Availability

OBJECT

Tells how many items of an article are available. Refers to the BaseUnit of the article.

Interfaces

–

Fields

value

Int *

–

warehouse

–

warehouseId

ID *

–

BaseUnit

OBJECT

The base unit is used for all internal calculations

Interfaces

–

Fields

id

ID *

–

interval

Int

–

maxQuantity

Int

–

minQuantity

Int

–

name

MeasurementUnit *

–

standardQuantity

Int

–

Brand

OBJECT

Brand

Interfaces

–

Fields

categories

[ Category * ]

–

categoryIds

[ String * ] *

–

description

–

id

ID *

–

media

[ Media * ] *

–

products

ProductsResult

–

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

ID *

–

items

[ CartItem * ] *

–

paymentMethods

[ PaymentMethod * ] *

–

shippingMethods

[ ShippingMethod * ] *

–

totals

Totals *

–

updatedAt

–

CartItem

OBJECT

A cart line item

Interfaces

–

Fields

article

–

articleId

ID *

–

cartId

ID *

–

children

[ CartItem * ] *

–

createdAt

–

id

ID *

–

parent

CartItem

–

parentItemId

ID

–

quantity

Int *

–

salesUnit

SalesUnit *

–

totals

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 * ] *

–

Meta

OBJECT

Meta data for SEO

Interfaces

–

Fields

description

–

robots

–

title

–

Mutation

OBJECT

Interfaces

–

Fields

addCustomerAddress

CustomerAddress

–

addToCart

AddToCartResult

–

addToWishlist

Wishlist

–

applyCoupon

Cart

–

cancelReservation

–

createCart

Cart

–

createReservation

Reservation

–

createWishlist

Wishlist

–

deleteCart

–

deleteCustomerAddress

–

deleteWishlist

–

finishCheckout

Order

–

login

LoginResult

–

register

RegistrationResult

–

removeFromCart

–

removeFromWishlist

–

startCheckout

CheckoutState

–

updateCartItem

CartItem

–

updateCheckout

CheckoutState

–

updateCustomer

–

updateCustomerAddress

CustomerAddress

–

Order

OBJECT

Order

Interfaces

–

Fields

billingAddress

Address *

–

createdAt

–

id

ID *

–

items

[ OrderItem * ]

–

paymentInfo

OrderPaymentInfo *

–

shippingAddress

Address *

–

shippingInfo

OrderShippingInfo *

–

status

OrderStatus *

–

OrderItem

OBJECT

Order item

Interfaces

–

Fields

article

–

id

ID *

–

orderId

ID *

–

price

Int *

–

quantity

Int *

–

sku

ID *

–

title

–

OrderPaymentInfo

OBJECT

Container for payment information of an order

Interfaces

–

Fields

method

PaymentMethod *

–

payments

[ Payment * ] *

–

OrderShippingInfo

OBJECT

Container for shipping information

Interfaces

–

Fields

method

ShippingMethod *

–

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

[ ContentBlock * ] *

–

children

[ Page * ]

–

childrenIds

[ ID * ] *

–

createdAt

–

id

ID *

–

locale

–

meta

Meta *

–

reference

PageReference

–

referenceId

ID

–

status

PageStatus *

–

template

–

title

–

updatedAt

–

url

–

PagesResult

OBJECT

Result of a pages query

Interfaces

Fields

paging

–

results

[ Page * ] *

–

Paging

OBJECT

Paging information

Interfaces

–

Fields

total

Int *

–

Payment

OBJECT

Payment

Interfaces

–

Fields

status

PaymentStatus *

–

PaymentMethod

OBJECT

Payment Method

Interfaces

–

Fields

description

–

expense

Expense

–

id

ID *

–

label

–

Price

OBJECT

Prices (and their related quantities) always refer to the BaseUnit of an article

Interfaces

–

Fields

currency

Currency *

–

discount

Int

–

grossValue

Int *

–

netValue

Int *

–

original

Int

–

quantity

Int *

–

referencePrice

ReferencePrice

–

taxValue

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

[ Article * ]

–

attributes

[ Attribute ] *

–

brand

–

brandId

ID *

–

categories

[ Category * ]

–

categoryIds

[ ID * ] *

–

createdAt

–

id

ID *

–

info

ProductInfo *

–

labels

[ String * ] *

–

manufacturer

Manufacturer

–

manufacturerId

ID

–

media

[ Media * ] *

–

options

[ ProductOption * ] *

–

relatedProducts

RelatedProductsResult

–

slug

–

status

ProductStatus *

–

title

–

updatedAt

–

ProductInfo

OBJECT

Product information

Interfaces

SellableInfo

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

ID *

–

label

–

type

ProductOptionType *

–

values

[ ProductOptionValue * ] *

–

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

BrandsResult

–

cart

Cart

–

carts

CartsResult

–

categories

CategoriesResult

–

category

Category

–

categoryByField

Category

–

contentBlock

ContentBlock

–

contentBlocks

ContentBlocksResult

–

customer

–

features

Features *

–

manufacturer

Manufacturer

–

manufacturerByField

Manufacturer

–

manufacturers

ManufacturersResult

–

order

Order

–

orders

OrdersResult

–

page

Page

–

pageByField

Page

–

pages

PagesResult

–

product

Product

–

productByField

Product

–

products

ProductsResult

–

reservation

Reservation

–

reservationByField

Reservation

–

reservations

ReservationsResult

–

search

SearchResult

–

seller

Seller

–

sellerByField

Seller

–

sellers

SellersResult

–

session

Session

–

shop

Shop

–

suggestions

[ Suggestion * ] *

–

warehouse

–

warehouseByField

–

warehouses

WarehousesResult

–

wishlist

Wishlist

–

wishlists

WishlistsResult

–

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

Currency *

–

grossValue

Int *

–

netValue

Int *

–

quantity

Int *

–

salesUnit

SalesUnit *

–

taxValue

TaxValue *

–

RegistrationResult

OBJECT

RegistrationResult

Interfaces

–

Fields

accessToken

AuthToken

–

customer

–

refreshToken

AuthToken

–

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

Product *

–

type

RelatedProductType *

–

RelatedProductsResult

OBJECT

Paged result of a related-product list

Interfaces

Fields

paging

–

results

[ RelatedProduct * ] *

–

Reservation

OBJECT

A reservation of articles in specified quantites in a warehouse

Interfaces

–

Fields

articles

[ ReservedArticle * ] *

–

customer

–

customerId

ID

–

email

–

firstname

–

id

ID *

–

lastname

–

phone

–

reservationNumber

–

status

ReservationStatus *

–

validUntil

–

warehouse

–

warehouseId

ID *

–

ReservationsResult

OBJECT

Result of a reservations query

Interfaces

Fields

paging

–

results

[ Reservation * ] *

–

ReservedArticle

OBJECT

A reserved article references an article in a specified quantity which is part of a reservation

Interfaces

–

Fields

article

–

articleID

ID *

–

id

ID *

–

quantity

Int *

–

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

Int *

–

id

ID *

–

name

MeasurementUnit *

–

SearchResult

OBJECT

Paged search result

Interfaces

Fields

filters

[ AppliedFilter * ] *

–

paging

–

results

[ SearchResultItem * ] *

–

SearchResultItem

OBJECT

A search result entry for product searches

Interfaces

–

Fields

image

SearchResultItemReference

–

reference

–

referenceId

ID

–

title

–

type

SearchResultItemType *

–

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

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

[ ShipmentItem * ] *

–

status

ShipmentStatus *

–

trackingNumber

–

ShipmentItem

OBJECT

A Shipment Item describes which articles have been shipped in which quantity

Interfaces

–

Fields

article

–

id

ID *

–

quantity

Int *

–

ShippingMethod

OBJECT

Shipping Method

Interfaces

–

Fields

description

–

expense

Expense

–

id

ID *

–

label

–

Shop

OBJECT

Shop specific settings and configuration

Interfaces

–

Fields

currencies

[ Currency * ] *

–

defaultLocale

Locale

–

locales

[ Locale * ] *

–

pricePrecision

Int *

–

Suggestion

OBJECT

Search Suggestion

Interfaces

–

Fields

result

SuggestionResult

–

resultId

ID *

–

slug

–

title

–

type

SuggestionType *

–

TaxClass

OBJECT

Tax class

Interfaces

–

Fields

country

Country *

–

id

ID *

–

name

–

value

Int *

–

TaxValue

OBJECT

An actual tax value, referring to a TaxClass

Interfaces

–

Fields

taxClass

TaxClass *

–

value

Int *

–

Totals

OBJECT

Total amounts of a Cart or a CartItem

Interfaces

–

Fields

discounts

[ Discount * ] *

–

expenses

[ Expense * ] *

–

gross

Int *

–

net

Int *

–

taxes

[ TaxValue ] *

–

Warehouse

OBJECT

A warehouse

Interfaces

–

Fields

id

ID *

–

name

–

openingTimes

[ OpeningTime * ] *

–

WarehousesResult

OBJECT

Result of a warehouses query

Interfaces

Fields

paging

–

results

[ Warehouse * ] *

–

Wishlist

OBJECT

Wishlist

Interfaces

–

Fields

id

ID *

–

items

[ WishlistItem * ] *

–

WishlistItem

OBJECT

Wishlist item

Interfaces

–

Fields

article

–

articleId

ID *

–

id

ID *

–

quantity

Int *

–

WishlistsResult

OBJECT

Paged result of a wishlist list

Interfaces

Fields

paging

–

results

[ Wishlist * ]

–

__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

[ __DirectiveLocation * ] *

–

args

[ __InputValue * ] *

–

__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

[ __InputValue * ] *

–

type

__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

__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

__Type *

–

mutationType

__Type

–

subscriptionType

__Type

–

directives

[ __Directive * ] *

–

__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

__TypeKind *

–

name

–

description

–

specifiedByURL

–

fields

[ __Field * ]

–

interfaces

[ __Type * ]

–

possibleTypes

[ __Type * ]

–

enumValues

[ __EnumValue * ]

–

inputFields

[ __InputValue * ]

–

ofType

__Type

–

AddToCartItemInput

INPUT_OBJECT

One item to be added to the cart

Input Fields

data

CartItemDataInput

–

parentCartItemId

ID

–

quantity

Int *

–

salesUnitId

ID

–

sku

ID *

–

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

Float

–

longitude

Float

–

radius

Int

–

searchQuery

–

CartItemDataInput

INPUT_OBJECT

Cart item data

Input Fields

customization

ScalarMap

–

positionText

–

FilterInput

INPUT_OBJECT

Generic filter input for lists/search

Input Fields

id

ID *

–

values

[ String * ] *

–

LoginInput

INPUT_OBJECT

Input Fields

password

–

refreshToken

–

username

–

OrdersFilterInput

INPUT_OBJECT

Order list filters

Input Fields

from

–

status

[ OrderStatus * ]

–

until

–

PagingInput

INPUT_OBJECT

Paging specifier

Input Fields

limit

Int *

–

page

Int *

–

RegistrationInput

INPUT_OBJECT

Customer data for registration

Input Fields

addresses

[ AddressInput * ] *

–

company

–

email

–

firstname

–

lastname

–

password

–

salutation

–

ReservationContactDataInput

INPUT_OBJECT

Contact data required to create a reservation

Input Fields

email

–

firstname

–

lastname

–

phone

ReservationContactDataInput *

–

ReservationInput

INPUT_OBJECT

Data required to create a new reservation

Input Fields

articleId

ID *

–

contactData

–

quantity

Int *

–

SortInput

INPUT_OBJECT

Sort specifier

Input Fields

field

–

value

SortValue *

–

UpdateCartItemInput

INPUT_OBJECT

Update cart item data

Input Fields

data

CartItemDataInput

–

quantity

Int

–

salesUnitId

ID

–

UpdateCheckoutInput

INPUT_OBJECT

Checkout data to be updated

Input Fields

billingAddress

AddressInput

–

email

–

paymentMethod

ID

–

shippingAddress

AddressInput

–

shippingMethod

ID

–

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

PagedResult

INTERFACE

Interfaces

–

Fields

paging

–

Possible Types

BrandsResult, CartsResult, CategoriesResult, ContentBlocksResult, ManufacturersResult, OrdersResult, PagesResult, ProductsResult, RelatedProductsResult, ReservationsResult, SearchResult, SellersResult, WarehousesResult, WishlistsResult

SellableInfo

INTERFACE

Interfaces

–

Fields

description