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
}
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
}
input ApiKeyFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
"""
ID by which we can look up the API-Key.
Also helps you identify keys without leaking the underlying secret API-Key.
"""
lookupId: StringOperators
"""Helps you identify unused keys"""
lastUsedAt: DateOperators
"""A descriptive name so you can remind yourself where the API-Key gets used"""
name: StringOperators
_and: [ApiKeyFilterParameter!]
_or: [ApiKeyFilterParameter!]
}
ApiKeyListOptions
inputApiKeyListOptions
input ApiKeyListOptions {
"""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: ApiKeySortParameter
"""Allows the results to be filtered"""
filter: ApiKeyFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}
ApiKeySortParameter
inputApiKeySortParameter
input ApiKeySortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
"""
ID by which we can look up the API-Key.
Also helps you identify keys without leaking the underlying secret API-Key.
"""
lookupId: SortOrder
"""Helps you identify unused keys"""
lastUsedAt: SortOrder
"""A descriptive name so you can remind yourself where the API-Key gets used"""
name: SortOrder
}
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
}
"""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
"""Not yet used - will be implemented in a future release."""
trackInventory: BooleanOperators
"""Not yet used - will be implemented in a future release."""
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
"""Not yet used - will be implemented in a future release."""
outOfStockThreshold: SortOrder
}
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
}
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
}
"""
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
}
"""
There is no User ID because you can only create API-Keys for yourself,
which gets determined by the User who does the request.
"""
input CreateApiKeyInput {
"""
Which roles to attach to this ApiKey.
You may only grant roles which you, yourself have.
"""
roleIds: [ID!]!
translations: [CreateApiKeyTranslationInput!]!
customFields: JSON
}
CreateApiKeyTranslationInput
inputCreateApiKeyTranslationInput
input CreateApiKeyTranslationInput {
languageCode: LanguageCode!
"""A descriptive name so you can remind yourself where the API-Key gets used"""
name: String!
customFields: JSON
}
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
}
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
}
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
}
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
}
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
}
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
}
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!]
}
input OrderFilterParameter {
customerLastName: StringOperators
transactionId: StringOperators
aggregateOrderId: IDOperators
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
type: StringOperators
"""
The date & time that the Order was placed, i.e. the Customer
completed the checkout and the Order is no longer "active"
"""
orderPlacedAt: DateOperators
"""A unique code for the Order"""
code: StringOperators
state: StringOperators
"""An order is active as long as the payment process has not been completed"""
active: BooleanOperators
totalQuantity: NumberOperators
"""
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: NumberOperators
"""Same as subTotal, but inclusive of tax"""
subTotalWithTax: NumberOperators
currencyCode: StringOperators
shipping: NumberOperators
shippingWithTax: NumberOperators
"""Equal to subTotal plus shipping"""
total: NumberOperators
"""The final payable amount. Equal to subTotalWithTax plus shippingWithTax"""
totalWithTax: NumberOperators
_and: [OrderFilterParameter!]
_or: [OrderFilterParameter!]
}
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
"""
The date & time that the Order was placed, i.e. the Customer
completed the checkout and the Order is no longer "active"
"""
orderPlacedAt: SortOrder
"""A unique code for the Order"""
code: SortOrder
state: SortOrder
totalQuantity: SortOrder
"""
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: SortOrder
"""Same as subTotal, but inclusive of tax"""
subTotalWithTax: SortOrder
shipping: SortOrder
shippingWithTax: SortOrder
"""Equal to subTotal plus shipping"""
total: SortOrder
"""The final payable amount. Equal to subTotalWithTax plus shippingWithTax"""
totalWithTax: SortOrder
}
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
}
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
}
input ProductOptionGroupFilterParameter {
id: IDOperators
createdAt: DateOperators
updatedAt: DateOperators
languageCode: StringOperators
code: StringOperators
name: StringOperators
"""The number of products that use this option group"""
productCount: NumberOperators
_and: [ProductOptionGroupFilterParameter!]
_or: [ProductOptionGroupFilterParameter!]
}
ProductOptionGroupListOptions
inputProductOptionGroupListOptions
input ProductOptionGroupListOptions {
"""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: ProductOptionGroupSortParameter
"""Allows the results to be filtered"""
filter: ProductOptionGroupFilterParameter
"""Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
filterOperator: LogicalOperator
}
ProductOptionGroupSortParameter
inputProductOptionGroupSortParameter
input ProductOptionGroupSortParameter {
id: SortOrder
createdAt: SortOrder
updatedAt: SortOrder
code: SortOrder
name: SortOrder
"""The number of products that use this option group"""
productCount: SortOrder
}
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
}
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
}
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
}
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
}
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
"""
Optional refund destination code. When omitted, refunds to the original
payment method. Use the `refundDestinations` query to discover available
destinations for an order.
Ignored when `targets` is specified.
"""
destination: String
"""
Splits the refund across multiple payments and/or refund destinations. The sum of the
`amount` of each target is the total amount refunded, and the top-level `amount` and
`destination` fields are ignored.
All targets are validated before any refund is created, and every target must draw on a
Payment in the `Settled` state. If a target fails once earlier targets have already been
refunded, the Refunds created for the earlier targets are kept and a `RefundIncompleteError`
is returned.
"""
targets: [RefundTargetInput!]
}
RefundTargetInput
inputRefundTargetInput
"""
Specifies a single portion of a refund: how much to refund, which Payment's refundable
balance it is drawn from, and where the funds are directed.
"""
input RefundTargetInput {
"""
The Payment whose refundable balance is drawn on. Defaults to the top-level `paymentId`
of the RefundOrderInput when omitted.
"""
paymentId: ID
"""The amount to refund to this target."""
amount: Money!
"""
The refund destination code. When omitted, the funds are refunded to the original
payment method.
"""
destination: String
"""
Arbitrary configuration passed to the RefundDestinationStrategy's `createRefund()` method,
for example an expiry date for a store credit refund. Has no effect when `destination`
is omitted.
"""
arguments: JSON
}
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
}
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
}
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
}
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
}
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
}
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
}
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
}
"""
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
}
input UpdateApiKeyInput {
"""ID of the ApiKey"""
id: ID!
"""
Which roles to attach to this ApiKey.
You may only grant roles which you, yourself have.
"""
roleIds: [ID!]
translations: [UpdateApiKeyTranslationInput!]
customFields: JSON
}
UpdateApiKeyTranslationInput
inputUpdateApiKeyTranslationInput
input UpdateApiKeyTranslationInput {
id: ID
languageCode: LanguageCode!
"""A descriptive name so you can remind yourself where the API-Key gets used"""
name: String
customFields: JSON
}
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
}
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
}