@vendure/docs 0.0.0-202601211103 → 0.0.0-202601211343

package/docs/reference/graphql-api/admin/queries.mdx

@@ -1,1194 +0,0 @@
----
-title: "Queries"
-generated: true
----
-
-
-
-## activeAdministrator {#activeadministrator}
-
-<GraphQLDoc
-  type="query"
-  typeName="activeAdministrator"
-  typeLinks={{
-    Administrator: '/reference/graphql-api/admin/object-types#administrator',
-  }}
->
-{`type Query {
-  activeAdministrator: Administrator
-}`}
-</GraphQLDoc>
-
-## activeChannel {#activechannel}
-
-<GraphQLDoc
-  type="query"
-  typeName="activeChannel"
-  typeLinks={{
-    Channel: '/reference/graphql-api/admin/object-types#channel',
-  }}
->
-{`type Query {
-  activeChannel: Channel!
-}`}
-</GraphQLDoc>
-
-## administrator {#administrator}
-
-<GraphQLDoc
-  type="query"
-  typeName="administrator"
-  typeLinks={{
-    Administrator: '/reference/graphql-api/admin/object-types#administrator',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  administrator(id: ID!): Administrator
-}`}
-</GraphQLDoc>
-
-## administrators {#administrators}
-
-<GraphQLDoc
-  type="query"
-  typeName="administrators"
-  typeLinks={{
-    AdministratorList: '/reference/graphql-api/admin/object-types#administratorlist',
-    AdministratorListOptions: '/reference/graphql-api/admin/input-types#administratorlistoptions',
-  }}
->
-{`type Query {
-  administrators(options: AdministratorListOptions): AdministratorList!
-}`}
-</GraphQLDoc>
-
-## asset {#asset}
-
-<GraphQLDoc
-  type="query"
-  typeName="asset"
-  typeLinks={{
-    Asset: '/reference/graphql-api/admin/object-types#asset',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`"""Get a single Asset by id"""
-type Query {
-  asset(id: ID!): Asset
-}`}
-</GraphQLDoc>
-
-## assets {#assets}
-
-<GraphQLDoc
-  type="query"
-  typeName="assets"
-  typeLinks={{
-    AssetList: '/reference/graphql-api/admin/object-types#assetlist',
-    AssetListOptions: '/reference/graphql-api/admin/input-types#assetlistoptions',
-  }}
->
-{`"""Get a list of Assets"""
-type Query {
-  assets(options: AssetListOptions): AssetList!
-}`}
-</GraphQLDoc>
-
-## channel {#channel}
-
-<GraphQLDoc
-  type="query"
-  typeName="channel"
-  typeLinks={{
-    Channel: '/reference/graphql-api/admin/object-types#channel',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  channel(id: ID!): Channel
-}`}
-</GraphQLDoc>
-
-## channels {#channels}
-
-<GraphQLDoc
-  type="query"
-  typeName="channels"
-  typeLinks={{
-    ChannelList: '/reference/graphql-api/admin/object-types#channellist',
-    ChannelListOptions: '/reference/graphql-api/admin/input-types#channellistoptions',
-  }}
->
-{`type Query {
-  channels(options: ChannelListOptions): ChannelList!
-}`}
-</GraphQLDoc>
-
-## collection {#collection}
-
-<GraphQLDoc
-  type="query"
-  typeName="collection"
-  typeLinks={{
-    Collection: '/reference/graphql-api/admin/object-types#collection',
-    ID: '/reference/graphql-api/admin/object-types#id',
-    String: '/reference/graphql-api/admin/object-types#string',
-  }}
->
-{`"""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
-}`}
-</GraphQLDoc>
-
-## collectionFilters {#collectionfilters}
-
-<GraphQLDoc
-  type="query"
-  typeName="collectionFilters"
-  typeLinks={{
-    ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
-  }}
->
-{`type Query {
-  collectionFilters: [ConfigurableOperationDefinition!]!
-}`}
-</GraphQLDoc>
-
-## collections {#collections}
-
-<GraphQLDoc
-  type="query"
-  typeName="collections"
-  typeLinks={{
-    CollectionList: '/reference/graphql-api/admin/object-types#collectionlist',
-    CollectionListOptions: '/reference/graphql-api/admin/input-types#collectionlistoptions',
-  }}
->
-{`type Query {
-  collections(options: CollectionListOptions): CollectionList!
-}`}
-</GraphQLDoc>
-
-## countries {#countries}
-
-<GraphQLDoc
-  type="query"
-  typeName="countries"
-  typeLinks={{
-    CountryList: '/reference/graphql-api/admin/object-types#countrylist',
-    CountryListOptions: '/reference/graphql-api/admin/input-types#countrylistoptions',
-  }}
->
-{`type Query {
-  countries(options: CountryListOptions): CountryList!
-}`}
-</GraphQLDoc>
-
-## country {#country}
-
-<GraphQLDoc
-  type="query"
-  typeName="country"
-  typeLinks={{
-    Country: '/reference/graphql-api/admin/object-types#country',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  country(id: ID!): Country
-}`}
-</GraphQLDoc>
-
-## customer {#customer}
-
-<GraphQLDoc
-  type="query"
-  typeName="customer"
-  typeLinks={{
-    Customer: '/reference/graphql-api/admin/object-types#customer',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  customer(id: ID!): Customer
-}`}
-</GraphQLDoc>
-
-## customerGroup {#customergroup}
-
-<GraphQLDoc
-  type="query"
-  typeName="customerGroup"
-  typeLinks={{
-    CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  customerGroup(id: ID!): CustomerGroup
-}`}
-</GraphQLDoc>
-
-## customerGroups {#customergroups}
-
-<GraphQLDoc
-  type="query"
-  typeName="customerGroups"
-  typeLinks={{
-    CustomerGroupList: '/reference/graphql-api/admin/object-types#customergrouplist',
-    CustomerGroupListOptions: '/reference/graphql-api/admin/input-types#customergrouplistoptions',
-  }}
->
-{`type Query {
-  customerGroups(options: CustomerGroupListOptions): CustomerGroupList!
-}`}
-</GraphQLDoc>
-
-## customers {#customers}
-
-<GraphQLDoc
-  type="query"
-  typeName="customers"
-  typeLinks={{
-    CustomerList: '/reference/graphql-api/admin/object-types#customerlist',
-    CustomerListOptions: '/reference/graphql-api/admin/input-types#customerlistoptions',
-  }}
->
-{`type Query {
-  customers(options: CustomerListOptions): CustomerList!
-}`}
-</GraphQLDoc>
-
-## eligibleShippingMethodsForDraftOrder {#eligibleshippingmethodsfordraftorder}
-
-<GraphQLDoc
-  type="query"
-  typeName="eligibleShippingMethodsForDraftOrder"
-  typeLinks={{
-    ShippingMethodQuote: '/reference/graphql-api/admin/object-types#shippingmethodquote',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`"""Returns a list of eligible shipping methods for the draft Order"""
-type Query {
-  eligibleShippingMethodsForDraftOrder(orderId: ID!): [ShippingMethodQuote!]!
-}`}
-</GraphQLDoc>
-
-## entityDuplicators {#entityduplicators}
-
-<GraphQLDoc
-  type="query"
-  typeName="entityDuplicators"
-  typeLinks={{
-    EntityDuplicatorDefinition: '/reference/graphql-api/admin/object-types#entityduplicatordefinition',
-  }}
->
-{`"""Returns all configured EntityDuplicators."""
-type Query {
-  entityDuplicators: [EntityDuplicatorDefinition!]!
-}`}
-</GraphQLDoc>
-
-## facet {#facet}
-
-<GraphQLDoc
-  type="query"
-  typeName="facet"
-  typeLinks={{
-    Facet: '/reference/graphql-api/admin/object-types#facet',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  facet(id: ID!): Facet
-}`}
-</GraphQLDoc>
-
-## facetValue {#facetvalue}
-
-<GraphQLDoc
-  type="query"
-  typeName="facetValue"
-  typeLinks={{
-    FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  facetValue(id: ID!): FacetValue
-}`}
-</GraphQLDoc>
-
-## facetValues {#facetvalues}
-
-<GraphQLDoc
-  type="query"
-  typeName="facetValues"
-  typeLinks={{
-    FacetValueList: '/reference/graphql-api/admin/object-types#facetvaluelist',
-    FacetValueListOptions: '/reference/graphql-api/admin/input-types#facetvaluelistoptions',
-  }}
->
-{`type Query {
-  facetValues(options: FacetValueListOptions): FacetValueList!
-}`}
-</GraphQLDoc>
-
-## facets {#facets}
-
-<GraphQLDoc
-  type="query"
-  typeName="facets"
-  typeLinks={{
-    FacetList: '/reference/graphql-api/admin/object-types#facetlist',
-    FacetListOptions: '/reference/graphql-api/admin/input-types#facetlistoptions',
-  }}
->
-{`type Query {
-  facets(options: FacetListOptions): FacetList!
-}`}
-</GraphQLDoc>
-
-## fulfillmentHandlers {#fulfillmenthandlers}
-
-<GraphQLDoc
-  type="query"
-  typeName="fulfillmentHandlers"
-  typeLinks={{
-    ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
-  }}
->
-{`type Query {
-  fulfillmentHandlers: [ConfigurableOperationDefinition!]!
-}`}
-</GraphQLDoc>
-
-## getSettingsStoreValue {#getsettingsstorevalue}
-
-<GraphQLDoc
-  type="query"
-  typeName="getSettingsStoreValue"
-  typeLinks={{
-    JSON: '/reference/graphql-api/admin/object-types#json',
-    String: '/reference/graphql-api/admin/object-types#string',
-  }}
->
-{`"""Get value for a specific key (automatically scoped based on field configuration)"""
-type Query {
-  getSettingsStoreValue(key: String!): JSON
-}`}
-</GraphQLDoc>
-
-## getSettingsStoreValues {#getsettingsstorevalues}
-
-<GraphQLDoc
-  type="query"
-  typeName="getSettingsStoreValues"
-  typeLinks={{
-    JSON: '/reference/graphql-api/admin/object-types#json',
-    String: '/reference/graphql-api/admin/object-types#string',
-  }}
->
-{`"""Get multiple key-value pairs (each automatically scoped)"""
-type Query {
-  getSettingsStoreValues(keys: [String!]!): JSON
-}`}
-</GraphQLDoc>
-
-## globalSettings {#globalsettings}
-
-<GraphQLDoc
-  type="query"
-  typeName="globalSettings"
-  typeLinks={{
-    GlobalSettings: '/reference/graphql-api/admin/object-types#globalsettings',
-  }}
->
-{`type Query {
-  globalSettings: GlobalSettings!
-}`}
-</GraphQLDoc>
-
-## job {#job}
-
-<GraphQLDoc
-  type="query"
-  typeName="job"
-  typeLinks={{
-    Job: '/reference/graphql-api/admin/object-types#job',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  job(jobId: ID!): Job
-}`}
-</GraphQLDoc>
-
-## jobBufferSize {#jobbuffersize}
-
-<GraphQLDoc
-  type="query"
-  typeName="jobBufferSize"
-  typeLinks={{
-    JobBufferSize: '/reference/graphql-api/admin/object-types#jobbuffersize',
-    String: '/reference/graphql-api/admin/object-types#string',
-  }}
->
-{`type Query {
-  jobBufferSize(bufferIds: [String!]): [JobBufferSize!]!
-}`}
-</GraphQLDoc>
-
-## jobQueues {#jobqueues}
-
-<GraphQLDoc
-  type="query"
-  typeName="jobQueues"
-  typeLinks={{
-    JobQueue: '/reference/graphql-api/admin/object-types#jobqueue',
-  }}
->
-{`type Query {
-  jobQueues: [JobQueue!]!
-}`}
-</GraphQLDoc>
-
-## jobs {#jobs}
-
-<GraphQLDoc
-  type="query"
-  typeName="jobs"
-  typeLinks={{
-    JobList: '/reference/graphql-api/admin/object-types#joblist',
-    JobListOptions: '/reference/graphql-api/admin/input-types#joblistoptions',
-  }}
->
-{`type Query {
-  jobs(options: JobListOptions): JobList!
-}`}
-</GraphQLDoc>
-
-## jobsById {#jobsbyid}
-
-<GraphQLDoc
-  type="query"
-  typeName="jobsById"
-  typeLinks={{
-    Job: '/reference/graphql-api/admin/object-types#job',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  jobsById(jobIds: [ID!]!): [Job!]!
-}`}
-</GraphQLDoc>
-
-## me {#me}
-
-<GraphQLDoc
-  type="query"
-  typeName="me"
-  typeLinks={{
-    CurrentUser: '/reference/graphql-api/admin/object-types#currentuser',
-  }}
->
-{`type Query {
-  me: CurrentUser
-}`}
-</GraphQLDoc>
-
-## metricSummary {#metricsummary}
-
-<GraphQLDoc
-  type="query"
-  typeName="metricSummary"
-  typeLinks={{
-    MetricSummary: '/reference/graphql-api/admin/object-types#metricsummary',
-    MetricSummaryInput: '/reference/graphql-api/admin/input-types#metricsummaryinput',
-  }}
->
-{`"""Get metrics for the given interval and metric types."""
-type Query {
-  metricSummary(input: MetricSummaryInput): [MetricSummary!]!
-}`}
-</GraphQLDoc>
-
-## order {#order}
-
-<GraphQLDoc
-  type="query"
-  typeName="order"
-  typeLinks={{
-    Order: '/reference/graphql-api/admin/object-types#order',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  order(id: ID!): Order
-}`}
-</GraphQLDoc>
-
-## orders {#orders}
-
-<GraphQLDoc
-  type="query"
-  typeName="orders"
-  typeLinks={{
-    OrderList: '/reference/graphql-api/admin/object-types#orderlist',
-    OrderListOptions: '/reference/graphql-api/admin/input-types#orderlistoptions',
-  }}
->
-{`type Query {
-  orders(options: OrderListOptions): OrderList!
-}`}
-</GraphQLDoc>
-
-## paymentMethod {#paymentmethod}
-
-<GraphQLDoc
-  type="query"
-  typeName="paymentMethod"
-  typeLinks={{
-    PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  paymentMethod(id: ID!): PaymentMethod
-}`}
-</GraphQLDoc>
-
-## paymentMethodEligibilityCheckers {#paymentmethodeligibilitycheckers}
-
-<GraphQLDoc
-  type="query"
-  typeName="paymentMethodEligibilityCheckers"
-  typeLinks={{
-    ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
-  }}
->
-{`type Query {
-  paymentMethodEligibilityCheckers: [ConfigurableOperationDefinition!]!
-}`}
-</GraphQLDoc>
-
-## paymentMethodHandlers {#paymentmethodhandlers}
-
-<GraphQLDoc
-  type="query"
-  typeName="paymentMethodHandlers"
-  typeLinks={{
-    ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
-  }}
->
-{`type Query {
-  paymentMethodHandlers: [ConfigurableOperationDefinition!]!
-}`}
-</GraphQLDoc>
-
-## paymentMethods {#paymentmethods}
-
-<GraphQLDoc
-  type="query"
-  typeName="paymentMethods"
-  typeLinks={{
-    PaymentMethodList: '/reference/graphql-api/admin/object-types#paymentmethodlist',
-    PaymentMethodListOptions: '/reference/graphql-api/admin/input-types#paymentmethodlistoptions',
-  }}
->
-{`type Query {
-  paymentMethods(options: PaymentMethodListOptions): PaymentMethodList!
-}`}
-</GraphQLDoc>
-
-## pendingSearchIndexUpdates {#pendingsearchindexupdates}
-
-<GraphQLDoc
-  type="query"
-  typeName="pendingSearchIndexUpdates"
-  typeLinks={{
-    Int: '/reference/graphql-api/admin/object-types#int',
-  }}
->
-{`type Query {
-  pendingSearchIndexUpdates: Int!
-}`}
-</GraphQLDoc>
-
-## previewCollectionVariants {#previewcollectionvariants}
-
-<GraphQLDoc
-  type="query"
-  typeName="previewCollectionVariants"
-  typeLinks={{
-    ProductVariantList: '/reference/graphql-api/admin/object-types#productvariantlist',
-    PreviewCollectionVariantsInput: '/reference/graphql-api/admin/input-types#previewcollectionvariantsinput',
-    ProductVariantListOptions: '/reference/graphql-api/admin/input-types#productvariantlistoptions',
-  }}
->
-{`"""Used for real-time previews of the contents of a Collection"""
-type Query {
-  previewCollectionVariants(input: PreviewCollectionVariantsInput!, options: ProductVariantListOptions): ProductVariantList!
-}`}
-</GraphQLDoc>
-
-## product {#product}
-
-<GraphQLDoc
-  type="query"
-  typeName="product"
-  typeLinks={{
-    Product: '/reference/graphql-api/admin/object-types#product',
-    ID: '/reference/graphql-api/admin/object-types#id',
-    String: '/reference/graphql-api/admin/object-types#string',
-  }}
->
-{`"""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
-}`}
-</GraphQLDoc>
-
-## productOption {#productoption}
-
-<GraphQLDoc
-  type="query"
-  typeName="productOption"
-  typeLinks={{
-    ProductOption: '/reference/graphql-api/admin/object-types#productoption',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  productOption(id: ID!): ProductOption
-}`}
-</GraphQLDoc>
-
-## productOptionGroup {#productoptiongroup}
-
-<GraphQLDoc
-  type="query"
-  typeName="productOptionGroup"
-  typeLinks={{
-    ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  productOptionGroup(id: ID!): ProductOptionGroup
-}`}
-</GraphQLDoc>
-
-## productOptionGroups {#productoptiongroups}
-
-<GraphQLDoc
-  type="query"
-  typeName="productOptionGroups"
-  typeLinks={{
-    ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
-    String: '/reference/graphql-api/admin/object-types#string',
-  }}
->
-{`type Query {
-  productOptionGroups(filterTerm: String): [ProductOptionGroup!]!
-}`}
-</GraphQLDoc>
-
-## productOptions {#productoptions}
-
-<GraphQLDoc
-  type="query"
-  typeName="productOptions"
-  typeLinks={{
-    ProductOptionList: '/reference/graphql-api/admin/object-types#productoptionlist',
-    ProductOptionListOptions: '/reference/graphql-api/admin/input-types#productoptionlistoptions',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  productOptions(options: ProductOptionListOptions, groupId: ID): ProductOptionList!
-}`}
-</GraphQLDoc>
-
-## productVariant {#productvariant}
-
-<GraphQLDoc
-  type="query"
-  typeName="productVariant"
-  typeLinks={{
-    ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`"""Get a ProductVariant by id"""
-type Query {
-  productVariant(id: ID!): ProductVariant
-}`}
-</GraphQLDoc>
-
-## productVariants {#productvariants}
-
-<GraphQLDoc
-  type="query"
-  typeName="productVariants"
-  typeLinks={{
-    ProductVariantList: '/reference/graphql-api/admin/object-types#productvariantlist',
-    ProductVariantListOptions: '/reference/graphql-api/admin/input-types#productvariantlistoptions',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`"""List ProductVariants either all or for the specific product."""
-type Query {
-  productVariants(options: ProductVariantListOptions, productId: ID): ProductVariantList!
-}`}
-</GraphQLDoc>
-
-## products {#products}
-
-<GraphQLDoc
-  type="query"
-  typeName="products"
-  typeLinks={{
-    ProductList: '/reference/graphql-api/admin/object-types#productlist',
-    ProductListOptions: '/reference/graphql-api/admin/input-types#productlistoptions',
-  }}
->
-{`"""List Products"""
-type Query {
-  products(options: ProductListOptions): ProductList!
-}`}
-</GraphQLDoc>
-
-## promotion {#promotion}
-
-<GraphQLDoc
-  type="query"
-  typeName="promotion"
-  typeLinks={{
-    Promotion: '/reference/graphql-api/admin/object-types#promotion',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  promotion(id: ID!): Promotion
-}`}
-</GraphQLDoc>
-
-## promotionActions {#promotionactions}
-
-<GraphQLDoc
-  type="query"
-  typeName="promotionActions"
-  typeLinks={{
-    ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
-  }}
->
-{`type Query {
-  promotionActions: [ConfigurableOperationDefinition!]!
-}`}
-</GraphQLDoc>
-
-## promotionConditions {#promotionconditions}
-
-<GraphQLDoc
-  type="query"
-  typeName="promotionConditions"
-  typeLinks={{
-    ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
-  }}
->
-{`type Query {
-  promotionConditions: [ConfigurableOperationDefinition!]!
-}`}
-</GraphQLDoc>
-
-## promotions {#promotions}
-
-<GraphQLDoc
-  type="query"
-  typeName="promotions"
-  typeLinks={{
-    PromotionList: '/reference/graphql-api/admin/object-types#promotionlist',
-    PromotionListOptions: '/reference/graphql-api/admin/input-types#promotionlistoptions',
-  }}
->
-{`type Query {
-  promotions(options: PromotionListOptions): PromotionList!
-}`}
-</GraphQLDoc>
-
-## province {#province}
-
-<GraphQLDoc
-  type="query"
-  typeName="province"
-  typeLinks={{
-    Province: '/reference/graphql-api/admin/object-types#province',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  province(id: ID!): Province
-}`}
-</GraphQLDoc>
-
-## provinces {#provinces}
-
-<GraphQLDoc
-  type="query"
-  typeName="provinces"
-  typeLinks={{
-    ProvinceList: '/reference/graphql-api/admin/object-types#provincelist',
-    ProvinceListOptions: '/reference/graphql-api/admin/input-types#provincelistoptions',
-  }}
->
-{`type Query {
-  provinces(options: ProvinceListOptions): ProvinceList!
-}`}
-</GraphQLDoc>
-
-## role {#role}
-
-<GraphQLDoc
-  type="query"
-  typeName="role"
-  typeLinks={{
-    Role: '/reference/graphql-api/admin/object-types#role',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  role(id: ID!): Role
-}`}
-</GraphQLDoc>
-
-## roles {#roles}
-
-<GraphQLDoc
-  type="query"
-  typeName="roles"
-  typeLinks={{
-    RoleList: '/reference/graphql-api/admin/object-types#rolelist',
-    RoleListOptions: '/reference/graphql-api/admin/input-types#rolelistoptions',
-  }}
->
-{`type Query {
-  roles(options: RoleListOptions): RoleList!
-}`}
-</GraphQLDoc>
-
-## scheduledTasks {#scheduledtasks}
-
-<GraphQLDoc
-  type="query"
-  typeName="scheduledTasks"
-  typeLinks={{
-    ScheduledTask: '/reference/graphql-api/admin/object-types#scheduledtask',
-  }}
->
-{`type Query {
-  scheduledTasks: [ScheduledTask!]!
-}`}
-</GraphQLDoc>
-
-## search {#search}
-
-<GraphQLDoc
-  type="query"
-  typeName="search"
-  typeLinks={{
-    SearchResponse: '/reference/graphql-api/admin/object-types#searchresponse',
-    SearchInput: '/reference/graphql-api/admin/input-types#searchinput',
-  }}
->
-{`type Query {
-  search(input: SearchInput!): SearchResponse!
-}`}
-</GraphQLDoc>
-
-## seller {#seller}
-
-<GraphQLDoc
-  type="query"
-  typeName="seller"
-  typeLinks={{
-    Seller: '/reference/graphql-api/admin/object-types#seller',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  seller(id: ID!): Seller
-}`}
-</GraphQLDoc>
-
-## sellers {#sellers}
-
-<GraphQLDoc
-  type="query"
-  typeName="sellers"
-  typeLinks={{
-    SellerList: '/reference/graphql-api/admin/object-types#sellerlist',
-    SellerListOptions: '/reference/graphql-api/admin/input-types#sellerlistoptions',
-  }}
->
-{`type Query {
-  sellers(options: SellerListOptions): SellerList!
-}`}
-</GraphQLDoc>
-
-## shippingCalculators {#shippingcalculators}
-
-<GraphQLDoc
-  type="query"
-  typeName="shippingCalculators"
-  typeLinks={{
-    ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
-  }}
->
-{`type Query {
-  shippingCalculators: [ConfigurableOperationDefinition!]!
-}`}
-</GraphQLDoc>
-
-## shippingEligibilityCheckers {#shippingeligibilitycheckers}
-
-<GraphQLDoc
-  type="query"
-  typeName="shippingEligibilityCheckers"
-  typeLinks={{
-    ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
-  }}
->
-{`type Query {
-  shippingEligibilityCheckers: [ConfigurableOperationDefinition!]!
-}`}
-</GraphQLDoc>
-
-## shippingMethod {#shippingmethod}
-
-<GraphQLDoc
-  type="query"
-  typeName="shippingMethod"
-  typeLinks={{
-    ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  shippingMethod(id: ID!): ShippingMethod
-}`}
-</GraphQLDoc>
-
-## shippingMethods {#shippingmethods}
-
-<GraphQLDoc
-  type="query"
-  typeName="shippingMethods"
-  typeLinks={{
-    ShippingMethodList: '/reference/graphql-api/admin/object-types#shippingmethodlist',
-    ShippingMethodListOptions: '/reference/graphql-api/admin/input-types#shippingmethodlistoptions',
-  }}
->
-{`type Query {
-  shippingMethods(options: ShippingMethodListOptions): ShippingMethodList!
-}`}
-</GraphQLDoc>
-
-## slugForEntity {#slugforentity}
-
-<GraphQLDoc
-  type="query"
-  typeName="slugForEntity"
-  typeLinks={{
-    String: '/reference/graphql-api/admin/object-types#string',
-    SlugForEntityInput: '/reference/graphql-api/admin/input-types#slugforentityinput',
-  }}
->
-{`"""Generate slug for entity"""
-type Query {
-  slugForEntity(input: SlugForEntityInput!): String!
-}`}
-</GraphQLDoc>
-
-## stockLocation {#stocklocation}
-
-<GraphQLDoc
-  type="query"
-  typeName="stockLocation"
-  typeLinks={{
-    StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  stockLocation(id: ID!): StockLocation
-}`}
-</GraphQLDoc>
-
-## stockLocations {#stocklocations}
-
-<GraphQLDoc
-  type="query"
-  typeName="stockLocations"
-  typeLinks={{
-    StockLocationList: '/reference/graphql-api/admin/object-types#stocklocationlist',
-    StockLocationListOptions: '/reference/graphql-api/admin/input-types#stocklocationlistoptions',
-  }}
->
-{`type Query {
-  stockLocations(options: StockLocationListOptions): StockLocationList!
-}`}
-</GraphQLDoc>
-
-## tag {#tag}
-
-<GraphQLDoc
-  type="query"
-  typeName="tag"
-  typeLinks={{
-    Tag: '/reference/graphql-api/admin/object-types#tag',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  tag(id: ID!): Tag!
-}`}
-</GraphQLDoc>
-
-## tags {#tags}
-
-<GraphQLDoc
-  type="query"
-  typeName="tags"
-  typeLinks={{
-    TagList: '/reference/graphql-api/admin/object-types#taglist',
-    TagListOptions: '/reference/graphql-api/admin/input-types#taglistoptions',
-  }}
->
-{`type Query {
-  tags(options: TagListOptions): TagList!
-}`}
-</GraphQLDoc>
-
-## taxCategories {#taxcategories}
-
-<GraphQLDoc
-  type="query"
-  typeName="taxCategories"
-  typeLinks={{
-    TaxCategoryList: '/reference/graphql-api/admin/object-types#taxcategorylist',
-    TaxCategoryListOptions: '/reference/graphql-api/admin/input-types#taxcategorylistoptions',
-  }}
->
-{`type Query {
-  taxCategories(options: TaxCategoryListOptions): TaxCategoryList!
-}`}
-</GraphQLDoc>
-
-## taxCategory {#taxcategory}
-
-<GraphQLDoc
-  type="query"
-  typeName="taxCategory"
-  typeLinks={{
-    TaxCategory: '/reference/graphql-api/admin/object-types#taxcategory',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  taxCategory(id: ID!): TaxCategory
-}`}
-</GraphQLDoc>
-
-## taxRate {#taxrate}
-
-<GraphQLDoc
-  type="query"
-  typeName="taxRate"
-  typeLinks={{
-    TaxRate: '/reference/graphql-api/admin/object-types#taxrate',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  taxRate(id: ID!): TaxRate
-}`}
-</GraphQLDoc>
-
-## taxRates {#taxrates}
-
-<GraphQLDoc
-  type="query"
-  typeName="taxRates"
-  typeLinks={{
-    TaxRateList: '/reference/graphql-api/admin/object-types#taxratelist',
-    TaxRateListOptions: '/reference/graphql-api/admin/input-types#taxratelistoptions',
-  }}
->
-{`type Query {
-  taxRates(options: TaxRateListOptions): TaxRateList!
-}`}
-</GraphQLDoc>
-
-## testEligibleShippingMethods {#testeligibleshippingmethods}
-
-<GraphQLDoc
-  type="query"
-  typeName="testEligibleShippingMethods"
-  typeLinks={{
-    ShippingMethodQuote: '/reference/graphql-api/admin/object-types#shippingmethodquote',
-    TestEligibleShippingMethodsInput: '/reference/graphql-api/admin/input-types#testeligibleshippingmethodsinput',
-  }}
->
-{`type Query {
-  testEligibleShippingMethods(input: TestEligibleShippingMethodsInput!): [ShippingMethodQuote!]!
-}`}
-</GraphQLDoc>
-
-## testShippingMethod {#testshippingmethod}
-
-<GraphQLDoc
-  type="query"
-  typeName="testShippingMethod"
-  typeLinks={{
-    TestShippingMethodResult: '/reference/graphql-api/admin/object-types#testshippingmethodresult',
-    TestShippingMethodInput: '/reference/graphql-api/admin/input-types#testshippingmethodinput',
-  }}
->
-{`type Query {
-  testShippingMethod(input: TestShippingMethodInput!): TestShippingMethodResult!
-}`}
-</GraphQLDoc>
-
-## zone {#zone}
-
-<GraphQLDoc
-  type="query"
-  typeName="zone"
-  typeLinks={{
-    Zone: '/reference/graphql-api/admin/object-types#zone',
-    ID: '/reference/graphql-api/admin/object-types#id',
-  }}
->
-{`type Query {
-  zone(id: ID!): Zone
-}`}
-</GraphQLDoc>
-
-## zones {#zones}
-
-<GraphQLDoc
-  type="query"
-  typeName="zones"
-  typeLinks={{
-    ZoneList: '/reference/graphql-api/admin/object-types#zonelist',
-    ZoneListOptions: '/reference/graphql-api/admin/input-types#zonelistoptions',
-  }}
->
-{`type Query {
-  zones(options: ZoneListOptions): ZoneList!
-}`}
-</GraphQLDoc>