Skip to content

Latest commit

 

History

History
761 lines (543 loc) · 33.3 KB

queries.md

File metadata and controls

761 lines (543 loc) · 33.3 KB
Raw
title isDefaultIndex generated
Queries
false
true

import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';

activeAdministrator

type Query {
activeAdministrator: Administrator
}

activeChannel

type Query {
activeChannel: Channel!
}

administrator

type Query {
administrator(id: ID!): Administrator
}

administrators

type Query {
administrators(options: AdministratorListOptions): AdministratorList!
}

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

type Query {
entityDuplicators: [EntityDuplicatorDefinition!]!
}

facet

type Query {
facet(id: ID!): Facet
}

facetValues

type Query {
facetValues(options: FacetValueListOptions): FacetValueList!
}

facets

type Query {
facets(options: FacetListOptions): FacetList!
}

fulfillmentHandlers

type Query {
fulfillmentHandlers: [ConfigurableOperationDefinition!]!
}

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

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
}

productOptionGroup

type Query {
productOptionGroup(id: ID!): ProductOptionGroup
}

productOptionGroups

type Query {
productOptionGroups(filterTerm: String): [ProductOptionGroup!]!
}

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

search

type Query {
search(input: SearchInput!): SearchResponse!
}

seller

type Query {
seller(id: ID!): Seller
}

sellers

type Query {
sellers(options: SellerListOptions): SellerList!
}

shippingCalculators

type Query {
shippingCalculators: [ConfigurableOperationDefinition!]!
}

shippingEligibilityCheckers

type Query {
shippingEligibilityCheckers: [ConfigurableOperationDefinition!]!
}

shippingMethod

type Query {
shippingMethod(id: ID!): ShippingMethod
}

shippingMethods

type Query {
shippingMethods(options: ShippingMethodListOptions): ShippingMethodList!
}

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

zone

type Query {
zone(id: ID!): Zone
}

zones

type Query {
zones(options: ZoneListOptions): ZoneList!
}