Types

Types

AddFulfillmentToOrderResult

union AddFulfillmentToOrderResult = Fulfillment | EmptyOrderLineSelectionError | ItemsAlreadyFulfilledError

Address

Adjustment

Administrator

AdministratorList

AlreadyRefundedError

Returned if an attempting to refund an OrderItem which has already been refunded

Asset

AssetList

AuthenticationMethod

AuthenticationResult

union AuthenticationResult = CurrentUser | InvalidCredentialsError

Boolean

The Boolean scalar type represents true or false.

BooleanCustomFieldConfig

CancelActiveOrderError

Returned if an attempting to cancel lines from an Order which is still active

CancelOrderResult

Cancellation

Channel

ChannelDefaultLanguageError

Returned when the default LanguageCode of a Channel is no longer found in the availableLanguages of the GlobalSettings

Collection

CollectionBreadcrumb

CollectionList

CollectionTranslation

ConfigArg

ConfigArgDefinition

ConfigurableOperation

ConfigurableOperationDefinition

Coordinate

Country

CountryList

CountryTranslation

CreateAssetResult

union CreateAssetResult = Asset | MimeTypeError

CreateChannelResult

union CreateChannelResult = Channel | LanguageNotAvailableError

CreateCustomerResult

union CreateCustomerResult = Customer | EmailAddressConflictError

CreatePromotionResult

union CreatePromotionResult = Promotion | MissingConditionsError

CurrentUser

CurrentUserChannel

CustomFieldConfig

CustomFields

Customer

CustomerGroup

CustomerGroupList

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 <input type="datetime-local"> HTML element. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes

DeletionResponse

EmailAddressConflictError

Retured when attemting to create a Customer with an email address already registered to an existing User.

EmptyOrderLineSelectionError

Returned if no OrderLines have been specified for the operation

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

FulfillmentStateTransitionError

Returned when there is an error in transitioning the Fulfillment state

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

InvalidCredentialsError

Returned if the user authentication credentials are not valid

ItemsAlreadyFulfilledError

Returned if the specified items are already part of a Fulfillment

JSON

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

Job

JobList

  • items: [Job!]!
  • totalItems: Int!

JobQueue

LanguageNotAvailableError

Returned if attempting to set a Channel’s defaultLanguageCode to a language which is not enabled in GlobalSettings

LocaleStringCustomFieldConfig

LocalizedString

MimeTypeError

MissingConditionsError

Returned if a PromotionCondition has neither a couponCode nor any conditions set

MultipleOrderError

Returned if an operation has specified OrderLines from multiple Orders

NativeAuthStrategyError

Retured when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured.

NativeAuthenticationResult

union NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError

NothingToRefundError

Returned if an attempting to refund an Order but neither items nor shipping refund was specified

Order

OrderAddress

OrderItem

OrderLine

OrderList

OrderProcessState

OrderStateTransitionError

Returned if there is an error in transitioning the Order state

Payment

PaymentMethod

PaymentMethodList

PaymentOrderMismatchError

Returned if an attempting to refund a Payment against OrderLines from a different Order

PaymentStateTransitionError

Returned when there is an error in transitioning the Payment state

PriceRange

The price range where the result has more than one price

Product

ProductList

ProductOption

ProductOptionGroup

ProductOptionGroupTranslation

ProductOptionInUseError

ProductOptionTranslation

ProductTranslation

ProductVariant

ProductVariantList

ProductVariantTranslation

Promotion

PromotionList

QuantityTooGreatError

Returned if the specified quantity of an OrderLine is greater than the number of items in that line

Refund

RefundOrderResult

RefundOrderStateError

Returned if an attempting to refund an Order which is not in the expected state

RefundStateTransitionError

Returned when there is an error in transitioning the Refund state

RemoveOptionGroupFromProductResult

union RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError

Return

Role

RoleList

Sale

SearchReindexResponse

SearchResponse

SearchResult

SearchResultAsset

SearchResultPrice

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

union SearchResultPrice = PriceRange | SinglePrice

ServerConfig

SettlePaymentError

Returned if the Payment settlement fails

SettlePaymentResult

SettleRefundResult

union SettleRefundResult = Refund | RefundStateTransitionError

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

Success

Indicates that an operation succeeded, where we do not want to return any more specific information.

TaxCategory

TaxRate

TaxRateList

TestShippingMethodQuote

TestShippingMethodResult

TransitionFulfillmentToStateResult

union TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError

TransitionOrderToStateResult

union TransitionOrderToStateResult = Order | OrderStateTransitionError

UpdateChannelResult

union UpdateChannelResult = Channel | LanguageNotAvailableError

UpdateCustomerResult

union UpdateCustomerResult = Customer | EmailAddressConflictError

UpdateGlobalSettingsResult

union UpdateGlobalSettingsResult = GlobalSettings | ChannelDefaultLanguageError

UpdatePromotionResult

union UpdatePromotionResult = Promotion | MissingConditionsError

Upload

The Upload scalar type represents a file upload.

User

Zone