Skip to content

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

Input objects

26 input objects in the Evolve GraphQL schema.

Represents the basic structure for inputting an address, supporting both personal and business addresses.

Field Type Default 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. Required.
company String The company name for business addresses. This field is required for business addresses.
country String! The country where the address is located. Must be a valid 2-letter ISO country code.
email String The email address for contact, optional for both personal and business addresses. Must be a valid email format.
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 The unique identifier for the address.
phone String The phone number associated with this address, typically including the international code. Optional.
postalCode String! The postal code or ZIP code for the address, depending on the country. Required.
region String The region, state, or province for the address. Used to represent subdivisions of countries. Optional.
salutation Salutation The salutation or title for the person associated with the address (e.g., Mr., Ms.). Optional.
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. Required.
streetNumber String The number of the building on the street. This field represents the main address number. Required.
streetNumberSuffix String Additional suffixes to the street number, often used in countries like the Netherlands.

Input for Apple Pay payment validation

Field Type Default Description
displayName String! Display name for the merchant
domainName String! Domain name for validation
merchantIdentifier String! Merchant identifier

Input for authoringFinalizeUploadedAsset.

Field Type Default Description
contentType String! MIME type of the uploaded bytes (e.g. image/png, video/mp4).
description String Description / alt copy. Optional.
fileName String! Desired filename in CMS (e.g. tennisrackets-hero-1.png).
tags [String!] Tags applied to the asset (e.g. [“ai-generated”, “veo”]). Optional.
title String Display title for the Contentful asset library. Optional.
uploadId ID! sys.id from a successful Contentful upload service POST. The

Input for authoringPreparePublishEntries.

Field Type Default Description
entryIds [ID!]! Entry ids to prepare. Typically the entries[*].id list returned

Input for authoringPublishEntries.

Field Type Default Description
entryIds [ID!]! Entry ids to publish. Typically the entries[*].id list returned

Input for authoringPushPage.

Field Type Default Description
pageJson String! JSON-encoded PageData (gateway shape — ContentPage or

Input for creating a new line item

Field Type Default Description
quantity Int! Quantity to add
sku String! SKU of the product variant

Input for updating an existing line item

Field Type Default Description
id String! Line item ID to update
quantity Int! New quantity for the line item

Input for setting billing address on cart

Field Type Default Description
address AddressInput Customer billing address

Input for setting customer email on cart

Field Type Default Description
email String Customer email

Input for setting payment method on cart

Field Type Default Description
paymentMethod PaymentMethodInput Selected payment method for the cart

Input for setting shipping address on cart

Field Type Default Description
address AddressInput Customer shipping address

Input for setting shipping method on cart

Field Type Default Description
shippingMethod ShippingMethodInput Selected shipping method for the cart

Union of all cart update actions

Field Type Default Description
setBillingAddress CartSetBillingAddressInput Set billing address
setCustomerEmail CartSetCustomerEmailInput Set customer email
setPaymentMethod CartSetPaymentMethodInput Set payment method
setShippingAddress CartSetShippingAddressInput Set shipping address
setShippingMethod CartSetShippingMethodInput Set shipping method

Input data required to create a new customer account

Field Type Default Description
email EmailAddress! Email address for the customer account
familyName String Family name of the customer
givenName String Given name of the customer
password String! Password for the customer account
salutation Salutation Optional salutation for the customer
Field Type Default Description
key String! Unique key for the facet
max Float Required for Range Facets
min Float Required for Range Facets
selections [String!] Required for Options Facets
toggle Boolean Required for Toggle Facets
Field Type Default Description
key String! Filter condition key
value String! Filter condition value

Input for payment context when completing checkout or creating a payment

Field Type Default Description
cancelUrl String! URL to redirect to on cancelled payment
failureUrl String! URL to redirect to on failed payment
method PaymentMethodInput! Payment method details
orderId String Optional order ID to associate the payment with. Only relevant if we create
successUrl String! URL to redirect to on successful payment

Input for payment method argument key-value pairs

Field Type Default Description
key String! Argument key
value String! Argument value

Input for selecting a payment method

Field Type Default Description
arguments [PaymentMethodArgumentInput!] Additional arguments for the payment method
internalId String! Internal ID of the payment method
provider String! Payment provider name

Input data for creating a new quote request

Field Type Default Description
comment String Optional comment from the customer
purchaseOrderNumber String Optional purchase order number

Input for selecting a shipping method

Field Type Default Description
id String! ID of the shipping method

Input data for creating or updating a shopping list

Field Type Default Description
description String Optional description for the shopping list
name String! Name for the shopping list

Input data for adding a new item to a shopping list

Field Type Default Description
quantity Int Quantity of the item (optional, defaults to 1)
sku String! SKU of the product variant to add

Input data for updating an existing item in a shopping list

Field Type Default Description
id ID! ID of the line item to update
quantity Int New quantity for the line item
Field Type Default 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.