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 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
}
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
}
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
}
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 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
}
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 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
}
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
}
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
}