vendure/docs/content/graphql-api/admin/queries.md

---

title: "Queries" weight: 1 date: 2023-07-04T11:02:07.589Z showtoc: true

generated: true

Queries

activeAdministrator

{{% gql-fields %}}

• activeAdministrator: Administrator {{% /gql-fields %}}

activeChannel

{{% gql-fields %}}

• activeChannel: Channel! {{% /gql-fields %}}

administrator

{{% gql-fields %}}

• administrator(id: ID!): Administrator {{% /gql-fields %}}

administrators

{{% gql-fields %}}

• administrators(options: AdministratorListOptions): AdministratorList! {{% /gql-fields %}}

asset

Get a single Asset by id

{{% gql-fields %}}

• asset(id: ID!): Asset {{% /gql-fields %}}

assets

Get a list of Assets

{{% gql-fields %}}

• assets(options: AssetListOptions): AssetList! {{% /gql-fields %}}

channel

{{% gql-fields %}}

• channel(id: ID!): Channel {{% /gql-fields %}}

channels

{{% gql-fields %}}

• channels(options: ChannelListOptions): ChannelList! {{% /gql-fields %}}

collection

Get a Collection either by id or slug. If neither id nor slug is specified, an error will result.

{{% gql-fields %}}

• collection(id: ID, slug: String): Collection {{% /gql-fields %}}

collectionFilters

{{% gql-fields %}}

• collectionFilters: [ConfigurableOperationDefinition!]! {{% /gql-fields %}}

collections

{{% gql-fields %}}

• collections(options: CollectionListOptions): CollectionList! {{% /gql-fields %}}

countries

{{% gql-fields %}}

• countries(options: CountryListOptions): CountryList! {{% /gql-fields %}}

country

{{% gql-fields %}}

• country(id: ID!): Country {{% /gql-fields %}}

customer

{{% gql-fields %}}

• customer(id: ID!): Customer {{% /gql-fields %}}

customerGroup

{{% gql-fields %}}

• customerGroup(id: ID!): CustomerGroup {{% /gql-fields %}}

customerGroups

{{% gql-fields %}}

• customerGroups(options: CustomerGroupListOptions): CustomerGroupList! {{% /gql-fields %}}

customers

{{% gql-fields %}}

• customers(options: CustomerListOptions): CustomerList! {{% /gql-fields %}}

eligibleShippingMethodsForDraftOrder

Returns a list of eligible shipping methods for the draft Order

{{% gql-fields %}}

• eligibleShippingMethodsForDraftOrder(orderId: ID!): [ShippingMethodQuote!]! {{% /gql-fields %}}

facet

{{% gql-fields %}}

• facet(id: ID!): Facet {{% /gql-fields %}}

facetValues

{{% gql-fields %}}

• facetValues(options: FacetValueListOptions): FacetValueList! {{% /gql-fields %}}

facets

{{% gql-fields %}}

• facets(options: FacetListOptions): FacetList! {{% /gql-fields %}}

fulfillmentHandlers

{{% gql-fields %}}

• fulfillmentHandlers: [ConfigurableOperationDefinition!]! {{% /gql-fields %}}

globalSettings

{{% gql-fields %}}

• globalSettings: GlobalSettings! {{% /gql-fields %}}

job

{{% gql-fields %}}

• job(jobId: ID!): Job {{% /gql-fields %}}

jobBufferSize

{{% gql-fields %}}

• jobBufferSize(bufferIds: [String!]): [JobBufferSize!]! {{% /gql-fields %}}

jobQueues

{{% gql-fields %}}

• jobQueues: [JobQueue!]! {{% /gql-fields %}}

jobs

{{% gql-fields %}}

• jobs(options: JobListOptions): JobList! {{% /gql-fields %}}

jobsById

{{% gql-fields %}}

• jobsById(jobIds: [ID!]!): [Job!]! {{% /gql-fields %}}

me

{{% gql-fields %}}

• me: CurrentUser {{% /gql-fields %}}

metricSummary

Get metrics for the given interval and metric types.

{{% gql-fields %}}

• metricSummary(input: MetricSummaryInput): [MetricSummary!]! {{% /gql-fields %}}

order

{{% gql-fields %}}

• order(id: ID!): Order {{% /gql-fields %}}

orders

{{% gql-fields %}}

• orders(options: OrderListOptions): OrderList! {{% /gql-fields %}}

paymentMethod

{{% gql-fields %}}

• paymentMethod(id: ID!): PaymentMethod {{% /gql-fields %}}

paymentMethodEligibilityCheckers

{{% gql-fields %}}

• paymentMethodEligibilityCheckers: [ConfigurableOperationDefinition!]! {{% /gql-fields %}}

paymentMethodHandlers

{{% gql-fields %}}

• paymentMethodHandlers: [ConfigurableOperationDefinition!]! {{% /gql-fields %}}

paymentMethods

{{% gql-fields %}}

• paymentMethods(options: PaymentMethodListOptions): PaymentMethodList! {{% /gql-fields %}}

pendingSearchIndexUpdates

{{% gql-fields %}}

• pendingSearchIndexUpdates: Int! {{% /gql-fields %}}

previewCollectionVariants

Used for real-time previews of the contents of a Collection

{{% gql-fields %}}

• previewCollectionVariants(input: PreviewCollectionVariantsInput!, options: ProductVariantListOptions): ProductVariantList! {{% /gql-fields %}}

product

Get a Product either by id or slug. If neither id nor slug is specified, an error will result.

{{% gql-fields %}}

• product(id: ID, slug: String): Product {{% /gql-fields %}}

productOptionGroup

{{% gql-fields %}}

• productOptionGroup(id: ID!): ProductOptionGroup {{% /gql-fields %}}

productOptionGroups

{{% gql-fields %}}

• productOptionGroups(filterTerm: String): [ProductOptionGroup!]! {{% /gql-fields %}}

productVariant

Get a ProductVariant by id

{{% gql-fields %}}

• productVariant(id: ID!): ProductVariant {{% /gql-fields %}}

productVariants

List ProductVariants either all or for the specific product.

{{% gql-fields %}}

• productVariants(options: ProductVariantListOptions, productId: ID): ProductVariantList! {{% /gql-fields %}}

products

List Products

{{% gql-fields %}}

• products(options: ProductListOptions): ProductList! {{% /gql-fields %}}

promotion

{{% gql-fields %}}

• promotion(id: ID!): Promotion {{% /gql-fields %}}

promotionActions

{{% gql-fields %}}

• promotionActions: [ConfigurableOperationDefinition!]! {{% /gql-fields %}}

promotionConditions

{{% gql-fields %}}

• promotionConditions: [ConfigurableOperationDefinition!]! {{% /gql-fields %}}

promotions

{{% gql-fields %}}

• promotions(options: PromotionListOptions): PromotionList! {{% /gql-fields %}}

province

{{% gql-fields %}}

• province(id: ID!): Province {{% /gql-fields %}}

provinces

{{% gql-fields %}}

• provinces(options: ProvinceListOptions): ProvinceList! {{% /gql-fields %}}

role

{{% gql-fields %}}

• role(id: ID!): Role {{% /gql-fields %}}

roles

{{% gql-fields %}}

• roles(options: RoleListOptions): RoleList! {{% /gql-fields %}}

search

{{% gql-fields %}}

• search(input: SearchInput!): SearchResponse! {{% /gql-fields %}}

seller

{{% gql-fields %}}

• seller(id: ID!): Seller {{% /gql-fields %}}

sellers

{{% gql-fields %}}

• sellers(options: SellerListOptions): SellerList! {{% /gql-fields %}}

shippingCalculators

{{% gql-fields %}}

• shippingCalculators: [ConfigurableOperationDefinition!]! {{% /gql-fields %}}

shippingEligibilityCheckers

{{% gql-fields %}}

• shippingEligibilityCheckers: [ConfigurableOperationDefinition!]! {{% /gql-fields %}}

shippingMethod

{{% gql-fields %}}

• shippingMethod(id: ID!): ShippingMethod {{% /gql-fields %}}

shippingMethods

{{% gql-fields %}}

• shippingMethods(options: ShippingMethodListOptions): ShippingMethodList! {{% /gql-fields %}}

stockLocation

{{% gql-fields %}}

• stockLocation(id: ID!): StockLocation {{% /gql-fields %}}

stockLocations

{{% gql-fields %}}

• stockLocations(options: StockLocationListOptions): StockLocationList! {{% /gql-fields %}}

tag

{{% gql-fields %}}

• tag(id: ID!): Tag! {{% /gql-fields %}}

tags

{{% gql-fields %}}

• tags(options: TagListOptions): TagList! {{% /gql-fields %}}

taxCategories

{{% gql-fields %}}

• taxCategories(options: TaxCategoryListOptions): TaxCategoryList! {{% /gql-fields %}}

taxCategory

{{% gql-fields %}}

• taxCategory(id: ID!): TaxCategory {{% /gql-fields %}}

taxRate

{{% gql-fields %}}

• taxRate(id: ID!): TaxRate {{% /gql-fields %}}

taxRates

{{% gql-fields %}}

• taxRates(options: TaxRateListOptions): TaxRateList! {{% /gql-fields %}}

testEligibleShippingMethods

{{% gql-fields %}}

• testEligibleShippingMethods(input: TestEligibleShippingMethodsInput!): [ShippingMethodQuote!]! {{% /gql-fields %}}

testShippingMethod

{{% gql-fields %}}

• testShippingMethod(input: TestShippingMethodInput!): TestShippingMethodResult! {{% /gql-fields %}}

zone

{{% gql-fields %}}

• zone(id: ID!): Zone {{% /gql-fields %}}

zones

{{% gql-fields %}}

• zones(options: ZoneListOptions): ZoneList! {{% /gql-fields %}}