content
stringlengths 29
370k
|
|---|
---
title: "Tabs"
isDefaultIndex: true
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
import DocCardList from '@theme/DocCardList';
<DocCardList /> |
---
title: "PageTabConfig"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## PageTabConfig
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/providers/page/page.service.ts" sourceLine="14" packageName="@vendure/admin-ui" />
The object used to configure a new page tab.
```ts title="Signature"
interface PageTabConfig {
location: PageLocationId;
tabIcon?: string;
route: string;
tab: string;
priority?: number;
component: Type<any> | ReturnType<typeof detailComponentWithResolver>;
routeConfig?: Route;
}
```
<div className="members-wrapper">
### location
<MemberInfo kind="property" type={`<a href='/reference/admin-ui-api/action-bar/page-location-id#pagelocationid'>PageLocationId</a>`} />
A valid location representing a list or detail page.
### tabIcon
<MemberInfo kind="property" type={`string`} />
An optional icon to display in the tab. The icon
should be a valid shape name from the [Clarity Icons](https://core.clarity.design/foundation/icons/shapes/)
set.
### route
<MemberInfo kind="property" type={`string`} />
The route path to the tab. This will be appended to the
route of the parent page.
### tab
<MemberInfo kind="property" type={`string`} />
The name of the tab to display in the UI.
### priority
<MemberInfo kind="property" type={`number`} />
The priority of the tab. Tabs with a lower priority will be displayed first.
### component
<MemberInfo kind="property" type={`Type<any> | ReturnType<typeof <a href='/reference/admin-ui-api/list-detail-views/detail-component-with-resolver#detailcomponentwithresolver'>detailComponentWithResolver</a>>`} />
The component to render at the route of the tab.
### routeConfig
<MemberInfo kind="property" type={`Route`} />
You can optionally provide any native Angular route configuration options here.
Any values provided here will take precedence over the values generated
by the `route` and `component` properties.
</div>
|
---
title: "RegisterPageTab"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## registerPageTab
<GenerationInfo sourceFile="packages/admin-ui/src/lib/core/src/extension/register-page-tab.ts" sourceLine="24" packageName="@vendure/admin-ui" />
Add a tab to an existing list or detail page.
*Example*
```ts title="providers.ts"
import { registerPageTab } from '@vendure/admin-ui/core';
import { DeletedProductListComponent } from './components/deleted-product-list/deleted-product-list.component';
export default [
registerPageTab({
location: 'product-list',
tab: 'Deleted Products',
route: 'deleted',
component: DeletedProductListComponent,
}),
];
```
```ts title="Signature"
function registerPageTab(config: PageTabConfig): Provider
```
Parameters
### config
<MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/tabs/page-tab-config#pagetabconfig'>PageTabConfig</a>`} />
|
---
title: "Ui Devkit"
weight: 10
date: 2023-07-14T16:57:51.349Z
showtoc: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
# ui-devkit |
---
title: "AdminUiExtension"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AdminUiExtension
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="130" packageName="@vendure/ui-devkit" />
Defines extensions to the Admin UI application by specifying additional
Angular [NgModules](https://angular.io/guide/ngmodules) which are compiled
into the application.
See [Extending the Admin UI](/guides/extending-the-admin-ui/getting-started/) for
detailed instructions.
```ts title="Signature"
interface AdminUiExtension extends Partial<TranslationExtension>,
Partial<StaticAssetExtension>,
Partial<GlobalStylesExtension> {
id?: string;
extensionPath: string;
ngModules?: Array<AdminUiExtensionSharedModule | AdminUiExtensionLazyModule>;
providers?: string[];
routes?: UiExtensionRouteDefinition[];
pathAlias?: string;
exclude?: string[];
}
```
* Extends: <code>Partial<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#translationextension'>TranslationExtension</a>></code>, <code>Partial<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#staticassetextension'>StaticAssetExtension</a>></code>, <code>Partial<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#globalstylesextension'>GlobalStylesExtension</a>></code>
<div className="members-wrapper">
### id
<MemberInfo kind="property" type={`string`} />
An optional ID for the extension module. Only used internally for generating
import paths to your module. If not specified, a unique hash will be used as the id.
### extensionPath
<MemberInfo kind="property" type={`string`} />
The path to the directory containing the extension module(s). The entire contents of this directory
will be copied into the Admin UI app, including all TypeScript source files, html templates,
scss style sheets etc.
### ngModules
<MemberInfo kind="property" type={`Array<<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionsharedmodule'>AdminUiExtensionSharedModule</a> | <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextensionlazymodule'>AdminUiExtensionLazyModule</a>>`} />
One or more Angular modules which extend the default Admin UI.
### providers
<MemberInfo kind="property" type={`string[]`} />
Defines the paths to a file that exports an array of shared providers such as nav menu items, custom form inputs,
custom detail components, action bar items, custom history entry components.
### routes
<MemberInfo kind="property" type={`<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#uiextensionroutedefinition'>UiExtensionRouteDefinition</a>[]`} />
Defines routes that will be lazy-loaded at the `/extensions/` route. The filePath should point to a file
relative to the `extensionPath` which exports an array of Angular route definitions.
### pathAlias
<MemberInfo kind="property" type={`string`} />
An optional alias for the module so it can be referenced by other UI extension modules.
By default, Angular modules declared in an AdminUiExtension do not have access to code outside the directory
defined by the `extensionPath`. A scenario in which that can be useful though is in a monorepo codebase where
a common NgModule is shared across different plugins, each defined in its own package. An example can be found
below - note that the main `tsconfig.json` also maps the target module but using a path relative to the project's
root folder. The UI module is not part of the main TypeScript build task as explained in
[Extending the Admin UI](https://www.vendure.io/docs/plugins/extending-the-admin-ui/) but having `paths`
properly configured helps with usual IDE code editing features such as code completion and quick navigation, as
well as linting.
*Example*
```ts title="packages/common-ui-module/src/ui/ui-shared.module.ts"
import { NgModule } from '@angular/core';
import { SharedModule } from '@vendure/admin-ui/core';
import { CommonUiComponent } from './components/common-ui/common-ui.component';
export { CommonUiComponent };
@NgModule({
imports: [SharedModule],
exports: [CommonUiComponent],
declarations: [CommonUiComponent],
})
export class CommonSharedUiModule {}
```
```ts title="packages/common-ui-module/src/index.ts"
import path from 'path';
import { AdminUiExtension } from '@vendure/ui-devkit/compiler';
export const uiExtensions: AdminUiExtension = {
// highlight-next-line
pathAlias: '@common-ui-module', // this is the important part
extensionPath: path.join(__dirname, 'ui'),
ngModules: [
{
type: 'shared' as const,
ngModuleFileName: 'ui-shared.module.ts',
ngModuleName: 'CommonSharedUiModule',
},
],
};
```
```json title="tsconfig.json"
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
// highlight-next-line
"@common-ui-module/*": ["packages/common-ui-module/src/ui/*"]
}
}
}
```
```ts title="packages/sample-plugin/src/ui/ui-extension.module.ts"
import { NgModule } from '@angular/core';
import { SharedModule } from '@vendure/admin-ui/core';
// highlight-start
// the import below works both in the context of the custom Admin UI app as well as the main project
// '@common-ui-module' is the value of "pathAlias" and 'ui-shared.module' is the file we want to reference inside "extensionPath"
import { CommonSharedUiModule, CommonUiComponent } from '@common-ui-module/ui-shared.module';
// highlight-end
@NgModule({
imports: [
SharedModule,
CommonSharedUiModule,
RouterModule.forChild([
{
path: '',
pathMatch: 'full',
component: CommonUiComponent,
},
]),
],
})
export class SampleUiExtensionModule {}
```
### exclude
<MemberInfo kind="property" type={`string[]`} />
Optional array specifying filenames or [glob](https://github.com/isaacs/node-glob) patterns that should
be skipped when copying the directory defined by `extensionPath`.
*Example*
```ts
exclude: ['**/*.spec.ts']
```
</div>
## TranslationExtension
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="18" packageName="@vendure/ui-devkit" />
Defines extensions to the Admin UI translations. Can be used as a stand-alone extension definition which only adds translations
without adding new UI functionality, or as part of a full <a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#adminuiextension'>AdminUiExtension</a>.
```ts title="Signature"
interface TranslationExtension {
translations: { [languageCode in LanguageCode]?: string };
}
```
<div className="members-wrapper">
### translations
<MemberInfo kind="property" type={`{ [languageCode in <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>]?: string }`} />
Optional object defining any translation files for the Admin UI. The value should be an object with
the key as a 2-character [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes),
and the value being a [glob](https://github.com/isaacs/node-glob) for any relevant
translation files in JSON format.
*Example*
```ts
translations: {
en: path.join(__dirname, 'translations/*.en.json'),
de: path.join(__dirname, 'translations/*.de.json'),
}
```
</div>
## StaticAssetExtension
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="44" packageName="@vendure/ui-devkit" />
Defines extensions which copy static assets to the custom Admin UI application source asset directory.
```ts title="Signature"
interface StaticAssetExtension {
staticAssets: StaticAssetDefinition[];
}
```
<div className="members-wrapper">
### staticAssets
<MemberInfo kind="property" type={`<a href='/reference/admin-ui-api/ui-devkit/admin-ui-extension#staticassetdefinition'>StaticAssetDefinition</a>[]`} />
Optional array of paths to static assets which will be copied over to the Admin UI app's `/static`
directory.
</div>
## GlobalStylesExtension
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="60" packageName="@vendure/ui-devkit" />
Defines extensions which add global styles to the custom Admin UI application.
```ts title="Signature"
interface GlobalStylesExtension {
globalStyles: string[] | string;
}
```
<div className="members-wrapper">
### globalStyles
<MemberInfo kind="property" type={`string[] | string`} />
Specifies a path (or array of paths) to global style files (css or Sass) which will be
incorporated into the Admin UI app global stylesheet.
</div>
## SassVariableOverridesExtension
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="76" packageName="@vendure/ui-devkit" />
Defines an extension which allows overriding Clarity Design System's Sass variables used in styles on the Admin UI.
```ts title="Signature"
interface SassVariableOverridesExtension {
sassVariableOverrides: string;
}
```
<div className="members-wrapper">
### sassVariableOverrides
<MemberInfo kind="property" type={`string`} />
Specifies a path to a Sass style file containing variable declarations, which will take precedence over
default values defined in Clarity.
</div>
## UiExtensionRouteDefinition
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="92" packageName="@vendure/ui-devkit" />
Defines a route which will be added to the Admin UI application.
```ts title="Signature"
interface UiExtensionRouteDefinition {
route: string;
filePath: string;
prefix?: string;
}
```
<div className="members-wrapper">
### route
<MemberInfo kind="property" type={`string`} />
The name of the route. This will be used as the path in the URL.
### filePath
<MemberInfo kind="property" type={`string`} />
The path to the file which exports an array of Angular route definitions.
### prefix
<MemberInfo kind="property" type={`string`} since="2.2.0" />
All extensions will be mounted under the `/extensions/` route. This option allows you to specify a
custom prefix rather than `/extensions/`. For example, setting this to `custom` would cause the extension
to be mounted at `/custom/<route>` instead.
A common use case for this is to mount the extension at the root of the Admin UI, by setting this to an empty string.
This is useful when the extension is intended to replace the default Admin UI, rather than extend it.
</div>
## StaticAssetDefinition
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="280" packageName="@vendure/ui-devkit" />
A static asset can be provided as a path to the asset, or as an object containing a path and a new
name, which will cause the compiler to copy and then rename the asset.
```ts title="Signature"
type StaticAssetDefinition = string | { path: string; rename: string }
```
## AdminUiExtensionSharedModule
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="289" packageName="@vendure/ui-devkit" />
Configuration defining a single NgModule with which to extend the Admin UI.
```ts title="Signature"
interface AdminUiExtensionSharedModule {
type: 'shared';
ngModuleFileName: string;
ngModuleName: string;
}
```
<div className="members-wrapper">
### type
<MemberInfo kind="property" type={`'shared'`} />
Shared modules are directly imported into the main AppModule of the Admin UI
and should be used to declare custom form components and define custom
navigation items.
### ngModuleFileName
<MemberInfo kind="property" type={`string`} />
The name of the file containing the extension module class.
### ngModuleName
<MemberInfo kind="property" type={`string`} />
The name of the extension module class.
</div>
## AdminUiExtensionLazyModule
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="316" packageName="@vendure/ui-devkit" />
Configuration defining a single NgModule with which to extend the Admin UI.
```ts title="Signature"
interface AdminUiExtensionLazyModule {
type: 'lazy';
route: string;
ngModuleFileName: string;
ngModuleName: string;
}
```
<div className="members-wrapper">
### type
<MemberInfo kind="property" type={`'lazy'`} />
Lazy modules are lazy-loaded at the `/extensions/` route and should be used for
modules which define new views for the Admin UI.
### route
<MemberInfo kind="property" type={`string`} />
The route specifies the route at which the module will be lazy-loaded. E.g. a value
of `'foo'` will cause the module to lazy-load when the `/extensions/foo` route
is activated.
### ngModuleFileName
<MemberInfo kind="property" type={`string`} />
The name of the file containing the extension module class.
### ngModuleName
<MemberInfo kind="property" type={`string`} />
The name of the extension module class.
</div>
|
---
title: "CompileUiExtensions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## compileUiExtensions
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/compile.ts" sourceLine="35" packageName="@vendure/ui-devkit" />
Compiles the Admin UI app with the specified extensions.
```ts title="Signature"
function compileUiExtensions(options: UiExtensionCompilerOptions): AdminUiAppConfig | AdminUiAppDevModeConfig
```
Parameters
### options
<MemberInfo kind="parameter" type={`<a href='/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options#uiextensioncompileroptions'>UiExtensionCompilerOptions</a>`} />
|
---
title: "Helpers"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## setBranding
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/helpers.ts" sourceLine="26" packageName="@vendure/ui-devkit" />
A helper function to simplify the process of setting custom branding images.
*Example*
```ts
compileUiExtensions({
outputPath: path.join(__dirname, '../admin-ui'),
extensions: [
setBranding({
// This is used as the branding in the top-left above the navigation
smallLogoPath: path.join(__dirname, 'images/my-logo-sm.png'),
// This is used on the login page
largeLogoPath: path.join(__dirname, 'images/my-logo-lg.png'),
faviconPath: path.join(__dirname, 'images/my-favicon.ico'),
}),
],
});
```
```ts title="Signature"
function setBranding(options: BrandingOptions): StaticAssetExtension
```
Parameters
### options
<MemberInfo kind="parameter" type={`BrandingOptions`} />
|
---
title: "Ui Devkit"
isDefaultIndex: true
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
import DocCardList from '@theme/DocCardList';
<DocCardList /> |
---
title: "UiDevkitClient"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## setTargetOrigin
<GenerationInfo sourceFile="packages/ui-devkit/src/client/devkit-client-api.ts" sourceLine="24" packageName="@vendure/ui-devkit" />
Set the [window.postMessage API](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage)
`targetOrigin`. The Vendure ui-devkit uses the postMessage API to
enable cross-frame and cross-origin communication between the ui extension code and the Admin UI
app. The `targetOrigin` is a security feature intended to provide control over where messages are sent.
```ts title="Signature"
function setTargetOrigin(value: string): void
```
Parameters
### value
<MemberInfo kind="parameter" type={`string`} />
## getActivatedRoute
<GenerationInfo sourceFile="packages/ui-devkit/src/client/devkit-client-api.ts" sourceLine="43" packageName="@vendure/ui-devkit" />
Retrieves information about the current route of the host application, since it is not possible
to otherwise get this information from within the child iframe.
*Example*
```ts
import { getActivatedRoute } from '@vendure/ui-devkit';
const route = await getActivatedRoute();
const slug = route.params.slug;
```
```ts title="Signature"
function getActivatedRoute(): Promise<ActiveRouteData>
```
## graphQlQuery
<GenerationInfo sourceFile="packages/ui-devkit/src/client/devkit-client-api.ts" sourceLine="70" packageName="@vendure/ui-devkit" />
Perform a GraphQL query and returns either an Observable or a Promise of the result.
*Example*
```ts
import { graphQlQuery } from '@vendure/ui-devkit';
const productList = await graphQlQuery(`
query GetProducts($skip: Int, $take: Int) {
products(options: { skip: $skip, take: $take }) {
items { id, name, enabled },
totalItems
}
}`, {
skip: 0,
take: 10,
}).then(data => data.products);
```
```ts title="Signature"
function graphQlQuery<T, V extends { [key: string]: any }>(document: string, variables?: { [key: string]: any }, fetchPolicy?: WatchQueryFetchPolicy): {
then: Promise<T>['then'];
stream: Observable<T>;
}
```
Parameters
### document
<MemberInfo kind="parameter" type={`string`} />
### variables
<MemberInfo kind="parameter" type={`{ [key: string]: any }`} />
### fetchPolicy
<MemberInfo kind="parameter" type={`WatchQueryFetchPolicy`} />
## graphQlMutation
<GenerationInfo sourceFile="packages/ui-devkit/src/client/devkit-client-api.ts" sourceLine="112" packageName="@vendure/ui-devkit" />
Perform a GraphQL mutation and returns either an Observable or a Promise of the result.
*Example*
```ts
import { graphQlMutation } from '@vendure/ui-devkit';
const disableProduct = (id: string) => {
return graphQlMutation(`
mutation DisableProduct($id: ID!) {
updateProduct(input: { id: $id, enabled: false }) {
id
enabled
}
}`, { id })
.then(data => data.updateProduct)
}
```
```ts title="Signature"
function graphQlMutation<T, V extends { [key: string]: any }>(document: string, variables?: { [key: string]: any }): {
then: Promise<T>['then'];
stream: Observable<T>;
}
```
Parameters
### document
<MemberInfo kind="parameter" type={`string`} />
### variables
<MemberInfo kind="parameter" type={`{ [key: string]: any }`} />
## notify
<GenerationInfo sourceFile="packages/ui-devkit/src/client/devkit-client-api.ts" sourceLine="147" packageName="@vendure/ui-devkit" />
Display a toast notification.
*Example*
```ts
import { notify } from '@vendure/ui-devkit';
notify({
message: 'Updated Product',
type: 'success'
});
```
```ts title="Signature"
function notify(options: NotificationMessage['data']): void
```
Parameters
### options
<MemberInfo kind="parameter" type={`NotificationMessage['data']`} />
|
---
title: "UiExtensionCompilerOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## UiExtensionCompilerOptions
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="356" packageName="@vendure/ui-devkit" />
Options to configure how the Admin UI should be compiled.
```ts title="Signature"
interface UiExtensionCompilerOptions {
outputPath: string;
extensions: Extension[];
ngCompilerPath?: string | undefined;
devMode?: boolean;
baseHref?: string;
watchPort?: number;
command?: 'yarn' | 'npm';
additionalProcessArguments?: UiExtensionCompilerProcessArgument[];
}
```
<div className="members-wrapper">
### outputPath
<MemberInfo kind="property" type={`string`} />
The directory into which the sources for the extended Admin UI will be copied.
### extensions
<MemberInfo kind="property" type={`Extension[]`} />
An array of objects which configure Angular modules and/or
translations with which to extend the Admin UI.
### ngCompilerPath
<MemberInfo kind="property" type={`string | undefined`} since="2.1.0" />
Allows you to manually specify the path to the Angular CLI compiler script. This can be useful in scenarios
where for some reason the built-in start/build scripts are unable to locate the `ng` command.
This option should not usually be required.
*Example*
```ts
compileUiExtensions({
ngCompilerPath: path.join(__dirname, '../../node_modules/@angular/cli/bin/ng.js'),
outputPath: path.join(__dirname, '../admin-ui'),
extensions: [
// ...
],
})
```
### devMode
<MemberInfo kind="property" type={`boolean`} default="false" />
Set to `true` in order to compile the Admin UI in development mode (using the Angular CLI
[ng serve](https://angular.io/cli/serve) command). When in dev mode, any changes to
UI extension files will be watched and trigger a rebuild of the Admin UI with live
reloading.
### baseHref
<MemberInfo kind="property" type={`string`} default="'/admin/'" />
Allows the baseHref of the compiled Admin UI app to be set. This determines the prefix
of the app, for example with the default value of `'/admin/'`, the Admin UI app
will be configured to be served from `http://<host>/admin/`.
Note: if you are using this in conjunction with the <a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a> then you should
also set the `route` option to match this value.
*Example*
```ts
AdminUiPlugin.init({
route: 'my-route',
port: 5001,
app: compileUiExtensions({
baseHref: '/my-route/',
outputPath: path.join(__dirname, './custom-admin-ui'),
extensions: [],
devMode: true,
}),
}),
```
### watchPort
<MemberInfo kind="property" type={`number`} default="4200 | undefined" />
In watch mode, allows the port of the dev server to be specified. Defaults to the Angular CLI default
of `4200`.
### command
<MemberInfo kind="property" type={`'yarn' | 'npm'`} since="1.5.0" />
Internally, the Angular CLI will be invoked as an npm script. By default, the compiler will use Yarn
to run the script if it is detected, otherwise it will use npm. This setting allows you to explicitly
set which command to use, rather than relying on the default behavior.
### additionalProcessArguments
<MemberInfo kind="property" type={`<a href='/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument#uiextensioncompilerprocessargument'>UiExtensionCompilerProcessArgument</a>[]`} default="undefined" since="1.5.0" />
Additional command-line arguments which will get passed to the [ng build](https://angular.io/cli/build)
command (or [ng serve](https://angular.io/cli/serve) if `devMode = true`).
*Example*
['--disable-host-check'] // to disable host check
</div>
|
---
title: "UiExtensionCompilerProcessArgument"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## UiExtensionCompilerProcessArgument
<GenerationInfo sourceFile="packages/ui-devkit/src/compiler/types.ts" sourceLine="348" packageName="@vendure/ui-devkit" />
Argument to configure process (watch or compile)
```ts title="Signature"
type UiExtensionCompilerProcessArgument = string | [string, any]
```
|
---
title: "Core Plugins"
isDefaultIndex: true
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
import DocCardList from '@theme/DocCardList';
<DocCardList /> |
---
title: "AdminUiPluginOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AdminUiPluginOptions
<GenerationInfo sourceFile="packages/admin-ui-plugin/src/plugin.ts" sourceLine="43" packageName="@vendure/admin-ui-plugin" />
Configuration options for the <a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>.
```ts title="Signature"
interface AdminUiPluginOptions {
route: string;
port: number;
hostname?: string;
app?: AdminUiAppConfig | AdminUiAppDevModeConfig;
adminUiConfig?: Partial<AdminUiConfig>;
}
```
<div className="members-wrapper">
### route
<MemberInfo kind="property" type={`string`} />
The route to the Admin UI.
Note: If you are using the {@link compileUiExtensions} function to compile a custom version of the Admin UI, then
the route should match the `baseHref` option passed to that function. The default value of `baseHref` is `/admin/`,
so it only needs to be changed if you set this `route` option to something other than `"admin"`.
### port
<MemberInfo kind="property" type={`number`} />
The port on which the server will listen. This port will be proxied by the AdminUiPlugin to the same port that
the Vendure server is running on.
### hostname
<MemberInfo kind="property" type={`string`} default="'localhost'" />
The hostname of the server serving the static admin ui files.
### app
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/admin-ui/admin-ui-app-config#adminuiappconfig'>AdminUiAppConfig</a> | <a href='/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config#adminuiappdevmodeconfig'>AdminUiAppDevModeConfig</a>`} />
By default, the AdminUiPlugin comes bundles with a pre-built version of the
Admin UI. This option can be used to override this default build with a different
version, e.g. one pre-compiled with one or more ui extensions.
### adminUiConfig
<MemberInfo kind="property" type={`Partial<<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>>`} />
Allows the contents of the `vendure-ui-config.json` file to be set, e.g.
for specifying the Vendure GraphQL API host, available UI languages, etc.
</div>
|
---
title: "AdminUiPlugin"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AdminUiPlugin
<GenerationInfo sourceFile="packages/admin-ui-plugin/src/plugin.ts" sourceLine="129" packageName="@vendure/admin-ui-plugin" />
This plugin starts a static server for the Admin UI app, and proxies it via the `/admin/` path of the main Vendure server.
The Admin UI allows you to administer all aspects of your store, from inventory management to order tracking. It is the tool used by
store administrators on a day-to-day basis for the management of the store.
## Installation
`yarn add @vendure/admin-ui-plugin`
or
`npm install @vendure/admin-ui-plugin`
*Example*
```ts
import { AdminUiPlugin } from '@vendure/admin-ui-plugin';
const config: VendureConfig = {
// Add an instance of the plugin to the plugins array
plugins: [
AdminUiPlugin.init({ port: 3002 }),
],
};
```
## Metrics
This plugin also defines a `metricSummary` query which is used by the Admin UI to display the order metrics on the dashboard.
If you are building a stand-alone version of the Admin UI app, and therefore don't need this plugin to server the Admin UI,
you can still use the `metricSummary` query by adding the `AdminUiPlugin` to the `plugins` array, but without calling the `init()` method:
*Example*
```ts
import { AdminUiPlugin } from '@vendure/admin-ui-plugin';
const config: VendureConfig = {
plugins: [
AdminUiPlugin, // <-- no call to .init()
],
// ...
};
```
```ts title="Signature"
class AdminUiPlugin implements NestModule {
constructor(configService: ConfigService, processContext: ProcessContext)
init(options: AdminUiPluginOptions) => Type<AdminUiPlugin>;
configure(consumer: MiddlewareConsumer) => ;
}
```
* Implements: <code>NestModule</code>
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(configService: ConfigService, processContext: <a href='/reference/typescript-api/common/process-context#processcontext'>ProcessContext</a>) => AdminUiPlugin`} />
### init
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options#adminuipluginoptions'>AdminUiPluginOptions</a>) => Type<<a href='/reference/core-plugins/admin-ui-plugin/#adminuiplugin'>AdminUiPlugin</a>>`} />
Set the plugin options
### configure
<MemberInfo kind="method" type={`(consumer: MiddlewareConsumer) => `} />
</div>
|
---
title: "AssetServerOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AssetServerOptions
<GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="72" packageName="@vendure/asset-server-plugin" />
The configuration options for the AssetServerPlugin.
```ts title="Signature"
interface AssetServerOptions {
route: string;
assetUploadDir: string;
assetUrlPrefix?: string | ((ctx: RequestContext, identifier: string) => string);
previewMaxWidth?: number;
previewMaxHeight?: number;
presets?: ImageTransformPreset[];
namingStrategy?: AssetNamingStrategy;
previewStrategy?: AssetPreviewStrategy;
storageStrategyFactory?: (
options: AssetServerOptions,
) => AssetStorageStrategy | Promise<AssetStorageStrategy>;
cacheHeader?: CacheConfig | string;
}
```
<div className="members-wrapper">
### route
<MemberInfo kind="property" type={`string`} />
The route to the asset server.
### assetUploadDir
<MemberInfo kind="property" type={`string`} />
The local directory to which assets will be uploaded when using the <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>.
### assetUrlPrefix
<MemberInfo kind="property" type={`string | ((ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, identifier: string) => string)`} />
The complete URL prefix of the asset files. For example, "https://demo.vendure.io/assets/". A
function can also be provided to handle more complex cases, such as serving multiple domains
from a single server. In this case, the function should return a string url prefix.
If not provided, the plugin will attempt to guess based off the incoming
request and the configured route. However, in all but the simplest cases,
this guess may not yield correct results.
### previewMaxWidth
<MemberInfo kind="property" type={`number`} default="1600" />
The max width in pixels of a generated preview image.
### previewMaxHeight
<MemberInfo kind="property" type={`number`} default="1600" />
The max height in pixels of a generated preview image.
### presets
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/image-transform-preset#imagetransformpreset'>ImageTransformPreset</a>[]`} />
An array of additional <a href='/reference/core-plugins/asset-server-plugin/image-transform-preset#imagetransformpreset'>ImageTransformPreset</a> objects.
### namingStrategy
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-naming-strategy#assetnamingstrategy'>AssetNamingStrategy</a>`} default="<a href='/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy#hashedassetnamingstrategy'>HashedAssetNamingStrategy</a>" />
Defines how asset files and preview images are named before being saved.
### previewStrategy
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy'>AssetPreviewStrategy</a>`} since="1.7.0" />
Defines how previews are generated for a given Asset binary. By default, this uses
the <a href='/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy#sharpassetpreviewstrategy'>SharpAssetPreviewStrategy</a>
### storageStrategyFactory
<MemberInfo kind="property" type={`(
options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>,
) => <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a> | Promise<<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>>`} default="() => <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a>" />
A function which can be used to configure an <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>. This is useful e.g. if you wish to store your assets
using a cloud storage provider. By default, the <a href='/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy#localassetstoragestrategy'>LocalAssetStorageStrategy</a> is used.
### cacheHeader
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/cache-config#cacheconfig'>CacheConfig</a> | string`} default="'public, max-age=15552000'" since="1.9.3" />
Configures the `Cache-Control` directive for response to control caching in browsers and shared caches (e.g. Proxies, CDNs).
Defaults to publicly cached for 6 months.
</div>
|
---
title: "CacheConfig"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## CacheConfig
<GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="52" packageName="@vendure/asset-server-plugin" />
A configuration option for the Cache-Control header in the AssetServerPlugin asset response.
```ts title="Signature"
type CacheConfig = {
maxAge: number;
restriction?: 'public' | 'private';
}
```
<div className="members-wrapper">
### maxAge
<MemberInfo kind="property" type={`number`} />
The max-age=N response directive indicates that the response remains fresh until N seconds after the response is generated.
### restriction
<MemberInfo kind="property" type={`'public' | 'private'`} />
The `private` response directive indicates that the response can be stored only in a private cache (e.g. local caches in browsers).
The `public` response directive indicates that the response can be stored in a shared cache.
</div>
|
---
title: "HashedAssetNamingStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## HashedAssetNamingStrategy
<GenerationInfo sourceFile="packages/asset-server-plugin/src/hashed-asset-naming-strategy.ts" sourceLine="20" packageName="@vendure/asset-server-plugin" />
An extension of the <a href='/reference/typescript-api/assets/default-asset-naming-strategy#defaultassetnamingstrategy'>DefaultAssetNamingStrategy</a> which prefixes file names with
the type (`'source'` or `'preview'`) as well as a 2-character sub-directory based on
the md5 hash of the original file name.
This is an implementation of the technique knows as "hashed directory" file storage,
and the purpose is to reduce the number of files in a single directory, since a very large
number of files can lead to performance issues when reading and writing to that directory.
With this strategy, even with 200,000 total assets stored, each directory would
only contain less than 800 files.
```ts title="Signature"
class HashedAssetNamingStrategy extends DefaultAssetNamingStrategy {
generateSourceFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string) => string;
generatePreviewFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string) => string;
}
```
* Extends: <code><a href='/reference/typescript-api/assets/default-asset-naming-strategy#defaultassetnamingstrategy'>DefaultAssetNamingStrategy</a></code>
<div className="members-wrapper">
### generateSourceFileName
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, originalFileName: string, conflictFileName?: string) => string`} />
### generatePreviewFileName
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, originalFileName: string, conflictFileName?: string) => string`} />
</div>
|
---
title: "ImageTransformMode"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## ImageTransformMode
<GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="21" packageName="@vendure/asset-server-plugin" />
Specifies the way in which an asset preview image will be resized to fit in the
proscribed dimensions:
* crop: crops the image to cover both provided dimensions
* resize: Preserving aspect ratio, resizes the image to be as large as possible
while ensuring its dimensions are less than or equal to both those specified.
```ts title="Signature"
type ImageTransformMode = 'crop' | 'resize'
```
|
---
title: "ImageTransformPreset"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## ImageTransformPreset
<GenerationInfo sourceFile="packages/asset-server-plugin/src/types.ts" sourceLine="39" packageName="@vendure/asset-server-plugin" />
A configuration option for an image size preset for the AssetServerPlugin.
Presets allow a shorthand way to generate a thumbnail preview of an asset. For example,
the built-in "tiny" preset generates a 50px x 50px cropped preview, which can be accessed
by appending the string `preset=tiny` to the asset url:
`http://localhost:3000/assets/some-asset.jpg?preset=tiny`
is equivalent to:
`http://localhost:3000/assets/some-asset.jpg?w=50&h=50&mode=crop`
```ts title="Signature"
interface ImageTransformPreset {
name: string;
width: number;
height: number;
mode: ImageTransformMode;
}
```
<div className="members-wrapper">
### name
<MemberInfo kind="property" type={`string`} />
### width
<MemberInfo kind="property" type={`number`} />
### height
<MemberInfo kind="property" type={`number`} />
### mode
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/asset-server-plugin/image-transform-mode#imagetransformmode'>ImageTransformMode</a>`} />
</div>
|
---
title: "AssetServerPlugin"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AssetServerPlugin
<GenerationInfo sourceFile="packages/asset-server-plugin/src/plugin.ts" sourceLine="153" packageName="@vendure/asset-server-plugin" />
The `AssetServerPlugin` serves assets (images and other files) from the local file system, and can also be configured to use
other storage strategies (e.g. <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3assetstoragestrategy'>S3AssetStorageStrategy</a>. It can also perform on-the-fly image transformations
and caches the results for subsequent calls.
## Installation
`yarn add @vendure/asset-server-plugin`
or
`npm install @vendure/asset-server-plugin`
*Example*
```ts
import { AssetServerPlugin } from '@vendure/asset-server-plugin';
const config: VendureConfig = {
// Add an instance of the plugin to the plugins array
plugins: [
AssetServerPlugin.init({
route: 'assets',
assetUploadDir: path.join(__dirname, 'assets'),
}),
],
};
```
The full configuration is documented at [AssetServerOptions](/reference/core-plugins/asset-server-plugin/asset-server-options)
## Image transformation
Asset preview images can be transformed (resized & cropped) on the fly by appending query parameters to the url:
`http://localhost:3000/assets/some-asset.jpg?w=500&h=300&mode=resize`
The above URL will return `some-asset.jpg`, resized to fit in the bounds of a 500px x 300px rectangle.
### Preview mode
The `mode` parameter can be either `crop` or `resize`. See the [ImageTransformMode](/reference/core-plugins/asset-server-plugin/image-transform-mode) docs for details.
### Focal point
When cropping an image (`mode=crop`), Vendure will attempt to keep the most "interesting" area of the image in the cropped frame. It does this
by finding the area of the image with highest entropy (the busiest area of the image). However, sometimes this does not yield a satisfactory
result - part or all of the main subject may still be cropped out.
This is where specifying the focal point can help. The focal point of the image may be specified by passing the `fpx` and `fpy` query parameters.
These are normalized coordinates (i.e. a number between 0 and 1), so the `fpx=0&fpy=0` corresponds to the top left of the image.
For example, let's say there is a very wide landscape image which we want to crop to be square. The main subject is a house to the far left of the
image. The following query would crop it to a square with the house centered:
`http://localhost:3000/assets/landscape.jpg?w=150&h=150&mode=crop&fpx=0.2&fpy=0.7`
### Format
Since v1.7.0, the image format can be specified by adding the `format` query parameter:
`http://localhost:3000/assets/some-asset.jpg?format=webp`
This means that, no matter the format of your original asset files, you can use more modern formats in your storefront if the browser
supports them. Supported values for `format` are:
* `jpeg` or `jpg`
* `png`
* `webp`
* `avif`
The `format` parameter can also be combined with presets (see below).
### Quality
Since v2.2.0, the image quality can be specified by adding the `q` query parameter:
`http://localhost:3000/assets/some-asset.jpg?q=75`
This applies to the `jpg`, `webp` and `avif` formats. The default quality value for `jpg` and `webp` is 80, and for `avif` is 50.
The `q` parameter can also be combined with presets (see below).
### Transform presets
Presets can be defined which allow a single preset name to be used instead of specifying the width, height and mode. Presets are
configured via the AssetServerOptions [presets property](/reference/core-plugins/asset-server-plugin/asset-server-options/#presets).
For example, defining the following preset:
```ts
AssetServerPlugin.init({
// ...
presets: [
{ name: 'my-preset', width: 85, height: 85, mode: 'crop' },
],
}),
```
means that a request to:
`http://localhost:3000/assets/some-asset.jpg?preset=my-preset`
is equivalent to:
`http://localhost:3000/assets/some-asset.jpg?w=85&h=85&mode=crop`
The AssetServerPlugin comes pre-configured with the following presets:
name | width | height | mode
-----|-------|--------|-----
tiny | 50px | 50px | crop
thumb | 150px | 150px | crop
small | 300px | 300px | resize
medium | 500px | 500px | resize
large | 800px | 800px | resize
### Caching
By default, the AssetServerPlugin will cache every transformed image, so that the transformation only needs to be performed a single time for
a given configuration. Caching can be disabled per-request by setting the `?cache=false` query parameter.
```ts title="Signature"
class AssetServerPlugin implements NestModule, OnApplicationBootstrap {
init(options: AssetServerOptions) => Type<AssetServerPlugin>;
constructor(processContext: ProcessContext)
configure(consumer: MiddlewareConsumer) => ;
}
```
* Implements: <code>NestModule</code>, <code>OnApplicationBootstrap</code>
<div className="members-wrapper">
### init
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>) => Type<<a href='/reference/core-plugins/asset-server-plugin/#assetserverplugin'>AssetServerPlugin</a>>`} />
Set the plugin options.
### constructor
<MemberInfo kind="method" type={`(processContext: <a href='/reference/typescript-api/common/process-context#processcontext'>ProcessContext</a>) => AssetServerPlugin`} />
### configure
<MemberInfo kind="method" type={`(consumer: MiddlewareConsumer) => `} />
</div>
|
---
title: "LocalAssetStorageStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## LocalAssetStorageStrategy
<GenerationInfo sourceFile="packages/asset-server-plugin/src/local-asset-storage-strategy.ts" sourceLine="15" packageName="@vendure/asset-server-plugin" />
A persistence strategy which saves files to the local file system.
```ts title="Signature"
class LocalAssetStorageStrategy implements AssetStorageStrategy {
toAbsoluteUrl: ((reqest: Request, identifier: string) => string) | undefined;
constructor(uploadPath: string, toAbsoluteUrlFn?: (reqest: Request, identifier: string) => string)
writeFileFromStream(fileName: string, data: ReadStream) => Promise<string>;
writeFileFromBuffer(fileName: string, data: Buffer) => Promise<string>;
fileExists(fileName: string) => Promise<boolean>;
readFileToBuffer(identifier: string) => Promise<Buffer>;
readFileToStream(identifier: string) => Promise<Stream>;
deleteFile(identifier: string) => Promise<void>;
}
```
* Implements: <code><a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a></code>
<div className="members-wrapper">
### toAbsoluteUrl
<MemberInfo kind="property" type={`((reqest: Request, identifier: string) => string) | undefined`} />
### constructor
<MemberInfo kind="method" type={`(uploadPath: string, toAbsoluteUrlFn?: (reqest: Request, identifier: string) => string) => LocalAssetStorageStrategy`} />
### writeFileFromStream
<MemberInfo kind="method" type={`(fileName: string, data: ReadStream) => Promise<string>`} />
### writeFileFromBuffer
<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise<string>`} />
### fileExists
<MemberInfo kind="method" type={`(fileName: string) => Promise<boolean>`} />
### readFileToBuffer
<MemberInfo kind="method" type={`(identifier: string) => Promise<Buffer>`} />
### readFileToStream
<MemberInfo kind="method" type={`(identifier: string) => Promise<Stream>`} />
### deleteFile
<MemberInfo kind="method" type={`(identifier: string) => Promise<void>`} />
</div>
|
---
title: "S3AssetStorageStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## S3AssetStorageStrategy
<GenerationInfo sourceFile="packages/asset-server-plugin/src/s3-asset-storage-strategy.ts" sourceLine="155" packageName="@vendure/asset-server-plugin" />
An <a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a> which uses [Amazon S3](https://aws.amazon.com/s3/) object storage service.
To us this strategy you must first have access to an AWS account.
See their [getting started guide](https://aws.amazon.com/s3/getting-started/) for how to get set up.
Before using this strategy, make sure you have the `@aws-sdk/client-s3` and `@aws-sdk/lib-storage` package installed:
```sh
npm install @aws-sdk/client-s3 @aws-sdk/lib-storage
```
**Note:** Rather than instantiating this manually, use the <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#configures3assetstorage'>configureS3AssetStorage</a> function.
## Use with S3-compatible services (MinIO)
This strategy will also work with any S3-compatible object storage solutions, such as [MinIO](https://min.io/).
See the <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#configures3assetstorage'>configureS3AssetStorage</a> for an example with MinIO.
```ts title="Signature"
class S3AssetStorageStrategy implements AssetStorageStrategy {
constructor(s3Config: S3Config, toAbsoluteUrl: (request: Request, identifier: string) => string)
init() => ;
destroy?: (() => void | Promise<void>) | undefined;
writeFileFromBuffer(fileName: string, data: Buffer) => ;
writeFileFromStream(fileName: string, data: Readable) => ;
readFileToBuffer(identifier: string) => ;
readFileToStream(identifier: string) => ;
deleteFile(identifier: string) => ;
fileExists(fileName: string) => ;
}
```
* Implements: <code><a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a></code>
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(s3Config: <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>, toAbsoluteUrl: (request: Request, identifier: string) => string) => S3AssetStorageStrategy`} />
### init
<MemberInfo kind="method" type={`() => `} />
### destroy
<MemberInfo kind="property" type={`(() => void | Promise<void>) | undefined`} />
### writeFileFromBuffer
<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => `} />
### writeFileFromStream
<MemberInfo kind="method" type={`(fileName: string, data: Readable) => `} />
### readFileToBuffer
<MemberInfo kind="method" type={`(identifier: string) => `} />
### readFileToStream
<MemberInfo kind="method" type={`(identifier: string) => `} />
### deleteFile
<MemberInfo kind="method" type={`(identifier: string) => `} />
### fileExists
<MemberInfo kind="method" type={`(fileName: string) => `} />
</div>
## S3Config
<GenerationInfo sourceFile="packages/asset-server-plugin/src/s3-asset-storage-strategy.ts" sourceLine="19" packageName="@vendure/asset-server-plugin" />
Configuration for connecting to AWS S3.
```ts title="Signature"
interface S3Config {
credentials: AwsCredentialIdentity | AwsCredentialIdentityProvider;
bucket: string;
nativeS3Configuration?: any;
nativeS3UploadConfiguration?: any;
}
```
<div className="members-wrapper">
### credentials
<MemberInfo kind="property" type={`AwsCredentialIdentity | AwsCredentialIdentityProvider`} />
The credentials used to access your s3 account. You can supply either the access key ID & secret, or you can make use of a
[shared credentials file](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/loading-node-credentials-shared.html)
To use a shared credentials file, import the `fromIni()` function from the "@aws-sdk/credential-provider-ini" or "@aws-sdk/credential-providers" package and supply
the profile name (e.g. `{ profile: 'default' }`) as its argument.
### bucket
<MemberInfo kind="property" type={`string`} />
The S3 bucket in which to store the assets. If it does not exist, it will be created on startup.
### nativeS3Configuration
<MemberInfo kind="property" type={`any`} />
Configuration object passed directly to the AWS SDK.
S3.Types.ClientConfiguration can be used after importing aws-sdk.
Using type `any` in order to avoid the need to include `aws-sdk` dependency in general.
### nativeS3UploadConfiguration
<MemberInfo kind="property" type={`any`} />
Configuration object passed directly to the AWS SDK.
ManagedUpload.ManagedUploadOptions can be used after importing aws-sdk.
Using type `any` in order to avoid the need to include `aws-sdk` dependency in general.
</div>
## configureS3AssetStorage
<GenerationInfo sourceFile="packages/asset-server-plugin/src/s3-asset-storage-strategy.ts" sourceLine="119" packageName="@vendure/asset-server-plugin" />
Returns a configured instance of the <a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3assetstoragestrategy'>S3AssetStorageStrategy</a> which can then be passed to the <a href='/reference/core-plugins/asset-server-plugin/asset-server-options#assetserveroptions'>AssetServerOptions</a>
`storageStrategyFactory` property.
Before using this strategy, make sure you have the `@aws-sdk/client-s3` and `@aws-sdk/lib-storage` package installed:
```sh
npm install @aws-sdk/client-s3 @aws-sdk/lib-storage
```
*Example*
```ts
import { AssetServerPlugin, configureS3AssetStorage } from '@vendure/asset-server-plugin';
import { DefaultAssetNamingStrategy } from '@vendure/core';
import { fromEnv } from '@aws-sdk/credential-providers';
// ...
plugins: [
AssetServerPlugin.init({
route: 'assets',
assetUploadDir: path.join(__dirname, 'assets'),
namingStrategy: new DefaultAssetNamingStrategy(),
storageStrategyFactory: configureS3AssetStorage({
bucket: 'my-s3-bucket',
credentials: fromEnv(), // or any other credential provider
nativeS3Configuration: {
region: process.env.AWS_REGION,
},
}),
}),
```
## Usage with MinIO
Reference: [How to use AWS SDK for Javascript with MinIO Server](https://docs.min.io/docs/how-to-use-aws-sdk-for-javascript-with-minio-server.html)
*Example*
```ts
import { AssetServerPlugin, configureS3AssetStorage } from '@vendure/asset-server-plugin';
import { DefaultAssetNamingStrategy } from '@vendure/core';
// ...
plugins: [
AssetServerPlugin.init({
route: 'assets',
assetUploadDir: path.join(__dirname, 'assets'),
namingStrategy: new DefaultAssetNamingStrategy(),
storageStrategyFactory: configureS3AssetStorage({
bucket: 'my-minio-bucket',
credentials: {
accessKeyId: process.env.MINIO_ACCESS_KEY_ID,
secretAccessKey: process.env.MINIO_SECRET_ACCESS_KEY,
},
nativeS3Configuration: {
endpoint: process.env.MINIO_ENDPOINT ?? 'http://localhost:9000',
forcePathStyle: true,
signatureVersion: 'v4',
// The `region` is required by the AWS SDK even when using MinIO,
// so we just use a dummy value here.
region: 'eu-west-1',
},
}),
}),
```
```ts title="Signature"
function configureS3AssetStorage(s3Config: S3Config): void
```
Parameters
### s3Config
<MemberInfo kind="parameter" type={`<a href='/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy#s3config'>S3Config</a>`} />
|
---
title: "SharpAssetPreviewStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## SharpAssetPreviewStrategy
<GenerationInfo sourceFile="packages/asset-server-plugin/src/sharp-asset-preview-strategy.ts" sourceLine="95" packageName="@vendure/asset-server-plugin" />
This <a href='/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy'>AssetPreviewStrategy</a> uses the [Sharp library](https://sharp.pixelplumbing.com/) to generate
preview images of uploaded binary files. For non-image binaries, a generic "file" icon with the mime type
overlay will be generated.
By default, this strategy will produce previews up to maximum dimensions of 1600 x 1600 pixels. The created
preview images will match the input format - so a source file in jpeg format will output a jpeg preview,
a webp source file will output a webp preview, and so on.
The settings for the outputs will default to Sharp's defaults (https://sharp.pixelplumbing.com/api-output).
However, it is possible to pass your own configurations to control the output of each format:
```ts
AssetServerPlugin.init({
previewStrategy: new SharpAssetPreviewStrategy({
jpegOptions: { quality: 95 },
webpOptions: { quality: 95 },
}),
}),
```
```ts title="Signature"
class SharpAssetPreviewStrategy implements AssetPreviewStrategy {
constructor(config?: SharpAssetPreviewConfig)
generatePreviewImage(ctx: RequestContext, mimeType: string, data: Buffer) => Promise<Buffer>;
}
```
* Implements: <code><a href='/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy'>AssetPreviewStrategy</a></code>
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(config?: <a href='/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy#sharpassetpreviewconfig'>SharpAssetPreviewConfig</a>) => SharpAssetPreviewStrategy`} />
### generatePreviewImage
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise<Buffer>`} />
</div>
## SharpAssetPreviewConfig
<GenerationInfo sourceFile="packages/asset-server-plugin/src/sharp-asset-preview-strategy.ts" sourceLine="17" packageName="@vendure/asset-server-plugin" />
This <a href='/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy'>AssetPreviewStrategy</a> uses the [Sharp library](https://sharp.pixelplumbing.com/) to generate
preview images of uploaded binary files. For non-image binaries, a generic "file" icon with the mime type
overlay will be generated.
```ts title="Signature"
interface SharpAssetPreviewConfig {
maxHeight?: number;
maxWidth?: number;
jpegOptions?: sharp.JpegOptions;
pngOptions?: sharp.PngOptions;
webpOptions?: sharp.WebpOptions;
gifOptions?: sharp.GifOptions;
avifOptions?: sharp.AvifOptions;
}
```
<div className="members-wrapper">
### maxHeight
<MemberInfo kind="property" type={`number`} default="1600" />
The max height in pixels of a generated preview image.
### maxWidth
<MemberInfo kind="property" type={`number`} default="1600" />
The max width in pixels of a generated preview image.
### jpegOptions
<MemberInfo kind="property" type={`sharp.JpegOptions`} since="1.7.0" />
Set Sharp's options for encoding jpeg files: https://sharp.pixelplumbing.com/api-output#jpeg
### pngOptions
<MemberInfo kind="property" type={`sharp.PngOptions`} since="1.7.0" />
Set Sharp's options for encoding png files: https://sharp.pixelplumbing.com/api-output#png
### webpOptions
<MemberInfo kind="property" type={`sharp.WebpOptions`} since="1.7.0" />
Set Sharp's options for encoding webp files: https://sharp.pixelplumbing.com/api-output#webp
### gifOptions
<MemberInfo kind="property" type={`sharp.GifOptions`} since="1.7.0" />
Set Sharp's options for encoding gif files: https://sharp.pixelplumbing.com/api-output#gif
### avifOptions
<MemberInfo kind="property" type={`sharp.AvifOptions`} since="1.7.0" />
Set Sharp's options for encoding avif files: https://sharp.pixelplumbing.com/api-output#avif
</div>
|
---
title: "ElasticsearchOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## ElasticsearchOptions
<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/options.ts" sourceLine="30" packageName="@vendure/elasticsearch-plugin" />
Configuration options for the <a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>.
```ts title="Signature"
interface ElasticsearchOptions {
host?: string;
port?: number;
connectionAttempts?: number;
connectionAttemptInterval?: number;
clientOptions?: ClientOptions;
indexPrefix?: string;
indexSettings?: object;
indexMappingProperties?: {
[indexName: string]: object;
};
reindexProductsChunkSize?: number;
reindexBulkOperationSizeLimit?: number;
searchConfig?: SearchConfig;
customProductMappings?: {
[fieldName: string]: CustomMapping<[Product, ProductVariant[], LanguageCode, Injector, RequestContext]>;
};
customProductVariantMappings?: {
[fieldName: string]: CustomMapping<[ProductVariant, LanguageCode, Injector, RequestContext]>;
};
bufferUpdates?: boolean;
hydrateProductRelations?: Array<EntityRelationPaths<Product>>;
hydrateProductVariantRelations?: Array<EntityRelationPaths<ProductVariant>>;
extendSearchInputType?: {
[name: string]: PrimitiveTypeVariations<GraphQlPrimitive>;
};
extendSearchSortType?: string[];
}
```
<div className="members-wrapper">
### host
<MemberInfo kind="property" type={`string`} default="'http://localhost'" />
The host of the Elasticsearch server. May also be specified in `clientOptions.node`.
### port
<MemberInfo kind="property" type={`number`} default="9200" />
The port of the Elasticsearch server. May also be specified in `clientOptions.node`.
### connectionAttempts
<MemberInfo kind="property" type={`number`} default="10" />
Maximum amount of attempts made to connect to the ElasticSearch server on startup.
### connectionAttemptInterval
<MemberInfo kind="property" type={`number`} default="5000" />
Interval in milliseconds between attempts to connect to the ElasticSearch server on startup.
### clientOptions
<MemberInfo kind="property" type={`ClientOptions`} />
Options to pass directly to the
[Elasticsearch Node.js client](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html). For example, to
set authentication or other more advanced options.
Note that if the `node` or `nodes` option is specified, it will override the values provided in the `host` and `port` options.
### indexPrefix
<MemberInfo kind="property" type={`string`} default="'vendure-'" />
Prefix for the indices created by the plugin.
### indexSettings
<MemberInfo kind="property" type={`object`} default="{}" since="1.2.0" />
[These options](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/index-modules.html#index-modules-settings)
are directly passed to index settings. To apply some settings indices will be recreated.
*Example*
```ts
// Configuring an English stemmer
indexSettings: {
analysis: {
analyzer: {
custom_analyzer: {
tokenizer: 'standard',
filter: [
'lowercase',
'english_stemmer'
]
}
},
filter : {
english_stemmer : {
type : 'stemmer',
name : 'english'
}
}
}
},
```
A more complete example can be found in the discussion thread
[How to make elastic plugin to search by substring with stemming](https://github.com/vendure-ecommerce/vendure/discussions/1066).
### indexMappingProperties
<MemberInfo kind="property" type={`{
[indexName: string]: object;
}`} default="{}" since="1.2.0" />
This option allow to redefine or define new properties in mapping. More about elastic
[mapping](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html)
After changing this option indices will be recreated.
*Example*
```ts
// Configuring custom analyzer for the `productName` field.
indexMappingProperties: {
productName: {
type: 'text',
analyzer:'custom_analyzer',
fields: {
keyword: {
type: 'keyword',
ignore_above: 256,
}
}
}
}
```
To reference a field defined by `customProductMappings` or `customProductVariantMappings`, you will
need to prefix the name with `'product-<name>'` or `'variant-<name>'` respectively, e.g.:
*Example*
```ts
customProductMappings: {
variantCount: {
graphQlType: 'Int!',
valueFn: (product, variants) => variants.length,
},
},
indexMappingProperties: {
'product-variantCount': {
type: 'integer',
}
}
```
### reindexProductsChunkSize
<MemberInfo kind="property" type={`number`} default="2500" since="2.1.7" />
Products limit chunk size for each loop iteration when indexing products.
### reindexBulkOperationSizeLimit
<MemberInfo kind="property" type={`number`} default="3000" since="2.1.7" />
Index operations are performed in bulk, with each bulk operation containing a number of individual
index operations. This option sets the maximum number of operations in the memory buffer before a
bulk operation is executed.
### searchConfig
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#searchconfig'>SearchConfig</a>`} />
Configuration of the internal Elasticsearch query.
### customProductMappings
<MemberInfo kind="property" type={`{
[fieldName: string]: CustomMapping<[<a href='/reference/typescript-api/entities/product#product'>Product</a>, <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>[], <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>]>;
}`} />
Custom mappings may be defined which will add the defined data to the
Elasticsearch index and expose that data via the SearchResult GraphQL type,
adding a new `customMappings`, `customProductMappings` & `customProductVariantMappings` fields.
The `graphQlType` property may be one of `String`, `Int`, `Float`, `Boolean`, `ID` or list
versions thereof (`[String!]` etc) and can be appended with a `!` to indicate non-nullable fields.
The `public` (default = `true`) property is used to reveal or hide the property in the GraphQL API schema.
If this property is set to `false` it's not accessible in the `customMappings` field but it's still getting
parsed to the elasticsearch index.
This config option defines custom mappings which are accessible when the "groupByProduct"
input options is set to `true`. In addition, custom variant mappings can be accessed by using
the `customProductVariantMappings` field, which is always available.
*Example*
```ts
customProductMappings: {
variantCount: {
graphQlType: 'Int!',
valueFn: (product, variants) => variants.length,
},
reviewRating: {
graphQlType: 'Float',
public: true,
valueFn: product => (product.customFields as any).reviewRating,
},
priority: {
graphQlType: 'Int!',
public: false,
valueFn: product => (product.customFields as any).priority,
},
}
```
*Example*
```graphql
query SearchProducts($input: SearchInput!) {
search(input: $input) {
totalItems
items {
productId
productName
customProductMappings {
variantCount
reviewRating
}
customMappings {
...on CustomProductMappings {
variantCount
reviewRating
}
}
}
}
}
```
### customProductVariantMappings
<MemberInfo kind="property" type={`{
[fieldName: string]: CustomMapping<[<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>, <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>, <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>]>;
}`} />
This config option defines custom mappings which are accessible when the "groupByProduct"
input options is set to `false`. In addition, custom product mappings can be accessed by using
the `customProductMappings` field, which is always available.
*Example*
```graphql
query SearchProducts($input: SearchInput!) {
search(input: $input) {
totalItems
items {
productId
productName
customProductVariantMappings {
weight
}
customMappings {
...on CustomProductVariantMappings {
weight
}
}
}
}
}
```
### bufferUpdates
<MemberInfo kind="property" type={`boolean`} default="false" since="1.3.0" />
If set to `true`, updates to Products, ProductVariants and Collections will not immediately
trigger an update to the search index. Instead, all these changes will be buffered and will
only be run via a call to the `runPendingSearchIndexUpdates` mutation in the Admin API.
This is very useful for installations with a large number of ProductVariants and/or
Collections, as the buffering allows better control over when these expensive jobs are run,
and also performs optimizations to minimize the amount of work that needs to be performed by
the worker.
### hydrateProductRelations
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a><<a href='/reference/typescript-api/entities/product#product'>Product</a>>>`} default="[]" since="1.3.0" />
Additional product relations that will be fetched from DB while reindexing. This can be used
in combination with `customProductMappings` to ensure that the required relations are joined
before the `product` object is passed to the `valueFn`.
*Example*
```ts
{
hydrateProductRelations: ['assets.asset'],
customProductMappings: {
assetPreviews: {
graphQlType: '[String!]',
// Here we can be sure that the `product.assets` array is populated
// with an Asset object
valueFn: (product) => product.assets.map(a => a.asset.preview),
}
}
}
```
### hydrateProductVariantRelations
<MemberInfo kind="property" type={`Array<<a href='/reference/typescript-api/common/entity-relation-paths#entityrelationpaths'>EntityRelationPaths</a><<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>>`} default="[]" since="1.3.0" />
Additional variant relations that will be fetched from DB while reindexing. See
`hydrateProductRelations` for more explanation and a usage example.
### extendSearchInputType
<MemberInfo kind="property" type={`{
[name: string]: PrimitiveTypeVariations<GraphQlPrimitive>;
}`} default="{}" since="1.3.0" />
Allows the `SearchInput` type to be extended with new input fields. This allows arbitrary
data to be passed in, which can then be used e.g. in the `mapQuery()` function or
custom `scriptFields` functions.
*Example*
```ts
extendSearchInputType: {
longitude: 'Float',
latitude: 'Float',
radius: 'Float',
}
```
This allows the search query to include these new fields:
*Example*
```graphql
query {
search(input: {
longitude: 101.7117,
latitude: 3.1584,
radius: 50.00
}) {
items {
productName
}
}
}
```
### extendSearchSortType
<MemberInfo kind="property" type={`string[]`} default="[]" since="1.4.0" />
Adds a list of sort parameters. This is mostly important to make the
correct sort order values available inside `input` parameter of the `mapSort` option.
*Example*
```ts
extendSearchSortType: ["distance"]
```
will extend the `SearchResultSortParameter` input type like this:
*Example*
```GraphQl
extend input SearchResultSortParameter {
distance: SortOrder
}
```
</div>
## SearchConfig
<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/options.ts" sourceLine="395" packageName="@vendure/elasticsearch-plugin" />
Configuration options for the internal Elasticsearch query which is generated when performing a search.
```ts title="Signature"
interface SearchConfig {
facetValueMaxSize?: number;
collectionMaxSize?: number;
totalItemsMaxSize?: number | boolean;
multiMatchType?: 'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix';
boostFields?: BoostFieldsConfig;
priceRangeBucketInterval?: number;
mapQuery?: (
query: any,
input: ElasticSearchInput,
searchConfig: DeepRequired<SearchConfig>,
channelId: ID,
enabledOnly: boolean,
) => any;
scriptFields?: { [fieldName: string]: CustomScriptMapping<[ElasticSearchInput]> };
mapSort?: (sort: ElasticSearchSortInput, input: ElasticSearchInput) => ElasticSearchSortInput;
}
```
<div className="members-wrapper">
### facetValueMaxSize
<MemberInfo kind="property" type={`number`} default="50" />
The maximum number of FacetValues to return from the search query. Internally, this
value sets the "size" property of an Elasticsearch aggregation.
### collectionMaxSize
<MemberInfo kind="property" type={`number`} default="50" since="1.1.0" />
The maximum number of Collections to return from the search query. Internally, this
value sets the "size" property of an Elasticsearch aggregation.
### totalItemsMaxSize
<MemberInfo kind="property" type={`number | boolean`} default="10000" since="1.2.0" />
The maximum number of totalItems to return from the search query. Internally, this
value sets the "track_total_hits" property of an Elasticsearch query.
If this parameter is set to "True", accurate count of totalItems will be returned.
If this parameter is set to "False", totalItems will be returned as 0.
If this parameter is set to integer, accurate count of totalItems will be returned not bigger than integer.
### multiMatchType
<MemberInfo kind="property" type={`'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix'`} default="'best_fields'" />
Defines the
[multi match type](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#multi-match-types)
used when matching against a search term.
### boostFields
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#boostfieldsconfig'>BoostFieldsConfig</a>`} />
Set custom boost values for particular fields when matching against a search term.
### priceRangeBucketInterval
<MemberInfo kind="property" type={`number`} />
The interval used to group search results into buckets according to price range. For example, setting this to
`2000` will group into buckets every $20.00:
```json
{
"data": {
"search": {
"totalItems": 32,
"priceRange": {
"buckets": [
{
"to": 2000,
"count": 21
},
{
"to": 4000,
"count": 7
},
{
"to": 6000,
"count": 3
},
{
"to": 12000,
"count": 1
}
]
}
}
}
}
```
### mapQuery
<MemberInfo kind="property" type={`(
query: any,
input: ElasticSearchInput,
searchConfig: DeepRequired<<a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#searchconfig'>SearchConfig</a>>,
channelId: <a href='/reference/typescript-api/common/id#id'>ID</a>,
enabledOnly: boolean,
) => any`} />
This config option allows the the modification of the whole (already built) search query. This allows
for e.g. wildcard / fuzzy searches on the index.
*Example*
```ts
mapQuery: (query, input, searchConfig, channelId, enabledOnly){
if(query.bool.must){
delete query.bool.must;
}
query.bool.should = [
{
query_string: {
query: "*" + term + "*",
fields: [
`productName^${searchConfig.boostFields.productName}`,
`productVariantName^${searchConfig.boostFields.productVariantName}`,
]
}
},
{
multi_match: {
query: term,
type: searchConfig.multiMatchType,
fields: [
`description^${searchConfig.boostFields.description}`,
`sku^${searchConfig.boostFields.sku}`,
],
},
},
];
return query;
}
```
### scriptFields
<MemberInfo kind="property" type={`{ [fieldName: string]: CustomScriptMapping<[ElasticSearchInput]> }`} since="1.3.0" />
Sets `script_fields` inside the elasticsearch body which allows returning a script evaluation for each hit.
The script field definition consists of three properties:
* `graphQlType`: This is the type that will be returned when this script field is queried
via the GraphQL API. It may be one of `String`, `Int`, `Float`, `Boolean`, `ID` or list
versions thereof (`[String!]` etc) and can be appended with a `!` to indicate non-nullable fields.
* `context`: determines whether this script field is available when grouping by product. Can be
`product`, `variant` or `both`.
* `scriptFn`: This is the function to run on each hit. Should return an object with a `script` property,
as covered in the
[Elasticsearch script fields docs](https://www.elastic.co/guide/en/elasticsearch/reference/7.15/search-fields.html#script-fields)
*Example*
```ts
extendSearchInputType: {
latitude: 'Float',
longitude: 'Float',
},
indexMappingProperties: {
// The `product-location` field corresponds to the `location` customProductMapping
// defined below. Here we specify that it would be index as a `geo_point` type,
// which will allow us to perform geo-spacial calculations on it in our script field.
'product-location': {
type: 'geo_point', // contains function arcDistance
},
},
customProductMappings: {
location: {
graphQlType: 'String',
valueFn: (product: Product) => {
// Assume that the Product entity has this customField defined
const custom = product.customFields.location;
return `${custom.latitude},${custom.longitude}`;
},
}
},
searchConfig: {
scriptFields: {
distance: {
graphQlType: 'Float!',
// Run this script only when grouping results by product
context: 'product',
scriptFn: (input) => {
// The SearchInput was extended with latitude and longitude
// via the `extendSearchInputType` option above.
const lat = input.latitude;
const lon = input.longitude;
return {
script: `doc['product-location'].arcDistance(${lat}, ${lon})`,
}
}
}
}
}
```
### mapSort
<MemberInfo kind="property" type={`(sort: ElasticSearchSortInput, input: ElasticSearchInput) => ElasticSearchSortInput`} default="{}" since="1.4.0" />
Allows extending the `sort` input of the elasticsearch body as covered in
[Elasticsearch sort docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html)
The `sort` input parameter contains the ElasticSearchSortInput generated for the default sort parameters "name" and "price".
If neither of those are applied it will be empty.
*Example*
```ts
mapSort: (sort, input) => {
// Assuming `extendSearchSortType: ["priority"]`
// Assuming priority is never undefined
const { priority } = input.sort;
return [
...sort,
{
// The `product-priority` field corresponds to the `priority` customProductMapping
// Depending on the index type, this field might require a
// more detailed input (example: 'productName.keyword')
["product-priority"]: {
order: priority === SortOrder.ASC ? 'asc' : 'desc'
}
}
];
}
```
A more generic example would be a sort function based on a product location like this:
*Example*
```ts
extendSearchInputType: {
latitude: 'Float',
longitude: 'Float',
},
extendSearchSortType: ["distance"],
indexMappingProperties: {
// The `product-location` field corresponds to the `location` customProductMapping
// defined below. Here we specify that it would be index as a `geo_point` type,
// which will allow us to perform geo-spacial calculations on it in our script field.
'product-location': {
type: 'geo_point',
},
},
customProductMappings: {
location: {
graphQlType: 'String',
valueFn: (product: Product) => {
// Assume that the Product entity has this customField defined
const custom = product.customFields.location;
return `${custom.latitude},${custom.longitude}`;
},
}
},
searchConfig: {
mapSort: (sort, input) => {
// Assuming distance is never undefined
const { distance } = input.sort;
return [
...sort,
{
["_geo_distance"]: {
"product-location": [
input.longitude,
input.latitude
],
order: distance === SortOrder.ASC ? 'asc' : 'desc',
unit: "km"
}
}
];
}
}
```
</div>
## BoostFieldsConfig
<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/options.ts" sourceLine="680" packageName="@vendure/elasticsearch-plugin" />
Configuration for [boosting](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#field-boost)
the scores of given fields when performing a search against a term.
Boosting a field acts as a score multiplier for matches against that field.
```ts title="Signature"
interface BoostFieldsConfig {
productName?: number;
productVariantName?: number;
description?: number;
sku?: number;
}
```
<div className="members-wrapper">
### productName
<MemberInfo kind="property" type={`number`} default="1" />
Defines the boost factor for the productName field.
### productVariantName
<MemberInfo kind="property" type={`number`} default="1" />
Defines the boost factor for the productVariantName field.
### description
<MemberInfo kind="property" type={`number`} default="1" />
Defines the boost factor for the description field.
### sku
<MemberInfo kind="property" type={`number`} default="1" />
Defines the boost factor for the sku field.
</div>
|
---
title: "ElasticsearchPlugin"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## ElasticsearchPlugin
<GenerationInfo sourceFile="packages/elasticsearch-plugin/src/plugin.ts" sourceLine="223" packageName="@vendure/elasticsearch-plugin" />
This plugin allows your product search to be powered by [Elasticsearch](https://github.com/elastic/elasticsearch) - a powerful Open Source search
engine. This is a drop-in replacement for the DefaultSearchPlugin which exposes many powerful configuration options enabling your storefront
to support a wide range of use-cases such as indexing of custom properties, fine control over search index configuration, and to leverage
advanced Elasticsearch features like spacial search.
## Installation
**Requires Elasticsearch v7.0 < required Elasticsearch version < 7.10 **
Elasticsearch version 7.10.2 will throw error due to incompatibility with elasticsearch-js client.
[Check here for more info](https://github.com/elastic/elasticsearch-js/issues/1519).
`yarn add @elastic/elasticsearch @vendure/elasticsearch-plugin`
or
`npm install @elastic/elasticsearch @vendure/elasticsearch-plugin`
Make sure to remove the `DefaultSearchPlugin` if it is still in the VendureConfig plugins array.
Then add the `ElasticsearchPlugin`, calling the `.init()` method with <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>:
*Example*
```ts
import { ElasticsearchPlugin } from '@vendure/elasticsearch-plugin';
const config: VendureConfig = {
// Add an instance of the plugin to the plugins array
plugins: [
ElasticsearchPlugin.init({
host: 'http://localhost',
port: 9200,
}),
],
};
```
## Search API Extensions
This plugin extends the default search query of the Shop API, allowing richer querying of your product data.
The [SearchResponse](/reference/graphql-api/admin/object-types/#searchresponse) type is extended with information
about price ranges in the result set:
```graphql
extend type SearchResponse {
prices: SearchResponsePriceData!
}
type SearchResponsePriceData {
range: PriceRange!
rangeWithTax: PriceRange!
buckets: [PriceRangeBucket!]!
bucketsWithTax: [PriceRangeBucket!]!
}
type PriceRangeBucket {
to: Int!
count: Int!
}
extend input SearchInput {
priceRange: PriceRangeInput
priceRangeWithTax: PriceRangeInput
}
input PriceRangeInput {
min: Int!
max: Int!
}
```
This `SearchResponsePriceData` type allows you to query data about the range of prices in the result set.
## Example Request & Response
```graphql
{
search (input: {
term: "table easel"
groupByProduct: true
priceRange: {
min: 500
max: 7000
}
}) {
totalItems
prices {
range {
min
max
}
buckets {
to
count
}
}
items {
productName
score
price {
...on PriceRange {
min
max
}
}
}
}
}
```
```json
{
"data": {
"search": {
"totalItems": 9,
"prices": {
"range": {
"min": 999,
"max": 6396,
},
"buckets": [
{
"to": 1000,
"count": 1
},
{
"to": 2000,
"count": 2
},
{
"to": 3000,
"count": 3
},
{
"to": 4000,
"count": 1
},
{
"to": 5000,
"count": 1
},
{
"to": 7000,
"count": 1
}
]
},
"items": [
{
"productName": "Loxley Yorkshire Table Easel",
"score": 30.58831,
"price": {
"min": 4984,
"max": 4984
}
},
// ... truncated
]
}
}
}
```
```ts title="Signature"
class ElasticsearchPlugin implements OnApplicationBootstrap {
init(options: ElasticsearchOptions) => Type<ElasticsearchPlugin>;
}
```
* Implements: <code>OnApplicationBootstrap</code>
<div className="members-wrapper">
### init
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/elasticsearch-plugin/elasticsearch-options#elasticsearchoptions'>ElasticsearchOptions</a>) => Type<<a href='/reference/core-plugins/elasticsearch-plugin/#elasticsearchplugin'>ElasticsearchPlugin</a>>`} />
</div>
|
---
title: "EmailEventHandlerWithAsyncData"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## EmailEventHandlerWithAsyncData
<GenerationInfo sourceFile="packages/email-plugin/src/handler/event-handler.ts" sourceLine="438" packageName="@vendure/email-plugin" />
Identical to the <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a> but with a `data` property added to the `event` based on the result
of the `.loadData()` function.
```ts title="Signature"
class EmailEventHandlerWithAsyncData<Data, T extends string = string, InputEvent extends EventWithContext = EventWithContext, Event extends EventWithAsyncData<InputEvent, Data> = EventWithAsyncData<InputEvent, Data>> extends EmailEventHandler<T, Event> {
constructor(_loadDataFn: LoadDataFn<InputEvent, Data>, listener: EmailEventListener<T>, event: Type<InputEvent>)
}
```
* Extends: <code><a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event></code>
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(_loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a><InputEvent, Data>, listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a><T>, event: Type<InputEvent>) => EmailEventHandlerWithAsyncData`} />
</div>
|
---
title: "EmailEventHandler"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## EmailEventHandler
<GenerationInfo sourceFile="packages/email-plugin/src/handler/event-handler.ts" sourceLine="131" packageName="@vendure/email-plugin" />
The EmailEventHandler defines how the EmailPlugin will respond to a given event.
A handler is created by creating a new <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a> and calling the `.on()` method
to specify which event to respond to.
*Example*
```ts
const confirmationHandler = new EmailEventListener('order-confirmation')
.on(OrderStateTransitionEvent)
.filter(event => event.toState === 'PaymentSettled')
.setRecipient(event => event.order.customer.emailAddress)
.setSubject(`Order confirmation for #{{ order.code }}`)
.setTemplateVars(event => ({ order: event.order }));
```
This example creates a handler which listens for the `OrderStateTransitionEvent` and if the Order has
transitioned to the `'PaymentSettled'` state, it will generate and send an email.
The string argument passed into the `EmailEventListener` constructor is used to identify the handler, and
also to locate the directory of the email template files. So in the example above, there should be a directory
`<app root>/static/email/templates/order-confirmation` which contains a Handlebars template named `body.hbs`.
## Handling other languages
By default, the handler will respond to all events on all channels and use the same subject ("Order confirmation for #12345" above)
and body template. Where the server is intended to support multiple languages, the `.addTemplate()` method may be used
to define the subject and body template for specific language and channel combinations.
The language is determined by looking at the `languageCode` property of the event's `ctx` (<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) object.
*Example*
```ts
const extendedConfirmationHandler = confirmationHandler
.addTemplate({
channelCode: 'default',
languageCode: LanguageCode.de,
templateFile: 'body.de.hbs',
subject: 'Bestellbestätigung für #{{ order.code }}',
})
```
## Defining a custom handler
Let's say you have a plugin which defines a new event type, `QuoteRequestedEvent`. In your plugin you have defined a mutation
which is executed when the customer requests a quote in your storefront, and in your resolver, you use the <a href='/reference/typescript-api/events/event-bus#eventbus'>EventBus</a> to publish a
new `QuoteRequestedEvent`.
You now want to email the customer with their quote. Here are the steps you would take to set this up:
### 1. Create a new handler
```ts
import { EmailEventListener } from `@vendure/email-plugin`;
import { QuoteRequestedEvent } from `./events`;
const quoteRequestedHandler = new EmailEventListener('quote-requested')
.on(QuoteRequestedEvent)
.setRecipient(event => event.customer.emailAddress)
.setSubject(`Here's the quote you requested`)
.setTemplateVars(event => ({ details: event.details }));
```
### 2. Create the email template
Next you need to make sure there is a template defined at `<app root>/static/email/templates/quote-requested/body.hbs`. The template
would look something like this:
```handlebars
{{> header title="Here's the quote you requested" }}
<mj-section background-color="#fafafa">
<mj-column>
<mj-text color="#525252">
Thank you for your interest in our products! Here's the details
of the quote you recently requested:
</mj-text>
<--! your custom email layout goes here -->
</mj-column>
</mj-section>
{{> footer }}
```
You can find pre-made templates on the [MJML website](https://mjml.io/templates/).
### 3. Register the handler
Finally, you need to register the handler with the EmailPlugin:
```ts {hl_lines=[8]}
import { defaultEmailHandlers, EmailPlugin } from '@vendure/email-plugin';
import { quoteRequestedHandler } from './plugins/quote-plugin';
const config: VendureConfig = {
// Add an instance of the plugin to the plugins array
plugins: [
EmailPlugin.init({
handler: [...defaultEmailHandlers, quoteRequestedHandler],
templatePath: path.join(__dirname, 'vendure/email/templates'),
// ... etc
}),
],
};
```
```ts title="Signature"
class EmailEventHandler<T extends string = string, Event extends EventWithContext = EventWithContext> {
constructor(listener: EmailEventListener<T>, event: Type<Event>)
filter(filterFn: (event: Event) => boolean) => EmailEventHandler<T, Event>;
setRecipient(setRecipientFn: (event: Event) => string) => EmailEventHandler<T, Event>;
setLanguageCode(setLanguageCodeFn: (event: Event) => LanguageCode | undefined) => EmailEventHandler<T, Event>;
setTemplateVars(templateVarsFn: SetTemplateVarsFn<Event>) => EmailEventHandler<T, Event>;
setSubject(defaultSubject: string) => EmailEventHandler<T, Event>;
setFrom(from: string) => EmailEventHandler<T, Event>;
setOptionalAddressFields(optionalAddressFieldsFn: SetOptionalAddressFieldsFn<Event>) => ;
setAttachments(setAttachmentsFn: SetAttachmentsFn<Event>) => ;
addTemplate(config: EmailTemplateConfig) => EmailEventHandler<T, Event>;
loadData(loadDataFn: LoadDataFn<Event, R>) => EmailEventHandlerWithAsyncData<R, T, Event, EventWithAsyncData<Event, R>>;
setMockEvent(event: Omit<Event, 'ctx' | 'data'>) => EmailEventHandler<T, Event>;
}
```
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(listener: <a href='/reference/core-plugins/email-plugin/email-event-listener#emaileventlistener'>EmailEventListener</a><T>, event: Type<Event>) => EmailEventHandler`} />
### filter
<MemberInfo kind="method" type={`(filterFn: (event: Event) => boolean) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
Defines a predicate function which is used to determine whether the event will trigger an email.
Multiple filter functions may be defined.
### setRecipient
<MemberInfo kind="method" type={`(setRecipientFn: (event: Event) => string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
A function which defines how the recipient email address should be extracted from the incoming event.
The recipient can be a plain email address: `'foobar@example.com'`
Or with a formatted name (includes unicode support): `'Ноде Майлер <foobar@example.com>'`
Or a comma-separated list of addresses: `'foobar@example.com, "Ноде Майлер" <bar@example.com>'`
### setLanguageCode
<MemberInfo kind="method" type={`(setLanguageCodeFn: (event: Event) => <a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a> | undefined) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} since="1.8.0" />
A function which allows to override the language of the email. If not defined, the language from the context will be used.
### setTemplateVars
<MemberInfo kind="method" type={`(templateVarsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#settemplatevarsfn'>SetTemplateVarsFn</a><Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
A function which returns an object hash of variables which will be made available to the Handlebars template
and subject line for interpolation.
### setSubject
<MemberInfo kind="method" type={`(defaultSubject: string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
Sets the default subject of the email. The subject string may use Handlebars variables defined by the
setTemplateVars() method.
### setFrom
<MemberInfo kind="method" type={`(from: string) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
Sets the default from field of the email. The from string may use Handlebars variables defined by the
setTemplateVars() method.
### setOptionalAddressFields
<MemberInfo kind="method" type={`(optionalAddressFieldsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setoptionaladdressfieldsfn'>SetOptionalAddressFieldsFn</a><Event>) => `} since="1.1.0" />
A function which allows <a href='/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields'>OptionalAddressFields</a> to be specified such as "cc" and "bcc".
### setAttachments
<MemberInfo kind="method" type={`(setAttachmentsFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#setattachmentsfn'>SetAttachmentsFn</a><Event>) => `} />
Defines one or more files to be attached to the email. An attachment can be specified
as either a `path` (to a file or URL) or as `content` which can be a string, Buffer or Stream.
**Note:** When using the `content` to pass a Buffer or Stream, the raw data will get serialized
into the job queue. For this reason the total size of all attachments passed as `content` should kept to
**less than ~50k**. If the attachments are greater than that limit, a warning will be logged and
errors may result if using the DefaultJobQueuePlugin with certain DBs such as MySQL/MariaDB.
*Example*
```ts
const testAttachmentHandler = new EmailEventListener('activate-voucher')
.on(ActivateVoucherEvent)
// ... omitted some steps for brevity
.setAttachments(async (event) => {
const { imageUrl, voucherCode } = await getVoucherDataForUser(event.user.id);
return [
{
filename: `voucher-${voucherCode}.jpg`,
path: imageUrl,
},
];
});
```
### addTemplate
<MemberInfo kind="method" type={`(config: EmailTemplateConfig) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
Add configuration for another template other than the default `"body.hbs"`. Use this method to define specific
templates for channels or languageCodes other than the default.
### loadData
<MemberInfo kind="method" type={`(loadDataFn: <a href='/reference/core-plugins/email-plugin/email-plugin-types#loaddatafn'>LoadDataFn</a><Event, R>) => <a href='/reference/core-plugins/email-plugin/email-event-handler-with-async-data#emaileventhandlerwithasyncdata'>EmailEventHandlerWithAsyncData</a><R, T, Event, <a href='/reference/core-plugins/email-plugin/email-plugin-types#eventwithasyncdata'>EventWithAsyncData</a><Event, R>>`} />
Allows data to be loaded asynchronously which can then be used as template variables.
The `loadDataFn` has access to the event, the TypeORM `Connection` object, and an
`inject()` function which can be used to inject any of the providers exported
by the <a href='/reference/typescript-api/plugin/plugin-common-module#plugincommonmodule'>PluginCommonModule</a>. The return value of the `loadDataFn` will be
added to the `event` as the `data` property.
*Example*
```ts
new EmailEventListener('order-confirmation')
.on(OrderStateTransitionEvent)
.filter(event => event.toState === 'PaymentSettled' && !!event.order.customer)
.loadData(({ event, injector }) => {
const orderService = injector.get(OrderService);
return orderService.getOrderPayments(event.order.id);
})
.setTemplateVars(event => ({
order: event.order,
payments: event.data,
}));
```
### setMockEvent
<MemberInfo kind="method" type={`(event: Omit<Event, 'ctx' | 'data'>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
Optionally define a mock Event which is used by the dev mode mailbox app for generating mock emails
from this handler, which is useful when developing the email templates.
</div>
|
---
title: "EmailEventListener"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## EmailEventListener
<GenerationInfo sourceFile="packages/email-plugin/src/event-listener.ts" sourceLine="13" packageName="@vendure/email-plugin" />
An EmailEventListener is used to listen for events and set up a <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a> which
defines how an email will be generated from this event.
```ts title="Signature"
class EmailEventListener<T extends string> {
public type: T;
constructor(type: T)
on(event: Type<Event>) => EmailEventHandler<T, Event>;
}
```
<div className="members-wrapper">
### type
<MemberInfo kind="property" type={`T`} />
### constructor
<MemberInfo kind="method" type={`(type: T) => EmailEventListener`} />
### on
<MemberInfo kind="method" type={`(event: Type<Event>) => <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><T, Event>`} />
Defines the event to listen for.
</div>
|
---
title: "EmailGenerator"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## EmailGenerator
<GenerationInfo sourceFile="packages/email-plugin/src/generator/email-generator.ts" sourceLine="13" packageName="@vendure/email-plugin" />
An EmailGenerator generates the subject and body details of an email.
```ts title="Signature"
interface EmailGenerator<T extends string = any, E extends VendureEvent = any> extends InjectableStrategy {
onInit?(options: EmailPluginOptions): void | Promise<void>;
generate(
from: string,
subject: string,
body: string,
templateVars: { [key: string]: any },
): Pick<EmailDetails, 'from' | 'subject' | 'body'>;
}
```
* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
<div className="members-wrapper">
### onInit
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>) => void | Promise<void>`} />
Any necessary setup can be performed here.
### generate
<MemberInfo kind="method" type={`(from: string, subject: string, body: string, templateVars: { [key: string]: any }) => Pick<<a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, 'from' | 'subject' | 'body'>`} />
Given a subject and body from an email template, this method generates the final
interpolated email text.
</div>
## HandlebarsMjmlGenerator
<GenerationInfo sourceFile="packages/email-plugin/src/generator/handlebars-mjml-generator.ts" sourceLine="17" packageName="@vendure/email-plugin" />
Uses Handlebars (https://handlebarsjs.com/) to output MJML (https://mjml.io) which is then
compiled down to responsive email HTML.
```ts title="Signature"
class HandlebarsMjmlGenerator implements EmailGenerator {
onInit(options: InitializedEmailPluginOptions) => ;
generate(from: string, subject: string, template: string, templateVars: any) => ;
}
```
* Implements: <code><a href='/reference/core-plugins/email-plugin/email-generator#emailgenerator'>EmailGenerator</a></code>
<div className="members-wrapper">
### onInit
<MemberInfo kind="method" type={`(options: InitializedEmailPluginOptions) => `} />
### generate
<MemberInfo kind="method" type={`(from: string, subject: string, template: string, templateVars: any) => `} />
</div>
|
---
title: "EmailPluginOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## EmailPluginOptions
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="41" packageName="@vendure/email-plugin" />
Configuration for the EmailPlugin.
```ts title="Signature"
interface EmailPluginOptions {
templatePath?: string;
templateLoader?: TemplateLoader;
transport:
| EmailTransportOptions
| ((
injector?: Injector,
ctx?: RequestContext,
) => EmailTransportOptions | Promise<EmailTransportOptions>);
handlers: Array<EmailEventHandler<string, any>>;
globalTemplateVars?: { [key: string]: any };
emailSender?: EmailSender;
emailGenerator?: EmailGenerator;
}
```
<div className="members-wrapper">
### templatePath
<MemberInfo kind="property" type={`string`} />
The path to the location of the email templates. In a default Vendure installation,
the templates are installed to `<project root>/vendure/email/templates`.
### templateLoader
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/email-plugin/template-loader#templateloader'>TemplateLoader</a>`} since="2.0.0" />
An optional TemplateLoader which can be used to load templates from a custom location or async service.
The default uses the FileBasedTemplateLoader which loads templates from `<project root>/vendure/email/templates`
### transport
<MemberInfo kind="property" type={`| <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>
| ((
injector?: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,
ctx?: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,
) => <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a> | Promise<<a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>>)`} />
Configures how the emails are sent.
### handlers
<MemberInfo kind="property" type={`Array<<a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a><string, any>>`} />
An array of <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>s which define which Vendure events will trigger
emails, and how those emails are generated.
### globalTemplateVars
<MemberInfo kind="property" type={`{ [key: string]: any }`} />
An object containing variables which are made available to all templates. For example,
the storefront URL could be defined here and then used in the "email address verification"
email.
### emailSender
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/email-plugin/email-sender#emailsender'>EmailSender</a>`} default="<a href='/reference/core-plugins/email-plugin/email-sender#nodemaileremailsender'>NodemailerEmailSender</a>" />
An optional allowed EmailSender, used to allow custom implementations of the send functionality
while still utilizing the existing emailPlugin functionality.
### emailGenerator
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/email-plugin/email-generator#emailgenerator'>EmailGenerator</a>`} default="<a href='/reference/core-plugins/email-plugin/email-generator#handlebarsmjmlgenerator'>HandlebarsMjmlGenerator</a>" />
An optional allowed EmailGenerator, used to allow custom email generation functionality to
better match with custom email sending functionality.
</div>
## EmailPluginDevModeOptions
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="111" packageName="@vendure/email-plugin" />
Configuration for running the EmailPlugin in development mode.
```ts title="Signature"
interface EmailPluginDevModeOptions extends Omit<EmailPluginOptions, 'transport'> {
devMode: true;
outputPath: string;
route: string;
}
```
* Extends: <code>Omit<<a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a>, 'transport'></code>
<div className="members-wrapper">
### devMode
<MemberInfo kind="property" type={`true`} />
### outputPath
<MemberInfo kind="property" type={`string`} />
The path to which html email files will be saved rather than being sent.
### route
<MemberInfo kind="property" type={`string`} />
The route to the dev mailbox server.
</div>
|
---
title: "Email Plugin Types"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## EventWithContext
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="22" packageName="@vendure/email-plugin" />
A VendureEvent which also includes a `ctx` property containing the current
<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, which is used to determine the channel and language
to use when generating the email.
```ts title="Signature"
type EventWithContext = VendureEvent & { ctx: RequestContext }
```
## EventWithAsyncData
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="32" packageName="@vendure/email-plugin" />
A VendureEvent with a <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> and a `data` property which contains the
value resolved from the <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>`.loadData()` callback.
```ts title="Signature"
type EventWithAsyncData<Event extends EventWithContext, R> = Event & { data: R }
```
## EmailDetails
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="249" packageName="@vendure/email-plugin" />
The final, generated email details to be sent.
```ts title="Signature"
interface EmailDetails<Type extends 'serialized' | 'unserialized' = 'unserialized'> {
from: string;
recipient: string;
subject: string;
body: string;
attachments: Array<Type extends 'serialized' ? SerializedAttachment : Attachment>;
cc?: string;
bcc?: string;
replyTo?: string;
}
```
<div className="members-wrapper">
### from
<MemberInfo kind="property" type={`string`} />
### recipient
<MemberInfo kind="property" type={`string`} />
### subject
<MemberInfo kind="property" type={`string`} />
### body
<MemberInfo kind="property" type={`string`} />
### attachments
<MemberInfo kind="property" type={`Array<Type extends 'serialized' ? SerializedAttachment : Attachment>`} />
### cc
<MemberInfo kind="property" type={`string`} />
### bcc
<MemberInfo kind="property" type={`string`} />
### replyTo
<MemberInfo kind="property" type={`string`} />
</div>
## LoadDataFn
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="283" packageName="@vendure/email-plugin" />
A function used to load async data for use by an <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>.
```ts title="Signature"
type LoadDataFn<Event extends EventWithContext, R> = (context: {
event: Event;
injector: Injector;
}) => Promise<R>
```
## EmailAttachment
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="302" packageName="@vendure/email-plugin" />
An object defining a file attachment for an email. Based on the object described
[here in the Nodemailer docs](https://nodemailer.com/message/attachments/), but
only uses the `path` property to define a filesystem path or a URL pointing to
the attachment file.
```ts title="Signature"
type EmailAttachment = Omit<Attachment, 'raw'> & { path?: string }
```
## SetTemplateVarsFn
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="374" packageName="@vendure/email-plugin" />
A function used to define template variables available to email templates.
See <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>.setTemplateVars().
```ts title="Signature"
type SetTemplateVarsFn<Event> = (
event: Event,
globals: { [key: string]: any },
) => { [key: string]: any }
```
## SetAttachmentsFn
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="388" packageName="@vendure/email-plugin" />
A function used to define attachments to be sent with the email.
See https://nodemailer.com/message/attachments/ for more information about
how attachments work in Nodemailer.
```ts title="Signature"
type SetAttachmentsFn<Event> = (event: Event) => EmailAttachment[] | Promise<EmailAttachment[]>
```
## OptionalAddressFields
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="398" packageName="@vendure/email-plugin" since="1.1.0" />
Optional address-related fields for sending the email.
```ts title="Signature"
interface OptionalAddressFields {
cc?: string;
bcc?: string;
replyTo?: string;
}
```
<div className="members-wrapper">
### cc
<MemberInfo kind="property" type={`string`} />
Comma separated list of recipients email addresses that will appear on the _Cc:_ field
### bcc
<MemberInfo kind="property" type={`string`} />
Comma separated list of recipients email addresses that will appear on the _Bcc:_ field
### replyTo
<MemberInfo kind="property" type={`string`} />
An email address that will appear on the _Reply-To:_ field
</div>
## SetOptionalAddressFieldsFn
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="424" packageName="@vendure/email-plugin" since="1.1.0" />
A function used to set the <a href='/reference/core-plugins/email-plugin/email-plugin-types#optionaladdressfields'>OptionalAddressFields</a>.
```ts title="Signature"
type SetOptionalAddressFieldsFn<Event> = (
event: Event,
) => OptionalAddressFields | Promise<OptionalAddressFields>
```
|
---
title: "EmailSendEvent"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## EmailSendEvent
<GenerationInfo sourceFile="packages/email-plugin/src/email-send-event.ts" sourceLine="14" packageName="@vendure/email-plugin" since="2.2.0" />
This event is fired when an email sending attempt has been made. If the sending was successful,
the `success` property will be `true`, and if not, the `error` property will contain the error
which occurred.
```ts title="Signature"
class EmailSendEvent extends VendureEvent {
constructor(ctx: RequestContext, details: EmailDetails, success: boolean, error?: Error)
}
```
* Extends: <code><a href='/reference/typescript-api/events/vendure-event#vendureevent'>VendureEvent</a></code>
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, details: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, success: boolean, error?: Error) => EmailSendEvent`} />
</div>
|
---
title: "EmailSender"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## EmailSender
<GenerationInfo sourceFile="packages/email-plugin/src/sender/email-sender.ts" sourceLine="45" packageName="@vendure/email-plugin" />
An EmailSender is responsible for sending the email, e.g. via an SMTP connection
or using some other mail-sending API. By default, the EmailPlugin uses the
<a href='/reference/core-plugins/email-plugin/email-sender#nodemaileremailsender'>NodemailerEmailSender</a>, but it is also possible to supply a custom implementation:
*Example*
```ts
const sgMail = require('@sendgrid/mail');
sgMail.setApiKey(process.env.SENDGRID_API_KEY);
class SendgridEmailSender implements EmailSender {
async send(email: EmailDetails) {
await sgMail.send({
to: email.recipient,
from: email.from,
subject: email.subject,
html: email.body,
});
}
}
const config: VendureConfig = {
logger: new DefaultLogger({ level: LogLevel.Debug })
// ...
plugins: [
EmailPlugin.init({
// ... template, handler config omitted
transport: { type: 'none' },
emailSender: new SendgridEmailSender(),
}),
],
};
```
```ts title="Signature"
interface EmailSender extends InjectableStrategy {
send: (email: EmailDetails, options: EmailTransportOptions) => void | Promise<void>;
}
```
* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
<div className="members-wrapper">
### send
<MemberInfo kind="property" type={`(email: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, options: <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>) => void | Promise<void>`} />
</div>
## NodemailerEmailSender
<GenerationInfo sourceFile="packages/email-plugin/src/sender/nodemailer-email-sender.ts" sourceLine="39" packageName="@vendure/email-plugin" />
Uses the configured transport to send the generated email.
```ts title="Signature"
class NodemailerEmailSender implements EmailSender {
send(email: EmailDetails, options: EmailTransportOptions) => ;
}
```
* Implements: <code><a href='/reference/core-plugins/email-plugin/email-sender#emailsender'>EmailSender</a></code>
<div className="members-wrapper">
### send
<MemberInfo kind="method" type={`(email: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>, options: <a href='/reference/core-plugins/email-plugin/transport-options#emailtransportoptions'>EmailTransportOptions</a>) => `} />
</div>
|
---
title: "Email Utils"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## transformOrderLineAssetUrls
<GenerationInfo sourceFile="packages/email-plugin/src/handler/default-email-handlers.ts" sourceLine="101" packageName="@vendure/email-plugin" />
Applies the configured `AssetStorageStrategy.toAbsoluteUrl()` function to each of the
OrderLine's `featuredAsset.preview` properties, so that they can be correctly displayed
in the email template.
This is required since that step usually happens at the API in middleware, which is not
applicable in this context. So we need to do it manually.
**Note: Mutates the Order object**
```ts title="Signature"
function transformOrderLineAssetUrls(ctx: RequestContext, order: Order, injector: Injector): Order
```
Parameters
### ctx
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`} />
### order
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/entities/order#order'>Order</a>`} />
### injector
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/common/injector#injector'>Injector</a>`} />
## hydrateShippingLines
<GenerationInfo sourceFile="packages/email-plugin/src/handler/default-email-handlers.ts" sourceLine="122" packageName="@vendure/email-plugin" />
Ensures that the ShippingLines are hydrated so that we can use the
`shippingMethod.name` property in the email template.
```ts title="Signature"
function hydrateShippingLines(ctx: RequestContext, order: Order, injector: Injector): Promise<ShippingLine[]>
```
Parameters
### ctx
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>`} />
### order
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/entities/order#order'>Order</a>`} />
### injector
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/common/injector#injector'>Injector</a>`} />
|
---
title: "EmailPlugin"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## EmailPlugin
<GenerationInfo sourceFile="packages/email-plugin/src/plugin.ts" sourceLine="272" packageName="@vendure/email-plugin" />
The EmailPlugin creates and sends transactional emails based on Vendure events. By default, it uses an [MJML](https://mjml.io/)-based
email generator to generate the email body and [Nodemailer](https://nodemailer.com/about/) to send the emails.
## High-level description
Vendure has an internal events system (see <a href='/reference/typescript-api/events/event-bus#eventbus'>EventBus</a>) that allows plugins to subscribe to events. The EmailPlugin is configured with <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a>s
that listen for a specific event and when it is published, the handler defines which template to use to generate the resulting email.
The plugin comes with a set of default handler for the following events:
- Order confirmation
- New customer email address verification
- Password reset request
- Email address change request
You can also create your own handler and register them with the plugin - see the <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a> docs for more details.
## Installation
`yarn add @vendure/email-plugin`
or
`npm install @vendure/email-plugin`
*Example*
```ts
import { defaultEmailHandlers, EmailPlugin } from '@vendure/email-plugin';
const config: VendureConfig = {
// Add an instance of the plugin to the plugins array
plugins: [
EmailPlugin.init({
handler: defaultEmailHandlers,
templatePath: path.join(__dirname, 'static/email/templates'),
transport: {
type: 'smtp',
host: 'smtp.example.com',
port: 587,
auth: {
user: 'username',
pass: 'password',
}
},
}),
],
};
```
## Email templates
In the example above, the plugin has been configured to look in `<app-root>/static/email/templates`
for the email template files. If you used `@vendure/create` to create your application, the templates will have
been copied to that location during setup.
If you are installing the EmailPlugin separately, then you'll need to copy the templates manually from
`node_modules/@vendure/email-plugin/templates` to a location of your choice, and then point the `templatePath` config
property at that directory.
* ### Dynamic Email Templates
Instead of passing a static value to `templatePath`, use `templateLoader` to define a template path.
```ts
EmailPlugin.init({
...,
templateLoader: new FileBasedTemplateLoader(my/order-confirmation/templates)
})
```
## Customizing templates
Emails are generated from templates which use [MJML](https://mjml.io/) syntax. MJML is an open-source HTML-like markup
language which makes the task of creating responsive email markup simple. By default, the templates are installed to
`<project root>/vendure/email/templates` and can be freely edited.
Dynamic data such as the recipient's name or order items are specified using [Handlebars syntax](https://handlebarsjs.com/):
```html
<p>Dear {{ order.customer.firstName }} {{ order.customer.lastName }},</p>
<p>Thank you for your order!</p>
<mj-table cellpadding="6px">
{{#each order.lines }}
<tr class="order-row">
<td>{{ quantity }} x {{ productVariant.name }}</td>
<td>{{ productVariant.quantity }}</td>
<td>{{ formatMoney totalPrice }}</td>
</tr>
{{/each}}
</mj-table>
```
### Handlebars helpers
The following helper functions are available for use in email templates:
* `formatMoney`: Formats an amount of money (which are always stored as integers in Vendure) as a decimal, e.g. `123` => `1.23`
* `formatDate`: Formats a Date value with the [dateformat](https://www.npmjs.com/package/dateformat) package.
## Extending the default email handler
The `defaultEmailHandlers` array defines the default handler such as for handling new account registration, order confirmation, password reset
etc. These defaults can be extended by adding custom templates for languages other than the default, or even completely new types of emails
which respond to any of the available [VendureEvents](/reference/typescript-api/events/).
A good way to learn how to create your own email handler is to take a look at the
[source code of the default handler](https://github.com/vendure-ecommerce/vendure/blob/master/packages/email-plugin/src/handler/default-email-handlers.ts).
New handler are defined in exactly the same way.
It is also possible to modify the default handler:
```ts
// Rather than importing `defaultEmailHandlers`, you can
// import the handler individually
import {
orderConfirmationHandler,
emailVerificationHandler,
passwordResetHandler,
emailAddressChangeHandler,
} from '@vendure/email-plugin';
import { CustomerService } from '@vendure/core';
// This allows you to then customize each handler to your needs.
// For example, let's set a new subject line to the order confirmation:
const myOrderConfirmationHandler = orderConfirmationHandler
.setSubject(`We received your order!`);
// Another example: loading additional data and setting new
// template variables.
const myPasswordResetHandler = passwordResetHandler
.loadData(async ({ event, injector }) => {
const customerService = injector.get(CustomerService);
const customer = await customerService.findOneByUserId(event.ctx, event.user.id);
return { customer };
})
.setTemplateVars(event => ({
passwordResetToken: event.user.getNativeAuthenticationMethod().passwordResetToken,
customer: event.data.customer,
}));
// Then you pass the handler to the EmailPlugin init method
// individually
EmailPlugin.init({
handler: [
myOrderConfirmationHandler,
myPasswordResetHandler,
emailVerificationHandler,
emailAddressChangeHandler,
],
// ...
}),
```
For all available methods of extending a handler, see the <a href='/reference/core-plugins/email-plugin/email-event-handler#emaileventhandler'>EmailEventHandler</a> documentation.
## Dynamic SMTP settings
Instead of defining static transport settings, you can also provide a function that dynamically resolves
channel aware transport settings.
*Example*
```ts
import { defaultEmailHandlers, EmailPlugin } from '@vendure/email-plugin';
import { MyTransportService } from './transport.services.ts';
const config: VendureConfig = {
plugins: [
EmailPlugin.init({
handler: defaultEmailHandlers,
templatePath: path.join(__dirname, 'static/email/templates'),
transport: (injector, ctx) => {
if (ctx) {
return injector.get(MyTransportService).getSettings(ctx);
} else {
return {
type: 'smtp',
host: 'smtp.example.com',
// ... etc.
}
}
}
}),
],
};
```
## Dev mode
For development, the `transport` option can be replaced by `devMode: true`. Doing so configures Vendure to use the
file transport (See <a href='/reference/core-plugins/email-plugin/transport-options#filetransportoptions'>FileTransportOptions</a>) and outputs emails as rendered HTML files in the directory specified by the
`outputPath` property.
```ts
EmailPlugin.init({
devMode: true,
route: 'mailbox',
handler: defaultEmailHandlers,
templatePath: path.join(__dirname, 'vendure/email/templates'),
outputPath: path.join(__dirname, 'test-emails'),
})
```
### Dev mailbox
In dev mode, a webmail-like interface available at the `/mailbox` path, e.g.
http://localhost:3000/mailbox. This is a simple way to view the output of all emails generated by the EmailPlugin while in dev mode.
## Troubleshooting SMTP Connections
If you are having trouble sending email over and SMTP connection, set the `logging` and `debug` options to `true`. This will
send detailed information from the SMTP transporter to the configured logger (defaults to console). For maximum detail combine
this with a detail log level in the configured VendureLogger:
```ts
const config: VendureConfig = {
logger: new DefaultLogger({ level: LogLevel.Debug })
// ...
plugins: [
EmailPlugin.init({
// ...
transport: {
type: 'smtp',
host: 'smtp.example.com',
port: 587,
auth: {
user: 'username',
pass: 'password',
},
logging: true,
debug: true,
},
}),
],
};
```
```ts title="Signature"
class EmailPlugin implements OnApplicationBootstrap, OnApplicationShutdown, NestModule {
init(options: EmailPluginOptions | EmailPluginDevModeOptions) => Type<EmailPlugin>;
onApplicationShutdown() => ;
configure(consumer: MiddlewareConsumer) => ;
}
```
* Implements: <code>OnApplicationBootstrap</code>, <code>OnApplicationShutdown</code>, <code>NestModule</code>
<div className="members-wrapper">
### init
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailpluginoptions'>EmailPluginOptions</a> | <a href='/reference/core-plugins/email-plugin/email-plugin-options#emailplugindevmodeoptions'>EmailPluginDevModeOptions</a>) => Type<<a href='/reference/core-plugins/email-plugin/#emailplugin'>EmailPlugin</a>>`} />
### onApplicationShutdown
<MemberInfo kind="method" type={`() => `} />
### configure
<MemberInfo kind="method" type={`(consumer: MiddlewareConsumer) => `} />
</div>
|
---
title: "TemplateLoader"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## TemplateLoader
<GenerationInfo sourceFile="packages/email-plugin/src/template-loader/template-loader.ts" sourceLine="32" packageName="@vendure/email-plugin" />
Loads email templates based on the given request context, type and template name
and return the template as a string.
*Example*
```ts
import { EmailPlugin, TemplateLoader } from '@vendure/email-plugin';
class MyTemplateLoader implements TemplateLoader {
loadTemplate(injector, ctx, { type, templateName }){
return myCustomTemplateFunction(ctx);
}
}
// In vendure-config.ts:
...
EmailPlugin.init({
templateLoader: new MyTemplateLoader()
...
})
```
```ts title="Signature"
interface TemplateLoader {
loadTemplate(injector: Injector, ctx: RequestContext, input: LoadTemplateInput): Promise<string>;
loadPartials?(): Promise<Partial[]>;
}
```
<div className="members-wrapper">
### loadTemplate
<MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: LoadTemplateInput) => Promise<string>`} />
Load template and return it's content as a string
### loadPartials
<MemberInfo kind="method" type={`() => Promise<Partial[]>`} />
Load partials and return their contents.
This method is only called during initialization, i.e. during server startup.
</div>
## FileBasedTemplateLoader
<GenerationInfo sourceFile="packages/email-plugin/src/template-loader/file-based-template-loader.ts" sourceLine="17" packageName="@vendure/email-plugin" />
Loads email templates from the local file system. This is the default
loader used by the EmailPlugin.
```ts title="Signature"
class FileBasedTemplateLoader implements TemplateLoader {
constructor(templatePath: string)
loadTemplate(_injector: Injector, _ctx: RequestContext, { type, templateName }: LoadTemplateInput) => Promise<string>;
loadPartials() => Promise<Partial[]>;
}
```
* Implements: <code><a href='/reference/core-plugins/email-plugin/template-loader#templateloader'>TemplateLoader</a></code>
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(templatePath: string) => FileBasedTemplateLoader`} />
### loadTemplate
<MemberInfo kind="method" type={`(_injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>, _ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, { type, templateName }: LoadTemplateInput) => Promise<string>`} />
### loadPartials
<MemberInfo kind="method" type={`() => Promise<Partial[]>`} />
</div>
|
---
title: "Transport Options"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## EmailTransportOptions
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="132" packageName="@vendure/email-plugin" />
A union of all the possible transport options for sending emails.
```ts title="Signature"
type EmailTransportOptions = | SMTPTransportOptions
| SendmailTransportOptions
| FileTransportOptions
| NoopTransportOptions
| SESTransportOptions
| TestingTransportOptions
```
## SMTPTransportOptions
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="147" packageName="@vendure/email-plugin" />
The SMTP transport options of [Nodemailer](https://nodemailer.com/smtp/)
```ts title="Signature"
interface SMTPTransportOptions extends SMTPTransport.Options {
type: 'smtp';
logging?: boolean;
}
```
* Extends: <code>SMTPTransport.Options</code>
<div className="members-wrapper">
### type
<MemberInfo kind="property" type={`'smtp'`} />
### logging
<MemberInfo kind="property" type={`boolean`} default="false" />
If true, uses the configured <a href='/reference/typescript-api/logger/vendure-logger#vendurelogger'>VendureLogger</a> to log messages from Nodemailer as it interacts with
the SMTP server.
</div>
## SESTransportOptions
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="196" packageName="@vendure/email-plugin" />
The SES transport options of [Nodemailer](https://nodemailer.com/transports/ses//)
See [Nodemailers's SES docs](https://nodemailer.com/transports/ses/) for more details
*Example*
```ts
import { SES, SendRawEmailCommand } from '@aws-sdk/client-ses'
const ses = new SES({
apiVersion: '2010-12-01',
region: 'eu-central-1',
credentials: {
accessKeyId: process.env.SES_ACCESS_KEY || '',
secretAccessKey: process.env.SES_SECRET_KEY || '',
},
})
const config: VendureConfig = {
// Add an instance of the plugin to the plugins array
plugins: [
EmailPlugin.init({
handler: defaultEmailHandlers,
templatePath: path.join(__dirname, 'static/email/templates'),
transport: {
type: 'ses',
SES: { ses, aws: { SendRawEmailCommand } },
sendingRate: 10, // optional messages per second sending rate
},
}),
],
};
```
```ts title="Signature"
interface SESTransportOptions extends SESTransport.Options {
type: 'ses';
}
```
* Extends: <code>SESTransport.Options</code>
<div className="members-wrapper">
### type
<MemberInfo kind="property" type={`'ses'`} />
</div>
## SendmailTransportOptions
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="207" packageName="@vendure/email-plugin" />
Uses the local Sendmail program to send the email.
```ts title="Signature"
interface SendmailTransportOptions {
type: 'sendmail';
path?: string;
newline?: string;
}
```
<div className="members-wrapper">
### type
<MemberInfo kind="property" type={`'sendmail'`} />
### path
<MemberInfo kind="property" type={`string`} />
### newline
<MemberInfo kind="property" type={`string`} />
</div>
## FileTransportOptions
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="222" packageName="@vendure/email-plugin" />
Outputs the email as an HTML file for development purposes.
```ts title="Signature"
interface FileTransportOptions {
type: 'file';
outputPath: string;
raw?: boolean;
}
```
<div className="members-wrapper">
### type
<MemberInfo kind="property" type={`'file'`} />
### outputPath
<MemberInfo kind="property" type={`string`} />
### raw
<MemberInfo kind="property" type={`boolean`} />
</div>
## NoopTransportOptions
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="238" packageName="@vendure/email-plugin" />
Does nothing with the generated email. Intended for use in testing where we don't care about the email transport,
or when using a custom <a href='/reference/core-plugins/email-plugin/email-sender#emailsender'>EmailSender</a> which does not require transport options.
```ts title="Signature"
interface NoopTransportOptions {
type: 'none';
}
```
<div className="members-wrapper">
### type
<MemberInfo kind="property" type={`'none'`} />
</div>
## TestingTransportOptions
<GenerationInfo sourceFile="packages/email-plugin/src/types.ts" sourceLine="267" packageName="@vendure/email-plugin" />
Forwards the raw GeneratedEmailContext object to a provided callback, for use in testing.
```ts title="Signature"
interface TestingTransportOptions {
type: 'testing';
onSend: (details: EmailDetails) => void;
}
```
<div className="members-wrapper">
### type
<MemberInfo kind="property" type={`'testing'`} />
### onSend
<MemberInfo kind="property" type={`(details: <a href='/reference/core-plugins/email-plugin/email-plugin-types#emaildetails'>EmailDetails</a>) => void`} />
Callback to be invoked when an email would be sent.
</div>
|
---
title: "DefaultVendureComplexityEstimator"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## defaultVendureComplexityEstimator
<GenerationInfo sourceFile="packages/harden-plugin/src/middleware/query-complexity-plugin.ts" sourceLine="94" packageName="@vendure/harden-plugin" />
A complexity estimator which takes into account List and PaginatedList types and can
be further configured by providing a customComplexityFactors object.
When selecting PaginatedList types, the "take" argument is used to estimate a complexity
factor. If the "take" argument is omitted, a default factor of 1000 is applied.
```ts title="Signature"
function defaultVendureComplexityEstimator(customComplexityFactors: { [path: string]: number }, logFieldScores: boolean): void
```
Parameters
### customComplexityFactors
<MemberInfo kind="parameter" type={`{ [path: string]: number }`} />
### logFieldScores
<MemberInfo kind="parameter" type={`boolean`} />
|
---
title: "HardenPluginOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## HardenPluginOptions
<GenerationInfo sourceFile="packages/harden-plugin/src/types.ts" sourceLine="9" packageName="@vendure/harden-plugin" />
Options that can be passed to the `.init()` static method of the HardenPlugin.
```ts title="Signature"
interface HardenPluginOptions {
maxQueryComplexity?: number;
queryComplexityEstimators?: ComplexityEstimator[];
logComplexityScore?: boolean;
customComplexityFactors?: {
[path: string]: number;
};
hideFieldSuggestions?: boolean;
apiMode?: 'dev' | 'prod';
}
```
<div className="members-wrapper">
### maxQueryComplexity
<MemberInfo kind="property" type={`number`} default="1000" />
Defines the maximum permitted complexity score of a query. The complexity score is based
on the number of fields being selected as well as other factors like whether there are nested
lists.
A query which exceeds the maximum score will result in an error.
### queryComplexityEstimators
<MemberInfo kind="property" type={`ComplexityEstimator[]`} />
An array of custom estimator functions for calculating the complexity of a query. By default,
the plugin will use the <a href='/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator#defaultvendurecomplexityestimator'>defaultVendureComplexityEstimator</a> which is specifically
tuned to accurately estimate Vendure queries.
### logComplexityScore
<MemberInfo kind="property" type={`boolean`} default="false" />
When set to `true`, the complexity score of each query will be logged at the Verbose
log level, and a breakdown of the calculation for each field will be logged at the Debug level.
This is very useful for tuning your complexity scores.
### customComplexityFactors
<MemberInfo kind="property" type={`{
[path: string]: number;
}`} />
This object allows you to tune the complexity weight of specific fields. For example,
if you have a custom `stockLocations` field defined on the `ProductVariant` type, and
you know that it is a particularly expensive operation to execute, you can increase
its complexity like this:
*Example*
```ts
HardenPlugin.init({
maxQueryComplexity: 650,
customComplexityFactors: {
'ProductVariant.stockLocations': 10
}
}),
```
### hideFieldSuggestions
<MemberInfo kind="property" type={`boolean`} default="true" />
Graphql-js will make suggestions about the names of fields if an invalid field name is provided.
This would allow an attacker to find out the available fields by brute force even if introspection
is disabled.
Setting this option to `true` will prevent these suggestion error messages from being returned,
instead replacing the message with a generic "Invalid request" message.
### apiMode
<MemberInfo kind="property" type={`'dev' | 'prod'`} default="'prod'" />
When set to `'prod'`, the plugin will disable dev-mode features of the GraphQL APIs:
- introspection
- GraphQL playground
</div>
|
---
title: "HardenPlugin"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## HardenPlugin
<GenerationInfo sourceFile="packages/harden-plugin/src/harden.plugin.ts" sourceLine="146" packageName="@vendure/harden-plugin" />
The HardenPlugin hardens the Shop and Admin GraphQL APIs against attacks and abuse.
- It analyzes the complexity on incoming graphql queries and rejects queries that are too complex and
could be used to overload the resources of the server.
- It disables dev-mode API features such as introspection and the GraphQL playground app.
- It removes field name suggestions to prevent trial-and-error schema sniffing.
It is a recommended plugin for all production configurations.
## Installation
`yarn add @vendure/harden-plugin`
or
`npm install @vendure/harden-plugin`
Then add the `HardenPlugin`, calling the `.init()` method with <a href='/reference/core-plugins/harden-plugin/harden-plugin-options#hardenpluginoptions'>HardenPluginOptions</a>:
*Example*
```ts
import { HardenPlugin } from '@vendure/harden-plugin';
const config: VendureConfig = {
// Add an instance of the plugin to the plugins array
plugins: [
HardenPlugin.init({
maxQueryComplexity: 650,
apiMode: process.env.APP_ENV === 'dev' ? 'dev' : 'prod',
}),
],
};
```
## Setting the max query complexity
The `maxQueryComplexity` option determines how complex a query can be. The complexity of a query relates to how many, and how
deeply-nested are the fields being selected, and is intended to roughly correspond to the amount of server resources that would
be required to resolve that query.
The goal of this setting is to prevent attacks in which a malicious actor crafts a very complex query in order to overwhelm your
server resources. Here's an example of a request which would likely overwhelm a Vendure server:
```GraphQL
query EvilQuery {
products {
items {
collections {
productVariants {
items {
product {
collections {
productVariants {
items {
product {
variants {
name
}
}
}
}
}
}
}
}
}
}
}
}
```
This evil query has a complexity score of 2,443,203 - much greater than the default of 1,000!
The complexity score is calculated by the [graphql-query-complexity library](https://www.npmjs.com/package/graphql-query-complexity),
and by default uses the <a href='/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator#defaultvendurecomplexityestimator'>defaultVendureComplexityEstimator</a>, which is tuned specifically to the Vendure Shop API.
:::caution
Note: By default, if the "take" argument is omitted from a list query (e.g. the `products` or `collections` query), a default factor of 1000 is applied.
:::
The optimal max complexity score will vary depending on:
- The requirements of your storefront and other clients using the Shop API
- The resources available to your server
You should aim to set the maximum as low as possible while still being able to service all the requests required.
This will take some manual tuning.
While tuning the max, you can turn on the `logComplexityScore` to get a detailed breakdown of the complexity of each query, as well as how
that total score is derived from its child fields:
*Example*
```ts
import { HardenPlugin } from '@vendure/harden-plugin';
const config: VendureConfig = {
// A detailed summary is logged at the "debug" level
logger: new DefaultLogger({ level: LogLevel.Debug }),
plugins: [
HardenPlugin.init({
maxQueryComplexity: 650,
logComplexityScore: true,
}),
],
};
```
With logging configured as above, the following query:
```GraphQL
query ProductList {
products(options: { take: 5 }) {
items {
id
name
featuredAsset {
preview
}
}
}
}
```
will log the following breakdown:
```sh
debug 16/12/22, 14:12 - [HardenPlugin] Calculating complexity of [ProductList]
debug 16/12/22, 14:12 - [HardenPlugin] Product.id: ID! childComplexity: 0, score: 1
debug 16/12/22, 14:12 - [HardenPlugin] Product.name: String! childComplexity: 0, score: 1
debug 16/12/22, 14:12 - [HardenPlugin] Asset.preview: String! childComplexity: 0, score: 1
debug 16/12/22, 14:12 - [HardenPlugin] Product.featuredAsset: Asset childComplexity: 1, score: 2
debug 16/12/22, 14:12 - [HardenPlugin] ProductList.items: [Product!]! childComplexity: 4, score: 20
debug 16/12/22, 14:12 - [HardenPlugin] Query.products: ProductList! childComplexity: 20, score: 35
verbose 16/12/22, 14:12 - [HardenPlugin] Query complexity [ProductList]: 35
```
```ts title="Signature"
class HardenPlugin {
static options: HardenPluginOptions;
init(options: HardenPluginOptions) => ;
}
```
<div className="members-wrapper">
### options
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/harden-plugin/harden-plugin-options#hardenpluginoptions'>HardenPluginOptions</a>`} />
### init
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/harden-plugin/harden-plugin-options#hardenpluginoptions'>HardenPluginOptions</a>) => `} />
</div>
|
---
title: "BullMQJobQueuePlugin"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## BullMQJobQueuePlugin
<GenerationInfo sourceFile="packages/job-queue-plugin/src/bullmq/plugin.ts" sourceLine="134" packageName="@vendure/job-queue-plugin" />
This plugin is a drop-in replacement of the DefaultJobQueuePlugin, which implements a push-based
job queue strategy built on top of the popular [BullMQ](https://github.com/taskforcesh/bullmq) library.
## Advantages over the DefaultJobQueuePlugin
The advantage of this approach is that jobs are stored in Redis rather than in the database. For more complex
applications with many job queues and/or multiple worker instances, this can massively reduce the load on the
DB server. The reason for this is that the DefaultJobQueuePlugin uses polling to check for new jobs. By default
it will poll every 200ms. A typical Vendure instance uses at least 3 queues (handling emails, collections, search index),
so even with a single worker instance this results in 15 queries per second to the DB constantly. Adding more
custom queues and multiple worker instances can easily result in 50 or 100 queries per second. At this point
performance may be impacted.
Using this plugin, no polling is needed, as BullMQ will _push_ jobs to the worker(s) as and when they are added
to the queue. This results in significantly more scalable performance characteristics, as well as lower latency
in processing jobs.
## Installation
`yarn add @vendure/job-queue-plugin bullmq`
or
`npm install @vendure/job-queue-plugin bullmq`
**Note:** The v1.x version of this plugin is designed to work with bullmq v1.x, etc.
*Example*
```ts
import { BullMQJobQueuePlugin } from '@vendure/job-queue-plugin/package/bullmq';
const config: VendureConfig = {
// Add an instance of the plugin to the plugins array
plugins: [
// DefaultJobQueuePlugin should be removed from the plugins array
BullMQJobQueuePlugin.init({
connection: {
port: 6379
}
}),
],
};
```
### Running Redis locally
To develop with this plugin, you'll need an instance of Redis to connect to. Here's a docker-compose config
that will set up [Redis](https://redis.io/) as well as [Redis Commander](https://github.com/joeferner/redis-commander),
which is a web-based UI for interacting with Redis:
```YAML
version: "3"
services:
redis:
image: bitnami/redis:6.2
hostname: redis
container_name: redis
environment:
- ALLOW_EMPTY_PASSWORD=yes
ports:
- "6379:6379"
redis-commander:
container_name: redis-commander
hostname: redis-commander
image: rediscommander/redis-commander:latest
environment:
- REDIS_HOSTS=local:redis:6379
ports:
- "8085:8081"
```
## Concurrency
The default concurrency of a single worker is 3, i.e. up to 3 jobs will be processed at the same time.
You can change the concurrency in the `workerOptions` passed to the `init()` method:
*Example*
```ts
const config: VendureConfig = {
plugins: [
BullMQJobQueuePlugin.init({
workerOptions: {
concurrency: 10,
},
}),
],
};
```
## Removing old jobs
By default, BullMQ will keep completed jobs in the `completed` set and failed jobs in the `failed` set. Over time,
these sets can grow very large. Since Vendure v2.1, the default behaviour is to remove jobs from these sets after
30 days or after a maximum of 5,000 completed or failed jobs.
This can be configured using the `removeOnComplete` and `removeOnFail` options:
*Example*
```ts
const config: VendureConfig = {
plugins: [
BullMQJobQueuePlugin.init({
workerOptions: {
removeOnComplete: {
count: 500,
},
removeOnFail: {
age: 60 * 60 * 24 * 7, // 7 days
count: 1000,
},
}
}),
],
};
```
The `count` option specifies the maximum number of jobs to keep in the set, while the `age` option specifies the
maximum age of a job in seconds. If both options are specified, then the jobs kept will be the ones that satisfy
both properties.
```ts title="Signature"
class BullMQJobQueuePlugin {
static options: BullMQPluginOptions;
init(options: BullMQPluginOptions) => ;
}
```
<div className="members-wrapper">
### options
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/job-queue-plugin/bull-mqplugin-options#bullmqpluginoptions'>BullMQPluginOptions</a>`} />
### init
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/job-queue-plugin/bull-mqplugin-options#bullmqpluginoptions'>BullMQPluginOptions</a>) => `} />
Configures the plugin.
</div>
|
---
title: "BullMQJobQueueStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## BullMQJobQueueStrategy
<GenerationInfo sourceFile="packages/job-queue-plugin/src/bullmq/bullmq-job-queue-strategy.ts" sourceLine="42" packageName="@vendure/job-queue-plugin" />
This JobQueueStrategy uses [BullMQ](https://docs.bullmq.io/) to implement a push-based job queue
on top of Redis. It should not be used alone, but as part of the <a href='/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin'>BullMQJobQueuePlugin</a>.
```ts title="Signature"
class BullMQJobQueueStrategy implements InspectableJobQueueStrategy {
init(injector: Injector) => Promise<void>;
destroy() => ;
add(job: Job<Data>) => Promise<Job<Data>>;
cancelJob(jobId: string) => Promise<Job | undefined>;
findMany(options?: JobListOptions) => Promise<PaginatedList<Job>>;
findManyById(ids: ID[]) => Promise<Job[]>;
findOne(id: ID) => Promise<Job | undefined>;
removeSettledJobs(queueNames?: string[], olderThan?: Date) => Promise<number>;
start(queueName: string, process: (job: Job<Data>) => Promise<any>) => Promise<void>;
stop(queueName: string, process: (job: Job<Data>) => Promise<any>) => Promise<void>;
}
```
* Implements: <code><a href='/reference/typescript-api/job-queue/inspectable-job-queue-strategy#inspectablejobqueuestrategy'>InspectableJobQueueStrategy</a></code>
<div className="members-wrapper">
### init
<MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>) => Promise<void>`} />
### destroy
<MemberInfo kind="method" type={`() => `} />
### add
<MemberInfo kind="method" type={`(job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>>`} />
### cancelJob
<MemberInfo kind="method" type={`(jobId: string) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined>`} />
### findMany
<MemberInfo kind="method" type={`(options?: JobListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/job-queue/job#job'>Job</a>>>`} />
### findManyById
<MemberInfo kind="method" type={`(ids: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a>[]>`} />
### findOne
<MemberInfo kind="method" type={`(id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/job-queue/job#job'>Job</a> | undefined>`} />
### removeSettledJobs
<MemberInfo kind="method" type={`(queueNames?: string[], olderThan?: Date) => Promise<number>`} />
### start
<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<any>) => Promise<void>`} />
### stop
<MemberInfo kind="method" type={`(queueName: string, process: (job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a><Data>) => Promise<any>) => Promise<void>`} />
</div>
|
---
title: "BullMQPluginOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## BullMQPluginOptions
<GenerationInfo sourceFile="packages/job-queue-plugin/src/bullmq/types.ts" sourceLine="14" packageName="@vendure/job-queue-plugin" since="1.2.0" />
Configuration options for the <a href='/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin#bullmqjobqueueplugin'>BullMQJobQueuePlugin</a>.
```ts title="Signature"
interface BullMQPluginOptions {
connection?: ConnectionOptions;
queueOptions?: Omit<QueueOptions, 'connection'>;
workerOptions?: Omit<WorkerOptions, 'connection'>;
setRetries?: (queueName: string, job: Job) => number;
setBackoff?: (queueName: string, job: Job) => BackoffOptions | undefined;
}
```
<div className="members-wrapper">
### connection
<MemberInfo kind="property" type={`ConnectionOptions`} />
Connection options which will be passed directly to BullMQ when
creating a new Queue, Worker and Scheduler instance.
If omitted, it will attempt to connect to Redis at `127.0.0.1:6379`.
### queueOptions
<MemberInfo kind="property" type={`Omit<QueueOptions, 'connection'>`} />
Additional options used when instantiating the BullMQ
Queue instance.
See the [BullMQ QueueOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.queueoptions.md)
### workerOptions
<MemberInfo kind="property" type={`Omit<WorkerOptions, 'connection'>`} />
Additional options used when instantiating the BullMQ
Worker instance.
See the [BullMQ WorkerOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.workeroptions.md)
### setRetries
<MemberInfo kind="property" type={`(queueName: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => number`} since="1.3.0" />
When a job is added to the JobQueue using `JobQueue.add()`, the calling
code may specify the number of retries in case of failure. This option allows
you to override that number and specify your own number of retries based on
the job being added.
*Example*
```ts
setRetries: (queueName, job) => {
if (queueName === 'send-email') {
// Override the default number of retries
// for the 'send-email' job because we have
// a very unreliable email service.
return 10;
}
return job.retries;
}
```
### setBackoff
<MemberInfo kind="property" type={`(queueName: string, job: <a href='/reference/typescript-api/job-queue/job#job'>Job</a>) => <a href='/reference/core-plugins/job-queue-plugin/bull-mqplugin-options#backoffoptions'>BackoffOptions</a> | undefined`} default="'exponential', 1000" since="1.3.0" />
This allows you to specify the backoff settings when a failed job gets retried.
In other words, this determines how much time should pass before attempting to
process the failed job again. If the function returns `undefined`, the default
value of exponential/1000ms will be used.
*Example*
```ts
setBackoff: (queueName, job) => {
return {
type: 'exponential', // or 'fixed'
delay: 10000 // first retry after 10s, second retry after 20s, 40s,...
};
}
```
</div>
## BackoffOptions
<GenerationInfo sourceFile="packages/job-queue-plugin/src/bullmq/types.ts" sourceLine="91" packageName="@vendure/job-queue-plugin" since="1.3.0" />
Configuration for the backoff function when retrying failed jobs.
```ts title="Signature"
interface BackoffOptions {
type: 'exponential' | 'fixed';
delay: number;
}
```
<div className="members-wrapper">
### type
<MemberInfo kind="property" type={`'exponential' | 'fixed'`} />
### delay
<MemberInfo kind="property" type={`number`} />
</div>
|
---
title: "Job Queue Plugin"
isDefaultIndex: true
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
import DocCardList from '@theme/DocCardList';
<DocCardList /> |
---
title: "BraintreePlugin"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## BraintreePlugin
<GenerationInfo sourceFile="packages/payments-plugin/src/braintree/braintree.plugin.ts" sourceLine="241" packageName="@vendure/payments-plugin" />
This plugin enables payments to be processed by [Braintree](https://www.braintreepayments.com/), a popular payment provider.
## Requirements
1. You will need to create a Braintree sandbox account as outlined in https://developers.braintreepayments.com/start/overview.
2. Then install `braintree` and `@types/braintree` from npm. This plugin was written with `v3.x` of the Braintree lib.
```shell
yarn add @vendure/payments-plugin braintree
yarn add -D @types/braintree
```
or
```shell
npm install @vendure/payments-plugin braintree
npm install -D @types/braintree
```
## Setup
1. Add the plugin to your VendureConfig `plugins` array:
```ts
import { BraintreePlugin } from '@vendure/payments-plugin/package/braintree';
import { Environment } from 'braintree';
// ...
plugins: [
BraintreePlugin.init({
environment: Environment.Sandbox,
// This allows saving customer payment
// methods with Braintree (see "vaulting"
// section below for details)
storeCustomersInBraintree: true,
}),
]
```
2. Create a new PaymentMethod in the Admin UI, and select "Braintree payments" as the handler.
2. Fill in the `Merchant ID`, `Public Key` & `Private Key` from your Braintree sandbox account.
## Storefront usage
The plugin is designed to work with the [Braintree drop-in UI](https://developers.braintreepayments.com/guides/drop-in/overview/javascript/v3).
This is a library provided by Braintree which will handle the payment UI for you. You can install it in your storefront project
with:
```shell
yarn add braintree-web-drop-in
# or
npm install braintree-web-drop-in
```
The high-level workflow is:
1. Generate a "client token" on the server by executing the `generateBraintreeClientToken` mutation which is exposed by this plugin.
2. Use this client token to instantiate the Braintree Dropin UI.
3. Listen for the `"paymentMethodRequestable"` event which emitted by the Dropin.
4. Use the Dropin's `requestPaymentMethod()` method to get the required payment metadata.
5. Pass that metadata to the `addPaymentToOrder` mutation. The metadata should be an object of type `{ nonce: string; }`
Here is an example of how your storefront code will look. Note that this example is attempting to
be framework-agnostic, so you'll need to adapt it to fit to your framework of choice.
```ts
// The Braintree Dropin instance
let dropin: import('braintree-web-drop-in').Dropin;
// Used to show/hide a "submit" button, which would be bound to the
// `submitPayment()` method below.
let showSubmitButton = false;
// Used to display a "processing..." spinner
let processing = false;
//
// This method would be invoked when the payment screen is mounted/created.
//
async function renderDropin(order: Order, clientToken: string) {
// Lazy load braintree dropin because it has a reference
// to `window` which breaks SSR
dropin = await import('braintree-web-drop-in').then((module) =>
module.default.create({
authorization: clientToken,
// This assumes a div in your view with the corresponding ID
container: '#dropin-container',
card: {
cardholderName: {
required: true,
},
overrides: {},
},
// Additional config is passed here depending on
// which payment methods you have enabled in your
// Braintree account.
paypal: {
flow: 'checkout',
amount: order.totalWithTax / 100,
currency: 'GBP',
},
}),
);
// If you are using the `storeCustomersInBraintree` option, then the
// customer might already have a stored payment method selected as
// soon as the dropin script loads. In this case, show the submit
// button immediately.
if (dropin.isPaymentMethodRequestable()) {
showSubmitButton = true;
}
dropin.on('paymentMethodRequestable', (payload) => {
if (payload.type === 'CreditCard') {
showSubmitButton = true;
}
if (payload.type === 'PayPalAccount') {
this.submitPayment();
}
});
dropin.on('noPaymentMethodRequestable', () => {
// Display an error
});
}
async function generateClientToken() {
const { generateBraintreeClientToken } = await graphQlClient.query(gql`
query GenerateBraintreeClientToken {
generateBraintreeClientToken
}
`);
return generateBraintreeClientToken;
}
async submitPayment() {
if (!dropin.isPaymentMethodRequestable()) {
return;
}
showSubmitButton = false;
processing = true;
const paymentResult = await dropin.requestPaymentMethod();
const { addPaymentToOrder } = await graphQlClient.query(gql`
mutation AddPayment($input: PaymentInput!) {
addPaymentToOrder(input: $input) {
... on Order {
id
payments {
id
amount
errorMessage
method
state
transactionId
createdAt
}
}
... on ErrorResult {
errorCode
message
}
}
}`, {
input: {
method: 'braintree', // The code of you Braintree PaymentMethod
metadata: paymentResult,
},
},
);
switch (addPaymentToOrder?.__typename) {
case 'Order':
// Adding payment succeeded!
break;
case 'OrderStateTransitionError':
case 'OrderPaymentStateError':
case 'PaymentDeclinedError':
case 'PaymentFailedError':
// Display an error to the customer
dropin.clearSelectedPaymentMethod();
}
}
```
## Storing payment details (vaulting)
Braintree has a [vault feature](https://developer.paypal.com/braintree/articles/control-panel/vault/overview) which allows the secure storage
of customer's payment information. Using the vault allows you to offer a faster checkout for repeat customers without needing to worry about
how to securely store payment details.
To enable this feature, set the `storeCustomersInBraintree` option to `true`.
```ts
BraintreePlugin.init({
environment: Environment.Sandbox,
storeCustomersInBraintree: true,
}),
```
Since v1.8, it is possible to override vaulting on a per-payment basis by passing `includeCustomerId: false` to the `generateBraintreeClientToken`
mutation:
```GraphQL
const { generateBraintreeClientToken } = await graphQlClient.query(gql`
query GenerateBraintreeClientToken($includeCustomerId: Boolean) {
generateBraintreeClientToken(includeCustomerId: $includeCustomerId)
}
`, { includeCustomerId: false });
```
as well as in the metadata of the `addPaymentToOrder` mutation:
```ts
const { addPaymentToOrder } = await graphQlClient.query(gql`
mutation AddPayment($input: PaymentInput!) {
addPaymentToOrder(input: $input) {
...Order
...ErrorResult
}
}`, {
input: {
method: 'braintree',
metadata: {
...paymentResult,
includeCustomerId: false,
},
}
);
```
```ts title="Signature"
class BraintreePlugin {
static options: BraintreePluginOptions = {};
init(options: BraintreePluginOptions) => Type<BraintreePlugin>;
}
```
<div className="members-wrapper">
### options
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreepluginoptions'>BraintreePluginOptions</a>`} />
### init
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreepluginoptions'>BraintreePluginOptions</a>) => Type<<a href='/reference/core-plugins/payments-plugin/braintree-plugin#braintreeplugin'>BraintreePlugin</a>>`} />
</div>
## BraintreePluginOptions
<GenerationInfo sourceFile="packages/payments-plugin/src/braintree/types.ts" sourceLine="25" packageName="@vendure/payments-plugin" />
Options for the Braintree plugin.
```ts title="Signature"
interface BraintreePluginOptions {
environment?: Environment;
storeCustomersInBraintree?: boolean;
extractMetadata?: (transaction: Transaction) => PaymentMetadata;
}
```
<div className="members-wrapper">
### environment
<MemberInfo kind="property" type={`Environment`} default="Environment.Sandbox" />
The Braintree environment being targeted, e.g. sandbox or production.
### storeCustomersInBraintree
<MemberInfo kind="property" type={`boolean`} default="false" />
If set to `true`, a [Customer](https://developer.paypal.com/braintree/docs/guides/customers) object
will be created in Braintree, which allows the secure storage ("vaulting") of previously-used payment methods.
This is done by adding a custom field to the Customer entity to store the Braintree customer ID,
so switching this on will require a database migration / synchronization.
Since v1.8, it is possible to override vaulting on a per-payment basis by passing `includeCustomerId: false` to the
`generateBraintreeClientToken` mutation.
### extractMetadata
<MemberInfo kind="property" type={`(transaction: <a href='/reference/typescript-api/request/transaction-decorator#transaction'>Transaction</a>) => PaymentMetadata`} since="1.7.0" />
Allows you to configure exactly what information from the Braintree
[Transaction object](https://developer.paypal.com/braintree/docs/reference/response/transaction#result-object) (which is returned by the
`transaction.sale()` method of the SDK) should be persisted to the resulting Payment entity metadata.
By default, the built-in extraction function will return a metadata object that looks like this:
*Example*
```ts
const metadata = {
"status": "settling",
"currencyIsoCode": "GBP",
"merchantAccountId": "my_account_id",
"cvvCheck": "Not Applicable",
"avsPostCodeCheck": "Not Applicable",
"avsStreetAddressCheck": "Not Applicable",
"processorAuthorizationCode": null,
"processorResponseText": "Approved",
// for Paypal payments
"paymentMethod": "paypal_account",
"paypalData": {
"payerEmail": "michael-buyer@paypalsandbox.com",
"paymentId": "PAYID-MLCXYNI74301746XK8807043",
"authorizationId": "3BU93594D85624939",
"payerStatus": "VERIFIED",
"sellerProtectionStatus": "ELIGIBLE",
"transactionFeeAmount": "0.54"
},
// for credit card payments
"paymentMethod": "credit_card",
"cardData": {
"cardType": "MasterCard",
"last4": "5454",
"expirationDate": "02/2023"
}
// publicly-available metadata that will be
// readable from the Shop API
"public": {
"cardData": {
"cardType": "MasterCard",
"last4": "5454",
"expirationDate": "02/2023"
},
"paypalData": {
"authorizationId": "3BU93594D85624939",
}
}
}
```
</div>
|
---
title: "Payments Plugin"
isDefaultIndex: true
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
import DocCardList from '@theme/DocCardList';
<DocCardList /> |
---
title: "MolliePlugin"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## MolliePlugin
<GenerationInfo sourceFile="packages/payments-plugin/src/mollie/mollie.plugin.ts" sourceLine="192" packageName="@vendure/payments-plugin" />
Plugin to enable payments through the [Mollie platform](https://docs.mollie.com/).
This plugin uses the Order API from Mollie, not the Payments API.
## Requirements
1. You will need to create a Mollie account and get your apiKey in the dashboard.
2. Install the Payments plugin and the Mollie client:
`yarn add @vendure/payments-plugin @mollie/api-client`
or
`npm install @vendure/payments-plugin @mollie/api-client`
## Setup
1. Add the plugin to your VendureConfig `plugins` array:
```ts
import { MolliePlugin } from '@vendure/payments-plugin/package/mollie';
// ...
plugins: [
MolliePlugin.init({ vendureHost: 'https://yourhost.io/' }),
]
```
2. Run a database migration to add the `mollieOrderId` custom field to the order entity.
3. Create a new PaymentMethod in the Admin UI, and select "Mollie payments" as the handler.
4. Set your Mollie apiKey in the `API Key` field.
5. Set the `Fallback redirectUrl` to the url that the customer should be redirected to after completing the payment.
You can override this url by passing the `redirectUrl` as an argument to the `createMolliePaymentIntent` mutation.
## Storefront usage
In your storefront you add a payment to an order using the `createMolliePaymentIntent` mutation. In this example, our Mollie
PaymentMethod was given the code "mollie-payment-method". The `redirectUrl``is the url that is used to redirect the end-user
back to your storefront after completing the payment.
```GraphQL
mutation CreateMolliePaymentIntent {
createMolliePaymentIntent(input: {
redirectUrl: "https://storefront/order/1234XYZ"
paymentMethodCode: "mollie-payment-method"
molliePaymentMethodCode: "ideal"
}) {
... on MolliePaymentIntent {
url
}
... on MolliePaymentIntentError {
errorCode
message
}
}
}
```
The response will contain
a redirectUrl, which can be used to redirect your customer to the Mollie
platform.
'molliePaymentMethodCode' is an optional parameter that can be passed to skip Mollie's hosted payment method selection screen
You can get available Mollie payment methods with the following query:
```GraphQL
{
molliePaymentMethods(input: { paymentMethodCode: "mollie-payment-method" }) {
id
code
description
minimumAmount {
value
currency
}
maximumAmount {
value
currency
}
image {
size1x
size2x
svg
}
}
}
```
You can pass `creditcard` for example, to the `createMolliePaymentIntent` mutation to skip the method selection.
After completing payment on the Mollie platform,
the user is redirected to the given redirect url, e.g. `https://storefront/order/CH234X5`
## Pay later methods
Mollie supports pay-later methods like 'Klarna Pay Later'. For pay-later methods, the status of an order is
'PaymentAuthorized' after the Mollie hosted checkout. You need to manually settle the payment via the admin ui to capture the payment!
Make sure you capture a payment within 28 days, because this is the Klarna expiry time
If you don't want this behaviour (Authorized first), you can set 'autoCapture=true' on the payment method. This option will immediately
capture the payment after a customer authorizes the payment.
## ArrangingAdditionalPayment state
In some rare cases, a customer can add items to the active order, while a Mollie payment is still open,
for example by opening your storefront in another browser tab.
This could result in an order being in `ArrangingAdditionalPayment` status after the customer finished payment.
You should check if there is still an active order with status `ArrangingAdditionalPayment` on your order confirmation page,
and if so, allow your customer to pay for the additional items by creating another Mollie payment.
```ts title="Signature"
class MolliePlugin {
static options: MolliePluginOptions;
init(options: MolliePluginOptions) => typeof MolliePlugin;
}
```
<div className="members-wrapper">
### options
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/payments-plugin/mollie-plugin#molliepluginoptions'>MolliePluginOptions</a>`} />
### init
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/mollie-plugin#molliepluginoptions'>MolliePluginOptions</a>) => typeof <a href='/reference/core-plugins/payments-plugin/mollie-plugin#mollieplugin'>MolliePlugin</a>`} />
Initialize the mollie payment plugin
</div>
## MolliePluginOptions
<GenerationInfo sourceFile="packages/payments-plugin/src/mollie/mollie.plugin.ts" sourceLine="29" packageName="@vendure/payments-plugin" />
Configuration options for the Mollie payments plugin.
```ts title="Signature"
interface MolliePluginOptions {
vendureHost: string;
enabledPaymentMethodsParams?: (
injector: Injector,
ctx: RequestContext,
order: Order | null,
) => AdditionalEnabledPaymentMethodsParams | Promise<AdditionalEnabledPaymentMethodsParams>;
}
```
<div className="members-wrapper">
### vendureHost
<MemberInfo kind="property" type={`string`} />
The host of your Vendure server, e.g. `'https://my-vendure.io'`.
This is used by Mollie to send webhook events to the Vendure server
### enabledPaymentMethodsParams
<MemberInfo kind="property" type={`(
injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,
ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,
order: <a href='/reference/typescript-api/entities/order#order'>Order</a> | null,
) => AdditionalEnabledPaymentMethodsParams | Promise<AdditionalEnabledPaymentMethodsParams>`} since="2.2.0" />
Provide additional parameters to the Mollie enabled payment methods API call. By default,
the plugin will already pass the `resource` parameter.
For example, if you want to provide a `locale` and `billingCountry` for the API call, you can do so like this:
**Note:** The `order` argument is possibly `null`, this could happen when you fetch the available payment methods
before the order is created.
*Example*
```ts
import { VendureConfig } from '@vendure/core';
import { MolliePlugin, getLocale } from '@vendure/payments-plugin/package/mollie';
export const config: VendureConfig = {
// ...
plugins: [
MolliePlugin.init({
enabledPaymentMethodsParams: (injector, ctx, order) => {
const locale = order?.billingAddress?.countryCode
? getLocale(order.billingAddress.countryCode, ctx.languageCode)
: undefined;
return {
locale,
billingCountry: order?.billingAddress?.countryCode,
},
}
}),
],
};
```
</div>
|
---
title: "StripePlugin"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## StripePlugin
<GenerationInfo sourceFile="packages/payments-plugin/src/stripe/stripe.plugin.ts" sourceLine="161" packageName="@vendure/payments-plugin" />
Plugin to enable payments through [Stripe](https://stripe.com/docs) via the Payment Intents API.
## Requirements
1. You will need to create a Stripe account and get your secret key in the dashboard.
2. Create a webhook endpoint in the Stripe dashboard (Developers -> Webhooks, "Add an endpoint") which listens to the `payment_intent.succeeded`
and `payment_intent.payment_failed` events. The URL should be `https://my-server.com/payments/stripe`, where
`my-server.com` is the host of your Vendure server. *Note:* for local development, you'll need to use
the Stripe CLI to test your webhook locally. See the _local development_ section below.
3. Get the signing secret for the newly created webhook.
4. Install the Payments plugin and the Stripe Node library:
`yarn add @vendure/payments-plugin stripe`
or
`npm install @vendure/payments-plugin stripe`
## Setup
1. Add the plugin to your VendureConfig `plugins` array:
```ts
import { StripePlugin } from '@vendure/payments-plugin/package/stripe';
// ...
plugins: [
StripePlugin.init({
// This prevents different customers from using the same PaymentIntent
storeCustomersInStripe: true,
}),
]
````
For all the plugin options, see the <a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions'>StripePluginOptions</a> type.
2. Create a new PaymentMethod in the Admin UI, and select "Stripe payments" as the handler.
3. Set the webhook secret and API key in the PaymentMethod form.
## Storefront usage
The plugin is designed to work with the [Custom payment flow](https://stripe.com/docs/payments/accept-a-payment?platform=web&ui=elements).
In this flow, Stripe provides libraries which handle the payment UI and confirmation for you. You can install it in your storefront project
with:
```shell
yarn add @stripe/stripe-js
# or
npm install @stripe/stripe-js
```
If you are using React, you should also consider installing `@stripe/react-stripe-js`, which is a wrapper around Stripe Elements.
The high-level workflow is:
1. Create a "payment intent" on the server by executing the `createStripePaymentIntent` mutation which is exposed by this plugin.
2. Use the returned client secret to instantiate the Stripe Payment Element:
```ts
import { Elements } from '@stripe/react-stripe-js';
import { loadStripe, Stripe } from '@stripe/stripe-js';
import { CheckoutForm } from './CheckoutForm';
const stripePromise = getStripe('pk_test_....wr83u');
type StripePaymentsProps = {
clientSecret: string;
orderCode: string;
}
export function StripePayments({ clientSecret, orderCode }: StripePaymentsProps) {
const options = {
// passing the client secret obtained from the server
clientSecret,
}
return (
<Elements stripe={stripePromise} options={options}>
<CheckoutForm orderCode={orderCode} />
</Elements>
);
}
```
```ts
// CheckoutForm.tsx
import { useStripe, useElements, PaymentElement } from '@stripe/react-stripe-js';
import { FormEvent } from 'react';
export const CheckoutForm = ({ orderCode }: { orderCode: string }) => {
const stripe = useStripe();
const elements = useElements();
const handleSubmit = async (event: FormEvent) => {
// We don't want to let default form submission happen here,
// which would refresh the page.
event.preventDefault();
if (!stripe || !elements) {
// Stripe.js has not yet loaded.
// Make sure to disable form submission until Stripe.js has loaded.
return;
}
const result = await stripe.confirmPayment({
//`Elements` instance that was used to create the Payment Element
elements,
confirmParams: {
return_url: location.origin + `/checkout/confirmation/${orderCode}`,
},
});
if (result.error) {
// Show error to your customer (for example, payment details incomplete)
console.log(result.error.message);
} else {
// Your customer will be redirected to your `return_url`. For some payment
// methods like iDEAL, your customer will be redirected to an intermediate
// site first to authorize the payment, then redirected to the `return_url`.
}
};
return (
<form onSubmit={handleSubmit}>
<PaymentElement />
<button disabled={!stripe}>Submit</button>
</form>
);
};
```
3. Once the form is submitted and Stripe processes the payment, the webhook takes care of updating the order without additional action
in the storefront. As in the code above, the customer will be redirected to `/checkout/confirmation/${orderCode}`.
:::info
A full working storefront example of the Stripe integration can be found in the
[Remix Starter repo](https://github.com/vendure-ecommerce/storefront-remix-starter/tree/master/app/components/checkout/stripe)
:::
## Local development
1. Download & install the Stripe CLI: https://stripe.com/docs/stripe-cli
2. From your Stripe dashboard, go to Developers -> Webhooks and click "Add an endpoint" and follow the instructions
under "Test in a local environment".
3. The Stripe CLI command will look like
```shell
stripe listen --forward-to localhost:3000/payments/stripe
```
4. The Stripe CLI will create a webhook signing secret you can then use in your config of the StripePlugin.
```ts title="Signature"
class StripePlugin {
static options: StripePluginOptions;
init(options: StripePluginOptions) => Type<StripePlugin>;
}
```
<div className="members-wrapper">
### options
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions'>StripePluginOptions</a>`} />
### init
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripepluginoptions'>StripePluginOptions</a>) => Type<<a href='/reference/core-plugins/payments-plugin/stripe-plugin#stripeplugin'>StripePlugin</a>>`} />
Initialize the Stripe payment plugin
</div>
## StripePluginOptions
<GenerationInfo sourceFile="packages/payments-plugin/src/stripe/types.ts" sourceLine="27" packageName="@vendure/payments-plugin" />
Configuration options for the Stripe payments plugin.
```ts title="Signature"
interface StripePluginOptions {
storeCustomersInStripe?: boolean;
metadata?: (
injector: Injector,
ctx: RequestContext,
order: Order,
) => Stripe.MetadataParam | Promise<Stripe.MetadataParam>;
paymentIntentCreateParams?: (
injector: Injector,
ctx: RequestContext,
order: Order,
) => AdditionalPaymentIntentCreateParams | Promise<AdditionalPaymentIntentCreateParams>;
customerCreateParams?: (
injector: Injector,
ctx: RequestContext,
order: Order,
) => AdditionalCustomerCreateParams | Promise<AdditionalCustomerCreateParams>;
}
```
<div className="members-wrapper">
### storeCustomersInStripe
<MemberInfo kind="property" type={`boolean`} default="false" />
If set to `true`, a [Customer](https://stripe.com/docs/api/customers) object will be created in Stripe - if
it doesn't already exist - for authenticated users, which prevents payment methods attached to other Customers
to be used with the same PaymentIntent. This is done by adding a custom field to the Customer entity to store
the Stripe customer ID, so switching this on will require a database migration / synchronization.
### metadata
<MemberInfo kind="property" type={`(
injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,
ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,
order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,
) => Stripe.MetadataParam | Promise<Stripe.MetadataParam>`} since="1.9.7" />
Attach extra metadata to Stripe payment intent creation call.
*Example*
```ts
import { EntityHydrator, VendureConfig } from '@vendure/core';
import { StripePlugin } from '@vendure/payments-plugin/package/stripe';
export const config: VendureConfig = {
// ...
plugins: [
StripePlugin.init({
metadata: async (injector, ctx, order) => {
const hydrator = injector.get(EntityHydrator);
await hydrator.hydrate(ctx, order, { relations: ['customer'] });
return {
description: `Order #${order.code} for ${order.customer!.emailAddress}`
},
}
}),
],
};
```
Note: If the `paymentIntentCreateParams` is also used and returns a `metadata` key, then the values
returned by both functions will be merged.
### paymentIntentCreateParams
<MemberInfo kind="property" type={`(
injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,
ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,
order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,
) => AdditionalPaymentIntentCreateParams | Promise<AdditionalPaymentIntentCreateParams>`} since="2.1.0" />
Provide additional parameters to the Stripe payment intent creation. By default,
the plugin will already pass the `amount`, `currency`, `customer` and `automatic_payment_methods: { enabled: true }` parameters.
For example, if you want to provide a `description` for the payment intent, you can do so like this:
*Example*
```ts
import { VendureConfig } from '@vendure/core';
import { StripePlugin } from '@vendure/payments-plugin/package/stripe';
export const config: VendureConfig = {
// ...
plugins: [
StripePlugin.init({
paymentIntentCreateParams: (injector, ctx, order) => {
return {
description: `Order #${order.code} for ${order.customer?.emailAddress}`
},
}
}),
],
};
```
### customerCreateParams
<MemberInfo kind="property" type={`(
injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>,
ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>,
order: <a href='/reference/typescript-api/entities/order#order'>Order</a>,
) => AdditionalCustomerCreateParams | Promise<AdditionalCustomerCreateParams>`} since="2.1.0" />
Provide additional parameters to the Stripe customer creation. By default,
the plugin will already pass the `email` and `name` parameters.
For example, if you want to provide an address for the customer:
*Example*
```ts
import { EntityHydrator, VendureConfig } from '@vendure/core';
import { StripePlugin } from '@vendure/payments-plugin/package/stripe';
export const config: VendureConfig = {
// ...
plugins: [
StripePlugin.init({
storeCustomersInStripe: true,
customerCreateParams: async (injector, ctx, order) => {
const entityHydrator = injector.get(EntityHydrator);
const customer = order.customer;
await entityHydrator.hydrate(ctx, customer, { relations: ['addresses'] });
const defaultBillingAddress = customer.addresses.find(a => a.defaultBillingAddress) ?? customer.addresses[0];
return {
address: {
line1: defaultBillingAddress.streetLine1 || order.shippingAddress?.streetLine1,
postal_code: defaultBillingAddress.postalCode || order.shippingAddress?.postalCode,
city: defaultBillingAddress.city || order.shippingAddress?.city,
state: defaultBillingAddress.province || order.shippingAddress?.province,
country: defaultBillingAddress.country.code || order.shippingAddress?.countryCode,
},
},
}
}),
],
};
```
</div>
|
---
title: "SentryPlugin"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## SentryPlugin
<GenerationInfo sourceFile="packages/sentry-plugin/src/sentry-plugin.ts" sourceLine="108" packageName="@vendure/sentry-plugin" />
This plugin integrates the [Sentry](https://sentry.io) error tracking & performance monitoring
service with your Vendure server. In addition to capturing errors, it also provides built-in
support for [tracing](https://docs.sentry.io/product/sentry-basics/concepts/tracing/) as well as
enriching your Sentry events with additional context about the request.
## Pre-requisites
This plugin depends on access to Sentry, which can be self-hosted or used as a cloud service.
If using the hosted SaaS option, you must have a Sentry account and a project set up ([sign up here](https://sentry.io/signup/)). When setting up your project,
select the "Node.js" platform and no framework.
Once set up, you will be given a [Data Source Name (DSN)](https://docs.sentry.io/product/sentry-basics/concepts/dsn-explainer/)
which you will need to provide to the plugin.
## Installation
Install this plugin as well as the `@sentry/node` package:
```sh
npm install --save @vendure/sentry-plugin @sentry/node
```
## Configuration
Before using the plugin, you must configure it with the DSN provided by Sentry:
```ts
import { VendureConfig } from '@vendure/core';
import { SentryPlugin } from '@vendure/sentry-plugin';
export const config: VendureConfig = {
// ...
plugins: [
// ...
// highlight-start
SentryPlugin.init({
dsn: process.env.SENTRY_DSN,
// Optional configuration
includeErrorTestMutation: true,
enableTracing: true,
// you can also pass in any of the options from @sentry/node
// for instance:
tracesSampleRate: 1.0,
}),
// highlight-end
],
};
```
## Tracing
This plugin includes built-in support for [tracing](https://docs.sentry.io/product/sentry-basics/concepts/tracing/), which allows you to see the performance of your
GraphQL resolvers in the Sentry dashboard. To enable tracing, set the `enableTracing` option to `true` as shown above.
## Instrumenting your own code
You may want to add your own custom spans to your code. To do so, you can use the `Sentry` object
just as you would in any Node application. For example:
```ts
import * as Sentry from "@sentry/node";
export class MyService {
async myMethod() {
Sentry.setContext('My Custom Context,{
key: 'value',
});
}
}
```
## Error test mutation
To test whether your Sentry configuration is working correctly, you can set the `includeErrorTestMutation` option to `true`. This will add a mutation to the Admin API
which will throw an error of the type specified in the `errorType` argument. For example:
```graphql
mutation CreateTestError {
createTestError(errorType: DATABASE_ERROR)
}
```
You should then be able to see the error in your Sentry dashboard (it may take a couple of minutes to appear).
```ts title="Signature"
class SentryPlugin implements NestModule {
static options: SentryPluginOptions = {} as any;
configure(consumer: MiddlewareConsumer) => any;
init(options: SentryPluginOptions) => ;
}
```
* Implements: <code>NestModule</code>
<div className="members-wrapper">
### options
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/sentry-plugin/sentry-plugin-options#sentrypluginoptions'>SentryPluginOptions</a>`} />
### configure
<MemberInfo kind="method" type={`(consumer: MiddlewareConsumer) => any`} />
### init
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/sentry-plugin/sentry-plugin-options#sentrypluginoptions'>SentryPluginOptions</a>) => `} />
</div>
|
---
title: "SentryPluginOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## SentryPluginOptions
<GenerationInfo sourceFile="packages/sentry-plugin/src/types.ts" sourceLine="12" packageName="@vendure/sentry-plugin" />
Configuration options for the <a href='/reference/core-plugins/sentry-plugin/#sentryplugin'>SentryPlugin</a>.
```ts title="Signature"
interface SentryPluginOptions extends NodeOptions {
dsn: string;
enableTracing?: boolean;
includeErrorTestMutation?: boolean;
}
```
* Extends: <code>NodeOptions</code>
<div className="members-wrapper">
### dsn
<MemberInfo kind="property" type={`string`} />
The [Data Source Name](https://docs.sentry.io/product/sentry-basics/concepts/dsn-explainer/) for your Sentry instance.
### enableTracing
<MemberInfo kind="property" type={`boolean`} />
### includeErrorTestMutation
<MemberInfo kind="property" type={`boolean`} />
</div>
|
---
title: "StellatePlugin"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## StellatePlugin
<GenerationInfo sourceFile="packages/stellate-plugin/src/stellate-plugin.ts" sourceLine="246" packageName="@vendure/stellate-plugin" since="2.1.5" />
A plugin to integrate the [Stellate](https://stellate.co/) GraphQL caching service with your Vendure server.
The main purpose of this plugin is to ensure that cached data gets correctly purged in
response to events inside Vendure. For example, changes to a Product's description should
purge any associated record for that Product in Stellate's cache.
## Pre-requisites
You will first need to [set up a free Stellate account](https://stellate.co/signup).
You will also need to generate an **API token** for the Stellate Purging API. For instructions on how to generate the token,
see the [Stellate Purging API docs](https://docs.stellate.co/docs/purging-api#authentication).
## Installation
```
npm install @vendure/stellate-plugin
```
## Configuration
The plugin is configured via the `StellatePlugin.init()` method. This method accepts an options object
which defines the Stellate service name and API token, as well as an array of <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a>s which
define how the plugin will respond to Vendure events in order to trigger calls to the
Stellate [Purging API](https://stellate.co/docs/graphql-edge-cache/purging-api).
*Example*
```ts
import { StellatePlugin, defaultPurgeRules } from '@vendure/stellate-plugin';
import { VendureConfig } from '@vendure/core';
export const config: VendureConfig = {
// ...
plugins: [
StellatePlugin.init({
// The Stellate service name, i.e. `<serviceName>.stellate.sh`
serviceName: 'my-service',
// The API token for the Stellate Purging API. See the "pre-requisites" section above.
apiToken: process.env.STELLATE_PURGE_API_TOKEN,
devMode: !isProd || process.env.STELLATE_DEBUG_MODE ? true : false,
debugLogging: process.env.STELLATE_DEBUG_MODE ? true : false,
purgeRules: [
...defaultPurgeRules,
// custom purge rules can be added here
],
}),
],
};
```
In your Stellate dashboard, you can use the following configuration example as a sensible default for a
Vendure application:
*Example*
```ts
import { Config } from "stellate";
const config: Config = {
config: {
name: "my-vendure-server",
originUrl: "https://my-vendure-server.com/shop-api",
ignoreOriginCacheControl: true,
passThroughOnly: false,
scopes: {
SESSION_BOUND: "header:authorization|cookie:session",
},
headers: {
"access-control-expose-headers": "vendure-auth-token",
},
rootTypeNames: {
query: "Query",
mutation: "Mutation",
},
keyFields: {
types: {
SearchResult: ["productId"],
SearchResponseCacheIdentifier: ["collectionSlug"],
},
},
rules: [
{
types: [
"Product",
"Collection",
"ProductVariant",
"SearchResponse",
],
maxAge: 900,
swr: 900,
description: "Cache Products & Collections",
},
{
types: ["Channel"],
maxAge: 9000,
swr: 9000,
description: "Cache active channel",
},
{
types: ["Order", "Customer", "User"],
maxAge: 0,
swr: 0,
description: "Do not cache user data",
},
],
},
};
export default config;
```
## Storefront setup
In your storefront, you should point your GraphQL client to the Stellate GraphQL API endpoint, which is
`https://<service-name>.stellate.sh`.
Wherever you are using the `search` query (typically in product listing & search pages), you should also add the
`cacheIdentifier` field to the query. This will ensure that the Stellate cache is correctly purged when
a Product or Collection is updated.
*Example*
```ts
import { graphql } from '../generated/gql';
export const searchProductsDocument = graphql(`
query SearchProducts($input: SearchInput!) {
search(input: $input) {
// highlight-start
cacheIdentifier {
collectionSlug
}
// highlight-end
items {
# ...
}
}
}
}`);
```
## Custom PurgeRules
The configuration above only accounts for caching of some of the built-in Vendure entity types. If you have
custom entity types, you may well want to add them to the Stellate cache. In this case, you'll also need a way to
purge those entities from the cache when they are updated. This is where the <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a> comes in.
Let's imagine that you have built a simple CMS plugin for Vendure which exposes an `Article` entity in your Shop API, and
you have added this to your Stellate configuration:
*Example*
```ts
import { Config } from "stellate";
const config: Config = {
config: {
// ...
rules: [
// ...
{
types: ["Article"],
maxAge: 900,
swr: 900,
description: "Cache Articles",
},
],
},
// ...
};
export default config;
```
You can then add a custom <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a> to the StellatePlugin configuration:
*Example*
```ts
import { StellatePlugin, defaultPurgeRules } from "@vendure/stellate-plugin";
import { VendureConfig } from "@vendure/core";
import { ArticleEvent } from "./plugins/cms/events/article-event";
export const config: VendureConfig = {
// ...
plugins: [
StellatePlugin.init({
// ...
purgeRules: [
...defaultPurgeRules,
new PurgeRule({
eventType: ArticleEvent,
handler: async ({ events, stellateService }) => {
const articleIds = events.map((e) => e.article.id);
stellateService.purge("Article", articleIds);
},
}),
],
}),
],
};
```
## DevMode & Debug Logging
In development, you can set `devMode: true`, which will prevent any calls being made to the Stellate Purging API.
If you want to log the calls that _would_ be made to the Stellate Purge API when in devMode, you can set `debugLogging: true`.
Note that debugLogging generates a lot of debug-level logging, so it is recommended to only enable this when needed.
*Example*
```ts
import { StellatePlugin, defaultPurgeRules } from '@vendure/stellate-plugin';
import { VendureConfig } from '@vendure/core';
export const config: VendureConfig = {
// ...
plugins: [
StellatePlugin.init({
// ...
devMode: !process.env.PRODUCTION,
debugLogging: process.env.STELLATE_DEBUG_MODE ? true : false,
purgeRules: [
...defaultPurgeRules,
],
}),
],
};
```
```ts title="Signature"
class StellatePlugin implements OnApplicationBootstrap {
static options: StellatePluginOptions;
init(options: StellatePluginOptions) => ;
constructor(options: StellatePluginOptions, eventBus: EventBus, stellateService: StellateService, moduleRef: ModuleRef)
onApplicationBootstrap() => ;
}
```
* Implements: <code>OnApplicationBootstrap</code>
<div className="members-wrapper">
### options
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/stellate-plugin/stellate-plugin-options#stellatepluginoptions'>StellatePluginOptions</a>`} />
### init
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/stellate-plugin/stellate-plugin-options#stellatepluginoptions'>StellatePluginOptions</a>) => `} />
### constructor
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/stellate-plugin/stellate-plugin-options#stellatepluginoptions'>StellatePluginOptions</a>, eventBus: <a href='/reference/typescript-api/events/event-bus#eventbus'>EventBus</a>, stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>, moduleRef: ModuleRef) => StellatePlugin`} />
### onApplicationBootstrap
<MemberInfo kind="method" type={`() => `} />
</div>
|
---
title: "PurgeRule"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## PurgeRule
<GenerationInfo sourceFile="packages/stellate-plugin/src/purge-rule.ts" sourceLine="49" packageName="@vendure/stellate-plugin" />
Defines a rule that listens for a particular VendureEvent and uses that to
make calls to the [Stellate Purging API](https://docs.stellate.co/docs/purging-api) via
the provided <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a> instance.
```ts title="Signature"
class PurgeRule<Event extends VendureEvent = VendureEvent> {
eventType: Type<Event>
bufferTimeMs: number | undefined
handle(handlerArgs: { events: Event[]; stellateService: StellateService; injector: Injector }) => ;
constructor(config: PurgeRuleConfig<Event>)
}
```
<div className="members-wrapper">
### eventType
<MemberInfo kind="property" type={`Type<Event>`} />
### bufferTimeMs
<MemberInfo kind="property" type={`number | undefined`} />
### handle
<MemberInfo kind="method" type={`(handlerArgs: { events: Event[]; stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>; injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a> }) => `} />
### constructor
<MemberInfo kind="method" type={`(config: <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgeruleconfig'>PurgeRuleConfig</a><Event>) => PurgeRule`} />
</div>
## PurgeRuleConfig
<GenerationInfo sourceFile="packages/stellate-plugin/src/purge-rule.ts" sourceLine="13" packageName="@vendure/stellate-plugin" />
Configures a <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a>.
```ts title="Signature"
interface PurgeRuleConfig<Event extends VendureEvent> {
eventType: Type<Event>;
bufferTime?: number;
handler: (handlerArgs: {
events: Event[];
stellateService: StellateService;
injector: Injector;
}) => void | Promise<void>;
}
```
<div className="members-wrapper">
### eventType
<MemberInfo kind="property" type={`Type<Event>`} />
Specifies which VendureEvent will trigger this purge rule.
### bufferTime
<MemberInfo kind="property" type={`number`} default="5000" />
How long to buffer events for in milliseconds before executing the handler. This allows
us to efficiently batch calls to the Stellate Purge API.
### handler
<MemberInfo kind="property" type={`(handlerArgs: {
events: Event[];
stellateService: <a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a>;
injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>;
}) => void | Promise<void>`} />
The function to invoke when the specified event is published. This function should use the
<a href='/reference/core-plugins/stellate-plugin/stellate-service#stellateservice'>StellateService</a> instance to call the Stellate Purge API.
</div>
|
---
title: "StellatePluginOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## StellatePluginOptions
<GenerationInfo sourceFile="packages/stellate-plugin/src/types.ts" sourceLine="9" packageName="@vendure/stellate-plugin" />
Configuration options for the StellatePlugin.
```ts title="Signature"
interface StellatePluginOptions {
serviceName: string;
apiToken: string;
purgeRules: PurgeRule[];
defaultBufferTimeMs?: number;
devMode?: boolean;
debugLogging?: boolean;
}
```
<div className="members-wrapper">
### serviceName
<MemberInfo kind="property" type={`string`} />
The Stellate service name, i.e. `<service-name>.stellate.sh`
### apiToken
<MemberInfo kind="property" type={`string`} />
The Stellate Purging API token. For instructions on how to generate the token,
see the [Stellate docs](https://docs.stellate.co/docs/purging-api#authentication)
### purgeRules
<MemberInfo kind="property" type={`<a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a>[]`} />
An array of <a href='/reference/core-plugins/stellate-plugin/purge-rule#purgerule'>PurgeRule</a> instances which are used to define how the plugin will
respond to Vendure events in order to trigger calls to the Stellate Purging API.
### defaultBufferTimeMs
<MemberInfo kind="property" type={`number`} default="2000" />
When events are published, the PurgeRules will buffer those events in order to efficiently
batch requests to the Stellate Purging API. You may wish to change the default, e.g. if you are
running in a serverless environment and cannot introduce pauses after the main request has completed.
### devMode
<MemberInfo kind="property" type={`boolean`} default="false" />
When set to `true`, calls will not be made to the Stellate Purge API.
### debugLogging
<MemberInfo kind="property" type={`boolean`} default="false" />
If set to true, the plugin will log the calls that would be made
to the Stellate Purge API. Note, this generates a
lot of debug-level logging.
</div>
|
---
title: "StellateService"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## StellateService
<GenerationInfo sourceFile="packages/stellate-plugin/src/service/stellate.service.ts" sourceLine="23" packageName="@vendure/stellate-plugin" />
The StellateService is used to purge the Stellate cache when certain events occur.
```ts title="Signature"
class StellateService {
constructor(options: StellatePluginOptions)
purgeProducts(products: Product[]) => ;
purgeProductVariants(productVariants: ProductVariant[]) => ;
purgeSearchResults(items: Array<ProductVariant | Product>) => ;
purgeAllOfType(type: CachedType) => ;
purgeCollections(collections: Collection[]) => ;
purgeSearchResponseCacheIdentifiers(collections: Collection[]) => ;
purge(type: CachedType, keys?: ID[], keyName: = 'id') => ;
}
```
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(options: <a href='/reference/core-plugins/stellate-plugin/stellate-plugin-options#stellatepluginoptions'>StellatePluginOptions</a>) => StellateService`} />
### purgeProducts
<MemberInfo kind="method" type={`(products: <a href='/reference/typescript-api/entities/product#product'>Product</a>[]) => `} />
Purges the cache for the given Products.
### purgeProductVariants
<MemberInfo kind="method" type={`(productVariants: <a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>[]) => `} />
Purges the cache for the given ProductVariants.
### purgeSearchResults
<MemberInfo kind="method" type={`(items: Array<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a> | <a href='/reference/typescript-api/entities/product#product'>Product</a>>) => `} />
Purges the cache for SearchResults which contain the given Products or ProductVariants.
### purgeAllOfType
<MemberInfo kind="method" type={`(type: CachedType) => `} />
Purges the entire cache for the given type.
### purgeCollections
<MemberInfo kind="method" type={`(collections: <a href='/reference/typescript-api/entities/collection#collection'>Collection</a>[]) => `} />
Purges the cache for the given Collections.
### purgeSearchResponseCacheIdentifiers
<MemberInfo kind="method" type={`(collections: <a href='/reference/typescript-api/entities/collection#collection'>Collection</a>[]) => `} />
Purges the cache of SearchResults for the given Collections based on slug.
### purge
<MemberInfo kind="method" type={`(type: CachedType, keys?: <a href='/reference/typescript-api/common/id#id'>ID</a>[], keyName: = 'id') => `} />
Purges the cache for the given type and keys.
</div>
|
---
title: "GraphQL API"
weight: 3
showtoc: false
---
# GraphQL API
This section contains a description of all queries, mutations and related types available in the Vendure GraphQL API.
The API is split into two distinct endpoints: *Shop* and *Admin*. The Shop API is for storefront client applications, whereas the Admin API is used for administrative tasks.
{{% alert %}}
All documentation in this section is auto-generated from the Vendure GraphQL schema.
{{< /alert >}}
|
---
title: "Admin API"
weight: 4
showtoc: false
---
# GraphQL Admin API
The Admin API is primarily used by the included Admin UI web app to perform administrative tasks such as inventory management, order tracking etc.
{{% alert %}}
Explore the interactive GraphQL Admin API at [demo.vendure.io/admin-api](https://demo.vendure.io/admin-api)
{{< /alert >}}
|
---
title: "Enums"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AdjustmentType
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">AdjustmentType</span>
{</div>
<div class="graphql-code-line ">PROMOTION</div>
<div class="graphql-code-line ">DISTRIBUTED_ORDER_PROMOTION</div>
<div class="graphql-code-line ">OTHER</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssetType
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">AssetType</span>
{</div>
<div class="graphql-code-line ">IMAGE</div>
<div class="graphql-code-line ">VIDEO</div>
<div class="graphql-code-line ">BINARY</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CurrencyCode
<div class="graphql-code-block">
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">ISO 4217 currency code</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">CurrencyCode</span>
{</div>
<div class="graphql-code-line comment">"""United Arab Emirates dirham"""</div>
<div class="graphql-code-line ">AED</div>
<div class="graphql-code-line comment">"""Afghan afghani"""</div>
<div class="graphql-code-line ">AFN</div>
<div class="graphql-code-line comment">"""Albanian lek"""</div>
<div class="graphql-code-line ">ALL</div>
<div class="graphql-code-line comment">"""Armenian dram"""</div>
<div class="graphql-code-line ">AMD</div>
<div class="graphql-code-line comment">"""Netherlands Antillean guilder"""</div>
<div class="graphql-code-line ">ANG</div>
<div class="graphql-code-line comment">"""Angolan kwanza"""</div>
<div class="graphql-code-line ">AOA</div>
<div class="graphql-code-line comment">"""Argentine peso"""</div>
<div class="graphql-code-line ">ARS</div>
<div class="graphql-code-line comment">"""Australian dollar"""</div>
<div class="graphql-code-line ">AUD</div>
<div class="graphql-code-line comment">"""Aruban florin"""</div>
<div class="graphql-code-line ">AWG</div>
<div class="graphql-code-line comment">"""Azerbaijani manat"""</div>
<div class="graphql-code-line ">AZN</div>
<div class="graphql-code-line comment">"""Bosnia and Herzegovina convertible mark"""</div>
<div class="graphql-code-line ">BAM</div>
<div class="graphql-code-line comment">"""Barbados dollar"""</div>
<div class="graphql-code-line ">BBD</div>
<div class="graphql-code-line comment">"""Bangladeshi taka"""</div>
<div class="graphql-code-line ">BDT</div>
<div class="graphql-code-line comment">"""Bulgarian lev"""</div>
<div class="graphql-code-line ">BGN</div>
<div class="graphql-code-line comment">"""Bahraini dinar"""</div>
<div class="graphql-code-line ">BHD</div>
<div class="graphql-code-line comment">"""Burundian franc"""</div>
<div class="graphql-code-line ">BIF</div>
<div class="graphql-code-line comment">"""Bermudian dollar"""</div>
<div class="graphql-code-line ">BMD</div>
<div class="graphql-code-line comment">"""Brunei dollar"""</div>
<div class="graphql-code-line ">BND</div>
<div class="graphql-code-line comment">"""Boliviano"""</div>
<div class="graphql-code-line ">BOB</div>
<div class="graphql-code-line comment">"""Brazilian real"""</div>
<div class="graphql-code-line ">BRL</div>
<div class="graphql-code-line comment">"""Bahamian dollar"""</div>
<div class="graphql-code-line ">BSD</div>
<div class="graphql-code-line comment">"""Bhutanese ngultrum"""</div>
<div class="graphql-code-line ">BTN</div>
<div class="graphql-code-line comment">"""Botswana pula"""</div>
<div class="graphql-code-line ">BWP</div>
<div class="graphql-code-line comment">"""Belarusian ruble"""</div>
<div class="graphql-code-line ">BYN</div>
<div class="graphql-code-line comment">"""Belize dollar"""</div>
<div class="graphql-code-line ">BZD</div>
<div class="graphql-code-line comment">"""Canadian dollar"""</div>
<div class="graphql-code-line ">CAD</div>
<div class="graphql-code-line comment">"""Congolese franc"""</div>
<div class="graphql-code-line ">CDF</div>
<div class="graphql-code-line comment">"""Swiss franc"""</div>
<div class="graphql-code-line ">CHF</div>
<div class="graphql-code-line comment">"""Chilean peso"""</div>
<div class="graphql-code-line ">CLP</div>
<div class="graphql-code-line comment">"""Renminbi (Chinese) yuan"""</div>
<div class="graphql-code-line ">CNY</div>
<div class="graphql-code-line comment">"""Colombian peso"""</div>
<div class="graphql-code-line ">COP</div>
<div class="graphql-code-line comment">"""Costa Rican colon"""</div>
<div class="graphql-code-line ">CRC</div>
<div class="graphql-code-line comment">"""Cuban convertible peso"""</div>
<div class="graphql-code-line ">CUC</div>
<div class="graphql-code-line comment">"""Cuban peso"""</div>
<div class="graphql-code-line ">CUP</div>
<div class="graphql-code-line comment">"""Cape Verde escudo"""</div>
<div class="graphql-code-line ">CVE</div>
<div class="graphql-code-line comment">"""Czech koruna"""</div>
<div class="graphql-code-line ">CZK</div>
<div class="graphql-code-line comment">"""Djiboutian franc"""</div>
<div class="graphql-code-line ">DJF</div>
<div class="graphql-code-line comment">"""Danish krone"""</div>
<div class="graphql-code-line ">DKK</div>
<div class="graphql-code-line comment">"""Dominican peso"""</div>
<div class="graphql-code-line ">DOP</div>
<div class="graphql-code-line comment">"""Algerian dinar"""</div>
<div class="graphql-code-line ">DZD</div>
<div class="graphql-code-line comment">"""Egyptian pound"""</div>
<div class="graphql-code-line ">EGP</div>
<div class="graphql-code-line comment">"""Eritrean nakfa"""</div>
<div class="graphql-code-line ">ERN</div>
<div class="graphql-code-line comment">"""Ethiopian birr"""</div>
<div class="graphql-code-line ">ETB</div>
<div class="graphql-code-line comment">"""Euro"""</div>
<div class="graphql-code-line ">EUR</div>
<div class="graphql-code-line comment">"""Fiji dollar"""</div>
<div class="graphql-code-line ">FJD</div>
<div class="graphql-code-line comment">"""Falkland Islands pound"""</div>
<div class="graphql-code-line ">FKP</div>
<div class="graphql-code-line comment">"""Pound sterling"""</div>
<div class="graphql-code-line ">GBP</div>
<div class="graphql-code-line comment">"""Georgian lari"""</div>
<div class="graphql-code-line ">GEL</div>
<div class="graphql-code-line comment">"""Ghanaian cedi"""</div>
<div class="graphql-code-line ">GHS</div>
<div class="graphql-code-line comment">"""Gibraltar pound"""</div>
<div class="graphql-code-line ">GIP</div>
<div class="graphql-code-line comment">"""Gambian dalasi"""</div>
<div class="graphql-code-line ">GMD</div>
<div class="graphql-code-line comment">"""Guinean franc"""</div>
<div class="graphql-code-line ">GNF</div>
<div class="graphql-code-line comment">"""Guatemalan quetzal"""</div>
<div class="graphql-code-line ">GTQ</div>
<div class="graphql-code-line comment">"""Guyanese dollar"""</div>
<div class="graphql-code-line ">GYD</div>
<div class="graphql-code-line comment">"""Hong Kong dollar"""</div>
<div class="graphql-code-line ">HKD</div>
<div class="graphql-code-line comment">"""Honduran lempira"""</div>
<div class="graphql-code-line ">HNL</div>
<div class="graphql-code-line comment">"""Croatian kuna"""</div>
<div class="graphql-code-line ">HRK</div>
<div class="graphql-code-line comment">"""Haitian gourde"""</div>
<div class="graphql-code-line ">HTG</div>
<div class="graphql-code-line comment">"""Hungarian forint"""</div>
<div class="graphql-code-line ">HUF</div>
<div class="graphql-code-line comment">"""Indonesian rupiah"""</div>
<div class="graphql-code-line ">IDR</div>
<div class="graphql-code-line comment">"""Israeli new shekel"""</div>
<div class="graphql-code-line ">ILS</div>
<div class="graphql-code-line comment">"""Indian rupee"""</div>
<div class="graphql-code-line ">INR</div>
<div class="graphql-code-line comment">"""Iraqi dinar"""</div>
<div class="graphql-code-line ">IQD</div>
<div class="graphql-code-line comment">"""Iranian rial"""</div>
<div class="graphql-code-line ">IRR</div>
<div class="graphql-code-line comment">"""Icelandic króna"""</div>
<div class="graphql-code-line ">ISK</div>
<div class="graphql-code-line comment">"""Jamaican dollar"""</div>
<div class="graphql-code-line ">JMD</div>
<div class="graphql-code-line comment">"""Jordanian dinar"""</div>
<div class="graphql-code-line ">JOD</div>
<div class="graphql-code-line comment">"""Japanese yen"""</div>
<div class="graphql-code-line ">JPY</div>
<div class="graphql-code-line comment">"""Kenyan shilling"""</div>
<div class="graphql-code-line ">KES</div>
<div class="graphql-code-line comment">"""Kyrgyzstani som"""</div>
<div class="graphql-code-line ">KGS</div>
<div class="graphql-code-line comment">"""Cambodian riel"""</div>
<div class="graphql-code-line ">KHR</div>
<div class="graphql-code-line comment">"""Comoro franc"""</div>
<div class="graphql-code-line ">KMF</div>
<div class="graphql-code-line comment">"""North Korean won"""</div>
<div class="graphql-code-line ">KPW</div>
<div class="graphql-code-line comment">"""South Korean won"""</div>
<div class="graphql-code-line ">KRW</div>
<div class="graphql-code-line comment">"""Kuwaiti dinar"""</div>
<div class="graphql-code-line ">KWD</div>
<div class="graphql-code-line comment">"""Cayman Islands dollar"""</div>
<div class="graphql-code-line ">KYD</div>
<div class="graphql-code-line comment">"""Kazakhstani tenge"""</div>
<div class="graphql-code-line ">KZT</div>
<div class="graphql-code-line comment">"""Lao kip"""</div>
<div class="graphql-code-line ">LAK</div>
<div class="graphql-code-line comment">"""Lebanese pound"""</div>
<div class="graphql-code-line ">LBP</div>
<div class="graphql-code-line comment">"""Sri Lankan rupee"""</div>
<div class="graphql-code-line ">LKR</div>
<div class="graphql-code-line comment">"""Liberian dollar"""</div>
<div class="graphql-code-line ">LRD</div>
<div class="graphql-code-line comment">"""Lesotho loti"""</div>
<div class="graphql-code-line ">LSL</div>
<div class="graphql-code-line comment">"""Libyan dinar"""</div>
<div class="graphql-code-line ">LYD</div>
<div class="graphql-code-line comment">"""Moroccan dirham"""</div>
<div class="graphql-code-line ">MAD</div>
<div class="graphql-code-line comment">"""Moldovan leu"""</div>
<div class="graphql-code-line ">MDL</div>
<div class="graphql-code-line comment">"""Malagasy ariary"""</div>
<div class="graphql-code-line ">MGA</div>
<div class="graphql-code-line comment">"""Macedonian denar"""</div>
<div class="graphql-code-line ">MKD</div>
<div class="graphql-code-line comment">"""Myanmar kyat"""</div>
<div class="graphql-code-line ">MMK</div>
<div class="graphql-code-line comment">"""Mongolian tögrög"""</div>
<div class="graphql-code-line ">MNT</div>
<div class="graphql-code-line comment">"""Macanese pataca"""</div>
<div class="graphql-code-line ">MOP</div>
<div class="graphql-code-line comment">"""Mauritanian ouguiya"""</div>
<div class="graphql-code-line ">MRU</div>
<div class="graphql-code-line comment">"""Mauritian rupee"""</div>
<div class="graphql-code-line ">MUR</div>
<div class="graphql-code-line comment">"""Maldivian rufiyaa"""</div>
<div class="graphql-code-line ">MVR</div>
<div class="graphql-code-line comment">"""Malawian kwacha"""</div>
<div class="graphql-code-line ">MWK</div>
<div class="graphql-code-line comment">"""Mexican peso"""</div>
<div class="graphql-code-line ">MXN</div>
<div class="graphql-code-line comment">"""Malaysian ringgit"""</div>
<div class="graphql-code-line ">MYR</div>
<div class="graphql-code-line comment">"""Mozambican metical"""</div>
<div class="graphql-code-line ">MZN</div>
<div class="graphql-code-line comment">"""Namibian dollar"""</div>
<div class="graphql-code-line ">NAD</div>
<div class="graphql-code-line comment">"""Nigerian naira"""</div>
<div class="graphql-code-line ">NGN</div>
<div class="graphql-code-line comment">"""Nicaraguan córdoba"""</div>
<div class="graphql-code-line ">NIO</div>
<div class="graphql-code-line comment">"""Norwegian krone"""</div>
<div class="graphql-code-line ">NOK</div>
<div class="graphql-code-line comment">"""Nepalese rupee"""</div>
<div class="graphql-code-line ">NPR</div>
<div class="graphql-code-line comment">"""New Zealand dollar"""</div>
<div class="graphql-code-line ">NZD</div>
<div class="graphql-code-line comment">"""Omani rial"""</div>
<div class="graphql-code-line ">OMR</div>
<div class="graphql-code-line comment">"""Panamanian balboa"""</div>
<div class="graphql-code-line ">PAB</div>
<div class="graphql-code-line comment">"""Peruvian sol"""</div>
<div class="graphql-code-line ">PEN</div>
<div class="graphql-code-line comment">"""Papua New Guinean kina"""</div>
<div class="graphql-code-line ">PGK</div>
<div class="graphql-code-line comment">"""Philippine peso"""</div>
<div class="graphql-code-line ">PHP</div>
<div class="graphql-code-line comment">"""Pakistani rupee"""</div>
<div class="graphql-code-line ">PKR</div>
<div class="graphql-code-line comment">"""Polish złoty"""</div>
<div class="graphql-code-line ">PLN</div>
<div class="graphql-code-line comment">"""Paraguayan guaraní"""</div>
<div class="graphql-code-line ">PYG</div>
<div class="graphql-code-line comment">"""Qatari riyal"""</div>
<div class="graphql-code-line ">QAR</div>
<div class="graphql-code-line comment">"""Romanian leu"""</div>
<div class="graphql-code-line ">RON</div>
<div class="graphql-code-line comment">"""Serbian dinar"""</div>
<div class="graphql-code-line ">RSD</div>
<div class="graphql-code-line comment">"""Russian ruble"""</div>
<div class="graphql-code-line ">RUB</div>
<div class="graphql-code-line comment">"""Rwandan franc"""</div>
<div class="graphql-code-line ">RWF</div>
<div class="graphql-code-line comment">"""Saudi riyal"""</div>
<div class="graphql-code-line ">SAR</div>
<div class="graphql-code-line comment">"""Solomon Islands dollar"""</div>
<div class="graphql-code-line ">SBD</div>
<div class="graphql-code-line comment">"""Seychelles rupee"""</div>
<div class="graphql-code-line ">SCR</div>
<div class="graphql-code-line comment">"""Sudanese pound"""</div>
<div class="graphql-code-line ">SDG</div>
<div class="graphql-code-line comment">"""Swedish krona/kronor"""</div>
<div class="graphql-code-line ">SEK</div>
<div class="graphql-code-line comment">"""Singapore dollar"""</div>
<div class="graphql-code-line ">SGD</div>
<div class="graphql-code-line comment">"""Saint Helena pound"""</div>
<div class="graphql-code-line ">SHP</div>
<div class="graphql-code-line comment">"""Sierra Leonean leone"""</div>
<div class="graphql-code-line ">SLL</div>
<div class="graphql-code-line comment">"""Somali shilling"""</div>
<div class="graphql-code-line ">SOS</div>
<div class="graphql-code-line comment">"""Surinamese dollar"""</div>
<div class="graphql-code-line ">SRD</div>
<div class="graphql-code-line comment">"""South Sudanese pound"""</div>
<div class="graphql-code-line ">SSP</div>
<div class="graphql-code-line comment">"""São Tomé and Príncipe dobra"""</div>
<div class="graphql-code-line ">STN</div>
<div class="graphql-code-line comment">"""Salvadoran colón"""</div>
<div class="graphql-code-line ">SVC</div>
<div class="graphql-code-line comment">"""Syrian pound"""</div>
<div class="graphql-code-line ">SYP</div>
<div class="graphql-code-line comment">"""Swazi lilangeni"""</div>
<div class="graphql-code-line ">SZL</div>
<div class="graphql-code-line comment">"""Thai baht"""</div>
<div class="graphql-code-line ">THB</div>
<div class="graphql-code-line comment">"""Tajikistani somoni"""</div>
<div class="graphql-code-line ">TJS</div>
<div class="graphql-code-line comment">"""Turkmenistan manat"""</div>
<div class="graphql-code-line ">TMT</div>
<div class="graphql-code-line comment">"""Tunisian dinar"""</div>
<div class="graphql-code-line ">TND</div>
<div class="graphql-code-line comment">"""Tongan paʻanga"""</div>
<div class="graphql-code-line ">TOP</div>
<div class="graphql-code-line comment">"""Turkish lira"""</div>
<div class="graphql-code-line ">TRY</div>
<div class="graphql-code-line comment">"""Trinidad and Tobago dollar"""</div>
<div class="graphql-code-line ">TTD</div>
<div class="graphql-code-line comment">"""New Taiwan dollar"""</div>
<div class="graphql-code-line ">TWD</div>
<div class="graphql-code-line comment">"""Tanzanian shilling"""</div>
<div class="graphql-code-line ">TZS</div>
<div class="graphql-code-line comment">"""Ukrainian hryvnia"""</div>
<div class="graphql-code-line ">UAH</div>
<div class="graphql-code-line comment">"""Ugandan shilling"""</div>
<div class="graphql-code-line ">UGX</div>
<div class="graphql-code-line comment">"""United States dollar"""</div>
<div class="graphql-code-line ">USD</div>
<div class="graphql-code-line comment">"""Uruguayan peso"""</div>
<div class="graphql-code-line ">UYU</div>
<div class="graphql-code-line comment">"""Uzbekistan som"""</div>
<div class="graphql-code-line ">UZS</div>
<div class="graphql-code-line comment">"""Venezuelan bolívar soberano"""</div>
<div class="graphql-code-line ">VES</div>
<div class="graphql-code-line comment">"""Vietnamese đồng"""</div>
<div class="graphql-code-line ">VND</div>
<div class="graphql-code-line comment">"""Vanuatu vatu"""</div>
<div class="graphql-code-line ">VUV</div>
<div class="graphql-code-line comment">"""Samoan tala"""</div>
<div class="graphql-code-line ">WST</div>
<div class="graphql-code-line comment">"""CFA franc BEAC"""</div>
<div class="graphql-code-line ">XAF</div>
<div class="graphql-code-line comment">"""East Caribbean dollar"""</div>
<div class="graphql-code-line ">XCD</div>
<div class="graphql-code-line comment">"""CFA franc BCEAO"""</div>
<div class="graphql-code-line ">XOF</div>
<div class="graphql-code-line comment">"""CFP franc (franc Pacifique)"""</div>
<div class="graphql-code-line ">XPF</div>
<div class="graphql-code-line comment">"""Yemeni rial"""</div>
<div class="graphql-code-line ">YER</div>
<div class="graphql-code-line comment">"""South African rand"""</div>
<div class="graphql-code-line ">ZAR</div>
<div class="graphql-code-line comment">"""Zambian kwacha"""</div>
<div class="graphql-code-line ">ZMW</div>
<div class="graphql-code-line comment">"""Zimbabwean dollar"""</div>
<div class="graphql-code-line ">ZWL</div>
<div class="graphql-code-line top-level">}</div>
</div>
## DeletionResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">DeletionResult</span>
{</div>
<div class="graphql-code-line comment">"""The entity was successfully deleted"""</div>
<div class="graphql-code-line ">DELETED</div>
<div class="graphql-code-line comment">"""Deletion did not take place, reason given in message"""</div>
<div class="graphql-code-line ">NOT_DELETED</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ErrorCode
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">ErrorCode</span>
{</div>
<div class="graphql-code-line ">UNKNOWN_ERROR</div>
<div class="graphql-code-line ">MIME_TYPE_ERROR</div>
<div class="graphql-code-line ">LANGUAGE_NOT_AVAILABLE_ERROR</div>
<div class="graphql-code-line ">DUPLICATE_ENTITY_ERROR</div>
<div class="graphql-code-line ">FACET_IN_USE_ERROR</div>
<div class="graphql-code-line ">CHANNEL_DEFAULT_LANGUAGE_ERROR</div>
<div class="graphql-code-line ">SETTLE_PAYMENT_ERROR</div>
<div class="graphql-code-line ">CANCEL_PAYMENT_ERROR</div>
<div class="graphql-code-line ">EMPTY_ORDER_LINE_SELECTION_ERROR</div>
<div class="graphql-code-line ">ITEMS_ALREADY_FULFILLED_ERROR</div>
<div class="graphql-code-line ">INVALID_FULFILLMENT_HANDLER_ERROR</div>
<div class="graphql-code-line ">CREATE_FULFILLMENT_ERROR</div>
<div class="graphql-code-line ">INSUFFICIENT_STOCK_ON_HAND_ERROR</div>
<div class="graphql-code-line ">MULTIPLE_ORDER_ERROR</div>
<div class="graphql-code-line ">CANCEL_ACTIVE_ORDER_ERROR</div>
<div class="graphql-code-line ">PAYMENT_ORDER_MISMATCH_ERROR</div>
<div class="graphql-code-line ">REFUND_ORDER_STATE_ERROR</div>
<div class="graphql-code-line ">NOTHING_TO_REFUND_ERROR</div>
<div class="graphql-code-line ">ALREADY_REFUNDED_ERROR</div>
<div class="graphql-code-line ">QUANTITY_TOO_GREAT_ERROR</div>
<div class="graphql-code-line ">REFUND_AMOUNT_ERROR</div>
<div class="graphql-code-line ">REFUND_STATE_TRANSITION_ERROR</div>
<div class="graphql-code-line ">PAYMENT_STATE_TRANSITION_ERROR</div>
<div class="graphql-code-line ">FULFILLMENT_STATE_TRANSITION_ERROR</div>
<div class="graphql-code-line ">ORDER_MODIFICATION_STATE_ERROR</div>
<div class="graphql-code-line ">NO_CHANGES_SPECIFIED_ERROR</div>
<div class="graphql-code-line ">PAYMENT_METHOD_MISSING_ERROR</div>
<div class="graphql-code-line ">REFUND_PAYMENT_ID_MISSING_ERROR</div>
<div class="graphql-code-line ">MANUAL_PAYMENT_STATE_ERROR</div>
<div class="graphql-code-line ">PRODUCT_OPTION_IN_USE_ERROR</div>
<div class="graphql-code-line ">MISSING_CONDITIONS_ERROR</div>
<div class="graphql-code-line ">NATIVE_AUTH_STRATEGY_ERROR</div>
<div class="graphql-code-line ">INVALID_CREDENTIALS_ERROR</div>
<div class="graphql-code-line ">ORDER_STATE_TRANSITION_ERROR</div>
<div class="graphql-code-line ">EMAIL_ADDRESS_CONFLICT_ERROR</div>
<div class="graphql-code-line ">GUEST_CHECKOUT_ERROR</div>
<div class="graphql-code-line ">ORDER_LIMIT_ERROR</div>
<div class="graphql-code-line ">NEGATIVE_QUANTITY_ERROR</div>
<div class="graphql-code-line ">INSUFFICIENT_STOCK_ERROR</div>
<div class="graphql-code-line ">COUPON_CODE_INVALID_ERROR</div>
<div class="graphql-code-line ">COUPON_CODE_EXPIRED_ERROR</div>
<div class="graphql-code-line ">COUPON_CODE_LIMIT_ERROR</div>
<div class="graphql-code-line ">ORDER_MODIFICATION_ERROR</div>
<div class="graphql-code-line ">INELIGIBLE_SHIPPING_METHOD_ERROR</div>
<div class="graphql-code-line ">NO_ACTIVE_ORDER_ERROR</div>
<div class="graphql-code-line top-level">}</div>
</div>
## GlobalFlag
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">GlobalFlag</span>
{</div>
<div class="graphql-code-line ">TRUE</div>
<div class="graphql-code-line ">FALSE</div>
<div class="graphql-code-line ">INHERIT</div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntryType
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">HistoryEntryType</span>
{</div>
<div class="graphql-code-line ">CUSTOMER_REGISTERED</div>
<div class="graphql-code-line ">CUSTOMER_VERIFIED</div>
<div class="graphql-code-line ">CUSTOMER_DETAIL_UPDATED</div>
<div class="graphql-code-line ">CUSTOMER_ADDED_TO_GROUP</div>
<div class="graphql-code-line ">CUSTOMER_REMOVED_FROM_GROUP</div>
<div class="graphql-code-line ">CUSTOMER_ADDRESS_CREATED</div>
<div class="graphql-code-line ">CUSTOMER_ADDRESS_UPDATED</div>
<div class="graphql-code-line ">CUSTOMER_ADDRESS_DELETED</div>
<div class="graphql-code-line ">CUSTOMER_PASSWORD_UPDATED</div>
<div class="graphql-code-line ">CUSTOMER_PASSWORD_RESET_REQUESTED</div>
<div class="graphql-code-line ">CUSTOMER_PASSWORD_RESET_VERIFIED</div>
<div class="graphql-code-line ">CUSTOMER_EMAIL_UPDATE_REQUESTED</div>
<div class="graphql-code-line ">CUSTOMER_EMAIL_UPDATE_VERIFIED</div>
<div class="graphql-code-line ">CUSTOMER_NOTE</div>
<div class="graphql-code-line ">ORDER_STATE_TRANSITION</div>
<div class="graphql-code-line ">ORDER_PAYMENT_TRANSITION</div>
<div class="graphql-code-line ">ORDER_FULFILLMENT</div>
<div class="graphql-code-line ">ORDER_CANCELLATION</div>
<div class="graphql-code-line ">ORDER_REFUND_TRANSITION</div>
<div class="graphql-code-line ">ORDER_FULFILLMENT_TRANSITION</div>
<div class="graphql-code-line ">ORDER_NOTE</div>
<div class="graphql-code-line ">ORDER_COUPON_APPLIED</div>
<div class="graphql-code-line ">ORDER_COUPON_REMOVED</div>
<div class="graphql-code-line ">ORDER_MODIFIED</div>
<div class="graphql-code-line ">ORDER_CUSTOMER_UPDATED</div>
<div class="graphql-code-line top-level">}</div>
</div>
## JobState
<div class="graphql-code-block">
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The state of a Job in the JobQueue</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">JobState</span>
{</div>
<div class="graphql-code-line ">PENDING</div>
<div class="graphql-code-line ">RUNNING</div>
<div class="graphql-code-line ">COMPLETED</div>
<div class="graphql-code-line ">RETRYING</div>
<div class="graphql-code-line ">FAILED</div>
<div class="graphql-code-line ">CANCELLED</div>
<div class="graphql-code-line top-level">}</div>
</div>
## LanguageCode
<div class="graphql-code-block">
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Languages in the form of a ISO 639-1 language code with optional</div>
<div class="graphql-code-line comment">region or script modifier (e.g. de_AT). The selection available is based</div>
<div class="graphql-code-line comment">on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)</div>
<div class="graphql-code-line comment">and includes the major spoken languages of the world and any widely-used variants.</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">LanguageCode</span>
{</div>
<div class="graphql-code-line comment">"""Afrikaans"""</div>
<div class="graphql-code-line ">af</div>
<div class="graphql-code-line comment">"""Akan"""</div>
<div class="graphql-code-line ">ak</div>
<div class="graphql-code-line comment">"""Albanian"""</div>
<div class="graphql-code-line ">sq</div>
<div class="graphql-code-line comment">"""Amharic"""</div>
<div class="graphql-code-line ">am</div>
<div class="graphql-code-line comment">"""Arabic"""</div>
<div class="graphql-code-line ">ar</div>
<div class="graphql-code-line comment">"""Armenian"""</div>
<div class="graphql-code-line ">hy</div>
<div class="graphql-code-line comment">"""Assamese"""</div>
<div class="graphql-code-line ">as</div>
<div class="graphql-code-line comment">"""Azerbaijani"""</div>
<div class="graphql-code-line ">az</div>
<div class="graphql-code-line comment">"""Bambara"""</div>
<div class="graphql-code-line ">bm</div>
<div class="graphql-code-line comment">"""Bangla"""</div>
<div class="graphql-code-line ">bn</div>
<div class="graphql-code-line comment">"""Basque"""</div>
<div class="graphql-code-line ">eu</div>
<div class="graphql-code-line comment">"""Belarusian"""</div>
<div class="graphql-code-line ">be</div>
<div class="graphql-code-line comment">"""Bosnian"""</div>
<div class="graphql-code-line ">bs</div>
<div class="graphql-code-line comment">"""Breton"""</div>
<div class="graphql-code-line ">br</div>
<div class="graphql-code-line comment">"""Bulgarian"""</div>
<div class="graphql-code-line ">bg</div>
<div class="graphql-code-line comment">"""Burmese"""</div>
<div class="graphql-code-line ">my</div>
<div class="graphql-code-line comment">"""Catalan"""</div>
<div class="graphql-code-line ">ca</div>
<div class="graphql-code-line comment">"""Chechen"""</div>
<div class="graphql-code-line ">ce</div>
<div class="graphql-code-line comment">"""Chinese"""</div>
<div class="graphql-code-line ">zh</div>
<div class="graphql-code-line comment">"""Simplified Chinese"""</div>
<div class="graphql-code-line ">zh_Hans</div>
<div class="graphql-code-line comment">"""Traditional Chinese"""</div>
<div class="graphql-code-line ">zh_Hant</div>
<div class="graphql-code-line comment">"""Church Slavic"""</div>
<div class="graphql-code-line ">cu</div>
<div class="graphql-code-line comment">"""Cornish"""</div>
<div class="graphql-code-line ">kw</div>
<div class="graphql-code-line comment">"""Corsican"""</div>
<div class="graphql-code-line ">co</div>
<div class="graphql-code-line comment">"""Croatian"""</div>
<div class="graphql-code-line ">hr</div>
<div class="graphql-code-line comment">"""Czech"""</div>
<div class="graphql-code-line ">cs</div>
<div class="graphql-code-line comment">"""Danish"""</div>
<div class="graphql-code-line ">da</div>
<div class="graphql-code-line comment">"""Dutch"""</div>
<div class="graphql-code-line ">nl</div>
<div class="graphql-code-line comment">"""Flemish"""</div>
<div class="graphql-code-line ">nl_BE</div>
<div class="graphql-code-line comment">"""Dzongkha"""</div>
<div class="graphql-code-line ">dz</div>
<div class="graphql-code-line comment">"""English"""</div>
<div class="graphql-code-line ">en</div>
<div class="graphql-code-line comment">"""Australian English"""</div>
<div class="graphql-code-line ">en_AU</div>
<div class="graphql-code-line comment">"""Canadian English"""</div>
<div class="graphql-code-line ">en_CA</div>
<div class="graphql-code-line comment">"""British English"""</div>
<div class="graphql-code-line ">en_GB</div>
<div class="graphql-code-line comment">"""American English"""</div>
<div class="graphql-code-line ">en_US</div>
<div class="graphql-code-line comment">"""Esperanto"""</div>
<div class="graphql-code-line ">eo</div>
<div class="graphql-code-line comment">"""Estonian"""</div>
<div class="graphql-code-line ">et</div>
<div class="graphql-code-line comment">"""Ewe"""</div>
<div class="graphql-code-line ">ee</div>
<div class="graphql-code-line comment">"""Faroese"""</div>
<div class="graphql-code-line ">fo</div>
<div class="graphql-code-line comment">"""Finnish"""</div>
<div class="graphql-code-line ">fi</div>
<div class="graphql-code-line comment">"""French"""</div>
<div class="graphql-code-line ">fr</div>
<div class="graphql-code-line comment">"""Canadian French"""</div>
<div class="graphql-code-line ">fr_CA</div>
<div class="graphql-code-line comment">"""Swiss French"""</div>
<div class="graphql-code-line ">fr_CH</div>
<div class="graphql-code-line comment">"""Fulah"""</div>
<div class="graphql-code-line ">ff</div>
<div class="graphql-code-line comment">"""Galician"""</div>
<div class="graphql-code-line ">gl</div>
<div class="graphql-code-line comment">"""Ganda"""</div>
<div class="graphql-code-line ">lg</div>
<div class="graphql-code-line comment">"""Georgian"""</div>
<div class="graphql-code-line ">ka</div>
<div class="graphql-code-line comment">"""German"""</div>
<div class="graphql-code-line ">de</div>
<div class="graphql-code-line comment">"""Austrian German"""</div>
<div class="graphql-code-line ">de_AT</div>
<div class="graphql-code-line comment">"""Swiss High German"""</div>
<div class="graphql-code-line ">de_CH</div>
<div class="graphql-code-line comment">"""Greek"""</div>
<div class="graphql-code-line ">el</div>
<div class="graphql-code-line comment">"""Gujarati"""</div>
<div class="graphql-code-line ">gu</div>
<div class="graphql-code-line comment">"""Haitian Creole"""</div>
<div class="graphql-code-line ">ht</div>
<div class="graphql-code-line comment">"""Hausa"""</div>
<div class="graphql-code-line ">ha</div>
<div class="graphql-code-line comment">"""Hebrew"""</div>
<div class="graphql-code-line ">he</div>
<div class="graphql-code-line comment">"""Hindi"""</div>
<div class="graphql-code-line ">hi</div>
<div class="graphql-code-line comment">"""Hungarian"""</div>
<div class="graphql-code-line ">hu</div>
<div class="graphql-code-line comment">"""Icelandic"""</div>
<div class="graphql-code-line ">is</div>
<div class="graphql-code-line comment">"""Igbo"""</div>
<div class="graphql-code-line ">ig</div>
<div class="graphql-code-line comment">"""Indonesian"""</div>
<div class="graphql-code-line ">id</div>
<div class="graphql-code-line comment">"""Interlingua"""</div>
<div class="graphql-code-line ">ia</div>
<div class="graphql-code-line comment">"""Irish"""</div>
<div class="graphql-code-line ">ga</div>
<div class="graphql-code-line comment">"""Italian"""</div>
<div class="graphql-code-line ">it</div>
<div class="graphql-code-line comment">"""Japanese"""</div>
<div class="graphql-code-line ">ja</div>
<div class="graphql-code-line comment">"""Javanese"""</div>
<div class="graphql-code-line ">jv</div>
<div class="graphql-code-line comment">"""Kalaallisut"""</div>
<div class="graphql-code-line ">kl</div>
<div class="graphql-code-line comment">"""Kannada"""</div>
<div class="graphql-code-line ">kn</div>
<div class="graphql-code-line comment">"""Kashmiri"""</div>
<div class="graphql-code-line ">ks</div>
<div class="graphql-code-line comment">"""Kazakh"""</div>
<div class="graphql-code-line ">kk</div>
<div class="graphql-code-line comment">"""Khmer"""</div>
<div class="graphql-code-line ">km</div>
<div class="graphql-code-line comment">"""Kikuyu"""</div>
<div class="graphql-code-line ">ki</div>
<div class="graphql-code-line comment">"""Kinyarwanda"""</div>
<div class="graphql-code-line ">rw</div>
<div class="graphql-code-line comment">"""Korean"""</div>
<div class="graphql-code-line ">ko</div>
<div class="graphql-code-line comment">"""Kurdish"""</div>
<div class="graphql-code-line ">ku</div>
<div class="graphql-code-line comment">"""Kyrgyz"""</div>
<div class="graphql-code-line ">ky</div>
<div class="graphql-code-line comment">"""Lao"""</div>
<div class="graphql-code-line ">lo</div>
<div class="graphql-code-line comment">"""Latin"""</div>
<div class="graphql-code-line ">la</div>
<div class="graphql-code-line comment">"""Latvian"""</div>
<div class="graphql-code-line ">lv</div>
<div class="graphql-code-line comment">"""Lingala"""</div>
<div class="graphql-code-line ">ln</div>
<div class="graphql-code-line comment">"""Lithuanian"""</div>
<div class="graphql-code-line ">lt</div>
<div class="graphql-code-line comment">"""Luba-Katanga"""</div>
<div class="graphql-code-line ">lu</div>
<div class="graphql-code-line comment">"""Luxembourgish"""</div>
<div class="graphql-code-line ">lb</div>
<div class="graphql-code-line comment">"""Macedonian"""</div>
<div class="graphql-code-line ">mk</div>
<div class="graphql-code-line comment">"""Malagasy"""</div>
<div class="graphql-code-line ">mg</div>
<div class="graphql-code-line comment">"""Malay"""</div>
<div class="graphql-code-line ">ms</div>
<div class="graphql-code-line comment">"""Malayalam"""</div>
<div class="graphql-code-line ">ml</div>
<div class="graphql-code-line comment">"""Maltese"""</div>
<div class="graphql-code-line ">mt</div>
<div class="graphql-code-line comment">"""Manx"""</div>
<div class="graphql-code-line ">gv</div>
<div class="graphql-code-line comment">"""Maori"""</div>
<div class="graphql-code-line ">mi</div>
<div class="graphql-code-line comment">"""Marathi"""</div>
<div class="graphql-code-line ">mr</div>
<div class="graphql-code-line comment">"""Mongolian"""</div>
<div class="graphql-code-line ">mn</div>
<div class="graphql-code-line comment">"""Nepali"""</div>
<div class="graphql-code-line ">ne</div>
<div class="graphql-code-line comment">"""North Ndebele"""</div>
<div class="graphql-code-line ">nd</div>
<div class="graphql-code-line comment">"""Northern Sami"""</div>
<div class="graphql-code-line ">se</div>
<div class="graphql-code-line comment">"""Norwegian Bokmål"""</div>
<div class="graphql-code-line ">nb</div>
<div class="graphql-code-line comment">"""Norwegian Nynorsk"""</div>
<div class="graphql-code-line ">nn</div>
<div class="graphql-code-line comment">"""Nyanja"""</div>
<div class="graphql-code-line ">ny</div>
<div class="graphql-code-line comment">"""Odia"""</div>
<div class="graphql-code-line ">or</div>
<div class="graphql-code-line comment">"""Oromo"""</div>
<div class="graphql-code-line ">om</div>
<div class="graphql-code-line comment">"""Ossetic"""</div>
<div class="graphql-code-line ">os</div>
<div class="graphql-code-line comment">"""Pashto"""</div>
<div class="graphql-code-line ">ps</div>
<div class="graphql-code-line comment">"""Persian"""</div>
<div class="graphql-code-line ">fa</div>
<div class="graphql-code-line comment">"""Dari"""</div>
<div class="graphql-code-line ">fa_AF</div>
<div class="graphql-code-line comment">"""Polish"""</div>
<div class="graphql-code-line ">pl</div>
<div class="graphql-code-line comment">"""Portuguese"""</div>
<div class="graphql-code-line ">pt</div>
<div class="graphql-code-line comment">"""Brazilian Portuguese"""</div>
<div class="graphql-code-line ">pt_BR</div>
<div class="graphql-code-line comment">"""European Portuguese"""</div>
<div class="graphql-code-line ">pt_PT</div>
<div class="graphql-code-line comment">"""Punjabi"""</div>
<div class="graphql-code-line ">pa</div>
<div class="graphql-code-line comment">"""Quechua"""</div>
<div class="graphql-code-line ">qu</div>
<div class="graphql-code-line comment">"""Romanian"""</div>
<div class="graphql-code-line ">ro</div>
<div class="graphql-code-line comment">"""Moldavian"""</div>
<div class="graphql-code-line ">ro_MD</div>
<div class="graphql-code-line comment">"""Romansh"""</div>
<div class="graphql-code-line ">rm</div>
<div class="graphql-code-line comment">"""Rundi"""</div>
<div class="graphql-code-line ">rn</div>
<div class="graphql-code-line comment">"""Russian"""</div>
<div class="graphql-code-line ">ru</div>
<div class="graphql-code-line comment">"""Samoan"""</div>
<div class="graphql-code-line ">sm</div>
<div class="graphql-code-line comment">"""Sango"""</div>
<div class="graphql-code-line ">sg</div>
<div class="graphql-code-line comment">"""Sanskrit"""</div>
<div class="graphql-code-line ">sa</div>
<div class="graphql-code-line comment">"""Scottish Gaelic"""</div>
<div class="graphql-code-line ">gd</div>
<div class="graphql-code-line comment">"""Serbian"""</div>
<div class="graphql-code-line ">sr</div>
<div class="graphql-code-line comment">"""Shona"""</div>
<div class="graphql-code-line ">sn</div>
<div class="graphql-code-line comment">"""Sichuan Yi"""</div>
<div class="graphql-code-line ">ii</div>
<div class="graphql-code-line comment">"""Sindhi"""</div>
<div class="graphql-code-line ">sd</div>
<div class="graphql-code-line comment">"""Sinhala"""</div>
<div class="graphql-code-line ">si</div>
<div class="graphql-code-line comment">"""Slovak"""</div>
<div class="graphql-code-line ">sk</div>
<div class="graphql-code-line comment">"""Slovenian"""</div>
<div class="graphql-code-line ">sl</div>
<div class="graphql-code-line comment">"""Somali"""</div>
<div class="graphql-code-line ">so</div>
<div class="graphql-code-line comment">"""Southern Sotho"""</div>
<div class="graphql-code-line ">st</div>
<div class="graphql-code-line comment">"""Spanish"""</div>
<div class="graphql-code-line ">es</div>
<div class="graphql-code-line comment">"""European Spanish"""</div>
<div class="graphql-code-line ">es_ES</div>
<div class="graphql-code-line comment">"""Mexican Spanish"""</div>
<div class="graphql-code-line ">es_MX</div>
<div class="graphql-code-line comment">"""Sundanese"""</div>
<div class="graphql-code-line ">su</div>
<div class="graphql-code-line comment">"""Swahili"""</div>
<div class="graphql-code-line ">sw</div>
<div class="graphql-code-line comment">"""Congo Swahili"""</div>
<div class="graphql-code-line ">sw_CD</div>
<div class="graphql-code-line comment">"""Swedish"""</div>
<div class="graphql-code-line ">sv</div>
<div class="graphql-code-line comment">"""Tajik"""</div>
<div class="graphql-code-line ">tg</div>
<div class="graphql-code-line comment">"""Tamil"""</div>
<div class="graphql-code-line ">ta</div>
<div class="graphql-code-line comment">"""Tatar"""</div>
<div class="graphql-code-line ">tt</div>
<div class="graphql-code-line comment">"""Telugu"""</div>
<div class="graphql-code-line ">te</div>
<div class="graphql-code-line comment">"""Thai"""</div>
<div class="graphql-code-line ">th</div>
<div class="graphql-code-line comment">"""Tibetan"""</div>
<div class="graphql-code-line ">bo</div>
<div class="graphql-code-line comment">"""Tigrinya"""</div>
<div class="graphql-code-line ">ti</div>
<div class="graphql-code-line comment">"""Tongan"""</div>
<div class="graphql-code-line ">to</div>
<div class="graphql-code-line comment">"""Turkish"""</div>
<div class="graphql-code-line ">tr</div>
<div class="graphql-code-line comment">"""Turkmen"""</div>
<div class="graphql-code-line ">tk</div>
<div class="graphql-code-line comment">"""Ukrainian"""</div>
<div class="graphql-code-line ">uk</div>
<div class="graphql-code-line comment">"""Urdu"""</div>
<div class="graphql-code-line ">ur</div>
<div class="graphql-code-line comment">"""Uyghur"""</div>
<div class="graphql-code-line ">ug</div>
<div class="graphql-code-line comment">"""Uzbek"""</div>
<div class="graphql-code-line ">uz</div>
<div class="graphql-code-line comment">"""Vietnamese"""</div>
<div class="graphql-code-line ">vi</div>
<div class="graphql-code-line comment">"""Volapük"""</div>
<div class="graphql-code-line ">vo</div>
<div class="graphql-code-line comment">"""Welsh"""</div>
<div class="graphql-code-line ">cy</div>
<div class="graphql-code-line comment">"""Western Frisian"""</div>
<div class="graphql-code-line ">fy</div>
<div class="graphql-code-line comment">"""Wolof"""</div>
<div class="graphql-code-line ">wo</div>
<div class="graphql-code-line comment">"""Xhosa"""</div>
<div class="graphql-code-line ">xh</div>
<div class="graphql-code-line comment">"""Yiddish"""</div>
<div class="graphql-code-line ">yi</div>
<div class="graphql-code-line comment">"""Yoruba"""</div>
<div class="graphql-code-line ">yo</div>
<div class="graphql-code-line comment">"""Zulu"""</div>
<div class="graphql-code-line ">zu</div>
<div class="graphql-code-line top-level">}</div>
</div>
## LogicalOperator
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">LogicalOperator</span>
{</div>
<div class="graphql-code-line ">AND</div>
<div class="graphql-code-line ">OR</div>
<div class="graphql-code-line top-level">}</div>
</div>
## MetricInterval
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">MetricInterval</span>
{</div>
<div class="graphql-code-line ">Daily</div>
<div class="graphql-code-line top-level">}</div>
</div>
## MetricType
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">MetricType</span>
{</div>
<div class="graphql-code-line ">OrderCount</div>
<div class="graphql-code-line ">OrderTotal</div>
<div class="graphql-code-line ">AverageOrderValue</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderType
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">OrderType</span>
{</div>
<div class="graphql-code-line ">Regular</div>
<div class="graphql-code-line ">Seller</div>
<div class="graphql-code-line ">Aggregate</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Permission
<div class="graphql-code-block">
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Permissions for administrators and customers. Used to control access to</div>
<div class="graphql-code-line comment">GraphQL resolvers via the {@link Allow} decorator.</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">## Understanding Permission.Owner</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">`Permission.Owner` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only</div>
<div class="graphql-code-line comment">be accessible to the "owner" of that resource.</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">For example, the Shop API <code>activeCustomer</code> query resolver should only return the Customer object for the "owner" of that Customer, i.e.</div>
<div class="graphql-code-line comment">based on the activeUserId of the current session. As a result, the resolver code looks like this:</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">@example</div>
<div class="graphql-code-line comment">```TypeScript</div>
<div class="graphql-code-line comment">\@Query()</div>
<div class="graphql-code-line comment">\@Allow(Permission.Owner)</div>
<div class="graphql-code-line comment">async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {</div>
<div class="graphql-code-line comment"> const userId = ctx.activeUserId;</div>
<div class="graphql-code-line comment"> if (userId) {</div>
<div class="graphql-code-line comment"> return this.customerService.findOneByUserId(ctx, userId);</div>
<div class="graphql-code-line comment"> }</div>
<div class="graphql-code-line comment">}</div>
<div class="graphql-code-line comment">```</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally</div>
<div class="graphql-code-line comment">nor statically encoded at build-time, any resolvers using <code>Permission.Owner</code> **must** include logic to enforce that only the owner</div>
<div class="graphql-code-line comment">of the resource has access. If not, then it is the equivalent of using `Permission.Public`.</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">Permission</span>
{</div>
<div class="graphql-code-line comment">"""Authenticated means simply that the user is logged in"""</div>
<div class="graphql-code-line ">Authenticated</div>
<div class="graphql-code-line comment">"""SuperAdmin has unrestricted access to all operations"""</div>
<div class="graphql-code-line ">SuperAdmin</div>
<div class="graphql-code-line comment">"""Owner means the user owns this entity, e.g. a Customer's own Order"""</div>
<div class="graphql-code-line ">Owner</div>
<div class="graphql-code-line comment">"""Public means any unauthenticated user may perform the operation"""</div>
<div class="graphql-code-line ">Public</div>
<div class="graphql-code-line comment">"""Grants permission to update GlobalSettings"""</div>
<div class="graphql-code-line ">UpdateGlobalSettings</div>
<div class="graphql-code-line comment">"""Grants permission to create Products, Facets, Assets, Collections"""</div>
<div class="graphql-code-line ">CreateCatalog</div>
<div class="graphql-code-line comment">"""Grants permission to read Products, Facets, Assets, Collections"""</div>
<div class="graphql-code-line ">ReadCatalog</div>
<div class="graphql-code-line comment">"""Grants permission to update Products, Facets, Assets, Collections"""</div>
<div class="graphql-code-line ">UpdateCatalog</div>
<div class="graphql-code-line comment">"""Grants permission to delete Products, Facets, Assets, Collections"""</div>
<div class="graphql-code-line ">DeleteCatalog</div>
<div class="graphql-code-line comment">"""Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
<div class="graphql-code-line ">CreateSettings</div>
<div class="graphql-code-line comment">"""Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
<div class="graphql-code-line ">ReadSettings</div>
<div class="graphql-code-line comment">"""Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
<div class="graphql-code-line ">UpdateSettings</div>
<div class="graphql-code-line comment">"""Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
<div class="graphql-code-line ">DeleteSettings</div>
<div class="graphql-code-line comment">"""Grants permission to create Administrator"""</div>
<div class="graphql-code-line ">CreateAdministrator</div>
<div class="graphql-code-line comment">"""Grants permission to read Administrator"""</div>
<div class="graphql-code-line ">ReadAdministrator</div>
<div class="graphql-code-line comment">"""Grants permission to update Administrator"""</div>
<div class="graphql-code-line ">UpdateAdministrator</div>
<div class="graphql-code-line comment">"""Grants permission to delete Administrator"""</div>
<div class="graphql-code-line ">DeleteAdministrator</div>
<div class="graphql-code-line comment">"""Grants permission to create Asset"""</div>
<div class="graphql-code-line ">CreateAsset</div>
<div class="graphql-code-line comment">"""Grants permission to read Asset"""</div>
<div class="graphql-code-line ">ReadAsset</div>
<div class="graphql-code-line comment">"""Grants permission to update Asset"""</div>
<div class="graphql-code-line ">UpdateAsset</div>
<div class="graphql-code-line comment">"""Grants permission to delete Asset"""</div>
<div class="graphql-code-line ">DeleteAsset</div>
<div class="graphql-code-line comment">"""Grants permission to create Channel"""</div>
<div class="graphql-code-line ">CreateChannel</div>
<div class="graphql-code-line comment">"""Grants permission to read Channel"""</div>
<div class="graphql-code-line ">ReadChannel</div>
<div class="graphql-code-line comment">"""Grants permission to update Channel"""</div>
<div class="graphql-code-line ">UpdateChannel</div>
<div class="graphql-code-line comment">"""Grants permission to delete Channel"""</div>
<div class="graphql-code-line ">DeleteChannel</div>
<div class="graphql-code-line comment">"""Grants permission to create Collection"""</div>
<div class="graphql-code-line ">CreateCollection</div>
<div class="graphql-code-line comment">"""Grants permission to read Collection"""</div>
<div class="graphql-code-line ">ReadCollection</div>
<div class="graphql-code-line comment">"""Grants permission to update Collection"""</div>
<div class="graphql-code-line ">UpdateCollection</div>
<div class="graphql-code-line comment">"""Grants permission to delete Collection"""</div>
<div class="graphql-code-line ">DeleteCollection</div>
<div class="graphql-code-line comment">"""Grants permission to create Country"""</div>
<div class="graphql-code-line ">CreateCountry</div>
<div class="graphql-code-line comment">"""Grants permission to read Country"""</div>
<div class="graphql-code-line ">ReadCountry</div>
<div class="graphql-code-line comment">"""Grants permission to update Country"""</div>
<div class="graphql-code-line ">UpdateCountry</div>
<div class="graphql-code-line comment">"""Grants permission to delete Country"""</div>
<div class="graphql-code-line ">DeleteCountry</div>
<div class="graphql-code-line comment">"""Grants permission to create Customer"""</div>
<div class="graphql-code-line ">CreateCustomer</div>
<div class="graphql-code-line comment">"""Grants permission to read Customer"""</div>
<div class="graphql-code-line ">ReadCustomer</div>
<div class="graphql-code-line comment">"""Grants permission to update Customer"""</div>
<div class="graphql-code-line ">UpdateCustomer</div>
<div class="graphql-code-line comment">"""Grants permission to delete Customer"""</div>
<div class="graphql-code-line ">DeleteCustomer</div>
<div class="graphql-code-line comment">"""Grants permission to create CustomerGroup"""</div>
<div class="graphql-code-line ">CreateCustomerGroup</div>
<div class="graphql-code-line comment">"""Grants permission to read CustomerGroup"""</div>
<div class="graphql-code-line ">ReadCustomerGroup</div>
<div class="graphql-code-line comment">"""Grants permission to update CustomerGroup"""</div>
<div class="graphql-code-line ">UpdateCustomerGroup</div>
<div class="graphql-code-line comment">"""Grants permission to delete CustomerGroup"""</div>
<div class="graphql-code-line ">DeleteCustomerGroup</div>
<div class="graphql-code-line comment">"""Grants permission to create Facet"""</div>
<div class="graphql-code-line ">CreateFacet</div>
<div class="graphql-code-line comment">"""Grants permission to read Facet"""</div>
<div class="graphql-code-line ">ReadFacet</div>
<div class="graphql-code-line comment">"""Grants permission to update Facet"""</div>
<div class="graphql-code-line ">UpdateFacet</div>
<div class="graphql-code-line comment">"""Grants permission to delete Facet"""</div>
<div class="graphql-code-line ">DeleteFacet</div>
<div class="graphql-code-line comment">"""Grants permission to create Order"""</div>
<div class="graphql-code-line ">CreateOrder</div>
<div class="graphql-code-line comment">"""Grants permission to read Order"""</div>
<div class="graphql-code-line ">ReadOrder</div>
<div class="graphql-code-line comment">"""Grants permission to update Order"""</div>
<div class="graphql-code-line ">UpdateOrder</div>
<div class="graphql-code-line comment">"""Grants permission to delete Order"""</div>
<div class="graphql-code-line ">DeleteOrder</div>
<div class="graphql-code-line comment">"""Grants permission to create PaymentMethod"""</div>
<div class="graphql-code-line ">CreatePaymentMethod</div>
<div class="graphql-code-line comment">"""Grants permission to read PaymentMethod"""</div>
<div class="graphql-code-line ">ReadPaymentMethod</div>
<div class="graphql-code-line comment">"""Grants permission to update PaymentMethod"""</div>
<div class="graphql-code-line ">UpdatePaymentMethod</div>
<div class="graphql-code-line comment">"""Grants permission to delete PaymentMethod"""</div>
<div class="graphql-code-line ">DeletePaymentMethod</div>
<div class="graphql-code-line comment">"""Grants permission to create Product"""</div>
<div class="graphql-code-line ">CreateProduct</div>
<div class="graphql-code-line comment">"""Grants permission to read Product"""</div>
<div class="graphql-code-line ">ReadProduct</div>
<div class="graphql-code-line comment">"""Grants permission to update Product"""</div>
<div class="graphql-code-line ">UpdateProduct</div>
<div class="graphql-code-line comment">"""Grants permission to delete Product"""</div>
<div class="graphql-code-line ">DeleteProduct</div>
<div class="graphql-code-line comment">"""Grants permission to create Promotion"""</div>
<div class="graphql-code-line ">CreatePromotion</div>
<div class="graphql-code-line comment">"""Grants permission to read Promotion"""</div>
<div class="graphql-code-line ">ReadPromotion</div>
<div class="graphql-code-line comment">"""Grants permission to update Promotion"""</div>
<div class="graphql-code-line ">UpdatePromotion</div>
<div class="graphql-code-line comment">"""Grants permission to delete Promotion"""</div>
<div class="graphql-code-line ">DeletePromotion</div>
<div class="graphql-code-line comment">"""Grants permission to create ShippingMethod"""</div>
<div class="graphql-code-line ">CreateShippingMethod</div>
<div class="graphql-code-line comment">"""Grants permission to read ShippingMethod"""</div>
<div class="graphql-code-line ">ReadShippingMethod</div>
<div class="graphql-code-line comment">"""Grants permission to update ShippingMethod"""</div>
<div class="graphql-code-line ">UpdateShippingMethod</div>
<div class="graphql-code-line comment">"""Grants permission to delete ShippingMethod"""</div>
<div class="graphql-code-line ">DeleteShippingMethod</div>
<div class="graphql-code-line comment">"""Grants permission to create Tag"""</div>
<div class="graphql-code-line ">CreateTag</div>
<div class="graphql-code-line comment">"""Grants permission to read Tag"""</div>
<div class="graphql-code-line ">ReadTag</div>
<div class="graphql-code-line comment">"""Grants permission to update Tag"""</div>
<div class="graphql-code-line ">UpdateTag</div>
<div class="graphql-code-line comment">"""Grants permission to delete Tag"""</div>
<div class="graphql-code-line ">DeleteTag</div>
<div class="graphql-code-line comment">"""Grants permission to create TaxCategory"""</div>
<div class="graphql-code-line ">CreateTaxCategory</div>
<div class="graphql-code-line comment">"""Grants permission to read TaxCategory"""</div>
<div class="graphql-code-line ">ReadTaxCategory</div>
<div class="graphql-code-line comment">"""Grants permission to update TaxCategory"""</div>
<div class="graphql-code-line ">UpdateTaxCategory</div>
<div class="graphql-code-line comment">"""Grants permission to delete TaxCategory"""</div>
<div class="graphql-code-line ">DeleteTaxCategory</div>
<div class="graphql-code-line comment">"""Grants permission to create TaxRate"""</div>
<div class="graphql-code-line ">CreateTaxRate</div>
<div class="graphql-code-line comment">"""Grants permission to read TaxRate"""</div>
<div class="graphql-code-line ">ReadTaxRate</div>
<div class="graphql-code-line comment">"""Grants permission to update TaxRate"""</div>
<div class="graphql-code-line ">UpdateTaxRate</div>
<div class="graphql-code-line comment">"""Grants permission to delete TaxRate"""</div>
<div class="graphql-code-line ">DeleteTaxRate</div>
<div class="graphql-code-line comment">"""Grants permission to create Seller"""</div>
<div class="graphql-code-line ">CreateSeller</div>
<div class="graphql-code-line comment">"""Grants permission to read Seller"""</div>
<div class="graphql-code-line ">ReadSeller</div>
<div class="graphql-code-line comment">"""Grants permission to update Seller"""</div>
<div class="graphql-code-line ">UpdateSeller</div>
<div class="graphql-code-line comment">"""Grants permission to delete Seller"""</div>
<div class="graphql-code-line ">DeleteSeller</div>
<div class="graphql-code-line comment">"""Grants permission to create StockLocation"""</div>
<div class="graphql-code-line ">CreateStockLocation</div>
<div class="graphql-code-line comment">"""Grants permission to read StockLocation"""</div>
<div class="graphql-code-line ">ReadStockLocation</div>
<div class="graphql-code-line comment">"""Grants permission to update StockLocation"""</div>
<div class="graphql-code-line ">UpdateStockLocation</div>
<div class="graphql-code-line comment">"""Grants permission to delete StockLocation"""</div>
<div class="graphql-code-line ">DeleteStockLocation</div>
<div class="graphql-code-line comment">"""Grants permission to create System"""</div>
<div class="graphql-code-line ">CreateSystem</div>
<div class="graphql-code-line comment">"""Grants permission to read System"""</div>
<div class="graphql-code-line ">ReadSystem</div>
<div class="graphql-code-line comment">"""Grants permission to update System"""</div>
<div class="graphql-code-line ">UpdateSystem</div>
<div class="graphql-code-line comment">"""Grants permission to delete System"""</div>
<div class="graphql-code-line ">DeleteSystem</div>
<div class="graphql-code-line comment">"""Grants permission to create Zone"""</div>
<div class="graphql-code-line ">CreateZone</div>
<div class="graphql-code-line comment">"""Grants permission to read Zone"""</div>
<div class="graphql-code-line ">ReadZone</div>
<div class="graphql-code-line comment">"""Grants permission to update Zone"""</div>
<div class="graphql-code-line ">UpdateZone</div>
<div class="graphql-code-line comment">"""Grants permission to delete Zone"""</div>
<div class="graphql-code-line ">DeleteZone</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SortOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">SortOrder</span>
{</div>
<div class="graphql-code-line ">ASC</div>
<div class="graphql-code-line ">DESC</div>
<div class="graphql-code-line top-level">}</div>
</div>
## StockMovementType
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">StockMovementType</span>
{</div>
<div class="graphql-code-line ">ADJUSTMENT</div>
<div class="graphql-code-line ">ALLOCATION</div>
<div class="graphql-code-line ">RELEASE</div>
<div class="graphql-code-line ">SALE</div>
<div class="graphql-code-line ">CANCELLATION</div>
<div class="graphql-code-line ">RETURN</div>
<div class="graphql-code-line top-level">}</div>
</div>
|
---
title: "Input Objects"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AddItemInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AddItemInput</span>
{</div>
<div class="graphql-code-line ">productVariantId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AddItemToDraftOrderInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AddItemToDraftOrderInput</span>
{</div>
<div class="graphql-code-line ">productVariantId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AddNoteToCustomerInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AddNoteToCustomerInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">note: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">isPublic: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AddNoteToOrderInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AddNoteToOrderInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">note: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">isPublic: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AdjustDraftOrderLineInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AdjustDraftOrderLineInput</span>
{</div>
<div class="graphql-code-line ">orderLineId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AdministratorFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AdministratorFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#administratorfilterparameter">AdministratorFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#administratorfilterparameter">AdministratorFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AdministratorListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AdministratorListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#administratorsortparameter">AdministratorSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#administratorfilterparameter">AdministratorFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AdministratorPaymentInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AdministratorPaymentInput</span>
{</div>
<div class="graphql-code-line ">paymentMethod: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AdministratorRefundInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AdministratorRefundInput</span>
{</div>
<div class="graphql-code-line ">paymentId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">reason: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The amount to be refunded to this particular Payment. This was introduced in</div>
<div class="graphql-code-line comment">v2.2.0 as the preferred way to specify the refund amount. The `lines`, <code>shipping</code> and `adjustment`</div>
<div class="graphql-code-line comment">fields will be removed in a future version.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">amount: <a href="/reference/graphql-api/admin/object-types#money">Money</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AdministratorSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AdministratorSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssetFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssetFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">fileSize: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">mimeType: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">width: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">height: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">source: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">preview: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#assetfilterparameter">AssetFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#assetfilterparameter">AssetFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssetListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssetListOptions</span>
{</div>
<div class="graphql-code-line ">tags: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">tagsOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#assetsortparameter">AssetSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#assetfilterparameter">AssetFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssetSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssetSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">fileSize: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">mimeType: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">width: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">height: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">source: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">preview: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssignAssetsToChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssignAssetsToChannelInput</span>
{</div>
<div class="graphql-code-line ">assetIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssignCollectionsToChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssignCollectionsToChannelInput</span>
{</div>
<div class="graphql-code-line ">collectionIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssignFacetsToChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssignFacetsToChannelInput</span>
{</div>
<div class="graphql-code-line ">facetIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssignPaymentMethodsToChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssignPaymentMethodsToChannelInput</span>
{</div>
<div class="graphql-code-line ">paymentMethodIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssignProductVariantsToChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssignProductVariantsToChannelInput</span>
{</div>
<div class="graphql-code-line ">productVariantIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">priceFactor: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssignProductsToChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssignProductsToChannelInput</span>
{</div>
<div class="graphql-code-line ">productIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">priceFactor: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssignPromotionsToChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssignPromotionsToChannelInput</span>
{</div>
<div class="graphql-code-line ">promotionIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssignShippingMethodsToChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssignShippingMethodsToChannelInput</span>
{</div>
<div class="graphql-code-line ">shippingMethodIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssignStockLocationsToChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AssignStockLocationsToChannelInput</span>
{</div>
<div class="graphql-code-line ">stockLocationIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AuthenticationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AuthenticationInput</span>
{</div>
<div class="graphql-code-line ">native: <a href="/reference/graphql-api/admin/input-types#nativeauthinput">NativeAuthInput</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## BooleanListOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a list of Boolean fields</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">BooleanListOperators</span>
{</div>
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## BooleanOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a Boolean field</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">BooleanOperators</span>
{</div>
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CancelOrderInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CancelOrderInput</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The id of the order to be cancelled</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/admin/input-types#orderlineinput">OrderLineInput</a>!]</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specify whether the shipping charges should also be cancelled. Defaults to false</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">cancelShipping: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">reason: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ChannelFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ChannelFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">token: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">defaultLanguageCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">defaultCurrencyCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">pricesIncludeTax: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#channelfilterparameter">ChannelFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#channelfilterparameter">ChannelFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ChannelListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ChannelListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#channelsortparameter">ChannelSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#channelfilterparameter">ChannelFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ChannelSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ChannelSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">token: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CollectionFilterParameter</span>
{</div>
<div class="graphql-code-line ">isPrivate: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">inheritFilters: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">position: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#collectionfilterparameter">CollectionFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#collectionfilterparameter">CollectionFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CollectionListOptions</span>
{</div>
<div class="graphql-code-line ">topLevelOnly: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#collectionsortparameter">CollectionSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#collectionfilterparameter">CollectionFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CollectionSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">position: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigArgInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ConfigArgInput</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">A JSON stringified representation of the actual value</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigurableOperationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ConfigurableOperationInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">arguments: [<a href="/reference/graphql-api/admin/input-types#configarginput">ConfigArgInput</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CoordinateInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CoordinateInput</span>
{</div>
<div class="graphql-code-line ">x: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line ">y: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CountryFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CountryFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#countryfilterparameter">CountryFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#countryfilterparameter">CountryFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CountryListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CountryListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#countrysortparameter">CountrySortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#countryfilterparameter">CountryFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CountrySortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CountrySortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CountryTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CountryTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateAddressInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateAddressInput</span>
{</div>
<div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">company: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">city: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">province: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">countryCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">defaultShippingAddress: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">defaultBillingAddress: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateAdministratorInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateAdministratorInput</span>
{</div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">password: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">roleIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateAssetInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateAssetInput</span>
{</div>
<div class="graphql-code-line ">file: <a href="/reference/graphql-api/admin/object-types#upload">Upload</a>!</div>
<div class="graphql-code-line ">tags: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateChannelInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">token: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">defaultLanguageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">availableLanguageCodes: [<a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!]</div>
<div class="graphql-code-line ">pricesIncludeTax: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a></div>
<div class="graphql-code-line ">defaultCurrencyCode: <a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a></div>
<div class="graphql-code-line ">availableCurrencyCodes: [<a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a>!]</div>
<div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">defaultTaxZoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">defaultShippingZoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">sellerId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateCollectionInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateCollectionInput</span>
{</div>
<div class="graphql-code-line ">isPrivate: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">featuredAssetId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">assetIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">inheritFilters: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">filters: [<a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#createcollectiontranslationinput">CreateCollectionTranslationInput</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateCollectionTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateCollectionTranslationInput</span>
{</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateCountryInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateCountryInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#countrytranslationinput">CountryTranslationInput</a>!]!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateCustomerGroupInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateCustomerGroupInput</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">customerIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateCustomerInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateCustomerInput</span>
{</div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateFacetInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateFacetInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">isPrivate: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#facettranslationinput">FacetTranslationInput</a>!]!</div>
<div class="graphql-code-line ">values: [<a href="/reference/graphql-api/admin/input-types#createfacetvaluewithfacetinput">CreateFacetValueWithFacetInput</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateFacetValueInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateFacetValueInput</span>
{</div>
<div class="graphql-code-line ">facetId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#facetvaluetranslationinput">FacetValueTranslationInput</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateFacetValueWithFacetInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateFacetValueWithFacetInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#facetvaluetranslationinput">FacetValueTranslationInput</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateGroupOptionInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateGroupOptionInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput">ProductOptionGroupTranslationInput</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreatePaymentMethodInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreatePaymentMethodInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">checker: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a></div>
<div class="graphql-code-line ">handler: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#paymentmethodtranslationinput">PaymentMethodTranslationInput</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateProductInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateProductInput</span>
{</div>
<div class="graphql-code-line ">featuredAssetId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">assetIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">facetValueIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#producttranslationinput">ProductTranslationInput</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateProductOptionGroupInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateProductOptionGroupInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput">ProductOptionGroupTranslationInput</a>!]!</div>
<div class="graphql-code-line ">options: [<a href="/reference/graphql-api/admin/input-types#creategroupoptioninput">CreateGroupOptionInput</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateProductOptionInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateProductOptionInput</span>
{</div>
<div class="graphql-code-line ">productOptionGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput">ProductOptionGroupTranslationInput</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateProductVariantInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateProductVariantInput</span>
{</div>
<div class="graphql-code-line ">productId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#productvarianttranslationinput">ProductVariantTranslationInput</a>!]!</div>
<div class="graphql-code-line ">facetValueIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/object-types#money">Money</a></div>
<div class="graphql-code-line ">taxCategoryId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">optionIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">featuredAssetId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">assetIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">stockOnHand: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">stockLevels: [<a href="/reference/graphql-api/admin/input-types#stocklevelinput">StockLevelInput</a>!]</div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">useGlobalOutOfStockThreshold: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/admin/enums#globalflag">GlobalFlag</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateProductVariantOptionInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateProductVariantOptionInput</span>
{</div>
<div class="graphql-code-line ">optionGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#productoptiontranslationinput">ProductOptionTranslationInput</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreatePromotionInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreatePromotionInput</span>
{</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">startsAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">endsAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">perCustomerUsageLimit: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">usageLimit: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">conditions: [<a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!]!</div>
<div class="graphql-code-line ">actions: [<a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#promotiontranslationinput">PromotionTranslationInput</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateProvinceInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateProvinceInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#provincetranslationinput">ProvinceTranslationInput</a>!]!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateRoleInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateRoleInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">permissions: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]!</div>
<div class="graphql-code-line ">channelIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateSellerInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateSellerInput</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateShippingMethodInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateShippingMethodInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">fulfillmentHandler: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">checker: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!</div>
<div class="graphql-code-line ">calculator: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#shippingmethodtranslationinput">ShippingMethodTranslationInput</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateStockLocationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateStockLocationInput</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateTagInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateTagInput</span>
{</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateTaxCategoryInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateTaxCategoryInput</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">isDefault: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateTaxRateInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateTaxRateInput</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line ">categoryId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">zoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">customerGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateZoneInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateZoneInput</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">memberIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerFilterParameter</span>
{</div>
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#customerfilterparameter">CustomerFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#customerfilterparameter">CustomerFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerGroupFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerGroupFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#customergroupfilterparameter">CustomerGroupFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#customergroupfilterparameter">CustomerGroupFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerGroupListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerGroupListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#customergroupsortparameter">CustomerGroupSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#customergroupfilterparameter">CustomerGroupFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerGroupSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerGroupSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#customersortparameter">CustomerSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#customerfilterparameter">CustomerFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## DateListOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a list of Date fields</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DateListOperators</span>
{</div>
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## DateOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a DateTime field</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DateOperators</span>
{</div>
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">before: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">after: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">between: <a href="/reference/graphql-api/admin/input-types#daterange">DateRange</a></div>
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## DateRange
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DateRange</span>
{</div>
<div class="graphql-code-line ">start: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">end: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## DeleteAssetInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DeleteAssetInput</span>
{</div>
<div class="graphql-code-line ">assetId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">deleteFromAllChannels: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## DeleteAssetsInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DeleteAssetsInput</span>
{</div>
<div class="graphql-code-line ">assetIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">deleteFromAllChannels: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## DeleteStockLocationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DeleteStockLocationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">transferToLocationId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## DuplicateEntityInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DuplicateEntityInput</span>
{</div>
<div class="graphql-code-line ">entityName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">entityId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">duplicatorInput: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetFilterParameter</span>
{</div>
<div class="graphql-code-line ">isPrivate: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#facetfilterparameter">FacetFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#facetfilterparameter">FacetFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#facetsortparameter">FacetSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#facetfilterparameter">FacetFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueFilterInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Used to construct boolean expressions for filtering search results</div>
<div class="graphql-code-line top-level comment">by FacetValue ID. Examples:</div>
<div class="graphql-code-line top-level comment"></div>
<div class="graphql-code-line top-level comment">* ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`</div>
<div class="graphql-code-line top-level comment">* ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`</div>
<div class="graphql-code-line top-level comment">* ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueFilterInput</span>
{</div>
<div class="graphql-code-line ">and: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">or: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">facetId: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#facetvaluefilterparameter">FacetValueFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#facetvaluefilterparameter">FacetValueFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#facetvaluesortparameter">FacetValueSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#facetvaluefilterparameter">FacetValueFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">facetId: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FulfillOrderInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FulfillOrderInput</span>
{</div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/admin/input-types#orderlineinput">OrderLineInput</a>!]!</div>
<div class="graphql-code-line ">handler: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntryFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">HistoryEntryFilterParameter</span>
{</div>
<div class="graphql-code-line ">isPublic: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#historyentryfilterparameter">HistoryEntryFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#historyentryfilterparameter">HistoryEntryFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntryListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">HistoryEntryListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#historyentrysortparameter">HistoryEntrySortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#historyentryfilterparameter">HistoryEntryFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntrySortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">HistoryEntrySortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## IDListOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a list of ID fields</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">IDListOperators</span>
{</div>
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## IDOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on an ID field</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">IDOperators</span>
{</div>
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">notEq: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">in: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">notIn: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## JobFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">JobFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">startedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">settledAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">queueName: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">progress: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">isSettled: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">duration: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">retries: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">attempts: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#jobfilterparameter">JobFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#jobfilterparameter">JobFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## JobListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">JobListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#jobsortparameter">JobSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#jobfilterparameter">JobFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## JobSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">JobSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">startedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">settledAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">queueName: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">progress: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">duration: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">retries: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">attempts: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ManualPaymentInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ManualPaymentInput</span>
{</div>
<div class="graphql-code-line ">orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">method: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">transactionId: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## MetricSummaryInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">MetricSummaryInput</span>
{</div>
<div class="graphql-code-line ">interval: <a href="/reference/graphql-api/admin/enums#metricinterval">MetricInterval</a>!</div>
<div class="graphql-code-line ">types: [<a href="/reference/graphql-api/admin/enums#metrictype">MetricType</a>!]!</div>
<div class="graphql-code-line ">refresh: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ModifyOrderInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ModifyOrderInput</span>
{</div>
<div class="graphql-code-line ">dryRun: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">addItems: [<a href="/reference/graphql-api/admin/input-types#additeminput">AddItemInput</a>!]</div>
<div class="graphql-code-line ">adjustOrderLines: [<a href="/reference/graphql-api/admin/input-types#orderlineinput">OrderLineInput</a>!]</div>
<div class="graphql-code-line ">surcharges: [<a href="/reference/graphql-api/admin/input-types#surchargeinput">SurchargeInput</a>!]</div>
<div class="graphql-code-line ">updateShippingAddress: <a href="/reference/graphql-api/admin/input-types#updateorderaddressinput">UpdateOrderAddressInput</a></div>
<div class="graphql-code-line ">updateBillingAddress: <a href="/reference/graphql-api/admin/input-types#updateorderaddressinput">UpdateOrderAddressInput</a></div>
<div class="graphql-code-line ">note: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Deprecated in v2.2.0. Use <code>refunds</code> instead to allow multiple refunds to be</div>
<div class="graphql-code-line comment">applied in the case that multiple payment methods have been used on the order.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">refund: <a href="/reference/graphql-api/admin/input-types#administratorrefundinput">AdministratorRefundInput</a></div>
<div class="graphql-code-line ">refunds: [<a href="/reference/graphql-api/admin/input-types#administratorrefundinput">AdministratorRefundInput</a>!]</div>
<div class="graphql-code-line ">options: <a href="/reference/graphql-api/admin/input-types#modifyorderoptions">ModifyOrderOptions</a></div>
<div class="graphql-code-line ">couponCodes: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Added in v2.2</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">shippingMethodIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ModifyOrderOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ModifyOrderOptions</span>
{</div>
<div class="graphql-code-line ">freezePromotions: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">recalculateShipping: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## MoveCollectionInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">MoveCollectionInput</span>
{</div>
<div class="graphql-code-line ">collectionId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">index: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NativeAuthInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NativeAuthInput</span>
{</div>
<div class="graphql-code-line ">username: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">password: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NumberListOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a list of Number fields</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NumberListOperators</span>
{</div>
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NumberOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a Int or Float field</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NumberOperators</span>
{</div>
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line ">lt: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line ">lte: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line ">gt: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line ">gte: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line ">between: <a href="/reference/graphql-api/admin/input-types#numberrange">NumberRange</a></div>
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## NumberRange
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NumberRange</span>
{</div>
<div class="graphql-code-line ">start: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line ">end: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">OrderFilterParameter</span>
{</div>
<div class="graphql-code-line ">customerLastName: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">transactionId: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">aggregateOrderId: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">orderPlacedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">active: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">totalQuantity: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">subTotal: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">subTotalWithTax: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">shippingWithTax: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">total: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">totalWithTax: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#orderfilterparameter">OrderFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#orderfilterparameter">OrderFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderLineInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">OrderLineInput</span>
{</div>
<div class="graphql-code-line ">orderLineId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">OrderListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#ordersortparameter">OrderSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#orderfilterparameter">OrderFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">OrderSortParameter</span>
{</div>
<div class="graphql-code-line ">customerLastName: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">transactionId: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">aggregateOrderId: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">orderPlacedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">totalQuantity: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">subTotal: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">subTotalWithTax: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">shippingWithTax: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">total: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">totalWithTax: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethodFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">PaymentMethodFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#paymentmethodfilterparameter">PaymentMethodFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#paymentmethodfilterparameter">PaymentMethodFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethodListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">PaymentMethodListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#paymentmethodsortparameter">PaymentMethodSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#paymentmethodfilterparameter">PaymentMethodFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethodSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">PaymentMethodSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethodTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">PaymentMethodTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PreviewCollectionVariantsInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">PreviewCollectionVariantsInput</span>
{</div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">inheritFilters: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">filters: [<a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductFilterParameter</span>
{</div>
<div class="graphql-code-line ">facetValueId: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#productfilterparameter">ProductFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#productfilterparameter">ProductFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#productsortparameter">ProductSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#productfilterparameter">ProductFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductOptionGroupTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductOptionGroupTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductOptionTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductOptionTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductVariantFilterParameter</span>
{</div>
<div class="graphql-code-line ">facetValueId: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">stockOnHand: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">stockAllocated: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">useGlobalOutOfStockThreshold: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">productId: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">stockLevel: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#productvariantfilterparameter">ProductVariantFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#productvariantfilterparameter">ProductVariantFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductVariantListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#productvariantsortparameter">ProductVariantSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#productvariantfilterparameter">ProductVariantFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantPriceInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Used to set up update the price of a ProductVariant in a particular Channel.</div>
<div class="graphql-code-line top-level comment">If the <code>delete</code> flag is `true`, the price will be deleted for the given Channel.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductVariantPriceInput</span>
{</div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">delete: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductVariantSortParameter</span>
{</div>
<div class="graphql-code-line ">stockOnHand: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">stockAllocated: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">productId: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">stockLevel: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductVariantTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PromotionFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">PromotionFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">startsAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">endsAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">perCustomerUsageLimit: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">usageLimit: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#promotionfilterparameter">PromotionFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#promotionfilterparameter">PromotionFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PromotionListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">PromotionListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#promotionsortparameter">PromotionSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#promotionfilterparameter">PromotionFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PromotionSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">PromotionSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">startsAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">endsAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">perCustomerUsageLimit: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">usageLimit: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PromotionTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">PromotionTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProvinceFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProvinceFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#provincefilterparameter">ProvinceFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#provincefilterparameter">ProvinceFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProvinceListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProvinceListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#provincesortparameter">ProvinceSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#provincefilterparameter">ProvinceFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProvinceSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProvinceSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProvinceTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProvinceTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## RefundOrderInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RefundOrderInput</span>
{</div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/admin/input-types#orderlineinput">OrderLineInput</a>!]!</div>
<div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">adjustment: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">If an amount is specified, this value will be used to create a Refund rather than calculating the</div>
<div class="graphql-code-line comment">amount automatically. This was added in v2.2 and will be the preferred way to specify the refund</div>
<div class="graphql-code-line comment">amount in the future. The `lines`, <code>shipping</code> and <code>adjustment</code> fields will likely be removed in a future</div>
<div class="graphql-code-line comment">version.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">amount: <a href="/reference/graphql-api/admin/object-types#money">Money</a></div>
<div class="graphql-code-line ">paymentId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">reason: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## RemoveCollectionsFromChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RemoveCollectionsFromChannelInput</span>
{</div>
<div class="graphql-code-line ">collectionIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RemoveFacetsFromChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RemoveFacetsFromChannelInput</span>
{</div>
<div class="graphql-code-line ">facetIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## RemovePaymentMethodsFromChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RemovePaymentMethodsFromChannelInput</span>
{</div>
<div class="graphql-code-line ">paymentMethodIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RemoveProductVariantsFromChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RemoveProductVariantsFromChannelInput</span>
{</div>
<div class="graphql-code-line ">productVariantIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RemoveProductsFromChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RemoveProductsFromChannelInput</span>
{</div>
<div class="graphql-code-line ">productIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RemovePromotionsFromChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RemovePromotionsFromChannelInput</span>
{</div>
<div class="graphql-code-line ">promotionIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RemoveShippingMethodsFromChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RemoveShippingMethodsFromChannelInput</span>
{</div>
<div class="graphql-code-line ">shippingMethodIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RemoveStockLocationsFromChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RemoveStockLocationsFromChannelInput</span>
{</div>
<div class="graphql-code-line ">stockLocationIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">channelId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RoleFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RoleFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#rolefilterparameter">RoleFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#rolefilterparameter">RoleFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RoleListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RoleListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#rolesortparameter">RoleSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#rolefilterparameter">RoleFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## RoleSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RoleSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SearchInput</span>
{</div>
<div class="graphql-code-line ">term: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">facetValueIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">facetValueOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line ">facetValueFilters: [<a href="/reference/graphql-api/admin/input-types#facetvaluefilterinput">FacetValueFilterInput</a>!]</div>
<div class="graphql-code-line ">collectionId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">collectionSlug: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">groupByProduct: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#searchresultsortparameter">SearchResultSortParameter</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchResultSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SearchResultSortParameter</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SellerFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SellerFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#sellerfilterparameter">SellerFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#sellerfilterparameter">SellerFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SellerListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SellerListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#sellersortparameter">SellerSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#sellerfilterparameter">SellerFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SellerSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SellerSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SetOrderCustomerInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SetOrderCustomerInput</span>
{</div>
<div class="graphql-code-line ">orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">customerId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">note: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SettleRefundInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SettleRefundInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">transactionId: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethodFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ShippingMethodFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">fulfillmentHandlerCode: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#shippingmethodfilterparameter">ShippingMethodFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#shippingmethodfilterparameter">ShippingMethodFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethodListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ShippingMethodListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#shippingmethodsortparameter">ShippingMethodSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#shippingmethodfilterparameter">ShippingMethodFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethodSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ShippingMethodSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">fulfillmentHandlerCode: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethodTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ShippingMethodTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## StockLevelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">StockLevelInput</span>
{</div>
<div class="graphql-code-line ">stockLocationId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">stockOnHand: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## StockLocationFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">StockLocationFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#stocklocationfilterparameter">StockLocationFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#stocklocationfilterparameter">StockLocationFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## StockLocationListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">StockLocationListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#stocklocationsortparameter">StockLocationSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#stocklocationfilterparameter">StockLocationFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## StockLocationSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">StockLocationSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## StockMovementListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">StockMovementListOptions</span>
{</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#stockmovementtype">StockMovementType</a></div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## StringListOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a list of String fields</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">StringListOperators</span>
{</div>
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## StringOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a String field</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">StringOperators</span>
{</div>
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">notEq: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">contains: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">notContains: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">in: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">notIn: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">regex: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SurchargeInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SurchargeInput</span>
{</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">priceIncludesTax: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line ">taxDescription: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TagFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TagFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#tagfilterparameter">TagFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#tagfilterparameter">TagFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TagListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TagListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#tagsortparameter">TagSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#tagfilterparameter">TagFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TagSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TagSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxCategoryFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TaxCategoryFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">isDefault: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#taxcategoryfilterparameter">TaxCategoryFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#taxcategoryfilterparameter">TaxCategoryFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxCategoryListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TaxCategoryListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#taxcategorysortparameter">TaxCategorySortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#taxcategoryfilterparameter">TaxCategoryFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxCategorySortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TaxCategorySortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxRateFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TaxRateFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#taxratefilterparameter">TaxRateFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#taxratefilterparameter">TaxRateFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxRateListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TaxRateListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#taxratesortparameter">TaxRateSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#taxratefilterparameter">TaxRateFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxRateSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TaxRateSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TestEligibleShippingMethodsInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TestEligibleShippingMethodsInput</span>
{</div>
<div class="graphql-code-line ">shippingAddress: <a href="/reference/graphql-api/admin/input-types#createaddressinput">CreateAddressInput</a>!</div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/admin/input-types#testshippingmethodorderlineinput">TestShippingMethodOrderLineInput</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TestShippingMethodInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TestShippingMethodInput</span>
{</div>
<div class="graphql-code-line ">checker: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!</div>
<div class="graphql-code-line ">calculator: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!</div>
<div class="graphql-code-line ">shippingAddress: <a href="/reference/graphql-api/admin/input-types#createaddressinput">CreateAddressInput</a>!</div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/admin/input-types#testshippingmethodorderlineinput">TestShippingMethodOrderLineInput</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TestShippingMethodOrderLineInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">TestShippingMethodOrderLineInput</span>
{</div>
<div class="graphql-code-line ">productVariantId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateActiveAdministratorInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateActiveAdministratorInput</span>
{</div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">password: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateAddressInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateAddressInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">company: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">city: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">province: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">countryCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">defaultShippingAddress: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">defaultBillingAddress: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateAdministratorInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateAdministratorInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">password: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">roleIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateAssetInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateAssetInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">focalPoint: <a href="/reference/graphql-api/admin/input-types#coordinateinput">CoordinateInput</a></div>
<div class="graphql-code-line ">tags: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateChannelInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateChannelInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">token: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">defaultLanguageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a></div>
<div class="graphql-code-line ">availableLanguageCodes: [<a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!]</div>
<div class="graphql-code-line ">pricesIncludeTax: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a></div>
<div class="graphql-code-line ">defaultCurrencyCode: <a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a></div>
<div class="graphql-code-line ">availableCurrencyCodes: [<a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a>!]</div>
<div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">defaultTaxZoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">defaultShippingZoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">sellerId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateCollectionInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateCollectionInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">isPrivate: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">featuredAssetId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">assetIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">inheritFilters: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">filters: [<a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!]</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#updatecollectiontranslationinput">UpdateCollectionTranslationInput</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateCollectionTranslationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateCollectionTranslationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateCountryInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateCountryInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#countrytranslationinput">CountryTranslationInput</a>!]</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateCustomerGroupInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateCustomerGroupInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateCustomerInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateCustomerInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateCustomerNoteInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateCustomerNoteInput</span>
{</div>
<div class="graphql-code-line ">noteId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">note: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateFacetInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateFacetInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">isPrivate: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#facettranslationinput">FacetTranslationInput</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateFacetValueInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateFacetValueInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#facetvaluetranslationinput">FacetValueTranslationInput</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateGlobalSettingsInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateGlobalSettingsInput</span>
{</div>
<div class="graphql-code-line ">availableLanguages: [<a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!]</div>
<div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateOrderAddressInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateOrderAddressInput</span>
{</div>
<div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">company: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">city: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">province: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">countryCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateOrderInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateOrderInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateOrderNoteInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateOrderNoteInput</span>
{</div>
<div class="graphql-code-line ">noteId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">note: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">isPublic: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdatePaymentMethodInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdatePaymentMethodInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">checker: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a></div>
<div class="graphql-code-line ">handler: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#paymentmethodtranslationinput">PaymentMethodTranslationInput</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateProductInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateProductInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">featuredAssetId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">assetIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">facetValueIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#producttranslationinput">ProductTranslationInput</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateProductOptionGroupInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateProductOptionGroupInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput">ProductOptionGroupTranslationInput</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateProductOptionInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateProductOptionInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput">ProductOptionGroupTranslationInput</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateProductVariantInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateProductVariantInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#productvarianttranslationinput">ProductVariantTranslationInput</a>!]</div>
<div class="graphql-code-line ">facetValueIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">optionIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">taxCategoryId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Sets the price for the ProductVariant in the Channel's default currency</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/object-types#money">Money</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows multiple prices to be set for the ProductVariant in different currencies.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">prices: [<a href="/reference/graphql-api/admin/input-types#productvariantpriceinput">ProductVariantPriceInput</a>!]</div>
<div class="graphql-code-line ">featuredAssetId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">assetIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">stockOnHand: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">stockLevels: [<a href="/reference/graphql-api/admin/input-types#stocklevelinput">StockLevelInput</a>!]</div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">useGlobalOutOfStockThreshold: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/admin/enums#globalflag">GlobalFlag</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdatePromotionInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdatePromotionInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">startsAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">endsAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">perCustomerUsageLimit: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">usageLimit: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">conditions: [<a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!]</div>
<div class="graphql-code-line ">actions: [<a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a>!]</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#promotiontranslationinput">PromotionTranslationInput</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateProvinceInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateProvinceInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#provincetranslationinput">ProvinceTranslationInput</a>!]</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateRoleInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateRoleInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">permissions: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">channelIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateSellerInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateSellerInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateShippingMethodInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateShippingMethodInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">fulfillmentHandler: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">checker: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a></div>
<div class="graphql-code-line ">calculator: <a href="/reference/graphql-api/admin/input-types#configurableoperationinput">ConfigurableOperationInput</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/input-types#shippingmethodtranslationinput">ShippingMethodTranslationInput</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateStockLocationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateStockLocationInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateTagInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateTagInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateTaxCategoryInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateTaxCategoryInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">isDefault: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateTaxRateInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateTaxRateInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">categoryId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">zoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">customerGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateZoneInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateZoneInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ZoneFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ZoneFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/admin/input-types#zonefilterparameter">ZoneFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/admin/input-types#zonefilterparameter">ZoneFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ZoneListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ZoneListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/admin/input-types#zonesortparameter">ZoneSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/admin/input-types#zonefilterparameter">ZoneFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/admin/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ZoneSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ZoneSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
|
---
title: "Mutations"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## addCustomersToGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Add Customers to a CustomerGroup</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">addCustomersToGroup(customerGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, customerIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## addFulfillmentToOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">addFulfillmentToOrder(input: <a href="/reference/graphql-api/admin/input-types#fulfillorderinput">FulfillOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#addfulfillmenttoorderresult">AddFulfillmentToOrderResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## addItemToDraftOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Adds an item to the draft Order.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">addItemToDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#additemtodraftorderinput">AddItemToDraftOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#updateorderitemsresult">UpdateOrderItemsResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## addManualPaymentToOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Used to manually create a new Payment against an Order.</div>
<div class="graphql-code-line top-level comment">This can be used by an Administrator when an Order is in the ArrangingPayment state.</div>
<div class="graphql-code-line top-level comment"></div>
<div class="graphql-code-line top-level comment">It is also used when a completed Order</div>
<div class="graphql-code-line top-level comment">has been modified (using `modifyOrder`) and the price has increased. The extra payment</div>
<div class="graphql-code-line top-level comment">can then be manually arranged by the administrator, and the details used to create a new</div>
<div class="graphql-code-line top-level comment">Payment.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">addManualPaymentToOrder(input: <a href="/reference/graphql-api/admin/input-types#manualpaymentinput">ManualPaymentInput</a>!): <a href="/reference/graphql-api/admin/object-types#addmanualpaymenttoorderresult">AddManualPaymentToOrderResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## addMembersToZone
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Add members to a Zone</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">addMembersToZone(zoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, memberIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## addNoteToCustomer
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">addNoteToCustomer(input: <a href="/reference/graphql-api/admin/input-types#addnotetocustomerinput">AddNoteToCustomerInput</a>!): <a href="/reference/graphql-api/admin/object-types#customer">Customer</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## addNoteToOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">addNoteToOrder(input: <a href="/reference/graphql-api/admin/input-types#addnotetoorderinput">AddNoteToOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## addOptionGroupToProduct
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Add an OptionGroup to a Product</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">addOptionGroupToProduct(productId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, optionGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#product">Product</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## adjustDraftOrderLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type <code>OrderLineCustomFieldsInput</code> will be available.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">adjustDraftOrderLine(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#adjustdraftorderlineinput">AdjustDraftOrderLineInput</a>!): <a href="/reference/graphql-api/admin/object-types#updateorderitemsresult">UpdateOrderItemsResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## applyCouponCodeToDraftOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Applies the given coupon code to the draft Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">applyCouponCodeToDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#applycouponcoderesult">ApplyCouponCodeResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## assignAssetsToChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Assign assets to channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">assignAssetsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignassetstochannelinput">AssignAssetsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#asset">Asset</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## assignCollectionsToChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Assigns Collections to the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">assignCollectionsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assigncollectionstochannelinput">AssignCollectionsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## assignFacetsToChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Assigns Facets to the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">assignFacetsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignfacetstochannelinput">AssignFacetsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#facet">Facet</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## assignPaymentMethodsToChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Assigns PaymentMethods to the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">assignPaymentMethodsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignpaymentmethodstochannelinput">AssignPaymentMethodsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## assignProductVariantsToChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Assigns ProductVariants to the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">assignProductVariantsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignproductvariantstochannelinput">AssignProductVariantsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## assignProductsToChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Assigns all ProductVariants of Product to the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">assignProductsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignproductstochannelinput">AssignProductsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#product">Product</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## assignPromotionsToChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Assigns Promotions to the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">assignPromotionsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignpromotionstochannelinput">AssignPromotionsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## assignRoleToAdministrator
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Assign a Role to an Administrator</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">assignRoleToAdministrator(administratorId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, roleId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## assignShippingMethodsToChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Assigns ShippingMethods to the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">assignShippingMethodsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignshippingmethodstochannelinput">AssignShippingMethodsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## assignStockLocationsToChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Assigns StockLocations to the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">assignStockLocationsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignstocklocationstochannelinput">AssignStockLocationsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## authenticate
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Authenticates the user using a named authentication strategy</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">authenticate(input: <a href="/reference/graphql-api/admin/input-types#authenticationinput">AuthenticationInput</a>!, rememberMe: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#authenticationresult">AuthenticationResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## cancelJob
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">cancelJob(jobId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#job">Job</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## cancelOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">cancelOrder(input: <a href="/reference/graphql-api/admin/input-types#cancelorderinput">CancelOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#cancelorderresult">CancelOrderResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## cancelPayment
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">cancelPayment(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#cancelpaymentresult">CancelPaymentResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createAdministrator
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Administrator</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createAdministrator(input: <a href="/reference/graphql-api/admin/input-types#createadministratorinput">CreateAdministratorInput</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createAssets
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Asset</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createAssets(input: [<a href="/reference/graphql-api/admin/input-types#createassetinput">CreateAssetInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#createassetresult">CreateAssetResult</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createChannel(input: <a href="/reference/graphql-api/admin/input-types#createchannelinput">CreateChannelInput</a>!): <a href="/reference/graphql-api/admin/object-types#createchannelresult">CreateChannelResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createCollection
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Collection</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createCollection(input: <a href="/reference/graphql-api/admin/input-types#createcollectioninput">CreateCollectionInput</a>!): <a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createCountry
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Country</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createCountry(input: <a href="/reference/graphql-api/admin/input-types#createcountryinput">CreateCountryInput</a>!): <a href="/reference/graphql-api/admin/object-types#country">Country</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createCustomer
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createCustomer(input: <a href="/reference/graphql-api/admin/input-types#createcustomerinput">CreateCustomerInput</a>!, password: <a href="/reference/graphql-api/admin/object-types#string">String</a>): <a href="/reference/graphql-api/admin/object-types#createcustomerresult">CreateCustomerResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createCustomerAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Address and associate it with the Customer specified by customerId</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createCustomerAddress(customerId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#address">Address</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createCustomerGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new CustomerGroup</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createCustomerGroup(input: <a href="/reference/graphql-api/admin/input-types#createcustomergroupinput">CreateCustomerGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createDraftOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Creates a draft Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createDraftOrder: <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createFacet
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Facet</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createFacet(input: <a href="/reference/graphql-api/admin/input-types#createfacetinput">CreateFacetInput</a>!): <a href="/reference/graphql-api/admin/object-types#facet">Facet</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createFacetValues
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create one or more FacetValues</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createFacetValues(input: [<a href="/reference/graphql-api/admin/input-types#createfacetvalueinput">CreateFacetValueInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createPaymentMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create existing PaymentMethod</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createPaymentMethod(input: <a href="/reference/graphql-api/admin/input-types#createpaymentmethodinput">CreatePaymentMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createProduct
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Product</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createProduct(input: <a href="/reference/graphql-api/admin/input-types#createproductinput">CreateProductInput</a>!): <a href="/reference/graphql-api/admin/object-types#product">Product</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createProductOption
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new ProductOption within a ProductOptionGroup</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createProductOption(input: <a href="/reference/graphql-api/admin/input-types#createproductoptioninput">CreateProductOptionInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoption">ProductOption</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createProductOptionGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new ProductOptionGroup</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createProductOptionGroup(input: <a href="/reference/graphql-api/admin/input-types#createproductoptiongroupinput">CreateProductOptionGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createProductVariants
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a set of ProductVariants based on the OptionGroups assigned to the given Product</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createProductVariants(input: [<a href="/reference/graphql-api/admin/input-types#createproductvariantinput">CreateProductVariantInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createPromotion
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createPromotion(input: <a href="/reference/graphql-api/admin/input-types#createpromotioninput">CreatePromotionInput</a>!): <a href="/reference/graphql-api/admin/object-types#createpromotionresult">CreatePromotionResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createProvince
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Province</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createProvince(input: <a href="/reference/graphql-api/admin/input-types#createprovinceinput">CreateProvinceInput</a>!): <a href="/reference/graphql-api/admin/object-types#province">Province</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createRole
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Role</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createRole(input: <a href="/reference/graphql-api/admin/input-types#createroleinput">CreateRoleInput</a>!): <a href="/reference/graphql-api/admin/object-types#role">Role</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createSeller
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Seller</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createSeller(input: <a href="/reference/graphql-api/admin/input-types#createsellerinput">CreateSellerInput</a>!): <a href="/reference/graphql-api/admin/object-types#seller">Seller</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createShippingMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new ShippingMethod</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createShippingMethod(input: <a href="/reference/graphql-api/admin/input-types#createshippingmethodinput">CreateShippingMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createStockLocation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createStockLocation(input: <a href="/reference/graphql-api/admin/input-types#createstocklocationinput">CreateStockLocationInput</a>!): <a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createTag
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Tag</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createTag(input: <a href="/reference/graphql-api/admin/input-types#createtaginput">CreateTagInput</a>!): <a href="/reference/graphql-api/admin/object-types#tag">Tag</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createTaxCategory
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new TaxCategory</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createTaxCategory(input: <a href="/reference/graphql-api/admin/input-types#createtaxcategoryinput">CreateTaxCategoryInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxcategory">TaxCategory</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createTaxRate
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new TaxRate</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createTaxRate(input: <a href="/reference/graphql-api/admin/input-types#createtaxrateinput">CreateTaxRateInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxrate">TaxRate</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createZone
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Zone</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createZone(input: <a href="/reference/graphql-api/admin/input-types#createzoneinput">CreateZoneInput</a>!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteAdministrator
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete an Administrator</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteAdministrator(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteAdministrators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple Administrators</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteAdministrators(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteAsset
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete an Asset</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteAsset(input: <a href="/reference/graphql-api/admin/input-types#deleteassetinput">DeleteAssetInput</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteAssets
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple Assets</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteAssets(input: <a href="/reference/graphql-api/admin/input-types#deleteassetsinput">DeleteAssetsInput</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteChannel(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteChannels
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple Channels</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteChannels(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteCollection
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a Collection and all of its descendants</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteCollection(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteCollections
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple Collections and all of their descendants</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteCollections(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteCountries
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple Countries</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteCountries(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteCountry
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a Country</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteCountry(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteCustomer
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a Customer</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteCustomer(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteCustomerAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Address</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteCustomerAddress(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteCustomerGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a CustomerGroup</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteCustomerGroup(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteCustomerGroups
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple CustomerGroups</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteCustomerGroups(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteCustomerNote
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteCustomerNote(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteCustomers
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Deletes Customers</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteCustomers(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteDraftOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Deletes a draft Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteFacet
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete an existing Facet</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteFacet(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteFacetValues
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete one or more FacetValues</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteFacetValues(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteFacets
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple existing Facets</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteFacets(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteOrderNote
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteOrderNote(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deletePaymentMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a PaymentMethod</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deletePaymentMethod(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deletePaymentMethods
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple PaymentMethods</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deletePaymentMethods(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteProduct
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a Product</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteProduct(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteProductOption
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a ProductOption</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteProductOption(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteProductVariant
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a ProductVariant</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteProductVariant(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteProductVariants
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple ProductVariants</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteProductVariants(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteProducts
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple Products</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteProducts(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deletePromotion
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deletePromotion(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deletePromotions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deletePromotions(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteProvince
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a Province</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteProvince(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteRole
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete an existing Role</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteRole(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteRoles
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple Roles</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteRoles(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteSeller
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a Seller</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteSeller(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteSellers
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple Sellers</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteSellers(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteShippingMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a ShippingMethod</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteShippingMethod(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteShippingMethods
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple ShippingMethods</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteShippingMethods(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteStockLocation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteStockLocation(input: <a href="/reference/graphql-api/admin/input-types#deletestocklocationinput">DeleteStockLocationInput</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteStockLocations
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteStockLocations(input: [<a href="/reference/graphql-api/admin/input-types#deletestocklocationinput">DeleteStockLocationInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteTag
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete an existing Tag</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteTag(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteTaxCategories
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Deletes multiple TaxCategories</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteTaxCategories(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteTaxCategory
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Deletes a TaxCategory</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteTaxCategory(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteTaxRate
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a TaxRate</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteTaxRate(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteTaxRates
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete multiple TaxRates</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteTaxRates(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteZone
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a Zone</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteZone(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteZones
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete a Zone</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteZones(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## duplicateEntity
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">duplicateEntity(input: <a href="/reference/graphql-api/admin/input-types#duplicateentityinput">DuplicateEntityInput</a>!): <a href="/reference/graphql-api/admin/object-types#duplicateentityresult">DuplicateEntityResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## flushBufferedJobs
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">flushBufferedJobs(bufferIds: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]): <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## importProducts
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">importProducts(csvFile: <a href="/reference/graphql-api/admin/object-types#upload">Upload</a>!): <a href="/reference/graphql-api/admin/object-types#importinfo">ImportInfo</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## login
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})`</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">login(username: <a href="/reference/graphql-api/admin/object-types#string">String</a>!, password: <a href="/reference/graphql-api/admin/object-types#string">String</a>!, rememberMe: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#nativeauthenticationresult">NativeAuthenticationResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## logout
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">logout: <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## modifyOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Allows an Order to be modified after it has been completed by the Customer. The Order must first</div>
<div class="graphql-code-line top-level comment">be in the <code>Modifying</code> state.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">modifyOrder(input: <a href="/reference/graphql-api/admin/input-types#modifyorderinput">ModifyOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#modifyorderresult">ModifyOrderResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## moveCollection
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Move a Collection to a different parent or index</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">moveCollection(input: <a href="/reference/graphql-api/admin/input-types#movecollectioninput">MoveCollectionInput</a>!): <a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## refundOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">refundOrder(input: <a href="/reference/graphql-api/admin/input-types#refundorderinput">RefundOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#refundorderresult">RefundOrderResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## reindex
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">reindex: <a href="/reference/graphql-api/admin/object-types#job">Job</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeCollectionsFromChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Removes Collections from the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeCollectionsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removecollectionsfromchannelinput">RemoveCollectionsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeCouponCodeFromDraftOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Removes the given coupon code from the draft Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeCouponCodeFromDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeCustomersFromGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Remove Customers from a CustomerGroup</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeCustomersFromGroup(customerGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, customerIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeDraftOrderLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Remove an OrderLine from the draft Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeDraftOrderLine(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, orderLineId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#removeorderitemsresult">RemoveOrderItemsResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeFacetsFromChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Removes Facets from the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeFacetsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removefacetsfromchannelinput">RemoveFacetsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#removefacetfromchannelresult">RemoveFacetFromChannelResult</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeMembersFromZone
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Remove members from a Zone</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeMembersFromZone(zoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, memberIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeOptionGroupFromProduct
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants</div>
<div class="graphql-code-line top-level comment">the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed.</div>
<div class="graphql-code-line top-level comment">Setting the <code>force</code> argument to <code>true</code> will override this and remove the OptionGroup anyway,</div>
<div class="graphql-code-line top-level comment">as well as removing any of the group's options from the Product's ProductVariants.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeOptionGroupFromProduct(productId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, optionGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#removeoptiongroupfromproductresult">RemoveOptionGroupFromProductResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removePaymentMethodsFromChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Removes PaymentMethods from the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removePaymentMethodsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removepaymentmethodsfromchannelinput">RemovePaymentMethodsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeProductVariantsFromChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Removes ProductVariants from the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeProductVariantsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removeproductvariantsfromchannelinput">RemoveProductVariantsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeProductsFromChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Removes all ProductVariants of Product from the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeProductsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removeproductsfromchannelinput">RemoveProductsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#product">Product</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removePromotionsFromChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Removes Promotions from the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removePromotionsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removepromotionsfromchannelinput">RemovePromotionsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeSettledJobs
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeSettledJobs(queueNames: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!], olderThan: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>): <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeShippingMethodsFromChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Removes ShippingMethods from the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeShippingMethodsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removeshippingmethodsfromchannelinput">RemoveShippingMethodsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeStockLocationsFromChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Removes StockLocations from the specified Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeStockLocationsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removestocklocationsfromchannelinput">RemoveStockLocationsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## runPendingSearchIndexUpdates
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">runPendingSearchIndexUpdates: <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## setCustomerForDraftOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setCustomerForDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, customerId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>, input: <a href="/reference/graphql-api/admin/input-types#createcustomerinput">CreateCustomerInput</a>): <a href="/reference/graphql-api/admin/object-types#setcustomerfordraftorderresult">SetCustomerForDraftOrderResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## setDraftOrderBillingAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Sets the billing address for a draft Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setDraftOrderBillingAddress(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## setDraftOrderCustomFields
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Allows any custom fields to be set for the active order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setDraftOrderCustomFields(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#updateorderinput">UpdateOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## setDraftOrderShippingAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Sets the shipping address for a draft Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setDraftOrderShippingAddress(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## setDraftOrderShippingMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Sets the shipping method by id, which can be obtained with the <code>eligibleShippingMethodsForDraftOrder</code> query</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setDraftOrderShippingMethod(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, shippingMethodId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#setordershippingmethodresult">SetOrderShippingMethodResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## setOrderCustomFields
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setOrderCustomFields(input: <a href="/reference/graphql-api/admin/input-types#updateorderinput">UpdateOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## setOrderCustomer
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Allows a different Customer to be assigned to an Order. Added in v2.2.0.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setOrderCustomer(input: <a href="/reference/graphql-api/admin/input-types#setordercustomerinput">SetOrderCustomerInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## settlePayment
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">settlePayment(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#settlepaymentresult">SettlePaymentResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## settleRefund
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">settleRefund(input: <a href="/reference/graphql-api/admin/input-types#settlerefundinput">SettleRefundInput</a>!): <a href="/reference/graphql-api/admin/object-types#settlerefundresult">SettleRefundResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## transitionFulfillmentToState
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">transitionFulfillmentToState(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#transitionfulfillmenttostateresult">TransitionFulfillmentToStateResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## transitionOrderToState
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">transitionOrderToState(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#transitionordertostateresult">TransitionOrderToStateResult</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## transitionPaymentToState
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">transitionPaymentToState(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#transitionpaymenttostateresult">TransitionPaymentToStateResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateActiveAdministrator
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update the active (currently logged-in) Administrator</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateActiveAdministrator(input: <a href="/reference/graphql-api/admin/input-types#updateactiveadministratorinput">UpdateActiveAdministratorInput</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateAdministrator
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Administrator</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateAdministrator(input: <a href="/reference/graphql-api/admin/input-types#updateadministratorinput">UpdateAdministratorInput</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateAsset
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Asset</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateAsset(input: <a href="/reference/graphql-api/admin/input-types#updateassetinput">UpdateAssetInput</a>!): <a href="/reference/graphql-api/admin/object-types#asset">Asset</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateChannel(input: <a href="/reference/graphql-api/admin/input-types#updatechannelinput">UpdateChannelInput</a>!): <a href="/reference/graphql-api/admin/object-types#updatechannelresult">UpdateChannelResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateCollection
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Collection</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateCollection(input: <a href="/reference/graphql-api/admin/input-types#updatecollectioninput">UpdateCollectionInput</a>!): <a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateCountry
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Country</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateCountry(input: <a href="/reference/graphql-api/admin/input-types#updatecountryinput">UpdateCountryInput</a>!): <a href="/reference/graphql-api/admin/object-types#country">Country</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateCustomer
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Customer</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateCustomer(input: <a href="/reference/graphql-api/admin/input-types#updatecustomerinput">UpdateCustomerInput</a>!): <a href="/reference/graphql-api/admin/object-types#updatecustomerresult">UpdateCustomerResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateCustomerAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Address</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateCustomerAddress(input: <a href="/reference/graphql-api/admin/input-types#updateaddressinput">UpdateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#address">Address</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateCustomerGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing CustomerGroup</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateCustomerGroup(input: <a href="/reference/graphql-api/admin/input-types#updatecustomergroupinput">UpdateCustomerGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateCustomerNote
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateCustomerNote(input: <a href="/reference/graphql-api/admin/input-types#updatecustomernoteinput">UpdateCustomerNoteInput</a>!): <a href="/reference/graphql-api/admin/object-types#historyentry">HistoryEntry</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateFacet
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Facet</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateFacet(input: <a href="/reference/graphql-api/admin/input-types#updatefacetinput">UpdateFacetInput</a>!): <a href="/reference/graphql-api/admin/object-types#facet">Facet</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateFacetValues
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update one or more FacetValues</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateFacetValues(input: [<a href="/reference/graphql-api/admin/input-types#updatefacetvalueinput">UpdateFacetValueInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateGlobalSettings
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateGlobalSettings(input: <a href="/reference/graphql-api/admin/input-types#updateglobalsettingsinput">UpdateGlobalSettingsInput</a>!): <a href="/reference/graphql-api/admin/object-types#updateglobalsettingsresult">UpdateGlobalSettingsResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateOrderNote
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateOrderNote(input: <a href="/reference/graphql-api/admin/input-types#updateordernoteinput">UpdateOrderNoteInput</a>!): <a href="/reference/graphql-api/admin/object-types#historyentry">HistoryEntry</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updatePaymentMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing PaymentMethod</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updatePaymentMethod(input: <a href="/reference/graphql-api/admin/input-types#updatepaymentmethodinput">UpdatePaymentMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateProduct
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Product</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateProduct(input: <a href="/reference/graphql-api/admin/input-types#updateproductinput">UpdateProductInput</a>!): <a href="/reference/graphql-api/admin/object-types#product">Product</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateProductOption
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new ProductOption within a ProductOptionGroup</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateProductOption(input: <a href="/reference/graphql-api/admin/input-types#updateproductoptioninput">UpdateProductOptionInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoption">ProductOption</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateProductOptionGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing ProductOptionGroup</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateProductOptionGroup(input: <a href="/reference/graphql-api/admin/input-types#updateproductoptiongroupinput">UpdateProductOptionGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateProductVariants
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update existing ProductVariants</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateProductVariants(input: [<a href="/reference/graphql-api/admin/input-types#updateproductvariantinput">UpdateProductVariantInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateProducts
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update multiple existing Products</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateProducts(input: [<a href="/reference/graphql-api/admin/input-types#updateproductinput">UpdateProductInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#product">Product</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updatePromotion
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updatePromotion(input: <a href="/reference/graphql-api/admin/input-types#updatepromotioninput">UpdatePromotionInput</a>!): <a href="/reference/graphql-api/admin/object-types#updatepromotionresult">UpdatePromotionResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateProvince
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Province</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateProvince(input: <a href="/reference/graphql-api/admin/input-types#updateprovinceinput">UpdateProvinceInput</a>!): <a href="/reference/graphql-api/admin/object-types#province">Province</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateRole
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Role</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateRole(input: <a href="/reference/graphql-api/admin/input-types#updateroleinput">UpdateRoleInput</a>!): <a href="/reference/graphql-api/admin/object-types#role">Role</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateSeller
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Seller</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateSeller(input: <a href="/reference/graphql-api/admin/input-types#updatesellerinput">UpdateSellerInput</a>!): <a href="/reference/graphql-api/admin/object-types#seller">Seller</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateShippingMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing ShippingMethod</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateShippingMethod(input: <a href="/reference/graphql-api/admin/input-types#updateshippingmethodinput">UpdateShippingMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateStockLocation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateStockLocation(input: <a href="/reference/graphql-api/admin/input-types#updatestocklocationinput">UpdateStockLocationInput</a>!): <a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateTag
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Tag</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateTag(input: <a href="/reference/graphql-api/admin/input-types#updatetaginput">UpdateTagInput</a>!): <a href="/reference/graphql-api/admin/object-types#tag">Tag</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateTaxCategory
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing TaxCategory</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateTaxCategory(input: <a href="/reference/graphql-api/admin/input-types#updatetaxcategoryinput">UpdateTaxCategoryInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxcategory">TaxCategory</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateTaxRate
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing TaxRate</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateTaxRate(input: <a href="/reference/graphql-api/admin/input-types#updatetaxrateinput">UpdateTaxRateInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxrate">TaxRate</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateZone
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Zone</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateZone(input: <a href="/reference/graphql-api/admin/input-types#updatezoneinput">UpdateZoneInput</a>!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
|
---
title: "Types"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AddFulfillmentToOrderResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">AddFulfillmentToOrderResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#fulfillment">Fulfillment</a> | <a href="/reference/graphql-api/admin/object-types#emptyorderlineselectionerror">EmptyOrderLineSelectionError</a> | <a href="/reference/graphql-api/admin/object-types#itemsalreadyfulfillederror">ItemsAlreadyFulfilledError</a> | <a href="/reference/graphql-api/admin/object-types#insufficientstockonhanderror">InsufficientStockOnHandError</a> | <a href="/reference/graphql-api/admin/object-types#invalidfulfillmenthandlererror">InvalidFulfillmentHandlerError</a> | <a href="/reference/graphql-api/admin/object-types#fulfillmentstatetransitionerror">FulfillmentStateTransitionError</a> | <a href="/reference/graphql-api/admin/object-types#createfulfillmenterror">CreateFulfillmentError</a></div>
</div>
## AddManualPaymentToOrderResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">AddManualPaymentToOrderResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#order">Order</a> | <a href="/reference/graphql-api/admin/object-types#manualpaymentstateerror">ManualPaymentStateError</a></div>
</div>
## Address
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Address</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">company: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">city: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">province: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">country: <a href="/reference/graphql-api/admin/object-types#country">Country</a>!</div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">defaultShippingAddress: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">defaultBillingAddress: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## Adjustment
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Adjustment</span>
{</div>
<div class="graphql-code-line ">adjustmentSource: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#adjustmenttype">AdjustmentType</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">amount: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">data: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## Administrator
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Administrator</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">user: <a href="/reference/graphql-api/admin/object-types#user">User</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AdministratorList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">AdministratorList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Allocation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Allocation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">productVariant: <a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#stockmovementtype">StockMovementType</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">orderLine: <a href="/reference/graphql-api/admin/object-types#orderline">OrderLine</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AlreadyRefundedError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if an attempting to refund an OrderItem which has already been refunded</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">AlreadyRefundedError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">refundId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ApplyCouponCodeResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">ApplyCouponCodeResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#order">Order</a> | <a href="/reference/graphql-api/admin/object-types#couponcodeexpirederror">CouponCodeExpiredError</a> | <a href="/reference/graphql-api/admin/object-types#couponcodeinvaliderror">CouponCodeInvalidError</a> | <a href="/reference/graphql-api/admin/object-types#couponcodelimiterror">CouponCodeLimitError</a></div>
</div>
## Asset
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Asset</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#assettype">AssetType</a>!</div>
<div class="graphql-code-line ">fileSize: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">mimeType: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">width: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">height: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">source: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">preview: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">focalPoint: <a href="/reference/graphql-api/admin/object-types#coordinate">Coordinate</a></div>
<div class="graphql-code-line ">tags: [<a href="/reference/graphql-api/admin/object-types#tag">Tag</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssetList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">AssetList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#asset">Asset</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AuthenticationMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">AuthenticationMethod</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">strategy: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AuthenticationResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">AuthenticationResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#currentuser">CurrentUser</a> | <a href="/reference/graphql-api/admin/object-types#invalidcredentialserror">InvalidCredentialsError</a></div>
</div>
## Boolean
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>Boolean</code> scalar type represents <code>true</code> or `false`.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Boolean</span>
</div>
</div>
## BooleanCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">BooleanCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CancelActiveOrderError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if an attempting to cancel lines from an Order which is still active</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CancelActiveOrderError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">orderState: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CancelOrderResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">CancelOrderResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#order">Order</a> | <a href="/reference/graphql-api/admin/object-types#emptyorderlineselectionerror">EmptyOrderLineSelectionError</a> | <a href="/reference/graphql-api/admin/object-types#quantitytoogreaterror">QuantityTooGreatError</a> | <a href="/reference/graphql-api/admin/object-types#multipleordererror">MultipleOrderError</a> | <a href="/reference/graphql-api/admin/object-types#cancelactiveordererror">CancelActiveOrderError</a> | <a href="/reference/graphql-api/admin/object-types#orderstatetransitionerror">OrderStateTransitionError</a></div>
</div>
## CancelPaymentError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the Payment cancellation fails</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CancelPaymentError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">paymentErrorMessage: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CancelPaymentResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">CancelPaymentResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#payment">Payment</a> | <a href="/reference/graphql-api/admin/object-types#cancelpaymenterror">CancelPaymentError</a> | <a href="/reference/graphql-api/admin/object-types#paymentstatetransitionerror">PaymentStateTransitionError</a></div>
</div>
## Cancellation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Cancellation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">productVariant: <a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#stockmovementtype">StockMovementType</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">orderLine: <a href="/reference/graphql-api/admin/object-types#orderline">OrderLine</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Channel
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Channel</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">token: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">defaultTaxZone: <a href="/reference/graphql-api/admin/object-types#zone">Zone</a></div>
<div class="graphql-code-line ">defaultShippingZone: <a href="/reference/graphql-api/admin/object-types#zone">Zone</a></div>
<div class="graphql-code-line ">defaultLanguageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">availableLanguageCodes: [<a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!]</div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">defaultCurrencyCode: <a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">availableCurrencyCodes: [<a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Not yet used - will be implemented in a future release.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Not yet used - will be implemented in a future release.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">pricesIncludeTax: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">seller: <a href="/reference/graphql-api/admin/object-types#seller">Seller</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ChannelDefaultLanguageError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when the default LanguageCode of a Channel is no longer found in the `availableLanguages`</div>
<div class="graphql-code-line top-level comment">of the GlobalSettings</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ChannelDefaultLanguageError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">language: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">channelCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ChannelList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ChannelList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#channel">Channel</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Collection
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Collection</span>
{</div>
<div class="graphql-code-line ">isPrivate: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">inheritFilters: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">breadcrumbs: [<a href="/reference/graphql-api/admin/object-types#collectionbreadcrumb">CollectionBreadcrumb</a>!]!</div>
<div class="graphql-code-line ">position: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/admin/object-types#asset">Asset</a></div>
<div class="graphql-code-line ">assets: [<a href="/reference/graphql-api/admin/object-types#asset">Asset</a>!]!</div>
<div class="graphql-code-line ">parent: <a href="/reference/graphql-api/admin/object-types#collection">Collection</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">children: [<a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!]</div>
<div class="graphql-code-line ">filters: [<a href="/reference/graphql-api/admin/object-types#configurableoperation">ConfigurableOperation</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#collectiontranslation">CollectionTranslation</a>!]!</div>
<div class="graphql-code-line ">productVariants(options: <a href="/reference/graphql-api/admin/input-types#productvariantlistoptions">ProductVariantListOptions</a>): <a href="/reference/graphql-api/admin/object-types#productvariantlist">ProductVariantList</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionBreadcrumb
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionBreadcrumb</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Which Collections are present in the products returned</div>
<div class="graphql-code-line top-level comment">by the search, and in what quantity.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionResult</span>
{</div>
<div class="graphql-code-line ">collection: <a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!</div>
<div class="graphql-code-line ">count: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigArg
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigArg</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigArgDefinition
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigArgDefinition</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">required: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">defaultValue: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line ">label: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigurableOperation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigurableOperation</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">args: [<a href="/reference/graphql-api/admin/object-types#configarg">ConfigArg</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigurableOperationDefinition
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigurableOperationDefinition</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">args: [<a href="/reference/graphql-api/admin/object-types#configargdefinition">ConfigArgDefinition</a>!]!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Coordinate
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Coordinate</span>
{</div>
<div class="graphql-code-line ">x: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line ">y: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Country
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Country</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">parent: <a href="/reference/graphql-api/admin/object-types#region">Region</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#regiontranslation">RegionTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CountryList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CountryList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#country">Country</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CouponCodeExpiredError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the provided coupon code is invalid</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CouponCodeExpiredError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CouponCodeInvalidError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the provided coupon code is invalid</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CouponCodeInvalidError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CouponCodeLimitError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the provided coupon code is invalid</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CouponCodeLimitError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">limit: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateAssetResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">CreateAssetResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#asset">Asset</a> | <a href="/reference/graphql-api/admin/object-types#mimetypeerror">MimeTypeError</a></div>
</div>
## CreateChannelResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">CreateChannelResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#channel">Channel</a> | <a href="/reference/graphql-api/admin/object-types#languagenotavailableerror">LanguageNotAvailableError</a></div>
</div>
## CreateCustomerResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">CreateCustomerResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#customer">Customer</a> | <a href="/reference/graphql-api/admin/object-types#emailaddressconflicterror">EmailAddressConflictError</a></div>
</div>
## CreateFulfillmentError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if an error is thrown in a FulfillmentHandler's createFulfillment method</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CreateFulfillmentError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">fulfillmentHandlerError: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreatePromotionResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">CreatePromotionResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a> | <a href="/reference/graphql-api/admin/object-types#missingconditionserror">MissingConditionsError</a></div>
</div>
## CurrentUser
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CurrentUser</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">identifier: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">channels: [<a href="/reference/graphql-api/admin/object-types#currentuserchannel">CurrentUserChannel</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CurrentUserChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CurrentUserChannel</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">token: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">permissions: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">CustomFieldConfig</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#stringcustomfieldconfig">StringCustomFieldConfig</a> | <a href="/reference/graphql-api/admin/object-types#localestringcustomfieldconfig">LocaleStringCustomFieldConfig</a> | <a href="/reference/graphql-api/admin/object-types#intcustomfieldconfig">IntCustomFieldConfig</a> | <a href="/reference/graphql-api/admin/object-types#floatcustomfieldconfig">FloatCustomFieldConfig</a> | <a href="/reference/graphql-api/admin/object-types#booleancustomfieldconfig">BooleanCustomFieldConfig</a> | <a href="/reference/graphql-api/admin/object-types#datetimecustomfieldconfig">DateTimeCustomFieldConfig</a> | <a href="/reference/graphql-api/admin/object-types#relationcustomfieldconfig">RelationCustomFieldConfig</a> | <a href="/reference/graphql-api/admin/object-types#textcustomfieldconfig">TextCustomFieldConfig</a> | <a href="/reference/graphql-api/admin/object-types#localetextcustomfieldconfig">LocaleTextCustomFieldConfig</a></div>
</div>
## CustomFields
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">This type is deprecated in v2.2 in favor of the EntityCustomFields type,</div>
<div class="graphql-code-line top-level comment">which allows custom fields to be defined on user-supplies entities.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CustomFields</span>
{</div>
<div class="graphql-code-line ">Address: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Administrator: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Asset: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Channel: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Collection: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Customer: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">CustomerGroup: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Facet: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">FacetValue: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Fulfillment: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">GlobalSettings: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Order: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">OrderLine: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">PaymentMethod: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Product: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">ProductOption: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">ProductOptionGroup: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">ProductVariant: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">ProductVariantPrice: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Promotion: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Region: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Seller: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">ShippingMethod: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">StockLocation: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">TaxCategory: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">TaxRate: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">User: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line ">Zone: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Customer
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Customer</span>
{</div>
<div class="graphql-code-line ">groups: [<a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!]!</div>
<div class="graphql-code-line ">history(options: <a href="/reference/graphql-api/admin/input-types#historyentrylistoptions">HistoryEntryListOptions</a>): <a href="/reference/graphql-api/admin/object-types#historyentrylist">HistoryEntryList</a>!</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">addresses: [<a href="/reference/graphql-api/admin/object-types#address">Address</a>!]</div>
<div class="graphql-code-line ">orders(options: <a href="/reference/graphql-api/admin/input-types#orderlistoptions">OrderListOptions</a>): <a href="/reference/graphql-api/admin/object-types#orderlist">OrderList</a>!</div>
<div class="graphql-code-line ">user: <a href="/reference/graphql-api/admin/object-types#user">User</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CustomerGroup</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">customers(options: <a href="/reference/graphql-api/admin/input-types#customerlistoptions">CustomerListOptions</a>): <a href="/reference/graphql-api/admin/object-types#customerlist">CustomerList</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerGroupList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CustomerGroupList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CustomerList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#customer">Customer</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## DateTime
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the <code>date-time</code> format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">DateTime</span>
</div>
</div>
## DateTimeCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Expects the same validation formats as the <code><input type="datetime-local"></code> HTML element.</div>
<div class="graphql-code-line top-level comment">See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">DateTimeCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">min: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">max: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">step: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## DeletionResponse
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">DeletionResponse</span>
{</div>
<div class="graphql-code-line ">result: <a href="/reference/graphql-api/admin/enums#deletionresult">DeletionResult</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## Discount
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Discount</span>
{</div>
<div class="graphql-code-line ">adjustmentSource: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#adjustmenttype">AdjustmentType</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">amount: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">amountWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## DuplicateEntityError
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">DuplicateEntityError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">duplicationError: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## DuplicateEntityResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">DuplicateEntityResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#duplicateentitysuccess">DuplicateEntitySuccess</a> | <a href="/reference/graphql-api/admin/object-types#duplicateentityerror">DuplicateEntityError</a></div>
</div>
## DuplicateEntitySuccess
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">DuplicateEntitySuccess</span>
{</div>
<div class="graphql-code-line ">newEntityId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## EmailAddressConflictError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to create a Customer with an email address already registered to an existing User.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">EmailAddressConflictError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## EmptyOrderLineSelectionError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if no OrderLines have been specified for the operation</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">EmptyOrderLineSelectionError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## EntityCustomFields
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">EntityCustomFields</span>
{</div>
<div class="graphql-code-line ">entityName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">customFields: [<a href="/reference/graphql-api/admin/object-types#customfieldconfig">CustomFieldConfig</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## EntityDuplicatorDefinition
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">EntityDuplicatorDefinition</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">args: [<a href="/reference/graphql-api/admin/object-types#configargdefinition">ConfigArgDefinition</a>!]!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">forEntities: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]!</div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Facet
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Facet</span>
{</div>
<div class="graphql-code-line ">isPrivate: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">values: [<a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">valueList(options: <a href="/reference/graphql-api/admin/input-types#facetvaluelistoptions">FacetValueListOptions</a>): <a href="/reference/graphql-api/admin/object-types#facetvaluelist">FacetValueList</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#facettranslation">FacetTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetInUseError
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetInUseError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">facetCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">productCount: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">variantCount: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#facet">Facet</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValue
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValue</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">facet: <a href="/reference/graphql-api/admin/object-types#facet">Facet</a>!</div>
<div class="graphql-code-line ">facetId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#facetvaluetranslation">FacetValueTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValueList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Which FacetValues are present in the products returned</div>
<div class="graphql-code-line top-level comment">by the search, and in what quantity.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValueResult</span>
{</div>
<div class="graphql-code-line ">facetValue: <a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!</div>
<div class="graphql-code-line ">count: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValueTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Float
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>Float</code> scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Float</span>
</div>
</div>
## FloatCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FloatCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">min: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line ">max: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line ">step: <a href="/reference/graphql-api/admin/object-types#float">Float</a></div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## Fulfillment
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Fulfillment</span>
{</div>
<div class="graphql-code-line ">nextStates: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]!</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/admin/object-types#fulfillmentline">FulfillmentLine</a>!]!</div>
<div class="graphql-code-line ">summary: [<a href="/reference/graphql-api/admin/object-types#fulfillmentline">FulfillmentLine</a>!]!</div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">method: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">trackingCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FulfillmentLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FulfillmentLine</span>
{</div>
<div class="graphql-code-line ">orderLine: <a href="/reference/graphql-api/admin/object-types#orderline">OrderLine</a>!</div>
<div class="graphql-code-line ">orderLineId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">fulfillment: <a href="/reference/graphql-api/admin/object-types#fulfillment">Fulfillment</a>!</div>
<div class="graphql-code-line ">fulfillmentId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FulfillmentStateTransitionError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when there is an error in transitioning the Fulfillment state</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FulfillmentStateTransitionError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">transitionError: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">fromState: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">toState: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## GlobalSettings
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">GlobalSettings</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">availableLanguages: [<a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!]!</div>
<div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">serverConfig: <a href="/reference/graphql-api/admin/object-types#serverconfig">ServerConfig</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## GuestCheckoutError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">GuestCheckoutError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">errorDetail: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntry
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">HistoryEntry</span>
{</div>
<div class="graphql-code-line ">isPublic: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">administrator: <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a></div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#historyentrytype">HistoryEntryType</a>!</div>
<div class="graphql-code-line ">data: <a href="/reference/graphql-api/admin/object-types#json">JSON</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntryList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">HistoryEntryList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#historyentry">HistoryEntry</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ID
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>ID</code> scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">ID</span>
</div>
</div>
## ImportInfo
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ImportInfo</span>
{</div>
<div class="graphql-code-line ">errors: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">processed: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">imported: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## IneligibleShippingMethodError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to set a ShippingMethod for which the Order is not eligible</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IneligibleShippingMethodError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## InsufficientStockError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to add more items to the Order than are available</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">InsufficientStockError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">quantityAvailable: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">order: <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## InsufficientStockOnHandError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if attempting to create a Fulfillment when there is insufficient</div>
<div class="graphql-code-line top-level comment">stockOnHand of a ProductVariant to satisfy the requested quantity.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">InsufficientStockOnHandError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">productVariantId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">productVariantName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">stockOnHand: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Int
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>Int</code> scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Int</span>
</div>
</div>
## IntCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IntCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">min: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">max: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">step: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## InvalidCredentialsError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the user authentication credentials are not valid</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">InvalidCredentialsError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">authenticationError: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## InvalidFulfillmentHandlerError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the specified FulfillmentHandler code is not valid</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">InvalidFulfillmentHandlerError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ItemsAlreadyFulfilledError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the specified items are already part of a Fulfillment</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ItemsAlreadyFulfilledError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## JSON
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>JSON</code> scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">JSON</span>
</div>
</div>
## Job
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Job</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">startedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">settledAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">queueName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/admin/enums#jobstate">JobState</a>!</div>
<div class="graphql-code-line ">progress: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line ">data: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line ">result: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line ">error: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line ">isSettled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">duration: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">retries: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">attempts: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## JobBufferSize
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">JobBufferSize</span>
{</div>
<div class="graphql-code-line ">bufferId: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">size: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## JobList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">JobList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#job">Job</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## JobQueue
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">JobQueue</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">running: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## LanguageNotAvailableError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">LanguageNotAvailableError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## LocaleStringCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">LocaleStringCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">length: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">pattern: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## LocaleTextCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">LocaleTextCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## LocalizedString
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">LocalizedString</span>
{</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ManualPaymentStateError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when a call to addManualPaymentToOrder is made but the Order</div>
<div class="graphql-code-line top-level comment">is not in the required state.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ManualPaymentStateError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## MetricSummary
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">MetricSummary</span>
{</div>
<div class="graphql-code-line ">interval: <a href="/reference/graphql-api/admin/enums#metricinterval">MetricInterval</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#metrictype">MetricType</a>!</div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">entries: [<a href="/reference/graphql-api/admin/object-types#metricsummaryentry">MetricSummaryEntry</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## MetricSummaryEntry
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">MetricSummaryEntry</span>
{</div>
<div class="graphql-code-line ">label: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## MimeTypeError
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">MimeTypeError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">fileName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">mimeType: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## MissingConditionsError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if a PromotionCondition has neither a couponCode nor any conditions set</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">MissingConditionsError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ModifyOrderResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">ModifyOrderResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#order">Order</a> | <a href="/reference/graphql-api/admin/object-types#nochangesspecifiederror">NoChangesSpecifiedError</a> | <a href="/reference/graphql-api/admin/object-types#ordermodificationstateerror">OrderModificationStateError</a> | <a href="/reference/graphql-api/admin/object-types#paymentmethodmissingerror">PaymentMethodMissingError</a> | <a href="/reference/graphql-api/admin/object-types#refundpaymentidmissingerror">RefundPaymentIdMissingError</a> | <a href="/reference/graphql-api/admin/object-types#orderlimiterror">OrderLimitError</a> | <a href="/reference/graphql-api/admin/object-types#negativequantityerror">NegativeQuantityError</a> | <a href="/reference/graphql-api/admin/object-types#insufficientstockerror">InsufficientStockError</a> | <a href="/reference/graphql-api/admin/object-types#couponcodeexpirederror">CouponCodeExpiredError</a> | <a href="/reference/graphql-api/admin/object-types#couponcodeinvaliderror">CouponCodeInvalidError</a> | <a href="/reference/graphql-api/admin/object-types#couponcodelimiterror">CouponCodeLimitError</a> | <a href="/reference/graphql-api/admin/object-types#ineligibleshippingmethoderror">IneligibleShippingMethodError</a></div>
</div>
## Money
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>Money</code> scalar type represents monetary values and supports signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Money</span>
</div>
</div>
## MultipleOrderError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if an operation has specified OrderLines from multiple Orders</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">MultipleOrderError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NativeAuthStrategyError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NativeAuthStrategyError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NativeAuthenticationResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">NativeAuthenticationResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#currentuser">CurrentUser</a> | <a href="/reference/graphql-api/admin/object-types#invalidcredentialserror">InvalidCredentialsError</a> | <a href="/reference/graphql-api/admin/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
</div>
## NegativeQuantityError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to set a negative OrderLine quantity.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NegativeQuantityError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NoActiveOrderError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when invoking a mutation which depends on there being an active Order on the</div>
<div class="graphql-code-line top-level comment">current session.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NoActiveOrderError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NoChangesSpecifiedError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when a call to modifyOrder fails to specify any changes</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NoChangesSpecifiedError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NothingToRefundError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if an attempting to refund an Order but neither items nor shipping refund was specified</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NothingToRefundError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Order
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Order</span>
{</div>
<div class="graphql-code-line ">nextStates: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]!</div>
<div class="graphql-code-line ">modifications: [<a href="/reference/graphql-api/admin/object-types#ordermodification">OrderModification</a>!]!</div>
<div class="graphql-code-line ">sellerOrders: [<a href="/reference/graphql-api/admin/object-types#order">Order</a>!]</div>
<div class="graphql-code-line ">aggregateOrder: <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
<div class="graphql-code-line ">aggregateOrderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">channels: [<a href="/reference/graphql-api/admin/object-types#channel">Channel</a>!]!</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#ordertype">OrderType</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The date & time that the Order was placed, i.e. the Customer</div>
<div class="graphql-code-line comment">completed the checkout and the Order is no longer "active"</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">orderPlacedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">A unique code for the Order</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">An order is active as long as the payment process has not been completed</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">active: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">customer: <a href="/reference/graphql-api/admin/object-types#customer">Customer</a></div>
<div class="graphql-code-line ">shippingAddress: <a href="/reference/graphql-api/admin/object-types#orderaddress">OrderAddress</a></div>
<div class="graphql-code-line ">billingAddress: <a href="/reference/graphql-api/admin/object-types#orderaddress">OrderAddress</a></div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/admin/object-types#orderline">OrderLine</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Surcharges are arbitrary modifications to the Order total which are neither</div>
<div class="graphql-code-line comment">ProductVariants nor discounts resulting from applied Promotions. For example,</div>
<div class="graphql-code-line comment">one-off discounts based on customer interaction, or surcharges based on payment</div>
<div class="graphql-code-line comment">methods.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">surcharges: [<a href="/reference/graphql-api/admin/object-types#surcharge">Surcharge</a>!]!</div>
<div class="graphql-code-line ">discounts: [<a href="/reference/graphql-api/admin/object-types#discount">Discount</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">An array of all coupon codes applied to the Order</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">couponCodes: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Promotions applied to the order. Only gets populated after the payment process has completed.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">promotions: [<a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a>!]!</div>
<div class="graphql-code-line ">payments: [<a href="/reference/graphql-api/admin/object-types#payment">Payment</a>!]</div>
<div class="graphql-code-line ">fulfillments: [<a href="/reference/graphql-api/admin/object-types#fulfillment">Fulfillment</a>!]</div>
<div class="graphql-code-line ">totalQuantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level</div>
<div class="graphql-code-line comment">discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.</div>
<div class="graphql-code-line comment">To get a total of all OrderLines which does not account for prorated discounts, use the</div>
<div class="graphql-code-line comment">sum of <code>OrderLine.discountedLinePrice</code> values.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">subTotal: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Same as subTotal, but inclusive of tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">subTotalWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">shippingLines: [<a href="/reference/graphql-api/admin/object-types#shippingline">ShippingLine</a>!]!</div>
<div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">shippingWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Equal to subTotal plus shipping</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">total: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The final payable amount. Equal to subTotalWithTax plus shippingWithTax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">totalWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">A summary of the taxes being applied to this Order</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">taxSummary: [<a href="/reference/graphql-api/admin/object-types#ordertaxsummary">OrderTaxSummary</a>!]!</div>
<div class="graphql-code-line ">history(options: <a href="/reference/graphql-api/admin/input-types#historyentrylistoptions">HistoryEntryListOptions</a>): <a href="/reference/graphql-api/admin/object-types#historyentrylist">HistoryEntryList</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderAddress</span>
{</div>
<div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">company: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">city: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">province: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">country: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">countryCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderLimitError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when the maximum order size limit has been reached.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderLimitError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">maxItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderLine</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">productVariant: <a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!</div>
<div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/admin/object-types#asset">Asset</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of a single unit, excluding tax and discounts</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">unitPrice: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of a single unit, including tax but excluding discounts</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">unitPriceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Non-zero if the unitPrice has changed since it was initially added to Order</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">unitPriceChangeSinceAdded: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Non-zero if the unitPriceWithTax has changed since it was initially added to Order</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">unitPriceWithTaxChangeSinceAdded: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of a single unit including discounts, excluding tax.</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">If Order-level discounts have been applied, this will not be the</div>
<div class="graphql-code-line comment">actual taxable unit price (see `proratedUnitPrice`), but is generally the</div>
<div class="graphql-code-line comment">correct price to display to customers to avoid confusion</div>
<div class="graphql-code-line comment">about the internal handling of distributed Order-level discounts.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">discountedUnitPrice: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of a single unit including discounts and tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">discountedUnitPriceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)</div>
<div class="graphql-code-line comment">Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax</div>
<div class="graphql-code-line comment">and refund calculations.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">proratedUnitPrice: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The proratedUnitPrice including tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">proratedUnitPriceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The quantity of items purchased</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The quantity at the time the Order was placed</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">orderPlacedQuantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The total price of the line excluding tax and discounts.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">linePrice: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The total price of the line including tax but excluding discounts.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">linePriceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of the line including discounts, excluding tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">discountedLinePrice: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of the line including discounts and tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">discountedLinePriceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)</div>
<div class="graphql-code-line comment">Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax</div>
<div class="graphql-code-line comment">and refund calculations.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">proratedLinePrice: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The proratedLinePrice including tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">proratedLinePriceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The total tax on this line</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">lineTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">discounts: [<a href="/reference/graphql-api/admin/object-types#discount">Discount</a>!]!</div>
<div class="graphql-code-line ">taxLines: [<a href="/reference/graphql-api/admin/object-types#taxline">TaxLine</a>!]!</div>
<div class="graphql-code-line ">order: <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
<div class="graphql-code-line ">fulfillmentLines: [<a href="/reference/graphql-api/admin/object-types#fulfillmentline">FulfillmentLine</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#order">Order</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderModification
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderModification</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">priceChange: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">note: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/admin/object-types#ordermodificationline">OrderModificationLine</a>!]!</div>
<div class="graphql-code-line ">surcharges: [<a href="/reference/graphql-api/admin/object-types#surcharge">Surcharge</a>!]</div>
<div class="graphql-code-line ">payment: <a href="/reference/graphql-api/admin/object-types#payment">Payment</a></div>
<div class="graphql-code-line ">refund: <a href="/reference/graphql-api/admin/object-types#refund">Refund</a></div>
<div class="graphql-code-line ">isSettled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderModificationError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to modify the contents of an Order that is not in the <code>AddingItems</code> state.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderModificationError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderModificationLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderModificationLine</span>
{</div>
<div class="graphql-code-line ">orderLine: <a href="/reference/graphql-api/admin/object-types#orderline">OrderLine</a>!</div>
<div class="graphql-code-line ">orderLineId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">modification: <a href="/reference/graphql-api/admin/object-types#ordermodification">OrderModification</a>!</div>
<div class="graphql-code-line ">modificationId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderModificationStateError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to modify the contents of an Order that is not in the <code>Modifying</code> state.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderModificationStateError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderProcessState
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderProcessState</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">to: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderStateTransitionError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if there is an error in transitioning the Order state</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderStateTransitionError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">transitionError: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">fromState: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">toState: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderTaxSummary
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">A summary of the taxes being applied to this order, grouped</div>
<div class="graphql-code-line top-level comment">by taxRate.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderTaxSummary</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">A description of this tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The taxRate as a percentage</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The total net price of OrderLines to which this taxRate applies</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">taxBase: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The total tax being applied to the Order at this taxRate</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">taxTotal: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Payment
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Payment</span>
{</div>
<div class="graphql-code-line ">nextStates: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]!</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">method: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">amount: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">transactionId: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">errorMessage: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">refunds: [<a href="/reference/graphql-api/admin/object-types#refund">Refund</a>!]!</div>
<div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentMethod</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">checker: <a href="/reference/graphql-api/admin/object-types#configurableoperation">ConfigurableOperation</a></div>
<div class="graphql-code-line ">handler: <a href="/reference/graphql-api/admin/object-types#configurableoperation">ConfigurableOperation</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#paymentmethodtranslation">PaymentMethodTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethodList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentMethodList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethodMissingError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when a call to modifyOrder fails to include a paymentMethod even</div>
<div class="graphql-code-line top-level comment">though the price has increased as a result of the changes.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentMethodMissingError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethodQuote
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentMethodQuote</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">isEligible: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">eligibilityMessage: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethodTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentMethodTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentOrderMismatchError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if an attempting to refund a Payment against OrderLines from a different Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentOrderMismatchError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentStateTransitionError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when there is an error in transitioning the Payment state</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentStateTransitionError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">transitionError: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">fromState: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">toState: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PermissionDefinition
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PermissionDefinition</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">assignable: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PriceRange
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The price range where the result has more than one price</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PriceRange</span>
{</div>
<div class="graphql-code-line ">min: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">max: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Product
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Product</span>
{</div>
<div class="graphql-code-line ">channels: [<a href="/reference/graphql-api/admin/object-types#channel">Channel</a>!]!</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/admin/object-types#asset">Asset</a></div>
<div class="graphql-code-line ">assets: [<a href="/reference/graphql-api/admin/object-types#asset">Asset</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Returns all ProductVariants</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">variants: [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Returns a paginated, sortable, filterable list of ProductVariants</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">variantList(options: <a href="/reference/graphql-api/admin/input-types#productvariantlistoptions">ProductVariantListOptions</a>): <a href="/reference/graphql-api/admin/object-types#productvariantlist">ProductVariantList</a>!</div>
<div class="graphql-code-line ">optionGroups: [<a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a>!]!</div>
<div class="graphql-code-line ">facetValues: [<a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#producttranslation">ProductTranslation</a>!]!</div>
<div class="graphql-code-line ">collections: [<a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#product">Product</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductOption
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOption</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">groupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">group: <a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#productoptiontranslation">ProductOptionTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductOptionGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOptionGroup</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">options: [<a href="/reference/graphql-api/admin/object-types#productoption">ProductOption</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#productoptiongrouptranslation">ProductOptionGroupTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductOptionGroupTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOptionGroupTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductOptionInUseError
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOptionInUseError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">optionGroupCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">productVariantCount: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductOptionTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOptionTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariant
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductVariant</span>
{</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/admin/enums#globalflag">GlobalFlag</a>!</div>
<div class="graphql-code-line ">stockOnHand: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">stockAllocated: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">useGlobalOutOfStockThreshold: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">prices: [<a href="/reference/graphql-api/admin/object-types#productvariantprice">ProductVariantPrice</a>!]!</div>
<div class="graphql-code-line ">stockLevels: [<a href="/reference/graphql-api/admin/object-types#stocklevel">StockLevel</a>!]!</div>
<div class="graphql-code-line ">stockMovements(options: <a href="/reference/graphql-api/admin/input-types#stockmovementlistoptions">StockMovementListOptions</a>): <a href="/reference/graphql-api/admin/object-types#stockmovementlist">StockMovementList</a>!</div>
<div class="graphql-code-line ">channels: [<a href="/reference/graphql-api/admin/object-types#channel">Channel</a>!]!</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">product: <a href="/reference/graphql-api/admin/object-types#product">Product</a>!</div>
<div class="graphql-code-line ">productId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/admin/object-types#asset">Asset</a></div>
<div class="graphql-code-line ">assets: [<a href="/reference/graphql-api/admin/object-types#asset">Asset</a>!]!</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">stockLevel: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">taxRateApplied: <a href="/reference/graphql-api/admin/object-types#taxrate">TaxRate</a>!</div>
<div class="graphql-code-line ">taxCategory: <a href="/reference/graphql-api/admin/object-types#taxcategory">TaxCategory</a>!</div>
<div class="graphql-code-line ">options: [<a href="/reference/graphql-api/admin/object-types#productoption">ProductOption</a>!]!</div>
<div class="graphql-code-line ">facetValues: [<a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#productvarianttranslation">ProductVariantTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductVariantList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantPrice
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductVariantPrice</span>
{</div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductVariantTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Promotion
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Promotion</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">startsAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">endsAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">perCustomerUsageLimit: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">usageLimit: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">conditions: [<a href="/reference/graphql-api/admin/object-types#configurableoperation">ConfigurableOperation</a>!]!</div>
<div class="graphql-code-line ">actions: [<a href="/reference/graphql-api/admin/object-types#configurableoperation">ConfigurableOperation</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#promotiontranslation">PromotionTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PromotionList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PromotionList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PromotionTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PromotionTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Province
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Province</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">parent: <a href="/reference/graphql-api/admin/object-types#region">Region</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/admin/object-types#id">ID</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#regiontranslation">RegionTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProvinceList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProvinceList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#province">Province</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## QuantityTooGreatError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the specified quantity of an OrderLine is greater than the number of items in that line</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">QuantityTooGreatError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Refund
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Refund</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">items: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">adjustment: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">total: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">method: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">transactionId: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">reason: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/admin/object-types#refundline">RefundLine</a>!]!</div>
<div class="graphql-code-line ">paymentId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## RefundAmountError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if <code>amount</code> is greater than the maximum un-refunded amount of the Payment</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RefundAmountError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">maximumRefundable: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RefundLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RefundLine</span>
{</div>
<div class="graphql-code-line ">orderLine: <a href="/reference/graphql-api/admin/object-types#orderline">OrderLine</a>!</div>
<div class="graphql-code-line ">orderLineId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">refund: <a href="/reference/graphql-api/admin/object-types#refund">Refund</a>!</div>
<div class="graphql-code-line ">refundId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RefundOrderResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RefundOrderResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#refund">Refund</a> | <a href="/reference/graphql-api/admin/object-types#quantitytoogreaterror">QuantityTooGreatError</a> | <a href="/reference/graphql-api/admin/object-types#nothingtorefunderror">NothingToRefundError</a> | <a href="/reference/graphql-api/admin/object-types#orderstatetransitionerror">OrderStateTransitionError</a> | <a href="/reference/graphql-api/admin/object-types#multipleordererror">MultipleOrderError</a> | <a href="/reference/graphql-api/admin/object-types#paymentordermismatcherror">PaymentOrderMismatchError</a> | <a href="/reference/graphql-api/admin/object-types#refundorderstateerror">RefundOrderStateError</a> | <a href="/reference/graphql-api/admin/object-types#alreadyrefundederror">AlreadyRefundedError</a> | <a href="/reference/graphql-api/admin/object-types#refundstatetransitionerror">RefundStateTransitionError</a> | <a href="/reference/graphql-api/admin/object-types#refundamounterror">RefundAmountError</a></div>
</div>
## RefundOrderStateError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if an attempting to refund an Order which is not in the expected state</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RefundOrderStateError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">orderState: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RefundPaymentIdMissingError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when a call to modifyOrder fails to include a refundPaymentId even</div>
<div class="graphql-code-line top-level comment">though the price has decreased as a result of the changes.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RefundPaymentIdMissingError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RefundStateTransitionError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when there is an error in transitioning the Refund state</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RefundStateTransitionError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">transitionError: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">fromState: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">toState: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RegionTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RegionTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RelationCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RelationCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">entity: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">scalarFields: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]!</div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## Release
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Release</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">productVariant: <a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#stockmovementtype">StockMovementType</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RemoveFacetFromChannelResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RemoveFacetFromChannelResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#facet">Facet</a> | <a href="/reference/graphql-api/admin/object-types#facetinuseerror">FacetInUseError</a></div>
</div>
## RemoveOptionGroupFromProductResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RemoveOptionGroupFromProductResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#product">Product</a> | <a href="/reference/graphql-api/admin/object-types#productoptioninuseerror">ProductOptionInUseError</a></div>
</div>
## RemoveOrderItemsResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RemoveOrderItemsResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#order">Order</a> | <a href="/reference/graphql-api/admin/object-types#ordermodificationerror">OrderModificationError</a></div>
</div>
## Return
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Return</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">productVariant: <a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#stockmovementtype">StockMovementType</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Role
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Role</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">permissions: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]!</div>
<div class="graphql-code-line ">channels: [<a href="/reference/graphql-api/admin/object-types#channel">Channel</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RoleList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RoleList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#role">Role</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Sale
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Sale</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">productVariant: <a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#stockmovementtype">StockMovementType</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchReindexResponse
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchReindexResponse</span>
{</div>
<div class="graphql-code-line ">success: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchResponse
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchResponse</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#searchresult">SearchResult</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">facetValues: [<a href="/reference/graphql-api/admin/object-types#facetvalueresult">FacetValueResult</a>!]!</div>
<div class="graphql-code-line ">collections: [<a href="/reference/graphql-api/admin/object-types#collectionresult">CollectionResult</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchResult</span>
{</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">An array of ids of the Channels in which this result appears</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">channelIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">productId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">productName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">productAsset: <a href="/reference/graphql-api/admin/object-types#searchresultasset">SearchResultAsset</a></div>
<div class="graphql-code-line ">productVariantId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">productVariantName: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">productVariantAsset: <a href="/reference/graphql-api/admin/object-types#searchresultasset">SearchResultAsset</a></div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/object-types#searchresultprice">SearchResultPrice</a>!</div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/admin/object-types#searchresultprice">SearchResultPrice</a>!</div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/admin/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">facetIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">facetValueIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">An array of ids of the Collections in which this result appears</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">collectionIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">A relevance score for the result. Differs between database implementations</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">score: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchResultAsset
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchResultAsset</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">preview: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">focalPoint: <a href="/reference/graphql-api/admin/object-types#coordinate">Coordinate</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchResultPrice
<div class="graphql-code-block">
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of a search result product, either as a range or as a single price</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">SearchResultPrice</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#pricerange">PriceRange</a> | <a href="/reference/graphql-api/admin/object-types#singleprice">SinglePrice</a></div>
</div>
## Seller
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Seller</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SellerList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SellerList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#seller">Seller</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ServerConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ServerConfig</span>
{</div>
<div class="graphql-code-line ">orderProcess: [<a href="/reference/graphql-api/admin/object-types#orderprocessstate">OrderProcessState</a>!]!</div>
<div class="graphql-code-line ">permittedAssetTypes: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]!</div>
<div class="graphql-code-line ">permissions: [<a href="/reference/graphql-api/admin/object-types#permissiondefinition">PermissionDefinition</a>!]!</div>
<div class="graphql-code-line ">moneyStrategyPrecision: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">This field is deprecated in v2.2 in favor of the entityCustomFields field,</div>
<div class="graphql-code-line comment">which allows custom fields to be defined on user-supplies entities.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">customFieldConfig: <a href="/reference/graphql-api/admin/object-types#customfields">CustomFields</a>!</div>
<div class="graphql-code-line ">entityCustomFields: [<a href="/reference/graphql-api/admin/object-types#entitycustomfields">EntityCustomFields</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SetCustomerForDraftOrderResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">SetCustomerForDraftOrderResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#order">Order</a> | <a href="/reference/graphql-api/admin/object-types#emailaddressconflicterror">EmailAddressConflictError</a></div>
</div>
## SetOrderShippingMethodResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">SetOrderShippingMethodResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#order">Order</a> | <a href="/reference/graphql-api/admin/object-types#ordermodificationerror">OrderModificationError</a> | <a href="/reference/graphql-api/admin/object-types#ineligibleshippingmethoderror">IneligibleShippingMethodError</a> | <a href="/reference/graphql-api/admin/object-types#noactiveordererror">NoActiveOrderError</a></div>
</div>
## SettlePaymentError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the Payment settlement fails</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SettlePaymentError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/admin/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">paymentErrorMessage: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SettlePaymentResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">SettlePaymentResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#payment">Payment</a> | <a href="/reference/graphql-api/admin/object-types#settlepaymenterror">SettlePaymentError</a> | <a href="/reference/graphql-api/admin/object-types#paymentstatetransitionerror">PaymentStateTransitionError</a> | <a href="/reference/graphql-api/admin/object-types#orderstatetransitionerror">OrderStateTransitionError</a></div>
</div>
## SettleRefundResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">SettleRefundResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#refund">Refund</a> | <a href="/reference/graphql-api/admin/object-types#refundstatetransitionerror">RefundStateTransitionError</a></div>
</div>
## ShippingLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingLine</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">shippingMethod: <a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">discountedPrice: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">discountedPriceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">discounts: [<a href="/reference/graphql-api/admin/object-types#discount">Discount</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethod</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">fulfillmentHandlerCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">checker: <a href="/reference/graphql-api/admin/object-types#configurableoperation">ConfigurableOperation</a>!</div>
<div class="graphql-code-line ">calculator: <a href="/reference/graphql-api/admin/object-types#configurableoperation">ConfigurableOperation</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/admin/object-types#shippingmethodtranslation">ShippingMethodTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethodList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethodList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethodQuote
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethodQuote</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethodTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethodTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/admin/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SinglePrice
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The price value where the result has a single price</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SinglePrice</span>
{</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## StockAdjustment
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StockAdjustment</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">productVariant: <a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/enums#stockmovementtype">StockMovementType</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## StockLevel
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StockLevel</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">stockLocationId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">stockOnHand: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">stockAllocated: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">stockLocation: <a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## StockLocation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StockLocation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## StockLocationList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StockLocationList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## StockMovementItem
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">StockMovementItem</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#stockadjustment">StockAdjustment</a> | <a href="/reference/graphql-api/admin/object-types#allocation">Allocation</a> | <a href="/reference/graphql-api/admin/object-types#sale">Sale</a> | <a href="/reference/graphql-api/admin/object-types#cancellation">Cancellation</a> | <a href="/reference/graphql-api/admin/object-types#return">Return</a> | <a href="/reference/graphql-api/admin/object-types#release">Release</a></div>
</div>
## StockMovementList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StockMovementList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#stockmovementitem">StockMovementItem</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## String
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>String</code> scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">String</span>
</div>
</div>
## StringCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StringCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">length: <a href="/reference/graphql-api/admin/object-types#int">Int</a></div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">pattern: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">options: [<a href="/reference/graphql-api/admin/object-types#stringfieldoption">StringFieldOption</a>!]</div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## StringFieldOption
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StringFieldOption</span>
{</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Success
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Indicates that an operation succeeded, where we do not want to return any more specific information.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Success</span>
{</div>
<div class="graphql-code-line ">success: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Surcharge
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Surcharge</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/admin/object-types#string">String</a></div>
<div class="graphql-code-line ">taxLines: [<a href="/reference/graphql-api/admin/object-types#taxline">TaxLine</a>!]!</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Tag
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Tag</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TagList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TagList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#tag">Tag</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxCategory
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxCategory</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">isDefault: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxCategoryList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxCategoryList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#taxcategory">TaxCategory</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxLine</span>
{</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxRate
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxRate</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/admin/object-types#float">Float</a>!</div>
<div class="graphql-code-line ">category: <a href="/reference/graphql-api/admin/object-types#taxcategory">TaxCategory</a>!</div>
<div class="graphql-code-line ">zone: <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
<div class="graphql-code-line ">customerGroup: <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxRateList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxRateList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#taxrate">TaxRate</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TestShippingMethodQuote
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TestShippingMethodQuote</span>
{</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/admin/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TestShippingMethodResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TestShippingMethodResult</span>
{</div>
<div class="graphql-code-line ">eligible: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">quote: <a href="/reference/graphql-api/admin/object-types#testshippingmethodquote">TestShippingMethodQuote</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TextCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TextCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/admin/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/admin/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TransitionFulfillmentToStateResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">TransitionFulfillmentToStateResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#fulfillment">Fulfillment</a> | <a href="/reference/graphql-api/admin/object-types#fulfillmentstatetransitionerror">FulfillmentStateTransitionError</a></div>
</div>
## TransitionOrderToStateResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">TransitionOrderToStateResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#order">Order</a> | <a href="/reference/graphql-api/admin/object-types#orderstatetransitionerror">OrderStateTransitionError</a></div>
</div>
## TransitionPaymentToStateResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">TransitionPaymentToStateResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#payment">Payment</a> | <a href="/reference/graphql-api/admin/object-types#paymentstatetransitionerror">PaymentStateTransitionError</a></div>
</div>
## UpdateChannelResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdateChannelResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#channel">Channel</a> | <a href="/reference/graphql-api/admin/object-types#languagenotavailableerror">LanguageNotAvailableError</a></div>
</div>
## UpdateCustomerResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdateCustomerResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#customer">Customer</a> | <a href="/reference/graphql-api/admin/object-types#emailaddressconflicterror">EmailAddressConflictError</a></div>
</div>
## UpdateGlobalSettingsResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdateGlobalSettingsResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#globalsettings">GlobalSettings</a> | <a href="/reference/graphql-api/admin/object-types#channeldefaultlanguageerror">ChannelDefaultLanguageError</a></div>
</div>
## UpdateOrderItemsResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdateOrderItemsResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#order">Order</a> | <a href="/reference/graphql-api/admin/object-types#ordermodificationerror">OrderModificationError</a> | <a href="/reference/graphql-api/admin/object-types#orderlimiterror">OrderLimitError</a> | <a href="/reference/graphql-api/admin/object-types#negativequantityerror">NegativeQuantityError</a> | <a href="/reference/graphql-api/admin/object-types#insufficientstockerror">InsufficientStockError</a></div>
</div>
## UpdatePromotionResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdatePromotionResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a> | <a href="/reference/graphql-api/admin/object-types#missingconditionserror">MissingConditionsError</a></div>
</div>
## Upload
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>Upload</code> scalar type represents a file upload.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Upload</span>
</div>
</div>
## User
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">User</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">identifier: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">verified: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">roles: [<a href="/reference/graphql-api/admin/object-types#role">Role</a>!]!</div>
<div class="graphql-code-line ">lastLogin: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">authenticationMethods: [<a href="/reference/graphql-api/admin/object-types#authenticationmethod">AuthenticationMethod</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## Zone
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Zone</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
<div class="graphql-code-line ">members: [<a href="/reference/graphql-api/admin/object-types#region">Region</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ZoneList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ZoneList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
|
---
title: "Queries"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## activeAdministrator
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">activeAdministrator: <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## activeChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">activeChannel: <a href="/reference/graphql-api/admin/object-types#channel">Channel</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## administrator
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">administrator(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## administrators
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">administrators(options: <a href="/reference/graphql-api/admin/input-types#administratorlistoptions">AdministratorListOptions</a>): <a href="/reference/graphql-api/admin/object-types#administratorlist">AdministratorList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## asset
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Get a single Asset by id</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">asset(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#asset">Asset</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## assets
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Get a list of Assets</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">assets(options: <a href="/reference/graphql-api/admin/input-types#assetlistoptions">AssetListOptions</a>): <a href="/reference/graphql-api/admin/object-types#assetlist">AssetList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## channel
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">channel(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#channel">Channel</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## channels
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">channels(options: <a href="/reference/graphql-api/admin/input-types#channellistoptions">ChannelListOptions</a>): <a href="/reference/graphql-api/admin/object-types#channellist">ChannelList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## collection
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Get a Collection either by id or slug. If neither id nor slug is specified, an error will result.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">collection(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>, slug: <a href="/reference/graphql-api/admin/object-types#string">String</a>): <a href="/reference/graphql-api/admin/object-types#collection">Collection</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## collectionFilters
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">collectionFilters: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## collections
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">collections(options: <a href="/reference/graphql-api/admin/input-types#collectionlistoptions">CollectionListOptions</a>): <a href="/reference/graphql-api/admin/object-types#collectionlist">CollectionList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## countries
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">countries(options: <a href="/reference/graphql-api/admin/input-types#countrylistoptions">CountryListOptions</a>): <a href="/reference/graphql-api/admin/object-types#countrylist">CountryList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## country
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">country(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#country">Country</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## customer
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">customer(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#customer">Customer</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## customerGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">customerGroup(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## customerGroups
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">customerGroups(options: <a href="/reference/graphql-api/admin/input-types#customergrouplistoptions">CustomerGroupListOptions</a>): <a href="/reference/graphql-api/admin/object-types#customergrouplist">CustomerGroupList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## customers
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">customers(options: <a href="/reference/graphql-api/admin/input-types#customerlistoptions">CustomerListOptions</a>): <a href="/reference/graphql-api/admin/object-types#customerlist">CustomerList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## eligibleShippingMethodsForDraftOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returns a list of eligible shipping methods for the draft Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">eligibleShippingMethodsForDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): [<a href="/reference/graphql-api/admin/object-types#shippingmethodquote">ShippingMethodQuote</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## entityDuplicators
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">entityDuplicators: [<a href="/reference/graphql-api/admin/object-types#entityduplicatordefinition">EntityDuplicatorDefinition</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## facet
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">facet(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#facet">Facet</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## facetValues
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">facetValues(options: <a href="/reference/graphql-api/admin/input-types#facetvaluelistoptions">FacetValueListOptions</a>): <a href="/reference/graphql-api/admin/object-types#facetvaluelist">FacetValueList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## facets
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">facets(options: <a href="/reference/graphql-api/admin/input-types#facetlistoptions">FacetListOptions</a>): <a href="/reference/graphql-api/admin/object-types#facetlist">FacetList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## fulfillmentHandlers
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">fulfillmentHandlers: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## globalSettings
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">globalSettings: <a href="/reference/graphql-api/admin/object-types#globalsettings">GlobalSettings</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## job
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">job(jobId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#job">Job</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## jobBufferSize
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">jobBufferSize(bufferIds: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]): [<a href="/reference/graphql-api/admin/object-types#jobbuffersize">JobBufferSize</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## jobQueues
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">jobQueues: [<a href="/reference/graphql-api/admin/object-types#jobqueue">JobQueue</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## jobs
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">jobs(options: <a href="/reference/graphql-api/admin/input-types#joblistoptions">JobListOptions</a>): <a href="/reference/graphql-api/admin/object-types#joblist">JobList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## jobsById
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">jobsById(jobIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#job">Job</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## me
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">me: <a href="/reference/graphql-api/admin/object-types#currentuser">CurrentUser</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## metricSummary
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Get metrics for the given interval and metric types.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">metricSummary(input: <a href="/reference/graphql-api/admin/input-types#metricsummaryinput">MetricSummaryInput</a>): [<a href="/reference/graphql-api/admin/object-types#metricsummary">MetricSummary</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## order
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">order(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## orders
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">orders(options: <a href="/reference/graphql-api/admin/input-types#orderlistoptions">OrderListOptions</a>): <a href="/reference/graphql-api/admin/object-types#orderlist">OrderList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## paymentMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">paymentMethod(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## paymentMethodEligibilityCheckers
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">paymentMethodEligibilityCheckers: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## paymentMethodHandlers
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">paymentMethodHandlers: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## paymentMethods
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">paymentMethods(options: <a href="/reference/graphql-api/admin/input-types#paymentmethodlistoptions">PaymentMethodListOptions</a>): <a href="/reference/graphql-api/admin/object-types#paymentmethodlist">PaymentMethodList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## pendingSearchIndexUpdates
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">pendingSearchIndexUpdates: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## previewCollectionVariants
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Used for real-time previews of the contents of a Collection</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">previewCollectionVariants(input: <a href="/reference/graphql-api/admin/input-types#previewcollectionvariantsinput">PreviewCollectionVariantsInput</a>!, options: <a href="/reference/graphql-api/admin/input-types#productvariantlistoptions">ProductVariantListOptions</a>): <a href="/reference/graphql-api/admin/object-types#productvariantlist">ProductVariantList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## product
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Get a Product either by id or slug. If neither id nor slug is specified, an error will result.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">product(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>, slug: <a href="/reference/graphql-api/admin/object-types#string">String</a>): <a href="/reference/graphql-api/admin/object-types#product">Product</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## productOptionGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">productOptionGroup(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## productOptionGroups
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">productOptionGroups(filterTerm: <a href="/reference/graphql-api/admin/object-types#string">String</a>): [<a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## productVariant
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Get a ProductVariant by id</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">productVariant(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## productVariants
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">List ProductVariants either all or for the specific product.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">productVariants(options: <a href="/reference/graphql-api/admin/input-types#productvariantlistoptions">ProductVariantListOptions</a>, productId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>): <a href="/reference/graphql-api/admin/object-types#productvariantlist">ProductVariantList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## products
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">List Products</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">products(options: <a href="/reference/graphql-api/admin/input-types#productlistoptions">ProductListOptions</a>): <a href="/reference/graphql-api/admin/object-types#productlist">ProductList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## promotion
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">promotion(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## promotionActions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">promotionActions: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## promotionConditions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">promotionConditions: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## promotions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">promotions(options: <a href="/reference/graphql-api/admin/input-types#promotionlistoptions">PromotionListOptions</a>): <a href="/reference/graphql-api/admin/object-types#promotionlist">PromotionList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## province
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">province(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#province">Province</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## provinces
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">provinces(options: <a href="/reference/graphql-api/admin/input-types#provincelistoptions">ProvinceListOptions</a>): <a href="/reference/graphql-api/admin/object-types#provincelist">ProvinceList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## role
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">role(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#role">Role</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## roles
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">roles(options: <a href="/reference/graphql-api/admin/input-types#rolelistoptions">RoleListOptions</a>): <a href="/reference/graphql-api/admin/object-types#rolelist">RoleList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## search
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">search(input: <a href="/reference/graphql-api/admin/input-types#searchinput">SearchInput</a>!): <a href="/reference/graphql-api/admin/object-types#searchresponse">SearchResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## seller
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">seller(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#seller">Seller</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## sellers
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">sellers(options: <a href="/reference/graphql-api/admin/input-types#sellerlistoptions">SellerListOptions</a>): <a href="/reference/graphql-api/admin/object-types#sellerlist">SellerList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## shippingCalculators
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">shippingCalculators: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## shippingEligibilityCheckers
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">shippingEligibilityCheckers: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## shippingMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">shippingMethod(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## shippingMethods
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">shippingMethods(options: <a href="/reference/graphql-api/admin/input-types#shippingmethodlistoptions">ShippingMethodListOptions</a>): <a href="/reference/graphql-api/admin/object-types#shippingmethodlist">ShippingMethodList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## stockLocation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">stockLocation(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## stockLocations
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">stockLocations(options: <a href="/reference/graphql-api/admin/input-types#stocklocationlistoptions">StockLocationListOptions</a>): <a href="/reference/graphql-api/admin/object-types#stocklocationlist">StockLocationList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## tag
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">tag(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#tag">Tag</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## tags
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">tags(options: <a href="/reference/graphql-api/admin/input-types#taglistoptions">TagListOptions</a>): <a href="/reference/graphql-api/admin/object-types#taglist">TagList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## taxCategories
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">taxCategories(options: <a href="/reference/graphql-api/admin/input-types#taxcategorylistoptions">TaxCategoryListOptions</a>): <a href="/reference/graphql-api/admin/object-types#taxcategorylist">TaxCategoryList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## taxCategory
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">taxCategory(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#taxcategory">TaxCategory</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## taxRate
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">taxRate(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#taxrate">TaxRate</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## taxRates
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">taxRates(options: <a href="/reference/graphql-api/admin/input-types#taxratelistoptions">TaxRateListOptions</a>): <a href="/reference/graphql-api/admin/object-types#taxratelist">TaxRateList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## testEligibleShippingMethods
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">testEligibleShippingMethods(input: <a href="/reference/graphql-api/admin/input-types#testeligibleshippingmethodsinput">TestEligibleShippingMethodsInput</a>!): [<a href="/reference/graphql-api/admin/object-types#shippingmethodquote">ShippingMethodQuote</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## testShippingMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">testShippingMethod(input: <a href="/reference/graphql-api/admin/input-types#testshippingmethodinput">TestShippingMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#testshippingmethodresult">TestShippingMethodResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## zone
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">zone(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## zones
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">zones(options: <a href="/reference/graphql-api/admin/input-types#zonelistoptions">ZoneListOptions</a>): <a href="/reference/graphql-api/admin/object-types#zonelist">ZoneList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
|
---
title: "Shop API"
weight: 3
showtoc: false
---
# GraphQL Shop API
The Shop API is used by storefront applications. It provides all the necessary queries and mutations for finding and viewing products, creating and updating orders, checking out, managing a customer account etc.
{{% alert %}}
Explore the interactive GraphQL Shop API at [demo.vendure.io/shop-api](https://demo.vendure.io/shop-api)
{{< /alert >}}
|
---
title: "Enums"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AdjustmentType
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">AdjustmentType</span>
{</div>
<div class="graphql-code-line ">PROMOTION</div>
<div class="graphql-code-line ">DISTRIBUTED_ORDER_PROMOTION</div>
<div class="graphql-code-line ">OTHER</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssetType
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">AssetType</span>
{</div>
<div class="graphql-code-line ">IMAGE</div>
<div class="graphql-code-line ">VIDEO</div>
<div class="graphql-code-line ">BINARY</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CurrencyCode
<div class="graphql-code-block">
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">ISO 4217 currency code</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">CurrencyCode</span>
{</div>
<div class="graphql-code-line comment">"""United Arab Emirates dirham"""</div>
<div class="graphql-code-line ">AED</div>
<div class="graphql-code-line comment">"""Afghan afghani"""</div>
<div class="graphql-code-line ">AFN</div>
<div class="graphql-code-line comment">"""Albanian lek"""</div>
<div class="graphql-code-line ">ALL</div>
<div class="graphql-code-line comment">"""Armenian dram"""</div>
<div class="graphql-code-line ">AMD</div>
<div class="graphql-code-line comment">"""Netherlands Antillean guilder"""</div>
<div class="graphql-code-line ">ANG</div>
<div class="graphql-code-line comment">"""Angolan kwanza"""</div>
<div class="graphql-code-line ">AOA</div>
<div class="graphql-code-line comment">"""Argentine peso"""</div>
<div class="graphql-code-line ">ARS</div>
<div class="graphql-code-line comment">"""Australian dollar"""</div>
<div class="graphql-code-line ">AUD</div>
<div class="graphql-code-line comment">"""Aruban florin"""</div>
<div class="graphql-code-line ">AWG</div>
<div class="graphql-code-line comment">"""Azerbaijani manat"""</div>
<div class="graphql-code-line ">AZN</div>
<div class="graphql-code-line comment">"""Bosnia and Herzegovina convertible mark"""</div>
<div class="graphql-code-line ">BAM</div>
<div class="graphql-code-line comment">"""Barbados dollar"""</div>
<div class="graphql-code-line ">BBD</div>
<div class="graphql-code-line comment">"""Bangladeshi taka"""</div>
<div class="graphql-code-line ">BDT</div>
<div class="graphql-code-line comment">"""Bulgarian lev"""</div>
<div class="graphql-code-line ">BGN</div>
<div class="graphql-code-line comment">"""Bahraini dinar"""</div>
<div class="graphql-code-line ">BHD</div>
<div class="graphql-code-line comment">"""Burundian franc"""</div>
<div class="graphql-code-line ">BIF</div>
<div class="graphql-code-line comment">"""Bermudian dollar"""</div>
<div class="graphql-code-line ">BMD</div>
<div class="graphql-code-line comment">"""Brunei dollar"""</div>
<div class="graphql-code-line ">BND</div>
<div class="graphql-code-line comment">"""Boliviano"""</div>
<div class="graphql-code-line ">BOB</div>
<div class="graphql-code-line comment">"""Brazilian real"""</div>
<div class="graphql-code-line ">BRL</div>
<div class="graphql-code-line comment">"""Bahamian dollar"""</div>
<div class="graphql-code-line ">BSD</div>
<div class="graphql-code-line comment">"""Bhutanese ngultrum"""</div>
<div class="graphql-code-line ">BTN</div>
<div class="graphql-code-line comment">"""Botswana pula"""</div>
<div class="graphql-code-line ">BWP</div>
<div class="graphql-code-line comment">"""Belarusian ruble"""</div>
<div class="graphql-code-line ">BYN</div>
<div class="graphql-code-line comment">"""Belize dollar"""</div>
<div class="graphql-code-line ">BZD</div>
<div class="graphql-code-line comment">"""Canadian dollar"""</div>
<div class="graphql-code-line ">CAD</div>
<div class="graphql-code-line comment">"""Congolese franc"""</div>
<div class="graphql-code-line ">CDF</div>
<div class="graphql-code-line comment">"""Swiss franc"""</div>
<div class="graphql-code-line ">CHF</div>
<div class="graphql-code-line comment">"""Chilean peso"""</div>
<div class="graphql-code-line ">CLP</div>
<div class="graphql-code-line comment">"""Renminbi (Chinese) yuan"""</div>
<div class="graphql-code-line ">CNY</div>
<div class="graphql-code-line comment">"""Colombian peso"""</div>
<div class="graphql-code-line ">COP</div>
<div class="graphql-code-line comment">"""Costa Rican colon"""</div>
<div class="graphql-code-line ">CRC</div>
<div class="graphql-code-line comment">"""Cuban convertible peso"""</div>
<div class="graphql-code-line ">CUC</div>
<div class="graphql-code-line comment">"""Cuban peso"""</div>
<div class="graphql-code-line ">CUP</div>
<div class="graphql-code-line comment">"""Cape Verde escudo"""</div>
<div class="graphql-code-line ">CVE</div>
<div class="graphql-code-line comment">"""Czech koruna"""</div>
<div class="graphql-code-line ">CZK</div>
<div class="graphql-code-line comment">"""Djiboutian franc"""</div>
<div class="graphql-code-line ">DJF</div>
<div class="graphql-code-line comment">"""Danish krone"""</div>
<div class="graphql-code-line ">DKK</div>
<div class="graphql-code-line comment">"""Dominican peso"""</div>
<div class="graphql-code-line ">DOP</div>
<div class="graphql-code-line comment">"""Algerian dinar"""</div>
<div class="graphql-code-line ">DZD</div>
<div class="graphql-code-line comment">"""Egyptian pound"""</div>
<div class="graphql-code-line ">EGP</div>
<div class="graphql-code-line comment">"""Eritrean nakfa"""</div>
<div class="graphql-code-line ">ERN</div>
<div class="graphql-code-line comment">"""Ethiopian birr"""</div>
<div class="graphql-code-line ">ETB</div>
<div class="graphql-code-line comment">"""Euro"""</div>
<div class="graphql-code-line ">EUR</div>
<div class="graphql-code-line comment">"""Fiji dollar"""</div>
<div class="graphql-code-line ">FJD</div>
<div class="graphql-code-line comment">"""Falkland Islands pound"""</div>
<div class="graphql-code-line ">FKP</div>
<div class="graphql-code-line comment">"""Pound sterling"""</div>
<div class="graphql-code-line ">GBP</div>
<div class="graphql-code-line comment">"""Georgian lari"""</div>
<div class="graphql-code-line ">GEL</div>
<div class="graphql-code-line comment">"""Ghanaian cedi"""</div>
<div class="graphql-code-line ">GHS</div>
<div class="graphql-code-line comment">"""Gibraltar pound"""</div>
<div class="graphql-code-line ">GIP</div>
<div class="graphql-code-line comment">"""Gambian dalasi"""</div>
<div class="graphql-code-line ">GMD</div>
<div class="graphql-code-line comment">"""Guinean franc"""</div>
<div class="graphql-code-line ">GNF</div>
<div class="graphql-code-line comment">"""Guatemalan quetzal"""</div>
<div class="graphql-code-line ">GTQ</div>
<div class="graphql-code-line comment">"""Guyanese dollar"""</div>
<div class="graphql-code-line ">GYD</div>
<div class="graphql-code-line comment">"""Hong Kong dollar"""</div>
<div class="graphql-code-line ">HKD</div>
<div class="graphql-code-line comment">"""Honduran lempira"""</div>
<div class="graphql-code-line ">HNL</div>
<div class="graphql-code-line comment">"""Croatian kuna"""</div>
<div class="graphql-code-line ">HRK</div>
<div class="graphql-code-line comment">"""Haitian gourde"""</div>
<div class="graphql-code-line ">HTG</div>
<div class="graphql-code-line comment">"""Hungarian forint"""</div>
<div class="graphql-code-line ">HUF</div>
<div class="graphql-code-line comment">"""Indonesian rupiah"""</div>
<div class="graphql-code-line ">IDR</div>
<div class="graphql-code-line comment">"""Israeli new shekel"""</div>
<div class="graphql-code-line ">ILS</div>
<div class="graphql-code-line comment">"""Indian rupee"""</div>
<div class="graphql-code-line ">INR</div>
<div class="graphql-code-line comment">"""Iraqi dinar"""</div>
<div class="graphql-code-line ">IQD</div>
<div class="graphql-code-line comment">"""Iranian rial"""</div>
<div class="graphql-code-line ">IRR</div>
<div class="graphql-code-line comment">"""Icelandic króna"""</div>
<div class="graphql-code-line ">ISK</div>
<div class="graphql-code-line comment">"""Jamaican dollar"""</div>
<div class="graphql-code-line ">JMD</div>
<div class="graphql-code-line comment">"""Jordanian dinar"""</div>
<div class="graphql-code-line ">JOD</div>
<div class="graphql-code-line comment">"""Japanese yen"""</div>
<div class="graphql-code-line ">JPY</div>
<div class="graphql-code-line comment">"""Kenyan shilling"""</div>
<div class="graphql-code-line ">KES</div>
<div class="graphql-code-line comment">"""Kyrgyzstani som"""</div>
<div class="graphql-code-line ">KGS</div>
<div class="graphql-code-line comment">"""Cambodian riel"""</div>
<div class="graphql-code-line ">KHR</div>
<div class="graphql-code-line comment">"""Comoro franc"""</div>
<div class="graphql-code-line ">KMF</div>
<div class="graphql-code-line comment">"""North Korean won"""</div>
<div class="graphql-code-line ">KPW</div>
<div class="graphql-code-line comment">"""South Korean won"""</div>
<div class="graphql-code-line ">KRW</div>
<div class="graphql-code-line comment">"""Kuwaiti dinar"""</div>
<div class="graphql-code-line ">KWD</div>
<div class="graphql-code-line comment">"""Cayman Islands dollar"""</div>
<div class="graphql-code-line ">KYD</div>
<div class="graphql-code-line comment">"""Kazakhstani tenge"""</div>
<div class="graphql-code-line ">KZT</div>
<div class="graphql-code-line comment">"""Lao kip"""</div>
<div class="graphql-code-line ">LAK</div>
<div class="graphql-code-line comment">"""Lebanese pound"""</div>
<div class="graphql-code-line ">LBP</div>
<div class="graphql-code-line comment">"""Sri Lankan rupee"""</div>
<div class="graphql-code-line ">LKR</div>
<div class="graphql-code-line comment">"""Liberian dollar"""</div>
<div class="graphql-code-line ">LRD</div>
<div class="graphql-code-line comment">"""Lesotho loti"""</div>
<div class="graphql-code-line ">LSL</div>
<div class="graphql-code-line comment">"""Libyan dinar"""</div>
<div class="graphql-code-line ">LYD</div>
<div class="graphql-code-line comment">"""Moroccan dirham"""</div>
<div class="graphql-code-line ">MAD</div>
<div class="graphql-code-line comment">"""Moldovan leu"""</div>
<div class="graphql-code-line ">MDL</div>
<div class="graphql-code-line comment">"""Malagasy ariary"""</div>
<div class="graphql-code-line ">MGA</div>
<div class="graphql-code-line comment">"""Macedonian denar"""</div>
<div class="graphql-code-line ">MKD</div>
<div class="graphql-code-line comment">"""Myanmar kyat"""</div>
<div class="graphql-code-line ">MMK</div>
<div class="graphql-code-line comment">"""Mongolian tögrög"""</div>
<div class="graphql-code-line ">MNT</div>
<div class="graphql-code-line comment">"""Macanese pataca"""</div>
<div class="graphql-code-line ">MOP</div>
<div class="graphql-code-line comment">"""Mauritanian ouguiya"""</div>
<div class="graphql-code-line ">MRU</div>
<div class="graphql-code-line comment">"""Mauritian rupee"""</div>
<div class="graphql-code-line ">MUR</div>
<div class="graphql-code-line comment">"""Maldivian rufiyaa"""</div>
<div class="graphql-code-line ">MVR</div>
<div class="graphql-code-line comment">"""Malawian kwacha"""</div>
<div class="graphql-code-line ">MWK</div>
<div class="graphql-code-line comment">"""Mexican peso"""</div>
<div class="graphql-code-line ">MXN</div>
<div class="graphql-code-line comment">"""Malaysian ringgit"""</div>
<div class="graphql-code-line ">MYR</div>
<div class="graphql-code-line comment">"""Mozambican metical"""</div>
<div class="graphql-code-line ">MZN</div>
<div class="graphql-code-line comment">"""Namibian dollar"""</div>
<div class="graphql-code-line ">NAD</div>
<div class="graphql-code-line comment">"""Nigerian naira"""</div>
<div class="graphql-code-line ">NGN</div>
<div class="graphql-code-line comment">"""Nicaraguan córdoba"""</div>
<div class="graphql-code-line ">NIO</div>
<div class="graphql-code-line comment">"""Norwegian krone"""</div>
<div class="graphql-code-line ">NOK</div>
<div class="graphql-code-line comment">"""Nepalese rupee"""</div>
<div class="graphql-code-line ">NPR</div>
<div class="graphql-code-line comment">"""New Zealand dollar"""</div>
<div class="graphql-code-line ">NZD</div>
<div class="graphql-code-line comment">"""Omani rial"""</div>
<div class="graphql-code-line ">OMR</div>
<div class="graphql-code-line comment">"""Panamanian balboa"""</div>
<div class="graphql-code-line ">PAB</div>
<div class="graphql-code-line comment">"""Peruvian sol"""</div>
<div class="graphql-code-line ">PEN</div>
<div class="graphql-code-line comment">"""Papua New Guinean kina"""</div>
<div class="graphql-code-line ">PGK</div>
<div class="graphql-code-line comment">"""Philippine peso"""</div>
<div class="graphql-code-line ">PHP</div>
<div class="graphql-code-line comment">"""Pakistani rupee"""</div>
<div class="graphql-code-line ">PKR</div>
<div class="graphql-code-line comment">"""Polish złoty"""</div>
<div class="graphql-code-line ">PLN</div>
<div class="graphql-code-line comment">"""Paraguayan guaraní"""</div>
<div class="graphql-code-line ">PYG</div>
<div class="graphql-code-line comment">"""Qatari riyal"""</div>
<div class="graphql-code-line ">QAR</div>
<div class="graphql-code-line comment">"""Romanian leu"""</div>
<div class="graphql-code-line ">RON</div>
<div class="graphql-code-line comment">"""Serbian dinar"""</div>
<div class="graphql-code-line ">RSD</div>
<div class="graphql-code-line comment">"""Russian ruble"""</div>
<div class="graphql-code-line ">RUB</div>
<div class="graphql-code-line comment">"""Rwandan franc"""</div>
<div class="graphql-code-line ">RWF</div>
<div class="graphql-code-line comment">"""Saudi riyal"""</div>
<div class="graphql-code-line ">SAR</div>
<div class="graphql-code-line comment">"""Solomon Islands dollar"""</div>
<div class="graphql-code-line ">SBD</div>
<div class="graphql-code-line comment">"""Seychelles rupee"""</div>
<div class="graphql-code-line ">SCR</div>
<div class="graphql-code-line comment">"""Sudanese pound"""</div>
<div class="graphql-code-line ">SDG</div>
<div class="graphql-code-line comment">"""Swedish krona/kronor"""</div>
<div class="graphql-code-line ">SEK</div>
<div class="graphql-code-line comment">"""Singapore dollar"""</div>
<div class="graphql-code-line ">SGD</div>
<div class="graphql-code-line comment">"""Saint Helena pound"""</div>
<div class="graphql-code-line ">SHP</div>
<div class="graphql-code-line comment">"""Sierra Leonean leone"""</div>
<div class="graphql-code-line ">SLL</div>
<div class="graphql-code-line comment">"""Somali shilling"""</div>
<div class="graphql-code-line ">SOS</div>
<div class="graphql-code-line comment">"""Surinamese dollar"""</div>
<div class="graphql-code-line ">SRD</div>
<div class="graphql-code-line comment">"""South Sudanese pound"""</div>
<div class="graphql-code-line ">SSP</div>
<div class="graphql-code-line comment">"""São Tomé and Príncipe dobra"""</div>
<div class="graphql-code-line ">STN</div>
<div class="graphql-code-line comment">"""Salvadoran colón"""</div>
<div class="graphql-code-line ">SVC</div>
<div class="graphql-code-line comment">"""Syrian pound"""</div>
<div class="graphql-code-line ">SYP</div>
<div class="graphql-code-line comment">"""Swazi lilangeni"""</div>
<div class="graphql-code-line ">SZL</div>
<div class="graphql-code-line comment">"""Thai baht"""</div>
<div class="graphql-code-line ">THB</div>
<div class="graphql-code-line comment">"""Tajikistani somoni"""</div>
<div class="graphql-code-line ">TJS</div>
<div class="graphql-code-line comment">"""Turkmenistan manat"""</div>
<div class="graphql-code-line ">TMT</div>
<div class="graphql-code-line comment">"""Tunisian dinar"""</div>
<div class="graphql-code-line ">TND</div>
<div class="graphql-code-line comment">"""Tongan paʻanga"""</div>
<div class="graphql-code-line ">TOP</div>
<div class="graphql-code-line comment">"""Turkish lira"""</div>
<div class="graphql-code-line ">TRY</div>
<div class="graphql-code-line comment">"""Trinidad and Tobago dollar"""</div>
<div class="graphql-code-line ">TTD</div>
<div class="graphql-code-line comment">"""New Taiwan dollar"""</div>
<div class="graphql-code-line ">TWD</div>
<div class="graphql-code-line comment">"""Tanzanian shilling"""</div>
<div class="graphql-code-line ">TZS</div>
<div class="graphql-code-line comment">"""Ukrainian hryvnia"""</div>
<div class="graphql-code-line ">UAH</div>
<div class="graphql-code-line comment">"""Ugandan shilling"""</div>
<div class="graphql-code-line ">UGX</div>
<div class="graphql-code-line comment">"""United States dollar"""</div>
<div class="graphql-code-line ">USD</div>
<div class="graphql-code-line comment">"""Uruguayan peso"""</div>
<div class="graphql-code-line ">UYU</div>
<div class="graphql-code-line comment">"""Uzbekistan som"""</div>
<div class="graphql-code-line ">UZS</div>
<div class="graphql-code-line comment">"""Venezuelan bolívar soberano"""</div>
<div class="graphql-code-line ">VES</div>
<div class="graphql-code-line comment">"""Vietnamese đồng"""</div>
<div class="graphql-code-line ">VND</div>
<div class="graphql-code-line comment">"""Vanuatu vatu"""</div>
<div class="graphql-code-line ">VUV</div>
<div class="graphql-code-line comment">"""Samoan tala"""</div>
<div class="graphql-code-line ">WST</div>
<div class="graphql-code-line comment">"""CFA franc BEAC"""</div>
<div class="graphql-code-line ">XAF</div>
<div class="graphql-code-line comment">"""East Caribbean dollar"""</div>
<div class="graphql-code-line ">XCD</div>
<div class="graphql-code-line comment">"""CFA franc BCEAO"""</div>
<div class="graphql-code-line ">XOF</div>
<div class="graphql-code-line comment">"""CFP franc (franc Pacifique)"""</div>
<div class="graphql-code-line ">XPF</div>
<div class="graphql-code-line comment">"""Yemeni rial"""</div>
<div class="graphql-code-line ">YER</div>
<div class="graphql-code-line comment">"""South African rand"""</div>
<div class="graphql-code-line ">ZAR</div>
<div class="graphql-code-line comment">"""Zambian kwacha"""</div>
<div class="graphql-code-line ">ZMW</div>
<div class="graphql-code-line comment">"""Zimbabwean dollar"""</div>
<div class="graphql-code-line ">ZWL</div>
<div class="graphql-code-line top-level">}</div>
</div>
## DeletionResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">DeletionResult</span>
{</div>
<div class="graphql-code-line comment">"""The entity was successfully deleted"""</div>
<div class="graphql-code-line ">DELETED</div>
<div class="graphql-code-line comment">"""Deletion did not take place, reason given in message"""</div>
<div class="graphql-code-line ">NOT_DELETED</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ErrorCode
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">ErrorCode</span>
{</div>
<div class="graphql-code-line ">UNKNOWN_ERROR</div>
<div class="graphql-code-line ">NATIVE_AUTH_STRATEGY_ERROR</div>
<div class="graphql-code-line ">INVALID_CREDENTIALS_ERROR</div>
<div class="graphql-code-line ">ORDER_STATE_TRANSITION_ERROR</div>
<div class="graphql-code-line ">EMAIL_ADDRESS_CONFLICT_ERROR</div>
<div class="graphql-code-line ">GUEST_CHECKOUT_ERROR</div>
<div class="graphql-code-line ">ORDER_LIMIT_ERROR</div>
<div class="graphql-code-line ">NEGATIVE_QUANTITY_ERROR</div>
<div class="graphql-code-line ">INSUFFICIENT_STOCK_ERROR</div>
<div class="graphql-code-line ">COUPON_CODE_INVALID_ERROR</div>
<div class="graphql-code-line ">COUPON_CODE_EXPIRED_ERROR</div>
<div class="graphql-code-line ">COUPON_CODE_LIMIT_ERROR</div>
<div class="graphql-code-line ">ORDER_MODIFICATION_ERROR</div>
<div class="graphql-code-line ">INELIGIBLE_SHIPPING_METHOD_ERROR</div>
<div class="graphql-code-line ">NO_ACTIVE_ORDER_ERROR</div>
<div class="graphql-code-line ">ORDER_PAYMENT_STATE_ERROR</div>
<div class="graphql-code-line ">INELIGIBLE_PAYMENT_METHOD_ERROR</div>
<div class="graphql-code-line ">PAYMENT_FAILED_ERROR</div>
<div class="graphql-code-line ">PAYMENT_DECLINED_ERROR</div>
<div class="graphql-code-line ">ALREADY_LOGGED_IN_ERROR</div>
<div class="graphql-code-line ">MISSING_PASSWORD_ERROR</div>
<div class="graphql-code-line ">PASSWORD_VALIDATION_ERROR</div>
<div class="graphql-code-line ">PASSWORD_ALREADY_SET_ERROR</div>
<div class="graphql-code-line ">VERIFICATION_TOKEN_INVALID_ERROR</div>
<div class="graphql-code-line ">VERIFICATION_TOKEN_EXPIRED_ERROR</div>
<div class="graphql-code-line ">IDENTIFIER_CHANGE_TOKEN_INVALID_ERROR</div>
<div class="graphql-code-line ">IDENTIFIER_CHANGE_TOKEN_EXPIRED_ERROR</div>
<div class="graphql-code-line ">PASSWORD_RESET_TOKEN_INVALID_ERROR</div>
<div class="graphql-code-line ">PASSWORD_RESET_TOKEN_EXPIRED_ERROR</div>
<div class="graphql-code-line ">NOT_VERIFIED_ERROR</div>
<div class="graphql-code-line top-level">}</div>
</div>
## GlobalFlag
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">GlobalFlag</span>
{</div>
<div class="graphql-code-line ">TRUE</div>
<div class="graphql-code-line ">FALSE</div>
<div class="graphql-code-line ">INHERIT</div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntryType
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">HistoryEntryType</span>
{</div>
<div class="graphql-code-line ">CUSTOMER_REGISTERED</div>
<div class="graphql-code-line ">CUSTOMER_VERIFIED</div>
<div class="graphql-code-line ">CUSTOMER_DETAIL_UPDATED</div>
<div class="graphql-code-line ">CUSTOMER_ADDED_TO_GROUP</div>
<div class="graphql-code-line ">CUSTOMER_REMOVED_FROM_GROUP</div>
<div class="graphql-code-line ">CUSTOMER_ADDRESS_CREATED</div>
<div class="graphql-code-line ">CUSTOMER_ADDRESS_UPDATED</div>
<div class="graphql-code-line ">CUSTOMER_ADDRESS_DELETED</div>
<div class="graphql-code-line ">CUSTOMER_PASSWORD_UPDATED</div>
<div class="graphql-code-line ">CUSTOMER_PASSWORD_RESET_REQUESTED</div>
<div class="graphql-code-line ">CUSTOMER_PASSWORD_RESET_VERIFIED</div>
<div class="graphql-code-line ">CUSTOMER_EMAIL_UPDATE_REQUESTED</div>
<div class="graphql-code-line ">CUSTOMER_EMAIL_UPDATE_VERIFIED</div>
<div class="graphql-code-line ">CUSTOMER_NOTE</div>
<div class="graphql-code-line ">ORDER_STATE_TRANSITION</div>
<div class="graphql-code-line ">ORDER_PAYMENT_TRANSITION</div>
<div class="graphql-code-line ">ORDER_FULFILLMENT</div>
<div class="graphql-code-line ">ORDER_CANCELLATION</div>
<div class="graphql-code-line ">ORDER_REFUND_TRANSITION</div>
<div class="graphql-code-line ">ORDER_FULFILLMENT_TRANSITION</div>
<div class="graphql-code-line ">ORDER_NOTE</div>
<div class="graphql-code-line ">ORDER_COUPON_APPLIED</div>
<div class="graphql-code-line ">ORDER_COUPON_REMOVED</div>
<div class="graphql-code-line ">ORDER_MODIFIED</div>
<div class="graphql-code-line ">ORDER_CUSTOMER_UPDATED</div>
<div class="graphql-code-line top-level">}</div>
</div>
## LanguageCode
<div class="graphql-code-block">
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Languages in the form of a ISO 639-1 language code with optional</div>
<div class="graphql-code-line comment">region or script modifier (e.g. de_AT). The selection available is based</div>
<div class="graphql-code-line comment">on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)</div>
<div class="graphql-code-line comment">and includes the major spoken languages of the world and any widely-used variants.</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">LanguageCode</span>
{</div>
<div class="graphql-code-line comment">"""Afrikaans"""</div>
<div class="graphql-code-line ">af</div>
<div class="graphql-code-line comment">"""Akan"""</div>
<div class="graphql-code-line ">ak</div>
<div class="graphql-code-line comment">"""Albanian"""</div>
<div class="graphql-code-line ">sq</div>
<div class="graphql-code-line comment">"""Amharic"""</div>
<div class="graphql-code-line ">am</div>
<div class="graphql-code-line comment">"""Arabic"""</div>
<div class="graphql-code-line ">ar</div>
<div class="graphql-code-line comment">"""Armenian"""</div>
<div class="graphql-code-line ">hy</div>
<div class="graphql-code-line comment">"""Assamese"""</div>
<div class="graphql-code-line ">as</div>
<div class="graphql-code-line comment">"""Azerbaijani"""</div>
<div class="graphql-code-line ">az</div>
<div class="graphql-code-line comment">"""Bambara"""</div>
<div class="graphql-code-line ">bm</div>
<div class="graphql-code-line comment">"""Bangla"""</div>
<div class="graphql-code-line ">bn</div>
<div class="graphql-code-line comment">"""Basque"""</div>
<div class="graphql-code-line ">eu</div>
<div class="graphql-code-line comment">"""Belarusian"""</div>
<div class="graphql-code-line ">be</div>
<div class="graphql-code-line comment">"""Bosnian"""</div>
<div class="graphql-code-line ">bs</div>
<div class="graphql-code-line comment">"""Breton"""</div>
<div class="graphql-code-line ">br</div>
<div class="graphql-code-line comment">"""Bulgarian"""</div>
<div class="graphql-code-line ">bg</div>
<div class="graphql-code-line comment">"""Burmese"""</div>
<div class="graphql-code-line ">my</div>
<div class="graphql-code-line comment">"""Catalan"""</div>
<div class="graphql-code-line ">ca</div>
<div class="graphql-code-line comment">"""Chechen"""</div>
<div class="graphql-code-line ">ce</div>
<div class="graphql-code-line comment">"""Chinese"""</div>
<div class="graphql-code-line ">zh</div>
<div class="graphql-code-line comment">"""Simplified Chinese"""</div>
<div class="graphql-code-line ">zh_Hans</div>
<div class="graphql-code-line comment">"""Traditional Chinese"""</div>
<div class="graphql-code-line ">zh_Hant</div>
<div class="graphql-code-line comment">"""Church Slavic"""</div>
<div class="graphql-code-line ">cu</div>
<div class="graphql-code-line comment">"""Cornish"""</div>
<div class="graphql-code-line ">kw</div>
<div class="graphql-code-line comment">"""Corsican"""</div>
<div class="graphql-code-line ">co</div>
<div class="graphql-code-line comment">"""Croatian"""</div>
<div class="graphql-code-line ">hr</div>
<div class="graphql-code-line comment">"""Czech"""</div>
<div class="graphql-code-line ">cs</div>
<div class="graphql-code-line comment">"""Danish"""</div>
<div class="graphql-code-line ">da</div>
<div class="graphql-code-line comment">"""Dutch"""</div>
<div class="graphql-code-line ">nl</div>
<div class="graphql-code-line comment">"""Flemish"""</div>
<div class="graphql-code-line ">nl_BE</div>
<div class="graphql-code-line comment">"""Dzongkha"""</div>
<div class="graphql-code-line ">dz</div>
<div class="graphql-code-line comment">"""English"""</div>
<div class="graphql-code-line ">en</div>
<div class="graphql-code-line comment">"""Australian English"""</div>
<div class="graphql-code-line ">en_AU</div>
<div class="graphql-code-line comment">"""Canadian English"""</div>
<div class="graphql-code-line ">en_CA</div>
<div class="graphql-code-line comment">"""British English"""</div>
<div class="graphql-code-line ">en_GB</div>
<div class="graphql-code-line comment">"""American English"""</div>
<div class="graphql-code-line ">en_US</div>
<div class="graphql-code-line comment">"""Esperanto"""</div>
<div class="graphql-code-line ">eo</div>
<div class="graphql-code-line comment">"""Estonian"""</div>
<div class="graphql-code-line ">et</div>
<div class="graphql-code-line comment">"""Ewe"""</div>
<div class="graphql-code-line ">ee</div>
<div class="graphql-code-line comment">"""Faroese"""</div>
<div class="graphql-code-line ">fo</div>
<div class="graphql-code-line comment">"""Finnish"""</div>
<div class="graphql-code-line ">fi</div>
<div class="graphql-code-line comment">"""French"""</div>
<div class="graphql-code-line ">fr</div>
<div class="graphql-code-line comment">"""Canadian French"""</div>
<div class="graphql-code-line ">fr_CA</div>
<div class="graphql-code-line comment">"""Swiss French"""</div>
<div class="graphql-code-line ">fr_CH</div>
<div class="graphql-code-line comment">"""Fulah"""</div>
<div class="graphql-code-line ">ff</div>
<div class="graphql-code-line comment">"""Galician"""</div>
<div class="graphql-code-line ">gl</div>
<div class="graphql-code-line comment">"""Ganda"""</div>
<div class="graphql-code-line ">lg</div>
<div class="graphql-code-line comment">"""Georgian"""</div>
<div class="graphql-code-line ">ka</div>
<div class="graphql-code-line comment">"""German"""</div>
<div class="graphql-code-line ">de</div>
<div class="graphql-code-line comment">"""Austrian German"""</div>
<div class="graphql-code-line ">de_AT</div>
<div class="graphql-code-line comment">"""Swiss High German"""</div>
<div class="graphql-code-line ">de_CH</div>
<div class="graphql-code-line comment">"""Greek"""</div>
<div class="graphql-code-line ">el</div>
<div class="graphql-code-line comment">"""Gujarati"""</div>
<div class="graphql-code-line ">gu</div>
<div class="graphql-code-line comment">"""Haitian Creole"""</div>
<div class="graphql-code-line ">ht</div>
<div class="graphql-code-line comment">"""Hausa"""</div>
<div class="graphql-code-line ">ha</div>
<div class="graphql-code-line comment">"""Hebrew"""</div>
<div class="graphql-code-line ">he</div>
<div class="graphql-code-line comment">"""Hindi"""</div>
<div class="graphql-code-line ">hi</div>
<div class="graphql-code-line comment">"""Hungarian"""</div>
<div class="graphql-code-line ">hu</div>
<div class="graphql-code-line comment">"""Icelandic"""</div>
<div class="graphql-code-line ">is</div>
<div class="graphql-code-line comment">"""Igbo"""</div>
<div class="graphql-code-line ">ig</div>
<div class="graphql-code-line comment">"""Indonesian"""</div>
<div class="graphql-code-line ">id</div>
<div class="graphql-code-line comment">"""Interlingua"""</div>
<div class="graphql-code-line ">ia</div>
<div class="graphql-code-line comment">"""Irish"""</div>
<div class="graphql-code-line ">ga</div>
<div class="graphql-code-line comment">"""Italian"""</div>
<div class="graphql-code-line ">it</div>
<div class="graphql-code-line comment">"""Japanese"""</div>
<div class="graphql-code-line ">ja</div>
<div class="graphql-code-line comment">"""Javanese"""</div>
<div class="graphql-code-line ">jv</div>
<div class="graphql-code-line comment">"""Kalaallisut"""</div>
<div class="graphql-code-line ">kl</div>
<div class="graphql-code-line comment">"""Kannada"""</div>
<div class="graphql-code-line ">kn</div>
<div class="graphql-code-line comment">"""Kashmiri"""</div>
<div class="graphql-code-line ">ks</div>
<div class="graphql-code-line comment">"""Kazakh"""</div>
<div class="graphql-code-line ">kk</div>
<div class="graphql-code-line comment">"""Khmer"""</div>
<div class="graphql-code-line ">km</div>
<div class="graphql-code-line comment">"""Kikuyu"""</div>
<div class="graphql-code-line ">ki</div>
<div class="graphql-code-line comment">"""Kinyarwanda"""</div>
<div class="graphql-code-line ">rw</div>
<div class="graphql-code-line comment">"""Korean"""</div>
<div class="graphql-code-line ">ko</div>
<div class="graphql-code-line comment">"""Kurdish"""</div>
<div class="graphql-code-line ">ku</div>
<div class="graphql-code-line comment">"""Kyrgyz"""</div>
<div class="graphql-code-line ">ky</div>
<div class="graphql-code-line comment">"""Lao"""</div>
<div class="graphql-code-line ">lo</div>
<div class="graphql-code-line comment">"""Latin"""</div>
<div class="graphql-code-line ">la</div>
<div class="graphql-code-line comment">"""Latvian"""</div>
<div class="graphql-code-line ">lv</div>
<div class="graphql-code-line comment">"""Lingala"""</div>
<div class="graphql-code-line ">ln</div>
<div class="graphql-code-line comment">"""Lithuanian"""</div>
<div class="graphql-code-line ">lt</div>
<div class="graphql-code-line comment">"""Luba-Katanga"""</div>
<div class="graphql-code-line ">lu</div>
<div class="graphql-code-line comment">"""Luxembourgish"""</div>
<div class="graphql-code-line ">lb</div>
<div class="graphql-code-line comment">"""Macedonian"""</div>
<div class="graphql-code-line ">mk</div>
<div class="graphql-code-line comment">"""Malagasy"""</div>
<div class="graphql-code-line ">mg</div>
<div class="graphql-code-line comment">"""Malay"""</div>
<div class="graphql-code-line ">ms</div>
<div class="graphql-code-line comment">"""Malayalam"""</div>
<div class="graphql-code-line ">ml</div>
<div class="graphql-code-line comment">"""Maltese"""</div>
<div class="graphql-code-line ">mt</div>
<div class="graphql-code-line comment">"""Manx"""</div>
<div class="graphql-code-line ">gv</div>
<div class="graphql-code-line comment">"""Maori"""</div>
<div class="graphql-code-line ">mi</div>
<div class="graphql-code-line comment">"""Marathi"""</div>
<div class="graphql-code-line ">mr</div>
<div class="graphql-code-line comment">"""Mongolian"""</div>
<div class="graphql-code-line ">mn</div>
<div class="graphql-code-line comment">"""Nepali"""</div>
<div class="graphql-code-line ">ne</div>
<div class="graphql-code-line comment">"""North Ndebele"""</div>
<div class="graphql-code-line ">nd</div>
<div class="graphql-code-line comment">"""Northern Sami"""</div>
<div class="graphql-code-line ">se</div>
<div class="graphql-code-line comment">"""Norwegian Bokmål"""</div>
<div class="graphql-code-line ">nb</div>
<div class="graphql-code-line comment">"""Norwegian Nynorsk"""</div>
<div class="graphql-code-line ">nn</div>
<div class="graphql-code-line comment">"""Nyanja"""</div>
<div class="graphql-code-line ">ny</div>
<div class="graphql-code-line comment">"""Odia"""</div>
<div class="graphql-code-line ">or</div>
<div class="graphql-code-line comment">"""Oromo"""</div>
<div class="graphql-code-line ">om</div>
<div class="graphql-code-line comment">"""Ossetic"""</div>
<div class="graphql-code-line ">os</div>
<div class="graphql-code-line comment">"""Pashto"""</div>
<div class="graphql-code-line ">ps</div>
<div class="graphql-code-line comment">"""Persian"""</div>
<div class="graphql-code-line ">fa</div>
<div class="graphql-code-line comment">"""Dari"""</div>
<div class="graphql-code-line ">fa_AF</div>
<div class="graphql-code-line comment">"""Polish"""</div>
<div class="graphql-code-line ">pl</div>
<div class="graphql-code-line comment">"""Portuguese"""</div>
<div class="graphql-code-line ">pt</div>
<div class="graphql-code-line comment">"""Brazilian Portuguese"""</div>
<div class="graphql-code-line ">pt_BR</div>
<div class="graphql-code-line comment">"""European Portuguese"""</div>
<div class="graphql-code-line ">pt_PT</div>
<div class="graphql-code-line comment">"""Punjabi"""</div>
<div class="graphql-code-line ">pa</div>
<div class="graphql-code-line comment">"""Quechua"""</div>
<div class="graphql-code-line ">qu</div>
<div class="graphql-code-line comment">"""Romanian"""</div>
<div class="graphql-code-line ">ro</div>
<div class="graphql-code-line comment">"""Moldavian"""</div>
<div class="graphql-code-line ">ro_MD</div>
<div class="graphql-code-line comment">"""Romansh"""</div>
<div class="graphql-code-line ">rm</div>
<div class="graphql-code-line comment">"""Rundi"""</div>
<div class="graphql-code-line ">rn</div>
<div class="graphql-code-line comment">"""Russian"""</div>
<div class="graphql-code-line ">ru</div>
<div class="graphql-code-line comment">"""Samoan"""</div>
<div class="graphql-code-line ">sm</div>
<div class="graphql-code-line comment">"""Sango"""</div>
<div class="graphql-code-line ">sg</div>
<div class="graphql-code-line comment">"""Sanskrit"""</div>
<div class="graphql-code-line ">sa</div>
<div class="graphql-code-line comment">"""Scottish Gaelic"""</div>
<div class="graphql-code-line ">gd</div>
<div class="graphql-code-line comment">"""Serbian"""</div>
<div class="graphql-code-line ">sr</div>
<div class="graphql-code-line comment">"""Shona"""</div>
<div class="graphql-code-line ">sn</div>
<div class="graphql-code-line comment">"""Sichuan Yi"""</div>
<div class="graphql-code-line ">ii</div>
<div class="graphql-code-line comment">"""Sindhi"""</div>
<div class="graphql-code-line ">sd</div>
<div class="graphql-code-line comment">"""Sinhala"""</div>
<div class="graphql-code-line ">si</div>
<div class="graphql-code-line comment">"""Slovak"""</div>
<div class="graphql-code-line ">sk</div>
<div class="graphql-code-line comment">"""Slovenian"""</div>
<div class="graphql-code-line ">sl</div>
<div class="graphql-code-line comment">"""Somali"""</div>
<div class="graphql-code-line ">so</div>
<div class="graphql-code-line comment">"""Southern Sotho"""</div>
<div class="graphql-code-line ">st</div>
<div class="graphql-code-line comment">"""Spanish"""</div>
<div class="graphql-code-line ">es</div>
<div class="graphql-code-line comment">"""European Spanish"""</div>
<div class="graphql-code-line ">es_ES</div>
<div class="graphql-code-line comment">"""Mexican Spanish"""</div>
<div class="graphql-code-line ">es_MX</div>
<div class="graphql-code-line comment">"""Sundanese"""</div>
<div class="graphql-code-line ">su</div>
<div class="graphql-code-line comment">"""Swahili"""</div>
<div class="graphql-code-line ">sw</div>
<div class="graphql-code-line comment">"""Congo Swahili"""</div>
<div class="graphql-code-line ">sw_CD</div>
<div class="graphql-code-line comment">"""Swedish"""</div>
<div class="graphql-code-line ">sv</div>
<div class="graphql-code-line comment">"""Tajik"""</div>
<div class="graphql-code-line ">tg</div>
<div class="graphql-code-line comment">"""Tamil"""</div>
<div class="graphql-code-line ">ta</div>
<div class="graphql-code-line comment">"""Tatar"""</div>
<div class="graphql-code-line ">tt</div>
<div class="graphql-code-line comment">"""Telugu"""</div>
<div class="graphql-code-line ">te</div>
<div class="graphql-code-line comment">"""Thai"""</div>
<div class="graphql-code-line ">th</div>
<div class="graphql-code-line comment">"""Tibetan"""</div>
<div class="graphql-code-line ">bo</div>
<div class="graphql-code-line comment">"""Tigrinya"""</div>
<div class="graphql-code-line ">ti</div>
<div class="graphql-code-line comment">"""Tongan"""</div>
<div class="graphql-code-line ">to</div>
<div class="graphql-code-line comment">"""Turkish"""</div>
<div class="graphql-code-line ">tr</div>
<div class="graphql-code-line comment">"""Turkmen"""</div>
<div class="graphql-code-line ">tk</div>
<div class="graphql-code-line comment">"""Ukrainian"""</div>
<div class="graphql-code-line ">uk</div>
<div class="graphql-code-line comment">"""Urdu"""</div>
<div class="graphql-code-line ">ur</div>
<div class="graphql-code-line comment">"""Uyghur"""</div>
<div class="graphql-code-line ">ug</div>
<div class="graphql-code-line comment">"""Uzbek"""</div>
<div class="graphql-code-line ">uz</div>
<div class="graphql-code-line comment">"""Vietnamese"""</div>
<div class="graphql-code-line ">vi</div>
<div class="graphql-code-line comment">"""Volapük"""</div>
<div class="graphql-code-line ">vo</div>
<div class="graphql-code-line comment">"""Welsh"""</div>
<div class="graphql-code-line ">cy</div>
<div class="graphql-code-line comment">"""Western Frisian"""</div>
<div class="graphql-code-line ">fy</div>
<div class="graphql-code-line comment">"""Wolof"""</div>
<div class="graphql-code-line ">wo</div>
<div class="graphql-code-line comment">"""Xhosa"""</div>
<div class="graphql-code-line ">xh</div>
<div class="graphql-code-line comment">"""Yiddish"""</div>
<div class="graphql-code-line ">yi</div>
<div class="graphql-code-line comment">"""Yoruba"""</div>
<div class="graphql-code-line ">yo</div>
<div class="graphql-code-line comment">"""Zulu"""</div>
<div class="graphql-code-line ">zu</div>
<div class="graphql-code-line top-level">}</div>
</div>
## LogicalOperator
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">LogicalOperator</span>
{</div>
<div class="graphql-code-line ">AND</div>
<div class="graphql-code-line ">OR</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderType
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">OrderType</span>
{</div>
<div class="graphql-code-line ">Regular</div>
<div class="graphql-code-line ">Seller</div>
<div class="graphql-code-line ">Aggregate</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Permission
<div class="graphql-code-block">
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Permissions for administrators and customers. Used to control access to</div>
<div class="graphql-code-line comment">GraphQL resolvers via the {@link Allow} decorator.</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">## Understanding Permission.Owner</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">`Permission.Owner` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only</div>
<div class="graphql-code-line comment">be accessible to the "owner" of that resource.</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">For example, the Shop API <code>activeCustomer</code> query resolver should only return the Customer object for the "owner" of that Customer, i.e.</div>
<div class="graphql-code-line comment">based on the activeUserId of the current session. As a result, the resolver code looks like this:</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">@example</div>
<div class="graphql-code-line comment">```TypeScript</div>
<div class="graphql-code-line comment">\@Query()</div>
<div class="graphql-code-line comment">\@Allow(Permission.Owner)</div>
<div class="graphql-code-line comment">async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {</div>
<div class="graphql-code-line comment"> const userId = ctx.activeUserId;</div>
<div class="graphql-code-line comment"> if (userId) {</div>
<div class="graphql-code-line comment"> return this.customerService.findOneByUserId(ctx, userId);</div>
<div class="graphql-code-line comment"> }</div>
<div class="graphql-code-line comment">}</div>
<div class="graphql-code-line comment">```</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally</div>
<div class="graphql-code-line comment">nor statically encoded at build-time, any resolvers using <code>Permission.Owner</code> **must** include logic to enforce that only the owner</div>
<div class="graphql-code-line comment">of the resource has access. If not, then it is the equivalent of using `Permission.Public`.</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">Permission</span>
{</div>
<div class="graphql-code-line comment">"""Authenticated means simply that the user is logged in"""</div>
<div class="graphql-code-line ">Authenticated</div>
<div class="graphql-code-line comment">"""SuperAdmin has unrestricted access to all operations"""</div>
<div class="graphql-code-line ">SuperAdmin</div>
<div class="graphql-code-line comment">"""Owner means the user owns this entity, e.g. a Customer's own Order"""</div>
<div class="graphql-code-line ">Owner</div>
<div class="graphql-code-line comment">"""Public means any unauthenticated user may perform the operation"""</div>
<div class="graphql-code-line ">Public</div>
<div class="graphql-code-line comment">"""Grants permission to update GlobalSettings"""</div>
<div class="graphql-code-line ">UpdateGlobalSettings</div>
<div class="graphql-code-line comment">"""Grants permission to create Products, Facets, Assets, Collections"""</div>
<div class="graphql-code-line ">CreateCatalog</div>
<div class="graphql-code-line comment">"""Grants permission to read Products, Facets, Assets, Collections"""</div>
<div class="graphql-code-line ">ReadCatalog</div>
<div class="graphql-code-line comment">"""Grants permission to update Products, Facets, Assets, Collections"""</div>
<div class="graphql-code-line ">UpdateCatalog</div>
<div class="graphql-code-line comment">"""Grants permission to delete Products, Facets, Assets, Collections"""</div>
<div class="graphql-code-line ">DeleteCatalog</div>
<div class="graphql-code-line comment">"""Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
<div class="graphql-code-line ">CreateSettings</div>
<div class="graphql-code-line comment">"""Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
<div class="graphql-code-line ">ReadSettings</div>
<div class="graphql-code-line comment">"""Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
<div class="graphql-code-line ">UpdateSettings</div>
<div class="graphql-code-line comment">"""Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
<div class="graphql-code-line ">DeleteSettings</div>
<div class="graphql-code-line comment">"""Grants permission to create Administrator"""</div>
<div class="graphql-code-line ">CreateAdministrator</div>
<div class="graphql-code-line comment">"""Grants permission to read Administrator"""</div>
<div class="graphql-code-line ">ReadAdministrator</div>
<div class="graphql-code-line comment">"""Grants permission to update Administrator"""</div>
<div class="graphql-code-line ">UpdateAdministrator</div>
<div class="graphql-code-line comment">"""Grants permission to delete Administrator"""</div>
<div class="graphql-code-line ">DeleteAdministrator</div>
<div class="graphql-code-line comment">"""Grants permission to create Asset"""</div>
<div class="graphql-code-line ">CreateAsset</div>
<div class="graphql-code-line comment">"""Grants permission to read Asset"""</div>
<div class="graphql-code-line ">ReadAsset</div>
<div class="graphql-code-line comment">"""Grants permission to update Asset"""</div>
<div class="graphql-code-line ">UpdateAsset</div>
<div class="graphql-code-line comment">"""Grants permission to delete Asset"""</div>
<div class="graphql-code-line ">DeleteAsset</div>
<div class="graphql-code-line comment">"""Grants permission to create Channel"""</div>
<div class="graphql-code-line ">CreateChannel</div>
<div class="graphql-code-line comment">"""Grants permission to read Channel"""</div>
<div class="graphql-code-line ">ReadChannel</div>
<div class="graphql-code-line comment">"""Grants permission to update Channel"""</div>
<div class="graphql-code-line ">UpdateChannel</div>
<div class="graphql-code-line comment">"""Grants permission to delete Channel"""</div>
<div class="graphql-code-line ">DeleteChannel</div>
<div class="graphql-code-line comment">"""Grants permission to create Collection"""</div>
<div class="graphql-code-line ">CreateCollection</div>
<div class="graphql-code-line comment">"""Grants permission to read Collection"""</div>
<div class="graphql-code-line ">ReadCollection</div>
<div class="graphql-code-line comment">"""Grants permission to update Collection"""</div>
<div class="graphql-code-line ">UpdateCollection</div>
<div class="graphql-code-line comment">"""Grants permission to delete Collection"""</div>
<div class="graphql-code-line ">DeleteCollection</div>
<div class="graphql-code-line comment">"""Grants permission to create Country"""</div>
<div class="graphql-code-line ">CreateCountry</div>
<div class="graphql-code-line comment">"""Grants permission to read Country"""</div>
<div class="graphql-code-line ">ReadCountry</div>
<div class="graphql-code-line comment">"""Grants permission to update Country"""</div>
<div class="graphql-code-line ">UpdateCountry</div>
<div class="graphql-code-line comment">"""Grants permission to delete Country"""</div>
<div class="graphql-code-line ">DeleteCountry</div>
<div class="graphql-code-line comment">"""Grants permission to create Customer"""</div>
<div class="graphql-code-line ">CreateCustomer</div>
<div class="graphql-code-line comment">"""Grants permission to read Customer"""</div>
<div class="graphql-code-line ">ReadCustomer</div>
<div class="graphql-code-line comment">"""Grants permission to update Customer"""</div>
<div class="graphql-code-line ">UpdateCustomer</div>
<div class="graphql-code-line comment">"""Grants permission to delete Customer"""</div>
<div class="graphql-code-line ">DeleteCustomer</div>
<div class="graphql-code-line comment">"""Grants permission to create CustomerGroup"""</div>
<div class="graphql-code-line ">CreateCustomerGroup</div>
<div class="graphql-code-line comment">"""Grants permission to read CustomerGroup"""</div>
<div class="graphql-code-line ">ReadCustomerGroup</div>
<div class="graphql-code-line comment">"""Grants permission to update CustomerGroup"""</div>
<div class="graphql-code-line ">UpdateCustomerGroup</div>
<div class="graphql-code-line comment">"""Grants permission to delete CustomerGroup"""</div>
<div class="graphql-code-line ">DeleteCustomerGroup</div>
<div class="graphql-code-line comment">"""Grants permission to create Facet"""</div>
<div class="graphql-code-line ">CreateFacet</div>
<div class="graphql-code-line comment">"""Grants permission to read Facet"""</div>
<div class="graphql-code-line ">ReadFacet</div>
<div class="graphql-code-line comment">"""Grants permission to update Facet"""</div>
<div class="graphql-code-line ">UpdateFacet</div>
<div class="graphql-code-line comment">"""Grants permission to delete Facet"""</div>
<div class="graphql-code-line ">DeleteFacet</div>
<div class="graphql-code-line comment">"""Grants permission to create Order"""</div>
<div class="graphql-code-line ">CreateOrder</div>
<div class="graphql-code-line comment">"""Grants permission to read Order"""</div>
<div class="graphql-code-line ">ReadOrder</div>
<div class="graphql-code-line comment">"""Grants permission to update Order"""</div>
<div class="graphql-code-line ">UpdateOrder</div>
<div class="graphql-code-line comment">"""Grants permission to delete Order"""</div>
<div class="graphql-code-line ">DeleteOrder</div>
<div class="graphql-code-line comment">"""Grants permission to create PaymentMethod"""</div>
<div class="graphql-code-line ">CreatePaymentMethod</div>
<div class="graphql-code-line comment">"""Grants permission to read PaymentMethod"""</div>
<div class="graphql-code-line ">ReadPaymentMethod</div>
<div class="graphql-code-line comment">"""Grants permission to update PaymentMethod"""</div>
<div class="graphql-code-line ">UpdatePaymentMethod</div>
<div class="graphql-code-line comment">"""Grants permission to delete PaymentMethod"""</div>
<div class="graphql-code-line ">DeletePaymentMethod</div>
<div class="graphql-code-line comment">"""Grants permission to create Product"""</div>
<div class="graphql-code-line ">CreateProduct</div>
<div class="graphql-code-line comment">"""Grants permission to read Product"""</div>
<div class="graphql-code-line ">ReadProduct</div>
<div class="graphql-code-line comment">"""Grants permission to update Product"""</div>
<div class="graphql-code-line ">UpdateProduct</div>
<div class="graphql-code-line comment">"""Grants permission to delete Product"""</div>
<div class="graphql-code-line ">DeleteProduct</div>
<div class="graphql-code-line comment">"""Grants permission to create Promotion"""</div>
<div class="graphql-code-line ">CreatePromotion</div>
<div class="graphql-code-line comment">"""Grants permission to read Promotion"""</div>
<div class="graphql-code-line ">ReadPromotion</div>
<div class="graphql-code-line comment">"""Grants permission to update Promotion"""</div>
<div class="graphql-code-line ">UpdatePromotion</div>
<div class="graphql-code-line comment">"""Grants permission to delete Promotion"""</div>
<div class="graphql-code-line ">DeletePromotion</div>
<div class="graphql-code-line comment">"""Grants permission to create ShippingMethod"""</div>
<div class="graphql-code-line ">CreateShippingMethod</div>
<div class="graphql-code-line comment">"""Grants permission to read ShippingMethod"""</div>
<div class="graphql-code-line ">ReadShippingMethod</div>
<div class="graphql-code-line comment">"""Grants permission to update ShippingMethod"""</div>
<div class="graphql-code-line ">UpdateShippingMethod</div>
<div class="graphql-code-line comment">"""Grants permission to delete ShippingMethod"""</div>
<div class="graphql-code-line ">DeleteShippingMethod</div>
<div class="graphql-code-line comment">"""Grants permission to create Tag"""</div>
<div class="graphql-code-line ">CreateTag</div>
<div class="graphql-code-line comment">"""Grants permission to read Tag"""</div>
<div class="graphql-code-line ">ReadTag</div>
<div class="graphql-code-line comment">"""Grants permission to update Tag"""</div>
<div class="graphql-code-line ">UpdateTag</div>
<div class="graphql-code-line comment">"""Grants permission to delete Tag"""</div>
<div class="graphql-code-line ">DeleteTag</div>
<div class="graphql-code-line comment">"""Grants permission to create TaxCategory"""</div>
<div class="graphql-code-line ">CreateTaxCategory</div>
<div class="graphql-code-line comment">"""Grants permission to read TaxCategory"""</div>
<div class="graphql-code-line ">ReadTaxCategory</div>
<div class="graphql-code-line comment">"""Grants permission to update TaxCategory"""</div>
<div class="graphql-code-line ">UpdateTaxCategory</div>
<div class="graphql-code-line comment">"""Grants permission to delete TaxCategory"""</div>
<div class="graphql-code-line ">DeleteTaxCategory</div>
<div class="graphql-code-line comment">"""Grants permission to create TaxRate"""</div>
<div class="graphql-code-line ">CreateTaxRate</div>
<div class="graphql-code-line comment">"""Grants permission to read TaxRate"""</div>
<div class="graphql-code-line ">ReadTaxRate</div>
<div class="graphql-code-line comment">"""Grants permission to update TaxRate"""</div>
<div class="graphql-code-line ">UpdateTaxRate</div>
<div class="graphql-code-line comment">"""Grants permission to delete TaxRate"""</div>
<div class="graphql-code-line ">DeleteTaxRate</div>
<div class="graphql-code-line comment">"""Grants permission to create Seller"""</div>
<div class="graphql-code-line ">CreateSeller</div>
<div class="graphql-code-line comment">"""Grants permission to read Seller"""</div>
<div class="graphql-code-line ">ReadSeller</div>
<div class="graphql-code-line comment">"""Grants permission to update Seller"""</div>
<div class="graphql-code-line ">UpdateSeller</div>
<div class="graphql-code-line comment">"""Grants permission to delete Seller"""</div>
<div class="graphql-code-line ">DeleteSeller</div>
<div class="graphql-code-line comment">"""Grants permission to create StockLocation"""</div>
<div class="graphql-code-line ">CreateStockLocation</div>
<div class="graphql-code-line comment">"""Grants permission to read StockLocation"""</div>
<div class="graphql-code-line ">ReadStockLocation</div>
<div class="graphql-code-line comment">"""Grants permission to update StockLocation"""</div>
<div class="graphql-code-line ">UpdateStockLocation</div>
<div class="graphql-code-line comment">"""Grants permission to delete StockLocation"""</div>
<div class="graphql-code-line ">DeleteStockLocation</div>
<div class="graphql-code-line comment">"""Grants permission to create System"""</div>
<div class="graphql-code-line ">CreateSystem</div>
<div class="graphql-code-line comment">"""Grants permission to read System"""</div>
<div class="graphql-code-line ">ReadSystem</div>
<div class="graphql-code-line comment">"""Grants permission to update System"""</div>
<div class="graphql-code-line ">UpdateSystem</div>
<div class="graphql-code-line comment">"""Grants permission to delete System"""</div>
<div class="graphql-code-line ">DeleteSystem</div>
<div class="graphql-code-line comment">"""Grants permission to create Zone"""</div>
<div class="graphql-code-line ">CreateZone</div>
<div class="graphql-code-line comment">"""Grants permission to read Zone"""</div>
<div class="graphql-code-line ">ReadZone</div>
<div class="graphql-code-line comment">"""Grants permission to update Zone"""</div>
<div class="graphql-code-line ">UpdateZone</div>
<div class="graphql-code-line comment">"""Grants permission to delete Zone"""</div>
<div class="graphql-code-line ">DeleteZone</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SortOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">SortOrder</span>
{</div>
<div class="graphql-code-line ">ASC</div>
<div class="graphql-code-line ">DESC</div>
<div class="graphql-code-line top-level">}</div>
</div>
|
---
title: "Input Objects"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AuthenticationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">AuthenticationInput</span>
{</div>
<div class="graphql-code-line ">native: <a href="/reference/graphql-api/shop/input-types#nativeauthinput">NativeAuthInput</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## BooleanListOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a list of Boolean fields</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">BooleanListOperators</span>
{</div>
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## BooleanOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a Boolean field</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">BooleanOperators</span>
{</div>
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CollectionFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">position: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#collectionfilterparameter">CollectionFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#collectionfilterparameter">CollectionFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CollectionListOptions</span>
{</div>
<div class="graphql-code-line ">topLevelOnly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#collectionsortparameter">CollectionSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#collectionfilterparameter">CollectionFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CollectionSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">position: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigArgInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ConfigArgInput</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">A JSON stringified representation of the actual value</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigurableOperationInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ConfigurableOperationInput</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">arguments: [<a href="/reference/graphql-api/shop/input-types#configarginput">ConfigArgInput</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateAddressInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateAddressInput</span>
{</div>
<div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">company: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">city: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">province: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">countryCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">defaultShippingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">defaultBillingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CreateCustomerInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CreateCustomerInput</span>
{</div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#customerfilterparameter">CustomerFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#customerfilterparameter">CustomerFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#customersortparameter">CustomerSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#customerfilterparameter">CustomerFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">CustomerSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## DateListOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a list of Date fields</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DateListOperators</span>
{</div>
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## DateOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a DateTime field</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DateOperators</span>
{</div>
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">before: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">after: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">between: <a href="/reference/graphql-api/shop/input-types#daterange">DateRange</a></div>
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## DateRange
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">DateRange</span>
{</div>
<div class="graphql-code-line ">start: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">end: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#facetfilterparameter">FacetFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#facetfilterparameter">FacetFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#facetsortparameter">FacetSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#facetfilterparameter">FacetFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueFilterInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Used to construct boolean expressions for filtering search results</div>
<div class="graphql-code-line top-level comment">by FacetValue ID. Examples:</div>
<div class="graphql-code-line top-level comment"></div>
<div class="graphql-code-line top-level comment">* ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`</div>
<div class="graphql-code-line top-level comment">* ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`</div>
<div class="graphql-code-line top-level comment">* ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueFilterInput</span>
{</div>
<div class="graphql-code-line ">and: <a href="/reference/graphql-api/shop/object-types#id">ID</a></div>
<div class="graphql-code-line ">or: [<a href="/reference/graphql-api/shop/object-types#id">ID</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">facetId: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#facetvaluefilterparameter">FacetValueFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#facetvaluefilterparameter">FacetValueFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#facetvaluesortparameter">FacetValueSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#facetvaluefilterparameter">FacetValueFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">FacetValueSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">facetId: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntryFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">HistoryEntryFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#historyentryfilterparameter">HistoryEntryFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#historyentryfilterparameter">HistoryEntryFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntryListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">HistoryEntryListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#historyentrysortparameter">HistoryEntrySortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#historyentryfilterparameter">HistoryEntryFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntrySortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">HistoryEntrySortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## IDListOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a list of ID fields</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">IDListOperators</span>
{</div>
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## IDOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on an ID field</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">IDOperators</span>
{</div>
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">notEq: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">in: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">notIn: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## NativeAuthInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NativeAuthInput</span>
{</div>
<div class="graphql-code-line ">username: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">password: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NumberListOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a list of Number fields</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NumberListOperators</span>
{</div>
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NumberOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a Int or Float field</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NumberOperators</span>
{</div>
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
<div class="graphql-code-line ">lt: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
<div class="graphql-code-line ">lte: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
<div class="graphql-code-line ">gt: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
<div class="graphql-code-line ">gte: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
<div class="graphql-code-line ">between: <a href="/reference/graphql-api/shop/input-types#numberrange">NumberRange</a></div>
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## NumberRange
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">NumberRange</span>
{</div>
<div class="graphql-code-line ">start: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
<div class="graphql-code-line ">end: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">OrderFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">orderPlacedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">active: <a href="/reference/graphql-api/shop/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">totalQuantity: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">subTotal: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">subTotalWithTax: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">shippingWithTax: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">total: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">totalWithTax: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#orderfilterparameter">OrderFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#orderfilterparameter">OrderFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">OrderListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#ordersortparameter">OrderSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#orderfilterparameter">OrderFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">OrderSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">orderPlacedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">totalQuantity: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">subTotal: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">subTotalWithTax: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">shippingWithTax: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">total: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">totalWithTax: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Passed as input to the <code>addPaymentToOrder</code> mutation.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">PaymentInput</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">This field should correspond to the <code>code</code> property of a PaymentMethod.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">method: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">This field should contain arbitrary data passed to the specified PaymentMethodHandler's <code>createPayment()</code> method</div>
<div class="graphql-code-line comment">as the "metadata" argument. For example, it could contain an ID for the payment and other</div>
<div class="graphql-code-line comment">data generated by the payment provider.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/shop/object-types#json">JSON</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/input-types#booleanoperators">BooleanOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#productfilterparameter">ProductFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#productfilterparameter">ProductFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#productsortparameter">ProductSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#productfilterparameter">ProductFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantFilterParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductVariantFilterParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">productId: <a href="/reference/graphql-api/shop/input-types#idoperators">IDOperators</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/input-types#dateoperators">DateOperators</a></div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/input-types#numberoperators">NumberOperators</a></div>
<div class="graphql-code-line ">stockLevel: <a href="/reference/graphql-api/shop/input-types#stringoperators">StringOperators</a></div>
<div class="graphql-code-line ">_and: [<a href="/reference/graphql-api/shop/input-types#productvariantfilterparameter">ProductVariantFilterParameter</a>!]</div>
<div class="graphql-code-line ">_or: [<a href="/reference/graphql-api/shop/input-types#productvariantfilterparameter">ProductVariantFilterParameter</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantListOptions
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductVariantListOptions</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Skips the first n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Takes n results, for use in pagination</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies which properties to sort the results by</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#productvariantsortparameter">ProductVariantSortParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Allows the results to be filtered</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filter: <a href="/reference/graphql-api/shop/input-types#productvariantfilterparameter">ProductVariantFilterParameter</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">filterOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">ProductVariantSortParameter</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">productId: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">stockLevel: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## RegisterCustomerInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">RegisterCustomerInput</span>
{</div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">password: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SearchInput</span>
{</div>
<div class="graphql-code-line ">term: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">facetValueIds: [<a href="/reference/graphql-api/shop/object-types#id">ID</a>!]</div>
<div class="graphql-code-line ">facetValueOperator: <a href="/reference/graphql-api/shop/enums#logicaloperator">LogicalOperator</a></div>
<div class="graphql-code-line ">facetValueFilters: [<a href="/reference/graphql-api/shop/input-types#facetvaluefilterinput">FacetValueFilterInput</a>!]</div>
<div class="graphql-code-line ">collectionId: <a href="/reference/graphql-api/shop/object-types#id">ID</a></div>
<div class="graphql-code-line ">collectionSlug: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">groupByProduct: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">take: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line ">skip: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line ">sort: <a href="/reference/graphql-api/shop/input-types#searchresultsortparameter">SearchResultSortParameter</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchResultSortParameter
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">SearchResultSortParameter</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/enums#sortorder">SortOrder</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## StringListOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a list of String fields</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">StringListOperators</span>
{</div>
<div class="graphql-code-line ">inList: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## StringOperators
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Operators for filtering on a String field</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">StringOperators</span>
{</div>
<div class="graphql-code-line ">eq: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">notEq: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">contains: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">notContains: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">in: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">notIn: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]</div>
<div class="graphql-code-line ">regex: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">isNull: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateAddressInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateAddressInput</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">company: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">city: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">province: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">countryCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">defaultShippingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">defaultBillingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateCustomerInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateCustomerInput</span>
{</div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## UpdateOrderInput
<div class="graphql-code-block">
<div class="graphql-code-line top-level">input <span class="graphql-code-identifier">UpdateOrderInput</span>
{</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
|
---
title: "Mutations"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## addItemToOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Adds an item to the order. If custom fields are defined on the OrderLine entity, a third argument 'customFields' will be available.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">addItemToOrder(productVariantId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!, quantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!): <a href="/reference/graphql-api/shop/object-types#updateorderitemsresult">UpdateOrderItemsResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## addPaymentToOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Add a Payment to the Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">addPaymentToOrder(input: <a href="/reference/graphql-api/shop/input-types#paymentinput">PaymentInput</a>!): <a href="/reference/graphql-api/shop/object-types#addpaymenttoorderresult">AddPaymentToOrderResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## adjustOrderLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Adjusts an OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type <code>OrderLineCustomFieldsInput</code> will be available.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">adjustOrderLine(orderLineId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!, quantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!): <a href="/reference/graphql-api/shop/object-types#updateorderitemsresult">UpdateOrderItemsResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## applyCouponCode
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Applies the given coupon code to the active Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">applyCouponCode(couponCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!): <a href="/reference/graphql-api/shop/object-types#applycouponcoderesult">ApplyCouponCodeResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## authenticate
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Authenticates the user using a named authentication strategy</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">authenticate(input: <a href="/reference/graphql-api/shop/input-types#authenticationinput">AuthenticationInput</a>!, rememberMe: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/shop/object-types#authenticationresult">AuthenticationResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## createCustomerAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Create a new Customer Address</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">createCustomerAddress(input: <a href="/reference/graphql-api/shop/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/shop/object-types#address">Address</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## deleteCustomerAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Delete an existing Address</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">deleteCustomerAddress(id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!): <a href="/reference/graphql-api/shop/object-types#success">Success</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## login
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})`</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">login(username: <a href="/reference/graphql-api/shop/object-types#string">String</a>!, password: <a href="/reference/graphql-api/shop/object-types#string">String</a>!, rememberMe: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/shop/object-types#nativeauthenticationresult">NativeAuthenticationResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## logout
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">End the current authenticated session</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">logout: <a href="/reference/graphql-api/shop/object-types#success">Success</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## refreshCustomerVerification
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Regenerate and send a verification token for a new Customer registration. Only applicable if <code>authOptions.requireVerification</code> is set to true.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">refreshCustomerVerification(emailAddress: <a href="/reference/graphql-api/shop/object-types#string">String</a>!): <a href="/reference/graphql-api/shop/object-types#refreshcustomerverificationresult">RefreshCustomerVerificationResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## registerCustomerAccount
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Register a Customer account with the given credentials. There are three possible registration flows:</div>
<div class="graphql-code-line top-level comment"></div>
<div class="graphql-code-line top-level comment">_If <code>authOptions.requireVerification</code> is set to `true`:_</div>
<div class="graphql-code-line top-level comment"></div>
<div class="graphql-code-line top-level comment">1. **The Customer is registered _with_ a password**. A verificationToken will be created (and typically emailed to the Customer). That</div>
<div class="graphql-code-line top-level comment"> verificationToken would then be passed to the <code>verifyCustomerAccount</code> mutation _without_ a password. The Customer is then</div>
<div class="graphql-code-line top-level comment"> verified and authenticated in one step.</div>
<div class="graphql-code-line top-level comment">2. **The Customer is registered _without_ a password**. A verificationToken will be created (and typically emailed to the Customer). That</div>
<div class="graphql-code-line top-level comment"> verificationToken would then be passed to the <code>verifyCustomerAccount</code> mutation _with_ the chosen password of the Customer. The Customer is then</div>
<div class="graphql-code-line top-level comment"> verified and authenticated in one step.</div>
<div class="graphql-code-line top-level comment"></div>
<div class="graphql-code-line top-level comment">_If <code>authOptions.requireVerification</code> is set to `false`:_</div>
<div class="graphql-code-line top-level comment"></div>
<div class="graphql-code-line top-level comment">3. The Customer _must_ be registered _with_ a password. No further action is needed - the Customer is able to authenticate immediately.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">registerCustomerAccount(input: <a href="/reference/graphql-api/shop/input-types#registercustomerinput">RegisterCustomerInput</a>!): <a href="/reference/graphql-api/shop/object-types#registercustomeraccountresult">RegisterCustomerAccountResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeAllOrderLines
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Remove all OrderLine from the Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeAllOrderLines: <a href="/reference/graphql-api/shop/object-types#removeorderitemsresult">RemoveOrderItemsResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeCouponCode
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Removes the given coupon code from the active Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeCouponCode(couponCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!): <a href="/reference/graphql-api/shop/object-types#order">Order</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## removeOrderLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Remove an OrderLine from the Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">removeOrderLine(orderLineId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!): <a href="/reference/graphql-api/shop/object-types#removeorderitemsresult">RemoveOrderItemsResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## requestPasswordReset
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Requests a password reset email to be sent</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">requestPasswordReset(emailAddress: <a href="/reference/graphql-api/shop/object-types#string">String</a>!): <a href="/reference/graphql-api/shop/object-types#requestpasswordresetresult">RequestPasswordResetResult</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## requestUpdateCustomerEmailAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Request to update the emailAddress of the active Customer. If <code>authOptions.requireVerification</code> is enabled</div>
<div class="graphql-code-line top-level comment">(as is the default), then the <code>identifierChangeToken</code> will be assigned to the current User and</div>
<div class="graphql-code-line top-level comment">a IdentifierChangeRequestEvent will be raised. This can then be used e.g. by the EmailPlugin to email</div>
<div class="graphql-code-line top-level comment">that verification token to the Customer, which is then used to verify the change of email address.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">requestUpdateCustomerEmailAddress(password: <a href="/reference/graphql-api/shop/object-types#string">String</a>!, newEmailAddress: <a href="/reference/graphql-api/shop/object-types#string">String</a>!): <a href="/reference/graphql-api/shop/object-types#requestupdatecustomeremailaddressresult">RequestUpdateCustomerEmailAddressResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## resetPassword
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Resets a Customer's password based on the provided token</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">resetPassword(token: <a href="/reference/graphql-api/shop/object-types#string">String</a>!, password: <a href="/reference/graphql-api/shop/object-types#string">String</a>!): <a href="/reference/graphql-api/shop/object-types#resetpasswordresult">ResetPasswordResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## setCustomerForOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Set the Customer for the Order. Required only if the Customer is not currently logged in</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setCustomerForOrder(input: <a href="/reference/graphql-api/shop/input-types#createcustomerinput">CreateCustomerInput</a>!): <a href="/reference/graphql-api/shop/object-types#setcustomerfororderresult">SetCustomerForOrderResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## setOrderBillingAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Sets the billing address for this order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setOrderBillingAddress(input: <a href="/reference/graphql-api/shop/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/shop/object-types#activeorderresult">ActiveOrderResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## setOrderCustomFields
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Allows any custom fields to be set for the active order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setOrderCustomFields(input: <a href="/reference/graphql-api/shop/input-types#updateorderinput">UpdateOrderInput</a>!): <a href="/reference/graphql-api/shop/object-types#activeorderresult">ActiveOrderResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## setOrderShippingAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Sets the shipping address for this order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setOrderShippingAddress(input: <a href="/reference/graphql-api/shop/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/shop/object-types#activeorderresult">ActiveOrderResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## setOrderShippingMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Sets the shipping method by id, which can be obtained with the <code>eligibleShippingMethods</code> query.</div>
<div class="graphql-code-line top-level comment">An Order can have multiple shipping methods, in which case you can pass an array of ids. In this case,</div>
<div class="graphql-code-line top-level comment">you should configure a custom ShippingLineAssignmentStrategy in order to know which OrderLines each</div>
<div class="graphql-code-line top-level comment">shipping method will apply to.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">setOrderShippingMethod(shippingMethodId: [<a href="/reference/graphql-api/shop/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/shop/object-types#setordershippingmethodresult">SetOrderShippingMethodResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## transitionOrderToState
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Transitions an Order to a new state. Valid next states can be found by querying `nextOrderStates`</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">transitionOrderToState(state: <a href="/reference/graphql-api/shop/object-types#string">String</a>!): <a href="/reference/graphql-api/shop/object-types#transitionordertostateresult">TransitionOrderToStateResult</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateCustomer
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Customer</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateCustomer(input: <a href="/reference/graphql-api/shop/input-types#updatecustomerinput">UpdateCustomerInput</a>!): <a href="/reference/graphql-api/shop/object-types#customer">Customer</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateCustomerAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update an existing Address</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateCustomerAddress(input: <a href="/reference/graphql-api/shop/input-types#updateaddressinput">UpdateAddressInput</a>!): <a href="/reference/graphql-api/shop/object-types#address">Address</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateCustomerEmailAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Confirm the update of the emailAddress with the provided token, which has been generated by the</div>
<div class="graphql-code-line top-level comment">`requestUpdateCustomerEmailAddress` mutation.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateCustomerEmailAddress(token: <a href="/reference/graphql-api/shop/object-types#string">String</a>!): <a href="/reference/graphql-api/shop/object-types#updatecustomeremailaddressresult">UpdateCustomerEmailAddressResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## updateCustomerPassword
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Update the password of the active Customer</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">updateCustomerPassword(currentPassword: <a href="/reference/graphql-api/shop/object-types#string">String</a>!, newPassword: <a href="/reference/graphql-api/shop/object-types#string">String</a>!): <a href="/reference/graphql-api/shop/object-types#updatecustomerpasswordresult">UpdateCustomerPasswordResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## verifyCustomerAccount
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Verify a Customer email address with the token sent to that address. Only applicable if <code>authOptions.requireVerification</code> is set to true.</div>
<div class="graphql-code-line top-level comment"></div>
<div class="graphql-code-line top-level comment">If the Customer was not registered with a password in the <code>registerCustomerAccount</code> mutation, the password _must_ be</div>
<div class="graphql-code-line top-level comment">provided here.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span>
{</div>
<div class="graphql-code-line ">verifyCustomerAccount(token: <a href="/reference/graphql-api/shop/object-types#string">String</a>!, password: <a href="/reference/graphql-api/shop/object-types#string">String</a>): <a href="/reference/graphql-api/shop/object-types#verifycustomeraccountresult">VerifyCustomerAccountResult</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
|
---
title: "Types"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## ActiveOrderResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">ActiveOrderResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#noactiveordererror">NoActiveOrderError</a></div>
</div>
## AddPaymentToOrderResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">AddPaymentToOrderResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#orderpaymentstateerror">OrderPaymentStateError</a> | <a href="/reference/graphql-api/shop/object-types#ineligiblepaymentmethoderror">IneligiblePaymentMethodError</a> | <a href="/reference/graphql-api/shop/object-types#paymentfailederror">PaymentFailedError</a> | <a href="/reference/graphql-api/shop/object-types#paymentdeclinederror">PaymentDeclinedError</a> | <a href="/reference/graphql-api/shop/object-types#orderstatetransitionerror">OrderStateTransitionError</a> | <a href="/reference/graphql-api/shop/object-types#noactiveordererror">NoActiveOrderError</a></div>
</div>
## Address
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Address</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">company: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">city: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">province: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">country: <a href="/reference/graphql-api/shop/object-types#country">Country</a>!</div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">defaultShippingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">defaultBillingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## Adjustment
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Adjustment</span>
{</div>
<div class="graphql-code-line ">adjustmentSource: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/enums#adjustmenttype">AdjustmentType</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">amount: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">data: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AlreadyLoggedInError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to set the Customer for an Order when already logged in.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">AlreadyLoggedInError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ApplyCouponCodeResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">ApplyCouponCodeResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#couponcodeexpirederror">CouponCodeExpiredError</a> | <a href="/reference/graphql-api/shop/object-types#couponcodeinvaliderror">CouponCodeInvalidError</a> | <a href="/reference/graphql-api/shop/object-types#couponcodelimiterror">CouponCodeLimitError</a></div>
</div>
## Asset
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Asset</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/enums#assettype">AssetType</a>!</div>
<div class="graphql-code-line ">fileSize: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">mimeType: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">width: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">height: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">source: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">preview: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">focalPoint: <a href="/reference/graphql-api/shop/object-types#coordinate">Coordinate</a></div>
<div class="graphql-code-line ">tags: [<a href="/reference/graphql-api/shop/object-types#tag">Tag</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## AssetList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">AssetList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#asset">Asset</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AuthenticationMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">AuthenticationMethod</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">strategy: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## AuthenticationResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">AuthenticationResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#currentuser">CurrentUser</a> | <a href="/reference/graphql-api/shop/object-types#invalidcredentialserror">InvalidCredentialsError</a> | <a href="/reference/graphql-api/shop/object-types#notverifiederror">NotVerifiedError</a></div>
</div>
## Boolean
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>Boolean</code> scalar type represents <code>true</code> or `false`.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Boolean</span>
</div>
</div>
## BooleanCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">BooleanCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## Channel
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Channel</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">token: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">defaultTaxZone: <a href="/reference/graphql-api/shop/object-types#zone">Zone</a></div>
<div class="graphql-code-line ">defaultShippingZone: <a href="/reference/graphql-api/shop/object-types#zone">Zone</a></div>
<div class="graphql-code-line ">defaultLanguageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">availableLanguageCodes: [<a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!]</div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">defaultCurrencyCode: <a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">availableCurrencyCodes: [<a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Not yet used - will be implemented in a future release.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Not yet used - will be implemented in a future release.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line ">pricesIncludeTax: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">seller: <a href="/reference/graphql-api/shop/object-types#seller">Seller</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## Collection
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Collection</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">breadcrumbs: [<a href="/reference/graphql-api/shop/object-types#collectionbreadcrumb">CollectionBreadcrumb</a>!]!</div>
<div class="graphql-code-line ">position: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/shop/object-types#asset">Asset</a></div>
<div class="graphql-code-line ">assets: [<a href="/reference/graphql-api/shop/object-types#asset">Asset</a>!]!</div>
<div class="graphql-code-line ">parent: <a href="/reference/graphql-api/shop/object-types#collection">Collection</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">children: [<a href="/reference/graphql-api/shop/object-types#collection">Collection</a>!]</div>
<div class="graphql-code-line ">filters: [<a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#collectiontranslation">CollectionTranslation</a>!]!</div>
<div class="graphql-code-line ">productVariants(options: <a href="/reference/graphql-api/shop/input-types#productvariantlistoptions">ProductVariantListOptions</a>): <a href="/reference/graphql-api/shop/object-types#productvariantlist">ProductVariantList</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionBreadcrumb
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionBreadcrumb</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#collection">Collection</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Which Collections are present in the products returned</div>
<div class="graphql-code-line top-level comment">by the search, and in what quantity.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionResult</span>
{</div>
<div class="graphql-code-line ">collection: <a href="/reference/graphql-api/shop/object-types#collection">Collection</a>!</div>
<div class="graphql-code-line ">count: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CollectionTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigArg
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigArg</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigArgDefinition
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigArgDefinition</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">required: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">defaultValue: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line ">label: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigurableOperation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigurableOperation</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">args: [<a href="/reference/graphql-api/shop/object-types#configarg">ConfigArg</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ConfigurableOperationDefinition
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigurableOperationDefinition</span>
{</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">args: [<a href="/reference/graphql-api/shop/object-types#configargdefinition">ConfigArgDefinition</a>!]!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Coordinate
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Coordinate</span>
{</div>
<div class="graphql-code-line ">x: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
<div class="graphql-code-line ">y: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Country
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Country</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">parent: <a href="/reference/graphql-api/shop/object-types#region">Region</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/shop/object-types#id">ID</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#regiontranslation">RegionTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CountryList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CountryList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#country">Country</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CouponCodeExpiredError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the provided coupon code is invalid</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CouponCodeExpiredError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CouponCodeInvalidError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the provided coupon code is invalid</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CouponCodeInvalidError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CouponCodeLimitError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the provided coupon code is invalid</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CouponCodeLimitError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">limit: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CurrentUser
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CurrentUser</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">identifier: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">channels: [<a href="/reference/graphql-api/shop/object-types#currentuserchannel">CurrentUserChannel</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CurrentUserChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CurrentUserChannel</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">token: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">permissions: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">CustomFieldConfig</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#stringcustomfieldconfig">StringCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#localestringcustomfieldconfig">LocaleStringCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#intcustomfieldconfig">IntCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#floatcustomfieldconfig">FloatCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#booleancustomfieldconfig">BooleanCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#datetimecustomfieldconfig">DateTimeCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#relationcustomfieldconfig">RelationCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#textcustomfieldconfig">TextCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#localetextcustomfieldconfig">LocaleTextCustomFieldConfig</a></div>
</div>
## Customer
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Customer</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">addresses: [<a href="/reference/graphql-api/shop/object-types#address">Address</a>!]</div>
<div class="graphql-code-line ">orders(options: <a href="/reference/graphql-api/shop/input-types#orderlistoptions">OrderListOptions</a>): <a href="/reference/graphql-api/shop/object-types#orderlist">OrderList</a>!</div>
<div class="graphql-code-line ">user: <a href="/reference/graphql-api/shop/object-types#user">User</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CustomerGroup</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">customers(options: <a href="/reference/graphql-api/shop/input-types#customerlistoptions">CustomerListOptions</a>): <a href="/reference/graphql-api/shop/object-types#customerlist">CustomerList</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## CustomerList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CustomerList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#customer">Customer</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## DateTime
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the <code>date-time</code> format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">DateTime</span>
</div>
</div>
## DateTimeCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Expects the same validation formats as the <code><input type="datetime-local"></code> HTML element.</div>
<div class="graphql-code-line top-level comment">See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">DateTimeCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">min: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">max: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">step: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## DeletionResponse
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">DeletionResponse</span>
{</div>
<div class="graphql-code-line ">result: <a href="/reference/graphql-api/shop/enums#deletionresult">DeletionResult</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## Discount
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Discount</span>
{</div>
<div class="graphql-code-line ">adjustmentSource: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/enums#adjustmenttype">AdjustmentType</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">amount: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">amountWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## EmailAddressConflictError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to create a Customer with an email address already registered to an existing User.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">EmailAddressConflictError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Facet
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Facet</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">values: [<a href="/reference/graphql-api/shop/object-types#facetvalue">FacetValue</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">valueList(options: <a href="/reference/graphql-api/shop/input-types#facetvaluelistoptions">FacetValueListOptions</a>): <a href="/reference/graphql-api/shop/object-types#facetvaluelist">FacetValueList</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#facettranslation">FacetTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#facet">Facet</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValue
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValue</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">facet: <a href="/reference/graphql-api/shop/object-types#facet">Facet</a>!</div>
<div class="graphql-code-line ">facetId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#facetvaluetranslation">FacetValueTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValueList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#facetvalue">FacetValue</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Which FacetValues are present in the products returned</div>
<div class="graphql-code-line top-level comment">by the search, and in what quantity.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValueResult</span>
{</div>
<div class="graphql-code-line ">facetValue: <a href="/reference/graphql-api/shop/object-types#facetvalue">FacetValue</a>!</div>
<div class="graphql-code-line ">count: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## FacetValueTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValueTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Float
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>Float</code> scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Float</span>
</div>
</div>
## FloatCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FloatCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">min: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
<div class="graphql-code-line ">max: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
<div class="graphql-code-line ">step: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## Fulfillment
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Fulfillment</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/shop/object-types#fulfillmentline">FulfillmentLine</a>!]!</div>
<div class="graphql-code-line ">summary: [<a href="/reference/graphql-api/shop/object-types#fulfillmentline">FulfillmentLine</a>!]!</div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">method: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">trackingCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## FulfillmentLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FulfillmentLine</span>
{</div>
<div class="graphql-code-line ">orderLine: <a href="/reference/graphql-api/shop/object-types#orderline">OrderLine</a>!</div>
<div class="graphql-code-line ">orderLineId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">fulfillment: <a href="/reference/graphql-api/shop/object-types#fulfillment">Fulfillment</a>!</div>
<div class="graphql-code-line ">fulfillmentId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## GuestCheckoutError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">GuestCheckoutError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">errorDetail: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntry
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">HistoryEntry</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/enums#historyentrytype">HistoryEntryType</a>!</div>
<div class="graphql-code-line ">data: <a href="/reference/graphql-api/shop/object-types#json">JSON</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## HistoryEntryList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">HistoryEntryList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#historyentry">HistoryEntry</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ID
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>ID</code> scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">ID</span>
</div>
</div>
## IdentifierChangeTokenExpiredError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the token used to change a Customer's email address is valid, but has</div>
<div class="graphql-code-line top-level comment">expired according to the <code>verificationTokenDuration</code> setting in the AuthOptions.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IdentifierChangeTokenExpiredError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## IdentifierChangeTokenInvalidError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the token used to change a Customer's email address is either</div>
<div class="graphql-code-line top-level comment">invalid or does not match any expected tokens.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IdentifierChangeTokenInvalidError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## IneligiblePaymentMethodError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to add a Payment using a PaymentMethod for which the Order is not eligible.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IneligiblePaymentMethodError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">eligibilityCheckerMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## IneligibleShippingMethodError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to set a ShippingMethod for which the Order is not eligible</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IneligibleShippingMethodError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## InsufficientStockError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to add more items to the Order than are available</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">InsufficientStockError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">quantityAvailable: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">order: <a href="/reference/graphql-api/shop/object-types#order">Order</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Int
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>Int</code> scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Int</span>
</div>
</div>
## IntCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IntCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">min: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line ">max: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line ">step: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## InvalidCredentialsError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the user authentication credentials are not valid</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">InvalidCredentialsError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">authenticationError: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## JSON
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>JSON</code> scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">JSON</span>
</div>
</div>
## LocaleStringCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">LocaleStringCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">length: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">pattern: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## LocaleTextCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">LocaleTextCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## LocalizedString
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">LocalizedString</span>
{</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## MissingPasswordError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to register or verify a customer account without a password, when one is required.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">MissingPasswordError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Money
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>Money</code> scalar type represents monetary values and supports signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Money</span>
</div>
</div>
## NativeAuthStrategyError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NativeAuthStrategyError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NativeAuthenticationResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">NativeAuthenticationResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#currentuser">CurrentUser</a> | <a href="/reference/graphql-api/shop/object-types#invalidcredentialserror">InvalidCredentialsError</a> | <a href="/reference/graphql-api/shop/object-types#notverifiederror">NotVerifiedError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
</div>
## NegativeQuantityError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to set a negative OrderLine quantity.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NegativeQuantityError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NoActiveOrderError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when invoking a mutation which depends on there being an active Order on the</div>
<div class="graphql-code-line top-level comment">current session.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NoActiveOrderError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## NotVerifiedError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if <code>authOptions.requireVerification</code> is set to <code>true</code> (which is the default)</div>
<div class="graphql-code-line top-level comment">and an unverified user attempts to authenticate.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NotVerifiedError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Order
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Order</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/enums#ordertype">OrderType</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The date & time that the Order was placed, i.e. the Customer</div>
<div class="graphql-code-line comment">completed the checkout and the Order is no longer "active"</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">orderPlacedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">A unique code for the Order</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">An order is active as long as the payment process has not been completed</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">active: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">customer: <a href="/reference/graphql-api/shop/object-types#customer">Customer</a></div>
<div class="graphql-code-line ">shippingAddress: <a href="/reference/graphql-api/shop/object-types#orderaddress">OrderAddress</a></div>
<div class="graphql-code-line ">billingAddress: <a href="/reference/graphql-api/shop/object-types#orderaddress">OrderAddress</a></div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/shop/object-types#orderline">OrderLine</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Surcharges are arbitrary modifications to the Order total which are neither</div>
<div class="graphql-code-line comment">ProductVariants nor discounts resulting from applied Promotions. For example,</div>
<div class="graphql-code-line comment">one-off discounts based on customer interaction, or surcharges based on payment</div>
<div class="graphql-code-line comment">methods.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">surcharges: [<a href="/reference/graphql-api/shop/object-types#surcharge">Surcharge</a>!]!</div>
<div class="graphql-code-line ">discounts: [<a href="/reference/graphql-api/shop/object-types#discount">Discount</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">An array of all coupon codes applied to the Order</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">couponCodes: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Promotions applied to the order. Only gets populated after the payment process has completed.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">promotions: [<a href="/reference/graphql-api/shop/object-types#promotion">Promotion</a>!]!</div>
<div class="graphql-code-line ">payments: [<a href="/reference/graphql-api/shop/object-types#payment">Payment</a>!]</div>
<div class="graphql-code-line ">fulfillments: [<a href="/reference/graphql-api/shop/object-types#fulfillment">Fulfillment</a>!]</div>
<div class="graphql-code-line ">totalQuantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level</div>
<div class="graphql-code-line comment">discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.</div>
<div class="graphql-code-line comment">To get a total of all OrderLines which does not account for prorated discounts, use the</div>
<div class="graphql-code-line comment">sum of <code>OrderLine.discountedLinePrice</code> values.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">subTotal: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Same as subTotal, but inclusive of tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">subTotalWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">shippingLines: [<a href="/reference/graphql-api/shop/object-types#shippingline">ShippingLine</a>!]!</div>
<div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">shippingWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Equal to subTotal plus shipping</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">total: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The final payable amount. Equal to subTotalWithTax plus shippingWithTax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">totalWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">A summary of the taxes being applied to this Order</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">taxSummary: [<a href="/reference/graphql-api/shop/object-types#ordertaxsummary">OrderTaxSummary</a>!]!</div>
<div class="graphql-code-line ">history(options: <a href="/reference/graphql-api/shop/input-types#historyentrylistoptions">HistoryEntryListOptions</a>): <a href="/reference/graphql-api/shop/object-types#historyentrylist">HistoryEntryList</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderAddress
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderAddress</span>
{</div>
<div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">company: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">city: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">province: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">country: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">countryCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderLimitError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when the maximum order size limit has been reached.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderLimitError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">maxItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderLine</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">productVariant: <a href="/reference/graphql-api/shop/object-types#productvariant">ProductVariant</a>!</div>
<div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/shop/object-types#asset">Asset</a></div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of a single unit, excluding tax and discounts</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">unitPrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of a single unit, including tax but excluding discounts</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">unitPriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Non-zero if the unitPrice has changed since it was initially added to Order</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">unitPriceChangeSinceAdded: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Non-zero if the unitPriceWithTax has changed since it was initially added to Order</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">unitPriceWithTaxChangeSinceAdded: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of a single unit including discounts, excluding tax.</div>
<div class="graphql-code-line comment"></div>
<div class="graphql-code-line comment">If Order-level discounts have been applied, this will not be the</div>
<div class="graphql-code-line comment">actual taxable unit price (see `proratedUnitPrice`), but is generally the</div>
<div class="graphql-code-line comment">correct price to display to customers to avoid confusion</div>
<div class="graphql-code-line comment">about the internal handling of distributed Order-level discounts.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">discountedUnitPrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of a single unit including discounts and tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">discountedUnitPriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)</div>
<div class="graphql-code-line comment">Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax</div>
<div class="graphql-code-line comment">and refund calculations.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">proratedUnitPrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The proratedUnitPrice including tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">proratedUnitPriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The quantity of items purchased</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The quantity at the time the Order was placed</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">orderPlacedQuantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The total price of the line excluding tax and discounts.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">linePrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The total price of the line including tax but excluding discounts.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">linePriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of the line including discounts, excluding tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">discountedLinePrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of the line including discounts and tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">discountedLinePriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)</div>
<div class="graphql-code-line comment">Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax</div>
<div class="graphql-code-line comment">and refund calculations.</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">proratedLinePrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The proratedLinePrice including tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">proratedLinePriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The total tax on this line</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">lineTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">discounts: [<a href="/reference/graphql-api/shop/object-types#discount">Discount</a>!]!</div>
<div class="graphql-code-line ">taxLines: [<a href="/reference/graphql-api/shop/object-types#taxline">TaxLine</a>!]!</div>
<div class="graphql-code-line ">order: <a href="/reference/graphql-api/shop/object-types#order">Order</a>!</div>
<div class="graphql-code-line ">fulfillmentLines: [<a href="/reference/graphql-api/shop/object-types#fulfillmentline">FulfillmentLine</a>!]</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#order">Order</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderModificationError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to modify the contents of an Order that is not in the <code>AddingItems</code> state.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderModificationError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderPaymentStateError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to add a Payment to an Order that is not in the <code>ArrangingPayment</code> state.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderPaymentStateError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderStateTransitionError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if there is an error in transitioning the Order state</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderStateTransitionError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">transitionError: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">fromState: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">toState: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## OrderTaxSummary
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">A summary of the taxes being applied to this order, grouped</div>
<div class="graphql-code-line top-level comment">by taxRate.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderTaxSummary</span>
{</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">A description of this tax</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The taxRate as a percentage</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The total net price of OrderLines to which this taxRate applies</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">taxBase: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The total tax being applied to the Order at this taxRate</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">taxTotal: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PasswordAlreadySetError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to verify a customer account with a password, when a password has already been set.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PasswordAlreadySetError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PasswordResetTokenExpiredError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the token used to reset a Customer's password is valid, but has</div>
<div class="graphql-code-line top-level comment">expired according to the <code>verificationTokenDuration</code> setting in the AuthOptions.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PasswordResetTokenExpiredError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PasswordResetTokenInvalidError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the token used to reset a Customer's password is either</div>
<div class="graphql-code-line top-level comment">invalid or does not match any expected tokens.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PasswordResetTokenInvalidError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PasswordValidationError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when attempting to register or verify a customer account where the given password fails password validation.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PasswordValidationError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">validationErrorMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Payment
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Payment</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">method: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">amount: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">transactionId: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">errorMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">refunds: [<a href="/reference/graphql-api/shop/object-types#refund">Refund</a>!]!</div>
<div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentDeclinedError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when a Payment is declined by the payment provider.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentDeclinedError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">paymentErrorMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentFailedError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned when a Payment fails due to an error.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentFailedError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">paymentErrorMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentMethod</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">checker: <a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a></div>
<div class="graphql-code-line ">handler: <a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#paymentmethodtranslation">PaymentMethodTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethodQuote
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentMethodQuote</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">isEligible: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">eligibilityMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PaymentMethodTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentMethodTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PriceRange
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The price range where the result has more than one price</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PriceRange</span>
{</div>
<div class="graphql-code-line ">min: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">max: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Product
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Product</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/shop/object-types#asset">Asset</a></div>
<div class="graphql-code-line ">assets: [<a href="/reference/graphql-api/shop/object-types#asset">Asset</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Returns all ProductVariants</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">variants: [<a href="/reference/graphql-api/shop/object-types#productvariant">ProductVariant</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Returns a paginated, sortable, filterable list of ProductVariants</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">variantList(options: <a href="/reference/graphql-api/shop/input-types#productvariantlistoptions">ProductVariantListOptions</a>): <a href="/reference/graphql-api/shop/object-types#productvariantlist">ProductVariantList</a>!</div>
<div class="graphql-code-line ">optionGroups: [<a href="/reference/graphql-api/shop/object-types#productoptiongroup">ProductOptionGroup</a>!]!</div>
<div class="graphql-code-line ">facetValues: [<a href="/reference/graphql-api/shop/object-types#facetvalue">FacetValue</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#producttranslation">ProductTranslation</a>!]!</div>
<div class="graphql-code-line ">collections: [<a href="/reference/graphql-api/shop/object-types#collection">Collection</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#product">Product</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductOption
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOption</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">groupId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">group: <a href="/reference/graphql-api/shop/object-types#productoptiongroup">ProductOptionGroup</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#productoptiontranslation">ProductOptionTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductOptionGroup
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOptionGroup</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">options: [<a href="/reference/graphql-api/shop/object-types#productoption">ProductOption</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#productoptiongrouptranslation">ProductOptionGroupTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductOptionGroupTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOptionGroupTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductOptionTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOptionTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariant
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductVariant</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">product: <a href="/reference/graphql-api/shop/object-types#product">Product</a>!</div>
<div class="graphql-code-line ">productId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/shop/object-types#asset">Asset</a></div>
<div class="graphql-code-line ">assets: [<a href="/reference/graphql-api/shop/object-types#asset">Asset</a>!]!</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">stockLevel: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">taxRateApplied: <a href="/reference/graphql-api/shop/object-types#taxrate">TaxRate</a>!</div>
<div class="graphql-code-line ">taxCategory: <a href="/reference/graphql-api/shop/object-types#taxcategory">TaxCategory</a>!</div>
<div class="graphql-code-line ">options: [<a href="/reference/graphql-api/shop/object-types#productoption">ProductOption</a>!]!</div>
<div class="graphql-code-line ">facetValues: [<a href="/reference/graphql-api/shop/object-types#facetvalue">FacetValue</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#productvarianttranslation">ProductVariantTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductVariantList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#productvariant">ProductVariant</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProductVariantTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductVariantTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Promotion
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Promotion</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">startsAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">endsAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">perCustomerUsageLimit: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line ">usageLimit: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">conditions: [<a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!]!</div>
<div class="graphql-code-line ">actions: [<a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!]!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#promotiontranslation">PromotionTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## PromotionList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PromotionList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#promotion">Promotion</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## PromotionTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PromotionTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Province
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Province</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">parent: <a href="/reference/graphql-api/shop/object-types#region">Region</a></div>
<div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/shop/object-types#id">ID</a></div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#regiontranslation">RegionTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ProvinceList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProvinceList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#province">Province</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RefreshCustomerVerificationResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RefreshCustomerVerificationResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
</div>
## Refund
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Refund</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">items: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">adjustment: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">total: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">method: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">transactionId: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">reason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/shop/object-types#refundline">RefundLine</a>!]!</div>
<div class="graphql-code-line ">paymentId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## RefundLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RefundLine</span>
{</div>
<div class="graphql-code-line ">orderLine: <a href="/reference/graphql-api/shop/object-types#orderline">OrderLine</a>!</div>
<div class="graphql-code-line ">orderLineId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">refund: <a href="/reference/graphql-api/shop/object-types#refund">Refund</a>!</div>
<div class="graphql-code-line ">refundId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RegionTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RegionTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RegisterCustomerAccountResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RegisterCustomerAccountResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#missingpassworderror">MissingPasswordError</a> | <a href="/reference/graphql-api/shop/object-types#passwordvalidationerror">PasswordValidationError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
</div>
## RelationCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RelationCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">entity: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">scalarFields: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]!</div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## RemoveOrderItemsResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RemoveOrderItemsResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#ordermodificationerror">OrderModificationError</a></div>
</div>
## RequestPasswordResetResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RequestPasswordResetResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
</div>
## RequestUpdateCustomerEmailAddressResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RequestUpdateCustomerEmailAddressResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#invalidcredentialserror">InvalidCredentialsError</a> | <a href="/reference/graphql-api/shop/object-types#emailaddressconflicterror">EmailAddressConflictError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
</div>
## ResetPasswordResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">ResetPasswordResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#currentuser">CurrentUser</a> | <a href="/reference/graphql-api/shop/object-types#passwordresettokeninvaliderror">PasswordResetTokenInvalidError</a> | <a href="/reference/graphql-api/shop/object-types#passwordresettokenexpirederror">PasswordResetTokenExpiredError</a> | <a href="/reference/graphql-api/shop/object-types#passwordvalidationerror">PasswordValidationError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a> | <a href="/reference/graphql-api/shop/object-types#notverifiederror">NotVerifiedError</a></div>
</div>
## Role
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Role</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">permissions: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]!</div>
<div class="graphql-code-line ">channels: [<a href="/reference/graphql-api/shop/object-types#channel">Channel</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## RoleList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RoleList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#role">Role</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchReindexResponse
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchReindexResponse</span>
{</div>
<div class="graphql-code-line ">success: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchResponse
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchResponse</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#searchresult">SearchResult</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line ">facetValues: [<a href="/reference/graphql-api/shop/object-types#facetvalueresult">FacetValueResult</a>!]!</div>
<div class="graphql-code-line ">collections: [<a href="/reference/graphql-api/shop/object-types#collectionresult">CollectionResult</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchResult</span>
{</div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">productId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">productName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">productAsset: <a href="/reference/graphql-api/shop/object-types#searchresultasset">SearchResultAsset</a></div>
<div class="graphql-code-line ">productVariantId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">productVariantName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">productVariantAsset: <a href="/reference/graphql-api/shop/object-types#searchresultasset">SearchResultAsset</a></div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/object-types#searchresultprice">SearchResultPrice</a>!</div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/object-types#searchresultprice">SearchResultPrice</a>!</div>
<div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">facetIds: [<a href="/reference/graphql-api/shop/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line ">facetValueIds: [<a href="/reference/graphql-api/shop/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">An array of ids of the Collections in which this result appears</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">collectionIds: [<a href="/reference/graphql-api/shop/object-types#id">ID</a>!]!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">A relevance score for the result. Differs between database implementations</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">score: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchResultAsset
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchResultAsset</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">preview: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">focalPoint: <a href="/reference/graphql-api/shop/object-types#coordinate">Coordinate</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SearchResultPrice
<div class="graphql-code-block">
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">The price of a search result product, either as a range or as a single price</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">SearchResultPrice</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#pricerange">PriceRange</a> | <a href="/reference/graphql-api/shop/object-types#singleprice">SinglePrice</a></div>
</div>
## Seller
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Seller</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## SetCustomerForOrderResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">SetCustomerForOrderResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#alreadyloggedinerror">AlreadyLoggedInError</a> | <a href="/reference/graphql-api/shop/object-types#emailaddressconflicterror">EmailAddressConflictError</a> | <a href="/reference/graphql-api/shop/object-types#noactiveordererror">NoActiveOrderError</a> | <a href="/reference/graphql-api/shop/object-types#guestcheckouterror">GuestCheckoutError</a></div>
</div>
## SetOrderShippingMethodResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">SetOrderShippingMethodResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#ordermodificationerror">OrderModificationError</a> | <a href="/reference/graphql-api/shop/object-types#ineligibleshippingmethoderror">IneligibleShippingMethodError</a> | <a href="/reference/graphql-api/shop/object-types#noactiveordererror">NoActiveOrderError</a></div>
</div>
## ShippingLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingLine</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">shippingMethod: <a href="/reference/graphql-api/shop/object-types#shippingmethod">ShippingMethod</a>!</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">discountedPrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">discountedPriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">discounts: [<a href="/reference/graphql-api/shop/object-types#discount">Discount</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethod
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethod</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">fulfillmentHandlerCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">checker: <a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!</div>
<div class="graphql-code-line ">calculator: <a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!</div>
<div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#shippingmethodtranslation">ShippingMethodTranslation</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethodList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethodList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#shippingmethod">ShippingMethod</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethodQuote
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethodQuote</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line comment">Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult</div>
<div class="graphql-code-line comment">"""</div>
<div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## ShippingMethodTranslation
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethodTranslation</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## SinglePrice
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The price value where the result has a single price</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SinglePrice</span>
{</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## String
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>String</code> scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">String</span>
</div>
</div>
## StringCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StringCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">length: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">pattern: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">options: [<a href="/reference/graphql-api/shop/object-types#stringfieldoption">StringFieldOption</a>!]</div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## StringFieldOption
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StringFieldOption</span>
{</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Success
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Indicates that an operation succeeded, where we do not want to return any more specific information.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Success</span>
{</div>
<div class="graphql-code-line ">success: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Surcharge
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Surcharge</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">sku: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
<div class="graphql-code-line ">taxLines: [<a href="/reference/graphql-api/shop/object-types#taxline">TaxLine</a>!]!</div>
<div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
<div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## Tag
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Tag</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TagList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TagList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#tag">Tag</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxCategory
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxCategory</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">isDefault: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxLine
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxLine</span>
{</div>
<div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxRate
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxRate</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
<div class="graphql-code-line ">category: <a href="/reference/graphql-api/shop/object-types#taxcategory">TaxCategory</a>!</div>
<div class="graphql-code-line ">zone: <a href="/reference/graphql-api/shop/object-types#zone">Zone</a>!</div>
<div class="graphql-code-line ">customerGroup: <a href="/reference/graphql-api/shop/object-types#customergroup">CustomerGroup</a></div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TaxRateList
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxRateList</span>
{</div>
<div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#taxrate">TaxRate</a>!]!</div>
<div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## TextCustomFieldConfig
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TextCustomFieldConfig</span>
{</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
<div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
<div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
<div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## TransitionOrderToStateResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">TransitionOrderToStateResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#orderstatetransitionerror">OrderStateTransitionError</a></div>
</div>
## UpdateCustomerEmailAddressResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdateCustomerEmailAddressResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#identifierchangetokeninvaliderror">IdentifierChangeTokenInvalidError</a> | <a href="/reference/graphql-api/shop/object-types#identifierchangetokenexpirederror">IdentifierChangeTokenExpiredError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
</div>
## UpdateCustomerPasswordResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdateCustomerPasswordResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#invalidcredentialserror">InvalidCredentialsError</a> | <a href="/reference/graphql-api/shop/object-types#passwordvalidationerror">PasswordValidationError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
</div>
## UpdateOrderItemsResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdateOrderItemsResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#ordermodificationerror">OrderModificationError</a> | <a href="/reference/graphql-api/shop/object-types#orderlimiterror">OrderLimitError</a> | <a href="/reference/graphql-api/shop/object-types#negativequantityerror">NegativeQuantityError</a> | <a href="/reference/graphql-api/shop/object-types#insufficientstockerror">InsufficientStockError</a></div>
</div>
## Upload
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The <code>Upload</code> scalar type represents a file upload.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Upload</span>
</div>
</div>
## User
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">User</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">identifier: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">verified: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
<div class="graphql-code-line ">roles: [<a href="/reference/graphql-api/shop/object-types#role">Role</a>!]!</div>
<div class="graphql-code-line ">lastLogin: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
<div class="graphql-code-line ">authenticationMethods: [<a href="/reference/graphql-api/shop/object-types#authenticationmethod">AuthenticationMethod</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## VerificationTokenExpiredError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the verification token (used to verify a Customer's email address) is valid, but has</div>
<div class="graphql-code-line top-level comment">expired according to the <code>verificationTokenDuration</code> setting in the AuthOptions.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">VerificationTokenExpiredError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## VerificationTokenInvalidError
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returned if the verification token (used to verify a Customer's email address) is either</div>
<div class="graphql-code-line top-level comment">invalid or does not match any expected tokens.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">VerificationTokenInvalidError</span>
{</div>
<div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
<div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## VerifyCustomerAccountResult
<div class="graphql-code-block">
<div class="graphql-code-line top-level">union <span class="graphql-code-identifier">VerifyCustomerAccountResult</span>
=</div>
<div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#currentuser">CurrentUser</a> | <a href="/reference/graphql-api/shop/object-types#verificationtokeninvaliderror">VerificationTokenInvalidError</a> | <a href="/reference/graphql-api/shop/object-types#verificationtokenexpirederror">VerificationTokenExpiredError</a> | <a href="/reference/graphql-api/shop/object-types#missingpassworderror">MissingPasswordError</a> | <a href="/reference/graphql-api/shop/object-types#passwordvalidationerror">PasswordValidationError</a> | <a href="/reference/graphql-api/shop/object-types#passwordalreadyseterror">PasswordAlreadySetError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
</div>
## Zone
<div class="graphql-code-block">
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Zone</span>
{</div>
<div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
<div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
<div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
<div class="graphql-code-line ">members: [<a href="/reference/graphql-api/shop/object-types#region">Region</a>!]!</div>
<div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
|
---
title: "Queries"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## activeChannel
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The active Channel</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">activeChannel: <a href="/reference/graphql-api/shop/object-types#channel">Channel</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## activeCustomer
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The active Customer</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">activeCustomer: <a href="/reference/graphql-api/shop/object-types#customer">Customer</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## activeOrder
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">The active Order. Will be <code>null</code> until an Order is created via `addItemToOrder`. Once an Order reaches the</div>
<div class="graphql-code-line top-level comment">state of <code>PaymentAuthorized</code> or `PaymentSettled`, then that Order is no longer considered "active" and this</div>
<div class="graphql-code-line top-level comment">query will once again return `null`.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">activeOrder: <a href="/reference/graphql-api/shop/object-types#order">Order</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## availableCountries
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">An array of supported Countries</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">availableCountries: [<a href="/reference/graphql-api/shop/object-types#country">Country</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## collection
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returns a Collection either by its id or slug. If neither 'id' nor 'slug' is specified, an error will result.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">collection(id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>, slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>): <a href="/reference/graphql-api/shop/object-types#collection">Collection</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## collections
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">A list of Collections available to the shop</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">collections(options: <a href="/reference/graphql-api/shop/input-types#collectionlistoptions">CollectionListOptions</a>): <a href="/reference/graphql-api/shop/object-types#collectionlist">CollectionList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## eligiblePaymentMethods
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returns a list of payment methods and their eligibility based on the current active Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">eligiblePaymentMethods: [<a href="/reference/graphql-api/shop/object-types#paymentmethodquote">PaymentMethodQuote</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## eligibleShippingMethods
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returns a list of eligible shipping methods based on the current active Order</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">eligibleShippingMethods: [<a href="/reference/graphql-api/shop/object-types#shippingmethodquote">ShippingMethodQuote</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## facet
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returns a Facet by its id</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">facet(id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!): <a href="/reference/graphql-api/shop/object-types#facet">Facet</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## facets
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">A list of Facets available to the shop</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">facets(options: <a href="/reference/graphql-api/shop/input-types#facetlistoptions">FacetListOptions</a>): <a href="/reference/graphql-api/shop/object-types#facetlist">FacetList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## me
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returns information about the current authenticated User</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">me: <a href="/reference/graphql-api/shop/object-types#currentuser">CurrentUser</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## nextOrderStates
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returns the possible next states that the activeOrder can transition to</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">nextOrderStates: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## order
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returns an Order based on the id. Note that in the Shop API, only orders belonging to the</div>
<div class="graphql-code-line top-level comment">currently-authenticated User may be queried.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">order(id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!): <a href="/reference/graphql-api/shop/object-types#order">Order</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## orderByCode
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Returns an Order based on the order `code`. For guest Orders (i.e. Orders placed by non-authenticated Customers)</div>
<div class="graphql-code-line top-level comment">this query will only return the Order within 2 hours of the Order being placed. This allows an Order confirmation</div>
<div class="graphql-code-line top-level comment">screen to be shown immediately after completion of a guest checkout, yet prevents security risks of allowing</div>
<div class="graphql-code-line top-level comment">general anonymous access to Order data.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">orderByCode(code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!): <a href="/reference/graphql-api/shop/object-types#order">Order</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## product
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Get a Product either by id or slug. If neither 'id' nor 'slug' is specified, an error will result.</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">product(id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>, slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>): <a href="/reference/graphql-api/shop/object-types#product">Product</a></div>
<div class="graphql-code-line top-level">}</div>
</div>
## products
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Get a list of Products</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">products(options: <a href="/reference/graphql-api/shop/input-types#productlistoptions">ProductListOptions</a>): <a href="/reference/graphql-api/shop/object-types#productlist">ProductList</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
## search
<div class="graphql-code-block">
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level comment">Search Products based on the criteria set by the `SearchInput`</div>
<div class="graphql-code-line top-level comment">"""</div>
<div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span>
{</div>
<div class="graphql-code-line ">search(input: <a href="/reference/graphql-api/shop/input-types#searchinput">SearchInput</a>!): <a href="/reference/graphql-api/shop/object-types#searchresponse">SearchResponse</a>!</div>
<div class="graphql-code-line top-level">}</div>
</div>
|
---
title: "TypeScript API"
weight: 9
showtoc: false
---
# Vendure TypeScript API Docs
The Vendure TypeScript API is used when configuring the server (via the [`VendureConfig`]({{< ref "configuration" >}}#vendureconfig) object) and when writing plugins that extend the functionality of Vendure core.
{{% alert %}}
All documentation in this section is auto-generated from the TypeScript source of the Vendure server.
{{< /alert >}}
|
---
title: "Assets"
weight: 10
date: 2023-07-14T16:57:49.465Z
showtoc: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
# assets |
---
title: "AssetNamingStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AssetNamingStrategy
<GenerationInfo sourceFile="packages/core/src/config/asset-naming-strategy/asset-naming-strategy.ts" sourceLine="18" packageName="@vendure/core" />
The AssetNamingStrategy determines how file names are generated based on the uploaded source file name,
as well as how to handle naming conflicts.
:::info
This is configured via the `assetOptions.assetNamingStrategy` property of
your VendureConfig.
:::
```ts title="Signature"
interface AssetNamingStrategy extends InjectableStrategy {
generateSourceFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string): string;
generatePreviewFileName(ctx: RequestContext, sourceFileName: string, conflictFileName?: string): string;
}
```
* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
<div className="members-wrapper">
### generateSourceFileName
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, originalFileName: string, conflictFileName?: string) => string`} />
Given the original file name of the uploaded file, generate a file name to
be stored on the server. Operations like normalization and time-stamping can
be performed in this method.
The output will be checked for a naming conflict with an existing file. If a conflict
exists, this method will be invoked again with the second argument passed in and a new, unique
file name should then be generated. This process will repeat until a unique file name has
been returned.
### generatePreviewFileName
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, sourceFileName: string, conflictFileName?: string) => string`} />
Given the source file name generated in the `generateSourceFileName` method, this method
should generate the file name of the preview image.
The same mechanism of checking for conflicts is used as described above.
</div>
|
---
title: "AssetOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AssetOptions
<GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="627" packageName="@vendure/core" />
The AssetOptions define how assets (images and other files) are named and stored, and how preview images are generated.
**Note**: If you are using the `AssetServerPlugin`, it is not necessary to configure these options.
```ts title="Signature"
interface AssetOptions {
assetNamingStrategy?: AssetNamingStrategy;
assetStorageStrategy?: AssetStorageStrategy;
assetPreviewStrategy?: AssetPreviewStrategy;
permittedFileTypes?: string[];
uploadMaxFileSize?: number;
}
```
<div className="members-wrapper">
### assetNamingStrategy
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-naming-strategy#assetnamingstrategy'>AssetNamingStrategy</a>`} default="<a href='/reference/typescript-api/assets/default-asset-naming-strategy#defaultassetnamingstrategy'>DefaultAssetNamingStrategy</a>" />
Defines how asset files and preview images are named before being saved.
### assetStorageStrategy
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-storage-strategy#assetstoragestrategy'>AssetStorageStrategy</a>`} default="NoAssetStorageStrategy" />
Defines the strategy used for storing uploaded binary files.
### assetPreviewStrategy
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/assets/asset-preview-strategy#assetpreviewstrategy'>AssetPreviewStrategy</a>`} default="NoAssetPreviewStrategy" />
Defines the strategy used for creating preview images of uploaded assets.
### permittedFileTypes
<MemberInfo kind="property" type={`string[]`} default="image, audio, video MIME types plus PDFs" />
An array of the permitted file types that may be uploaded as Assets. Each entry
should be in the form of a valid
[unique file type specifier](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#Unique_file_type_specifiers)
i.e. either a file extension (".pdf") or a mime type ("image/*", "audio/mpeg" etc.).
### uploadMaxFileSize
<MemberInfo kind="property" type={`number`} default="20971520" />
The max file size in bytes for uploaded assets.
</div>
|
---
title: "AssetPreviewStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AssetPreviewStrategy
<GenerationInfo sourceFile="packages/core/src/config/asset-preview-strategy/asset-preview-strategy.ts" sourceLine="25" packageName="@vendure/core" />
The AssetPreviewStrategy determines how preview images for assets are created. For image
assets, this would usually typically involve resizing to sensible dimensions. Other file types
could be previewed in a variety of ways, e.g.:
- waveform images generated for audio files
- preview images generated for pdf documents
- watermarks added to preview images
:::info
This is configured via the `assetOptions.assetPreviewStrategy` property of
your VendureConfig.
:::
```ts title="Signature"
interface AssetPreviewStrategy extends InjectableStrategy {
generatePreviewImage(ctx: RequestContext, mimeType: string, data: Buffer): Promise<Buffer>;
}
```
* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
<div className="members-wrapper">
### generatePreviewImage
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, mimeType: string, data: Buffer) => Promise<Buffer>`} />
</div>
|
---
title: "AssetStorageStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AssetStorageStrategy
<GenerationInfo sourceFile="packages/core/src/config/asset-storage-strategy/asset-storage-strategy.ts" sourceLine="20" packageName="@vendure/core" />
The AssetPersistenceStrategy determines how Asset files are physically stored
and retrieved.
:::info
This is configured via the `assetOptions.assetStorageStrategy` property of
your VendureConfig.
:::
```ts title="Signature"
interface AssetStorageStrategy extends InjectableStrategy {
writeFileFromBuffer(fileName: string, data: Buffer): Promise<string>;
writeFileFromStream(fileName: string, data: Stream): Promise<string>;
readFileToBuffer(identifier: string): Promise<Buffer>;
readFileToStream(identifier: string): Promise<Stream>;
deleteFile(identifier: string): Promise<void>;
fileExists(fileName: string): Promise<boolean>;
toAbsoluteUrl?(request: Request, identifier: string): string;
}
```
* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
<div className="members-wrapper">
### writeFileFromBuffer
<MemberInfo kind="method" type={`(fileName: string, data: Buffer) => Promise<string>`} />
Writes a buffer to the store and returns a unique identifier for that
file such as a file path or a URL.
### writeFileFromStream
<MemberInfo kind="method" type={`(fileName: string, data: Stream) => Promise<string>`} />
Writes a readable stream to the store and returns a unique identifier for that
file such as a file path or a URL.
### readFileToBuffer
<MemberInfo kind="method" type={`(identifier: string) => Promise<Buffer>`} />
Reads a file based on an identifier which was generated by the writeFile
method, and returns the as a Buffer.
### readFileToStream
<MemberInfo kind="method" type={`(identifier: string) => Promise<Stream>`} />
Reads a file based on an identifier which was generated by the writeFile
method, and returns the file as a Stream.
### deleteFile
<MemberInfo kind="method" type={`(identifier: string) => Promise<void>`} />
Deletes a file from the storage.
### fileExists
<MemberInfo kind="method" type={`(fileName: string) => Promise<boolean>`} />
Check whether a file with the given name already exists. Used to avoid
naming conflicts before saving the file.
### toAbsoluteUrl
<MemberInfo kind="method" type={`(request: Request, identifier: string) => string`} />
Convert an identifier as generated by the writeFile... methods into an absolute
url (if it is not already in that form). If no conversion step is needed
(i.e. the identifier is already an absolute url) then this method
should not be implemented.
</div>
|
---
title: "DefaultAssetNamingStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## DefaultAssetNamingStrategy
<GenerationInfo sourceFile="packages/core/src/config/asset-naming-strategy/default-asset-naming-strategy.ts" sourceLine="15" packageName="@vendure/core" />
The default strategy normalizes the file names to remove unwanted characters and
in the case of conflicts, increments a counter suffix.
```ts title="Signature"
class DefaultAssetNamingStrategy implements AssetNamingStrategy {
generateSourceFileName(ctx: RequestContext, originalFileName: string, conflictFileName?: string) => string;
generatePreviewFileName(ctx: RequestContext, sourceFileName: string, conflictFileName?: string) => string;
}
```
* Implements: <code><a href='/reference/typescript-api/assets/asset-naming-strategy#assetnamingstrategy'>AssetNamingStrategy</a></code>
<div className="members-wrapper">
### generateSourceFileName
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, originalFileName: string, conflictFileName?: string) => string`} />
### generatePreviewFileName
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, sourceFileName: string, conflictFileName?: string) => string`} />
</div>
|
---
title: "Assets"
isDefaultIndex: true
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
import DocCardList from '@theme/DocCardList';
<DocCardList /> |
---
title: "Auth"
weight: 10
date: 2023-07-14T16:57:49.450Z
showtoc: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import DocCardList from '@theme/DocCardList';
<DocCardList />
|
---
title: "AuthOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AuthOptions
<GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="329" packageName="@vendure/core" />
The AuthOptions define how authentication and authorization is managed.
```ts title="Signature"
interface AuthOptions {
disableAuth?: boolean;
tokenMethod?: 'cookie' | 'bearer' | ReadonlyArray<'cookie' | 'bearer'>;
cookieOptions?: CookieOptions;
authTokenHeaderKey?: string;
sessionDuration?: string | number;
sessionCacheStrategy?: SessionCacheStrategy;
sessionCacheTTL?: number;
requireVerification?: boolean;
verificationTokenDuration?: string | number;
superadminCredentials?: SuperadminCredentials;
shopAuthenticationStrategy?: AuthenticationStrategy[];
adminAuthenticationStrategy?: AuthenticationStrategy[];
customPermissions?: PermissionDefinition[];
passwordHashingStrategy?: PasswordHashingStrategy;
passwordValidationStrategy?: PasswordValidationStrategy;
}
```
<div className="members-wrapper">
### disableAuth
<MemberInfo kind="property" type={`boolean`} default="false" />
Disable authentication & permissions checks.
NEVER set the to true in production. It exists
only to aid certain development tasks.
### tokenMethod
<MemberInfo kind="property" type={`'cookie' | 'bearer' | ReadonlyArray<'cookie' | 'bearer'>`} default="'cookie'" />
Sets the method by which the session token is delivered and read.
* 'cookie': Upon login, a 'Set-Cookie' header will be returned to the client, setting a
cookie containing the session token. A browser-based client (making requests with credentials)
should automatically send the session cookie with each request.
* 'bearer': Upon login, the token is returned in the response and should be then stored by the
client app. Each request should include the header `Authorization: Bearer <token>`.
Note that if the bearer method is used, Vendure will automatically expose the configured
`authTokenHeaderKey` in the server's CORS configuration (adding `Access-Control-Expose-Headers: vendure-auth-token`
by default).
From v1.2.0 it is possible to specify both methods as a tuple: `['cookie', 'bearer']`.
### cookieOptions
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/cookie-options#cookieoptions'>CookieOptions</a>`} />
Options related to the handling of cookies when using the 'cookie' tokenMethod.
### authTokenHeaderKey
<MemberInfo kind="property" type={`string`} default="'vendure-auth-token'" />
Sets the header property which will be used to send the auth token when using the 'bearer' method.
### sessionDuration
<MemberInfo kind="property" type={`string | number`} default="'1y'" />
Session duration, i.e. the time which must elapse from the last authenticated request
after which the user must re-authenticate.
Expressed as a string describing a time span per
[zeit/ms](https://github.com/zeit/ms.js). Eg: `60`, `'2 days'`, `'10h'`, `'7d'`
### sessionCacheStrategy
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy'>SessionCacheStrategy</a>`} default="<a href='/reference/typescript-api/auth/in-memory-session-cache-strategy#inmemorysessioncachestrategy'>InMemorySessionCacheStrategy</a>" />
This strategy defines how sessions will be cached. By default, sessions are cached using a simple
in-memory caching strategy which is suitable for development and low-traffic, single-instance
deployments.
### sessionCacheTTL
<MemberInfo kind="property" type={`number`} default="300" />
The "time to live" of a given item in the session cache. This determines the length of time (in seconds)
that a cache entry is kept before being considered "stale" and being replaced with fresh data
taken from the database.
### requireVerification
<MemberInfo kind="property" type={`boolean`} default="true" />
Determines whether new User accounts require verification of their email address.
If set to "true", when registering via the `registerCustomerAccount` mutation, one should *not* set the
`password` property - doing so will result in an error. Instead, the password is set at a later stage
(once the email with the verification token has been opened) via the `verifyCustomerAccount` mutation.
### verificationTokenDuration
<MemberInfo kind="property" type={`string | number`} default="'7d'" />
Sets the length of time that a verification token is valid for, after which the verification token must be refreshed.
Expressed as a string describing a time span per
[zeit/ms](https://github.com/zeit/ms.js). Eg: `60`, `'2 days'`, `'10h'`, `'7d'`
### superadminCredentials
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/superadmin-credentials#superadmincredentials'>SuperadminCredentials</a>`} />
Configures the credentials to be used to create a superadmin
### shopAuthenticationStrategy
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/authentication-strategy#authenticationstrategy'>AuthenticationStrategy</a>[]`} default="<a href='/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy'>NativeAuthenticationStrategy</a>" />
Configures one or more AuthenticationStrategies which defines how authentication
is handled in the Shop API.
### adminAuthenticationStrategy
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/authentication-strategy#authenticationstrategy'>AuthenticationStrategy</a>[]`} default="<a href='/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy'>NativeAuthenticationStrategy</a>" />
Configures one or more AuthenticationStrategy which defines how authentication
is handled in the Admin API.
### customPermissions
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/permission-definition#permissiondefinition'>PermissionDefinition</a>[]`} default="[]" />
Allows custom Permissions to be defined, which can be used to restrict access to custom
GraphQL resolvers defined in plugins.
### passwordHashingStrategy
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/password-hashing-strategy#passwordhashingstrategy'>PasswordHashingStrategy</a>`} default="<a href='/reference/typescript-api/auth/bcrypt-password-hashing-strategy#bcryptpasswordhashingstrategy'>BcryptPasswordHashingStrategy</a>" since="1.3.0" />
Allows you to customize the way passwords are hashed when using the <a href='/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy'>NativeAuthenticationStrategy</a>.
### passwordValidationStrategy
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/password-validation-strategy#passwordvalidationstrategy'>PasswordValidationStrategy</a>`} default="<a href='/reference/typescript-api/auth/default-password-validation-strategy#defaultpasswordvalidationstrategy'>DefaultPasswordValidationStrategy</a>" since="1.5.0" />
Allows you to set a custom policy for passwords when using the <a href='/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy'>NativeAuthenticationStrategy</a>.
By default, it uses the <a href='/reference/typescript-api/auth/default-password-validation-strategy#defaultpasswordvalidationstrategy'>DefaultPasswordValidationStrategy</a>, which will impose a minimum length
of four characters. To improve security for production, you are encouraged to specify a more strict
policy, which you can do like this:
*Example*
```ts
{
passwordValidationStrategy: new DefaultPasswordValidationStrategy({
// Minimum eight characters, at least one letter and one number
regexp: /^(?=.*[A-Za-z])(?=.*\d)[A-Za-z\d]{8,}$/,
}),
}
```
</div>
|
---
title: "AuthenticationStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AuthenticationStrategy
<GenerationInfo sourceFile="packages/core/src/config/auth/authentication-strategy.ts" sourceLine="23" packageName="@vendure/core" />
An AuthenticationStrategy defines how a User (which can be a Customer in the Shop API or
and Administrator in the Admin API) may be authenticated.
Real-world examples can be found in the [Authentication guide](/guides/core-concepts/auth/).
:::info
This is configured via the `authOptions.shopAuthenticationStrategy` and `authOptions.adminAuthenticationStrategy`
properties of your VendureConfig.
:::
```ts title="Signature"
interface AuthenticationStrategy<Data = unknown> extends InjectableStrategy {
readonly name: string;
defineInputType(): DocumentNode;
authenticate(ctx: RequestContext, data: Data): Promise<User | false | string>;
onLogOut?(ctx: RequestContext, user: User): Promise<void>;
}
```
* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
<div className="members-wrapper">
### name
<MemberInfo kind="property" type={`string`} />
The name of the strategy, for example `'facebook'`, `'google'`, `'keycloak'`.
### defineInputType
<MemberInfo kind="method" type={`() => DocumentNode`} />
Defines the type of the GraphQL Input object expected by the `authenticate`
mutation. The final input object will be a map, with the key being the name
of the strategy. The shape of the input object should match the generic `Data`
type argument.
*Example*
For example, given the following:
```ts
defineInputType() {
return gql`
input MyAuthInput {
token: String!
}
`;
}
```
assuming the strategy name is "my_auth", then the resulting call to `authenticate`
would look like:
```GraphQL
authenticate(input: {
my_auth: {
token: "foo"
}
}) {
# ...
}
```
**Note:** if more than one graphql `input` type is being defined (as in a nested input type), then
the _first_ input will be assumed to be the top-level input.
### authenticate
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: Data) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | false | string>`} />
Used to authenticate a user with the authentication provider. This method
will implement the provider-specific authentication logic, and should resolve to either a
<a href='/reference/typescript-api/entities/user#user'>User</a> object on success, or `false | string` on failure.
A `string` return could be used to describe what error happened, otherwise `false` to an unknown error.
### onLogOut
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>) => Promise<void>`} />
Called when a user logs out, and may perform any required tasks
related to the user logging out with the external provider.
</div>
|
---
title: "BcryptPasswordHashingStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## BcryptPasswordHashingStrategy
<GenerationInfo sourceFile="packages/core/src/config/auth/bcrypt-password-hashing-strategy.ts" sourceLine="12" packageName="@vendure/core" since="1.3.0" />
A hashing strategy which uses bcrypt (https://en.wikipedia.org/wiki/Bcrypt) to hash plaintext password strings.
```ts title="Signature"
class BcryptPasswordHashingStrategy implements PasswordHashingStrategy {
hash(plaintext: string) => Promise<string>;
check(plaintext: string, hash: string) => Promise<boolean>;
}
```
* Implements: <code><a href='/reference/typescript-api/auth/password-hashing-strategy#passwordhashingstrategy'>PasswordHashingStrategy</a></code>
<div className="members-wrapper">
### hash
<MemberInfo kind="method" type={`(plaintext: string) => Promise<string>`} />
### check
<MemberInfo kind="method" type={`(plaintext: string, hash: string) => Promise<boolean>`} />
</div>
|
---
title: "CookieOptions"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## CookieOptions
<GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="224" packageName="@vendure/core" />
Options for the handling of the cookies used to track sessions (only applicable if
`authOptions.tokenMethod` is set to `'cookie'`). These options are passed directly
to the Express [cookie-session middleware](https://github.com/expressjs/cookie-session).
```ts title="Signature"
interface CookieOptions {
name?: string | { shop: string; admin: string };
secret?: string;
path?: string;
domain?: string;
sameSite?: 'strict' | 'lax' | 'none' | boolean;
secure?: boolean;
secureProxy?: boolean;
httpOnly?: boolean;
signed?: boolean;
overwrite?: boolean;
maxAge?: number;
expires?: Date;
}
```
<div className="members-wrapper">
### name
<MemberInfo kind="property" type={`string | { shop: string; admin: string }`} default="'session'" />
The name of the cookies to set.
If set to a string, both cookies for the Admin API and Shop API will have the same name.
If set as an object, it makes it possible to give different names to the Admin API and the Shop API cookies
### secret
<MemberInfo kind="property" type={`string`} default="(random character string)" />
The secret used for signing the session cookies for authenticated users. Only applies
tokenMethod is set to 'cookie'.
In production applications, this should not be stored as a string in
source control for security reasons, but may be loaded from an external
file not under source control, or from an environment variable, for example.
### path
<MemberInfo kind="property" type={`string`} default="'/'" />
a string indicating the path of the cookie.
### domain
<MemberInfo kind="property" type={`string`} />
a string indicating the domain of the cookie (no default).
### sameSite
<MemberInfo kind="property" type={`'strict' | 'lax' | 'none' | boolean`} default="false" />
a boolean or string indicating whether the cookie is a "same site" cookie (false by default). This can be set to 'strict',
'lax', 'none', or true (which maps to 'strict').
### secure
<MemberInfo kind="property" type={`boolean`} />
a boolean indicating whether the cookie is only to be sent over HTTPS (false by default for HTTP, true by default for HTTPS).
### secureProxy
<MemberInfo kind="property" type={`boolean`} />
a boolean indicating whether the cookie is only to be sent over HTTPS (use this if you handle SSL not in your node process).
### httpOnly
<MemberInfo kind="property" type={`boolean`} default="true" />
a boolean indicating whether the cookie is only to be sent over HTTP(S), and not made available to client JavaScript (true by default).
### signed
<MemberInfo kind="property" type={`boolean`} />
a boolean indicating whether the cookie is to be signed (true by default). If this is true, another cookie of the same name with the .sig
suffix appended will also be sent, with a 27-byte url-safe base64 SHA1 value representing the hash of cookie-name=cookie-value against the
first Keygrip key. This signature key is used to detect tampering the next time a cookie is received.
### overwrite
<MemberInfo kind="property" type={`boolean`} />
a boolean indicating whether to overwrite previously set cookies of the same name (true by default). If this is true, all cookies set during
the same request with the same name (regardless of path or domain) are filtered out of the Set-Cookie header when setting this cookie.
### maxAge
<MemberInfo kind="property" type={`number`} since="2.2.0" />
A number representing the milliseconds from Date.now() for expiry
### expires
<MemberInfo kind="property" type={`Date`} since="2.2.0" />
a Date object indicating the cookie's expiration date (expires at the end of session by default).
</div>
|
---
title: "DefaultPasswordValidationStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## DefaultPasswordValidationStrategy
<GenerationInfo sourceFile="packages/core/src/config/auth/default-password-validation-strategy.ts" sourceLine="18" packageName="@vendure/core" since="1.5.0" />
The DefaultPasswordValidationStrategy allows you to specify a minimum length and/or
a regular expression to match passwords against.
TODO:
By default, the `minLength` will be set to `4`. This is rather permissive and is only
this way in order to reduce the risk of backward-compatibility breaks. In the next major version
this default will be made more strict.
```ts title="Signature"
class DefaultPasswordValidationStrategy implements PasswordValidationStrategy {
constructor(options: { minLength?: number; regexp?: RegExp })
validate(ctx: RequestContext, password: string) => boolean | string;
}
```
* Implements: <code><a href='/reference/typescript-api/auth/password-validation-strategy#passwordvalidationstrategy'>PasswordValidationStrategy</a></code>
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(options: { minLength?: number; regexp?: RegExp }) => DefaultPasswordValidationStrategy`} />
### validate
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, password: string) => boolean | string`} />
</div>
|
---
title: "ExternalAuthenticationService"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## ExternalAuthenticationService
<GenerationInfo sourceFile="packages/core/src/service/helpers/external-authentication/external-authentication.service.ts" sourceLine="24" packageName="@vendure/core" />
This is a helper service which exposes methods related to looking up and creating Users based on an
external <a href='/reference/typescript-api/auth/authentication-strategy#authenticationstrategy'>AuthenticationStrategy</a>.
```ts title="Signature"
class ExternalAuthenticationService {
constructor(connection: TransactionalConnection, roleService: RoleService, historyService: HistoryService, customerService: CustomerService, administratorService: AdministratorService, channelService: ChannelService)
findCustomerUser(ctx: RequestContext, strategy: string, externalIdentifier: string, checkCurrentChannelOnly: = true) => Promise<User | undefined>;
findAdministratorUser(ctx: RequestContext, strategy: string, externalIdentifier: string) => Promise<User | undefined>;
createCustomerAndUser(ctx: RequestContext, config: {
strategy: string;
externalIdentifier: string;
verified: boolean;
emailAddress: string;
firstName?: string;
lastName?: string;
}) => Promise<User>;
createAdministratorAndUser(ctx: RequestContext, config: {
strategy: string;
externalIdentifier: string;
identifier: string;
emailAddress?: string;
firstName?: string;
lastName?: string;
roles: Role[];
}) => ;
findUser(ctx: RequestContext, strategy: string, externalIdentifier: string) => Promise<User | undefined>;
}
```
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(connection: <a href='/reference/typescript-api/data-access/transactional-connection#transactionalconnection'>TransactionalConnection</a>, roleService: <a href='/reference/typescript-api/services/role-service#roleservice'>RoleService</a>, historyService: <a href='/reference/typescript-api/services/history-service#historyservice'>HistoryService</a>, customerService: <a href='/reference/typescript-api/services/customer-service#customerservice'>CustomerService</a>, administratorService: <a href='/reference/typescript-api/services/administrator-service#administratorservice'>AdministratorService</a>, channelService: <a href='/reference/typescript-api/services/channel-service#channelservice'>ChannelService</a>) => ExternalAuthenticationService`} />
### findCustomerUser
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string, checkCurrentChannelOnly: = true) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`} />
Looks up a User based on their identifier from an external authentication
provider, ensuring this User is associated with a Customer account.
By default, only customers in the currently-active Channel will be checked.
By passing `false` as the `checkCurrentChannelOnly` argument, _all_ channels
will be checked.
### findAdministratorUser
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`} />
Looks up a User based on their identifier from an external authentication
provider, ensuring this User is associated with an Administrator account.
### createCustomerAndUser
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: {
strategy: string;
externalIdentifier: string;
verified: boolean;
emailAddress: string;
firstName?: string;
lastName?: string;
}) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a>>`} />
If a customer has been successfully authenticated by an external authentication provider, yet cannot
be found using `findCustomerUser`, then we need to create a new User and
Customer record in Vendure for that user. This method encapsulates that logic as well as additional
housekeeping such as adding a record to the Customer's history.
### createAdministratorAndUser
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, config: {
strategy: string;
externalIdentifier: string;
identifier: string;
emailAddress?: string;
firstName?: string;
lastName?: string;
roles: <a href='/reference/typescript-api/entities/role#role'>Role</a>[];
}) => `} />
If an administrator has been successfully authenticated by an external authentication provider, yet cannot
be found using `findAdministratorUser`, then we need to create a new User and
Administrator record in Vendure for that user.
### findUser
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, strategy: string, externalIdentifier: string) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | undefined>`} />
</div>
|
---
title: "InMemorySessionCacheStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## InMemorySessionCacheStrategy
<GenerationInfo sourceFile="packages/core/src/config/session-cache/in-memory-session-cache-strategy.ts" sourceLine="16" packageName="@vendure/core" />
Caches session in memory, using a LRU cache implementation. Not suitable for
multi-server setups since the cache will be local to each instance, reducing
its effectiveness. By default the cache has a size of 1000, meaning that after
1000 sessions have been cached, any new sessions will cause the least-recently-used
session to be evicted (removed) from the cache.
The cache size can be configured by passing a different number to the constructor
function.
```ts title="Signature"
class InMemorySessionCacheStrategy implements SessionCacheStrategy {
constructor(cacheSize?: number)
delete(sessionToken: string) => ;
get(sessionToken: string) => ;
set(session: CachedSession) => ;
clear() => ;
}
```
* Implements: <code><a href='/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy'>SessionCacheStrategy</a></code>
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(cacheSize?: number) => InMemorySessionCacheStrategy`} />
### delete
<MemberInfo kind="method" type={`(sessionToken: string) => `} />
### get
<MemberInfo kind="method" type={`(sessionToken: string) => `} />
### set
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => `} />
### clear
<MemberInfo kind="method" type={`() => `} />
</div>
|
---
title: "Auth"
isDefaultIndex: true
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
import DocCardList from '@theme/DocCardList';
<DocCardList /> |
---
title: "NativeAuthenticationStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## NativeAuthenticationStrategy
<GenerationInfo sourceFile="packages/core/src/config/auth/native-authentication-strategy.ts" sourceLine="28" packageName="@vendure/core" />
This strategy implements a username/password credential-based authentication, with the credentials
being stored in the Vendure database. This is the default method of authentication, and it is advised
to keep it configured unless there is a specific reason not to.
```ts title="Signature"
class NativeAuthenticationStrategy implements AuthenticationStrategy<NativeAuthenticationData> {
readonly name = NATIVE_AUTH_STRATEGY_NAME;
init(injector: Injector) => ;
defineInputType() => DocumentNode;
authenticate(ctx: RequestContext, data: NativeAuthenticationData) => Promise<User | false>;
verifyUserPassword(ctx: RequestContext, userId: ID, password: string) => Promise<boolean>;
}
```
* Implements: <code><a href='/reference/typescript-api/auth/authentication-strategy#authenticationstrategy'>AuthenticationStrategy</a><NativeAuthenticationData></code>
<div className="members-wrapper">
### name
<MemberInfo kind="property" type={``} />
### init
<MemberInfo kind="method" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>) => `} />
### defineInputType
<MemberInfo kind="method" type={`() => DocumentNode`} />
### authenticate
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, data: NativeAuthenticationData) => Promise<<a href='/reference/typescript-api/entities/user#user'>User</a> | false>`} />
### verifyUserPassword
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>, password: string) => Promise<boolean>`} />
</div>
|
---
title: "NoopSessionCacheStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## NoopSessionCacheStrategy
<GenerationInfo sourceFile="packages/core/src/config/session-cache/noop-session-cache-strategy.ts" sourceLine="10" packageName="@vendure/core" />
A cache that doesn't cache. The cache lookup will miss every time
so the session will always be taken from the database.
```ts title="Signature"
class NoopSessionCacheStrategy implements SessionCacheStrategy {
clear() => ;
delete(sessionToken: string) => ;
get(sessionToken: string) => ;
set(session: CachedSession) => ;
}
```
* Implements: <code><a href='/reference/typescript-api/auth/session-cache-strategy#sessioncachestrategy'>SessionCacheStrategy</a></code>
<div className="members-wrapper">
### clear
<MemberInfo kind="method" type={`() => `} />
### delete
<MemberInfo kind="method" type={`(sessionToken: string) => `} />
### get
<MemberInfo kind="method" type={`(sessionToken: string) => `} />
### set
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => `} />
</div>
|
---
title: "PasswordHashingStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## PasswordHashingStrategy
<GenerationInfo sourceFile="packages/core/src/config/auth/password-hashing-strategy.ts" sourceLine="17" packageName="@vendure/core" since="1.3.0" />
Defines how user passwords get hashed when using the <a href='/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy'>NativeAuthenticationStrategy</a>.
:::info
This is configured via the `authOptions.passwordHashingStrategy` property of
your VendureConfig.
:::
```ts title="Signature"
interface PasswordHashingStrategy extends InjectableStrategy {
hash(plaintext: string): Promise<string>;
check(plaintext: string, hash: string): Promise<boolean>;
}
```
* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
<div className="members-wrapper">
### hash
<MemberInfo kind="method" type={`(plaintext: string) => Promise<string>`} />
### check
<MemberInfo kind="method" type={`(plaintext: string, hash: string) => Promise<boolean>`} />
</div>
|
---
title: "PasswordValidationStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## PasswordValidationStrategy
<GenerationInfo sourceFile="packages/core/src/config/auth/password-validation-strategy.ts" sourceLine="19" packageName="@vendure/core" since="1.5.0" />
Defines validation to apply to new password (when creating an account or updating an existing account's
password when using the <a href='/reference/typescript-api/auth/native-authentication-strategy#nativeauthenticationstrategy'>NativeAuthenticationStrategy</a>.
:::info
This is configured via the `authOptions.passwordValidationStrategy` property of
your VendureConfig.
:::
```ts title="Signature"
interface PasswordValidationStrategy extends InjectableStrategy {
validate(ctx: RequestContext, password: string): Promise<boolean | string> | boolean | string;
}
```
* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
<div className="members-wrapper">
### validate
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, password: string) => Promise<boolean | string> | boolean | string`} since="1.5.0" />
Validates a password submitted during account registration or when a customer updates their password.
The method should resolve to `true` if the password is acceptable. If not, it should return `false` or
optionally a string which will be passed to the returned ErrorResult, which can e.g. advise on why
exactly the proposed password is not valid.
</div>
|
---
title: "PermissionDefinition"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## PermissionDefinition
<GenerationInfo sourceFile="packages/core/src/common/permission-definition.ts" sourceLine="86" packageName="@vendure/core" />
Defines a new Permission with which to control access to GraphQL resolvers & REST controllers.
Used in conjunction with the <a href='/reference/typescript-api/request/allow-decorator#allow'>Allow</a> decorator (see example below).
**Note:** To define CRUD permissions, use the <a href='/reference/typescript-api/auth/permission-definition#crudpermissiondefinition'>CrudPermissionDefinition</a>.
*Example*
```ts
export const sync = new PermissionDefinition({
name: 'SyncInventory',
description: 'Allows syncing stock levels via Admin API'
});
```
```ts
const config: VendureConfig = {
authOptions: {
customPermissions: [sync],
},
}
```
```ts
@Resolver()
export class ExternalSyncResolver {
@Allow(sync.Permission)
@Mutation()
syncStockLevels() {
// ...
}
}
```
```ts title="Signature"
class PermissionDefinition {
constructor(config: PermissionDefinitionConfig)
Permission: Permission
}
```
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/auth/permission-definition#permissiondefinitionconfig'>PermissionDefinitionConfig</a>) => PermissionDefinition`} />
### Permission
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
Returns the permission defined by this definition, for use in the
<a href='/reference/typescript-api/request/allow-decorator#allow'>Allow</a> decorator.
</div>
## CrudPermissionDefinition
<GenerationInfo sourceFile="packages/core/src/common/permission-definition.ts" sourceLine="146" packageName="@vendure/core" />
Defines a set of CRUD Permissions for the given name, i.e. a `name` of 'Wishlist' will create
4 Permissions: 'CreateWishlist', 'ReadWishlist', 'UpdateWishlist' & 'DeleteWishlist'.
*Example*
```ts
export const wishlist = new CrudPermissionDefinition('Wishlist');
```
```ts
const config: VendureConfig = {
authOptions: {
customPermissions: [wishlist],
},
}
```
```ts
@Resolver()
export class WishlistResolver {
@Allow(wishlist.Create)
@Mutation()
createWishlist() {
// ...
}
}
```
```ts title="Signature"
class CrudPermissionDefinition extends PermissionDefinition {
constructor(name: string, descriptionFn?: (operation: 'create' | 'read' | 'update' | 'delete') => string)
Create: Permission
Read: Permission
Update: Permission
Delete: Permission
}
```
* Extends: <code><a href='/reference/typescript-api/auth/permission-definition#permissiondefinition'>PermissionDefinition</a></code>
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(name: string, descriptionFn?: (operation: 'create' | 'read' | 'update' | 'delete') => string) => CrudPermissionDefinition`} />
### Create
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
Returns the 'Create' CRUD permission defined by this definition, for use in the
<a href='/reference/typescript-api/request/allow-decorator#allow'>Allow</a> decorator.
### Read
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
Returns the 'Read' CRUD permission defined by this definition, for use in the
<a href='/reference/typescript-api/request/allow-decorator#allow'>Allow</a> decorator.
### Update
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
Returns the 'Update' CRUD permission defined by this definition, for use in the
<a href='/reference/typescript-api/request/allow-decorator#allow'>Allow</a> decorator.
### Delete
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/permission#permission'>Permission</a>`} />
Returns the 'Delete' CRUD permission defined by this definition, for use in the
<a href='/reference/typescript-api/request/allow-decorator#allow'>Allow</a> decorator.
</div>
## PermissionDefinitionConfig
<GenerationInfo sourceFile="packages/core/src/common/permission-definition.ts" sourceLine="10" packageName="@vendure/core" />
Configures a <a href='/reference/typescript-api/auth/permission-definition#permissiondefinition'>PermissionDefinition</a>
```ts title="Signature"
interface PermissionDefinitionConfig {
name: string;
description?: string;
assignable?: boolean;
internal?: boolean;
}
```
<div className="members-wrapper">
### name
<MemberInfo kind="property" type={`string`} />
The name of the permission. By convention this should be
UpperCamelCased.
### description
<MemberInfo kind="property" type={`string`} />
A description of the permission.
### assignable
<MemberInfo kind="property" type={`boolean`} default="true" />
Whether this permission can be assigned to a Role. In general this
should be left as the default `true` except in special cases.
### internal
<MemberInfo kind="property" type={`boolean`} default="false" />
Internal permissions are not exposed via the API and are reserved for
special use-cases such at the `Owner` or `Public` permissions.
</div>
|
---
title: "SessionCacheStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## SessionCacheStrategy
<GenerationInfo sourceFile="packages/core/src/config/session-cache/session-cache-strategy.ts" sourceLine="155" packageName="@vendure/core" />
This strategy defines how sessions get cached. Since most requests will need the Session
object for permissions data, it can become a bottleneck to go to the database and do a multi-join
SQL query each time. Therefore, we cache the session data only perform the SQL query once and upon
invalidation of the cache.
The Vendure default is to use a the <a href='/reference/typescript-api/auth/in-memory-session-cache-strategy#inmemorysessioncachestrategy'>InMemorySessionCacheStrategy</a>, which is fast and suitable for
single-instance deployments. However, for multi-instance deployments (horizontally scaled, serverless etc.),
you will need to define a custom strategy that stores the session cache in a shared data store, such as in the
DB or in Redis.
:::info
This is configured via the `authOptions.sessionCacheStrategy` property of
your VendureConfig.
:::
Here's an example implementation using Redis. To use this, you need to add the
[ioredis package](https://www.npmjs.com/package/ioredis) as a dependency.
*Example*
```ts
import { CachedSession, Logger, SessionCacheStrategy, VendurePlugin } from '@vendure/core';
import { Redis, RedisOptions } from 'ioredis';
export interface RedisSessionCachePluginOptions {
namespace?: string;
redisOptions?: RedisOptions;
}
const loggerCtx = 'RedisSessionCacheStrategy';
const DEFAULT_NAMESPACE = 'vendure-session-cache';
const DEFAULT_TTL = 86400;
export class RedisSessionCacheStrategy implements SessionCacheStrategy {
private client: Redis;
constructor(private options: RedisSessionCachePluginOptions) {}
init() {
this.client = new Redis(this.options.redisOptions as RedisOptions);
this.client.on('error', err => Logger.error(err.message, loggerCtx, err.stack));
}
async destroy() {
await this.client.quit();
}
async get(sessionToken: string): Promise<CachedSession | undefined> {
try {
const retrieved = await this.client.get(this.namespace(sessionToken));
if (retrieved) {
try {
return JSON.parse(retrieved);
} catch (e: any) {
Logger.error(`Could not parse cached session data: ${e.message}`, loggerCtx);
}
}
} catch (e: any) {
Logger.error(`Could not get cached session: ${e.message}`, loggerCtx);
}
}
async set(session: CachedSession) {
try {
await this.client.set(this.namespace(session.token), JSON.stringify(session), 'EX', DEFAULT_TTL);
} catch (e: any) {
Logger.error(`Could not set cached session: ${e.message}`, loggerCtx);
}
}
async delete(sessionToken: string) {
try {
await this.client.del(this.namespace(sessionToken));
} catch (e: any) {
Logger.error(`Could not delete cached session: ${e.message}`, loggerCtx);
}
}
clear() {
// not implemented
}
private namespace(key: string) {
return `${this.options.namespace ?? DEFAULT_NAMESPACE}:${key}`;
}
}
@VendurePlugin({
configuration: config => {
config.authOptions.sessionCacheStrategy = new RedisSessionCacheStrategy(
RedisSessionCachePlugin.options,
);
return config;
},
})
export class RedisSessionCachePlugin {
static options: RedisSessionCachePluginOptions;
static init(options: RedisSessionCachePluginOptions) {
this.options = options;
return this;
}
}
```
```ts title="Signature"
interface SessionCacheStrategy extends InjectableStrategy {
set(session: CachedSession): void | Promise<void>;
get(sessionToken: string): CachedSession | undefined | Promise<CachedSession | undefined>;
delete(sessionToken: string): void | Promise<void>;
clear(): void | Promise<void>;
}
```
* Extends: <code><a href='/reference/typescript-api/common/injectable-strategy#injectablestrategy'>InjectableStrategy</a></code>
<div className="members-wrapper">
### set
<MemberInfo kind="method" type={`(session: <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a>) => void | Promise<void>`} />
Store the session in the cache. When caching a session, the data
should not be modified apart from performing any transforms needed to
get it into a state to be stored, e.g. JSON.stringify().
### get
<MemberInfo kind="method" type={`(sessionToken: string) => <a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined | Promise<<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsession'>CachedSession</a> | undefined>`} />
Retrieve the session from the cache
### delete
<MemberInfo kind="method" type={`(sessionToken: string) => void | Promise<void>`} />
Delete a session from the cache
### clear
<MemberInfo kind="method" type={`() => void | Promise<void>`} />
Clear the entire cache
</div>
## CachedSessionUser
<GenerationInfo sourceFile="packages/core/src/config/session-cache/session-cache-strategy.ts" sourceLine="14" packageName="@vendure/core" />
A simplified representation of the User associated with the
current Session.
```ts title="Signature"
type CachedSessionUser = {
id: ID;
identifier: string;
verified: boolean;
channelPermissions: UserChannelPermissions[];
}
```
<div className="members-wrapper">
### id
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
### identifier
<MemberInfo kind="property" type={`string`} />
### verified
<MemberInfo kind="property" type={`boolean`} />
### channelPermissions
<MemberInfo kind="property" type={`UserChannelPermissions[]`} />
</div>
## CachedSession
<GenerationInfo sourceFile="packages/core/src/config/session-cache/session-cache-strategy.ts" sourceLine="29" packageName="@vendure/core" />
A simplified representation of a Session which is easy to
store.
```ts title="Signature"
type CachedSession = {
cacheExpiry: number;
id: ID;
token: string;
expires: Date;
activeOrderId?: ID;
authenticationStrategy?: string;
user?: CachedSessionUser;
activeChannelId?: ID;
}
```
<div className="members-wrapper">
### cacheExpiry
<MemberInfo kind="property" type={`number`} />
The timestamp after which this cache entry is considered stale and
a fresh copy of the data will be set. Based on the `sessionCacheTTL`
option.
### id
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
### token
<MemberInfo kind="property" type={`string`} />
### expires
<MemberInfo kind="property" type={`Date`} />
### activeOrderId
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
### authenticationStrategy
<MemberInfo kind="property" type={`string`} />
### user
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/auth/session-cache-strategy#cachedsessionuser'>CachedSessionUser</a>`} />
### activeChannelId
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/common/id#id'>ID</a>`} />
</div>
|
---
title: "SuperadminCredentials"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## SuperadminCredentials
<GenerationInfo sourceFile="packages/core/src/config/vendure-config.ts" sourceLine="803" packageName="@vendure/core" />
These credentials will be used to create the Superadmin user & administrator
when Vendure first bootstraps.
```ts title="Signature"
interface SuperadminCredentials {
identifier: string;
password: string;
}
```
<div className="members-wrapper">
### identifier
<MemberInfo kind="property" type={`string`} default="'superadmin'" />
The identifier to be used to create a superadmin account
### password
<MemberInfo kind="property" type={`string`} default="'superadmin'" />
The password to be used to create a superadmin account
</div>
|
---
title: "AsyncQueue"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## AsyncQueue
<GenerationInfo sourceFile="packages/core/src/common/async-queue.ts" sourceLine="13" packageName="@vendure/core" />
A queue class for limiting concurrent async tasks. This can be used e.g. to prevent
race conditions when working on a shared resource such as writing to a database.
```ts title="Signature"
class AsyncQueue {
constructor(label: string = 'default', concurrency: number = 1)
push(task: Task<T>) => Promise<T>;
}
```
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(label: string = 'default', concurrency: number = 1) => AsyncQueue`} />
### push
<MemberInfo kind="method" type={`(task: Task<T>) => Promise<T>`} />
Pushes a new task onto the queue, upon which the task will either execute immediately or
(if the number of running tasks is equal to the concurrency limit) enqueue the task to
be executed at the soonest opportunity.
</div>
|
---
title: "Bootstrap"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## bootstrap
<GenerationInfo sourceFile="packages/core/src/bootstrap.ts" sourceLine="106" packageName="@vendure/core" />
Bootstraps the Vendure server. This is the entry point to the application.
*Example*
```ts
import { bootstrap } from '@vendure/core';
import { config } from './vendure-config';
bootstrap(config).catch(err => {
console.log(err);
process.exit(1);
});
```
### Passing additional options
Since v2.2.0, you can pass additional options to the NestJs application via the `options` parameter.
For example, to integrate with the [Nest Devtools](https://docs.nestjs.com/devtools/overview), you need to
pass the `snapshot` option:
```ts
import { bootstrap } from '@vendure/core';
import { config } from './vendure-config';
bootstrap(config, {
// highlight-start
nestApplicationOptions: {
snapshot: true,
}
// highlight-end
}).catch(err => {
console.log(err);
process.exit(1);
});
```
```ts title="Signature"
function bootstrap(userConfig: Partial<VendureConfig>, options?: BootstrapOptions): Promise<INestApplication>
```
Parameters
### userConfig
<MemberInfo kind="parameter" type={`Partial<<a href='/reference/typescript-api/configuration/vendure-config#vendureconfig'>VendureConfig</a>>`} />
### options
<MemberInfo kind="parameter" type={`<a href='/reference/typescript-api/common/bootstrap#bootstrapoptions'>BootstrapOptions</a>`} />
## BootstrapOptions
<GenerationInfo sourceFile="packages/core/src/bootstrap.ts" sourceLine="41" packageName="@vendure/core" since="2.2.0" />
Additional options that can be used to configure the bootstrap process of the
Vendure server.
```ts title="Signature"
interface BootstrapOptions {
nestApplicationOptions: NestApplicationOptions;
}
```
<div className="members-wrapper">
### nestApplicationOptions
<MemberInfo kind="property" type={`NestApplicationOptions`} />
These options get passed directly to the `NestFactory.create()` method.
</div>
|
---
title: "CurrencyCode"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## CurrencyCode
<GenerationInfo sourceFile="packages/common/src/generated-types.ts" sourceLine="982" packageName="@vendure/common" />
ISO 4217 currency code
```ts title="Signature"
enum CurrencyCode {
AED = 'AED'
AFN = 'AFN'
ALL = 'ALL'
AMD = 'AMD'
ANG = 'ANG'
AOA = 'AOA'
ARS = 'ARS'
AUD = 'AUD'
AWG = 'AWG'
AZN = 'AZN'
BAM = 'BAM'
BBD = 'BBD'
BDT = 'BDT'
BGN = 'BGN'
BHD = 'BHD'
BIF = 'BIF'
BMD = 'BMD'
BND = 'BND'
BOB = 'BOB'
BRL = 'BRL'
BSD = 'BSD'
BTN = 'BTN'
BWP = 'BWP'
BYN = 'BYN'
BZD = 'BZD'
CAD = 'CAD'
CDF = 'CDF'
CHF = 'CHF'
CLP = 'CLP'
CNY = 'CNY'
COP = 'COP'
CRC = 'CRC'
CUC = 'CUC'
CUP = 'CUP'
CVE = 'CVE'
CZK = 'CZK'
DJF = 'DJF'
DKK = 'DKK'
DOP = 'DOP'
DZD = 'DZD'
EGP = 'EGP'
ERN = 'ERN'
ETB = 'ETB'
EUR = 'EUR'
FJD = 'FJD'
FKP = 'FKP'
GBP = 'GBP'
GEL = 'GEL'
GHS = 'GHS'
GIP = 'GIP'
GMD = 'GMD'
GNF = 'GNF'
GTQ = 'GTQ'
GYD = 'GYD'
HKD = 'HKD'
HNL = 'HNL'
HRK = 'HRK'
HTG = 'HTG'
HUF = 'HUF'
IDR = 'IDR'
ILS = 'ILS'
INR = 'INR'
IQD = 'IQD'
IRR = 'IRR'
ISK = 'ISK'
JMD = 'JMD'
JOD = 'JOD'
JPY = 'JPY'
KES = 'KES'
KGS = 'KGS'
KHR = 'KHR'
KMF = 'KMF'
KPW = 'KPW'
KRW = 'KRW'
KWD = 'KWD'
KYD = 'KYD'
KZT = 'KZT'
LAK = 'LAK'
LBP = 'LBP'
LKR = 'LKR'
LRD = 'LRD'
LSL = 'LSL'
LYD = 'LYD'
MAD = 'MAD'
MDL = 'MDL'
MGA = 'MGA'
MKD = 'MKD'
MMK = 'MMK'
MNT = 'MNT'
MOP = 'MOP'
MRU = 'MRU'
MUR = 'MUR'
MVR = 'MVR'
MWK = 'MWK'
MXN = 'MXN'
MYR = 'MYR'
MZN = 'MZN'
NAD = 'NAD'
NGN = 'NGN'
NIO = 'NIO'
NOK = 'NOK'
NPR = 'NPR'
NZD = 'NZD'
OMR = 'OMR'
PAB = 'PAB'
PEN = 'PEN'
PGK = 'PGK'
PHP = 'PHP'
PKR = 'PKR'
PLN = 'PLN'
PYG = 'PYG'
QAR = 'QAR'
RON = 'RON'
RSD = 'RSD'
RUB = 'RUB'
RWF = 'RWF'
SAR = 'SAR'
SBD = 'SBD'
SCR = 'SCR'
SDG = 'SDG'
SEK = 'SEK'
SGD = 'SGD'
SHP = 'SHP'
SLL = 'SLL'
SOS = 'SOS'
SRD = 'SRD'
SSP = 'SSP'
STN = 'STN'
SVC = 'SVC'
SYP = 'SYP'
SZL = 'SZL'
THB = 'THB'
TJS = 'TJS'
TMT = 'TMT'
TND = 'TND'
TOP = 'TOP'
TRY = 'TRY'
TTD = 'TTD'
TWD = 'TWD'
TZS = 'TZS'
UAH = 'UAH'
UGX = 'UGX'
USD = 'USD'
UYU = 'UYU'
UZS = 'UZS'
VES = 'VES'
VND = 'VND'
VUV = 'VUV'
WST = 'WST'
XAF = 'XAF'
XCD = 'XCD'
XOF = 'XOF'
XPF = 'XPF'
YER = 'YER'
ZAR = 'ZAR'
ZMW = 'ZMW'
ZWL = 'ZWL'
}
```
|
---
title: "EntityRelationPaths"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## EntityRelationPaths
<GenerationInfo sourceFile="packages/core/src/common/types/entity-relation-paths.ts" sourceLine="23" packageName="@vendure/core" />
This type allows type-safe access to entity relations using strings with dot notation.
It works to 2 levels deep.
*Example*
```ts
type T1 = EntityRelationPaths<Product>;
```
In the above example, the type `T1` will be a string union of all relations of the
`Product` entity:
* `'featuredAsset'`
* `'variants'`
* `'variants.options'`
* `'variants.featuredAsset'`
* etc.
```ts title="Signature"
type EntityRelationPaths<T extends VendureEntity> = | `customFields.${string}`
| PathsToStringProps1<T>
| Join<PathsToStringProps2<T>, '.'>
| TripleDotPath
```
|
---
title: "I18nService"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## I18nService
<GenerationInfo sourceFile="packages/core/src/i18n/i18n.service.ts" sourceLine="44" packageName="@vendure/core" />
```ts title="Signature"
class I18nService implements OnModuleInit {
addTranslationFile(langKey: string, filePath: string) => void;
addTranslation(langKey: string, resources: VendureTranslationResources | any) => void;
}
```
* Implements: <code>OnModuleInit</code>
<div className="members-wrapper">
### addTranslationFile
<MemberInfo kind="method" type={`(langKey: string, filePath: string) => void`} />
Add a I18n translation by json file
### addTranslation
<MemberInfo kind="method" type={`(langKey: string, resources: <a href='/reference/typescript-api/common/i18n-service#venduretranslationresources'>VendureTranslationResources</a> | any) => void`} />
Add a I18n translation (key-value) resource
</div>
## VendureTranslationResources
<GenerationInfo sourceFile="packages/core/src/i18n/i18n.service.ts" sourceLine="24" packageName="@vendure/core" />
I18n resources used for translations
```ts title="Signature"
interface VendureTranslationResources {
error: any;
errorResult: any;
message: any;
}
```
<div className="members-wrapper">
### error
<MemberInfo kind="property" type={`any`} />
### errorResult
<MemberInfo kind="property" type={`any`} />
### message
<MemberInfo kind="property" type={`any`} />
</div>
|
---
title: "ID"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## ID
<GenerationInfo sourceFile="packages/common/src/shared-types.ts" sourceLine="79" packageName="@vendure/common" />
An entity ID. Depending on the configured <a href='/reference/typescript-api/configuration/entity-id-strategy#entityidstrategy'>EntityIdStrategy</a>, it will be either
a `string` or a `number`;
```ts title="Signature"
type ID = string | number
```
|
---
title: "Common"
isDefaultIndex: true
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
import DocCardList from '@theme/DocCardList';
<DocCardList /> |
---
title: "InjectableStrategy"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## InjectableStrategy
<GenerationInfo sourceFile="packages/core/src/common/types/injectable-strategy.ts" sourceLine="10" packageName="@vendure/core" />
This interface defines the setup and teardown hooks available to the
various strategies used to configure Vendure.
```ts title="Signature"
interface InjectableStrategy {
init?: (injector: Injector) => void | Promise<void>;
destroy?: () => void | Promise<void>;
}
```
<div className="members-wrapper">
### init
<MemberInfo kind="property" type={`(injector: <a href='/reference/typescript-api/common/injector#injector'>Injector</a>) => void | Promise<void>`} />
Defines setup logic to be run during application bootstrap. Receives
the <a href='/reference/typescript-api/common/injector#injector'>Injector</a> as an argument, which allows application providers
to be used as part of the setup. This hook will be called on both the
main server and the worker processes.
*Example*
```ts
async init(injector: Injector) {
const myService = injector.get(MyService);
await myService.doSomething();
}
```
### destroy
<MemberInfo kind="property" type={`() => void | Promise<void>`} />
Defines teardown logic to be run before application shutdown.
</div>
|
---
title: "Injector"
isDefaultIndex: false
generated: true
---
<!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
import MemberInfo from '@site/src/components/MemberInfo';
import GenerationInfo from '@site/src/components/GenerationInfo';
import MemberDescription from '@site/src/components/MemberDescription';
## Injector
<GenerationInfo sourceFile="packages/core/src/common/injector.ts" sourceLine="15" packageName="@vendure/core" />
The Injector wraps the underlying Nestjs `ModuleRef`, allowing injection of providers
known to the application's dependency injection container. This is intended to enable the injection
of services into objects which exist outside of the Nestjs module system, e.g. the various
Strategies which can be supplied in the VendureConfig.
```ts title="Signature"
class Injector {
constructor(moduleRef: ModuleRef)
get(typeOrToken: Type<T> | string | symbol) => R;
resolve(typeOrToken: Type<T> | string | symbol, contextId?: ContextId) => Promise<R>;
}
```
<div className="members-wrapper">
### constructor
<MemberInfo kind="method" type={`(moduleRef: ModuleRef) => Injector`} />
### get
<MemberInfo kind="method" type={`(typeOrToken: Type<T> | string | symbol) => R`} />
Retrieve an instance of the given type from the app's dependency injection container.
Wraps the Nestjs `ModuleRef.get()` method.
### resolve
<MemberInfo kind="method" type={`(typeOrToken: Type<T> | string | symbol, contextId?: ContextId) => Promise<R>`} />
Retrieve an instance of the given scoped provider (transient or request-scoped) from the
app's dependency injection container.
Wraps the Nestjs `ModuleRef.resolve()` method.
</div>
|