🚨 Announcing Vendure v2 Beta

Product

Features

A tour of the core Vendure features

Case studies

How Vendure is being used in real-world projects

Plugins

Official & community plugins

Integrations

Storefronts, payments, infrastructure. Compose your commerce stack

Demo
Live

Try our live Vendure demo now!

Roadmap

Partners

Partner Program

Become a Vendure Partner

Developers

Documentation

Get started in 5 minutes!

Blog

News and technical articles

Input Objects

AddItemInput

  • productVariantId: ID!
  • quantity: Int!

AddItemToDraftOrderInput

  • productVariantId: ID!
  • quantity: Int!

AddNoteToCustomerInput

AddNoteToOrderInput

AdjustDraftOrderLineInput

  • orderLineId: ID!
  • quantity: Int!

AdjustOrderLineInput

  • orderLineId: ID!
  • quantity: Int!

AdministratorFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

AdministratorPaymentInput

AdministratorRefundInput

AdministratorSortParameter

AssetFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

AssetSortParameter

AssignAssetsToChannelInput

  • assetIds: [ID!]!
  • channelId: ID!

AssignCollectionsToChannelInput

  • collectionIds: [ID!]!
  • channelId: ID!

AssignFacetsToChannelInput

  • facetIds: [ID!]!
  • channelId: ID!

AssignProductVariantsToChannelInput

  • productVariantIds: [ID!]!
  • channelId: ID!
  • priceFactor: Float

AssignProductsToChannelInput

  • productIds: [ID!]!
  • channelId: ID!
  • priceFactor: Float

AssignPromotionsToChannelInput

  • promotionIds: [ID!]!
  • channelId: ID!

AuthenticationInput

BooleanListOperators

Operators for filtering on a list of Boolean fields

BooleanOperators

Operators for filtering on a Boolean field

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

CollectionFilterParameter

CollectionListOptions

  • // 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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

CollectionSortParameter

ConfigArgInput

  • name: String!
  • // A JSON stringified representation of the actual value
  • value: String!

ConfigurableOperationInput

CoordinateInput

CountryFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

CountrySortParameter

CountryTranslationInput

CreateAddressInput

CreateAdministratorInput

CreateAssetInput

CreateChannelInput

CreateCollectionInput

CreateCollectionTranslationInput

CreateCountryInput

CreateCustomerGroupInput

CreateCustomerInput

CreateFacetInput

CreateFacetValueInput

CreateFacetValueWithFacetInput

CreateGroupOptionInput

CreatePaymentMethodInput

CreateProductInput

CreateProductOptionGroupInput

CreateProductOptionInput

CreateProductVariantInput

CreateProductVariantOptionInput

CreatePromotionInput

CreateRoleInput

CreateShippingMethodInput

CreateTagInput

CreateTaxCategoryInput

CreateTaxRateInput

CreateZoneInput

CustomerFilterParameter

CustomerGroupFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

CustomerGroupSortParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

CustomerSortParameter

DateListOperators

Operators for filtering on a list of Date fields

DateOperators

Operators for filtering on a DateTime field

DateRange

DeleteAssetInput

DeleteAssetsInput

FacetFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

FacetSortParameter

FacetTranslationInput

FacetValueFilterInput

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

FacetValueFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

FacetValueSortParameter

FacetValueTranslationInput

FulfillOrderInput

HistoryEntryFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

HistoryEntrySortParameter

IDListOperators

Operators for filtering on a list of ID fields

  • inList: ID!

IDOperators

Operators for filtering on an ID field

JobFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

JobSortParameter

ManualPaymentInput

ModifyOrderInput

ModifyOrderOptions

MoveCollectionInput

  • collectionId: ID!
  • parentId: ID!
  • index: Int!

NativeAuthInput

NumberListOperators

Operators for filtering on a list of Number fields

NumberOperators

Operators for filtering on a Int or Float field

NumberRange

OrderFilterParameter

OrderLineInput

  • orderLineId: ID!
  • quantity: Int!

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

OrderSortParameter

PaymentMethodFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

PaymentMethodSortParameter

PreviewCollectionVariantsInput

ProductFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

ProductOptionGroupTranslationInput

ProductOptionTranslationInput

ProductSortParameter

ProductTranslationInput

ProductVariantFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

ProductVariantSortParameter

ProductVariantTranslationInput

PromotionFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

PromotionSortParameter

RefundOrderInput

RemoveCollectionsFromChannelInput

  • collectionIds: [ID!]!
  • channelId: ID!

RemoveFacetsFromChannelInput

RemoveProductVariantsFromChannelInput

  • productVariantIds: [ID!]!
  • channelId: ID!

RemoveProductsFromChannelInput

  • productIds: [ID!]!
  • channelId: ID!

RemovePromotionsFromChannelInput

  • promotionIds: [ID!]!
  • channelId: ID!

RoleFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

RoleSortParameter

SearchInput

SearchResultSortParameter

SettleRefundInput

ShippingMethodFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

ShippingMethodSortParameter

ShippingMethodTranslationInput

StockMovementListOptions

StringListOperators

Operators for filtering on a list of String fields

StringOperators

Operators for filtering on a String field

SurchargeInput

TagFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

TagSortParameter

TaxRateFilterParameter

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 “filter” arguments should be combines with a logical AND or OR operation. Defaults to AND.
  • filterOperator: LogicalOperator

TaxRateSortParameter

TestEligibleShippingMethodsInput

TestShippingMethodInput

TestShippingMethodOrderLineInput

  • productVariantId: ID!
  • quantity: Int!

UpdateActiveAdministratorInput

UpdateAddressInput

UpdateAdministratorInput

UpdateAssetInput

UpdateChannelInput

UpdateCollectionInput

UpdateCollectionTranslationInput

UpdateCountryInput

UpdateCustomerGroupInput

UpdateCustomerInput

UpdateCustomerNoteInput

UpdateFacetInput

UpdateFacetValueInput

UpdateGlobalSettingsInput

UpdateOrderAddressInput

UpdateOrderInput

UpdateOrderNoteInput

UpdatePaymentMethodInput

UpdateProductInput

UpdateProductOptionGroupInput

UpdateProductOptionInput

UpdateProductVariantInput

UpdatePromotionInput

UpdateRoleInput

UpdateShippingMethodInput

UpdateTagInput

UpdateTaxCategoryInput

UpdateTaxRateInput

UpdateZoneInput

Generated on Mar 22 2023 at 12:55