Input Objects

input AddItemInput {
  productVariantId: ID!
  quantity: Int!
}

input AuthenticationInput {
  native: NativeAuthInput
}

"""Operators for filtering on a list of Boolean fields"""
input BooleanListOperators {
  inList: Boolean!
}

"""Operators for filtering on a Boolean field"""
input BooleanOperators {
  eq: Boolean
  isNull: Boolean
}

input CollectionFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  name: StringOperators
  slug: StringOperators
  position: NumberOperators
  description: StringOperators
  parentId: IDOperators
  productVariantCount: NumberOperators
  _and: [CollectionFilterParameter!]
  _or: [CollectionFilterParameter!]
}

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
}

input CollectionSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
  slug: SortOrder
  position: SortOrder
  description: SortOrder
  parentId: SortOrder
  productVariantCount: SortOrder
}

input ConfigArgInput {
  name: String!
  """A JSON stringified representation of the actual value"""
  value: String!
}

input ConfigurableOperationInput {
  code: String!
  arguments: [ConfigArgInput!]!
}

"""
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
}

input CreateCustomerInput {
  title: String
  firstName: String!
  lastName: String!
  phoneNumber: String
  emailAddress: String!
  customFields: JSON
}

input CustomerFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  title: StringOperators
  firstName: StringOperators
  lastName: StringOperators
  phoneNumber: StringOperators
  emailAddress: StringOperators
  _and: [CustomerFilterParameter!]
  _or: [CustomerFilterParameter!]
}

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
}

input CustomerSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  title: SortOrder
  firstName: SortOrder
  lastName: SortOrder
  phoneNumber: SortOrder
  emailAddress: SortOrder
}

"""Operators for filtering on a list of Date fields"""
input DateListOperators {
  inList: DateTime!
}

"""Operators for filtering on a DateTime field"""
input DateOperators {
  eq: DateTime
  before: DateTime
  after: DateTime
  between: DateRange
  isNull: Boolean
}

input DateRange {
  start: DateTime!
  end: DateTime!
}

input FacetFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  name: StringOperators
  code: StringOperators
  _and: [FacetFilterParameter!]
  _or: [FacetFilterParameter!]
}

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
}

input FacetSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
  code: SortOrder
}

"""
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!]
}

input FacetValueFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  facetId: IDOperators
  name: StringOperators
  code: StringOperators
  _and: [FacetValueFilterParameter!]
  _or: [FacetValueFilterParameter!]
}

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
}

input FacetValueSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  facetId: SortOrder
  name: SortOrder
  code: SortOrder
}

input HistoryEntryFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  type: StringOperators
  _and: [HistoryEntryFilterParameter!]
  _or: [HistoryEntryFilterParameter!]
}

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
}

input HistoryEntrySortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
}

"""Operators for filtering on a list of ID fields"""
input IDListOperators {
  inList: ID!
}

"""Operators for filtering on an ID field"""
input IDOperators {
  eq: String
  notEq: String
  in: [String!]
  notIn: [String!]
  isNull: Boolean
}

input NativeAuthInput {
  username: String!
  password: String!
}

"""Operators for filtering on a list of Number fields"""
input NumberListOperators {
  inList: Float!
}

"""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
}

input NumberRange {
  start: Float!
  end: Float!
}

input OrderFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  type: StringOperators
  """
  The date & time that the Order was placed, i.e. the Customer
  completed the checkout and the Order is no longer "active"
  """
  orderPlacedAt: DateOperators
  """A unique code for the Order"""
  code: StringOperators
  state: StringOperators
  """An order is active as long as the payment process has not been completed"""
  active: BooleanOperators
  totalQuantity: NumberOperators
  """
  The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
  discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.
  To get a total of all OrderLines which does not account for prorated discounts, use the
  sum of `OrderLine.discountedLinePrice` values.
  """
  subTotal: NumberOperators
  """Same as subTotal, but inclusive of tax"""
  subTotalWithTax: NumberOperators
  currencyCode: StringOperators
  shipping: NumberOperators
  shippingWithTax: NumberOperators
  """Equal to subTotal plus shipping"""
  total: NumberOperators
  """The final payable amount. Equal to subTotalWithTax plus shippingWithTax"""
  totalWithTax: NumberOperators
  _and: [OrderFilterParameter!]
  _or: [OrderFilterParameter!]
}

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
}

input OrderSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  """
  The date & time that the Order was placed, i.e. the Customer
  completed the checkout and the Order is no longer "active"
  """
  orderPlacedAt: SortOrder
  """A unique code for the Order"""
  code: SortOrder
  state: SortOrder
  totalQuantity: SortOrder
  """
  The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
  discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.
  To get a total of all OrderLines which does not account for prorated discounts, use the
  sum of `OrderLine.discountedLinePrice` values.
  """
  subTotal: SortOrder
  """Same as subTotal, but inclusive of tax"""
  subTotalWithTax: SortOrder
  shipping: SortOrder
  shippingWithTax: SortOrder
  """Equal to subTotal plus shipping"""
  total: SortOrder
  """The final payable amount. Equal to subTotalWithTax plus shippingWithTax"""
  totalWithTax: SortOrder
}

"""Passed as input to the `addPaymentToOrder` mutation."""
input PaymentInput {
  """This field should correspond to the `code` property of a PaymentMethod."""
  method: String!
  """
  This field should contain arbitrary data passed to the specified PaymentMethodHandler's `createPayment()` method
  as the "metadata" argument. For example, it could contain an ID for the payment and other
  data generated by the payment provider.
  """
  metadata: JSON!
}

input ProductFilterParameter {
  id: IDOperators
  createdAt: DateOperators
  updatedAt: DateOperators
  languageCode: StringOperators
  name: StringOperators
  slug: StringOperators
  description: StringOperators
  enabled: BooleanOperators
  _and: [ProductFilterParameter!]
  _or: [ProductFilterParameter!]
}

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
}

input ProductSortParameter {
  id: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  name: SortOrder
  slug: SortOrder
  description: SortOrder
}

input ProductVariantFilterParameter {
  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!]
}

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
}

input ProductVariantSortParameter {
  id: SortOrder
  productId: SortOrder
  createdAt: SortOrder
  updatedAt: SortOrder
  sku: SortOrder
  name: SortOrder
  price: SortOrder
  priceWithTax: SortOrder
  stockLevel: SortOrder
}

input RegisterCustomerInput {
  emailAddress: String!
  title: String
  firstName: String
  lastName: String
  phoneNumber: String
  password: String
}

input SearchInput {
  term: String
  facetValueIds: [ID!]
  facetValueOperator: LogicalOperator
  facetValueFilters: [FacetValueFilterInput!]
  collectionId: ID
  collectionIds: [ID!]
  collectionSlug: String
  collectionSlugs: [String!]
  groupByProduct: Boolean
  take: Int
  skip: Int
  sort: SearchResultSortParameter
}

input SearchResultSortParameter {
  name: SortOrder
  price: SortOrder
}

"""Operators for filtering on a list of String fields"""
input StringListOperators {
  inList: String!
}

"""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
}

"""
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
}

input UpdateCustomerInput {
  title: String
  firstName: String
  lastName: String
  phoneNumber: String
  customFields: JSON
}

input UpdateOrderInput {
  customFields: JSON
}