Skip to content

New: AI agent integration via Model Context Protocol (MCP).Learn more

Objects

184 objects in the Evolve GraphQL schema.

Represents the basic structure for an address, supporting both private and company addresses.

Field Type Description
additionalAddressInfo String Extra information regarding the address, such as building number, floor, or apartment number.
city String The city where the address is located.
company String The company name for business addresses. This field may be omitted for personal addresses.
country String! The country where the address is located. Must be provided.
email String The email address for contact, optional for both personal and business addresses.
familyName String The family name (last name) of the individual. May be left empty for company addresses.
givenName String The given name (first name) of the individual. May be left empty for company addresses.
id ID
phone String The phone number associated with this address, typically including the international code.
postalCode String! The postal code or ZIP code for the address, depending on the country.
region String The region, state, or province for the address. Used to represent subdivisions of countries.
salutation Salutation The salutation or title for the person associated with the address.
streetAddress String The unstructured full street address, including street name, number, and optional suffix.
streetName String The name of the street where the address is located.
streetNumber String The number of the building on the street. This field represents the main address number.
streetNumberSuffix String Additional suffixes to the street number, often used in countries like the Netherlands.

Paginated connection for addresses

Field Type Description
items [Address!]! List of address items in the current page
totalCount Int! Total number of addresses matching the query
Field Type Description
city String
country String
postalCode String
streetName String
streetNumber String
streetNumberSuffix String
Field Type Description
suggestions [AddressSuggestion]
valid Boolean!

Implements: PaymentMethodExtraFields

Field Type Description
brands [String!]
configuration PaymentMethodApplePayConfiguration
type String!

Implements: Error

Field Type Description
code AuthenticationErrorCode! Error code indicating the type of authentication failure
message String! Human readable error message describing the authentication failure. Not intended for end users.

A single asset returned by authoringSearchAssets.

Field Type Description
contentType String MIME type, e.g. image/jpeg.
description String Optional description / alt text.
height Int Image height in pixels, if known.
id ID! Stable id of the asset (CMS-side entry id).
title String! Display title.
updatedAt String ISO timestamp of the asset’s last update.
url String CDN URL of the asset, if available.
width Int Image width in pixels, if known.

Paginated authoring asset search results.

Field Type Description
results [AuthoringAssetSearchItem!]! List of asset search items.
total Int! Total number of assets matching the criteria.

A single entry returned by authoringSearchEntries.

Field Type Description
contentType String! CMS content-type id (e.g. heroBlock).
id ID! Stable id of the entry (CMS-side entry id).
internalName String Optional internal name (used by editors for disambiguation).
title String! Display title (best-effort across title / label / name).
updatedAt String ISO timestamp of the entry’s last update.

Paginated authoring entry search results.

Field Type Description
results [AuthoringEntrySearchItem!]! List of entry search items.
total Int! Total number of entries matching the criteria.

Result of a successful authoringFinalizeUploadedAsset mutation.

Field Type Description
assetId ID! Real Contentful Asset id.
contentType String! Echoed MIME type.
url String! Public CDN URL of the uploaded asset (after processing).

Per-page summary returned by authoringListPages.

Field Type Description
author String Last editor’s display name, or null if not resolvable.
id ID!
kind AuthoringPageKind!
slug String!
status AuthoringPageStatus!
title String!
updatedAt String! ISO timestamp of the last edit.

Result of a authoringPreparePublishEntries pass.

Field Type Description
fixed [AuthoringPreparePublishFix!]! List of locale-backfill writes that were applied.
ready [ID!]! Entry ids that are now publish-ready. Empty when unfixable is
unfixable [AuthoringPreparePublishUnfixable!]! Validation issues backfill couldn’t resolve (e.g. enum mismatches,

Describes a single locale-backfill write.

Field Type Description
entryId ID! Entry the fix was applied to.
field String! Field id (e.g. name, slug).
locale String! Locale code that was missing and is now filled (e.g. en-GB).
sourceLocale String! Locale code we copied the value from (e.g. nl-NL).

Describes a validation issue that deterministic backfill can’t resolve.

Field Type Description
entryId ID! Entry the issue belongs to.
entryUrl String! Direct URL to open the entry in the Contentful web app for manual repair.
field String! Field id with the problem.
reason String! Human-readable reason — surfaced verbatim back to the editor.

Result of an authoringPublishEntries bulk publish.

Field Type Description
bulkActionId ID! Contentful bulk-action id, useful for cross-referencing in CF logs.
errors [AuthoringPublishEntryError!]! Per-entry error messages, if any. Empty on full success.
failed Int! Number of entries that failed to publish.
published Int! Number of entries published successfully.
status AuthoringPublishStatus! Terminal status reported by Contentful’s bulk action.

Error against a single entry within a bulk publish.

Field Type Description
entryId ID! Real Contentful entry id.
message String! Error message string (CF’s error code + details, truncated).

Per-entry summary returned by authoringPushPage.

Field Type Description
contentType String! Contentful content type id (e.g. hero, productRow).
id ID! Real Contentful entry id.
title String! Human-readable title used in the Contentful UI.

Locales used by the push.

Field Type Description
default String! Contentful space default locale (used for non-localized fields).
request String! Storefront request locale (used for localized fields like slug).

Result of a successful authoringPushPage mutation.

Field Type Description
canonicalPath String! Canonical page slug as written to CF (locale prefix stripped, leading
contentfulUrl String! Direct URL to open the page in the Contentful web app.
entries [AuthoringPushedEntry!]! List of all entries (page + nested blocks) touched by the push.
locales AuthoringPushLocales! Which locale(s) the push wrote to. Localized fields land in
pageEntryId ID! Real Contentful entry id of the page itself.
stats AuthoringPushStats! Counts of created / updated / unchanged entries during the push.

Counts returned by authoringPushPage.

Field Type Description
created Int!
unchanged Int!
updated Int!

Represents a single item in a breadcrumb trail.

Field Type Description
name String! Name of the breadcrumb item.
path String! Path of the breadcrumb item.
type BreadcrumbType! Type of the breadcrumb item.
Field Type Description
id ID! Unique identifier for the business unit
address Address Address of the business unit (args: id)
addresses AddressConnection! Addresses of the business unit (args: page, pageSize, searchTerm)
associate BusinessUnitAssociate An associate of the business unit (args: id)
associates BusinessUnitAssociateConnection! Associates of the business unit (args: page, pageSize, searchTerm)
availableRoles [BusinessUnitRole!]! Available roles that can be assigned to customers in this business unit
billingAddress Address Billing address of the business unit
name String! Name of the business unit
shoppingList ShoppingList A shopping list of the business unit (args: id)
shoppingLists ShoppingListResult Shopping lists of the business unit (args: page, pageSize)
stores [Store!] Stores assigned to the business unit
order Order Get a specific order by order number (args: orderNumber)
orders OrderResult Get a paginated list of orders for this business unit (args: page, pageSize, searchTerm)
quote Quote Get a specific quote by its ID (args: id)
quoteRequest QuoteRequest Get a specific quote request by its ID (args: id)
quoteRequests QuoteRequestResult Get a paginated list of quote requests (args: page, pageSize)
quotes QuoteResult Get a paginated list of quotes (args: page, pageSize)
Field Type Description
businessUnit BusinessUnit Updated business unit information with new address
businessUnitErrors [BusinessUnitAddressCreateError!]! Error details if address creation failed
Field Type Description
businessUnit BusinessUnit Updated business unit information after address deletion
businessUnitErrors [BusinessUnitAddressDeleteError!]! Error details if address deletion failed
Field Type Description
businessUnit BusinessUnit Updated business unit information with modified address
businessUnitErrors [BusinessUnitAddressUpdateError!]! Error details if address update failed

Customer associated with a business unit, including their assigned roles

Field Type Description
createdAt DateTime! Date and time when the associate was created
email EmailAddress! Email address of the associate
familyName String Last name of the associate
givenName String First name of the associate
id ID! Unique identifier for the associate
roles [BusinessUnitRole!]! Roles assigned to the customer in the business unit
salutation Salutation Optional salutation for the associate

Paginated connection for business unit associates

Field Type Description
items [BusinessUnitAssociate!]! List of associate items in the current page
totalCount Int! Total number of associates matching the query
Field Type Description
businessUnit BusinessUnit Updated business unit information with new associate
businessUnitErrors [BusinessUnitAssociateInviteError!]! Error details if associate invitation failed
Field Type Description
businessUnit BusinessUnit Updated business unit information after associate removal
businessUnitErrors [BusinessUnitAssociateRemoveError!]! Error details if associate removal failed
Field Type Description
businessUnit BusinessUnit Updated business unit information with modified associate roles
businessUnitErrors [BusinessUnitAssociateRolesUpdateError!]! Error details if associate roles update failed

Roles that can be assigned to customers in a business unit

Field Type Description
id ID! Unique identifier for the role
name String! Name of the role

Represents a single button element.

Field Type Description
id ID! Unique identifier for the button.
link ResourceLink! Link associated with the button.
title String! Title text of the button.
variant ButtonVariant! Visual variant of the button.

Represents a group of buttons.

Field Type Description
buttons [Button!]! List of buttons in the group.
id ID! Unique identifier for the buttons group.

Shopping cart containing line items and checkout information

Field Type Description
id ID! Unique identifier of the cart
availablePaymentMethods [PaymentMethod!]! Payment methods that are available for the cart (args: device)
availableShippingMethods [ShippingMethod!]! Shipping methods that are available for the cart
billingAddress Address Customer billing address
createdAt DateTime! Creation date of the cart
currency String! The currency used in the cart
customerEmail String Customer email
discountCodes [CartDiscountCode!]! Discount codes that are applied to the cart
discountTotal Money Sum of all discounts
isGuest Boolean! Indicates if the cart is a guest cart
lastModifiedAt DateTime! Last modified date of the cart
lineItems [CartLineItem!]! Line items in the cart
selectedPaymentMethod PaymentMethod Selected payment method for the cart
selectedShippingMethod ShippingMethod Selected shipping method for the cart
shippingAddress Address Customer shipping address
shippingCosts TaxedPrice Shipping costs, if any
subTotal TaxedTotalPrice! Sum of all line items (i.e. price excluding all shipping and payment costs)
total TaxedTotalPrice! Sum of all line items (i.e. price including all shipping and payment costs)
totalQuantity Int! Total quantity of all line items

A CartDiscountCode represents a discount that is applied to the cart

Field Type Description
amount Money! The discount amount applied
code String! The discount code string used
id ID! Unique identifier for the discount code

Response for adding discount code to cart

Field Type Description
cart Cart Cart information after discount code is added
cartErrors [CartDiscountCodeAddError!]! Error details if discount code addition failed

Response for removing discount code from cart

Field Type Description
cart Cart Cart information after discount code is removed
cartErrors [CartDiscountCodeRemoveError!]! Error details if discount code removal failed

A recoverable error that occurred during a cart operation

Implements: Error

Field Type Description
code CartErrorCode! The error code identifying the cart operation failure
message String!

Response for adding line items to cart

Field Type Description
cart Cart Cart information after line items are added
cartErrors [CartLineItemsAddError!]! Error details if line item addition failed

Response for removing line items from cart

Field Type Description
cart Cart Cart information after line items are removed
cartErrors [CartLineItemsRemoveError!]! Error details if line item removal failed

Response for updating line items in cart

Field Type Description
cart Cart Cart information after line items are updated
cartErrors [CartLineItemsUpdateError!]! Error details if line item update failed

Individual line item in a cart

Implements: CartLineItem

Field Type Description
addedAt String Date when the line item was added
availableStock Int! Available stock for the product variant
id ID! Unique identifier for the line item
listPrice TaxedPrice! The list price (MSRP)
price TaxedPrice! The final price after applying discounts
productName String! Product name for the line item
productSlug String Product slug for URL generation
quantity Int! Number of items in the line item
regularPrice TaxedPrice! The regular selling price on the platform
variant ProductVariant! Product variant details

Response for cart update operations

Field Type Description
cart Cart Cart information after update
cartErrors [CartUpdateError!]! Error details if update failed

Represents a block of catalog pages, typically used for navigation or categorization.

Field Type Description
format CatalogBlockFormat! Format of the catalog block, e.g., ‘round’, ‘card’.
id ID! Unique identifier for the catalog block.
items [CatalogBlockItem!]! List of catalog block items.
title String! Title of the catalog block.

Represents a catalog block item with its associated content.

Field Type Description
id ID! Unique identifier for the catalog block item.
image ContentAsset! Image asset for the catalog block item.
link ResourceLink! Link associated with the catalog block item.
title String! Title of the catalog block item.

Represents a catalog page with catalog specific content, e.g. a product listing of all products in a category or a pre-defined search query.

Implements: AbstractPage

Field Type Description
id ID! Unique identifier for the product listing page.
categoryId String Identifier of the category associated with this product listing.
productListingConfig ProductListingConfig!
bottomContent [Block!] Bottom content of the product listing page, composed of various block types.
breadcrumbs [Breadcrumb!] Breadcrumb trail for the product listing page.
hero HeroBlock Hero section of the product listing page.
meta PageMeta Page metadata for SEO and other purposes.
name String! Name of the product listing page.
path String! URL path of the product listing page.
teaserRow TeasersBlock Teaser row displayed on the product listing page.
topContent [Block!] Top content of the product listing page, composed of various block types.
translatedPaths [TranslatedPath!] List of translated paths for different locales.

Category-based facet for hierarchical filtering (e.g., categories, collections)

Field Type Description
key String! Unique key for the facet (e.g., ‘sustainable’)
label String! Display label for the facet (e.g., ‘Sustainable’)
options [FacetValue!]! Available options for this facet

Category overview page displaying child categories and navigation

Field Type Description
breadcrumbs [Breadcrumb!]! The breadcrumbs representing the navigation path to the page.
category ProductCategory The parent category for this overview page
childCategories [ProductCategory!]! Child categories displayed on this overview page
indexable Boolean Indicates whether the page is indexable for search engines.
meta PageMeta Page metadata for SEO and other purposes
name String The name of the page.
path String! The URL path of the category overview page

Order information returned after successful checkout completion

Field Type Description
orderId String! Unique identifier of the created order
orderNumber String! Human-readable order number

Error that occurred during checkout completion

Implements: Error

Field Type Description
code CheckoutCompleteErrorCode! Error code identifying the type of error
message String! Human-readable error message

Response for checkout completion

Field Type Description
checkoutCompleteErrors [CheckoutCompleteErrorUnion!]! Error details if checkout completion failed
redirectURL String URL to redirect the customer to for payment

Represents a content asset, such as an image or file.

Field Type Description
alt String Alternative text for the asset.
filename String! Filename of the asset.
isExternalUrl Boolean Indicates if the asset URL is external.
name String Name of the asset.
title String Title of the asset.

Represents a content page with various sections and blocks.

Implements: AbstractPage

Field Type Description
id ID! Unique identifier for the content page.
body [Block] Main content body of the page, composed of various block types.
breadcrumbs [Breadcrumb!] Breadcrumb trail for the content page.
hero HeroBlock Hero section of the content page.
meta PageMeta Page metadata for SEO and other purposes.
name String! Name of the content page.
path String! URL path of the content page.
translatedPaths [TranslatedPath!] List of translated paths for different locales.

Represents a snippet of content that can be used in various places.

Field Type Description
content [Block!] Content for the snippet.
id ID! Unique identifier for the content snippet.
key String! Key for identifying the content snippet.

Represents a table structure in content.

Field Type Description
tbody [[String!]!] Table body rows.
thead [String!] Table header row.

Response type for creating a guest session

Field Type Description
success Boolean! Whether the guest session was created successfully

Response for creating a payment

Field Type Description
payment PaymentData Payment data if payment creation succeeded
paymentErrors [CreatePaymentErrorUnion!]! Error details if payment creation failed

Customer account information with personal details and business context

Field Type Description
email String! Email address of the customer
addresses [Address!] List of addresses associated with the customer
billingAddress Address Primary billing address for the customer
businessUnit BusinessUnit Get a specific business unit by ID that the customer has access to (args: id)
businessUnits [BusinessUnit!] List of all business units the customer has access to
company String Company name for business customers
createdAt DateTime! Date and time when the customer account was created
familyName String Last name of the customer
givenName String First name of the customer
id ID! Unique identifier for the customer
salutation Salutation Optional salutation for the customer
shoppingList ShoppingList Get a specific shopping list by ID for the customer (args: id)
shoppingLists ShoppingListResult Get paginated shopping lists for the customer (args: page, pageSize)
vatNumber String VAT identification number for business customers
order Order Get a specific order by order number (args: orderNumber)
orders OrderResult Get a paginated list of orders for this customer (args: page, pageSize, searchTerm)
Field Type Description
customer Customer Updated customer account information with new address
customerErrors [CustomerAddressCreateError!]! Error details if address creation failed
Field Type Description
customer Customer Updated customer account information after address deletion
customerErrors [CustomerAddressDeleteError!]! Error details if address deletion failed
Field Type Description
customer Customer Updated customer account information with modified address
customerErrors [CustomerAddressUpdateError!]! Error details if address update failed
Field Type Description
customer Customer Created customer account information
customerErrors [CustomerCreateError!]! Error details if account creation failed
Field Type Description
customerErrors [CustomerDeleteError!]! Error details if deletion failed
success Boolean Indicates if the deletion was successful
Field Type Description
customer Customer Updated customer account information
customerErrors [CustomerEmailUpdateError!]! Error details if email update failed

Result type for checking if a customer exists

Field Type Description
result Boolean! Whether a customer with the given email exists
Field Type Description
customer Customer Updated customer account information
customerErrors [CustomerInformationUpdateError!]! Error details if update failed
Field Type Description
customer Customer Authenticated customer account information
customerErrors [CustomerLoginError!]! Error details if authentication failed
Field Type Description
customerErrors [Error!]! Error details if authentication failed
success Boolean! Authenticated customer account information
Field Type Description
customerErrors [CustomerPasswordResetRequestError!]! Error details if the request failed
success Boolean! Indicates if the password reset request was successful
Field Type Description
customer Customer Updated customer account information after password reset
customerErrors [CustomerPasswordResetError!]! Error details if the password reset failed
Field Type Description
customer Customer Updated customer account information after password reset
customerErrors [CustomerPasswordUpdateError!]! Error details if the password update failed

Dimension option specific for this variant (see ProductVariantDimension for available options)

Field Type Description
key String! The key of the dimension (e.g. ‘color’)
label String! The translated label of the dimension (e.g. ‘Color’ or ‘Kleur’)
value String! The value of the dimension (e.g. ‘#ff0000’)
valueLabel String! The translated value label of the dimension (e.g. ‘Red’ or ‘Rood’)

Represents a divider element, typically used for visual separation in content.

Field Type Description
id ID! Unique identifier for the divider.

Individual value option within a facet with count information

Field Type Description
count Int! Number of products matching this facet value
key String! Unique key for the facet value (e.g., ‘red’)
label String! Display label for the facet value (e.g., ‘Red’)
selected Boolean! Whether this facet value is currently selected
Field Type Description
groups [FaqGroup!]!
id ID! Unique identifier for the Faq.
link ResourceLink
title String!
Field Type Description
id ID! Unique identifier for the Faq group.
items [FaqItem!]! List of FAQ items.
title String! Title of the FAQ item list.
Field Type Description
answer RichText!
id ID! Unique identifier for the Faq item.
question String!
Field Type Description
code String! The error code for the validation issue
field String!
message String! human-readable message describing the error. This message is not intended
Field Type Description
key String! Filter condition key
value String! Filter condition value

Represents a hero section typically used at the top of a page.

Field Type Description
bodyText RichText Body text of the hero section.
buttons [Button!] Buttons displayed in the hero section.
id ID! Unique identifier for the hero section.
image ContentAsset! Image asset used in the hero section.
imagePosition ImagePosition! Position of the image in the hero section.
imageStyle ImageStyle! Style of the image in the hero section.
title String! Title of the hero section.

Represents a single image with its associated content.

Field Type Description
id ID! Unique identifier for the image.
image ContentAsset!

Represents links to various information pages of a website.

Field Type Description
business ResourceLink Link to the business information page.
cookies ResourceLink Link to the cookies policy page.
privacy ResourceLink Link to the privacy policy page.
service ResourceLink Link to the customer service page.
terms ResourceLink Link to the terms and conditions page.

Localized URL slug for different language versions

Field Type Description
locale String! The locale for this slug
slug String! The localized slug value

Represents a block of menu items.

Field Type Description
id ID! Unique identifier for the menu block.
label String! Label for the menu block.
menuLinks [ResourceLink!]! List of links in the menu block.

Represents a single item in a menu.

Field Type Description
id ID! Unique identifier for the menu item.
label String Label text for the menu item.
subMenuItems [MenuItem!] Sub-menu items under this menu item.
target MenuLinkTarget Target link or category for the menu item.
Field Type Description
centAmount Int!
currency Currency!
Field Type Description
id ID! Unique identifier for the navigation menu.
key String! Key for identifying the navigation menu for a brand.
menuItems [NavigationMenuItem] Top level navigation menu items.
Field Type Description
extraContent [NavigationContent] Extra content shown in the navigation menu item.
icon ContentAsset Icon for the navigation menu item.
id ID! Unique identifier for the navigation menu item.
link ResourceLink Link to the resource associated with the navigation menu item.
menuItems [NavigationMenuItem] Sub menu items within the navigation menu item.
name String Label text for the navigation menu item.

Represents a one-column layout structure.

Field Type Description
column1 [ColumnEntry!]! Content blocks for the first column.
id ID! Unique identifier for the one-column layout.

Open Graph protocol metadata for social media sharing

Field Type Description
description String Open Graph description.
image String Open Graph image URL.
title String Open Graph title.

Multi-option facet for categorical filtering (e.g., color, brand)

Field Type Description
key String! Unique key for the facet (e.g., ‘color’)
label String! Display label for the facet (e.g., ‘Color’)
options [FacetValue!]! Available options for this facet

Complete order information including customer details, line items, and status

Field Type Description
id ID! Unique identifier for the order
billingAddress Address Billing address for the order
availablePaymentMethods [PaymentMethod!]! Available payment methods for the order. Country is required to determine the available payment methods (args: device)
createdAt DateTime! Date and time when the order was created
createdBy String The user or system that created the order
currency String! Currency used for the order
customerEmail EmailAddress Email address of the customer who placed the order
discountCodes [OrderDiscountCode!]! Discount codes that were applied to the cart
discountTotal Money Sum of all discounts
isGuest Boolean! Indicates if the order was placed by a guest customer
lineItems [OrderLineItem!]! Line items in the order
orderNumber String! Human-readable order number
orderStatus OrderStatus OrderStatus contains a general status of the order. This is useful for
selectedPaymentMethod PaymentMethod Payment method selected for the order
shippingAddress Address Shipping address for the order
shippingCosts TaxedPrice Shipping costs for the order
shippingNotice String Special shipping notice or instructions
subTotal TaxedTotalPrice! Sum of all line items (i.e. price excluding all shipping and payment costs)
total TaxedTotalPrice! Total price of the order including all costs
vatShifting Money VAT shifting amount for reverse charge mechanism. This applies when the VAT

An OrderDiscountCode represents a discount that was applied to the order. These are identified by their discount code.

Field Type Description
amount Money! The discount amount applied
code String! The discount code string used
id ID! Unique identifier for the discount code

Paginated result containing orders and metadata

Field Type Description
results [Order!]! List of orders returned in the result
total Int! Total count of orders matching the query criteria

Individual line item in an order containing product details and pricing information

Implements: OrderLineItem

Field Type Description
id ID! Unique identifier for the line item
listPrice TaxedPrice! Represents the list price, also known as te Manufacturer’s Suggested Retail
name String! Name of the line item
price TaxedPrice! The line-item is the final price after applying any additional discounts on
quantity Int! Number of items in the line item
regularPrice TaxedPrice! The regular selling price on the platform, potentially already discounted
variant ProductVariant! Product variant details for this line item

Implements: PaymentMethodExtraFields

Field Type Description
type String!

Page metadata for SEO

Field Type Description
description String Description of the page
keywords [String] SEO keywords for the page
openGraph OpenGraph Open Graph metadata for the page
title String Title of the page

Represents the result of a query for multiple pages.

Field Type Description
results [Page!]! List of pages returned in the result.
total Int! Total number of pages matching the query.

Represents a page title.

Field Type Description
id ID! Unique identifier for the page title.
title String!

Implements: Error

Field Type Description
code PasswordChangeErrorCode! Error code indicating the specific password change failure
message String! Human readable error message describing the password change failure. Not intended for end users.

Implements: Error

Field Type Description
code PasswordResetErrorCode! Error code indicating the specific password reset failure
message String! Human readable error message describing the password reset failure. Not intended for end users.
Field Type Description
id ID!

Error that occurred during payment creation

Implements: Error

Field Type Description
code PaymentCreateErrorCode! Error code indicating the specific payment creation failure
message String! Human readable error message describing the payment creation failure. Not intended for end users.

Payment processing data including redirect information

Field Type Description
redirectURL String! URL to redirect the customer to
Field Type Description
extra PaymentMethodExtra
id ID! Unique identifier of the payment method
internalId String! Internal identifier of the payment method for the provider
issuers [PaymentMethodOption!]
name String! Human readable name of the payment method (localized)
provider String! Payment method provider
Field Type Description
merchantId String!
merchantName String!
Field Type Description
id ID! Unique identifier of the payment method option
name String! Human readable name of the payment method (localized)

Product entity containing all product information, variants, and metadata.

Field Type Description
id ID! Unique identifier for the product
brand String Brand of the product
categories [ProductCategory!] The categories to which the product belongs.
image ProductImage The primary image associated with the product.
localizedSlugs [LocalizedSlug!]! Localized slugs for different locales (args: locales)
meta ResourceMeta Metadata for the product
name String! Name of the product
primaryCategory ProductCategory The primary category to which the product belongs.
relatedProducts [Product!] Products that are similar. E.g. the same t-shirt in another color.
reviews Reviews Customer reviews for the product
slug String! URL-friendly slug for the product
startingPrice TaxedPrice The lowest price of all variants, often used to communicate the price on the product list page.
variant ProductVariant! A specific variant, often used to show data in a product card. If no sku is given then the primary variant is returned. (args: sku)
variantDimensions [ProductVariantDimension!]! Product variant dimensions for the product with selection options (args: selectedSku)
variants [ProductVariant!]! A list of all variants, often used to show all available options in a product detail page. (args: sku)
articles [ContentPage!] Related content articles for the product.
breadcrumbs [Breadcrumb!]

Represents a row of product teasers.

Field Type Description
id ID! Unique identifier for the product row.
productVariants [ProductVariant!]! List of product variants in the row.
title String! Title of the product row.
viewMoreLink ResourceLink Link for viewing more products.

Paginated result containing product category pages

Field Type Description
results [ProductCategoryPage!]! List of category pages in the result
total Int! Total number of categories matching the criteria

Represents a category of products.

Field Type Description
id ID! Unique identifier for the product category.
key String! Unique key for the product category
ancestors [ProductCategory!]! Ancestor categories in the category hierarchy
description String Description of the product category
name String! Name of the product category
path String! URL path for the category

Product category page containing products and metadata

Field Type Description
breadcrumbs [Breadcrumb!]! The breadcrumbs representing the navigation path to the page.
category ProductCategory! The product category associated with this page
indexable Boolean Indicates whether the page is indexable for search engines.
meta PageMeta Page metadata for SEO and other purposes
name String The name of the page.
path String! The URL path of the category page
productListingConfig ProductListingConfig! Configuration for the product listing on this page

Reference to a product entity with basic information

Field Type Description
name String Name of the referenced product entity
path String Path to the referenced product entity

Standard product image with URL and accessibility information

Field Type Description
url String! The URL to the image.
alt String Alternative text for the image
description String Description of the image

360-degree product image set for interactive viewing

Field Type Description
alt String Alternative text for the 360° image set
description String Description of the 360° image set
urls [String!]! A list of URLs to the images.
Field Type Description
categoryId String! Category ID for the product listing
defaultOrder ProductSortOrder Default sort order for products
enabledFacets [String!] List of enabled facet keys
prefilters [FilterCondition!] Pre-applied filters for the listing
Field Type Description
kind String NEW, SALE, etc.
label String Text in the ribbon

Implements: AbstractProductSpecificationAttribute

Field Type Description
description String Optional descriptive information about the attribute, Localized to the current locale
label String! The label of the attribute, e.g. ‘Is fragile’. Localized to the current locale
name String! The name of the attribute, e.g. ‘isFragile’. Consistent across all locales
value Boolean! The boolean value of the attribute, e.g. true

Implements: AbstractProductSpecificationAttribute

Field Type Description
description String Optional descriptive information about the attribute, Localized to the current locale
label String! The label of the attribute, e.g. ‘Available from’. Localized to the current locale
name String! The name of the attribute, e.g. ‘availableFrom’. Consistent across all locales
value DateTime! The datetime value of the attribute, e.g. 2024-08-14T07:52:15.520Z

Implements: AbstractProductSpecificationAttribute

Field Type Description
description String Optional descriptive information about the attribute, Localized to the current locale
label String! The label of the attribute, e.g. ‘Season’. Localized to the current locale
name String! The name of the attribute, e.g. ‘season’. Consistent across all locales
value ProductSpecificationEnumValue! The enum value of the attribute

Implements: AbstractProductSpecificationAttribute

Field Type Description
description String Optional descriptive information about the attribute, Localized to the current locale
label String! The label of the attribute, e.g. ‘Audiences’. Localized to the current locale
name String! The name of the attribute, e.g. ‘audiences’. Consistent across all locales
values [ProductSpecificationEnumValue]! The enumc values of the attribute
Field Type Description
label String! The label of the enum, e.g. ‘green’. Consistent across all locales
value String! The string value of the enum, e.g. ‘Green’
Field Type Description
attributes [ProductSpecificationAttribute!]! Attributes for this specification group. These reflect a list of all the attributes associated with this specification group.
description String Optional descriptive information about the specification group, Localized to the current locale
label String! The label of the specification group, e.g. ‘Technical’. Localized to the current locale
name String! The name of the specification group, e.g. ‘technical’. Consistent across all locales

Implements: AbstractProductSpecificationAttribute

Field Type Description
description String Optional descriptive information about the attribute, Localized to the current locale
label String! The label of the attribute, e.g. ‘Length’. Localized to the current locale
name String! The name of the attribute, e.g. ‘length’. Consistent across all locales
value Float! The integer value of the attribute, e.g. 1

Implements: AbstractProductSpecificationAttribute

Field Type Description
description String Optional descriptive information about the attribute, Localized to the current locale
label String! The label of the attribute, e.g. ‘Size’. Localized to the current locale
name String! The name of the attribute, e.g. ‘size’. Consistent across all locales
value String! The string value of the attribute, e.g. ‘XL’. Localized to the current locale

Paginated result containing products and available facets for filtering

Field Type Description
facets [Facet!] Available facets for filtering
results [Product!]! List of products in the result
total Int! Total number of products matching the criteria

Specific variant of a product with unique SKU, pricing, and attributes

Field Type Description
sku String The SKU (stock keeping unit) for the variant.
id ID! Unique identifier for the variant
name String The name of the variant.
primaryImage ProductImage The main image associated with the product variant.
availability ProductAvailability Availability status of the variant
deliveryTime String A description about when the product can be delivered. For example: Ordered
description String The variant description, can be formatted using Markdown.
dimensions [Dimension!]! The dimensions specific to the product variant. Used to display the dimensions of the variant.
ean String European Article Number (EAN)
highlightedSpecifications [ProductSpecificationAttribute!] Highlighted specifications for this variant. These are a subset of the full specifications that are particularly
hscode String Harmonized System (HS) code for the variant.
images [ProductImage!] All images associated with the product variant.
listPrice TaxedPrice Represents the list price, also known as te Manufacturer’s Suggested Retail
price TaxedPrice The price on the platform after regular product discounts are applied, it’s
product Product Backlink to the product. This is useful for the frontend to fetch product information if the entrypoint was the
regularPrice TaxedPrice The regular selling price on the platform, potentially already discounted
ribbon ProductRibbon The ribbon. For example: ‘Boeket van de maand’ etc.
specifications [ProductSpecificationGroup!] Specifications for this variant. These reflect predefined groups of attributes that can be used to describe the

Product variant dimension containing selectable options (e.g., size, color)

Field Type Description
label String! Display label for the dimension
name String! Internal name of the dimension
options [ProductVariantDimensionOption!]! Available options for this dimension

Color-based product variant dimension option with hex color value

Implements: ProductVariantDimensionOption

Field Type Description
availability ProductAvailability
color String! Hex value of the color used to display the option.
label String!
product Product
selected Boolean!
value String!
variant ProductVariant

Image-based product variant dimension option (e.g., pattern, style)

Implements: ProductVariantDimensionOption

Field Type Description
availability ProductAvailability
label String!
product Product
selected Boolean!
value String!
variant ProductVariant

Text-based product variant dimension option (e.g., size, material)

Implements: ProductVariantDimensionOption

Field Type Description
availability ProductAvailability
label String!
product Product
selected Boolean!
value String!
variant ProductVariant

YouTube video embedded as product media

Field Type Description
alt String Alternative text for the video
description String Description of the video
videoId String! The YouTube video ID.

Quote provided by merchant in response to a quote request

Field Type Description
id QuoteIdentifier! Quote identifier containing id and version
billingAddress Address Customer billing address
comment String Comment from the customer
createdAt DateTime! Creation date of the quote
lineItems [QuoteSingleLineItem!]! Line items in the quote
purchaseOrderNumber String Purchase order number entered by the client
shippingAddress Address Customer shipping address
status QuoteStatus! Status of the quote
total TaxedTotalPrice Sum of all line items

Identifier for a quote with version control

Field Type Description
id ID! Unique identifier for the quote
version Int! Version number for optimistic concurrency control

Quote request created by a customer

Field Type Description
id QuoteIdentifier! Quote identifier containing id and version
billingAddress Address Customer billing address
comment String Comment from the customer
createdAt DateTime! Creation date of the quote
lineItems [QuoteSingleLineItem!]! Line items in the quote
purchaseOrderNumber String Purchase order number entered by the client
shippingAddress Address Customer shipping address
status QuoteRequestStatus! Status of the quote
total TaxedTotalPrice Sum of all line items

Response for quote request creation

Field Type Description
quoteRequest QuoteRequest! Quote request created
quoteRequestErrors [QuoteRequestCreateError!]! Error details if creation failed

Identifier for a quote request with version control

Field Type Description
id ID! Unique identifier for the quote request
version Int! Version number for optimistic concurrency control

Paginated result containing quote requests

Field Type Description
results [QuoteRequest!]! List of quote requests
total Int! Total count of quote requests

Paginated result containing quotes

Field Type Description
results [Quote!]! List of quotes
total Int! Total count of quotes

Individual line item in a quote

Implements: QuoteLineItem

Field Type Description
id ID! Unique identifier for the line item
listPrice TaxedPrice! The list price (MSRP)
name String! Product name for the line item
price TaxedPrice! The final price after applying discounts
quantity Int! Number of items
regularPrice TaxedPrice! The regular selling price on the platform
variant ProductVariant! Product variant details

Range-based facet for numeric filtering (e.g., price, rating)

Field Type Description
key String! Unique key for the facet (e.g., ‘price’)
label String! Display label for the facet (e.g., ‘Price’)
max Int! Maximum value in the range
min Int! Minimum value in the range
selectedMax Int Currently selected maximum value
selectedMin Int Currently selected minimum value
Field Type Description
refreshTokenErrors [RefreshTokenError!]! Error details if token refresh failed
success Boolean Indicates if the token refresh was successful

Represents a link to a resource, either internal or external.

Field Type Description
anchor String The anchor within the page or content that the link points to, if applicable.
asset ContentAsset Asset for the link.
id ID CF entry id when this link is sourced from a real Contentful entry (the common case via mapResourceLink). Synthetic links built ad-hoc in resolvers (header / site config) leave this null. Authoring push relies on this to match an incoming link to its existing entry — without it every save creates a new Untitled draft and dangles the previous reference.
name String Name of the linked resource.
newTab Boolean Indicates if the link should open in a new tab.
type ResourceLinkType! Type of the resource link.
value String The URL or identifier for the content link, which can be a product ID, category ID, or page path.

Metadata for a resource

Field Type Description
description String Description metadata
title String Title metadata
Field Type Description
amount Int! The number of reviews for the product.
averageRating Float! The average rating for the product.

Represents rich text content.

Field Type Description
content String! Content of the rich text.
id ID! Unique identifier for the rich text content.
renderer RichTextRenderer Renderer used for the rich text content.
Field Type Description
setActiveBusinessContextErrors [SetActiveBusinessContextError!]! Error details if setting active business context failed
success Boolean Indicates if setting active business context was successful
Field Type Description
description String Description of the shipping method
id ID! Unique identifier of the shipping method
key String! Unique key of the shipping method
name String! Name of the shipping method
price Money! Price of the shipping method.

Customer shopping list containing saved products for future purchase

Field Type Description
id ID! Unique identifier for the shopping list
description String Optional description of the shopping list
items [ShoppingListLineItem!]! Items in the shopping list
name String! Name of the shopping list
Field Type Description
shoppingList ShoppingList Created shopping list information
shoppingListErrors [ShoppingListCreateError!]! Error details if creation failed
Field Type Description
shoppingListErrors [ShoppingListDeleteError!]! Error details if deletion failed
success Boolean!

Individual item within a shopping list containing product and quantity information

Field Type Description
id ID! Unique identifier for the line item
quantity Int! Quantity of the item in the shopping list
slug String URL slug for the product (optional)
variant ProductVariant! Product variant for this line item
Field Type Description
shoppingList ShoppingList Updated shopping list information after line item operation
shoppingListErrors [ShoppingListLineItemAddError!]! Error details if line item operation failed
Field Type Description
shoppingList ShoppingList Updated shopping list information after line item operation
shoppingListErrors [ShoppingListLineRemoveError!]! Error details if line item operation failed
Field Type Description
shoppingList ShoppingList Updated shopping list information after line item operation
shoppingListErrors [ShoppingListLineUpdateError!]! Error details if line item operation failed

Paginated result containing shopping lists and metadata

Field Type Description
results [ShoppingList!]! List of shopping lists returned in the result
total Int! Total count of shopping lists matching the query criteria
Field Type Description
shoppingList ShoppingList Updated shopping list information
shoppingListErrors [ShoppingListUpdateError!]! Error details if update failed

Represents a website with various components and settings.

Field Type Description
id ID! Unique identifier for the site.
mainMenu [MenuItem!] Main menu items for the site.
Field Type Description
bottomBarLinks [ResourceLink!] Bottom links for the footer.
footerMenu [MenuBlock!] Footer menu blocks for the site.
paymentMethods [ResourceLink!] Payment method assets for the site.
socials [ResourceLink!] Social media links with icons for the site.
Field Type Description
id ID! Unique identifier for the header.
logo ContentAsset Logo asset for the header.
siteRating SiteRating Site rating for the header.
topBarLinks [ResourceLink!] Top bar links for the header.
usps [Usp!]! USPs (Unique Selling Points) in the header.

Site layout configuration including header, footer, and navigation

Field Type Description
footer SiteFooter Footer configuration for the site
header SiteHeader Header configuration for the site
navigation NavigationMenu Navigation menu configuration for the site
Field Type Description
count Int! Number of reviews for the site.
link ResourceLink Review site link for the site.
value Float! Average rating for the site.

Represents social media links for a website.

Field Type Description
facebook String Facebook profile URL.
instagram String Instagram profile URL.
linkedIn String LinkedIn profile URL.
twitter String Twitter profile URL.
youtube String YouTube channel URL.

Physical or virtual store location within a business unit

Field Type Description
id ID! Unique identifier for the store
name String! Name of the store

Represents data for storing content previews.

Field Type Description
id ID Identifier for the stored content preview data.
Field Type Description
data StoreContentPreviewData Response containing the stored content preview data.
previewErrors [Error!] List of errors encountered while storing the content preview.
Field Type Description
currency String! The currency used in the store context.
locale String! The locale of the store context. For example: en-US.
storeKey String! The store key associated with the store context.
Field Type Description
rate Float! Rate of the tax line item as percentage from 0 to 1.
value Money! Value in money of the tax line item.
Field Type Description
gross Money!
net Money!
tax Tax!

A total price consists of items that can have different tax rates.

Field Type Description
gross Money!
net Money!
taxes [Tax!]!

Represents a single teaser item.

Field Type Description
content String! Content of the teaser.
id ID! Unique identifier for the teaser.
image ContentAsset! Image asset for the teaser.
link ResourceLink! Link associated with the teaser.
title String! Title of the teaser.

Represents a content teaser with additional styling options.

Field Type Description
content String! Content of the teaser.
id ID! Unique identifier for the content teaser.
image ContentAsset! Image asset for the content teaser.
imagePosition ImagePosition! Position of the image in the content teaser.
link ResourceLink! Link associated with the content teaser.
title String! Title of the content teaser.

Represents a row of teasers.

Field Type Description
id ID! Unique identifier for the teaser row.
items [Teaser!]! List of teasers in the row.
title String! Title of the teaser row.
viewMoreLink ResourceLink Link for viewing more content. If empty, no view more button will be shown.

Represents a three-column layout structure.

Field Type Description
column1 [ColumnEntry!]! Content blocks for the first column.
column2 [ColumnEntry!]! Content blocks for the second column.
column3 [ColumnEntry!]! Content blocks for the third column.
id ID! Unique identifier for the three-column layout.

Boolean toggle facet for binary filtering (e.g., in stock, on sale)

Field Type Description
key String! Unique key for the facet (e.g., ‘sustainable’)
label String! Display label for the facet (e.g., ‘Sustainable’)
options [FacetValue!]! Toggle options (exactly 2: true and false)

Represents a translated path for a specific locale.

Field Type Description
locale String! The locale of the translated path.
path String! The translated path for the given locale.

Represents a two-column layout structure.

Field Type Description
column1 [ColumnEntry!]! Content blocks for the first column.
column2 [ColumnEntry!]! Content blocks for the second column.
id ID! Unique identifier for the two-column layout.
ratio TwoColumnsRatio! Ratio of the two columns.

Represents a single Unique Selling Point (USP).

Field Type Description
id ID! Unique identifier for the USP (Unique Selling Point).
link ResourceLink Optional link associated with the USP.
title String! Title of the USP.

Represents a list of Unique Selling Points (USPs).

Field Type Description
format UspBlockFormat Format of the USP list, e.g., ‘horizontal’, ‘vertical’.
id ID! Unique identifier for the USP list.
items [Usp!]! List of USPs.

Represents a group of Unique Selling Points (USPs).

Field Type Description
id ID! Unique identifier for the USPs group.
usp1 String! First USP (Unique Selling Point).
usp2 String! Second USP (Unique Selling Point).
usp3 String! Third USP (Unique Selling Point).
usp4 String Fourth USP (Unique Selling Point) (optional).
Field Type Description
applePayErrors [ValidateApplePayPaymentError!]! Error details if validation failed
data String Encrypted Apple Pay payment data

Implements: Error

Field Type Description
fields [FieldValidationIssue!]!
message String!

Represents a video with its associated content.

Field Type Description
autoplay Boolean! Whether the video should autoplay when loaded.
controls Boolean! Whether the video should show controls like play/pause, volume, etc.
id ID! Unique identifier for the video.
loop Boolean! Whether the video should loop when it reaches the end.
youtubeId String! The YouTube video ID.