🆕 Try our new beta documentation!

Discord logo GitHub star counter

Types

AddFulfillmentToOrderResult

union AddFulfillmentToOrderResult = Fulfillment | EmptyOrderLineSelectionError | ItemsAlreadyFulfilledError | InsufficientStockOnHandError | InvalidFulfillmentHandlerError | FulfillmentStateTransitionError | CreateFulfillmentError

AddManualPaymentToOrderResult

union AddManualPaymentToOrderResult = Order | ManualPaymentStateError

Address

Adjustment

Administrator

AdministratorList

Allocation

AlreadyRefundedError

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

ApplyCouponCodeResult

union ApplyCouponCodeResult = Order | CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError

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

union CancelOrderResult = Order | EmptyOrderLineSelectionError | QuantityTooGreatError | MultipleOrderError | CancelActiveOrderError | OrderStateTransitionError

CancelPaymentError

Returned if the Payment cancellation fails

CancelPaymentResult

union CancelPaymentResult = Payment | CancelPaymentError | PaymentStateTransitionError

Cancellation

Channel

ChannelDefaultLanguageError

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

ChannelList

Collection

CollectionBreadcrumb

CollectionList

CollectionResult

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

CollectionTranslation

ConfigArg

ConfigArgDefinition

ConfigurableOperation

ConfigurableOperationDefinition

Coordinate

Country

CountryList

CouponCodeExpiredError

Returned if the provided coupon code is invalid

CouponCodeInvalidError

Returned if the provided coupon code is invalid

CouponCodeLimitError

Returned if the provided coupon code is invalid

CreateAssetResult

union CreateAssetResult = Asset | MimeTypeError

CreateChannelResult

union CreateChannelResult = Channel | LanguageNotAvailableError

CreateCustomerResult

union CreateCustomerResult = Customer | EmailAddressConflictError

CreateFulfillmentError

Returned if an error is thrown in a FulfillmentHandler’s createFulfillment method

CreatePromotionResult

union CreatePromotionResult = Promotion | MissingConditionsError

CurrentUser

CurrentUserChannel

CustomFieldConfig

union CustomFieldConfig = StringCustomFieldConfig | LocaleStringCustomFieldConfig | IntCustomFieldConfig | FloatCustomFieldConfig | BooleanCustomFieldConfig | DateTimeCustomFieldConfig | RelationCustomFieldConfig | TextCustomFieldConfig | LocaleTextCustomFieldConfig

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

Discount

EmailAddressConflictError

Returned when attempting 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

FacetInUseError

FacetList

FacetTranslation

FacetValue

FacetValueList

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

FulfillmentLine

FulfillmentStateTransitionError

Returned when there is an error in transitioning the Fulfillment state

GlobalSettings

GuestCheckoutError

Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it.

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

IneligibleShippingMethodError

Returned when attempting to set a ShippingMethod for which the Order is not eligible

InsufficientStockError

Returned when attempting to add more items to the Order than are available

InsufficientStockOnHandError

Returned if attempting to create a Fulfillment when there is insufficient stockOnHand of a ProductVariant to satisfy the requested quantity.

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

InvalidFulfillmentHandlerError

Returned if the specified FulfillmentHandler code is 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

JobBufferSize

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

LocaleTextCustomFieldConfig

LocalizedString

ManualPaymentStateError

Returned when a call to addManualPaymentToOrder is made but the Order is not in the required state.

MetricSummary

MetricSummaryEntry

MimeTypeError

MissingConditionsError

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

ModifyOrderResult

union ModifyOrderResult = Order | NoChangesSpecifiedError | OrderModificationStateError | PaymentMethodMissingError | RefundPaymentIdMissingError | OrderLimitError | NegativeQuantityError | InsufficientStockError | CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError

Money

The Money scalar type represents monetary values and supports signed double-precision fractional values as specified by IEEE 754.

MultipleOrderError

Returned if an operation has specified OrderLines from multiple Orders

NativeAuthStrategyError

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

NativeAuthenticationResult

union NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError

NegativeQuantityError

Returned when attempting to set a negative OrderLine quantity.

NoActiveOrderError

Returned when invoking a mutation which depends on there being an active Order on the current session.

NoChangesSpecifiedError

Returned when a call to modifyOrder fails to specify any changes

NothingToRefundError

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

Order

  • nextStates: [String!]!
  • modifications: [OrderModification!]!
  • sellerOrders: [Order!]
  • aggregateOrder: Order
  • aggregateOrderId: ID
  • channels: [Channel!]!
  • id: ID!
  • createdAt: DateTime!
  • updatedAt: DateTime!
  • type: OrderType!
  • // The date & time that the Order was placed, i.e. the Customer completed the checkout and the Order is no longer “active”
  • orderPlacedAt: DateTime
  • // A unique code for the Order
  • code: String!
  • state: String!
  • // An order is active as long as the payment process has not been completed
  • active: Boolean!
  • customer: Customer
  • shippingAddress: OrderAddress
  • billingAddress: OrderAddress
  • lines: [OrderLine!]!
  • // Surcharges are arbitrary modifications to the Order total which are neither ProductVariants nor discounts resulting from applied Promotions. For example, one-off discounts based on customer interaction, or surcharges based on payment methods.
  • surcharges: [Surcharge!]!
  • discounts: [Discount!]!
  • // An array of all coupon codes applied to the Order
  • couponCodes: [String!]!
  • // Promotions applied to the order. Only gets populated after the payment process has completed.
  • promotions: [Promotion!]!
  • payments: [Payment!]
  • fulfillments: [Fulfillment!]
  • totalQuantity: Int!
  • // The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine. To get a total of all OrderLines which does not account for prorated discounts, use the sum of OrderLine.discountedLinePrice values.
  • subTotal: Money!
  • // Same as subTotal, but inclusive of tax
  • subTotalWithTax: Money!
  • currencyCode: CurrencyCode!
  • shippingLines: [ShippingLine!]!
  • shipping: Money!
  • shippingWithTax: Money!
  • // Equal to subTotal plus shipping
  • total: Money!
  • // The final payable amount. Equal to subTotalWithTax plus shippingWithTax
  • totalWithTax: Money!
  • // A summary of the taxes being applied to this Order
  • taxSummary: [OrderTaxSummary!]!
  • history(options: HistoryEntryListOptions): HistoryEntryList!
  • customFields: JSON

OrderAddress

OrderLimitError

Returned when the maximum order size limit has been reached.

OrderLine

  • id: ID!
  • createdAt: DateTime!
  • updatedAt: DateTime!
  • productVariant: ProductVariant!
  • featuredAsset: Asset
  • // The price of a single unit, excluding tax and discounts
  • unitPrice: Money!
  • // The price of a single unit, including tax but excluding discounts
  • unitPriceWithTax: Money!
  • // Non-zero if the unitPrice has changed since it was initially added to Order
  • unitPriceChangeSinceAdded: Money!
  • // Non-zero if the unitPriceWithTax has changed since it was initially added to Order
  • unitPriceWithTaxChangeSinceAdded: Money!
  • *// The price of a single unit including discounts, excluding tax.

If Order-level discounts have been applied, this will not be the actual taxable unit price (see proratedUnitPrice), but is generally the correct price to display to customers to avoid confusion about the internal handling of distributed Order-level discounts.*

  • discountedUnitPrice: Money!
  • // The price of a single unit including discounts and tax
  • discountedUnitPriceWithTax: Money!
  • // The actual unit price, taking into account both item discounts and prorated (proportionally-distributed) Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax and refund calculations.
  • proratedUnitPrice: Money!
  • // The proratedUnitPrice including tax
  • proratedUnitPriceWithTax: Money!
  • quantity: Int!
  • // The quantity at the time the Order was placed
  • orderPlacedQuantity: Int!
  • taxRate: Float!
  • // The total price of the line excluding tax and discounts.
  • linePrice: Money!
  • // The total price of the line including tax but excluding discounts.
  • linePriceWithTax: Money!
  • // The price of the line including discounts, excluding tax
  • discountedLinePrice: Money!
  • // The price of the line including discounts and tax
  • discountedLinePriceWithTax: Money!
  • // The actual line price, taking into account both item discounts and prorated (proportionally-distributed) Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax and refund calculations.
  • proratedLinePrice: Money!
  • // The proratedLinePrice including tax
  • proratedLinePriceWithTax: Money!
  • // The total tax on this line
  • lineTax: Money!
  • discounts: [Discount!]!
  • taxLines: [TaxLine!]!
  • order: Order!
  • fulfillmentLines: [FulfillmentLine!]
  • customFields: JSON

OrderList

OrderModification

OrderModificationError

Returned when attempting to modify the contents of an Order that is not in the AddingItems state.

OrderModificationLine

OrderModificationStateError

Returned when attempting to modify the contents of an Order that is not in the Modifying state.

OrderProcessState

OrderStateTransitionError

Returned if there is an error in transitioning the Order state

OrderTaxSummary

A summary of the taxes being applied to this order, grouped by taxRate.

  • // A description of this tax
  • description: String!
  • // The taxRate as a percentage
  • taxRate: Float!
  • // The total net price of OrderLines to which this taxRate applies
  • taxBase: Money!
  • // The total tax being applied to the Order at this taxRate
  • taxTotal: Money!

Payment

PaymentMethod

PaymentMethodList

PaymentMethodMissingError

Returned when a call to modifyOrder fails to include a paymentMethod even though the price has increased as a result of the changes.

PaymentMethodQuote

PaymentMethodTranslation

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

PermissionDefinition

PriceRange

The price range where the result has more than one price

Product

ProductList

ProductOption

ProductOptionGroup

ProductOptionGroupTranslation

ProductOptionInUseError

ProductOptionTranslation

ProductTranslation

ProductVariant

ProductVariantList

ProductVariantPrice

ProductVariantTranslation

Promotion

PromotionList

PromotionTranslation

Province

ProvinceList

QuantityTooGreatError

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

Refund

RefundLine

RefundOrderResult

union RefundOrderResult = Refund | QuantityTooGreatError | NothingToRefundError | OrderStateTransitionError | MultipleOrderError | PaymentOrderMismatchError | RefundOrderStateError | AlreadyRefundedError | RefundStateTransitionError

RefundOrderStateError

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

RefundPaymentIdMissingError

Returned when a call to modifyOrder fails to include a refundPaymentId even though the price has decreased as a result of the changes.

RefundStateTransitionError

Returned when there is an error in transitioning the Refund state

RegionTranslation

RelationCustomFieldConfig

Release

RemoveFacetFromChannelResult

union RemoveFacetFromChannelResult = Facet | FacetInUseError

RemoveOptionGroupFromProductResult

union RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError

RemoveOrderItemsResult

union RemoveOrderItemsResult = Order | OrderModificationError

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

Seller

SellerList

ServerConfig

SetCustomerForDraftOrderResult

union SetCustomerForDraftOrderResult = Order | EmailAddressConflictError

SetOrderShippingMethodResult

union SetOrderShippingMethodResult = Order | OrderModificationError | IneligibleShippingMethodError | NoActiveOrderError

SettlePaymentError

Returned if the Payment settlement fails

SettlePaymentResult

union SettlePaymentResult = Payment | SettlePaymentError | PaymentStateTransitionError | OrderStateTransitionError

SettleRefundResult

union SettleRefundResult = Refund | RefundStateTransitionError

ShippingLine

ShippingMethod

ShippingMethodList

ShippingMethodQuote

  • id: ID!
  • price: Money!
  • priceWithTax: Money!
  • code: String!
  • name: String!
  • description: String!
  • // Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult
  • metadata: JSON
  • customFields: JSON

ShippingMethodTranslation

SinglePrice

The price value where the result has a single price

StockAdjustment

StockLevel

StockLocation

StockLocationList

StockMovementItem

union StockMovementItem = StockAdjustment | Allocation | Sale | Cancellation | Return | Release

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.

Surcharge

Tag

TagList

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

TaxCategory

TaxCategoryList

TaxLine

TaxRate

TaxRateList

TestShippingMethodQuote

TestShippingMethodResult

TextCustomFieldConfig

TransitionFulfillmentToStateResult

union TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError

TransitionOrderToStateResult

union TransitionOrderToStateResult = Order | OrderStateTransitionError

TransitionPaymentToStateResult

union TransitionPaymentToStateResult = Payment | PaymentStateTransitionError

UpdateChannelResult

union UpdateChannelResult = Channel | LanguageNotAvailableError

UpdateCustomerResult

union UpdateCustomerResult = Customer | EmailAddressConflictError

UpdateGlobalSettingsResult

union UpdateGlobalSettingsResult = GlobalSettings | ChannelDefaultLanguageError

UpdateOrderItemsResult

union UpdateOrderItemsResult = Order | OrderModificationError | OrderLimitError | NegativeQuantityError | InsufficientStockError

UpdatePromotionResult

union UpdatePromotionResult = Promotion | MissingConditionsError

Upload

The Upload scalar type represents a file upload.

User

Zone

ZoneList

Generated on Jul 4 2023 at 13:02