Types

Types

Channel

ID

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

DateTime

A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Zone

Country

Boolean

The Boolean scalar type represents true or false.

CountryTranslation

Customer

Address

JSON

The JSON scalar type represents JSON values as specified by ECMA-404.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

OrderList

Order

OrderAddress

OrderLine

ProductVariant

Asset

TaxRate

TaxCategory

CustomerGroup

ProductOption

ProductOptionTranslation

FacetValue

Facet

FacetTranslation

FacetValueTranslation

ProductVariantTranslation

OrderItem

Adjustment

Payment

ShippingMethod

ConfigurableOperation

ConfigArg

User

Role

CollectionList

Collection

CollectionBreadcrumb

CollectionTranslation

ProductVariantList

ShippingMethodQuote

CurrentUser

Product

ProductOptionGroup

ProductOptionGroupTranslation

ProductTranslation

ProductList

SearchResponse

SearchResult

SearchResultPrice

The price of a search result product, either as a range or as a single price

union SearchResultPrice = PriceRange | SinglePrice

PriceRange

The price range where the result has more than one price

SinglePrice

The price value where the result has a single price

FacetValueResult

Which FacetValues are present in the products returned by the search, and in what quantity.

LoginResult

AdjustmentOperations

Administrator

AdministratorList

AssetList

CountryList

CustomerList

DeletionResponse

FacetList

GlobalSettings

ServerConfig

  • customFields: JSON

ImportInfo

PaymentMethod

Promotion

PromotionList

RoleList

SearchReindexResponse

ShippingMethodList

TaxRateList

Upload

The Upload scalar type represents a file upload.

alpha