@vendure/docs 0.0.0-202601211406 → 0.0.0-202601211412

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

@@ -5,7 +5,9 @@ generated: true
 
 
 
-## activeAdministrator {#activeadministrator}
+<a name="activeadministrator"></a>
+
+## activeAdministrator
 
 <GraphQLDoc
   type="query"
@@ -19,7 +21,9 @@ generated: true
 }`}
 </GraphQLDoc>
 
-## activeChannel {#activechannel}
+<a name="activechannel"></a>
+
+## activeChannel
 
 <GraphQLDoc
   type="query"
@@ -33,7 +37,9 @@ generated: true
 }`}
 </GraphQLDoc>
 
-## administrator {#administrator}
+<a name="administrator"></a>
+
+## administrator
 
 <GraphQLDoc
   type="query"
@@ -48,7 +54,9 @@ generated: true
 }`}
 </GraphQLDoc>
 
-## administrators {#administrators}
+<a name="administrators"></a>
+
+## administrators
 
 <GraphQLDoc
   type="query"
@@ -63,7 +71,9 @@ generated: true
 }`}
 </GraphQLDoc>
 
-## asset {#asset}
+<a name="asset"></a>
+
+## asset
 
 <GraphQLDoc
   type="query"
@@ -79,7 +89,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## assets {#assets}
+<a name="assets"></a>
+
+## assets
 
 <GraphQLDoc
   type="query"
@@ -95,7 +107,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## channel {#channel}
+<a name="channel"></a>
+
+## channel
 
 <GraphQLDoc
   type="query"
@@ -110,7 +124,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## channels {#channels}
+<a name="channels"></a>
+
+## channels
 
 <GraphQLDoc
   type="query"
@@ -125,7 +141,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## collection {#collection}
+<a name="collection"></a>
+
+## collection
 
 <GraphQLDoc
   type="query"
@@ -142,7 +160,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## collectionFilters {#collectionfilters}
+<a name="collectionfilters"></a>
+
+## collectionFilters
 
 <GraphQLDoc
   type="query"
@@ -156,7 +176,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## collections {#collections}
+<a name="collections"></a>
+
+## collections
 
 <GraphQLDoc
   type="query"
@@ -171,7 +193,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## countries {#countries}
+<a name="countries"></a>
+
+## countries
 
 <GraphQLDoc
   type="query"
@@ -186,7 +210,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## country {#country}
+<a name="country"></a>
+
+## country
 
 <GraphQLDoc
   type="query"
@@ -201,7 +227,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## customer {#customer}
+<a name="customer"></a>
+
+## customer
 
 <GraphQLDoc
   type="query"
@@ -216,7 +244,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## customerGroup {#customergroup}
+<a name="customergroup"></a>
+
+## customerGroup
 
 <GraphQLDoc
   type="query"
@@ -231,7 +261,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## customerGroups {#customergroups}
+<a name="customergroups"></a>
+
+## customerGroups
 
 <GraphQLDoc
   type="query"
@@ -246,7 +278,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## customers {#customers}
+<a name="customers"></a>
+
+## customers
 
 <GraphQLDoc
   type="query"
@@ -261,7 +295,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## eligibleShippingMethodsForDraftOrder {#eligibleshippingmethodsfordraftorder}
+<a name="eligibleshippingmethodsfordraftorder"></a>
+
+## eligibleShippingMethodsForDraftOrder
 
 <GraphQLDoc
   type="query"
@@ -277,7 +313,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## entityDuplicators {#entityduplicators}
+<a name="entityduplicators"></a>
+
+## entityDuplicators
 
 <GraphQLDoc
   type="query"
@@ -292,7 +330,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## facet {#facet}
+<a name="facet"></a>
+
+## facet
 
 <GraphQLDoc
   type="query"
@@ -307,7 +347,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## facetValue {#facetvalue}
+<a name="facetvalue"></a>
+
+## facetValue
 
 <GraphQLDoc
   type="query"
@@ -322,7 +364,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## facetValues {#facetvalues}
+<a name="facetvalues"></a>
+
+## facetValues
 
 <GraphQLDoc
   type="query"
@@ -337,7 +381,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## facets {#facets}
+<a name="facets"></a>
+
+## facets
 
 <GraphQLDoc
   type="query"
@@ -352,7 +398,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## fulfillmentHandlers {#fulfillmenthandlers}
+<a name="fulfillmenthandlers"></a>
+
+## fulfillmentHandlers
 
 <GraphQLDoc
   type="query"
@@ -366,7 +414,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## getSettingsStoreValue {#getsettingsstorevalue}
+<a name="getsettingsstorevalue"></a>
+
+## getSettingsStoreValue
 
 <GraphQLDoc
   type="query"
@@ -382,7 +432,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## getSettingsStoreValues {#getsettingsstorevalues}
+<a name="getsettingsstorevalues"></a>
+
+## getSettingsStoreValues
 
 <GraphQLDoc
   type="query"
@@ -398,7 +450,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## globalSettings {#globalsettings}
+<a name="globalsettings"></a>
+
+## globalSettings
 
 <GraphQLDoc
   type="query"
@@ -412,7 +466,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## job {#job}
+<a name="job"></a>
+
+## job
 
 <GraphQLDoc
   type="query"
@@ -427,7 +483,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## jobBufferSize {#jobbuffersize}
+<a name="jobbuffersize"></a>
+
+## jobBufferSize
 
 <GraphQLDoc
   type="query"
@@ -442,7 +500,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## jobQueues {#jobqueues}
+<a name="jobqueues"></a>
+
+## jobQueues
 
 <GraphQLDoc
   type="query"
@@ -456,7 +516,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## jobs {#jobs}
+<a name="jobs"></a>
+
+## jobs
 
 <GraphQLDoc
   type="query"
@@ -471,7 +533,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## jobsById {#jobsbyid}
+<a name="jobsbyid"></a>
+
+## jobsById
 
 <GraphQLDoc
   type="query"
@@ -486,7 +550,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## me {#me}
+<a name="me"></a>
+
+## me
 
 <GraphQLDoc
   type="query"
@@ -500,7 +566,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## metricSummary {#metricsummary}
+<a name="metricsummary"></a>
+
+## metricSummary
 
 <GraphQLDoc
   type="query"
@@ -516,7 +584,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## order {#order}
+<a name="order"></a>
+
+## order
 
 <GraphQLDoc
   type="query"
@@ -531,7 +601,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## orders {#orders}
+<a name="orders"></a>
+
+## orders
 
 <GraphQLDoc
   type="query"
@@ -546,7 +618,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## paymentMethod {#paymentmethod}
+<a name="paymentmethod"></a>
+
+## paymentMethod
 
 <GraphQLDoc
   type="query"
@@ -561,7 +635,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## paymentMethodEligibilityCheckers {#paymentmethodeligibilitycheckers}
+<a name="paymentmethodeligibilitycheckers"></a>
+
+## paymentMethodEligibilityCheckers
 
 <GraphQLDoc
   type="query"
@@ -575,7 +651,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## paymentMethodHandlers {#paymentmethodhandlers}
+<a name="paymentmethodhandlers"></a>
+
+## paymentMethodHandlers
 
 <GraphQLDoc
   type="query"
@@ -589,7 +667,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## paymentMethods {#paymentmethods}
+<a name="paymentmethods"></a>
+
+## paymentMethods
 
 <GraphQLDoc
   type="query"
@@ -604,7 +684,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## pendingSearchIndexUpdates {#pendingsearchindexupdates}
+<a name="pendingsearchindexupdates"></a>
+
+## pendingSearchIndexUpdates
 
 <GraphQLDoc
   type="query"
@@ -618,7 +700,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## previewCollectionVariants {#previewcollectionvariants}
+<a name="previewcollectionvariants"></a>
+
+## previewCollectionVariants
 
 <GraphQLDoc
   type="query"
@@ -635,7 +719,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## product {#product}
+<a name="product"></a>
+
+## product
 
 <GraphQLDoc
   type="query"
@@ -652,7 +738,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## productOption {#productoption}
+<a name="productoption"></a>
+
+## productOption
 
 <GraphQLDoc
   type="query"
@@ -667,7 +755,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## productOptionGroup {#productoptiongroup}
+<a name="productoptiongroup"></a>
+
+## productOptionGroup
 
 <GraphQLDoc
   type="query"
@@ -682,7 +772,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## productOptionGroups {#productoptiongroups}
+<a name="productoptiongroups"></a>
+
+## productOptionGroups
 
 <GraphQLDoc
   type="query"
@@ -697,7 +789,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## productOptions {#productoptions}
+<a name="productoptions"></a>
+
+## productOptions
 
 <GraphQLDoc
   type="query"
@@ -713,7 +807,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## productVariant {#productvariant}
+<a name="productvariant"></a>
+
+## productVariant
 
 <GraphQLDoc
   type="query"
@@ -729,7 +825,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## productVariants {#productvariants}
+<a name="productvariants"></a>
+
+## productVariants
 
 <GraphQLDoc
   type="query"
@@ -746,7 +844,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## products {#products}
+<a name="products"></a>
+
+## products
 
 <GraphQLDoc
   type="query"
@@ -762,7 +862,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## promotion {#promotion}
+<a name="promotion"></a>
+
+## promotion
 
 <GraphQLDoc
   type="query"
@@ -777,7 +879,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## promotionActions {#promotionactions}
+<a name="promotionactions"></a>
+
+## promotionActions
 
 <GraphQLDoc
   type="query"
@@ -791,7 +895,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## promotionConditions {#promotionconditions}
+<a name="promotionconditions"></a>
+
+## promotionConditions
 
 <GraphQLDoc
   type="query"
@@ -805,7 +911,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## promotions {#promotions}
+<a name="promotions"></a>
+
+## promotions
 
 <GraphQLDoc
   type="query"
@@ -820,7 +928,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## province {#province}
+<a name="province"></a>
+
+## province
 
 <GraphQLDoc
   type="query"
@@ -835,7 +945,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## provinces {#provinces}
+<a name="provinces"></a>
+
+## provinces
 
 <GraphQLDoc
   type="query"
@@ -850,7 +962,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## role {#role}
+<a name="role"></a>
+
+## role
 
 <GraphQLDoc
   type="query"
@@ -865,7 +979,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## roles {#roles}
+<a name="roles"></a>
+
+## roles
 
 <GraphQLDoc
   type="query"
@@ -880,7 +996,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## scheduledTasks {#scheduledtasks}
+<a name="scheduledtasks"></a>
+
+## scheduledTasks
 
 <GraphQLDoc
   type="query"
@@ -894,7 +1012,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## search {#search}
+<a name="search"></a>
+
+## search
 
 <GraphQLDoc
   type="query"
@@ -909,7 +1029,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## seller {#seller}
+<a name="seller"></a>
+
+## seller
 
 <GraphQLDoc
   type="query"
@@ -924,7 +1046,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## sellers {#sellers}
+<a name="sellers"></a>
+
+## sellers
 
 <GraphQLDoc
   type="query"
@@ -939,7 +1063,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## shippingCalculators {#shippingcalculators}
+<a name="shippingcalculators"></a>
+
+## shippingCalculators
 
 <GraphQLDoc
   type="query"
@@ -953,7 +1079,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## shippingEligibilityCheckers {#shippingeligibilitycheckers}
+<a name="shippingeligibilitycheckers"></a>
+
+## shippingEligibilityCheckers
 
 <GraphQLDoc
   type="query"
@@ -967,7 +1095,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## shippingMethod {#shippingmethod}
+<a name="shippingmethod"></a>
+
+## shippingMethod
 
 <GraphQLDoc
   type="query"
@@ -982,7 +1112,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## shippingMethods {#shippingmethods}
+<a name="shippingmethods"></a>
+
+## shippingMethods
 
 <GraphQLDoc
   type="query"
@@ -997,7 +1129,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## slugForEntity {#slugforentity}
+<a name="slugforentity"></a>
+
+## slugForEntity
 
 <GraphQLDoc
   type="query"
@@ -1013,7 +1147,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## stockLocation {#stocklocation}
+<a name="stocklocation"></a>
+
+## stockLocation
 
 <GraphQLDoc
   type="query"
@@ -1028,7 +1164,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## stockLocations {#stocklocations}
+<a name="stocklocations"></a>
+
+## stockLocations
 
 <GraphQLDoc
   type="query"
@@ -1043,7 +1181,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## tag {#tag}
+<a name="tag"></a>
+
+## tag
 
 <GraphQLDoc
   type="query"
@@ -1058,7 +1198,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## tags {#tags}
+<a name="tags"></a>
+
+## tags
 
 <GraphQLDoc
   type="query"
@@ -1073,7 +1215,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## taxCategories {#taxcategories}
+<a name="taxcategories"></a>
+
+## taxCategories
 
 <GraphQLDoc
   type="query"
@@ -1088,7 +1232,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## taxCategory {#taxcategory}
+<a name="taxcategory"></a>
+
+## taxCategory
 
 <GraphQLDoc
   type="query"
@@ -1103,7 +1249,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## taxRate {#taxrate}
+<a name="taxrate"></a>
+
+## taxRate
 
 <GraphQLDoc
   type="query"
@@ -1118,7 +1266,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## taxRates {#taxrates}
+<a name="taxrates"></a>
+
+## taxRates
 
 <GraphQLDoc
   type="query"
@@ -1133,7 +1283,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## testEligibleShippingMethods {#testeligibleshippingmethods}
+<a name="testeligibleshippingmethods"></a>
+
+## testEligibleShippingMethods
 
 <GraphQLDoc
   type="query"
@@ -1148,7 +1300,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## testShippingMethod {#testshippingmethod}
+<a name="testshippingmethod"></a>
+
+## testShippingMethod
 
 <GraphQLDoc
   type="query"
@@ -1163,7 +1317,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## zone {#zone}
+<a name="zone"></a>
+
+## zone
 
 <GraphQLDoc
   type="query"
@@ -1178,7 +1334,9 @@ type Query {
 }`}
 </GraphQLDoc>
 
-## zones {#zones}
+<a name="zones"></a>
+
+## zones
 
 <GraphQLDoc
   type="query"