Types

Types

Address

Adjustment

Administrator

AdministratorList

Asset

AssetList

Boolean

The Boolean scalar type represents true or false.

BooleanCustomFieldConfig

Cancellation

Channel

Collection

CollectionBreadcrumb

CollectionList

CollectionTranslation

ConfigArg

ConfigArgDefinition

ConfigurableOperation

ConfigurableOperationDefinition

Country

CountryList

CountryTranslation

CurrentUser

CustomFieldConfig

CustomFields

Customer

CustomerGroup

CustomerList

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.

DateTimeCustomFieldConfig

Expects the same validation formats as the HTML element. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes

DeletionResponse

Facet

FacetList

FacetTranslation

FacetValue

FacetValueResult

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

FacetValueTranslation

Float

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

FloatCustomFieldConfig

Fulfillment

GlobalSettings

HistoryEntry

HistoryEntryList

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.

ImportInfo

Int

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

IntCustomFieldConfig

JSON

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

LocaleStringCustomFieldConfig

LocalizedString

LoginResult

Order

OrderAddress

OrderItem

OrderLine

OrderList

Payment

PaymentMethod

PriceRange

The price range where the result has more than one price

Product

ProductList

ProductOption

ProductOptionGroup

ProductOptionGroupTranslation

ProductOptionTranslation

ProductTranslation

ProductVariant

ProductVariantList

ProductVariantTranslation

Promotion

PromotionList

Refund

Return

Role

RoleList

Sale

SearchReindexResponse

SearchResponse

SearchResult

SearchResultPrice

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

union SearchResultPrice = PriceRange | SinglePrice

ServerConfig

ShippingMethod

ShippingMethodList

ShippingMethodQuote

SinglePrice

The price value where the result has a single price

StockAdjustment

StockMovementItem

union StockMovementItem = StockAdjustment | Sale | Cancellation | Return

StockMovementList

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.

StringCustomFieldConfig

StringFieldOption

TaxCategory

TaxRate

TaxRateList

Upload

The Upload scalar type represents a file upload.

User

Zone