*** title: "Queries" generated: true --------------- ## activeAdministrator \ {`type Query { activeAdministrator: Administrator }`} ## activeChannel \ {`type Query { activeChannel: Channel! }`} ## administrator \ {`type Query { administrator(id: ID!): Administrator }`} ## administrators \ {`type Query { administrators(options: AdministratorListOptions): AdministratorList! }`} ## apiKey \ {`type Query { apiKey(id: ID!): ApiKey }`} ## apiKeys \ {`type Query { apiKeys(options: ApiKeyListOptions): ApiKeyList! }`} ## asset \ {`"""Get a single Asset by id""" type Query { asset(id: ID!): Asset }`} ## assets \ {`"""Get a list of Assets""" type Query { assets(options: AssetListOptions): AssetList! }`} ## channel \ {`type Query { channel(id: ID!): Channel }`} ## channels \ {`type Query { channels(options: ChannelListOptions): ChannelList! }`} ## collection \ {`"""Get a Collection either by id or slug. If neither id nor slug is specified, an error will result.""" type Query { collection(id: ID, slug: String): Collection }`} ## collectionFilters \ {`type Query { collectionFilters: [ConfigurableOperationDefinition!]! }`} ## collections \ {`type Query { collections(options: CollectionListOptions): CollectionList! }`} ## countries \ {`type Query { countries(options: CountryListOptions): CountryList! }`} ## country \ {`type Query { country(id: ID!): Country }`} ## customer \ {`type Query { customer(id: ID!): Customer }`} ## customerGroup \ {`type Query { customerGroup(id: ID!): CustomerGroup }`} ## customerGroups \ {`type Query { customerGroups(options: CustomerGroupListOptions): CustomerGroupList! }`} ## customers \ {`type Query { customers(options: CustomerListOptions): CustomerList! }`} ## eligibleShippingMethodsForDraftOrder \ {`"""Returns a list of eligible shipping methods for the draft Order""" type Query { eligibleShippingMethodsForDraftOrder(orderId: ID!): [ShippingMethodQuote!]! }`} ## entityDuplicators \ {`"""Returns all configured EntityDuplicators.""" type Query { entityDuplicators: [EntityDuplicatorDefinition!]! }`} ## facet \ {`type Query { facet(id: ID!): Facet }`} ## facetValue \ {`type Query { facetValue(id: ID!): FacetValue }`} ## facetValues \ {`type Query { facetValues(options: FacetValueListOptions): FacetValueList! }`} ## facets \ {`type Query { facets(options: FacetListOptions): FacetList! }`} ## fulfillmentHandlers \ {`type Query { fulfillmentHandlers: [ConfigurableOperationDefinition!]! }`} ## getSettingsStoreValue \ {`"""Get value for a specific key (automatically scoped based on field configuration)""" type Query { getSettingsStoreValue(key: String!): JSON }`} ## getSettingsStoreValues \ {`"""Get multiple key-value pairs (each automatically scoped)""" type Query { getSettingsStoreValues(keys: [String!]!): JSON }`} ## globalSettings \ {`type Query { globalSettings: GlobalSettings! }`} ## job \ {`type Query { job(jobId: ID!): Job }`} ## jobBufferSize \ {`type Query { jobBufferSize(bufferIds: [String!]): [JobBufferSize!]! }`} ## jobQueues \ {`type Query { jobQueues: [JobQueue!]! }`} ## jobs \ {`type Query { jobs(options: JobListOptions): JobList! }`} ## jobsById \ {`type Query { jobsById(jobIds: [ID!]!): [Job!]! }`} ## me \ {`type Query { me: CurrentUser }`} ## metricSummary \ {`"""Get metrics for the given interval and metric types.""" type Query { metricSummary(input: MetricSummaryInput): [MetricSummary!]! }`} ## order \ {`type Query { order(id: ID!): Order }`} ## orders \ {`type Query { orders(options: OrderListOptions): OrderList! }`} ## paymentMethod \ {`type Query { paymentMethod(id: ID!): PaymentMethod }`} ## paymentMethodEligibilityCheckers \ {`type Query { paymentMethodEligibilityCheckers: [ConfigurableOperationDefinition!]! }`} ## paymentMethodHandlers \ {`type Query { paymentMethodHandlers: [ConfigurableOperationDefinition!]! }`} ## paymentMethods \ {`type Query { paymentMethods(options: PaymentMethodListOptions): PaymentMethodList! }`} ## pendingSearchIndexUpdates \ {`type Query { pendingSearchIndexUpdates: Int! }`} ## previewCollectionVariants \ {`"""Used for real-time previews of the contents of a Collection""" type Query { previewCollectionVariants(input: PreviewCollectionVariantsInput!, options: ProductVariantListOptions): ProductVariantList! }`} ## product \ {`"""Get a Product either by id or slug. If neither id nor slug is specified, an error will result.""" type Query { product(id: ID, slug: String): Product }`} ## productOption \ {`type Query { productOption(id: ID!): ProductOption }`} ## productOptionGroup \ {`type Query { productOptionGroup(id: ID!): ProductOptionGroup }`} ## productOptionGroups \ {`type Query { productOptionGroups(options: ProductOptionGroupListOptions): ProductOptionGroupList! }`} ## productOptions \ {`type Query { productOptions(options: ProductOptionListOptions, groupId: ID): ProductOptionList! }`} ## productVariant \ {`"""Get a ProductVariant by id""" type Query { productVariant(id: ID!): ProductVariant }`} ## productVariants \ {`"""List ProductVariants either all or for the specific product.""" type Query { productVariants(options: ProductVariantListOptions, productId: ID): ProductVariantList! }`} ## products \ {`"""List Products""" type Query { products(options: ProductListOptions): ProductList! }`} ## promotion \ {`type Query { promotion(id: ID!): Promotion }`} ## promotionActions \ {`type Query { promotionActions: [ConfigurableOperationDefinition!]! }`} ## promotionConditions \ {`type Query { promotionConditions: [ConfigurableOperationDefinition!]! }`} ## promotions \ {`type Query { promotions(options: PromotionListOptions): PromotionList! }`} ## province \ {`type Query { province(id: ID!): Province }`} ## provinces \ {`type Query { provinces(options: ProvinceListOptions): ProvinceList! }`} ## role \ {`type Query { role(id: ID!): Role }`} ## roles \ {`type Query { roles(options: RoleListOptions): RoleList! }`} ## scheduledTasks \ {`type Query { scheduledTasks: [ScheduledTask!]! }`} ## search \ {`type Query { search(input: SearchInput!): SearchResponse! }`} ## seller \ {`type Query { seller(id: ID!): Seller }`} ## sellers \ {`type Query { sellers(options: SellerListOptions): SellerList! }`} ## settingsStoreFieldDefinitions \ {`"""Returns all registered settings store field definitions with their current values""" type Query { settingsStoreFieldDefinitions: [SettingsStoreFieldDefinition!]! }`} ## shippingCalculators \ {`type Query { shippingCalculators: [ConfigurableOperationDefinition!]! }`} ## shippingEligibilityCheckers \ {`type Query { shippingEligibilityCheckers: [ConfigurableOperationDefinition!]! }`} ## shippingMethod \ {`type Query { shippingMethod(id: ID!): ShippingMethod }`} ## shippingMethods \ {`type Query { shippingMethods(options: ShippingMethodListOptions): ShippingMethodList! }`} ## slugForEntity \ {`"""Generate slug for entity""" type Query { slugForEntity(input: SlugForEntityInput!): String! }`} ## stockLocation \ {`type Query { stockLocation(id: ID!): StockLocation }`} ## stockLocations \ {`type Query { stockLocations(options: StockLocationListOptions): StockLocationList! }`} ## tag \ {`type Query { tag(id: ID!): Tag! }`} ## tags \ {`type Query { tags(options: TagListOptions): TagList! }`} ## taxCategories \ {`type Query { taxCategories(options: TaxCategoryListOptions): TaxCategoryList! }`} ## taxCategory \ {`type Query { taxCategory(id: ID!): TaxCategory }`} ## taxRate \ {`type Query { taxRate(id: ID!): TaxRate }`} ## taxRates \ {`type Query { taxRates(options: TaxRateListOptions): TaxRateList! }`} ## testEligibleShippingMethods \ {`type Query { testEligibleShippingMethods(input: TestEligibleShippingMethodsInput!): [ShippingMethodQuote!]! }`} ## testShippingMethod \ {`type Query { testShippingMethod(input: TestShippingMethodInput!): TestShippingMethodResult! }`} ## zone \ {`type Query { zone(id: ID!): Zone }`} ## zones \ {`type Query { zones(options: ZoneListOptions): ZoneList! }`}