Types

Types

Int

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

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.

AdministratorList

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.

Administrator

User

Boolean

The Boolean scalar type represents true or false.

Role

Channel

Zone

Country

CountryTranslation

JSON

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

Float

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

AssetList

Asset

CurrentUser

CollectionList

Collection

ConfigurableOperation

ConfigArg

CollectionTranslation

ProductVariantList

ProductVariant

TaxRate

TaxCategory

CustomerGroup

ProductOption

ProductOptionTranslation

FacetValue

Facet

FacetTranslation

FacetValueTranslation

ProductVariantTranslation

Config

  • customFields: JSON

CountryList

CustomerList

Customer

Address

OrderList

Order

OrderAddress

OrderLine

OrderItem

Adjustment

Payment

ShippingMethod

FacetList

GlobalSettings

ServerConfig

  • customFields: JSON

PaymentMethodList

PaymentMethod

ProductOptionGroup

ProductOptionGroupTranslation

SearchResponse

SearchResult

ProductList

Product

ProductTranslation

Promotion

PromotionList

AdjustmentOperations

RoleList

ShippingMethodList

TaxRateList

Upload

The Upload scalar type represents a file upload.

LoginResult

DeletionResponse

ImportInfo

SearchReindexResponse

ShippingMethodQuote

alpha