---
title: "Input Objects"
generated: true
---



## AddItemInput {#additeminput}

<GraphQLDoc
  type="input"
  typeName="AddItemInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Int: '/reference/graphql-api/admin/object-types#int',
  }}
>
{`input AddItemInput {
  productVariantId: ID!
  quantity: Int!
}`}
</GraphQLDoc>

## AddItemToDraftOrderInput {#additemtodraftorderinput}

<GraphQLDoc
  type="input"
  typeName="AddItemToDraftOrderInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Int: '/reference/graphql-api/admin/object-types#int',
  }}
>
{`input AddItemToDraftOrderInput {
  productVariantId: ID!
  quantity: Int!
}`}
</GraphQLDoc>

## AddNoteToCustomerInput {#addnotetocustomerinput}

<GraphQLDoc
  type="input"
  typeName="AddNoteToCustomerInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`input AddNoteToCustomerInput {
  id: ID!
  note: String!
  isPublic: Boolean!
}`}
</GraphQLDoc>

## AddNoteToOrderInput {#addnotetoorderinput}

<GraphQLDoc
  type="input"
  typeName="AddNoteToOrderInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`input AddNoteToOrderInput {
  id: ID!
  note: String!
  isPublic: Boolean!
}`}
</GraphQLDoc>

## AdjustDraftOrderLineInput {#adjustdraftorderlineinput}

<GraphQLDoc
  type="input"
  typeName="AdjustDraftOrderLineInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Int: '/reference/graphql-api/admin/object-types#int',
  }}
>
{`input AdjustDraftOrderLineInput {
  orderLineId: ID!
  quantity: Int!
}`}
</GraphQLDoc>

## AdministratorFilterParameter {#administratorfilterparameter}

<GraphQLDoc
  type="input"
  typeName="AdministratorFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    AdministratorFilterParameter: '/reference/graphql-api/admin/input-types#administratorfilterparameter',
  }}
>
{`input AdministratorFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  firstName: StringOperators
  lastName: StringOperators
  emailAddress: StringOperators
  _and: [AdministratorFilterParameter!]
  _or: [AdministratorFilterParameter!]
}`}
</GraphQLDoc>

## AdministratorListOptions {#administratorlistoptions}

<GraphQLDoc
  type="input"
  typeName="AdministratorListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    AdministratorSortParameter: '/reference/graphql-api/admin/input-types#administratorsortparameter',
    AdministratorFilterParameter: '/reference/graphql-api/admin/input-types#administratorfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input AdministratorListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: AdministratorSortParameter
  """Allows the results to be filtered"""
  filter: AdministratorFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## AdministratorPaymentInput {#administratorpaymentinput}

<GraphQLDoc
  type="input"
  typeName="AdministratorPaymentInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input AdministratorPaymentInput {
  paymentMethod: String
  metadata: JSON
}`}
</GraphQLDoc>

## AdministratorRefundInput {#administratorrefundinput}

<GraphQLDoc
  type="input"
  typeName="AdministratorRefundInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    Money: '/reference/graphql-api/admin/object-types#money',
  }}
>
{`input AdministratorRefundInput {
  paymentId: ID!
  reason: String
  """
  The amount to be refunded to this particular Payment. This was introduced in
  v2.2.0 as the preferred way to specify the refund amount. The \`lines\`, \`shipping\` and \`adjustment\`
  fields will be removed in a future version.
  """
  amount: Money
}`}
</GraphQLDoc>

## AdministratorSortParameter {#administratorsortparameter}

<GraphQLDoc
  type="input"
  typeName="AdministratorSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input AdministratorSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  firstName: SortOrder
  lastName: SortOrder
  emailAddress: SortOrder
}`}
</GraphQLDoc>

## AssetFilterParameter {#assetfilterparameter}

<GraphQLDoc
  type="input"
  typeName="AssetFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
    AssetFilterParameter: '/reference/graphql-api/admin/input-types#assetfilterparameter',
  }}
>
{`input AssetFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  name: StringOperators
  type: StringOperators
  fileSize: NumberOperators
  mimeType: StringOperators
  width: NumberOperators
  height: NumberOperators
  source: StringOperators
  preview: StringOperators
  _and: [AssetFilterParameter!]
  _or: [AssetFilterParameter!]
}`}
</GraphQLDoc>

## AssetListOptions {#assetlistoptions}

<GraphQLDoc
  type="input"
  typeName="AssetListOptions"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
    Int: '/reference/graphql-api/admin/object-types#int',
    AssetSortParameter: '/reference/graphql-api/admin/input-types#assetsortparameter',
    AssetFilterParameter: '/reference/graphql-api/admin/input-types#assetfilterparameter',
  }}
>
{`input AssetListOptions {
  tags: [String!]
  tagsOperator: LogicalOperator
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: AssetSortParameter
  """Allows the results to be filtered"""
  filter: AssetFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## AssetSortParameter {#assetsortparameter}

<GraphQLDoc
  type="input"
  typeName="AssetSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input AssetSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
  fileSize: SortOrder
  mimeType: SortOrder
  width: SortOrder
  height: SortOrder
  source: SortOrder
  preview: SortOrder
}`}
</GraphQLDoc>

## AssignAssetsToChannelInput {#assignassetstochannelinput}

<GraphQLDoc
  type="input"
  typeName="AssignAssetsToChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input AssignAssetsToChannelInput {
  assetIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## AssignCollectionsToChannelInput {#assigncollectionstochannelinput}

<GraphQLDoc
  type="input"
  typeName="AssignCollectionsToChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input AssignCollectionsToChannelInput {
  collectionIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## AssignFacetsToChannelInput {#assignfacetstochannelinput}

<GraphQLDoc
  type="input"
  typeName="AssignFacetsToChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input AssignFacetsToChannelInput {
  facetIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## AssignPaymentMethodsToChannelInput {#assignpaymentmethodstochannelinput}

<GraphQLDoc
  type="input"
  typeName="AssignPaymentMethodsToChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input AssignPaymentMethodsToChannelInput {
  paymentMethodIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## AssignProductVariantsToChannelInput {#assignproductvariantstochannelinput}

<GraphQLDoc
  type="input"
  typeName="AssignProductVariantsToChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Float: '/reference/graphql-api/admin/object-types#float',
  }}
>
{`input AssignProductVariantsToChannelInput {
  productVariantIds: [ID!]!
  channelId: ID!
  priceFactor: Float
}`}
</GraphQLDoc>

## AssignProductsToChannelInput {#assignproductstochannelinput}

<GraphQLDoc
  type="input"
  typeName="AssignProductsToChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Float: '/reference/graphql-api/admin/object-types#float',
  }}
>
{`input AssignProductsToChannelInput {
  productIds: [ID!]!
  channelId: ID!
  priceFactor: Float
}`}
</GraphQLDoc>

## AssignPromotionsToChannelInput {#assignpromotionstochannelinput}

<GraphQLDoc
  type="input"
  typeName="AssignPromotionsToChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input AssignPromotionsToChannelInput {
  promotionIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## AssignShippingMethodsToChannelInput {#assignshippingmethodstochannelinput}

<GraphQLDoc
  type="input"
  typeName="AssignShippingMethodsToChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input AssignShippingMethodsToChannelInput {
  shippingMethodIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## AssignStockLocationsToChannelInput {#assignstocklocationstochannelinput}

<GraphQLDoc
  type="input"
  typeName="AssignStockLocationsToChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input AssignStockLocationsToChannelInput {
  stockLocationIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## AuthenticationInput {#authenticationinput}

<GraphQLDoc
  type="input"
  typeName="AuthenticationInput"
  typeLinks={{
    NativeAuthInput: '/reference/graphql-api/admin/input-types#nativeauthinput',
  }}
>
{`input AuthenticationInput {
  native: NativeAuthInput
}`}
</GraphQLDoc>

## BooleanListOperators {#booleanlistoperators}

<GraphQLDoc
  type="input"
  typeName="BooleanListOperators"
  typeLinks={{
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`"""Operators for filtering on a list of Boolean fields"""
input BooleanListOperators {
  inList: Boolean!
}`}
</GraphQLDoc>

## BooleanOperators {#booleanoperators}

<GraphQLDoc
  type="input"
  typeName="BooleanOperators"
  typeLinks={{
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`"""Operators for filtering on a Boolean field"""
input BooleanOperators {
  eq: Boolean
  isNull: Boolean
}`}
</GraphQLDoc>

## CancelOrderInput {#cancelorderinput}

<GraphQLDoc
  type="input"
  typeName="CancelOrderInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    OrderLineInput: '/reference/graphql-api/admin/input-types#orderlineinput',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    String: '/reference/graphql-api/admin/object-types#string',
  }}
>
{`input CancelOrderInput {
  """The id of the order to be cancelled"""
  orderId: ID!
  """Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled"""
  lines: [OrderLineInput!]
  """Specify whether the shipping charges should also be cancelled. Defaults to false"""
  cancelShipping: Boolean
  reason: String
}`}
</GraphQLDoc>

## ChannelFilterParameter {#channelfilterparameter}

<GraphQLDoc
  type="input"
  typeName="ChannelFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
    ChannelFilterParameter: '/reference/graphql-api/admin/input-types#channelfilterparameter',
  }}
>
{`input ChannelFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  code: StringOperators
  token: StringOperators
  defaultLanguageCode: StringOperators
  currencyCode: StringOperators
  defaultCurrencyCode: StringOperators
  trackInventory: BooleanOperators
  outOfStockThreshold: NumberOperators
  pricesIncludeTax: BooleanOperators
  _and: [ChannelFilterParameter!]
  _or: [ChannelFilterParameter!]
}`}
</GraphQLDoc>

## ChannelListOptions {#channellistoptions}

<GraphQLDoc
  type="input"
  typeName="ChannelListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    ChannelSortParameter: '/reference/graphql-api/admin/input-types#channelsortparameter',
    ChannelFilterParameter: '/reference/graphql-api/admin/input-types#channelfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input ChannelListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: ChannelSortParameter
  """Allows the results to be filtered"""
  filter: ChannelFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## ChannelSortParameter {#channelsortparameter}

<GraphQLDoc
  type="input"
  typeName="ChannelSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input ChannelSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  code: SortOrder
  token: SortOrder
  outOfStockThreshold: SortOrder
}`}
</GraphQLDoc>

## CollectionFilterParameter {#collectionfilterparameter}

<GraphQLDoc
  type="input"
  typeName="CollectionFilterParameter"
  typeLinks={{
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
    CollectionFilterParameter: '/reference/graphql-api/admin/input-types#collectionfilterparameter',
  }}
>
{`input CollectionFilterParameter {
  isPrivate: BooleanOperators
  inheritFilters: BooleanOperators
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  name: StringOperators
  slug: StringOperators
  position: NumberOperators
  description: StringOperators
  parentId: IDOperators
  _and: [CollectionFilterParameter!]
  _or: [CollectionFilterParameter!]
}`}
</GraphQLDoc>

## CollectionListOptions {#collectionlistoptions}

<GraphQLDoc
  type="input"
  typeName="CollectionListOptions"
  typeLinks={{
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    Int: '/reference/graphql-api/admin/object-types#int',
    CollectionSortParameter: '/reference/graphql-api/admin/input-types#collectionsortparameter',
    CollectionFilterParameter: '/reference/graphql-api/admin/input-types#collectionfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input CollectionListOptions {
  topLevelOnly: Boolean
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: CollectionSortParameter
  """Allows the results to be filtered"""
  filter: CollectionFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## CollectionSortParameter {#collectionsortparameter}

<GraphQLDoc
  type="input"
  typeName="CollectionSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input CollectionSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
  slug: SortOrder
  position: SortOrder
  description: SortOrder
  parentId: SortOrder
}`}
</GraphQLDoc>

## ConfigArgInput {#configarginput}

<GraphQLDoc
  type="input"
  typeName="ConfigArgInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
  }}
>
{`input ConfigArgInput {
  name: String!
  """A JSON stringified representation of the actual value"""
  value: String!
}`}
</GraphQLDoc>

## ConfigurableOperationInput {#configurableoperationinput}

<GraphQLDoc
  type="input"
  typeName="ConfigurableOperationInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    ConfigArgInput: '/reference/graphql-api/admin/input-types#configarginput',
  }}
>
{`input ConfigurableOperationInput {
  code: String!
  arguments: [ConfigArgInput!]!
}`}
</GraphQLDoc>

## CoordinateInput {#coordinateinput}

<GraphQLDoc
  type="input"
  typeName="CoordinateInput"
  typeLinks={{
    Float: '/reference/graphql-api/admin/object-types#float',
  }}
>
{`input CoordinateInput {
  x: Float!
  y: Float!
}`}
</GraphQLDoc>

## CountryFilterParameter {#countryfilterparameter}

<GraphQLDoc
  type="input"
  typeName="CountryFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    CountryFilterParameter: '/reference/graphql-api/admin/input-types#countryfilterparameter',
  }}
>
{`input CountryFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  code: StringOperators
  type: StringOperators
  name: StringOperators
  enabled: BooleanOperators
  parentId: IDOperators
  _and: [CountryFilterParameter!]
  _or: [CountryFilterParameter!]
}`}
</GraphQLDoc>

## CountryListOptions {#countrylistoptions}

<GraphQLDoc
  type="input"
  typeName="CountryListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    CountrySortParameter: '/reference/graphql-api/admin/input-types#countrysortparameter',
    CountryFilterParameter: '/reference/graphql-api/admin/input-types#countryfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input CountryListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: CountrySortParameter
  """Allows the results to be filtered"""
  filter: CountryFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## CountrySortParameter {#countrysortparameter}

<GraphQLDoc
  type="input"
  typeName="CountrySortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input CountrySortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  code: SortOrder
  type: SortOrder
  name: SortOrder
  parentId: SortOrder
}`}
</GraphQLDoc>

## CountryTranslationInput {#countrytranslationinput}

<GraphQLDoc
  type="input"
  typeName="CountryTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CountryTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  customFields: JSON
}`}
</GraphQLDoc>

## CreateAddressInput {#createaddressinput}

<GraphQLDoc
  type="input"
  typeName="CreateAddressInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`"""
Input used to create an Address.

The countryCode must correspond to a \`code\` property of a Country that has been defined in the
Vendure server. The \`code\` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
If an invalid code is passed, the mutation will fail.
"""
input CreateAddressInput {
  fullName: String
  company: String
  streetLine1: String!
  streetLine2: String
  city: String
  province: String
  postalCode: String
  countryCode: String!
  phoneNumber: String
  defaultShippingAddress: Boolean
  defaultBillingAddress: Boolean
  customFields: JSON
}`}
</GraphQLDoc>

## CreateAdministratorInput {#createadministratorinput}

<GraphQLDoc
  type="input"
  typeName="CreateAdministratorInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    ID: '/reference/graphql-api/admin/object-types#id',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateAdministratorInput {
  firstName: String!
  lastName: String!
  emailAddress: String!
  password: String!
  roleIds: [ID!]!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateAssetInput {#createassetinput}

<GraphQLDoc
  type="input"
  typeName="CreateAssetInput"
  typeLinks={{
    Upload: '/reference/graphql-api/admin/object-types#upload',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateAssetInput {
  file: Upload!
  tags: [String!]
  customFields: JSON
}`}
</GraphQLDoc>

## CreateChannelInput {#createchannelinput}

<GraphQLDoc
  type="input"
  typeName="CreateChannelInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
    Int: '/reference/graphql-api/admin/object-types#int',
    ID: '/reference/graphql-api/admin/object-types#id',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateChannelInput {
  code: String!
  token: String!
  defaultLanguageCode: LanguageCode!
  availableLanguageCodes: [LanguageCode!]
  pricesIncludeTax: Boolean!
  currencyCode: CurrencyCode
  defaultCurrencyCode: CurrencyCode
  availableCurrencyCodes: [CurrencyCode!]
  trackInventory: Boolean
  outOfStockThreshold: Int
  defaultTaxZoneId: ID!
  defaultShippingZoneId: ID!
  sellerId: ID
  customFields: JSON
}`}
</GraphQLDoc>

## CreateCollectionInput {#createcollectioninput}

<GraphQLDoc
  type="input"
  typeName="CreateCollectionInput"
  typeLinks={{
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    ID: '/reference/graphql-api/admin/object-types#id',
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
    CreateCollectionTranslationInput: '/reference/graphql-api/admin/input-types#createcollectiontranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateCollectionInput {
  isPrivate: Boolean
  featuredAssetId: ID
  assetIds: [ID!]
  parentId: ID
  inheritFilters: Boolean
  filters: [ConfigurableOperationInput!]!
  translations: [CreateCollectionTranslationInput!]!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateCollectionTranslationInput {#createcollectiontranslationinput}

<GraphQLDoc
  type="input"
  typeName="CreateCollectionTranslationInput"
  typeLinks={{
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateCollectionTranslationInput {
  languageCode: LanguageCode!
  name: String!
  slug: String!
  description: String!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateCountryInput {#createcountryinput}

<GraphQLDoc
  type="input"
  typeName="CreateCountryInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    CountryTranslationInput: '/reference/graphql-api/admin/input-types#countrytranslationinput',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateCountryInput {
  code: String!
  translations: [CountryTranslationInput!]!
  enabled: Boolean!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateCustomerGroupInput {#createcustomergroupinput}

<GraphQLDoc
  type="input"
  typeName="CreateCustomerGroupInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    ID: '/reference/graphql-api/admin/object-types#id',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateCustomerGroupInput {
  name: String!
  customerIds: [ID!]
  customFields: JSON
}`}
</GraphQLDoc>

## CreateCustomerInput {#createcustomerinput}

<GraphQLDoc
  type="input"
  typeName="CreateCustomerInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateCustomerInput {
  title: String
  firstName: String!
  lastName: String!
  phoneNumber: String
  emailAddress: String!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateFacetInput {#createfacetinput}

<GraphQLDoc
  type="input"
  typeName="CreateFacetInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    FacetTranslationInput: '/reference/graphql-api/admin/input-types#facettranslationinput',
    CreateFacetValueWithFacetInput: '/reference/graphql-api/admin/input-types#createfacetvaluewithfacetinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateFacetInput {
  code: String!
  isPrivate: Boolean!
  translations: [FacetTranslationInput!]!
  values: [CreateFacetValueWithFacetInput!]
  customFields: JSON
}`}
</GraphQLDoc>

## CreateFacetValueInput {#createfacetvalueinput}

<GraphQLDoc
  type="input"
  typeName="CreateFacetValueInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    FacetValueTranslationInput: '/reference/graphql-api/admin/input-types#facetvaluetranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateFacetValueInput {
  facetId: ID!
  code: String!
  translations: [FacetValueTranslationInput!]!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateFacetValueWithFacetInput {#createfacetvaluewithfacetinput}

<GraphQLDoc
  type="input"
  typeName="CreateFacetValueWithFacetInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    FacetValueTranslationInput: '/reference/graphql-api/admin/input-types#facetvaluetranslationinput',
  }}
>
{`input CreateFacetValueWithFacetInput {
  code: String!
  translations: [FacetValueTranslationInput!]!
}`}
</GraphQLDoc>

## CreateGroupOptionInput {#creategroupoptioninput}

<GraphQLDoc
  type="input"
  typeName="CreateGroupOptionInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    ProductOptionGroupTranslationInput: '/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput',
  }}
>
{`input CreateGroupOptionInput {
  code: String!
  translations: [ProductOptionGroupTranslationInput!]!
}`}
</GraphQLDoc>

## CreatePaymentMethodInput {#createpaymentmethodinput}

<GraphQLDoc
  type="input"
  typeName="CreatePaymentMethodInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
    PaymentMethodTranslationInput: '/reference/graphql-api/admin/input-types#paymentmethodtranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreatePaymentMethodInput {
  code: String!
  enabled: Boolean!
  checker: ConfigurableOperationInput
  handler: ConfigurableOperationInput!
  translations: [PaymentMethodTranslationInput!]!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateProductInput {#createproductinput}

<GraphQLDoc
  type="input"
  typeName="CreateProductInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    ProductTranslationInput: '/reference/graphql-api/admin/input-types#producttranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateProductInput {
  featuredAssetId: ID
  enabled: Boolean
  assetIds: [ID!]
  facetValueIds: [ID!]
  translations: [ProductTranslationInput!]!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateProductOptionGroupInput {#createproductoptiongroupinput}

<GraphQLDoc
  type="input"
  typeName="CreateProductOptionGroupInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    ProductOptionGroupTranslationInput: '/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput',
    CreateGroupOptionInput: '/reference/graphql-api/admin/input-types#creategroupoptioninput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateProductOptionGroupInput {
  code: String!
  translations: [ProductOptionGroupTranslationInput!]!
  options: [CreateGroupOptionInput!]!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateProductOptionInput {#createproductoptioninput}

<GraphQLDoc
  type="input"
  typeName="CreateProductOptionInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    ProductOptionGroupTranslationInput: '/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateProductOptionInput {
  productOptionGroupId: ID!
  code: String!
  translations: [ProductOptionGroupTranslationInput!]!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateProductVariantInput {#createproductvariantinput}

<GraphQLDoc
  type="input"
  typeName="CreateProductVariantInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    ProductVariantTranslationInput: '/reference/graphql-api/admin/input-types#productvarianttranslationinput',
    String: '/reference/graphql-api/admin/object-types#string',
    Money: '/reference/graphql-api/admin/object-types#money',
    CreateProductVariantPriceInput: '/reference/graphql-api/admin/input-types#createproductvariantpriceinput',
    Int: '/reference/graphql-api/admin/object-types#int',
    StockLevelInput: '/reference/graphql-api/admin/input-types#stocklevelinput',
    GlobalFlag: '/reference/graphql-api/admin/enums#globalflag',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateProductVariantInput {
  productId: ID!
  enabled: Boolean
  translations: [ProductVariantTranslationInput!]!
  facetValueIds: [ID!]
  sku: String!
  price: Money
  prices: [CreateProductVariantPriceInput]
  taxCategoryId: ID
  optionIds: [ID!]
  featuredAssetId: ID
  assetIds: [ID!]
  stockOnHand: Int
  stockLevels: [StockLevelInput!]
  outOfStockThreshold: Int
  useGlobalOutOfStockThreshold: Boolean
  trackInventory: GlobalFlag
  customFields: JSON
}`}
</GraphQLDoc>

## CreateProductVariantOptionInput {#createproductvariantoptioninput}

<GraphQLDoc
  type="input"
  typeName="CreateProductVariantOptionInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    ProductOptionTranslationInput: '/reference/graphql-api/admin/input-types#productoptiontranslationinput',
  }}
>
{`input CreateProductVariantOptionInput {
  optionGroupId: ID!
  code: String!
  translations: [ProductOptionTranslationInput!]!
}`}
</GraphQLDoc>

## CreateProductVariantPriceInput {#createproductvariantpriceinput}

<GraphQLDoc
  type="input"
  typeName="CreateProductVariantPriceInput"
  typeLinks={{
    CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
    Money: '/reference/graphql-api/admin/object-types#money',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateProductVariantPriceInput {
  currencyCode: CurrencyCode!
  price: Money!
  customFields: JSON
}`}
</GraphQLDoc>

## CreatePromotionInput {#createpromotioninput}

<GraphQLDoc
  type="input"
  typeName="CreatePromotionInput"
  typeLinks={{
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    DateTime: '/reference/graphql-api/admin/object-types#datetime',
    String: '/reference/graphql-api/admin/object-types#string',
    Int: '/reference/graphql-api/admin/object-types#int',
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
    PromotionTranslationInput: '/reference/graphql-api/admin/input-types#promotiontranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreatePromotionInput {
  enabled: Boolean!
  startsAt: DateTime
  endsAt: DateTime
  couponCode: String
  perCustomerUsageLimit: Int
  usageLimit: Int
  conditions: [ConfigurableOperationInput!]!
  actions: [ConfigurableOperationInput!]!
  translations: [PromotionTranslationInput!]!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateProvinceInput {#createprovinceinput}

<GraphQLDoc
  type="input"
  typeName="CreateProvinceInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    ProvinceTranslationInput: '/reference/graphql-api/admin/input-types#provincetranslationinput',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateProvinceInput {
  code: String!
  translations: [ProvinceTranslationInput!]!
  enabled: Boolean!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateRoleInput {#createroleinput}

<GraphQLDoc
  type="input"
  typeName="CreateRoleInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    Permission: '/reference/graphql-api/admin/enums#permission',
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input CreateRoleInput {
  code: String!
  description: String!
  permissions: [Permission!]!
  channelIds: [ID!]
}`}
</GraphQLDoc>

## CreateSellerInput {#createsellerinput}

<GraphQLDoc
  type="input"
  typeName="CreateSellerInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateSellerInput {
  name: String!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateShippingMethodInput {#createshippingmethodinput}

<GraphQLDoc
  type="input"
  typeName="CreateShippingMethodInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
    ShippingMethodTranslationInput: '/reference/graphql-api/admin/input-types#shippingmethodtranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateShippingMethodInput {
  code: String!
  fulfillmentHandler: String!
  checker: ConfigurableOperationInput!
  calculator: ConfigurableOperationInput!
  translations: [ShippingMethodTranslationInput!]!
  customFields: JSON
}`}
</GraphQLDoc>

## CreateStockLocationInput {#createstocklocationinput}

<GraphQLDoc
  type="input"
  typeName="CreateStockLocationInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateStockLocationInput {
  name: String!
  description: String
  customFields: JSON
}`}
</GraphQLDoc>

## CreateTagInput {#createtaginput}

<GraphQLDoc
  type="input"
  typeName="CreateTagInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
  }}
>
{`input CreateTagInput {
  value: String!
}`}
</GraphQLDoc>

## CreateTaxCategoryInput {#createtaxcategoryinput}

<GraphQLDoc
  type="input"
  typeName="CreateTaxCategoryInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateTaxCategoryInput {
  name: String!
  isDefault: Boolean
  customFields: JSON
}`}
</GraphQLDoc>

## CreateTaxRateInput {#createtaxrateinput}

<GraphQLDoc
  type="input"
  typeName="CreateTaxRateInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    Float: '/reference/graphql-api/admin/object-types#float',
    ID: '/reference/graphql-api/admin/object-types#id',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateTaxRateInput {
  name: String!
  enabled: Boolean!
  value: Float!
  categoryId: ID!
  zoneId: ID!
  customerGroupId: ID
  customFields: JSON
}`}
</GraphQLDoc>

## CreateZoneInput {#createzoneinput}

<GraphQLDoc
  type="input"
  typeName="CreateZoneInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    ID: '/reference/graphql-api/admin/object-types#id',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input CreateZoneInput {
  name: String!
  memberIds: [ID!]
  customFields: JSON
}`}
</GraphQLDoc>

## CustomerFilterParameter {#customerfilterparameter}

<GraphQLDoc
  type="input"
  typeName="CustomerFilterParameter"
  typeLinks={{
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    CustomerFilterParameter: '/reference/graphql-api/admin/input-types#customerfilterparameter',
  }}
>
{`input CustomerFilterParameter {
  postalCode: StringOperators
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  title: StringOperators
  firstName: StringOperators
  lastName: StringOperators
  phoneNumber: StringOperators
  emailAddress: StringOperators
  _and: [CustomerFilterParameter!]
  _or: [CustomerFilterParameter!]
}`}
</GraphQLDoc>

## CustomerGroupFilterParameter {#customergroupfilterparameter}

<GraphQLDoc
  type="input"
  typeName="CustomerGroupFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    CustomerGroupFilterParameter: '/reference/graphql-api/admin/input-types#customergroupfilterparameter',
  }}
>
{`input CustomerGroupFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  name: StringOperators
  _and: [CustomerGroupFilterParameter!]
  _or: [CustomerGroupFilterParameter!]
}`}
</GraphQLDoc>

## CustomerGroupListOptions {#customergrouplistoptions}

<GraphQLDoc
  type="input"
  typeName="CustomerGroupListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    CustomerGroupSortParameter: '/reference/graphql-api/admin/input-types#customergroupsortparameter',
    CustomerGroupFilterParameter: '/reference/graphql-api/admin/input-types#customergroupfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input CustomerGroupListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: CustomerGroupSortParameter
  """Allows the results to be filtered"""
  filter: CustomerGroupFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## CustomerGroupSortParameter {#customergroupsortparameter}

<GraphQLDoc
  type="input"
  typeName="CustomerGroupSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input CustomerGroupSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
}`}
</GraphQLDoc>

## CustomerListOptions {#customerlistoptions}

<GraphQLDoc
  type="input"
  typeName="CustomerListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    CustomerSortParameter: '/reference/graphql-api/admin/input-types#customersortparameter',
    CustomerFilterParameter: '/reference/graphql-api/admin/input-types#customerfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input CustomerListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: CustomerSortParameter
  """Allows the results to be filtered"""
  filter: CustomerFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## CustomerSortParameter {#customersortparameter}

<GraphQLDoc
  type="input"
  typeName="CustomerSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input CustomerSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  title: SortOrder
  firstName: SortOrder
  lastName: SortOrder
  phoneNumber: SortOrder
  emailAddress: SortOrder
}`}
</GraphQLDoc>

## DateListOperators {#datelistoperators}

<GraphQLDoc
  type="input"
  typeName="DateListOperators"
  typeLinks={{
    DateTime: '/reference/graphql-api/admin/object-types#datetime',
  }}
>
{`"""Operators for filtering on a list of Date fields"""
input DateListOperators {
  inList: DateTime!
}`}
</GraphQLDoc>

## DateOperators {#dateoperators}

<GraphQLDoc
  type="input"
  typeName="DateOperators"
  typeLinks={{
    DateTime: '/reference/graphql-api/admin/object-types#datetime',
    DateRange: '/reference/graphql-api/admin/input-types#daterange',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`"""Operators for filtering on a DateTime field"""
input DateOperators {
  eq: DateTime
  before: DateTime
  after: DateTime
  between: DateRange
  isNull: Boolean
}`}
</GraphQLDoc>

## DateRange {#daterange}

<GraphQLDoc
  type="input"
  typeName="DateRange"
  typeLinks={{
    DateTime: '/reference/graphql-api/admin/object-types#datetime',
  }}
>
{`input DateRange {
  start: DateTime!
  end: DateTime!
}`}
</GraphQLDoc>

## DeleteAssetInput {#deleteassetinput}

<GraphQLDoc
  type="input"
  typeName="DeleteAssetInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`input DeleteAssetInput {
  assetId: ID!
  force: Boolean
  deleteFromAllChannels: Boolean
}`}
</GraphQLDoc>

## DeleteAssetsInput {#deleteassetsinput}

<GraphQLDoc
  type="input"
  typeName="DeleteAssetsInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`input DeleteAssetsInput {
  assetIds: [ID!]!
  force: Boolean
  deleteFromAllChannels: Boolean
}`}
</GraphQLDoc>

## DeleteStockLocationInput {#deletestocklocationinput}

<GraphQLDoc
  type="input"
  typeName="DeleteStockLocationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input DeleteStockLocationInput {
  id: ID!
  transferToLocationId: ID
}`}
</GraphQLDoc>

## DuplicateEntityInput {#duplicateentityinput}

<GraphQLDoc
  type="input"
  typeName="DuplicateEntityInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    ID: '/reference/graphql-api/admin/object-types#id',
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
  }}
>
{`input DuplicateEntityInput {
  entityName: String!
  entityId: ID!
  duplicatorInput: ConfigurableOperationInput!
}`}
</GraphQLDoc>

## FacetFilterParameter {#facetfilterparameter}

<GraphQLDoc
  type="input"
  typeName="FacetFilterParameter"
  typeLinks={{
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    FacetFilterParameter: '/reference/graphql-api/admin/input-types#facetfilterparameter',
  }}
>
{`input FacetFilterParameter {
  isPrivate: BooleanOperators
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  name: StringOperators
  code: StringOperators
  _and: [FacetFilterParameter!]
  _or: [FacetFilterParameter!]
}`}
</GraphQLDoc>

## FacetListOptions {#facetlistoptions}

<GraphQLDoc
  type="input"
  typeName="FacetListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    FacetSortParameter: '/reference/graphql-api/admin/input-types#facetsortparameter',
    FacetFilterParameter: '/reference/graphql-api/admin/input-types#facetfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input FacetListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: FacetSortParameter
  """Allows the results to be filtered"""
  filter: FacetFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## FacetSortParameter {#facetsortparameter}

<GraphQLDoc
  type="input"
  typeName="FacetSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input FacetSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
  code: SortOrder
}`}
</GraphQLDoc>

## FacetTranslationInput {#facettranslationinput}

<GraphQLDoc
  type="input"
  typeName="FacetTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input FacetTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  customFields: JSON
}`}
</GraphQLDoc>

## FacetValueFilterInput {#facetvaluefilterinput}

<GraphQLDoc
  type="input"
  typeName="FacetValueFilterInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`"""
Used to construct boolean expressions for filtering search results
by FacetValue ID. Examples:

* ID=1 OR ID=2: \`{ facetValueFilters: [{ or: [1,2] }] }\`
* ID=1 AND ID=2: \`{ facetValueFilters: [{ and: 1 }, { and: 2 }] }\`
* ID=1 AND (ID=2 OR ID=3): \`{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }\`
"""
input FacetValueFilterInput {
  and: ID
  or: [ID!]
}`}
</GraphQLDoc>

## FacetValueFilterParameter {#facetvaluefilterparameter}

<GraphQLDoc
  type="input"
  typeName="FacetValueFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    FacetValueFilterParameter: '/reference/graphql-api/admin/input-types#facetvaluefilterparameter',
  }}
>
{`input FacetValueFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  facetId: IDOperators
  name: StringOperators
  code: StringOperators
  _and: [FacetValueFilterParameter!]
  _or: [FacetValueFilterParameter!]
}`}
</GraphQLDoc>

## FacetValueListOptions {#facetvaluelistoptions}

<GraphQLDoc
  type="input"
  typeName="FacetValueListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    FacetValueSortParameter: '/reference/graphql-api/admin/input-types#facetvaluesortparameter',
    FacetValueFilterParameter: '/reference/graphql-api/admin/input-types#facetvaluefilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input FacetValueListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: FacetValueSortParameter
  """Allows the results to be filtered"""
  filter: FacetValueFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## FacetValueSortParameter {#facetvaluesortparameter}

<GraphQLDoc
  type="input"
  typeName="FacetValueSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input FacetValueSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  facetId: SortOrder
  name: SortOrder
  code: SortOrder
}`}
</GraphQLDoc>

## FacetValueTranslationInput {#facetvaluetranslationinput}

<GraphQLDoc
  type="input"
  typeName="FacetValueTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input FacetValueTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  customFields: JSON
}`}
</GraphQLDoc>

## FulfillOrderInput {#fulfillorderinput}

<GraphQLDoc
  type="input"
  typeName="FulfillOrderInput"
  typeLinks={{
    OrderLineInput: '/reference/graphql-api/admin/input-types#orderlineinput',
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
  }}
>
{`input FulfillOrderInput {
  lines: [OrderLineInput!]!
  handler: ConfigurableOperationInput!
}`}
</GraphQLDoc>

## HistoryEntryFilterParameter {#historyentryfilterparameter}

<GraphQLDoc
  type="input"
  typeName="HistoryEntryFilterParameter"
  typeLinks={{
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    HistoryEntryFilterParameter: '/reference/graphql-api/admin/input-types#historyentryfilterparameter',
  }}
>
{`input HistoryEntryFilterParameter {
  isPublic: BooleanOperators
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  type: StringOperators
  _and: [HistoryEntryFilterParameter!]
  _or: [HistoryEntryFilterParameter!]
}`}
</GraphQLDoc>

## HistoryEntryListOptions {#historyentrylistoptions}

<GraphQLDoc
  type="input"
  typeName="HistoryEntryListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    HistoryEntrySortParameter: '/reference/graphql-api/admin/input-types#historyentrysortparameter',
    HistoryEntryFilterParameter: '/reference/graphql-api/admin/input-types#historyentryfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input HistoryEntryListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: HistoryEntrySortParameter
  """Allows the results to be filtered"""
  filter: HistoryEntryFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## HistoryEntrySortParameter {#historyentrysortparameter}

<GraphQLDoc
  type="input"
  typeName="HistoryEntrySortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input HistoryEntrySortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
}`}
</GraphQLDoc>

## IDListOperators {#idlistoperators}

<GraphQLDoc
  type="input"
  typeName="IDListOperators"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`"""Operators for filtering on a list of ID fields"""
input IDListOperators {
  inList: ID!
}`}
</GraphQLDoc>

## IDOperators {#idoperators}

<GraphQLDoc
  type="input"
  typeName="IDOperators"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`"""Operators for filtering on an ID field"""
input IDOperators {
  eq: String
  notEq: String
  in: [String!]
  notIn: [String!]
  isNull: Boolean
}`}
</GraphQLDoc>

## JobFilterParameter {#jobfilterparameter}

<GraphQLDoc
  type="input"
  typeName="JobFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    JobFilterParameter: '/reference/graphql-api/admin/input-types#jobfilterparameter',
  }}
>
{`input JobFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  startedAt: DateOperators
  settledAt: DateOperators
  queueName: StringOperators
  state: StringOperators
  progress: NumberOperators
  isSettled: BooleanOperators
  duration: NumberOperators
  retries: NumberOperators
  attempts: NumberOperators
  _and: [JobFilterParameter!]
  _or: [JobFilterParameter!]
}`}
</GraphQLDoc>

## JobListOptions {#joblistoptions}

<GraphQLDoc
  type="input"
  typeName="JobListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    JobSortParameter: '/reference/graphql-api/admin/input-types#jobsortparameter',
    JobFilterParameter: '/reference/graphql-api/admin/input-types#jobfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input JobListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: JobSortParameter
  """Allows the results to be filtered"""
  filter: JobFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## JobSortParameter {#jobsortparameter}

<GraphQLDoc
  type="input"
  typeName="JobSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input JobSortParameter {
  id: SortOrder
  createdAt: SortOrder
  startedAt: SortOrder
  settledAt: SortOrder
  queueName: SortOrder
  progress: SortOrder
  duration: SortOrder
  retries: SortOrder
  attempts: SortOrder
}`}
</GraphQLDoc>

## ManualPaymentInput {#manualpaymentinput}

<GraphQLDoc
  type="input"
  typeName="ManualPaymentInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input ManualPaymentInput {
  orderId: ID!
  method: String!
  transactionId: String
  metadata: JSON
}`}
</GraphQLDoc>

## MetricSummaryInput {#metricsummaryinput}

<GraphQLDoc
  type="input"
  typeName="MetricSummaryInput"
  typeLinks={{
    MetricInterval: '/reference/graphql-api/admin/enums#metricinterval',
    MetricType: '/reference/graphql-api/admin/enums#metrictype',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`input MetricSummaryInput {
  interval: MetricInterval!
  types: [MetricType!]!
  refresh: Boolean
}`}
</GraphQLDoc>

## ModifyOrderInput {#modifyorderinput}

<GraphQLDoc
  type="input"
  typeName="ModifyOrderInput"
  typeLinks={{
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    ID: '/reference/graphql-api/admin/object-types#id',
    AddItemInput: '/reference/graphql-api/admin/input-types#additeminput',
    OrderLineInput: '/reference/graphql-api/admin/input-types#orderlineinput',
    SurchargeInput: '/reference/graphql-api/admin/input-types#surchargeinput',
    UpdateOrderAddressInput: '/reference/graphql-api/admin/input-types#updateorderaddressinput',
    String: '/reference/graphql-api/admin/object-types#string',
    AdministratorRefundInput: '/reference/graphql-api/admin/input-types#administratorrefundinput',
    ModifyOrderOptions: '/reference/graphql-api/admin/input-types#modifyorderoptions',
  }}
>
{`input ModifyOrderInput {
  dryRun: Boolean!
  orderId: ID!
  addItems: [AddItemInput!]
  adjustOrderLines: [OrderLineInput!]
  surcharges: [SurchargeInput!]
  updateShippingAddress: UpdateOrderAddressInput
  updateBillingAddress: UpdateOrderAddressInput
  note: String
  """
  Deprecated in v2.2.0. Use \`refunds\` instead to allow multiple refunds to be
  applied in the case that multiple payment methods have been used on the order.
  """
  refund: AdministratorRefundInput
  refunds: [AdministratorRefundInput!]
  options: ModifyOrderOptions
  couponCodes: [String!]
  """Added in v2.2"""
  shippingMethodIds: [ID!]
}`}
</GraphQLDoc>

## ModifyOrderOptions {#modifyorderoptions}

<GraphQLDoc
  type="input"
  typeName="ModifyOrderOptions"
  typeLinks={{
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`input ModifyOrderOptions {
  freezePromotions: Boolean
  recalculateShipping: Boolean
}`}
</GraphQLDoc>

## MoveCollectionInput {#movecollectioninput}

<GraphQLDoc
  type="input"
  typeName="MoveCollectionInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Int: '/reference/graphql-api/admin/object-types#int',
  }}
>
{`input MoveCollectionInput {
  collectionId: ID!
  parentId: ID!
  index: Int!
}`}
</GraphQLDoc>

## NativeAuthInput {#nativeauthinput}

<GraphQLDoc
  type="input"
  typeName="NativeAuthInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
  }}
>
{`input NativeAuthInput {
  username: String!
  password: String!
}`}
</GraphQLDoc>

## NumberListOperators {#numberlistoperators}

<GraphQLDoc
  type="input"
  typeName="NumberListOperators"
  typeLinks={{
    Float: '/reference/graphql-api/admin/object-types#float',
  }}
>
{`"""Operators for filtering on a list of Number fields"""
input NumberListOperators {
  inList: Float!
}`}
</GraphQLDoc>

## NumberOperators {#numberoperators}

<GraphQLDoc
  type="input"
  typeName="NumberOperators"
  typeLinks={{
    Float: '/reference/graphql-api/admin/object-types#float',
    NumberRange: '/reference/graphql-api/admin/input-types#numberrange',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`"""Operators for filtering on a Int or Float field"""
input NumberOperators {
  eq: Float
  lt: Float
  lte: Float
  gt: Float
  gte: Float
  between: NumberRange
  isNull: Boolean
}`}
</GraphQLDoc>

## NumberRange {#numberrange}

<GraphQLDoc
  type="input"
  typeName="NumberRange"
  typeLinks={{
    Float: '/reference/graphql-api/admin/object-types#float',
  }}
>
{`input NumberRange {
  start: Float!
  end: Float!
}`}
</GraphQLDoc>

## OrderFilterParameter {#orderfilterparameter}

<GraphQLDoc
  type="input"
  typeName="OrderFilterParameter"
  typeLinks={{
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
    OrderFilterParameter: '/reference/graphql-api/admin/input-types#orderfilterparameter',
  }}
>
{`input OrderFilterParameter {
  customerLastName: StringOperators
  transactionId: StringOperators
  aggregateOrderId: IDOperators
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  type: StringOperators
  orderPlacedAt: DateOperators
  code: StringOperators
  state: StringOperators
  active: BooleanOperators
  totalQuantity: NumberOperators
  subTotal: NumberOperators
  subTotalWithTax: NumberOperators
  currencyCode: StringOperators
  shipping: NumberOperators
  shippingWithTax: NumberOperators
  total: NumberOperators
  totalWithTax: NumberOperators
  _and: [OrderFilterParameter!]
  _or: [OrderFilterParameter!]
}`}
</GraphQLDoc>

## OrderLineInput {#orderlineinput}

<GraphQLDoc
  type="input"
  typeName="OrderLineInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Int: '/reference/graphql-api/admin/object-types#int',
  }}
>
{`input OrderLineInput {
  orderLineId: ID!
  quantity: Int!
}`}
</GraphQLDoc>

## OrderListOptions {#orderlistoptions}

<GraphQLDoc
  type="input"
  typeName="OrderListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    OrderSortParameter: '/reference/graphql-api/admin/input-types#ordersortparameter',
    OrderFilterParameter: '/reference/graphql-api/admin/input-types#orderfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input OrderListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: OrderSortParameter
  """Allows the results to be filtered"""
  filter: OrderFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## OrderSortParameter {#ordersortparameter}

<GraphQLDoc
  type="input"
  typeName="OrderSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input OrderSortParameter {
  customerLastName: SortOrder
  transactionId: SortOrder
  aggregateOrderId: SortOrder
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  orderPlacedAt: SortOrder
  code: SortOrder
  state: SortOrder
  totalQuantity: SortOrder
  subTotal: SortOrder
  subTotalWithTax: SortOrder
  shipping: SortOrder
  shippingWithTax: SortOrder
  total: SortOrder
  totalWithTax: SortOrder
}`}
</GraphQLDoc>

## PaymentMethodFilterParameter {#paymentmethodfilterparameter}

<GraphQLDoc
  type="input"
  typeName="PaymentMethodFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    PaymentMethodFilterParameter: '/reference/graphql-api/admin/input-types#paymentmethodfilterparameter',
  }}
>
{`input PaymentMethodFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  name: StringOperators
  code: StringOperators
  description: StringOperators
  enabled: BooleanOperators
  _and: [PaymentMethodFilterParameter!]
  _or: [PaymentMethodFilterParameter!]
}`}
</GraphQLDoc>

## PaymentMethodListOptions {#paymentmethodlistoptions}

<GraphQLDoc
  type="input"
  typeName="PaymentMethodListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    PaymentMethodSortParameter: '/reference/graphql-api/admin/input-types#paymentmethodsortparameter',
    PaymentMethodFilterParameter: '/reference/graphql-api/admin/input-types#paymentmethodfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input PaymentMethodListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: PaymentMethodSortParameter
  """Allows the results to be filtered"""
  filter: PaymentMethodFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## PaymentMethodSortParameter {#paymentmethodsortparameter}

<GraphQLDoc
  type="input"
  typeName="PaymentMethodSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input PaymentMethodSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
  code: SortOrder
  description: SortOrder
}`}
</GraphQLDoc>

## PaymentMethodTranslationInput {#paymentmethodtranslationinput}

<GraphQLDoc
  type="input"
  typeName="PaymentMethodTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input PaymentMethodTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  description: String
  customFields: JSON
}`}
</GraphQLDoc>

## PreviewCollectionVariantsInput {#previewcollectionvariantsinput}

<GraphQLDoc
  type="input"
  typeName="PreviewCollectionVariantsInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
  }}
>
{`input PreviewCollectionVariantsInput {
  parentId: ID
  inheritFilters: Boolean!
  filters: [ConfigurableOperationInput!]!
}`}
</GraphQLDoc>

## ProductFilterParameter {#productfilterparameter}

<GraphQLDoc
  type="input"
  typeName="ProductFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    ProductFilterParameter: '/reference/graphql-api/admin/input-types#productfilterparameter',
  }}
>
{`input ProductFilterParameter {
  facetValueId: IDOperators
  sku: StringOperators
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  name: StringOperators
  slug: StringOperators
  description: StringOperators
  enabled: BooleanOperators
  _and: [ProductFilterParameter!]
  _or: [ProductFilterParameter!]
}`}
</GraphQLDoc>

## ProductListOptions {#productlistoptions}

<GraphQLDoc
  type="input"
  typeName="ProductListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    ProductSortParameter: '/reference/graphql-api/admin/input-types#productsortparameter',
    ProductFilterParameter: '/reference/graphql-api/admin/input-types#productfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input ProductListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: ProductSortParameter
  """Allows the results to be filtered"""
  filter: ProductFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## ProductOptionFilterParameter {#productoptionfilterparameter}

<GraphQLDoc
  type="input"
  typeName="ProductOptionFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    ProductOptionFilterParameter: '/reference/graphql-api/admin/input-types#productoptionfilterparameter',
  }}
>
{`input ProductOptionFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  code: StringOperators
  name: StringOperators
  groupId: IDOperators
  _and: [ProductOptionFilterParameter!]
  _or: [ProductOptionFilterParameter!]
}`}
</GraphQLDoc>

## ProductOptionGroupTranslationInput {#productoptiongrouptranslationinput}

<GraphQLDoc
  type="input"
  typeName="ProductOptionGroupTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input ProductOptionGroupTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  customFields: JSON
}`}
</GraphQLDoc>

## ProductOptionListOptions {#productoptionlistoptions}

<GraphQLDoc
  type="input"
  typeName="ProductOptionListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    ProductOptionSortParameter: '/reference/graphql-api/admin/input-types#productoptionsortparameter',
    ProductOptionFilterParameter: '/reference/graphql-api/admin/input-types#productoptionfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input ProductOptionListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: ProductOptionSortParameter
  """Allows the results to be filtered"""
  filter: ProductOptionFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## ProductOptionSortParameter {#productoptionsortparameter}

<GraphQLDoc
  type="input"
  typeName="ProductOptionSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input ProductOptionSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  code: SortOrder
  name: SortOrder
  groupId: SortOrder
}`}
</GraphQLDoc>

## ProductOptionTranslationInput {#productoptiontranslationinput}

<GraphQLDoc
  type="input"
  typeName="ProductOptionTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input ProductOptionTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  customFields: JSON
}`}
</GraphQLDoc>

## ProductSortParameter {#productsortparameter}

<GraphQLDoc
  type="input"
  typeName="ProductSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input ProductSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
  slug: SortOrder
  description: SortOrder
}`}
</GraphQLDoc>

## ProductTranslationInput {#producttranslationinput}

<GraphQLDoc
  type="input"
  typeName="ProductTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input ProductTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  slug: String
  description: String
  customFields: JSON
}`}
</GraphQLDoc>

## ProductVariantFilterParameter {#productvariantfilterparameter}

<GraphQLDoc
  type="input"
  typeName="ProductVariantFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    ProductVariantFilterParameter: '/reference/graphql-api/admin/input-types#productvariantfilterparameter',
  }}
>
{`input ProductVariantFilterParameter {
  facetValueId: IDOperators
  enabled: BooleanOperators
  trackInventory: StringOperators
  stockOnHand: NumberOperators
  stockAllocated: NumberOperators
  outOfStockThreshold: NumberOperators
  useGlobalOutOfStockThreshold: BooleanOperators
  id: IDOperators
  productId: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  sku: StringOperators
  name: StringOperators
  price: NumberOperators
  currencyCode: StringOperators
  priceWithTax: NumberOperators
  stockLevel: StringOperators
  _and: [ProductVariantFilterParameter!]
  _or: [ProductVariantFilterParameter!]
}`}
</GraphQLDoc>

## ProductVariantListOptions {#productvariantlistoptions}

<GraphQLDoc
  type="input"
  typeName="ProductVariantListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    ProductVariantSortParameter: '/reference/graphql-api/admin/input-types#productvariantsortparameter',
    ProductVariantFilterParameter: '/reference/graphql-api/admin/input-types#productvariantfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input ProductVariantListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: ProductVariantSortParameter
  """Allows the results to be filtered"""
  filter: ProductVariantFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## ProductVariantSortParameter {#productvariantsortparameter}

<GraphQLDoc
  type="input"
  typeName="ProductVariantSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input ProductVariantSortParameter {
  stockOnHand: SortOrder
  stockAllocated: SortOrder
  outOfStockThreshold: SortOrder
  id: SortOrder
  productId: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  sku: SortOrder
  name: SortOrder
  price: SortOrder
  priceWithTax: SortOrder
  stockLevel: SortOrder
}`}
</GraphQLDoc>

## ProductVariantTranslationInput {#productvarianttranslationinput}

<GraphQLDoc
  type="input"
  typeName="ProductVariantTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input ProductVariantTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  customFields: JSON
}`}
</GraphQLDoc>

## PromotionFilterParameter {#promotionfilterparameter}

<GraphQLDoc
  type="input"
  typeName="PromotionFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    PromotionFilterParameter: '/reference/graphql-api/admin/input-types#promotionfilterparameter',
  }}
>
{`input PromotionFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  startsAt: DateOperators
  endsAt: DateOperators
  couponCode: StringOperators
  perCustomerUsageLimit: NumberOperators
  usageLimit: NumberOperators
  name: StringOperators
  description: StringOperators
  enabled: BooleanOperators
  _and: [PromotionFilterParameter!]
  _or: [PromotionFilterParameter!]
}`}
</GraphQLDoc>

## PromotionListOptions {#promotionlistoptions}

<GraphQLDoc
  type="input"
  typeName="PromotionListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    PromotionSortParameter: '/reference/graphql-api/admin/input-types#promotionsortparameter',
    PromotionFilterParameter: '/reference/graphql-api/admin/input-types#promotionfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input PromotionListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: PromotionSortParameter
  """Allows the results to be filtered"""
  filter: PromotionFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## PromotionSortParameter {#promotionsortparameter}

<GraphQLDoc
  type="input"
  typeName="PromotionSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input PromotionSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  startsAt: SortOrder
  endsAt: SortOrder
  couponCode: SortOrder
  perCustomerUsageLimit: SortOrder
  usageLimit: SortOrder
  name: SortOrder
  description: SortOrder
}`}
</GraphQLDoc>

## PromotionTranslationInput {#promotiontranslationinput}

<GraphQLDoc
  type="input"
  typeName="PromotionTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input PromotionTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  description: String
  customFields: JSON
}`}
</GraphQLDoc>

## ProvinceFilterParameter {#provincefilterparameter}

<GraphQLDoc
  type="input"
  typeName="ProvinceFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    ProvinceFilterParameter: '/reference/graphql-api/admin/input-types#provincefilterparameter',
  }}
>
{`input ProvinceFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  code: StringOperators
  type: StringOperators
  name: StringOperators
  enabled: BooleanOperators
  parentId: IDOperators
  _and: [ProvinceFilterParameter!]
  _or: [ProvinceFilterParameter!]
}`}
</GraphQLDoc>

## ProvinceListOptions {#provincelistoptions}

<GraphQLDoc
  type="input"
  typeName="ProvinceListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    ProvinceSortParameter: '/reference/graphql-api/admin/input-types#provincesortparameter',
    ProvinceFilterParameter: '/reference/graphql-api/admin/input-types#provincefilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input ProvinceListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: ProvinceSortParameter
  """Allows the results to be filtered"""
  filter: ProvinceFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## ProvinceSortParameter {#provincesortparameter}

<GraphQLDoc
  type="input"
  typeName="ProvinceSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input ProvinceSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  code: SortOrder
  type: SortOrder
  name: SortOrder
  parentId: SortOrder
}`}
</GraphQLDoc>

## ProvinceTranslationInput {#provincetranslationinput}

<GraphQLDoc
  type="input"
  typeName="ProvinceTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input ProvinceTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  customFields: JSON
}`}
</GraphQLDoc>

## RefundOrderInput {#refundorderinput}

<GraphQLDoc
  type="input"
  typeName="RefundOrderInput"
  typeLinks={{
    OrderLineInput: '/reference/graphql-api/admin/input-types#orderlineinput',
    Money: '/reference/graphql-api/admin/object-types#money',
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
  }}
>
{`input RefundOrderInput {
  lines: [OrderLineInput!]
  shipping: Money
  adjustment: Money
  """
  The amount to be refunded to this particular payment. This was introduced in v2.2.0 as the preferred way to specify the refund amount.
  Can be as much as the total amount of the payment minus the sum of all previous refunds.
  """
  amount: Money
  paymentId: ID!
  reason: String
}`}
</GraphQLDoc>

## RemoveCollectionsFromChannelInput {#removecollectionsfromchannelinput}

<GraphQLDoc
  type="input"
  typeName="RemoveCollectionsFromChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input RemoveCollectionsFromChannelInput {
  collectionIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## RemoveFacetsFromChannelInput {#removefacetsfromchannelinput}

<GraphQLDoc
  type="input"
  typeName="RemoveFacetsFromChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`input RemoveFacetsFromChannelInput {
  facetIds: [ID!]!
  channelId: ID!
  force: Boolean
}`}
</GraphQLDoc>

## RemovePaymentMethodsFromChannelInput {#removepaymentmethodsfromchannelinput}

<GraphQLDoc
  type="input"
  typeName="RemovePaymentMethodsFromChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input RemovePaymentMethodsFromChannelInput {
  paymentMethodIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## RemoveProductVariantsFromChannelInput {#removeproductvariantsfromchannelinput}

<GraphQLDoc
  type="input"
  typeName="RemoveProductVariantsFromChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input RemoveProductVariantsFromChannelInput {
  productVariantIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## RemoveProductsFromChannelInput {#removeproductsfromchannelinput}

<GraphQLDoc
  type="input"
  typeName="RemoveProductsFromChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input RemoveProductsFromChannelInput {
  productIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## RemovePromotionsFromChannelInput {#removepromotionsfromchannelinput}

<GraphQLDoc
  type="input"
  typeName="RemovePromotionsFromChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input RemovePromotionsFromChannelInput {
  promotionIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## RemoveShippingMethodsFromChannelInput {#removeshippingmethodsfromchannelinput}

<GraphQLDoc
  type="input"
  typeName="RemoveShippingMethodsFromChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input RemoveShippingMethodsFromChannelInput {
  shippingMethodIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## RemoveStockLocationsFromChannelInput {#removestocklocationsfromchannelinput}

<GraphQLDoc
  type="input"
  typeName="RemoveStockLocationsFromChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input RemoveStockLocationsFromChannelInput {
  stockLocationIds: [ID!]!
  channelId: ID!
}`}
</GraphQLDoc>

## RoleFilterParameter {#rolefilterparameter}

<GraphQLDoc
  type="input"
  typeName="RoleFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    RoleFilterParameter: '/reference/graphql-api/admin/input-types#rolefilterparameter',
  }}
>
{`input RoleFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  code: StringOperators
  description: StringOperators
  _and: [RoleFilterParameter!]
  _or: [RoleFilterParameter!]
}`}
</GraphQLDoc>

## RoleListOptions {#rolelistoptions}

<GraphQLDoc
  type="input"
  typeName="RoleListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    RoleSortParameter: '/reference/graphql-api/admin/input-types#rolesortparameter',
    RoleFilterParameter: '/reference/graphql-api/admin/input-types#rolefilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input RoleListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: RoleSortParameter
  """Allows the results to be filtered"""
  filter: RoleFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## RoleSortParameter {#rolesortparameter}

<GraphQLDoc
  type="input"
  typeName="RoleSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input RoleSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  code: SortOrder
  description: SortOrder
}`}
</GraphQLDoc>

## SearchInput {#searchinput}

<GraphQLDoc
  type="input"
  typeName="SearchInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    ID: '/reference/graphql-api/admin/object-types#id',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
    FacetValueFilterInput: '/reference/graphql-api/admin/input-types#facetvaluefilterinput',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    Int: '/reference/graphql-api/admin/object-types#int',
    SearchResultSortParameter: '/reference/graphql-api/admin/input-types#searchresultsortparameter',
  }}
>
{`input SearchInput {
  term: String
  facetValueIds: [ID!]
  facetValueOperator: LogicalOperator
  facetValueFilters: [FacetValueFilterInput!]
  collectionId: ID
  collectionSlug: String
  groupByProduct: Boolean
  take: Int
  skip: Int
  sort: SearchResultSortParameter
}`}
</GraphQLDoc>

## SearchResultSortParameter {#searchresultsortparameter}

<GraphQLDoc
  type="input"
  typeName="SearchResultSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input SearchResultSortParameter {
  name: SortOrder
  price: SortOrder
}`}
</GraphQLDoc>

## SellerFilterParameter {#sellerfilterparameter}

<GraphQLDoc
  type="input"
  typeName="SellerFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    SellerFilterParameter: '/reference/graphql-api/admin/input-types#sellerfilterparameter',
  }}
>
{`input SellerFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  name: StringOperators
  _and: [SellerFilterParameter!]
  _or: [SellerFilterParameter!]
}`}
</GraphQLDoc>

## SellerListOptions {#sellerlistoptions}

<GraphQLDoc
  type="input"
  typeName="SellerListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    SellerSortParameter: '/reference/graphql-api/admin/input-types#sellersortparameter',
    SellerFilterParameter: '/reference/graphql-api/admin/input-types#sellerfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input SellerListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: SellerSortParameter
  """Allows the results to be filtered"""
  filter: SellerFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## SellerSortParameter {#sellersortparameter}

<GraphQLDoc
  type="input"
  typeName="SellerSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input SellerSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
}`}
</GraphQLDoc>

## SetOrderCustomerInput {#setordercustomerinput}

<GraphQLDoc
  type="input"
  typeName="SetOrderCustomerInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
  }}
>
{`input SetOrderCustomerInput {
  orderId: ID!
  customerId: ID!
  note: String
}`}
</GraphQLDoc>

## SettingsStoreInput {#settingsstoreinput}

<GraphQLDoc
  type="input"
  typeName="SettingsStoreInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input SettingsStoreInput {
  key: String!
  value: JSON!
}`}
</GraphQLDoc>

## SettleRefundInput {#settlerefundinput}

<GraphQLDoc
  type="input"
  typeName="SettleRefundInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
  }}
>
{`input SettleRefundInput {
  id: ID!
  transactionId: String!
}`}
</GraphQLDoc>

## ShippingMethodFilterParameter {#shippingmethodfilterparameter}

<GraphQLDoc
  type="input"
  typeName="ShippingMethodFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    ShippingMethodFilterParameter: '/reference/graphql-api/admin/input-types#shippingmethodfilterparameter',
  }}
>
{`input ShippingMethodFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  code: StringOperators
  name: StringOperators
  description: StringOperators
  fulfillmentHandlerCode: StringOperators
  _and: [ShippingMethodFilterParameter!]
  _or: [ShippingMethodFilterParameter!]
}`}
</GraphQLDoc>

## ShippingMethodListOptions {#shippingmethodlistoptions}

<GraphQLDoc
  type="input"
  typeName="ShippingMethodListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    ShippingMethodSortParameter: '/reference/graphql-api/admin/input-types#shippingmethodsortparameter',
    ShippingMethodFilterParameter: '/reference/graphql-api/admin/input-types#shippingmethodfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input ShippingMethodListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: ShippingMethodSortParameter
  """Allows the results to be filtered"""
  filter: ShippingMethodFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## ShippingMethodSortParameter {#shippingmethodsortparameter}

<GraphQLDoc
  type="input"
  typeName="ShippingMethodSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input ShippingMethodSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  code: SortOrder
  name: SortOrder
  description: SortOrder
  fulfillmentHandlerCode: SortOrder
}`}
</GraphQLDoc>

## ShippingMethodTranslationInput {#shippingmethodtranslationinput}

<GraphQLDoc
  type="input"
  typeName="ShippingMethodTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input ShippingMethodTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  description: String
  customFields: JSON
}`}
</GraphQLDoc>

## SlugForEntityInput {#slugforentityinput}

<GraphQLDoc
  type="input"
  typeName="SlugForEntityInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    ID: '/reference/graphql-api/admin/object-types#id',
  }}
>
{`input SlugForEntityInput {
  entityName: String!
  fieldName: String!
  inputValue: String!
  entityId: ID
}`}
</GraphQLDoc>

## StockLevelInput {#stocklevelinput}

<GraphQLDoc
  type="input"
  typeName="StockLevelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Int: '/reference/graphql-api/admin/object-types#int',
  }}
>
{`input StockLevelInput {
  stockLocationId: ID!
  stockOnHand: Int!
}`}
</GraphQLDoc>

## StockLocationFilterParameter {#stocklocationfilterparameter}

<GraphQLDoc
  type="input"
  typeName="StockLocationFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    StockLocationFilterParameter: '/reference/graphql-api/admin/input-types#stocklocationfilterparameter',
  }}
>
{`input StockLocationFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  name: StringOperators
  description: StringOperators
  _and: [StockLocationFilterParameter!]
  _or: [StockLocationFilterParameter!]
}`}
</GraphQLDoc>

## StockLocationListOptions {#stocklocationlistoptions}

<GraphQLDoc
  type="input"
  typeName="StockLocationListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    StockLocationSortParameter: '/reference/graphql-api/admin/input-types#stocklocationsortparameter',
    StockLocationFilterParameter: '/reference/graphql-api/admin/input-types#stocklocationfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input StockLocationListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: StockLocationSortParameter
  """Allows the results to be filtered"""
  filter: StockLocationFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## StockLocationSortParameter {#stocklocationsortparameter}

<GraphQLDoc
  type="input"
  typeName="StockLocationSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input StockLocationSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
  description: SortOrder
}`}
</GraphQLDoc>

## StockMovementListOptions {#stockmovementlistoptions}

<GraphQLDoc
  type="input"
  typeName="StockMovementListOptions"
  typeLinks={{
    StockMovementType: '/reference/graphql-api/admin/enums#stockmovementtype',
    Int: '/reference/graphql-api/admin/object-types#int',
  }}
>
{`input StockMovementListOptions {
  type: StockMovementType
  skip: Int
  take: Int
}`}
</GraphQLDoc>

## StringListOperators {#stringlistoperators}

<GraphQLDoc
  type="input"
  typeName="StringListOperators"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
  }}
>
{`"""Operators for filtering on a list of String fields"""
input StringListOperators {
  inList: String!
}`}
</GraphQLDoc>

## StringOperators {#stringoperators}

<GraphQLDoc
  type="input"
  typeName="StringOperators"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`"""Operators for filtering on a String field"""
input StringOperators {
  eq: String
  notEq: String
  contains: String
  notContains: String
  in: [String!]
  notIn: [String!]
  regex: String
  isNull: Boolean
}`}
</GraphQLDoc>

## SurchargeInput {#surchargeinput}

<GraphQLDoc
  type="input"
  typeName="SurchargeInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    Money: '/reference/graphql-api/admin/object-types#money',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    Float: '/reference/graphql-api/admin/object-types#float',
  }}
>
{`input SurchargeInput {
  description: String!
  sku: String
  price: Money!
  priceIncludesTax: Boolean!
  taxRate: Float
  taxDescription: String
}`}
</GraphQLDoc>

## TagFilterParameter {#tagfilterparameter}

<GraphQLDoc
  type="input"
  typeName="TagFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    TagFilterParameter: '/reference/graphql-api/admin/input-types#tagfilterparameter',
  }}
>
{`input TagFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  value: StringOperators
  _and: [TagFilterParameter!]
  _or: [TagFilterParameter!]
}`}
</GraphQLDoc>

## TagListOptions {#taglistoptions}

<GraphQLDoc
  type="input"
  typeName="TagListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    TagSortParameter: '/reference/graphql-api/admin/input-types#tagsortparameter',
    TagFilterParameter: '/reference/graphql-api/admin/input-types#tagfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input TagListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: TagSortParameter
  """Allows the results to be filtered"""
  filter: TagFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## TagSortParameter {#tagsortparameter}

<GraphQLDoc
  type="input"
  typeName="TagSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input TagSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  value: SortOrder
}`}
</GraphQLDoc>

## TaxCategoryFilterParameter {#taxcategoryfilterparameter}

<GraphQLDoc
  type="input"
  typeName="TaxCategoryFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    TaxCategoryFilterParameter: '/reference/graphql-api/admin/input-types#taxcategoryfilterparameter',
  }}
>
{`input TaxCategoryFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  name: StringOperators
  isDefault: BooleanOperators
  _and: [TaxCategoryFilterParameter!]
  _or: [TaxCategoryFilterParameter!]
}`}
</GraphQLDoc>

## TaxCategoryListOptions {#taxcategorylistoptions}

<GraphQLDoc
  type="input"
  typeName="TaxCategoryListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    TaxCategorySortParameter: '/reference/graphql-api/admin/input-types#taxcategorysortparameter',
    TaxCategoryFilterParameter: '/reference/graphql-api/admin/input-types#taxcategoryfilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input TaxCategoryListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: TaxCategorySortParameter
  """Allows the results to be filtered"""
  filter: TaxCategoryFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## TaxCategorySortParameter {#taxcategorysortparameter}

<GraphQLDoc
  type="input"
  typeName="TaxCategorySortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input TaxCategorySortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
}`}
</GraphQLDoc>

## TaxRateFilterParameter {#taxratefilterparameter}

<GraphQLDoc
  type="input"
  typeName="TaxRateFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
    NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
    TaxRateFilterParameter: '/reference/graphql-api/admin/input-types#taxratefilterparameter',
  }}
>
{`input TaxRateFilterParameter {
  zoneId: IDOperators
  categoryId: IDOperators
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  name: StringOperators
  enabled: BooleanOperators
  value: NumberOperators
  _and: [TaxRateFilterParameter!]
  _or: [TaxRateFilterParameter!]
}`}
</GraphQLDoc>

## TaxRateListOptions {#taxratelistoptions}

<GraphQLDoc
  type="input"
  typeName="TaxRateListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    TaxRateSortParameter: '/reference/graphql-api/admin/input-types#taxratesortparameter',
    TaxRateFilterParameter: '/reference/graphql-api/admin/input-types#taxratefilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input TaxRateListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: TaxRateSortParameter
  """Allows the results to be filtered"""
  filter: TaxRateFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## TaxRateSortParameter {#taxratesortparameter}

<GraphQLDoc
  type="input"
  typeName="TaxRateSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input TaxRateSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
  value: SortOrder
}`}
</GraphQLDoc>

## TestEligibleShippingMethodsInput {#testeligibleshippingmethodsinput}

<GraphQLDoc
  type="input"
  typeName="TestEligibleShippingMethodsInput"
  typeLinks={{
    CreateAddressInput: '/reference/graphql-api/admin/input-types#createaddressinput',
    TestShippingMethodOrderLineInput: '/reference/graphql-api/admin/input-types#testshippingmethodorderlineinput',
  }}
>
{`input TestEligibleShippingMethodsInput {
  shippingAddress: CreateAddressInput!
  lines: [TestShippingMethodOrderLineInput!]!
}`}
</GraphQLDoc>

## TestShippingMethodInput {#testshippingmethodinput}

<GraphQLDoc
  type="input"
  typeName="TestShippingMethodInput"
  typeLinks={{
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
    CreateAddressInput: '/reference/graphql-api/admin/input-types#createaddressinput',
    TestShippingMethodOrderLineInput: '/reference/graphql-api/admin/input-types#testshippingmethodorderlineinput',
  }}
>
{`input TestShippingMethodInput {
  checker: ConfigurableOperationInput!
  calculator: ConfigurableOperationInput!
  shippingAddress: CreateAddressInput!
  lines: [TestShippingMethodOrderLineInput!]!
}`}
</GraphQLDoc>

## TestShippingMethodOrderLineInput {#testshippingmethodorderlineinput}

<GraphQLDoc
  type="input"
  typeName="TestShippingMethodOrderLineInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Int: '/reference/graphql-api/admin/object-types#int',
  }}
>
{`input TestShippingMethodOrderLineInput {
  productVariantId: ID!
  quantity: Int!
}`}
</GraphQLDoc>

## UpdateActiveAdministratorInput {#updateactiveadministratorinput}

<GraphQLDoc
  type="input"
  typeName="UpdateActiveAdministratorInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateActiveAdministratorInput {
  firstName: String
  lastName: String
  emailAddress: String
  password: String
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateAddressInput {#updateaddressinput}

<GraphQLDoc
  type="input"
  typeName="UpdateAddressInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`"""
Input used to update an Address.

The countryCode must correspond to a \`code\` property of a Country that has been defined in the
Vendure server. The \`code\` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
If an invalid code is passed, the mutation will fail.
"""
input UpdateAddressInput {
  id: ID!
  fullName: String
  company: String
  streetLine1: String
  streetLine2: String
  city: String
  province: String
  postalCode: String
  countryCode: String
  phoneNumber: String
  defaultShippingAddress: Boolean
  defaultBillingAddress: Boolean
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateAdministratorInput {#updateadministratorinput}

<GraphQLDoc
  type="input"
  typeName="UpdateAdministratorInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateAdministratorInput {
  id: ID!
  firstName: String
  lastName: String
  emailAddress: String
  password: String
  roleIds: [ID!]
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateAssetInput {#updateassetinput}

<GraphQLDoc
  type="input"
  typeName="UpdateAssetInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    CoordinateInput: '/reference/graphql-api/admin/input-types#coordinateinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateAssetInput {
  id: ID!
  name: String
  focalPoint: CoordinateInput
  tags: [String!]
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateChannelInput {#updatechannelinput}

<GraphQLDoc
  type="input"
  typeName="UpdateChannelInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
    Int: '/reference/graphql-api/admin/object-types#int',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateChannelInput {
  id: ID!
  code: String
  token: String
  defaultLanguageCode: LanguageCode
  availableLanguageCodes: [LanguageCode!]
  pricesIncludeTax: Boolean
  currencyCode: CurrencyCode
  defaultCurrencyCode: CurrencyCode
  availableCurrencyCodes: [CurrencyCode!]
  trackInventory: Boolean
  outOfStockThreshold: Int
  defaultTaxZoneId: ID
  defaultShippingZoneId: ID
  sellerId: ID
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateCollectionInput {#updatecollectioninput}

<GraphQLDoc
  type="input"
  typeName="UpdateCollectionInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
    UpdateCollectionTranslationInput: '/reference/graphql-api/admin/input-types#updatecollectiontranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateCollectionInput {
  id: ID!
  isPrivate: Boolean
  featuredAssetId: ID
  parentId: ID
  assetIds: [ID!]
  inheritFilters: Boolean
  filters: [ConfigurableOperationInput!]
  translations: [UpdateCollectionTranslationInput!]
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateCollectionTranslationInput {#updatecollectiontranslationinput}

<GraphQLDoc
  type="input"
  typeName="UpdateCollectionTranslationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateCollectionTranslationInput {
  id: ID
  languageCode: LanguageCode!
  name: String
  slug: String
  description: String
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateCountryInput {#updatecountryinput}

<GraphQLDoc
  type="input"
  typeName="UpdateCountryInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    CountryTranslationInput: '/reference/graphql-api/admin/input-types#countrytranslationinput',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateCountryInput {
  id: ID!
  code: String
  translations: [CountryTranslationInput!]
  enabled: Boolean
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateCustomerGroupInput {#updatecustomergroupinput}

<GraphQLDoc
  type="input"
  typeName="UpdateCustomerGroupInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateCustomerGroupInput {
  id: ID!
  name: String
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateCustomerInput {#updatecustomerinput}

<GraphQLDoc
  type="input"
  typeName="UpdateCustomerInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateCustomerInput {
  id: ID!
  title: String
  firstName: String
  lastName: String
  phoneNumber: String
  emailAddress: String
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateCustomerNoteInput {#updatecustomernoteinput}

<GraphQLDoc
  type="input"
  typeName="UpdateCustomerNoteInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
  }}
>
{`input UpdateCustomerNoteInput {
  noteId: ID!
  note: String!
}`}
</GraphQLDoc>

## UpdateFacetInput {#updatefacetinput}

<GraphQLDoc
  type="input"
  typeName="UpdateFacetInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    String: '/reference/graphql-api/admin/object-types#string',
    FacetTranslationInput: '/reference/graphql-api/admin/input-types#facettranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateFacetInput {
  id: ID!
  isPrivate: Boolean
  code: String
  translations: [FacetTranslationInput!]
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateFacetValueInput {#updatefacetvalueinput}

<GraphQLDoc
  type="input"
  typeName="UpdateFacetValueInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    FacetValueTranslationInput: '/reference/graphql-api/admin/input-types#facetvaluetranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateFacetValueInput {
  id: ID!
  code: String
  translations: [FacetValueTranslationInput!]
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateGlobalSettingsInput {#updateglobalsettingsinput}

<GraphQLDoc
  type="input"
  typeName="UpdateGlobalSettingsInput"
  typeLinks={{
    LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    Int: '/reference/graphql-api/admin/object-types#int',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateGlobalSettingsInput {
  availableLanguages: [LanguageCode!]
  trackInventory: Boolean
  outOfStockThreshold: Int
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateOrderAddressInput {#updateorderaddressinput}

<GraphQLDoc
  type="input"
  typeName="UpdateOrderAddressInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
  }}
>
{`input UpdateOrderAddressInput {
  fullName: String
  company: String
  streetLine1: String
  streetLine2: String
  city: String
  province: String
  postalCode: String
  countryCode: String
  phoneNumber: String
}`}
</GraphQLDoc>

## UpdateOrderInput {#updateorderinput}

<GraphQLDoc
  type="input"
  typeName="UpdateOrderInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateOrderInput {
  id: ID!
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateOrderNoteInput {#updateordernoteinput}

<GraphQLDoc
  type="input"
  typeName="UpdateOrderNoteInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`input UpdateOrderNoteInput {
  noteId: ID!
  note: String
  isPublic: Boolean
}`}
</GraphQLDoc>

## UpdatePaymentMethodInput {#updatepaymentmethodinput}

<GraphQLDoc
  type="input"
  typeName="UpdatePaymentMethodInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
    PaymentMethodTranslationInput: '/reference/graphql-api/admin/input-types#paymentmethodtranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdatePaymentMethodInput {
  id: ID!
  code: String
  enabled: Boolean
  checker: ConfigurableOperationInput
  handler: ConfigurableOperationInput
  translations: [PaymentMethodTranslationInput!]
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateProductInput {#updateproductinput}

<GraphQLDoc
  type="input"
  typeName="UpdateProductInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    ProductTranslationInput: '/reference/graphql-api/admin/input-types#producttranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateProductInput {
  id: ID!
  enabled: Boolean
  featuredAssetId: ID
  assetIds: [ID!]
  facetValueIds: [ID!]
  translations: [ProductTranslationInput!]
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateProductOptionGroupInput {#updateproductoptiongroupinput}

<GraphQLDoc
  type="input"
  typeName="UpdateProductOptionGroupInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    ProductOptionGroupTranslationInput: '/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateProductOptionGroupInput {
  id: ID!
  code: String
  translations: [ProductOptionGroupTranslationInput!]
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateProductOptionInput {#updateproductoptioninput}

<GraphQLDoc
  type="input"
  typeName="UpdateProductOptionInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    ProductOptionGroupTranslationInput: '/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateProductOptionInput {
  id: ID!
  code: String
  translations: [ProductOptionGroupTranslationInput!]
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateProductVariantInput {#updateproductvariantinput}

<GraphQLDoc
  type="input"
  typeName="UpdateProductVariantInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    ProductVariantTranslationInput: '/reference/graphql-api/admin/input-types#productvarianttranslationinput',
    String: '/reference/graphql-api/admin/object-types#string',
    Money: '/reference/graphql-api/admin/object-types#money',
    UpdateProductVariantPriceInput: '/reference/graphql-api/admin/input-types#updateproductvariantpriceinput',
    Int: '/reference/graphql-api/admin/object-types#int',
    StockLevelInput: '/reference/graphql-api/admin/input-types#stocklevelinput',
    GlobalFlag: '/reference/graphql-api/admin/enums#globalflag',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateProductVariantInput {
  id: ID!
  enabled: Boolean
  translations: [ProductVariantTranslationInput!]
  facetValueIds: [ID!]
  optionIds: [ID!]
  sku: String
  taxCategoryId: ID
  """Sets the price for the ProductVariant in the Channel's default currency"""
  price: Money
  """Allows multiple prices to be set for the ProductVariant in different currencies."""
  prices: [UpdateProductVariantPriceInput!]
  featuredAssetId: ID
  assetIds: [ID!]
  stockOnHand: Int
  stockLevels: [StockLevelInput!]
  outOfStockThreshold: Int
  useGlobalOutOfStockThreshold: Boolean
  trackInventory: GlobalFlag
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateProductVariantPriceInput {#updateproductvariantpriceinput}

<GraphQLDoc
  type="input"
  typeName="UpdateProductVariantPriceInput"
  typeLinks={{
    CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
    Money: '/reference/graphql-api/admin/object-types#money',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`"""
Used to set up update the price of a ProductVariant in a particular Channel.
If the \`delete\` flag is \`true\`, the price will be deleted for the given Channel.
"""
input UpdateProductVariantPriceInput {
  currencyCode: CurrencyCode!
  price: Money!
  delete: Boolean
  customFields: JSON
}`}
</GraphQLDoc>

## UpdatePromotionInput {#updatepromotioninput}

<GraphQLDoc
  type="input"
  typeName="UpdatePromotionInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    DateTime: '/reference/graphql-api/admin/object-types#datetime',
    String: '/reference/graphql-api/admin/object-types#string',
    Int: '/reference/graphql-api/admin/object-types#int',
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
    PromotionTranslationInput: '/reference/graphql-api/admin/input-types#promotiontranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdatePromotionInput {
  id: ID!
  enabled: Boolean
  startsAt: DateTime
  endsAt: DateTime
  couponCode: String
  perCustomerUsageLimit: Int
  usageLimit: Int
  conditions: [ConfigurableOperationInput!]
  actions: [ConfigurableOperationInput!]
  translations: [PromotionTranslationInput!]
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateProvinceInput {#updateprovinceinput}

<GraphQLDoc
  type="input"
  typeName="UpdateProvinceInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    ProvinceTranslationInput: '/reference/graphql-api/admin/input-types#provincetranslationinput',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateProvinceInput {
  id: ID!
  code: String
  translations: [ProvinceTranslationInput!]
  enabled: Boolean
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateRoleInput {#updateroleinput}

<GraphQLDoc
  type="input"
  typeName="UpdateRoleInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    Permission: '/reference/graphql-api/admin/enums#permission',
  }}
>
{`input UpdateRoleInput {
  id: ID!
  code: String
  description: String
  permissions: [Permission!]
  channelIds: [ID!]
}`}
</GraphQLDoc>

## UpdateScheduledTaskInput {#updatescheduledtaskinput}

<GraphQLDoc
  type="input"
  typeName="UpdateScheduledTaskInput"
  typeLinks={{
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
  }}
>
{`input UpdateScheduledTaskInput {
  id: String!
  enabled: Boolean
}`}
</GraphQLDoc>

## UpdateSellerInput {#updatesellerinput}

<GraphQLDoc
  type="input"
  typeName="UpdateSellerInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateSellerInput {
  id: ID!
  name: String
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateShippingMethodInput {#updateshippingmethodinput}

<GraphQLDoc
  type="input"
  typeName="UpdateShippingMethodInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
    ShippingMethodTranslationInput: '/reference/graphql-api/admin/input-types#shippingmethodtranslationinput',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateShippingMethodInput {
  id: ID!
  code: String
  fulfillmentHandler: String
  checker: ConfigurableOperationInput
  calculator: ConfigurableOperationInput
  translations: [ShippingMethodTranslationInput!]!
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateStockLocationInput {#updatestocklocationinput}

<GraphQLDoc
  type="input"
  typeName="UpdateStockLocationInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateStockLocationInput {
  id: ID!
  name: String
  description: String
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateTagInput {#updatetaginput}

<GraphQLDoc
  type="input"
  typeName="UpdateTagInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
  }}
>
{`input UpdateTagInput {
  id: ID!
  value: String
}`}
</GraphQLDoc>

## UpdateTaxCategoryInput {#updatetaxcategoryinput}

<GraphQLDoc
  type="input"
  typeName="UpdateTaxCategoryInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateTaxCategoryInput {
  id: ID!
  name: String
  isDefault: Boolean
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateTaxRateInput {#updatetaxrateinput}

<GraphQLDoc
  type="input"
  typeName="UpdateTaxRateInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    Float: '/reference/graphql-api/admin/object-types#float',
    Boolean: '/reference/graphql-api/admin/object-types#boolean',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateTaxRateInput {
  id: ID!
  name: String
  value: Float
  enabled: Boolean
  categoryId: ID
  zoneId: ID
  customerGroupId: ID
  customFields: JSON
}`}
</GraphQLDoc>

## UpdateZoneInput {#updatezoneinput}

<GraphQLDoc
  type="input"
  typeName="UpdateZoneInput"
  typeLinks={{
    ID: '/reference/graphql-api/admin/object-types#id',
    String: '/reference/graphql-api/admin/object-types#string',
    JSON: '/reference/graphql-api/admin/object-types#json',
  }}
>
{`input UpdateZoneInput {
  id: ID!
  name: String
  customFields: JSON
}`}
</GraphQLDoc>

## ZoneFilterParameter {#zonefilterparameter}

<GraphQLDoc
  type="input"
  typeName="ZoneFilterParameter"
  typeLinks={{
    IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
    DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
    StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
    ZoneFilterParameter: '/reference/graphql-api/admin/input-types#zonefilterparameter',
  }}
>
{`input ZoneFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  name: StringOperators
  _and: [ZoneFilterParameter!]
  _or: [ZoneFilterParameter!]
}`}
</GraphQLDoc>

## ZoneListOptions {#zonelistoptions}

<GraphQLDoc
  type="input"
  typeName="ZoneListOptions"
  typeLinks={{
    Int: '/reference/graphql-api/admin/object-types#int',
    ZoneSortParameter: '/reference/graphql-api/admin/input-types#zonesortparameter',
    ZoneFilterParameter: '/reference/graphql-api/admin/input-types#zonefilterparameter',
    LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
  }}
>
{`input ZoneListOptions {
  """Skips the first n results, for use in pagination"""
  skip: Int
  """Takes n results, for use in pagination"""
  take: Int
  """Specifies which properties to sort the results by"""
  sort: ZoneSortParameter
  """Allows the results to be filtered"""
  filter: ZoneFilterParameter
  """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
  filterOperator: LogicalOperator
}`}
</GraphQLDoc>

## ZoneSortParameter {#zonesortparameter}

<GraphQLDoc
  type="input"
  typeName="ZoneSortParameter"
  typeLinks={{
    SortOrder: '/reference/graphql-api/admin/enums#sortorder',
  }}
>
{`input ZoneSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
}`}
</GraphQLDoc>
