Queries

type Query {
  activeAdministrator: Administrator
}

type Query {
  activeChannel: Channel!
}

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

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

type Query {
  apiKey(id: ID!): ApiKey
}

type Query {
  apiKeys(options: ApiKeyListOptions): ApiKeyList!
}

"""Get a single Asset by id"""
type Query {
  asset(id: ID!): Asset
}

"""Get a list of Assets"""
type Query {
  assets(options: AssetListOptions): AssetList!
}

type Query {
  channel(id: ID!): Channel
}

type Query {
  channels(options: ChannelListOptions): ChannelList!
}

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

type Query {
  collectionFilters: [ConfigurableOperationDefinition!]!
}

type Query {
  collections(options: CollectionListOptions): CollectionList!
}

type Query {
  countries(options: CountryListOptions): CountryList!
}

type Query {
  country(id: ID!): Country
}

type Query {
  customer(id: ID!): Customer
}

type Query {
  customerGroup(id: ID!): CustomerGroup
}

type Query {
  customerGroups(options: CustomerGroupListOptions): CustomerGroupList!
}

type Query {
  customers(options: CustomerListOptions): CustomerList!
}

"""Returns a list of eligible shipping methods for the draft Order"""
type Query {
  eligibleShippingMethodsForDraftOrder(orderId: ID!): [ShippingMethodQuote!]!
}

"""Returns all configured EntityDuplicators."""
type Query {
  entityDuplicators: [EntityDuplicatorDefinition!]!
}

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

type Query {
  facetValue(id: ID!): FacetValue
}

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

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

type Query {
  fulfillmentHandlers: [ConfigurableOperationDefinition!]!
}

"""Get value for a specific key (automatically scoped based on field configuration)"""
type Query {
  getSettingsStoreValue(key: String!): JSON
}

"""Get multiple key-value pairs (each automatically scoped)"""
type Query {
  getSettingsStoreValues(keys: [String!]!): JSON
}

type Query {
  globalSettings: GlobalSettings!
}

type Query {
  job(jobId: ID!): Job
}

type Query {
  jobBufferSize(bufferIds: [String!]): [JobBufferSize!]!
}

type Query {
  jobQueues: [JobQueue!]!
}

type Query {
  jobs(options: JobListOptions): JobList!
}

type Query {
  jobsById(jobIds: [ID!]!): [Job!]!
}

type Query {
  me: CurrentUser
}

"""Get metrics for the given interval and metric types."""
type Query {
  metricSummary(input: MetricSummaryInput): [MetricSummary!]!
}

type Query {
  order(id: ID!): Order
}

type Query {
  orders(options: OrderListOptions): OrderList!
}

type Query {
  paymentMethod(id: ID!): PaymentMethod
}

type Query {
  paymentMethodEligibilityCheckers: [ConfigurableOperationDefinition!]!
}

type Query {
  paymentMethodHandlers: [ConfigurableOperationDefinition!]!
}

type Query {
  paymentMethods(options: PaymentMethodListOptions): PaymentMethodList!
}

type Query {
  pendingSearchIndexUpdates: Int!
}

"""Used for real-time previews of the contents of a Collection"""
type Query {
  previewCollectionVariants(input: PreviewCollectionVariantsInput!, options: ProductVariantListOptions): ProductVariantList!
}

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

type Query {
  productOption(id: ID!): ProductOption
}

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

type Query {
  productOptionGroups(options: ProductOptionGroupListOptions): ProductOptionGroupList!
}

type Query {
  productOptions(options: ProductOptionListOptions, groupId: ID): ProductOptionList!
}

"""Get a ProductVariant by id"""
type Query {
  productVariant(id: ID!): ProductVariant
}

"""List ProductVariants either all or for the specific product."""
type Query {
  productVariants(options: ProductVariantListOptions, productId: ID): ProductVariantList!
}

"""List Products"""
type Query {
  products(options: ProductListOptions): ProductList!
}

type Query {
  promotion(id: ID!): Promotion
}

type Query {
  promotionActions: [ConfigurableOperationDefinition!]!
}

type Query {
  promotionConditions: [ConfigurableOperationDefinition!]!
}

type Query {
  promotions(options: PromotionListOptions): PromotionList!
}

type Query {
  province(id: ID!): Province
}

type Query {
  provinces(options: ProvinceListOptions): ProvinceList!
}

"""
Returns the available refund destinations for the given order.
This includes the default destination (original payment method) plus
any custom destinations registered via RefundDestinationStrategy.
"""
type Query {
  refundDestinations(orderId: ID!): [RefundDestination!]!
}

type Query {
  role(id: ID!): Role
}

type Query {
  roles(options: RoleListOptions): RoleList!
}

type Query {
  scheduledTasks: [ScheduledTask!]!
}

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

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

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

"""Returns all registered settings store field definitions with their current values"""
type Query {
  settingsStoreFieldDefinitions: [SettingsStoreFieldDefinition!]!
}

type Query {
  shippingCalculators: [ConfigurableOperationDefinition!]!
}

type Query {
  shippingEligibilityCheckers: [ConfigurableOperationDefinition!]!
}

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

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

"""Generate slug for entity"""
type Query {
  slugForEntity(input: SlugForEntityInput!): String!
}

type Query {
  stockLocation(id: ID!): StockLocation
}

type Query {
  stockLocations(options: StockLocationListOptions): StockLocationList!
}

type Query {
  tag(id: ID!): Tag!
}

type Query {
  tags(options: TagListOptions): TagList!
}

type Query {
  taxCategories(options: TaxCategoryListOptions): TaxCategoryList!
}

type Query {
  taxCategory(id: ID!): TaxCategory
}

type Query {
  taxRate(id: ID!): TaxRate
}

type Query {
  taxRates(options: TaxRateListOptions): TaxRateList!
}

type Query {
  testEligibleShippingMethods(input: TestEligibleShippingMethodsInput!): [ShippingMethodQuote!]!
}

type Query {
  testShippingMethod(input: TestShippingMethodInput!): TestShippingMethodResult!
}

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

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