*** title: "Input Objects" generated: true --------------- ## AddItemInput \ {`input AddItemInput { productVariantId: ID! quantity: Int! }`} ## AddItemToDraftOrderInput \ {`input AddItemToDraftOrderInput { productVariantId: ID! quantity: Int! }`} ## AddNoteToCustomerInput \ {`input AddNoteToCustomerInput { id: ID! note: String! isPublic: Boolean! }`} ## AddNoteToOrderInput \ {`input AddNoteToOrderInput { id: ID! note: String! isPublic: Boolean! }`} ## AdjustDraftOrderLineInput \ {`input AdjustDraftOrderLineInput { orderLineId: ID! quantity: Int! }`} ## AdministratorFilterParameter \ {`input AdministratorFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators firstName: StringOperators lastName: StringOperators emailAddress: StringOperators _and: [AdministratorFilterParameter!] _or: [AdministratorFilterParameter!] }`} ## AdministratorListOptions \ {`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 }`} ## AdministratorPaymentInput \ {`input AdministratorPaymentInput { paymentMethod: String metadata: JSON }`} ## AdministratorRefundInput \ {`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 }\`} ## AdministratorSortParameter \ {`input AdministratorSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder firstName: SortOrder lastName: SortOrder emailAddress: SortOrder }`} ## ApiKeyFilterParameter \ {`input ApiKeyFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators """ ID by which we can look up the API-Key. Also helps you identify keys without leaking the underlying secret API-Key. """ lookupId: StringOperators """Helps you identify unused keys""" lastUsedAt: DateOperators """A descriptive name so you can remind yourself where the API-Key gets used""" name: StringOperators _and: [ApiKeyFilterParameter!] _or: [ApiKeyFilterParameter!] }`} ## ApiKeyListOptions \ {`input ApiKeyListOptions { """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: ApiKeySortParameter """Allows the results to be filtered""" filter: ApiKeyFilterParameter """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.""" filterOperator: LogicalOperator }`} ## ApiKeySortParameter \ {`input ApiKeySortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder """ ID by which we can look up the API-Key. Also helps you identify keys without leaking the underlying secret API-Key. """ lookupId: SortOrder """Helps you identify unused keys""" lastUsedAt: SortOrder """A descriptive name so you can remind yourself where the API-Key gets used""" name: SortOrder }`} ## AssetFilterParameter \ {`input AssetFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators languageCode: StringOperators name: StringOperators type: StringOperators fileSize: NumberOperators mimeType: StringOperators width: NumberOperators height: NumberOperators source: StringOperators preview: StringOperators _and: [AssetFilterParameter!] _or: [AssetFilterParameter!] }`} ## AssetListOptions \ {`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 }`} ## AssetSortParameter \ {`input AssetSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder name: SortOrder fileSize: SortOrder mimeType: SortOrder width: SortOrder height: SortOrder source: SortOrder preview: SortOrder }`} ## AssetTranslationInput \ {`input AssetTranslationInput { id: ID languageCode: LanguageCode! name: String customFields: JSON }`} ## AssignAssetsToChannelInput \ {`input AssignAssetsToChannelInput { assetIds: [ID!]! channelId: ID! }`} ## AssignCollectionsToChannelInput \ {`input AssignCollectionsToChannelInput { collectionIds: [ID!]! channelId: ID! }`} ## AssignFacetsToChannelInput \ {`input AssignFacetsToChannelInput { facetIds: [ID!]! channelId: ID! }`} ## AssignPaymentMethodsToChannelInput \ {`input AssignPaymentMethodsToChannelInput { paymentMethodIds: [ID!]! channelId: ID! }`} ## AssignProductOptionGroupsToChannelInput \ {`input AssignProductOptionGroupsToChannelInput { productOptionGroupIds: [ID!]! channelId: ID! }`} ## AssignProductVariantsToChannelInput \ {`input AssignProductVariantsToChannelInput { productVariantIds: [ID!]! channelId: ID! priceFactor: Float }`} ## AssignProductsToChannelInput \ {`input AssignProductsToChannelInput { productIds: [ID!]! channelId: ID! priceFactor: Float }`} ## AssignPromotionsToChannelInput \ {`input AssignPromotionsToChannelInput { promotionIds: [ID!]! channelId: ID! }`} ## AssignShippingMethodsToChannelInput \ {`input AssignShippingMethodsToChannelInput { shippingMethodIds: [ID!]! channelId: ID! }`} ## AssignStockLocationsToChannelInput \ {`input AssignStockLocationsToChannelInput { stockLocationIds: [ID!]! channelId: ID! }`} ## AuthenticationInput \ {`input AuthenticationInput { native: NativeAuthInput }`} ## BooleanListOperators \ {`"""Operators for filtering on a list of Boolean fields""" input BooleanListOperators { inList: Boolean! }`} ## BooleanOperators \ {`"""Operators for filtering on a Boolean field""" input BooleanOperators { eq: Boolean isNull: Boolean }`} ## CancelOrderInput \ {`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 }`} ## ChannelFilterParameter \ {`input ChannelFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators code: StringOperators token: StringOperators defaultLanguageCode: StringOperators currencyCode: StringOperators defaultCurrencyCode: StringOperators """Not yet used - will be implemented in a future release.""" trackInventory: BooleanOperators """Not yet used - will be implemented in a future release.""" outOfStockThreshold: NumberOperators pricesIncludeTax: BooleanOperators _and: [ChannelFilterParameter!] _or: [ChannelFilterParameter!] }`} ## ChannelListOptions \ {`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 }`} ## ChannelSortParameter \ {`input ChannelSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder code: SortOrder token: SortOrder """Not yet used - will be implemented in a future release.""" outOfStockThreshold: SortOrder }`} ## 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 productVariantCount: NumberOperators _and: [CollectionFilterParameter!] _or: [CollectionFilterParameter!] }`} ## CollectionListOptions \ {`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 }`} ## CollectionSortParameter \ {`input CollectionSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder name: SortOrder slug: SortOrder position: SortOrder description: SortOrder parentId: SortOrder productVariantCount: SortOrder }`} ## ConfigArgInput \ {`input ConfigArgInput { name: String! """A JSON stringified representation of the actual value""" value: String! }`} ## ConfigurableOperationInput \ {`input ConfigurableOperationInput { code: String! arguments: [ConfigArgInput!]! }`} ## CoordinateInput \ {`input CoordinateInput { x: Float! y: Float! }`} ## 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!] }`} ## CountryListOptions \ {`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 }`} ## CountrySortParameter \ {`input CountrySortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder code: SortOrder type: SortOrder name: SortOrder parentId: SortOrder }`} ## CountryTranslationInput \ {`input CountryTranslationInput { id: ID languageCode: LanguageCode! name: String customFields: JSON }`} ## CreateAddressInput \ {\`""" 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 }\`} ## CreateAdministratorInput \ {`input CreateAdministratorInput { firstName: String! lastName: String! emailAddress: String! password: String! roleIds: [ID!]! customFields: JSON }`} ## CreateApiKeyInput \ {`""" There is no User ID because you can only create API-Keys for yourself, which gets determined by the User who does the request. """ input CreateApiKeyInput { """ Which roles to attach to this ApiKey. You may only grant roles which you, yourself have. """ roleIds: [ID!]! translations: [CreateApiKeyTranslationInput!]! customFields: JSON }`} ## CreateApiKeyTranslationInput \ {`input CreateApiKeyTranslationInput { languageCode: LanguageCode! """A descriptive name so you can remind yourself where the API-Key gets used""" name: String! customFields: JSON }`} ## CreateAssetInput \ {`input CreateAssetInput { file: Upload! tags: [String!] translations: [AssetTranslationInput!] customFields: JSON }`} ## CreateChannelInput \ {`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 }`} ## CreateCollectionInput \ {`input CreateCollectionInput { isPrivate: Boolean featuredAssetId: ID assetIds: [ID!] parentId: ID inheritFilters: Boolean filters: [ConfigurableOperationInput!]! translations: [CreateCollectionTranslationInput!]! customFields: JSON }`} ## CreateCollectionTranslationInput \ {`input CreateCollectionTranslationInput { languageCode: LanguageCode! name: String! slug: String! description: String! customFields: JSON }`} ## CreateCountryInput \ {`input CreateCountryInput { code: String! translations: [CountryTranslationInput!]! enabled: Boolean! customFields: JSON }`} ## CreateCustomerGroupInput \ {`input CreateCustomerGroupInput { name: String! customerIds: [ID!] customFields: JSON }`} ## CreateCustomerInput \ {`input CreateCustomerInput { title: String firstName: String! lastName: String! phoneNumber: String emailAddress: String! customFields: JSON }`} ## CreateFacetInput \ {`input CreateFacetInput { code: String! isPrivate: Boolean! translations: [FacetTranslationInput!]! values: [CreateFacetValueWithFacetInput!] customFields: JSON }`} ## CreateFacetValueInput \ {`input CreateFacetValueInput { facetId: ID! code: String! translations: [FacetValueTranslationInput!]! customFields: JSON }`} ## CreateFacetValueWithFacetInput \ {`input CreateFacetValueWithFacetInput { code: String! translations: [FacetValueTranslationInput!]! }`} ## CreateGroupOptionInput \ {`input CreateGroupOptionInput { code: String! translations: [ProductOptionGroupTranslationInput!]! }`} ## CreatePaymentMethodInput \ {`input CreatePaymentMethodInput { code: String! enabled: Boolean! checker: ConfigurableOperationInput handler: ConfigurableOperationInput! translations: [PaymentMethodTranslationInput!]! customFields: JSON }`} ## CreateProductInput \ {`input CreateProductInput { featuredAssetId: ID enabled: Boolean assetIds: [ID!] facetValueIds: [ID!] translations: [ProductTranslationInput!]! customFields: JSON }`} ## CreateProductOptionGroupInput \ {`input CreateProductOptionGroupInput { code: String! translations: [ProductOptionGroupTranslationInput!]! options: [CreateGroupOptionInput!] customFields: JSON }`} ## CreateProductOptionInput \ {`input CreateProductOptionInput { productOptionGroupId: ID! code: String! translations: [ProductOptionGroupTranslationInput!]! customFields: JSON }`} ## CreateProductVariantInput \ {`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 }`} ## CreateProductVariantOptionInput \ {`input CreateProductVariantOptionInput { optionGroupId: ID! code: String! translations: [ProductOptionTranslationInput!]! }`} ## CreateProductVariantPriceInput \ {`input CreateProductVariantPriceInput { currencyCode: CurrencyCode! price: Money! customFields: JSON }`} ## CreatePromotionInput \ {`input CreatePromotionInput { enabled: Boolean! startsAt: DateTime endsAt: DateTime couponCode: String perCustomerUsageLimit: Int usageLimit: Int conditions: [ConfigurableOperationInput!]! actions: [ConfigurableOperationInput!]! translations: [PromotionTranslationInput!]! customFields: JSON }`} ## CreateProvinceInput \ {`input CreateProvinceInput { code: String! translations: [ProvinceTranslationInput!]! enabled: Boolean! customFields: JSON }`} ## CreateRoleInput \ {`input CreateRoleInput { code: String! description: String! permissions: [Permission!]! channelIds: [ID!] }`} ## CreateSellerInput \ {`input CreateSellerInput { name: String! customFields: JSON }`} ## CreateShippingMethodInput \ {`input CreateShippingMethodInput { code: String! fulfillmentHandler: String! checker: ConfigurableOperationInput! calculator: ConfigurableOperationInput! translations: [ShippingMethodTranslationInput!]! customFields: JSON }`} ## CreateStockLocationInput \ {`input CreateStockLocationInput { name: String! description: String customFields: JSON }`} ## CreateTagInput \ {`input CreateTagInput { value: String! }`} ## CreateTaxCategoryInput \ {`input CreateTaxCategoryInput { name: String! isDefault: Boolean customFields: JSON }`} ## CreateTaxRateInput \ {`input CreateTaxRateInput { name: String! enabled: Boolean! value: Float! categoryId: ID! zoneId: ID! customerGroupId: ID customFields: JSON }`} ## CreateZoneInput \ {`input CreateZoneInput { name: String! memberIds: [ID!] customFields: JSON }`} ## 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!] }`} ## CustomerGroupFilterParameter \ {`input CustomerGroupFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators name: StringOperators _and: [CustomerGroupFilterParameter!] _or: [CustomerGroupFilterParameter!] }`} ## CustomerGroupListOptions \ {`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 }`} ## CustomerGroupSortParameter \ {`input CustomerGroupSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder name: SortOrder }`} ## CustomerListOptions \ {`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 }`} ## CustomerSortParameter \ {`input CustomerSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder title: SortOrder firstName: SortOrder lastName: SortOrder phoneNumber: SortOrder emailAddress: SortOrder }`} ## DateListOperators \ {`"""Operators for filtering on a list of Date fields""" input DateListOperators { inList: DateTime! }`} ## DateOperators \ {`"""Operators for filtering on a DateTime field""" input DateOperators { eq: DateTime before: DateTime after: DateTime between: DateRange isNull: Boolean }`} ## DateRange \ {`input DateRange { start: DateTime! end: DateTime! }`} ## DeleteAssetInput \ {`input DeleteAssetInput { assetId: ID! force: Boolean deleteFromAllChannels: Boolean }`} ## DeleteAssetsInput \ {`input DeleteAssetsInput { assetIds: [ID!]! force: Boolean deleteFromAllChannels: Boolean }`} ## DeleteStockLocationInput \ {`input DeleteStockLocationInput { id: ID! transferToLocationId: ID }`} ## DuplicateEntityInput \ {`input DuplicateEntityInput { entityName: String! entityId: ID! duplicatorInput: ConfigurableOperationInput! }`} ## FacetFilterParameter \ {`input FacetFilterParameter { isPrivate: BooleanOperators id: IDOperators createdAt: DateOperators updatedAt: DateOperators languageCode: StringOperators name: StringOperators code: StringOperators _and: [FacetFilterParameter!] _or: [FacetFilterParameter!] }`} ## FacetListOptions \ {`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 }`} ## FacetSortParameter \ {`input FacetSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder name: SortOrder code: SortOrder }`} ## FacetTranslationInput \ {`input FacetTranslationInput { id: ID languageCode: LanguageCode! name: String customFields: JSON }`} ## FacetValueFilterInput \ {\`""" 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!] }\`} ## FacetValueFilterParameter \ {`input FacetValueFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators languageCode: StringOperators facetId: IDOperators name: StringOperators code: StringOperators _and: [FacetValueFilterParameter!] _or: [FacetValueFilterParameter!] }`} ## FacetValueListOptions \ {`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 }`} ## FacetValueSortParameter \ {`input FacetValueSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder facetId: SortOrder name: SortOrder code: SortOrder }`} ## FacetValueTranslationInput \ {`input FacetValueTranslationInput { id: ID languageCode: LanguageCode! name: String customFields: JSON }`} ## FulfillOrderInput \ {`input FulfillOrderInput { lines: [OrderLineInput!]! handler: ConfigurableOperationInput! }`} ## HistoryEntryFilterParameter \ {`input HistoryEntryFilterParameter { isPublic: BooleanOperators id: IDOperators createdAt: DateOperators updatedAt: DateOperators type: StringOperators _and: [HistoryEntryFilterParameter!] _or: [HistoryEntryFilterParameter!] }`} ## HistoryEntryListOptions \ {`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 }`} ## HistoryEntrySortParameter \ {`input HistoryEntrySortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder }`} ## IDListOperators \ {`"""Operators for filtering on a list of ID fields""" input IDListOperators { inList: ID! }`} ## IDOperators \ {`"""Operators for filtering on an ID field""" input IDOperators { eq: String notEq: String in: [String!] notIn: [String!] isNull: Boolean }`} ## 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!] }`} ## JobListOptions \ {`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 }`} ## JobSortParameter \ {`input JobSortParameter { id: SortOrder createdAt: SortOrder startedAt: SortOrder settledAt: SortOrder queueName: SortOrder progress: SortOrder duration: SortOrder retries: SortOrder attempts: SortOrder }`} ## ManualPaymentInput \ {`input ManualPaymentInput { orderId: ID! method: String! transactionId: String metadata: JSON }`} ## MetricSummaryInput \ {`input MetricSummaryInput { interval: MetricInterval! types: [MetricType!]! refresh: Boolean }`} ## ModifyOrderInput \ {`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!] }\`} ## ModifyOrderOptions \ {`input ModifyOrderOptions { freezePromotions: Boolean recalculateShipping: Boolean }`} ## MoveCollectionInput \ {`input MoveCollectionInput { collectionId: ID! parentId: ID! index: Int! }`} ## NativeAuthInput \ {`input NativeAuthInput { username: String! password: String! }`} ## NumberListOperators \ {`"""Operators for filtering on a list of Number fields""" input NumberListOperators { inList: Float! }`} ## NumberOperators \ {`"""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 }`} ## NumberRange \ {`input NumberRange { start: Float! end: Float! }`} ## OrderFilterParameter \ {`input OrderFilterParameter { customerLastName: StringOperators transactionId: StringOperators aggregateOrderId: IDOperators 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!] }\`} ## OrderLineInput \ {`input OrderLineInput { orderLineId: ID! quantity: Int! }`} ## OrderListOptions \ {`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 }`} ## OrderSortParameter \ {`input OrderSortParameter { customerLastName: SortOrder transactionId: SortOrder aggregateOrderId: SortOrder 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 }\`} ## PaymentMethodFilterParameter \ {`input PaymentMethodFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators name: StringOperators code: StringOperators description: StringOperators enabled: BooleanOperators _and: [PaymentMethodFilterParameter!] _or: [PaymentMethodFilterParameter!] }`} ## PaymentMethodListOptions \ {`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 }`} ## PaymentMethodSortParameter \ {`input PaymentMethodSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder name: SortOrder code: SortOrder description: SortOrder }`} ## PaymentMethodTranslationInput \ {`input PaymentMethodTranslationInput { id: ID languageCode: LanguageCode! name: String description: String customFields: JSON }`} ## PreviewCollectionVariantsInput \ {`input PreviewCollectionVariantsInput { parentId: ID inheritFilters: Boolean! filters: [ConfigurableOperationInput!]! }`} ## ProductFilterParameter \ {`input ProductFilterParameter { facetValueId: IDOperators sku: StringOperators optionGroupId: IDOperators id: IDOperators createdAt: DateOperators updatedAt: DateOperators languageCode: StringOperators name: StringOperators slug: StringOperators description: StringOperators enabled: BooleanOperators _and: [ProductFilterParameter!] _or: [ProductFilterParameter!] }`} ## ProductListOptions \ {`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 }`} ## ProductOptionFilterParameter \ {`input ProductOptionFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators languageCode: StringOperators code: StringOperators name: StringOperators groupId: IDOperators _and: [ProductOptionFilterParameter!] _or: [ProductOptionFilterParameter!] }`} ## ProductOptionGroupFilterParameter \ {`input ProductOptionGroupFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators languageCode: StringOperators code: StringOperators name: StringOperators """The number of products that use this option group""" productCount: NumberOperators _and: [ProductOptionGroupFilterParameter!] _or: [ProductOptionGroupFilterParameter!] }`} ## ProductOptionGroupListOptions \ {`input ProductOptionGroupListOptions { """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: ProductOptionGroupSortParameter """Allows the results to be filtered""" filter: ProductOptionGroupFilterParameter """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND.""" filterOperator: LogicalOperator }`} ## ProductOptionGroupSortParameter \ {`input ProductOptionGroupSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder code: SortOrder name: SortOrder """The number of products that use this option group""" productCount: SortOrder }`} ## ProductOptionGroupTranslationInput \ {`input ProductOptionGroupTranslationInput { id: ID languageCode: LanguageCode! name: String customFields: JSON }`} ## ProductOptionListOptions \ {`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 }`} ## ProductOptionSortParameter \ {`input ProductOptionSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder code: SortOrder name: SortOrder groupId: SortOrder }`} ## ProductOptionTranslationInput \ {`input ProductOptionTranslationInput { id: ID languageCode: LanguageCode! name: String customFields: JSON }`} ## ProductSortParameter \ {`input ProductSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder name: SortOrder slug: SortOrder description: SortOrder }`} ## ProductTranslationInput \ {`input ProductTranslationInput { id: ID languageCode: LanguageCode! name: String slug: String description: String customFields: JSON }`} ## 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!] }`} ## ProductVariantListOptions \ {`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 }`} ## ProductVariantSortParameter \ {`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 }`} ## ProductVariantTranslationInput \ {`input ProductVariantTranslationInput { id: ID languageCode: LanguageCode! name: String customFields: JSON }`} ## 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!] }`} ## PromotionListOptions \ {`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 }`} ## PromotionSortParameter \ {`input PromotionSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder startsAt: SortOrder endsAt: SortOrder couponCode: SortOrder perCustomerUsageLimit: SortOrder usageLimit: SortOrder name: SortOrder description: SortOrder }`} ## PromotionTranslationInput \ {`input PromotionTranslationInput { id: ID languageCode: LanguageCode! name: String description: String customFields: JSON }`} ## 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!] }`} ## ProvinceListOptions \ {`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 }`} ## ProvinceSortParameter \ {`input ProvinceSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder code: SortOrder type: SortOrder name: SortOrder parentId: SortOrder }`} ## ProvinceTranslationInput \ {`input ProvinceTranslationInput { id: ID languageCode: LanguageCode! name: String customFields: JSON }`} ## RefundOrderInput \ {`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 }`} ## RemoveCollectionsFromChannelInput \ {`input RemoveCollectionsFromChannelInput { collectionIds: [ID!]! channelId: ID! }`} ## RemoveFacetsFromChannelInput \ {`input RemoveFacetsFromChannelInput { facetIds: [ID!]! channelId: ID! force: Boolean }`} ## RemovePaymentMethodsFromChannelInput \ {`input RemovePaymentMethodsFromChannelInput { paymentMethodIds: [ID!]! channelId: ID! }`} ## RemoveProductOptionGroupsFromChannelInput \ {`input RemoveProductOptionGroupsFromChannelInput { productOptionGroupIds: [ID!]! channelId: ID! force: Boolean }`} ## RemoveProductVariantsFromChannelInput \ {`input RemoveProductVariantsFromChannelInput { productVariantIds: [ID!]! channelId: ID! }`} ## RemoveProductsFromChannelInput \ {`input RemoveProductsFromChannelInput { productIds: [ID!]! channelId: ID! }`} ## RemovePromotionsFromChannelInput \ {`input RemovePromotionsFromChannelInput { promotionIds: [ID!]! channelId: ID! }`} ## RemoveShippingMethodsFromChannelInput \ {`input RemoveShippingMethodsFromChannelInput { shippingMethodIds: [ID!]! channelId: ID! }`} ## RemoveStockLocationsFromChannelInput \ {`input RemoveStockLocationsFromChannelInput { stockLocationIds: [ID!]! channelId: ID! }`} ## RoleFilterParameter \ {`input RoleFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators code: StringOperators description: StringOperators _and: [RoleFilterParameter!] _or: [RoleFilterParameter!] }`} ## RoleListOptions \ {`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 }`} ## RoleSortParameter \ {`input RoleSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder code: SortOrder description: SortOrder }`} ## SearchInput \ {`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 }`} ## SearchResultSortParameter \ {`input SearchResultSortParameter { name: SortOrder price: SortOrder }`} ## SellerFilterParameter \ {`input SellerFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators name: StringOperators _and: [SellerFilterParameter!] _or: [SellerFilterParameter!] }`} ## SellerListOptions \ {`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 }`} ## SellerSortParameter \ {`input SellerSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder name: SortOrder }`} ## SetOrderCustomerInput \ {`input SetOrderCustomerInput { orderId: ID! customerId: ID! note: String }`} ## SettingsStoreInput \ {`input SettingsStoreInput { key: String! value: JSON! }`} ## SettleRefundInput \ {`input SettleRefundInput { id: ID! transactionId: String! }`} ## ShippingMethodFilterParameter \ {`input ShippingMethodFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators languageCode: StringOperators code: StringOperators name: StringOperators description: StringOperators fulfillmentHandlerCode: StringOperators _and: [ShippingMethodFilterParameter!] _or: [ShippingMethodFilterParameter!] }`} ## ShippingMethodListOptions \ {`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 }`} ## ShippingMethodSortParameter \ {`input ShippingMethodSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder code: SortOrder name: SortOrder description: SortOrder fulfillmentHandlerCode: SortOrder }`} ## ShippingMethodTranslationInput \ {`input ShippingMethodTranslationInput { id: ID languageCode: LanguageCode! name: String description: String customFields: JSON }`} ## SlugForEntityInput \ {`input SlugForEntityInput { entityName: String! fieldName: String! inputValue: String! entityId: ID }`} ## StockLevelInput \ {`input StockLevelInput { stockLocationId: ID! stockOnHand: Int! }`} ## StockLocationFilterParameter \ {`input StockLocationFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators name: StringOperators description: StringOperators _and: [StockLocationFilterParameter!] _or: [StockLocationFilterParameter!] }`} ## StockLocationListOptions \ {`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 }`} ## StockLocationSortParameter \ {`input StockLocationSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder name: SortOrder description: SortOrder }`} ## StockMovementListOptions \ {`input StockMovementListOptions { type: StockMovementType skip: Int take: Int }`} ## StringListOperators \ {`"""Operators for filtering on a list of String fields""" input StringListOperators { inList: String! }`} ## StringOperators \ {`"""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 }`} ## SurchargeInput \ {`input SurchargeInput { description: String! sku: String price: Money! priceIncludesTax: Boolean! taxRate: Float taxDescription: String }`} ## TagFilterParameter \ {`input TagFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators value: StringOperators _and: [TagFilterParameter!] _or: [TagFilterParameter!] }`} ## TagListOptions \ {`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 }`} ## TagSortParameter \ {`input TagSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder value: SortOrder }`} ## TaxCategoryFilterParameter \ {`input TaxCategoryFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators name: StringOperators isDefault: BooleanOperators _and: [TaxCategoryFilterParameter!] _or: [TaxCategoryFilterParameter!] }`} ## TaxCategoryListOptions \ {`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 }`} ## TaxCategorySortParameter \ {`input TaxCategorySortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder name: SortOrder }`} ## TaxRateFilterParameter \ {`input TaxRateFilterParameter { zoneId: IDOperators categoryId: IDOperators id: IDOperators createdAt: DateOperators updatedAt: DateOperators name: StringOperators enabled: BooleanOperators value: NumberOperators _and: [TaxRateFilterParameter!] _or: [TaxRateFilterParameter!] }`} ## TaxRateListOptions \ {`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 }`} ## TaxRateSortParameter \ {`input TaxRateSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder name: SortOrder value: SortOrder }`} ## TestEligibleShippingMethodsInput \ {`input TestEligibleShippingMethodsInput { shippingAddress: CreateAddressInput! lines: [TestShippingMethodOrderLineInput!]! }`} ## TestShippingMethodInput \ {`input TestShippingMethodInput { checker: ConfigurableOperationInput! calculator: ConfigurableOperationInput! shippingAddress: CreateAddressInput! lines: [TestShippingMethodOrderLineInput!]! }`} ## TestShippingMethodOrderLineInput \ {`input TestShippingMethodOrderLineInput { productVariantId: ID! quantity: Int! }`} ## UpdateActiveAdministratorInput \ {`input UpdateActiveAdministratorInput { firstName: String lastName: String emailAddress: String password: String customFields: JSON }`} ## UpdateAddressInput \ {\`""" 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 }\`} ## UpdateAdministratorInput \ {`input UpdateAdministratorInput { id: ID! firstName: String lastName: String emailAddress: String password: String roleIds: [ID!] customFields: JSON }`} ## UpdateApiKeyInput \ {`input UpdateApiKeyInput { """ID of the ApiKey""" id: ID! """ Which roles to attach to this ApiKey. You may only grant roles which you, yourself have. """ roleIds: [ID!] translations: [UpdateApiKeyTranslationInput!] customFields: JSON }`} ## UpdateApiKeyTranslationInput \ {`input UpdateApiKeyTranslationInput { id: ID languageCode: LanguageCode! """A descriptive name so you can remind yourself where the API-Key gets used""" name: String customFields: JSON }`} ## UpdateAssetInput \ {`input UpdateAssetInput { id: ID! name: String focalPoint: CoordinateInput tags: [String!] translations: [AssetTranslationInput!] customFields: JSON }`} ## UpdateChannelInput \ {`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 }`} ## UpdateCollectionInput \ {`input UpdateCollectionInput { id: ID! isPrivate: Boolean featuredAssetId: ID parentId: ID assetIds: [ID!] inheritFilters: Boolean filters: [ConfigurableOperationInput!] translations: [UpdateCollectionTranslationInput!] customFields: JSON }`} ## UpdateCollectionTranslationInput \ {`input UpdateCollectionTranslationInput { id: ID languageCode: LanguageCode! name: String slug: String description: String customFields: JSON }`} ## UpdateCountryInput \ {`input UpdateCountryInput { id: ID! code: String translations: [CountryTranslationInput!] enabled: Boolean customFields: JSON }`} ## UpdateCustomerGroupInput \ {`input UpdateCustomerGroupInput { id: ID! name: String customFields: JSON }`} ## UpdateCustomerInput \ {`input UpdateCustomerInput { id: ID! title: String firstName: String lastName: String phoneNumber: String emailAddress: String customFields: JSON }`} ## UpdateCustomerNoteInput \ {`input UpdateCustomerNoteInput { noteId: ID! note: String! }`} ## UpdateFacetInput \ {`input UpdateFacetInput { id: ID! isPrivate: Boolean code: String translations: [FacetTranslationInput!] customFields: JSON }`} ## UpdateFacetValueInput \ {`input UpdateFacetValueInput { id: ID! code: String translations: [FacetValueTranslationInput!] customFields: JSON }`} ## UpdateGlobalSettingsInput \ {`input UpdateGlobalSettingsInput { availableLanguages: [LanguageCode!] trackInventory: Boolean outOfStockThreshold: Int customFields: JSON }`} ## UpdateOrderAddressInput \ {`input UpdateOrderAddressInput { fullName: String company: String streetLine1: String streetLine2: String city: String province: String postalCode: String countryCode: String phoneNumber: String }`} ## UpdateOrderInput \ {`input UpdateOrderInput { id: ID! customFields: JSON }`} ## UpdateOrderNoteInput \ {`input UpdateOrderNoteInput { noteId: ID! note: String isPublic: Boolean }`} ## UpdatePaymentMethodInput \ {`input UpdatePaymentMethodInput { id: ID! code: String enabled: Boolean checker: ConfigurableOperationInput handler: ConfigurableOperationInput translations: [PaymentMethodTranslationInput!] customFields: JSON }`} ## UpdateProductInput \ {`input UpdateProductInput { id: ID! enabled: Boolean featuredAssetId: ID assetIds: [ID!] facetValueIds: [ID!] translations: [ProductTranslationInput!] customFields: JSON }`} ## UpdateProductOptionGroupInput \ {`input UpdateProductOptionGroupInput { id: ID! code: String translations: [ProductOptionGroupTranslationInput!] customFields: JSON }`} ## UpdateProductOptionInput \ {`input UpdateProductOptionInput { id: ID! code: String translations: [ProductOptionGroupTranslationInput!] customFields: JSON }`} ## UpdateProductVariantInput \ {`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 }`} ## UpdateProductVariantPriceInput \ {`""" 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 }\`} ## UpdatePromotionInput \ {`input UpdatePromotionInput { id: ID! enabled: Boolean startsAt: DateTime endsAt: DateTime couponCode: String perCustomerUsageLimit: Int usageLimit: Int conditions: [ConfigurableOperationInput!] actions: [ConfigurableOperationInput!] translations: [PromotionTranslationInput!] customFields: JSON }`} ## UpdateProvinceInput \ {`input UpdateProvinceInput { id: ID! code: String translations: [ProvinceTranslationInput!] enabled: Boolean customFields: JSON }`} ## UpdateRoleInput \ {`input UpdateRoleInput { id: ID! code: String description: String permissions: [Permission!] channelIds: [ID!] }`} ## UpdateScheduledTaskInput \ {`input UpdateScheduledTaskInput { id: String! enabled: Boolean }`} ## UpdateSellerInput \ {`input UpdateSellerInput { id: ID! name: String customFields: JSON }`} ## UpdateShippingMethodInput \ {`input UpdateShippingMethodInput { id: ID! code: String fulfillmentHandler: String checker: ConfigurableOperationInput calculator: ConfigurableOperationInput translations: [ShippingMethodTranslationInput!]! customFields: JSON }`} ## UpdateStockLocationInput \ {`input UpdateStockLocationInput { id: ID! name: String description: String customFields: JSON }`} ## UpdateTagInput \ {`input UpdateTagInput { id: ID! value: String }`} ## UpdateTaxCategoryInput \ {`input UpdateTaxCategoryInput { id: ID! name: String isDefault: Boolean customFields: JSON }`} ## UpdateTaxRateInput \ {`input UpdateTaxRateInput { id: ID! name: String value: Float enabled: Boolean categoryId: ID zoneId: ID customerGroupId: ID customFields: JSON }`} ## UpdateZoneInput \ {`input UpdateZoneInput { id: ID! name: String customFields: JSON }`} ## ZoneFilterParameter \ {`input ZoneFilterParameter { id: IDOperators createdAt: DateOperators updatedAt: DateOperators name: StringOperators _and: [ZoneFilterParameter!] _or: [ZoneFilterParameter!] }`} ## ZoneListOptions \ {`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 }`} ## ZoneSortParameter \ {`input ZoneSortParameter { id: SortOrder createdAt: SortOrder updatedAt: SortOrder name: SortOrder }`}