@vendure/docs 0.0.0-202601211103 → 0.0.0-202601211343

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

@@ -1,314 +0,0 @@
----
-title: "Queries"
-generated: true
----
-
-
-
-## activeChannel {#activechannel}
-
-<GraphQLDoc
-  type="query"
-  typeName="activeChannel"
-  typeLinks={{
-    Channel: '/reference/graphql-api/shop/object-types#channel',
-  }}
->
-{`"""The active Channel"""
-type Query {
-  activeChannel: Channel!
-}`}
-</GraphQLDoc>
-
-## activeCustomer {#activecustomer}
-
-<GraphQLDoc
-  type="query"
-  typeName="activeCustomer"
-  typeLinks={{
-    Customer: '/reference/graphql-api/shop/object-types#customer',
-  }}
->
-{`"""The active Customer"""
-type Query {
-  activeCustomer: Customer
-}`}
-</GraphQLDoc>
-
-## activeOrder {#activeorder}
-
-<GraphQLDoc
-  type="query"
-  typeName="activeOrder"
-  typeLinks={{
-    Order: '/reference/graphql-api/shop/object-types#order',
-  }}
->
-{`"""
-The active Order. Will be \`null\` until an Order is created via \`addItemToOrder\`. Once an Order reaches the
-state of \`PaymentAuthorized\` or \`PaymentSettled\`, then that Order is no longer considered "active" and this
-query will once again return \`null\`.
-"""
-type Query {
-  activeOrder: Order
-}`}
-</GraphQLDoc>
-
-## activePaymentMethods {#activepaymentmethods}
-
-<GraphQLDoc
-  type="query"
-  typeName="activePaymentMethods"
-  typeLinks={{
-    PublicPaymentMethod: '/reference/graphql-api/shop/object-types#publicpaymentmethod',
-  }}
->
-{`"""Get active payment methods"""
-type Query {
-  activePaymentMethods: [PublicPaymentMethod]!
-}`}
-</GraphQLDoc>
-
-## activeShippingMethods {#activeshippingmethods}
-
-<GraphQLDoc
-  type="query"
-  typeName="activeShippingMethods"
-  typeLinks={{
-    PublicShippingMethod: '/reference/graphql-api/shop/object-types#publicshippingmethod',
-  }}
->
-{`"""Get active shipping methods"""
-type Query {
-  activeShippingMethods: [PublicShippingMethod]!
-}`}
-</GraphQLDoc>
-
-## availableCountries {#availablecountries}
-
-<GraphQLDoc
-  type="query"
-  typeName="availableCountries"
-  typeLinks={{
-    Country: '/reference/graphql-api/shop/object-types#country',
-  }}
->
-{`"""An array of supported Countries"""
-type Query {
-  availableCountries: [Country!]!
-}`}
-</GraphQLDoc>
-
-## collection {#collection}
-
-<GraphQLDoc
-  type="query"
-  typeName="collection"
-  typeLinks={{
-    Collection: '/reference/graphql-api/shop/object-types#collection',
-    ID: '/reference/graphql-api/shop/object-types#id',
-    String: '/reference/graphql-api/shop/object-types#string',
-  }}
->
-{`"""Returns a Collection either by its id or slug. If neither 'id' nor 'slug' is specified, an error will result."""
-type Query {
-  collection(id: ID, slug: String): Collection
-}`}
-</GraphQLDoc>
-
-## collections {#collections}
-
-<GraphQLDoc
-  type="query"
-  typeName="collections"
-  typeLinks={{
-    CollectionList: '/reference/graphql-api/shop/object-types#collectionlist',
-    CollectionListOptions: '/reference/graphql-api/shop/input-types#collectionlistoptions',
-  }}
->
-{`"""A list of Collections available to the shop"""
-type Query {
-  collections(options: CollectionListOptions): CollectionList!
-}`}
-</GraphQLDoc>
-
-## eligiblePaymentMethods {#eligiblepaymentmethods}
-
-<GraphQLDoc
-  type="query"
-  typeName="eligiblePaymentMethods"
-  typeLinks={{
-    PaymentMethodQuote: '/reference/graphql-api/shop/object-types#paymentmethodquote',
-  }}
->
-{`"""Returns a list of payment methods and their eligibility based on the current active Order"""
-type Query {
-  eligiblePaymentMethods: [PaymentMethodQuote!]!
-}`}
-</GraphQLDoc>
-
-## eligibleShippingMethods {#eligibleshippingmethods}
-
-<GraphQLDoc
-  type="query"
-  typeName="eligibleShippingMethods"
-  typeLinks={{
-    ShippingMethodQuote: '/reference/graphql-api/shop/object-types#shippingmethodquote',
-  }}
->
-{`"""Returns a list of eligible shipping methods based on the current active Order"""
-type Query {
-  eligibleShippingMethods: [ShippingMethodQuote!]!
-}`}
-</GraphQLDoc>
-
-## facet {#facet}
-
-<GraphQLDoc
-  type="query"
-  typeName="facet"
-  typeLinks={{
-    Facet: '/reference/graphql-api/shop/object-types#facet',
-    ID: '/reference/graphql-api/shop/object-types#id',
-  }}
->
-{`"""Returns a Facet by its id"""
-type Query {
-  facet(id: ID!): Facet
-}`}
-</GraphQLDoc>
-
-## facets {#facets}
-
-<GraphQLDoc
-  type="query"
-  typeName="facets"
-  typeLinks={{
-    FacetList: '/reference/graphql-api/shop/object-types#facetlist',
-    FacetListOptions: '/reference/graphql-api/shop/input-types#facetlistoptions',
-  }}
->
-{`"""A list of Facets available to the shop"""
-type Query {
-  facets(options: FacetListOptions): FacetList!
-}`}
-</GraphQLDoc>
-
-## me {#me}
-
-<GraphQLDoc
-  type="query"
-  typeName="me"
-  typeLinks={{
-    CurrentUser: '/reference/graphql-api/shop/object-types#currentuser',
-  }}
->
-{`"""Returns information about the current authenticated User"""
-type Query {
-  me: CurrentUser
-}`}
-</GraphQLDoc>
-
-## nextOrderStates {#nextorderstates}
-
-<GraphQLDoc
-  type="query"
-  typeName="nextOrderStates"
-  typeLinks={{
-    String: '/reference/graphql-api/shop/object-types#string',
-  }}
->
-{`"""Returns the possible next states that the activeOrder can transition to"""
-type Query {
-  nextOrderStates: [String!]!
-}`}
-</GraphQLDoc>
-
-## order {#order}
-
-<GraphQLDoc
-  type="query"
-  typeName="order"
-  typeLinks={{
-    Order: '/reference/graphql-api/shop/object-types#order',
-    ID: '/reference/graphql-api/shop/object-types#id',
-  }}
->
-{`"""
-Returns an Order based on the id. Note that in the Shop API, only orders belonging to the
-currently-authenticated User may be queried.
-"""
-type Query {
-  order(id: ID!): Order
-}`}
-</GraphQLDoc>
-
-## orderByCode {#orderbycode}
-
-<GraphQLDoc
-  type="query"
-  typeName="orderByCode"
-  typeLinks={{
-    Order: '/reference/graphql-api/shop/object-types#order',
-    String: '/reference/graphql-api/shop/object-types#string',
-  }}
->
-{`"""
-Returns an Order based on the order \`code\`. For guest Orders (i.e. Orders placed by non-authenticated Customers)
-this query will only return the Order within 2 hours of the Order being placed. This allows an Order confirmation
-screen to be shown immediately after completion of a guest checkout, yet prevents security risks of allowing
-general anonymous access to Order data.
-"""
-type Query {
-  orderByCode(code: String!): Order
-}`}
-</GraphQLDoc>
-
-## product {#product}
-
-<GraphQLDoc
-  type="query"
-  typeName="product"
-  typeLinks={{
-    Product: '/reference/graphql-api/shop/object-types#product',
-    ID: '/reference/graphql-api/shop/object-types#id',
-    String: '/reference/graphql-api/shop/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>
-
-## products {#products}
-
-<GraphQLDoc
-  type="query"
-  typeName="products"
-  typeLinks={{
-    ProductList: '/reference/graphql-api/shop/object-types#productlist',
-    ProductListOptions: '/reference/graphql-api/shop/input-types#productlistoptions',
-  }}
->
-{`"""Get a list of Products"""
-type Query {
-  products(options: ProductListOptions): ProductList!
-}`}
-</GraphQLDoc>
-
-## search {#search}
-
-<GraphQLDoc
-  type="query"
-  typeName="search"
-  typeLinks={{
-    SearchResponse: '/reference/graphql-api/shop/object-types#searchresponse',
-    SearchInput: '/reference/graphql-api/shop/input-types#searchinput',
-  }}
->
-{`"""Search Products based on the criteria set by the \`SearchInput\`"""
-type Query {
-  search(input: SearchInput!): SearchResponse!
-}`}
-</GraphQLDoc>