Objects

Address

Fields

Name	Description
firstName String
lastName String
company String
addressLine String
addressLine2 String
postalCode String
countryCode String
regionCode String
city String

AdminUiConfig

Fields

Name	Description
customProperties [AdminUiConfigCustomEntityInterface!]!

AdminUiConfigCustomEntityInterface

Fields

Name	Description
entityName String!
inlineFragment String!

Assortment

Assortment

Fields

Name	Description
_id ID!
created DateTime
updated DateTime
deleted DateTime
isActive Boolean
isBase Boolean
isRoot Boolean
sequence Int!
tags [LowerCaseString!]
media [AssortmentMedia!]!	Arguments Name Description limit Int offset Int tags [LowerCaseString!]
texts AssortmentTexts	Arguments Name Description forceLocale String
productAssignments [AssortmentProduct!]
filterAssignments [AssortmentFilter!]
linkedAssortments [AssortmentLink!]
assortmentPaths [AssortmentPath!]!
children [Assortment!]	Arguments Name Description includeInactive Boolean
childrenCount Int!	Arguments Name Description includeInactive Boolean
searchProducts ProductSearchResult!	Arguments Name Description queryString String filterQuery [FilterQueryInput!] includeInactive Boolean ignoreChildAssortments Boolean orderBy SearchOrderBy

AssortmentFilter

Fields

Name	Description
_id ID!
sortKey Int!
tags [LowerCaseString!]
assortment Assortment!
filter Filter!

AssortmentLink

Fields

Name	Description
_id ID!
sortKey Int!
tags [LowerCaseString!]
parent Assortment!
child Assortment!

AssortmentMedia

Fields

Name	Description
_id ID!
tags [LowerCaseString!]
file Media!
sortKey Int!
texts AssortmentMediaTexts	Arguments Name Description forceLocale String

AssortmentMediaTexts

Fields

Name	Description
_id ID!
locale Locale
title String
subtitle String

AssortmentPath

Directed assortment to product paths (breadcrumbs)

Fields

Name	Description
links [AssortmentPathLink!]!

AssortmentPathLink

A connection that represents an uplink from assortment to assortment, assortmentId and assortmentTexts are there for convenience to short-circuit breadcrumb lookups

Fields

Name	Description
assortmentId ID!
assortmentTexts AssortmentTexts!	Arguments Name Description forceLocale String
link AssortmentLink

AssortmentProduct

Fields

Name	Description
_id ID!
sortKey Int!
tags [LowerCaseString!]
assortment Assortment!
product Product!

AssortmentSearchResult

Fields

Name	Description
assortmentsCount Int!
assortments [Assortment!]!	Arguments Name Description limit Int offset Int

AssortmentTexts

Fields

Name	Description
_id ID!
locale Locale
slug String
title String
subtitle String
description String

Bookmark

Fields

Name	Description
_id ID!
user User!
product Product!
created DateTime

BundleProduct

A Bundle product consists of multiple configured products

Implements

• Product

Fields

Name	Description
_id ID!
sequence Int!
status ProductStatus!
tags [LowerCaseString!]
created DateTime
updated DateTime
published DateTime
media [ProductMedia!]!	Arguments Name Description limit Int offset Int tags [LowerCaseString!]
texts ProductTexts	Arguments Name Description forceLocale String
bundleItems [ProductBundleItem!]
reviews [ProductReview!]!	Arguments Name Description limit Int offset Int sort [SortOptionInput!] queryString String
reviewsCount Int!	Arguments Name Description queryString String
assortmentPaths [ProductAssortmentPath!]!
siblings [Product!]!	Arguments Name Description assortmentId ID limit Int offset Int includeInactive Boolean

Color

Fields

Name	Description
name String
hex String
red Int
green Int
blue Int

ConfigurableProduct

Configurable Product (Proxy)

Implements

• Product

Fields

Name	Description
_id ID!
sequence Int!
status ProductStatus!
tags [LowerCaseString!]
created DateTime
updated DateTime
published DateTime
media [ProductMedia!]!	Arguments Name Description limit Int offset Int tags [LowerCaseString!]
texts ProductTexts	Arguments Name Description forceLocale String
assortmentPaths [ProductAssortmentPath!]!
siblings [Product!]!	Arguments Name Description assortmentId ID limit Int offset Int includeInactive Boolean
reviews [ProductReview!]!	Arguments Name Description limit Int offset Int sort [SortOptionInput!] queryString String
reviewsCount Int!	Arguments Name Description queryString String
catalogPriceRange PriceRange	Arguments Name Description quantity Int vectors [ProductAssignmentVectorInput!] includeInactive Boolean currency String
simulatedPriceRange PriceRange	Arguments Name Description quantity Int vectors [ProductAssignmentVectorInput!] includeInactive Boolean currency String useNetPrice Boolean
products [Product!]	Reduced list of possible products by key/value combinations Arguments Name Description vectors [ProductAssignmentVectorInput!] includeInactive Boolean
variations [ProductVariation!]	Product's variations (keys) and their options (values)
assignments [ProductVariationAssignment!]!	Complete assignment matrix Arguments Name Description includeInactive Boolean

Contact

Fields

Name	Description
telNumber String
emailAddress String

ContractConfiguration

Fields

Name	Description
tokenId String!
supply Int!
ercMetadataProperties JSON

Country

Fields

Name	Description
_id ID!
isoCode String	ISO 3166-1 alpha-2 https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
isActive Boolean
isBase Boolean
defaultCurrency Currency
flagEmoji String
name String	Arguments Name Description forceLocale String

Currency

Fields

Name	Description
_id ID!
isoCode String!
isActive Boolean
contractAddress String
decimals Int

DeliveryInterface

Fields

Name	Description
_id ID!
label String
version String

DeliveryProvider

Fields

Name	Description
_id ID!
created DateTime
updated DateTime
deleted DateTime
type DeliveryProviderType
interface DeliveryInterface
configuration JSON
configurationError DeliveryProviderError
isActive Boolean
simulatedPrice Price	Arguments Name Description currency String useNetPrice Boolean orderId ID context JSON

Dimensions

Fields

Name	Description
weight Float	Arguments Name Description unit MassUnit
length Float	Arguments Name Description unit LengthUnit
width Float	Arguments Name Description unit LengthUnit
height Float	Arguments Name Description unit LengthUnit

DiscountInterface

Fields

Name	Description
_id ID!
label String
version String
isManualAdditionAllowed Boolean
isManualRemovalAllowed Boolean

Dispatch

Fields

Name	Description
_id ID!
deliveryProvider DeliveryProvider
warehousingProvider WarehousingProvider
shipping DateTime
earliestDelivery DateTime

Enrollment

Enrollment

Fields

Name	Description
_id ID!
billingAddress Address
contact Contact
country Country
created DateTime!
currency Currency
delivery EnrollmentDelivery
enrollmentNumber String
expires DateTime
isExpired Boolean	Arguments Name Description referenceDate Timestamp
payment EnrollmentPayment
periods [EnrollmentPeriod!]!
plan EnrollmentPlan!
status EnrollmentStatus!
updated DateTime
user User!

EnrollmentDelivery

Fields

Name	Description
provider DeliveryProvider

EnrollmentPayment

Fields

Name	Description
provider PaymentProvider

EnrollmentPeriod

Fields

Name	Description
start DateTime!
end DateTime!
isTrial Boolean!
order Order

EnrollmentPlan

Fields

Name	Description
product PlanProduct!
quantity Int!
configuration [ProductConfigurationParameter!]

Event

Fields

Name	Description
_id ID!
type String!
payload JSON
created Timestamp!

EventStatistics

Fields

Name	Description
type EventType!
emitCount Int!

Filter

Fields

Name	Description
_id ID!
updated DateTime
created DateTime
isActive Boolean
texts FilterTexts	Arguments Name Description forceLocale String
type FilterType
key String
options [FilterOption!]

FilterOption

Fields

Name	Description
_id ID!
texts FilterTexts	Arguments Name Description forceLocale String
value String

FilterTexts

Fields

Name	Description
_id ID!
locale Locale
title String
subtitle String

GeoPosition

Fields

Name	Description
latitude Float!
longitude Float!
altitute Float

Language

Fields

Name	Description
_id ID!
isoCode String	ISO 639-1 alpha-2 https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
isActive Boolean
isBase Boolean
name String

Link

Fields

Name	Description
href String
title String
target ExternalLinkTarget

LoadedFilter

Fields

Name	Description
productsCount Int!
filteredProductsCount Int!
definition Filter!
isSelected Boolean
options [LoadedFilterOption!]

LoadedFilterOption

Fields

Name	Description
filteredProductsCount Int!
definition FilterOption!
isSelected Boolean

LoginMethodResponse

Type returned when the user logs in

Fields

Name	Description
_id String!	Session ID
tokenExpires DateTime!	Expiration date for the token
user User	The logged in user

Media

Fields

Name	Description
_id ID!
name String!
type String!
size Int!
url String!	Arguments Name Description version String baseUrl String

MediaUploadTicket

Fields

Name	Description
_id ID!
putURL String!
expires DateTime!

Order

Just an order

Fields

Name	Description
_id ID!
billingAddress Address
confirmed DateTime
rejected DateTime
contact Contact
country Country
created DateTime
currency Currency
delivery OrderDelivery
discounts [OrderDiscount!]
enrollment Enrollment
fullfilled DateTime
items [OrderItem!]
ordered DateTime
orderNumber String
payment OrderPayment
status OrderStatus
supportedDeliveryProviders [DeliveryProvider!]!
supportedPaymentProviders [PaymentProvider!]!
total Price	Arguments Name Description category OrderPriceCategory useNetPrice Boolean
updated DateTime
user User

OrderDeliveryDiscount

Implements

• OrderDiscountable

Fields

Name	Description
_id ID!
orderDiscount OrderDiscount!
delivery OrderDelivery!
total Price!

OrderDeliveryPickUp

Implements

• OrderDelivery

Fields

Name	Description
_id ID!
provider DeliveryProvider
status OrderDeliveryStatus
delivered DateTime
fee Price
discounts [OrderDeliveryDiscount!]
pickUpLocations [OrderPickUpLocation!]!
activePickUpLocation OrderPickUpLocation

OrderDeliveryShipping

Implements

• OrderDelivery

Fields

Name	Description
_id ID!
provider DeliveryProvider
status OrderDeliveryStatus
delivered DateTime
fee Price
discounts [OrderDeliveryDiscount!]
address Address

OrderDiscount

Fields

Name	Description
_id ID!
trigger OrderDiscountTrigger!
code String
order Order!
interface DiscountInterface
total Price!	Arguments Name Description useNetPrice Boolean
discounted [OrderDiscountable!]

OrderGlobalDiscount

Implements

• OrderDiscountable

Fields

Name	Description
_id ID!
orderDiscount OrderDiscount!
order Order!
total Price!

OrderItem

Fields

Name	Description
_id ID!
product Product!
order Order!
quantity Int!
originalProduct Product!
quotation Quotation
unitPrice Price	Arguments Name Description useNetPrice Boolean
total Price	Arguments Name Description category OrderItemPriceCategory useNetPrice Boolean
discounts [OrderItemDiscount!]
dispatches [Dispatch!]
configuration [ProductConfigurationParameter!]
tokens [Token!]!

OrderItemDiscount

Implements

• OrderDiscountable

Fields

Name	Description
_id ID!
orderDiscount OrderDiscount!
item OrderItem!
total Price!

OrderPaymentCard

Implements

• OrderPayment

Fields

Name	Description
_id ID!
provider PaymentProvider
status OrderPaymentStatus
paid DateTime
fee Price
discounts [OrderPaymentDiscount!]

OrderPaymentDiscount

Implements

• OrderDiscountable

Fields

Name	Description
_id ID!
orderDiscount OrderDiscount!
payment OrderPayment!
total Price!

OrderPaymentGeneric

Implements

• OrderPayment

Fields

Name	Description
_id ID!
provider PaymentProvider
status OrderPaymentStatus
fee Price
paid DateTime
discounts [OrderPaymentDiscount!]

OrderPaymentInvoice

Implements

• OrderPayment

Fields

Name	Description
_id ID!
provider PaymentProvider
status OrderPaymentStatus
fee Price
paid DateTime
discounts [OrderPaymentDiscount!]

OrderPickUpLocation

Fields

Name	Description
_id ID!
order Order!
name String!
address Address
geoPoint GeoPosition

OrderStatistics

Fields

Name	Description
newCount Int!
checkoutCount Int!
rejectCount Int!
confirmCount Int!
fulfillCount Int!

PaymentCredentials

Fields

Name	Description
_id ID!
user User!
paymentProvider PaymentProvider!
token JSON
meta JSON
isValid Boolean!
isPreferred Boolean!

PaymentInterface

Fields

Name	Description
_id ID!
label String
version String

PaymentProvider

Fields

Name	Description
_id ID!
created DateTime
updated DateTime
deleted DateTime
type PaymentProviderType
interface PaymentInterface
configuration JSON
configurationError PaymentProviderError
isActive Boolean
simulatedPrice Price	Arguments Name Description currency String useNetPrice Boolean orderId ID context JSON

PlanProduct

Plan (Virtual Product that somebody can enroll to)

Implements

• Product

Fields

Name	Description
_id ID!
sequence Int!
status ProductStatus!
tags [LowerCaseString!]
created DateTime
updated DateTime
published DateTime
media [ProductMedia!]!	Arguments Name Description limit Int offset Int tags [LowerCaseString!]
texts ProductTexts	Arguments Name Description forceLocale String
catalogPrice Price	Arguments Name Description quantity Int currency String
leveledCatalogPrices [PriceLevel!]!	Arguments Name Description currency String
simulatedPrice Price	Arguments Name Description currency String useNetPrice Boolean quantity Int configuration [ProductConfigurationParameterInput!]
assortmentPaths [ProductAssortmentPath!]!	Arguments Name Description forceLocale String
siblings [Product!]!	Arguments Name Description assortmentId ID limit Int offset Int includeInactive Boolean
salesUnit String
salesQuantityPerUnit String
defaultOrderQuantity Int
reviews [ProductReview!]!	Arguments Name Description limit Int offset Int sort [SortOptionInput!] queryString String
reviewsCount Int!	Arguments Name Description queryString String
plan ProductPlanConfiguration

Price

Fields

Name	Description
_id ID!
isTaxable Boolean!
isNetPrice Boolean!
amount Int!
currency String!

PriceLevel

Fields

Name	Description
minQuantity Int!
maxQuantity Int
price Price!

PriceRange

Fields

Name	Description
_id ID!
minPrice Price!
maxPrice Price!

ProductAssortmentPath

Directed assortment to product paths (breadcrumbs)

Fields

Name	Description
assortmentProduct AssortmentProduct!
links [AssortmentPathLink!]!

ProductBundleItem

Fields

Name	Description
product Product!
quantity Int!
configuration [ProductConfigurationParameter!]

ProductCatalogPrice

Fields

Name	Description
_id ID!
isTaxable Boolean!
isNetPrice Boolean!
country Country!
currency Currency!
amount Int!
maxQuantity Int

ProductConfigurationParameter

Fields

Name	Description
key String!
value String!

ProductDiscount

Fields

Name	Description
_id ID!
interface DiscountInterface
total Price!

ProductMedia

Fields

Name	Description
_id ID!
tags [LowerCaseString!]
file Media!
sortKey Int!
texts ProductMediaTexts	Arguments Name Description forceLocale String

ProductMediaTexts

Fields

Name	Description
_id ID!
locale Locale
title String
subtitle String

ProductPlanConfiguration

Fields

Name	Description
usageCalculationType ProductPlanUsageCalculationType!
billingInterval ProductPlanConfigurationInterval!
billingIntervalCount Int
trialInterval ProductPlanConfigurationInterval
trialIntervalCount Int

ProductReview

Fields

Name	Description
_id ID!
created DateTime
updated DateTime
deleted DateTime
author User!
product Product!
rating Int
title String
review String
voteCount Int	Arguments Name Description type ProductReviewVoteType
ownVotes [ProductReviewVote!]!

ProductReviewVote

Fields

Name	Description
_id ID!
timestamp Timestamp!
type ProductReviewVoteType!

ProductSearchResult

Search result

Fields

Name	Description
productsCount Int!
filteredProductsCount Int!
filters [LoadedFilter!]!
products [Product!]!	Arguments Name Description limit Int offset Int

ProductTexts

Fields

Name	Description
_id ID!
locale Locale
slug String
title String
subtitle String
description String
vendor String
brand String
labels [String!]

ProductVariation

Fields

Name	Description
_id ID!
texts ProductVariationTexts	Arguments Name Description forceLocale String
type ProductVariationType
key String
options [ProductVariationOption!]

ProductVariationAssignment

Key Value Combination to Product Assignment

Fields

Name	Description
_id ID!
vectors [ProductVariationAssignmentVector!]	Query string key=val&key=val ...
product Product	Assigned Product

ProductVariationAssignmentVector

Key Value Combination

Fields

Name	Description
_id ID!
variation ProductVariation
option ProductVariationOption

ProductVariationOption

Fields

Name	Description
_id ID!
texts ProductVariationTexts	Arguments Name Description forceLocale String
value String

ProductVariationTexts

Fields

Name	Description
_id ID!
locale Locale
title String
subtitle String

PushSubscription

Fields

Name	Description
_id ID!
userAgent String
expirationTime Timestamp
endpoint String!

Quotation

Quotation

Fields

Name	Description
_id ID!
user User!
product Product!
status QuotationStatus!
created DateTime!
expires DateTime
updated DateTime
isExpired Boolean	Arguments Name Description referenceDate Timestamp
quotationNumber String
fullfilled DateTime
rejected DateTime
country Country
currency Currency
configuration [ProductConfigurationParameter!]

SearchResult

Search result

Fields

Name	Description
productsCount Int!
filteredProductsCount Int!
filters [LoadedFilter!]!
products [Product!]!	Arguments Name Description limit Int offset Int

Shop

Fields

Name	Description
_id ID!
language Language
country Country
version String
userRoles [String!]!
externalLinks [Link]!
adminUiConfig AdminUiConfig!
vapidPublicKey String

SimpleProduct

Simple Product

Implements

• Product

Fields

Name	Description
_id ID!
sequence Int!
status ProductStatus!
tags [LowerCaseString!]
created DateTime
updated DateTime
published DateTime
media [ProductMedia!]!	Arguments Name Description limit Int offset Int tags [LowerCaseString!]
texts ProductTexts	Arguments Name Description forceLocale String
catalogPrice Price	Arguments Name Description quantity Int currency String
leveledCatalogPrices [PriceLevel!]!	Arguments Name Description currency String
simulatedPrice Price	Arguments Name Description currency String useNetPrice Boolean quantity Int configuration [ProductConfigurationParameterInput!]
simulatedDispatches [Dispatch!]	Arguments Name Description deliveryProviderType DeliveryProviderType referenceDate Timestamp quantity Int
simulatedStocks [Stock!]	Arguments Name Description deliveryProviderType DeliveryProviderType referenceDate Timestamp
assortmentPaths [ProductAssortmentPath!]!
siblings [Product!]!	Arguments Name Description assortmentId ID limit Int offset Int includeInactive Boolean
dimensions Dimensions
sku String
baseUnit String
salesUnit String
salesQuantityPerUnit String
defaultOrderQuantity Int
reviews [ProductReview!]!	Arguments Name Description limit Int offset Int sort [SortOptionInput!] queryString String
reviewsCount Int!	Arguments Name Description queryString String

Stock

Fields

Name	Description
_id ID!
deliveryProvider DeliveryProvider
warehousingProvider WarehousingProvider
quantity Int

SuccessResponse

Fields

Name	Description
success Boolean

Token

Fields

Name	Description
_id ID!
product TokenizedProduct!
status TokenExportStatus!
quantity Int!
isInvalidateable Boolean!
accessKey String!	Get an access key that you can pass along the HTTP Header "x-token-accesskey" to access the token anonymously.
invalidatedDate DateTime
user User
expiryDate DateTime
contractAddress String
walletAddress String
chainId String
chainTokenId String
ercMetadata JSON	Arguments Name Description forceLocale String

TokenizedProduct

Tokenized Product (Blockchain materialized Product)

Implements

• Product

Fields

Name	Description
_id ID!
sequence Int!
status ProductStatus!
tags [LowerCaseString!]
created DateTime
updated DateTime
published DateTime
media [ProductMedia!]!	Arguments Name Description limit Int offset Int tags [LowerCaseString!]
texts ProductTexts	Arguments Name Description forceLocale String
catalogPrice Price	Arguments Name Description quantity Int currency String
leveledCatalogPrices [PriceLevel!]!	Arguments Name Description currency String
simulatedPrice Price	Arguments Name Description currency String useNetPrice Boolean quantity Int configuration [ProductConfigurationParameterInput!]
simulatedStocks [Stock!]	Arguments Name Description referenceDate Timestamp
assortmentPaths [ProductAssortmentPath!]!	Arguments Name Description forceLocale String
siblings [Product!]!	Arguments Name Description assortmentId ID limit Int offset Int includeInactive Boolean
reviews [ProductReview!]!	Arguments Name Description limit Int offset Int sort [SortOptionInput!] queryString String
reviewsCount Int!	Arguments Name Description queryString String
contractAddress String
contractStandard SmartContractStandard
contractConfiguration ContractConfiguration
tokens [Token!]!
tokensCount Int!

User

Fields

Name	Description
_id ID!
created DateTime!
updated DateTime
deleted DateTime
username String
isGuest Boolean!
isInitialPassword Boolean!
webAuthnCredentials [WebAuthnCredentials!]!
web3Addresses [Web3Address!]!
pushSubscriptions [PushSubscription!]!
name String!
avatar Media
profile UserProfile
language Language
country Country
lastBillingAddress Address
lastContact Contact
lastLogin UserLoginTracker
primaryEmail UserEmail
emails [UserEmail!]
roles [String!]
tags [LowerCaseString!]
cart Order	Arguments Name Description orderNumber String
orders [Order!]!	Arguments Name Description limit Int offset Int status [OrderStatus!] queryString String sort [SortOptionInput!] includeCarts Boolean
quotations [Quotation!]!	Arguments Name Description sort [SortOptionInput!] queryString String limit Int offset Int
bookmarks [Bookmark!]!
paymentCredentials [PaymentCredentials!]!
enrollments [Enrollment!]!	Arguments Name Description limit Int offset Int queryString String status [String!] sort [SortOptionInput!]
allowedActions [RoleAction!]!
tokens [Token!]!
reviews [ProductReview!]!	Arguments Name Description limit Int offset Int sort [SortOptionInput!]
reviewsCount Int!

UserEmail

Fields

Name	Description
address String!
verified Boolean!

UserLoginTracker

Fields

Name	Description
timestamp Timestamp!
remoteAddress String
remotePort String
userAgent String
locale Locale
countryCode String

UserProfile

Fields

Name	Description
displayName String
phoneMobile String
gender String
birthday Date
address Address

WarehousingInterface

Fields

Name	Description
_id ID!
label String
version String

WarehousingProvider

Fields

Name	Description
_id ID!
created DateTime
updated DateTime
deleted DateTime
type WarehousingProviderType
interface WarehousingInterface
configuration JSON
configurationError WarehousingProviderError
isActive Boolean

Web3Address

Fields

Name	Description
address String!
nonce Int
verified Boolean!

WebAuthnCredentials

Fields

Name	Description
_id ID!
created DateTime!
aaguid String!
counter Int!
mdsMetadata WebAuthnMDSv3Metadata

WebAuthnMDSv3Metadata

Fields

Name	Description
legalHeader String
description String
authenticatorVersion Int
protocolFamily String
schema Int
upv [JSON!]
authenticationAlgorithms [String!]
publicKeyAlgAndEncodings [String!]
attestationTypes [String!]
userVerificationDetails [JSON!]
keyProtection [String!]
matcherProtection [String!]
cryptoStrength Int
attachmentHint [String!]
tcDisplay [JSON!]
attestationRootCertificates [String!]
icon String
authenticatorGetInfo JSON

Work

Fields

Name	Description
_id ID!
started DateTime
finished DateTime
created DateTime!
updated DateTime
deleted DateTime
priority Int!
type WorkType!
status WorkStatus!
worker String
input JSON
result JSON
error JSON
success Boolean
scheduled DateTime
original Work
retries Int!
timeout Int
autoscheduled Boolean

WorkOutput

Fields

Name	Description
result JSON
error JSON
success Boolean!

WorkStatistics

Fields

Name	Description
type WorkType!
newCount Int!
startCount Int!
errorCount Int!
successCount Int!
deleteCount Int!