Input Objects
AddItemInput
AddItemToDraftOrderInput
inputAddItemToDraftOrderInput
AddNoteToCustomerInput
inputAddNoteToCustomerInput
AddNoteToOrderInput
AdjustDraftOrderLineInput
AdministratorFilterParameter
inputAdministratorFilterParameter
input AdministratorFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
firstName: StringOperators
lastName: StringOperators
emailAddress: StringOperators
_and: [AdministratorFilterParameter!]
_or: [AdministratorFilterParameter!]
}AdministratorListOptions
inputAdministratorListOptions
input AdministratorListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: AdministratorSortParameter
"""Allows the results to be filtered"""
filter: AdministratorFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}AdministratorPaymentInput
inputAdministratorPaymentInput
AdministratorRefundInput
inputAdministratorRefundInput
input AdministratorRefundInput {
paymentId: ID!
reason: String
"""
The amount to be refunded to this particular Payment. This was introduced in
v2.2.0 as the preferred way to specify the refund amount. The `lines`, `shipping` and `adjustment`
fields will be removed in a future version.
"""
amount: Money
}AdministratorSortParameter
inputAdministratorSortParameter
input AdministratorSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
firstName: SortOrder
lastName: SortOrder
emailAddress: SortOrder
}AssetFilterParameter
inputAssetFilterParameter
input AssetFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
type: StringOperators
fileSize: NumberOperators
mimeType: StringOperators
width: NumberOperators
height: NumberOperators
source: StringOperators
preview: StringOperators
_and: [AssetFilterParameter!]
_or: [AssetFilterParameter!]
}AssetListOptions
inputAssetListOptions
input AssetListOptions {
tags: [String!]
tagsOperator: LogicalOperator
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: AssetSortParameter
"""Allows the results to be filtered"""
filter: AssetFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}AssetSortParameter
inputAssetSortParameter
input AssetSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
fileSize: SortOrder
mimeType: SortOrder
width: SortOrder
height: SortOrder
source: SortOrder
preview: SortOrder
}AssignAssetsToChannelInput
inputAssignAssetsToChannelInput
input AssignAssetsToChannelInput {
assetIds: [ID!]!
channelId: ID!
}AssignCollectionsToChannelInput
inputAssignCollectionsToChannelInput
input AssignCollectionsToChannelInput {
collectionIds: [ID!]!
channelId: ID!
}AssignFacetsToChannelInput
inputAssignFacetsToChannelInput
input AssignFacetsToChannelInput {
facetIds: [ID!]!
channelId: ID!
}AssignPaymentMethodsToChannelInput
inputAssignPaymentMethodsToChannelInput
input AssignPaymentMethodsToChannelInput {
paymentMethodIds: [ID!]!
channelId: ID!
}AssignProductVariantsToChannelInput
inputAssignProductVariantsToChannelInput
AssignProductsToChannelInput
inputAssignProductsToChannelInput
AssignPromotionsToChannelInput
inputAssignPromotionsToChannelInput
input AssignPromotionsToChannelInput {
promotionIds: [ID!]!
channelId: ID!
}AssignShippingMethodsToChannelInput
inputAssignShippingMethodsToChannelInput
input AssignShippingMethodsToChannelInput {
shippingMethodIds: [ID!]!
channelId: ID!
}AssignStockLocationsToChannelInput
inputAssignStockLocationsToChannelInput
input AssignStockLocationsToChannelInput {
stockLocationIds: [ID!]!
channelId: ID!
}AuthenticationInput
inputAuthenticationInput
input AuthenticationInput {
native: NativeAuthInput
}BooleanListOperators
inputBooleanListOperators
"""Operators for filtering on a list of Boolean fields"""
input BooleanListOperators {
inList: Boolean!
}BooleanOperators
inputBooleanOperators
"""Operators for filtering on a Boolean field"""
input BooleanOperators {
eq: Boolean
isNull: Boolean
}CancelOrderInput
inputCancelOrderInput
input CancelOrderInput {
"""The id of the order to be cancelled"""
orderId: ID!
"""Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled"""
lines: [OrderLineInput!]
"""Specify whether the shipping charges should also be cancelled. Defaults to false"""
cancelShipping: Boolean
reason: String
}ChannelFilterParameter
inputChannelFilterParameter
input ChannelFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
code: StringOperators
token: StringOperators
defaultLanguageCode: StringOperators
currencyCode: StringOperators
defaultCurrencyCode: StringOperators
trackInventory: BooleanOperators
outOfStockThreshold: NumberOperators
pricesIncludeTax: BooleanOperators
_and: [ChannelFilterParameter!]
_or: [ChannelFilterParameter!]
}ChannelListOptions
inputChannelListOptions
input ChannelListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: ChannelSortParameter
"""Allows the results to be filtered"""
filter: ChannelFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}ChannelSortParameter
inputChannelSortParameter
input ChannelSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
token: SortOrder
outOfStockThreshold: SortOrder
}CollectionFilterParameter
inputCollectionFilterParameter
input CollectionFilterParameter {
isPrivate: BooleanOperators
inheritFilters: BooleanOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
slug: StringOperators
position: NumberOperators
description: StringOperators
parentId: IDOperators
productVariantCount: NumberOperators
_and: [CollectionFilterParameter!]
_or: [CollectionFilterParameter!]
}CollectionListOptions
inputCollectionListOptions
input CollectionListOptions {
topLevelOnly: Boolean
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: CollectionSortParameter
"""Allows the results to be filtered"""
filter: CollectionFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}CollectionSortParameter
inputCollectionSortParameter
input CollectionSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
slug: SortOrder
position: SortOrder
description: SortOrder
parentId: SortOrder
productVariantCount: SortOrder
}ConfigArgInput
inputConfigArgInput
input ConfigArgInput {
name: String!
"""A JSON stringified representation of the actual value"""
value: String!
}ConfigurableOperationInput
inputConfigurableOperationInput
input ConfigurableOperationInput {
code: String!
arguments: [ConfigArgInput!]!
}CoordinateInput
inputCoordinateInput
input CoordinateInput {
x: Float!
y: Float!
}CountryFilterParameter
inputCountryFilterParameter
input CountryFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
code: StringOperators
type: StringOperators
name: StringOperators
enabled: BooleanOperators
parentId: IDOperators
_and: [CountryFilterParameter!]
_or: [CountryFilterParameter!]
}CountryListOptions
inputCountryListOptions
input CountryListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: CountrySortParameter
"""Allows the results to be filtered"""
filter: CountryFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}CountrySortParameter
inputCountrySortParameter
input CountrySortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
type: SortOrder
name: SortOrder
parentId: SortOrder
}CountryTranslationInput
inputCountryTranslationInput
input CountryTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}CreateAddressInput
inputCreateAddressInput
"""
Input used to create an Address.
The countryCode must correspond to a `code` property of a Country that has been defined in the
Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
If an invalid code is passed, the mutation will fail.
"""
input CreateAddressInput {
fullName: String
company: String
streetLine1: String!
streetLine2: String
city: String
province: String
postalCode: String
countryCode: String!
phoneNumber: String
defaultShippingAddress: Boolean
defaultBillingAddress: Boolean
customFields: JSON
}CreateAdministratorInput
inputCreateAdministratorInput
CreateAssetInput
CreateChannelInput
inputCreateChannelInput
input CreateChannelInput {
code: String!
token: String!
defaultLanguageCode: LanguageCode!
availableLanguageCodes: [LanguageCode!]
pricesIncludeTax: Boolean!
currencyCode: CurrencyCode
defaultCurrencyCode: CurrencyCode
availableCurrencyCodes: [CurrencyCode!]
trackInventory: Boolean
outOfStockThreshold: Int
defaultTaxZoneId: ID!
defaultShippingZoneId: ID!
sellerId: ID
customFields: JSON
}CreateCollectionInput
inputCreateCollectionInput
input CreateCollectionInput {
isPrivate: Boolean
featuredAssetId: ID
assetIds: [ID!]
parentId: ID
inheritFilters: Boolean
filters: [ConfigurableOperationInput!]!
translations: [CreateCollectionTranslationInput!]!
customFields: JSON
}CreateCollectionTranslationInput
inputCreateCollectionTranslationInput
input CreateCollectionTranslationInput {
languageCode: LanguageCode!
name: String!
slug: String!
description: String!
customFields: JSON
}CreateCountryInput
inputCreateCountryInput
input CreateCountryInput {
code: String!
translations: [CountryTranslationInput!]!
enabled: Boolean!
customFields: JSON
}CreateCustomerGroupInput
inputCreateCustomerGroupInput
CreateCustomerInput
inputCreateCustomerInput
CreateFacetInput
inputCreateFacetInput
input CreateFacetInput {
code: String!
isPrivate: Boolean!
translations: [FacetTranslationInput!]!
values: [CreateFacetValueWithFacetInput!]
customFields: JSON
}CreateFacetValueInput
inputCreateFacetValueInput
input CreateFacetValueInput {
facetId: ID!
code: String!
translations: [FacetValueTranslationInput!]!
customFields: JSON
}CreateFacetValueWithFacetInput
inputCreateFacetValueWithFacetInput
input CreateFacetValueWithFacetInput {
code: String!
translations: [FacetValueTranslationInput!]!
}CreateGroupOptionInput
inputCreateGroupOptionInput
input CreateGroupOptionInput {
code: String!
translations: [ProductOptionGroupTranslationInput!]!
}CreatePaymentMethodInput
inputCreatePaymentMethodInput
input CreatePaymentMethodInput {
code: String!
enabled: Boolean!
checker: ConfigurableOperationInput
handler: ConfigurableOperationInput!
translations: [PaymentMethodTranslationInput!]!
customFields: JSON
}CreateProductInput
inputCreateProductInput
input CreateProductInput {
featuredAssetId: ID
enabled: Boolean
assetIds: [ID!]
facetValueIds: [ID!]
translations: [ProductTranslationInput!]!
customFields: JSON
}CreateProductOptionGroupInput
inputCreateProductOptionGroupInput
input CreateProductOptionGroupInput {
code: String!
translations: [ProductOptionGroupTranslationInput!]!
options: [CreateGroupOptionInput!]!
customFields: JSON
}CreateProductOptionInput
inputCreateProductOptionInput
input CreateProductOptionInput {
productOptionGroupId: ID!
code: String!
translations: [ProductOptionGroupTranslationInput!]!
customFields: JSON
}CreateProductVariantInput
inputCreateProductVariantInput
input CreateProductVariantInput {
productId: ID!
enabled: Boolean
translations: [ProductVariantTranslationInput!]!
facetValueIds: [ID!]
sku: String!
price: Money
prices: [CreateProductVariantPriceInput]
taxCategoryId: ID
optionIds: [ID!]
featuredAssetId: ID
assetIds: [ID!]
stockOnHand: Int
stockLevels: [StockLevelInput!]
outOfStockThreshold: Int
useGlobalOutOfStockThreshold: Boolean
trackInventory: GlobalFlag
customFields: JSON
}CreateProductVariantOptionInput
inputCreateProductVariantOptionInput
input CreateProductVariantOptionInput {
optionGroupId: ID!
code: String!
translations: [ProductOptionTranslationInput!]!
}CreateProductVariantPriceInput
inputCreateProductVariantPriceInput
input CreateProductVariantPriceInput {
currencyCode: CurrencyCode!
price: Money!
customFields: JSON
}CreatePromotionInput
inputCreatePromotionInput
input CreatePromotionInput {
enabled: Boolean!
startsAt: DateTime
endsAt: DateTime
couponCode: String
perCustomerUsageLimit: Int
usageLimit: Int
conditions: [ConfigurableOperationInput!]!
actions: [ConfigurableOperationInput!]!
translations: [PromotionTranslationInput!]!
customFields: JSON
}CreateProvinceInput
inputCreateProvinceInput
input CreateProvinceInput {
code: String!
translations: [ProvinceTranslationInput!]!
enabled: Boolean!
customFields: JSON
}CreateRoleInput
inputCreateRoleInput
input CreateRoleInput {
code: String!
description: String!
permissions: [Permission!]!
channelIds: [ID!]
}CreateSellerInput
CreateShippingMethodInput
inputCreateShippingMethodInput
input CreateShippingMethodInput {
code: String!
fulfillmentHandler: String!
checker: ConfigurableOperationInput!
calculator: ConfigurableOperationInput!
translations: [ShippingMethodTranslationInput!]!
customFields: JSON
}CreateStockLocationInput
inputCreateStockLocationInput
CreateTagInput
inputCreateTagInput
input CreateTagInput {
value: String!
}CreateTaxCategoryInput
inputCreateTaxCategoryInput
CreateTaxRateInput
inputCreateTaxRateInput
CreateZoneInput
CustomerFilterParameter
inputCustomerFilterParameter
input CustomerFilterParameter {
postalCode: StringOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
title: StringOperators
firstName: StringOperators
lastName: StringOperators
phoneNumber: StringOperators
emailAddress: StringOperators
_and: [CustomerFilterParameter!]
_or: [CustomerFilterParameter!]
}CustomerGroupFilterParameter
inputCustomerGroupFilterParameter
input CustomerGroupFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
_and: [CustomerGroupFilterParameter!]
_or: [CustomerGroupFilterParameter!]
}CustomerGroupListOptions
inputCustomerGroupListOptions
input CustomerGroupListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: CustomerGroupSortParameter
"""Allows the results to be filtered"""
filter: CustomerGroupFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}CustomerGroupSortParameter
inputCustomerGroupSortParameter
input CustomerGroupSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
}CustomerListOptions
inputCustomerListOptions
input CustomerListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: CustomerSortParameter
"""Allows the results to be filtered"""
filter: CustomerFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}CustomerSortParameter
inputCustomerSortParameter
input CustomerSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
title: SortOrder
firstName: SortOrder
lastName: SortOrder
phoneNumber: SortOrder
emailAddress: SortOrder
}DateListOperators
inputDateListOperators
"""Operators for filtering on a list of Date fields"""
input DateListOperators {
inList: DateTime!
}DateOperators
inputDateOperators
DateRange
inputDateRange
input DateRange {
start: DateTime!
end: DateTime!
}DeleteAssetInput
inputDeleteAssetInput
DeleteAssetsInput
inputDeleteAssetsInput
DeleteStockLocationInput
inputDeleteStockLocationInput
input DeleteStockLocationInput {
id: ID!
transferToLocationId: ID
}DuplicateEntityInput
inputDuplicateEntityInput
input DuplicateEntityInput {
entityName: String!
entityId: ID!
duplicatorInput: ConfigurableOperationInput!
}FacetFilterParameter
inputFacetFilterParameter
input FacetFilterParameter {
isPrivate: BooleanOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
code: StringOperators
_and: [FacetFilterParameter!]
_or: [FacetFilterParameter!]
}FacetListOptions
inputFacetListOptions
input FacetListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: FacetSortParameter
"""Allows the results to be filtered"""
filter: FacetFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}FacetSortParameter
inputFacetSortParameter
input FacetSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
code: SortOrder
}FacetTranslationInput
inputFacetTranslationInput
input FacetTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}FacetValueFilterInput
inputFacetValueFilterInput
"""
Used to construct boolean expressions for filtering search results
by FacetValue ID. Examples:
* ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`
* ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`
* ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`
"""
input FacetValueFilterInput {
and: ID
or: [ID!]
}FacetValueFilterParameter
inputFacetValueFilterParameter
input FacetValueFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
facetId: IDOperators
name: StringOperators
code: StringOperators
_and: [FacetValueFilterParameter!]
_or: [FacetValueFilterParameter!]
}FacetValueListOptions
inputFacetValueListOptions
input FacetValueListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: FacetValueSortParameter
"""Allows the results to be filtered"""
filter: FacetValueFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}FacetValueSortParameter
inputFacetValueSortParameter
input FacetValueSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
facetId: SortOrder
name: SortOrder
code: SortOrder
}FacetValueTranslationInput
inputFacetValueTranslationInput
input FacetValueTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}FulfillOrderInput
inputFulfillOrderInput
input FulfillOrderInput {
lines: [OrderLineInput!]!
handler: ConfigurableOperationInput!
}HistoryEntryFilterParameter
inputHistoryEntryFilterParameter
input HistoryEntryFilterParameter {
isPublic: BooleanOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
type: StringOperators
_and: [HistoryEntryFilterParameter!]
_or: [HistoryEntryFilterParameter!]
}HistoryEntryListOptions
inputHistoryEntryListOptions
input HistoryEntryListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: HistoryEntrySortParameter
"""Allows the results to be filtered"""
filter: HistoryEntryFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}HistoryEntrySortParameter
inputHistoryEntrySortParameter
input HistoryEntrySortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
}IDListOperators
inputIDListOperators
"""Operators for filtering on a list of ID fields"""
input IDListOperators {
inList: ID!
}IDOperators
inputIDOperators
JobFilterParameter
inputJobFilterParameter
input JobFilterParameter {
id: IDOperators
createdAt: DateOperators
startedAt: DateOperators
settledAt: DateOperators
queueName: StringOperators
state: StringOperators
progress: NumberOperators
isSettled: BooleanOperators
duration: NumberOperators
retries: NumberOperators
attempts: NumberOperators
_and: [JobFilterParameter!]
_or: [JobFilterParameter!]
}JobListOptions
inputJobListOptions
input JobListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: JobSortParameter
"""Allows the results to be filtered"""
filter: JobFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}JobSortParameter
inputJobSortParameter
input JobSortParameter {
id: SortOrder
createdAt: SortOrder
startedAt: SortOrder
settledAt: SortOrder
queueName: SortOrder
progress: SortOrder
duration: SortOrder
retries: SortOrder
attempts: SortOrder
}ManualPaymentInput
inputManualPaymentInput
MetricSummaryInput
inputMetricSummaryInput
input MetricSummaryInput {
interval: MetricInterval!
types: [MetricType!]!
refresh: Boolean
}ModifyOrderInput
inputModifyOrderInput
input ModifyOrderInput {
dryRun: Boolean!
orderId: ID!
addItems: [AddItemInput!]
adjustOrderLines: [OrderLineInput!]
surcharges: [SurchargeInput!]
updateShippingAddress: UpdateOrderAddressInput
updateBillingAddress: UpdateOrderAddressInput
note: String
"""
Deprecated in v2.2.0. Use `refunds` instead to allow multiple refunds to be
applied in the case that multiple payment methods have been used on the order.
"""
refund: AdministratorRefundInput
refunds: [AdministratorRefundInput!]
options: ModifyOrderOptions
couponCodes: [String!]
"""Added in v2.2"""
shippingMethodIds: [ID!]
}ModifyOrderOptions
inputModifyOrderOptions
input ModifyOrderOptions {
freezePromotions: Boolean
recalculateShipping: Boolean
}MoveCollectionInput
NativeAuthInput
inputNativeAuthInput
input NativeAuthInput {
username: String!
password: String!
}NumberListOperators
inputNumberListOperators
"""Operators for filtering on a list of Number fields"""
input NumberListOperators {
inList: Float!
}NumberOperators
inputNumberOperators
"""Operators for filtering on a Int or Float field"""
input NumberOperators {
eq: Float
lt: Float
lte: Float
gt: Float
gte: Float
between: NumberRange
isNull: Boolean
}NumberRange
inputNumberRange
input NumberRange {
start: Float!
end: Float!
}OrderFilterParameter
inputOrderFilterParameter
input OrderFilterParameter {
customerLastName: StringOperators
transactionId: StringOperators
aggregateOrderId: IDOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
type: StringOperators
orderPlacedAt: DateOperators
code: StringOperators
state: StringOperators
active: BooleanOperators
totalQuantity: NumberOperators
subTotal: NumberOperators
subTotalWithTax: NumberOperators
currencyCode: StringOperators
shipping: NumberOperators
shippingWithTax: NumberOperators
total: NumberOperators
totalWithTax: NumberOperators
_and: [OrderFilterParameter!]
_or: [OrderFilterParameter!]
}OrderLineInput
OrderListOptions
inputOrderListOptions
input OrderListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: OrderSortParameter
"""Allows the results to be filtered"""
filter: OrderFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}OrderSortParameter
inputOrderSortParameter
input OrderSortParameter {
customerLastName: SortOrder
transactionId: SortOrder
aggregateOrderId: SortOrder
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
orderPlacedAt: SortOrder
code: SortOrder
state: SortOrder
totalQuantity: SortOrder
subTotal: SortOrder
subTotalWithTax: SortOrder
shipping: SortOrder
shippingWithTax: SortOrder
total: SortOrder
totalWithTax: SortOrder
}PaymentMethodFilterParameter
inputPaymentMethodFilterParameter
input PaymentMethodFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
code: StringOperators
description: StringOperators
enabled: BooleanOperators
_and: [PaymentMethodFilterParameter!]
_or: [PaymentMethodFilterParameter!]
}PaymentMethodListOptions
inputPaymentMethodListOptions
input PaymentMethodListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: PaymentMethodSortParameter
"""Allows the results to be filtered"""
filter: PaymentMethodFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}PaymentMethodSortParameter
inputPaymentMethodSortParameter
input PaymentMethodSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
code: SortOrder
description: SortOrder
}PaymentMethodTranslationInput
inputPaymentMethodTranslationInput
input PaymentMethodTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
description: String
customFields: JSON
}PreviewCollectionVariantsInput
inputPreviewCollectionVariantsInput
input PreviewCollectionVariantsInput {
parentId: ID
inheritFilters: Boolean!
filters: [ConfigurableOperationInput!]!
}ProductFilterParameter
inputProductFilterParameter
input ProductFilterParameter {
facetValueId: IDOperators
sku: StringOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
name: StringOperators
slug: StringOperators
description: StringOperators
enabled: BooleanOperators
_and: [ProductFilterParameter!]
_or: [ProductFilterParameter!]
}ProductListOptions
inputProductListOptions
input ProductListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: ProductSortParameter
"""Allows the results to be filtered"""
filter: ProductFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}ProductOptionFilterParameter
inputProductOptionFilterParameter
input ProductOptionFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
code: StringOperators
name: StringOperators
groupId: IDOperators
_and: [ProductOptionFilterParameter!]
_or: [ProductOptionFilterParameter!]
}ProductOptionGroupTranslationInput
inputProductOptionGroupTranslationInput
input ProductOptionGroupTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}ProductOptionListOptions
inputProductOptionListOptions
input ProductOptionListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: ProductOptionSortParameter
"""Allows the results to be filtered"""
filter: ProductOptionFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}ProductOptionSortParameter
inputProductOptionSortParameter
input ProductOptionSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
name: SortOrder
groupId: SortOrder
}ProductOptionTranslationInput
inputProductOptionTranslationInput
input ProductOptionTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}ProductSortParameter
inputProductSortParameter
input ProductSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
slug: SortOrder
description: SortOrder
}ProductTranslationInput
inputProductTranslationInput
input ProductTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
slug: String
description: String
customFields: JSON
}ProductVariantFilterParameter
inputProductVariantFilterParameter
input ProductVariantFilterParameter {
facetValueId: IDOperators
enabled: BooleanOperators
trackInventory: StringOperators
stockOnHand: NumberOperators
stockAllocated: NumberOperators
outOfStockThreshold: NumberOperators
useGlobalOutOfStockThreshold: BooleanOperators
id: IDOperators
productId: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
sku: StringOperators
name: StringOperators
price: NumberOperators
currencyCode: StringOperators
priceWithTax: NumberOperators
stockLevel: StringOperators
_and: [ProductVariantFilterParameter!]
_or: [ProductVariantFilterParameter!]
}ProductVariantListOptions
inputProductVariantListOptions
input ProductVariantListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: ProductVariantSortParameter
"""Allows the results to be filtered"""
filter: ProductVariantFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}ProductVariantSortParameter
inputProductVariantSortParameter
input ProductVariantSortParameter {
stockOnHand: SortOrder
stockAllocated: SortOrder
outOfStockThreshold: SortOrder
id: SortOrder
productId: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
sku: SortOrder
name: SortOrder
price: SortOrder
priceWithTax: SortOrder
stockLevel: SortOrder
}ProductVariantTranslationInput
inputProductVariantTranslationInput
input ProductVariantTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}PromotionFilterParameter
inputPromotionFilterParameter
input PromotionFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
startsAt: DateOperators
endsAt: DateOperators
couponCode: StringOperators
perCustomerUsageLimit: NumberOperators
usageLimit: NumberOperators
name: StringOperators
description: StringOperators
enabled: BooleanOperators
_and: [PromotionFilterParameter!]
_or: [PromotionFilterParameter!]
}PromotionListOptions
inputPromotionListOptions
input PromotionListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: PromotionSortParameter
"""Allows the results to be filtered"""
filter: PromotionFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}PromotionSortParameter
inputPromotionSortParameter
input PromotionSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
startsAt: SortOrder
endsAt: SortOrder
couponCode: SortOrder
perCustomerUsageLimit: SortOrder
usageLimit: SortOrder
name: SortOrder
description: SortOrder
}PromotionTranslationInput
inputPromotionTranslationInput
input PromotionTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
description: String
customFields: JSON
}ProvinceFilterParameter
inputProvinceFilterParameter
input ProvinceFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
code: StringOperators
type: StringOperators
name: StringOperators
enabled: BooleanOperators
parentId: IDOperators
_and: [ProvinceFilterParameter!]
_or: [ProvinceFilterParameter!]
}ProvinceListOptions
inputProvinceListOptions
input ProvinceListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: ProvinceSortParameter
"""Allows the results to be filtered"""
filter: ProvinceFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}ProvinceSortParameter
inputProvinceSortParameter
input ProvinceSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
type: SortOrder
name: SortOrder
parentId: SortOrder
}ProvinceTranslationInput
inputProvinceTranslationInput
input ProvinceTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
customFields: JSON
}RefundOrderInput
inputRefundOrderInput
input RefundOrderInput {
lines: [OrderLineInput!]
shipping: Money
adjustment: Money
"""
The amount to be refunded to this particular payment. This was introduced in v2.2.0 as the preferred way to specify the refund amount.
Can be as much as the total amount of the payment minus the sum of all previous refunds.
"""
amount: Money
paymentId: ID!
reason: String
}RemoveCollectionsFromChannelInput
inputRemoveCollectionsFromChannelInput
input RemoveCollectionsFromChannelInput {
collectionIds: [ID!]!
channelId: ID!
}RemoveFacetsFromChannelInput
inputRemoveFacetsFromChannelInput
RemovePaymentMethodsFromChannelInput
inputRemovePaymentMethodsFromChannelInput
input RemovePaymentMethodsFromChannelInput {
paymentMethodIds: [ID!]!
channelId: ID!
}RemoveProductVariantsFromChannelInput
inputRemoveProductVariantsFromChannelInput
input RemoveProductVariantsFromChannelInput {
productVariantIds: [ID!]!
channelId: ID!
}RemoveProductsFromChannelInput
inputRemoveProductsFromChannelInput
input RemoveProductsFromChannelInput {
productIds: [ID!]!
channelId: ID!
}RemovePromotionsFromChannelInput
inputRemovePromotionsFromChannelInput
input RemovePromotionsFromChannelInput {
promotionIds: [ID!]!
channelId: ID!
}RemoveShippingMethodsFromChannelInput
inputRemoveShippingMethodsFromChannelInput
input RemoveShippingMethodsFromChannelInput {
shippingMethodIds: [ID!]!
channelId: ID!
}RemoveStockLocationsFromChannelInput
inputRemoveStockLocationsFromChannelInput
input RemoveStockLocationsFromChannelInput {
stockLocationIds: [ID!]!
channelId: ID!
}RoleFilterParameter
inputRoleFilterParameter
input RoleFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
code: StringOperators
description: StringOperators
_and: [RoleFilterParameter!]
_or: [RoleFilterParameter!]
}RoleListOptions
inputRoleListOptions
input RoleListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: RoleSortParameter
"""Allows the results to be filtered"""
filter: RoleFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}RoleSortParameter
inputRoleSortParameter
input RoleSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
description: SortOrder
}SearchInput
inputSearchInput
input SearchInput {
term: String
facetValueIds: [ID!]
facetValueOperator: LogicalOperator
facetValueFilters: [FacetValueFilterInput!]
collectionId: ID
collectionSlug: String
groupByProduct: Boolean
take: Int
skip: Int
sort: SearchResultSortParameter
}SearchResultSortParameter
inputSearchResultSortParameter
input SearchResultSortParameter {
name: SortOrder
price: SortOrder
}SellerFilterParameter
inputSellerFilterParameter
input SellerFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
_and: [SellerFilterParameter!]
_or: [SellerFilterParameter!]
}SellerListOptions
inputSellerListOptions
input SellerListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: SellerSortParameter
"""Allows the results to be filtered"""
filter: SellerFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}SellerSortParameter
inputSellerSortParameter
input SellerSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
}SetOrderCustomerInput
SettingsStoreInput
SettleRefundInput
ShippingMethodFilterParameter
inputShippingMethodFilterParameter
input ShippingMethodFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
code: StringOperators
name: StringOperators
description: StringOperators
fulfillmentHandlerCode: StringOperators
_and: [ShippingMethodFilterParameter!]
_or: [ShippingMethodFilterParameter!]
}ShippingMethodListOptions
inputShippingMethodListOptions
input ShippingMethodListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: ShippingMethodSortParameter
"""Allows the results to be filtered"""
filter: ShippingMethodFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}ShippingMethodSortParameter
inputShippingMethodSortParameter
input ShippingMethodSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
name: SortOrder
description: SortOrder
fulfillmentHandlerCode: SortOrder
}ShippingMethodTranslationInput
inputShippingMethodTranslationInput
input ShippingMethodTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
description: String
customFields: JSON
}SlugForEntityInput
inputSlugForEntityInput
StockLevelInput
StockLocationFilterParameter
inputStockLocationFilterParameter
input StockLocationFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
description: StringOperators
_and: [StockLocationFilterParameter!]
_or: [StockLocationFilterParameter!]
}StockLocationListOptions
inputStockLocationListOptions
input StockLocationListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: StockLocationSortParameter
"""Allows the results to be filtered"""
filter: StockLocationFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}StockLocationSortParameter
inputStockLocationSortParameter
input StockLocationSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
description: SortOrder
}StockMovementListOptions
inputStockMovementListOptions
input StockMovementListOptions {
type: StockMovementType
skip: Int
take: Int
}StringListOperators
inputStringListOperators
"""Operators for filtering on a list of String fields"""
input StringListOperators {
inList: String!
}StringOperators
inputStringOperators
SurchargeInput
inputSurchargeInput
TagFilterParameter
inputTagFilterParameter
input TagFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
value: StringOperators
_and: [TagFilterParameter!]
_or: [TagFilterParameter!]
}TagListOptions
inputTagListOptions
input TagListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: TagSortParameter
"""Allows the results to be filtered"""
filter: TagFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}TagSortParameter
inputTagSortParameter
input TagSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
value: SortOrder
}TaxCategoryFilterParameter
inputTaxCategoryFilterParameter
input TaxCategoryFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
isDefault: BooleanOperators
_and: [TaxCategoryFilterParameter!]
_or: [TaxCategoryFilterParameter!]
}TaxCategoryListOptions
inputTaxCategoryListOptions
input TaxCategoryListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: TaxCategorySortParameter
"""Allows the results to be filtered"""
filter: TaxCategoryFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}TaxCategorySortParameter
inputTaxCategorySortParameter
input TaxCategorySortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
}TaxRateFilterParameter
inputTaxRateFilterParameter
input TaxRateFilterParameter {
zoneId: IDOperators
categoryId: IDOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
enabled: BooleanOperators
value: NumberOperators
_and: [TaxRateFilterParameter!]
_or: [TaxRateFilterParameter!]
}TaxRateListOptions
inputTaxRateListOptions
input TaxRateListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: TaxRateSortParameter
"""Allows the results to be filtered"""
filter: TaxRateFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}TaxRateSortParameter
inputTaxRateSortParameter
input TaxRateSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
value: SortOrder
}TestEligibleShippingMethodsInput
inputTestEligibleShippingMethodsInput
input TestEligibleShippingMethodsInput {
shippingAddress: CreateAddressInput!
lines: [TestShippingMethodOrderLineInput!]!
}TestShippingMethodInput
inputTestShippingMethodInput
input TestShippingMethodInput {
checker: ConfigurableOperationInput!
calculator: ConfigurableOperationInput!
shippingAddress: CreateAddressInput!
lines: [TestShippingMethodOrderLineInput!]!
}TestShippingMethodOrderLineInput
inputTestShippingMethodOrderLineInput
UpdateActiveAdministratorInput
inputUpdateActiveAdministratorInput
UpdateAddressInput
inputUpdateAddressInput
"""
Input used to update an Address.
The countryCode must correspond to a `code` property of a Country that has been defined in the
Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
If an invalid code is passed, the mutation will fail.
"""
input UpdateAddressInput {
id: ID!
fullName: String
company: String
streetLine1: String
streetLine2: String
city: String
province: String
postalCode: String
countryCode: String
phoneNumber: String
defaultShippingAddress: Boolean
defaultBillingAddress: Boolean
customFields: JSON
}UpdateAdministratorInput
inputUpdateAdministratorInput
UpdateAssetInput
inputUpdateAssetInput
input UpdateAssetInput {
id: ID!
name: String
focalPoint: CoordinateInput
tags: [String!]
customFields: JSON
}UpdateChannelInput
inputUpdateChannelInput
input UpdateChannelInput {
id: ID!
code: String
token: String
defaultLanguageCode: LanguageCode
availableLanguageCodes: [LanguageCode!]
pricesIncludeTax: Boolean
currencyCode: CurrencyCode
defaultCurrencyCode: CurrencyCode
availableCurrencyCodes: [CurrencyCode!]
trackInventory: Boolean
outOfStockThreshold: Int
defaultTaxZoneId: ID
defaultShippingZoneId: ID
sellerId: ID
customFields: JSON
}UpdateCollectionInput
inputUpdateCollectionInput
input UpdateCollectionInput {
id: ID!
isPrivate: Boolean
featuredAssetId: ID
parentId: ID
assetIds: [ID!]
inheritFilters: Boolean
filters: [ConfigurableOperationInput!]
translations: [UpdateCollectionTranslationInput!]
customFields: JSON
}UpdateCollectionTranslationInput
inputUpdateCollectionTranslationInput
input UpdateCollectionTranslationInput {
id: ID
languageCode: LanguageCode!
name: String
slug: String
description: String
customFields: JSON
}UpdateCountryInput
inputUpdateCountryInput
input UpdateCountryInput {
id: ID!
code: String
translations: [CountryTranslationInput!]
enabled: Boolean
customFields: JSON
}UpdateCustomerGroupInput
inputUpdateCustomerGroupInput
UpdateCustomerInput
inputUpdateCustomerInput
UpdateCustomerNoteInput
UpdateFacetInput
inputUpdateFacetInput
input UpdateFacetInput {
id: ID!
isPrivate: Boolean
code: String
translations: [FacetTranslationInput!]
customFields: JSON
}UpdateFacetValueInput
inputUpdateFacetValueInput
input UpdateFacetValueInput {
id: ID!
code: String
translations: [FacetValueTranslationInput!]
customFields: JSON
}UpdateGlobalSettingsInput
inputUpdateGlobalSettingsInput
input UpdateGlobalSettingsInput {
availableLanguages: [LanguageCode!]
trackInventory: Boolean
outOfStockThreshold: Int
customFields: JSON
}UpdateOrderAddressInput
inputUpdateOrderAddressInput
input UpdateOrderAddressInput {
fullName: String
company: String
streetLine1: String
streetLine2: String
city: String
province: String
postalCode: String
countryCode: String
phoneNumber: String
}UpdateOrderInput
UpdateOrderNoteInput
UpdatePaymentMethodInput
inputUpdatePaymentMethodInput
input UpdatePaymentMethodInput {
id: ID!
code: String
enabled: Boolean
checker: ConfigurableOperationInput
handler: ConfigurableOperationInput
translations: [PaymentMethodTranslationInput!]
customFields: JSON
}UpdateProductInput
inputUpdateProductInput
input UpdateProductInput {
id: ID!
enabled: Boolean
featuredAssetId: ID
assetIds: [ID!]
facetValueIds: [ID!]
translations: [ProductTranslationInput!]
customFields: JSON
}UpdateProductOptionGroupInput
inputUpdateProductOptionGroupInput
input UpdateProductOptionGroupInput {
id: ID!
code: String
translations: [ProductOptionGroupTranslationInput!]
customFields: JSON
}UpdateProductOptionInput
inputUpdateProductOptionInput
input UpdateProductOptionInput {
id: ID!
code: String
translations: [ProductOptionGroupTranslationInput!]
customFields: JSON
}UpdateProductVariantInput
inputUpdateProductVariantInput
input UpdateProductVariantInput {
id: ID!
enabled: Boolean
translations: [ProductVariantTranslationInput!]
facetValueIds: [ID!]
optionIds: [ID!]
sku: String
taxCategoryId: ID
"""Sets the price for the ProductVariant in the Channel's default currency"""
price: Money
"""Allows multiple prices to be set for the ProductVariant in different currencies."""
prices: [UpdateProductVariantPriceInput!]
featuredAssetId: ID
assetIds: [ID!]
stockOnHand: Int
stockLevels: [StockLevelInput!]
outOfStockThreshold: Int
useGlobalOutOfStockThreshold: Boolean
trackInventory: GlobalFlag
customFields: JSON
}UpdateProductVariantPriceInput
inputUpdateProductVariantPriceInput
"""
Used to set up update the price of a ProductVariant in a particular Channel.
If the `delete` flag is `true`, the price will be deleted for the given Channel.
"""
input UpdateProductVariantPriceInput {
currencyCode: CurrencyCode!
price: Money!
delete: Boolean
customFields: JSON
}UpdatePromotionInput
inputUpdatePromotionInput
input UpdatePromotionInput {
id: ID!
enabled: Boolean
startsAt: DateTime
endsAt: DateTime
couponCode: String
perCustomerUsageLimit: Int
usageLimit: Int
conditions: [ConfigurableOperationInput!]
actions: [ConfigurableOperationInput!]
translations: [PromotionTranslationInput!]
customFields: JSON
}UpdateProvinceInput
inputUpdateProvinceInput
input UpdateProvinceInput {
id: ID!
code: String
translations: [ProvinceTranslationInput!]
enabled: Boolean
customFields: JSON
}UpdateRoleInput
inputUpdateRoleInput
input UpdateRoleInput {
id: ID!
code: String
description: String
permissions: [Permission!]
channelIds: [ID!]
}UpdateScheduledTaskInput
UpdateSellerInput
UpdateShippingMethodInput
inputUpdateShippingMethodInput
input UpdateShippingMethodInput {
id: ID!
code: String
fulfillmentHandler: String
checker: ConfigurableOperationInput
calculator: ConfigurableOperationInput
translations: [ShippingMethodTranslationInput!]!
customFields: JSON
}UpdateStockLocationInput
inputUpdateStockLocationInput
UpdateTagInput
UpdateTaxCategoryInput
inputUpdateTaxCategoryInput
UpdateTaxRateInput
inputUpdateTaxRateInput
UpdateZoneInput
ZoneFilterParameter
inputZoneFilterParameter
input ZoneFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
name: StringOperators
_and: [ZoneFilterParameter!]
_or: [ZoneFilterParameter!]
}ZoneListOptions
inputZoneListOptions
input ZoneListOptions {
"""Skips the first n results, for use in pagination"""
skip: Int
"""Takes n results, for use in pagination"""
take: Int
"""Specifies which properties to sort the results by"""
sort: ZoneSortParameter
"""Allows the results to be filtered"""
filter: ZoneFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}ZoneSortParameter
inputZoneSortParameter
input ZoneSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
name: SortOrder
}Was this chapter helpful?