@vendure/docs 0.0.0-202601211103 → 0.0.0-202601211343

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (234) hide show
  1. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +1 -1
  2. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
  3. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +1 -1
  4. package/docs/reference/admin-ui-api/components/data-table-component.mdx +1 -1
  5. package/docs/reference/admin-ui-api/components/data-table2component.mdx +1 -1
  6. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +1 -1
  7. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +1 -1
  8. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
  9. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
  10. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +1 -1
  11. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +1 -1
  12. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +1 -1
  13. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +1 -1
  14. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +19 -19
  15. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +1 -1
  16. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
  17. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +1 -1
  18. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +1 -1
  20. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +2 -2
  21. package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx +1 -1
  22. package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx +1 -1
  23. package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx +1 -1
  24. package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx +1 -1
  25. package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx +2 -2
  26. package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx +2 -2
  27. package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx +2 -2
  28. package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx +2 -2
  29. package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx +2 -2
  30. package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx +1 -1
  31. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
  32. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  33. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +1 -1
  34. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  35. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  36. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +1 -1
  37. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  38. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +1 -1
  39. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  40. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  41. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  42. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
  43. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  44. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +1 -1
  45. package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +1 -1
  46. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +2 -2
  47. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  48. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +1 -1
  49. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +2 -2
  50. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +1 -1
  51. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -1
  52. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +2 -2
  53. package/docs/reference/core-plugins/stellate-plugin/index.mdx +1 -1
  54. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +1 -1
  55. package/docs/reference/dashboard/components/vendure-image.mdx +1 -1
  56. package/docs/reference/dashboard/page-layout/page.mdx +1 -1
  57. package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +1 -1
  58. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  59. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +1 -1
  60. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +1 -1
  61. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +1 -1
  62. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +1 -1
  63. package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +1 -1
  64. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +1 -1
  65. package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +1 -1
  66. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +1 -1
  67. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +1 -1
  68. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +1 -1
  69. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +1 -1
  70. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  71. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  72. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +1 -1
  73. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +1 -1
  74. package/docs/reference/typescript-api/cache/cache-strategy.mdx +1 -1
  75. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +1 -1
  76. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  77. package/docs/reference/typescript-api/common/i18n-service.mdx +1 -1
  78. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +1 -1
  79. package/docs/reference/typescript-api/configuration/collection-filter.mdx +1 -1
  80. package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +1 -1
  81. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
  82. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +3 -3
  83. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +2 -2
  84. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +2 -2
  85. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +1 -1
  86. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  87. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  88. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
  89. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
  90. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  91. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +1 -1
  92. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +1 -1
  93. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +1 -1
  94. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +1 -1
  95. package/docs/reference/typescript-api/entities/address.mdx +2 -2
  96. package/docs/reference/typescript-api/entities/administrator.mdx +2 -2
  97. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  98. package/docs/reference/typescript-api/entities/asset.mdx +2 -2
  99. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  100. package/docs/reference/typescript-api/entities/authentication-method.mdx +3 -3
  101. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  102. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  103. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  104. package/docs/reference/typescript-api/entities/customer-group.mdx +2 -2
  105. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  106. package/docs/reference/typescript-api/entities/customer.mdx +2 -2
  107. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  108. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  109. package/docs/reference/typescript-api/entities/fulfillment.mdx +2 -2
  110. package/docs/reference/typescript-api/entities/global-settings.mdx +2 -2
  111. package/docs/reference/typescript-api/entities/history-entry.mdx +2 -2
  112. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  113. package/docs/reference/typescript-api/entities/order-line-reference.mdx +4 -4
  114. package/docs/reference/typescript-api/entities/order-line.mdx +2 -2
  115. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  116. package/docs/reference/typescript-api/entities/order.mdx +2 -2
  117. package/docs/reference/typescript-api/entities/orderable-asset.mdx +2 -2
  118. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  119. package/docs/reference/typescript-api/entities/payment.mdx +2 -2
  120. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  121. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  122. package/docs/reference/typescript-api/entities/product-variant-price.mdx +2 -2
  123. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  124. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  125. package/docs/reference/typescript-api/entities/promotion.mdx +2 -2
  126. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  127. package/docs/reference/typescript-api/entities/refund.mdx +2 -2
  128. package/docs/reference/typescript-api/entities/region.mdx +2 -2
  129. package/docs/reference/typescript-api/entities/role.mdx +2 -2
  130. package/docs/reference/typescript-api/entities/seller.mdx +2 -2
  131. package/docs/reference/typescript-api/entities/session.mdx +2 -2
  132. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  133. package/docs/reference/typescript-api/entities/shipping-line.mdx +2 -2
  134. package/docs/reference/typescript-api/entities/shipping-method.mdx +2 -2
  135. package/docs/reference/typescript-api/entities/stock-level.mdx +2 -2
  136. package/docs/reference/typescript-api/entities/stock-location.mdx +2 -2
  137. package/docs/reference/typescript-api/entities/stock-movement.mdx +7 -7
  138. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  139. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  140. package/docs/reference/typescript-api/entities/tax-category.mdx +2 -2
  141. package/docs/reference/typescript-api/entities/tax-rate.mdx +2 -2
  142. package/docs/reference/typescript-api/entities/user.mdx +2 -2
  143. package/docs/reference/typescript-api/entities/zone.mdx +2 -2
  144. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +1 -1
  145. package/docs/reference/typescript-api/errors/error-types.mdx +7 -7
  146. package/docs/reference/typescript-api/errors/i18n-error.mdx +1 -1
  147. package/docs/reference/typescript-api/events/event-bus.mdx +1 -1
  148. package/docs/reference/typescript-api/events/event-types.mdx +59 -59
  149. package/docs/reference/typescript-api/events/vendure-entity-event.mdx +1 -1
  150. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +2 -2
  151. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +1 -1
  152. package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +1 -1
  153. package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +1 -1
  154. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +1 -1
  155. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  156. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +1 -1
  157. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +1 -1
  158. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -2
  159. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
  160. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +1 -1
  161. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +1 -1
  162. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +1 -1
  163. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +1 -1
  164. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +2 -2
  165. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +1 -1
  166. package/docs/reference/typescript-api/logger/default-logger.mdx +1 -1
  167. package/docs/reference/typescript-api/logger/index.mdx +1 -1
  168. package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +1 -1
  169. package/docs/reference/typescript-api/money/default-money-strategy.mdx +1 -1
  170. package/docs/reference/typescript-api/money/money-strategy.mdx +1 -1
  171. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +1 -1
  172. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  173. package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +1 -1
  174. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  175. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  176. package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +1 -1
  177. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  178. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  179. package/docs/reference/typescript-api/orders/merge-strategies.mdx +4 -4
  180. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +2 -2
  181. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +2 -2
  182. package/docs/reference/typescript-api/orders/order-interceptor.mdx +1 -1
  183. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  184. package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +1 -1
  185. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  186. package/docs/reference/typescript-api/orders/order-process.mdx +1 -1
  187. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +2 -2
  188. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  189. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +1 -1
  190. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
  191. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
  192. package/docs/reference/typescript-api/payment/payment-process.mdx +1 -1
  193. package/docs/reference/typescript-api/payment/refund-process.mdx +1 -1
  194. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +1 -1
  195. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  196. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +1 -1
  197. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  198. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +1 -1
  199. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  200. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  201. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +1 -1
  202. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  203. package/docs/reference/typescript-api/promotions/promotion-action.mdx +10 -10
  204. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +2 -2
  205. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +1 -1
  206. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +1 -1
  207. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +1 -1
  208. package/docs/reference/typescript-api/services/asset-service.mdx +1 -1
  209. package/docs/reference/typescript-api/services/collection-service.mdx +1 -1
  210. package/docs/reference/typescript-api/services/session-service.mdx +1 -1
  211. package/docs/reference/typescript-api/services/settings-store-service.mdx +1 -1
  212. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  213. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +1 -1
  214. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +1 -1
  215. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
  216. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  217. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +1 -1
  218. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +1 -1
  219. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +1 -1
  220. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  221. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  222. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +1 -1
  223. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  224. package/package.json +1 -1
  225. package/docs/reference/graphql-api/admin/enums.mdx +0 -1139
  226. package/docs/reference/graphql-api/admin/input-types.mdx +0 -4708
  227. package/docs/reference/graphql-api/admin/mutations.mdx +0 -2750
  228. package/docs/reference/graphql-api/admin/object-types.mdx +0 -4973
  229. package/docs/reference/graphql-api/admin/queries.mdx +0 -1194
  230. package/docs/reference/graphql-api/shop/enums.mdx +0 -1063
  231. package/docs/reference/graphql-api/shop/input-types.mdx +0 -1113
  232. package/docs/reference/graphql-api/shop/mutations.mdx +0 -540
  233. package/docs/reference/graphql-api/shop/object-types.mdx +0 -3693
  234. package/docs/reference/graphql-api/shop/queries.mdx +0 -314
@@ -1,1113 +0,0 @@
1
- ---
2
- title: "Input Objects"
3
- generated: true
4
- ---
5
-
6
-
7
-
8
- ## AddItemInput {#additeminput}
9
-
10
- <GraphQLDoc
11
- type="input"
12
- typeName="AddItemInput"
13
- typeLinks={{
14
- ID: '/reference/graphql-api/shop/object-types#id',
15
- Int: '/reference/graphql-api/shop/object-types#int',
16
- }}
17
- >
18
- {`input AddItemInput {
19
- productVariantId: ID!
20
- quantity: Int!
21
- }`}
22
- </GraphQLDoc>
23
-
24
- ## AuthenticationInput {#authenticationinput}
25
-
26
- <GraphQLDoc
27
- type="input"
28
- typeName="AuthenticationInput"
29
- typeLinks={{
30
- NativeAuthInput: '/reference/graphql-api/shop/input-types#nativeauthinput',
31
- }}
32
- >
33
- {`input AuthenticationInput {
34
- native: NativeAuthInput
35
- }`}
36
- </GraphQLDoc>
37
-
38
- ## BooleanListOperators {#booleanlistoperators}
39
-
40
- <GraphQLDoc
41
- type="input"
42
- typeName="BooleanListOperators"
43
- typeLinks={{
44
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
45
- }}
46
- >
47
- {`"""Operators for filtering on a list of Boolean fields"""
48
- input BooleanListOperators {
49
- inList: Boolean!
50
- }`}
51
- </GraphQLDoc>
52
-
53
- ## BooleanOperators {#booleanoperators}
54
-
55
- <GraphQLDoc
56
- type="input"
57
- typeName="BooleanOperators"
58
- typeLinks={{
59
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
60
- }}
61
- >
62
- {`"""Operators for filtering on a Boolean field"""
63
- input BooleanOperators {
64
- eq: Boolean
65
- isNull: Boolean
66
- }`}
67
- </GraphQLDoc>
68
-
69
- ## CollectionFilterParameter {#collectionfilterparameter}
70
-
71
- <GraphQLDoc
72
- type="input"
73
- typeName="CollectionFilterParameter"
74
- typeLinks={{
75
- IDOperators: '/reference/graphql-api/shop/input-types#idoperators',
76
- DateOperators: '/reference/graphql-api/shop/input-types#dateoperators',
77
- StringOperators: '/reference/graphql-api/shop/input-types#stringoperators',
78
- NumberOperators: '/reference/graphql-api/shop/input-types#numberoperators',
79
- CollectionFilterParameter: '/reference/graphql-api/shop/input-types#collectionfilterparameter',
80
- }}
81
- >
82
- {`input CollectionFilterParameter {
83
- id: IDOperators
84
- createdAt: DateOperators
85
- updatedAt: DateOperators
86
- languageCode: StringOperators
87
- name: StringOperators
88
- slug: StringOperators
89
- position: NumberOperators
90
- description: StringOperators
91
- parentId: IDOperators
92
- _and: [CollectionFilterParameter!]
93
- _or: [CollectionFilterParameter!]
94
- }`}
95
- </GraphQLDoc>
96
-
97
- ## CollectionListOptions {#collectionlistoptions}
98
-
99
- <GraphQLDoc
100
- type="input"
101
- typeName="CollectionListOptions"
102
- typeLinks={{
103
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
104
- Int: '/reference/graphql-api/shop/object-types#int',
105
- CollectionSortParameter: '/reference/graphql-api/shop/input-types#collectionsortparameter',
106
- CollectionFilterParameter: '/reference/graphql-api/shop/input-types#collectionfilterparameter',
107
- LogicalOperator: '/reference/graphql-api/shop/enums#logicaloperator',
108
- }}
109
- >
110
- {`input CollectionListOptions {
111
- topLevelOnly: Boolean
112
- """Skips the first n results, for use in pagination"""
113
- skip: Int
114
- """Takes n results, for use in pagination"""
115
- take: Int
116
- """Specifies which properties to sort the results by"""
117
- sort: CollectionSortParameter
118
- """Allows the results to be filtered"""
119
- filter: CollectionFilterParameter
120
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
121
- filterOperator: LogicalOperator
122
- }`}
123
- </GraphQLDoc>
124
-
125
- ## CollectionSortParameter {#collectionsortparameter}
126
-
127
- <GraphQLDoc
128
- type="input"
129
- typeName="CollectionSortParameter"
130
- typeLinks={{
131
- SortOrder: '/reference/graphql-api/shop/enums#sortorder',
132
- }}
133
- >
134
- {`input CollectionSortParameter {
135
- id: SortOrder
136
- createdAt: SortOrder
137
- updatedAt: SortOrder
138
- name: SortOrder
139
- slug: SortOrder
140
- position: SortOrder
141
- description: SortOrder
142
- parentId: SortOrder
143
- }`}
144
- </GraphQLDoc>
145
-
146
- ## ConfigArgInput {#configarginput}
147
-
148
- <GraphQLDoc
149
- type="input"
150
- typeName="ConfigArgInput"
151
- typeLinks={{
152
- String: '/reference/graphql-api/shop/object-types#string',
153
- }}
154
- >
155
- {`input ConfigArgInput {
156
- name: String!
157
- """A JSON stringified representation of the actual value"""
158
- value: String!
159
- }`}
160
- </GraphQLDoc>
161
-
162
- ## ConfigurableOperationInput {#configurableoperationinput}
163
-
164
- <GraphQLDoc
165
- type="input"
166
- typeName="ConfigurableOperationInput"
167
- typeLinks={{
168
- String: '/reference/graphql-api/shop/object-types#string',
169
- ConfigArgInput: '/reference/graphql-api/shop/input-types#configarginput',
170
- }}
171
- >
172
- {`input ConfigurableOperationInput {
173
- code: String!
174
- arguments: [ConfigArgInput!]!
175
- }`}
176
- </GraphQLDoc>
177
-
178
- ## CreateAddressInput {#createaddressinput}
179
-
180
- <GraphQLDoc
181
- type="input"
182
- typeName="CreateAddressInput"
183
- typeLinks={{
184
- String: '/reference/graphql-api/shop/object-types#string',
185
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
186
- JSON: '/reference/graphql-api/shop/object-types#json',
187
- }}
188
- >
189
- {`"""
190
- Input used to create an Address.
191
-
192
- The countryCode must correspond to a \`code\` property of a Country that has been defined in the
193
- Vendure server. The \`code\` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
194
- If an invalid code is passed, the mutation will fail.
195
- """
196
- input CreateAddressInput {
197
- fullName: String
198
- company: String
199
- streetLine1: String!
200
- streetLine2: String
201
- city: String
202
- province: String
203
- postalCode: String
204
- countryCode: String!
205
- phoneNumber: String
206
- defaultShippingAddress: Boolean
207
- defaultBillingAddress: Boolean
208
- customFields: JSON
209
- }`}
210
- </GraphQLDoc>
211
-
212
- ## CreateCustomerInput {#createcustomerinput}
213
-
214
- <GraphQLDoc
215
- type="input"
216
- typeName="CreateCustomerInput"
217
- typeLinks={{
218
- String: '/reference/graphql-api/shop/object-types#string',
219
- JSON: '/reference/graphql-api/shop/object-types#json',
220
- }}
221
- >
222
- {`input CreateCustomerInput {
223
- title: String
224
- firstName: String!
225
- lastName: String!
226
- phoneNumber: String
227
- emailAddress: String!
228
- customFields: JSON
229
- }`}
230
- </GraphQLDoc>
231
-
232
- ## CustomerFilterParameter {#customerfilterparameter}
233
-
234
- <GraphQLDoc
235
- type="input"
236
- typeName="CustomerFilterParameter"
237
- typeLinks={{
238
- IDOperators: '/reference/graphql-api/shop/input-types#idoperators',
239
- DateOperators: '/reference/graphql-api/shop/input-types#dateoperators',
240
- StringOperators: '/reference/graphql-api/shop/input-types#stringoperators',
241
- CustomerFilterParameter: '/reference/graphql-api/shop/input-types#customerfilterparameter',
242
- }}
243
- >
244
- {`input CustomerFilterParameter {
245
- id: IDOperators
246
- createdAt: DateOperators
247
- updatedAt: DateOperators
248
- title: StringOperators
249
- firstName: StringOperators
250
- lastName: StringOperators
251
- phoneNumber: StringOperators
252
- emailAddress: StringOperators
253
- _and: [CustomerFilterParameter!]
254
- _or: [CustomerFilterParameter!]
255
- }`}
256
- </GraphQLDoc>
257
-
258
- ## CustomerListOptions {#customerlistoptions}
259
-
260
- <GraphQLDoc
261
- type="input"
262
- typeName="CustomerListOptions"
263
- typeLinks={{
264
- Int: '/reference/graphql-api/shop/object-types#int',
265
- CustomerSortParameter: '/reference/graphql-api/shop/input-types#customersortparameter',
266
- CustomerFilterParameter: '/reference/graphql-api/shop/input-types#customerfilterparameter',
267
- LogicalOperator: '/reference/graphql-api/shop/enums#logicaloperator',
268
- }}
269
- >
270
- {`input CustomerListOptions {
271
- """Skips the first n results, for use in pagination"""
272
- skip: Int
273
- """Takes n results, for use in pagination"""
274
- take: Int
275
- """Specifies which properties to sort the results by"""
276
- sort: CustomerSortParameter
277
- """Allows the results to be filtered"""
278
- filter: CustomerFilterParameter
279
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
280
- filterOperator: LogicalOperator
281
- }`}
282
- </GraphQLDoc>
283
-
284
- ## CustomerSortParameter {#customersortparameter}
285
-
286
- <GraphQLDoc
287
- type="input"
288
- typeName="CustomerSortParameter"
289
- typeLinks={{
290
- SortOrder: '/reference/graphql-api/shop/enums#sortorder',
291
- }}
292
- >
293
- {`input CustomerSortParameter {
294
- id: SortOrder
295
- createdAt: SortOrder
296
- updatedAt: SortOrder
297
- title: SortOrder
298
- firstName: SortOrder
299
- lastName: SortOrder
300
- phoneNumber: SortOrder
301
- emailAddress: SortOrder
302
- }`}
303
- </GraphQLDoc>
304
-
305
- ## DateListOperators {#datelistoperators}
306
-
307
- <GraphQLDoc
308
- type="input"
309
- typeName="DateListOperators"
310
- typeLinks={{
311
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
312
- }}
313
- >
314
- {`"""Operators for filtering on a list of Date fields"""
315
- input DateListOperators {
316
- inList: DateTime!
317
- }`}
318
- </GraphQLDoc>
319
-
320
- ## DateOperators {#dateoperators}
321
-
322
- <GraphQLDoc
323
- type="input"
324
- typeName="DateOperators"
325
- typeLinks={{
326
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
327
- DateRange: '/reference/graphql-api/shop/input-types#daterange',
328
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
329
- }}
330
- >
331
- {`"""Operators for filtering on a DateTime field"""
332
- input DateOperators {
333
- eq: DateTime
334
- before: DateTime
335
- after: DateTime
336
- between: DateRange
337
- isNull: Boolean
338
- }`}
339
- </GraphQLDoc>
340
-
341
- ## DateRange {#daterange}
342
-
343
- <GraphQLDoc
344
- type="input"
345
- typeName="DateRange"
346
- typeLinks={{
347
- DateTime: '/reference/graphql-api/shop/object-types#datetime',
348
- }}
349
- >
350
- {`input DateRange {
351
- start: DateTime!
352
- end: DateTime!
353
- }`}
354
- </GraphQLDoc>
355
-
356
- ## FacetFilterParameter {#facetfilterparameter}
357
-
358
- <GraphQLDoc
359
- type="input"
360
- typeName="FacetFilterParameter"
361
- typeLinks={{
362
- IDOperators: '/reference/graphql-api/shop/input-types#idoperators',
363
- DateOperators: '/reference/graphql-api/shop/input-types#dateoperators',
364
- StringOperators: '/reference/graphql-api/shop/input-types#stringoperators',
365
- FacetFilterParameter: '/reference/graphql-api/shop/input-types#facetfilterparameter',
366
- }}
367
- >
368
- {`input FacetFilterParameter {
369
- id: IDOperators
370
- createdAt: DateOperators
371
- updatedAt: DateOperators
372
- languageCode: StringOperators
373
- name: StringOperators
374
- code: StringOperators
375
- _and: [FacetFilterParameter!]
376
- _or: [FacetFilterParameter!]
377
- }`}
378
- </GraphQLDoc>
379
-
380
- ## FacetListOptions {#facetlistoptions}
381
-
382
- <GraphQLDoc
383
- type="input"
384
- typeName="FacetListOptions"
385
- typeLinks={{
386
- Int: '/reference/graphql-api/shop/object-types#int',
387
- FacetSortParameter: '/reference/graphql-api/shop/input-types#facetsortparameter',
388
- FacetFilterParameter: '/reference/graphql-api/shop/input-types#facetfilterparameter',
389
- LogicalOperator: '/reference/graphql-api/shop/enums#logicaloperator',
390
- }}
391
- >
392
- {`input FacetListOptions {
393
- """Skips the first n results, for use in pagination"""
394
- skip: Int
395
- """Takes n results, for use in pagination"""
396
- take: Int
397
- """Specifies which properties to sort the results by"""
398
- sort: FacetSortParameter
399
- """Allows the results to be filtered"""
400
- filter: FacetFilterParameter
401
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
402
- filterOperator: LogicalOperator
403
- }`}
404
- </GraphQLDoc>
405
-
406
- ## FacetSortParameter {#facetsortparameter}
407
-
408
- <GraphQLDoc
409
- type="input"
410
- typeName="FacetSortParameter"
411
- typeLinks={{
412
- SortOrder: '/reference/graphql-api/shop/enums#sortorder',
413
- }}
414
- >
415
- {`input FacetSortParameter {
416
- id: SortOrder
417
- createdAt: SortOrder
418
- updatedAt: SortOrder
419
- name: SortOrder
420
- code: SortOrder
421
- }`}
422
- </GraphQLDoc>
423
-
424
- ## FacetValueFilterInput {#facetvaluefilterinput}
425
-
426
- <GraphQLDoc
427
- type="input"
428
- typeName="FacetValueFilterInput"
429
- typeLinks={{
430
- ID: '/reference/graphql-api/shop/object-types#id',
431
- }}
432
- >
433
- {`"""
434
- Used to construct boolean expressions for filtering search results
435
- by FacetValue ID. Examples:
436
-
437
- * ID=1 OR ID=2: \`{ facetValueFilters: [{ or: [1,2] }] }\`
438
- * ID=1 AND ID=2: \`{ facetValueFilters: [{ and: 1 }, { and: 2 }] }\`
439
- * ID=1 AND (ID=2 OR ID=3): \`{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }\`
440
- """
441
- input FacetValueFilterInput {
442
- and: ID
443
- or: [ID!]
444
- }`}
445
- </GraphQLDoc>
446
-
447
- ## FacetValueFilterParameter {#facetvaluefilterparameter}
448
-
449
- <GraphQLDoc
450
- type="input"
451
- typeName="FacetValueFilterParameter"
452
- typeLinks={{
453
- IDOperators: '/reference/graphql-api/shop/input-types#idoperators',
454
- DateOperators: '/reference/graphql-api/shop/input-types#dateoperators',
455
- StringOperators: '/reference/graphql-api/shop/input-types#stringoperators',
456
- FacetValueFilterParameter: '/reference/graphql-api/shop/input-types#facetvaluefilterparameter',
457
- }}
458
- >
459
- {`input FacetValueFilterParameter {
460
- id: IDOperators
461
- createdAt: DateOperators
462
- updatedAt: DateOperators
463
- languageCode: StringOperators
464
- facetId: IDOperators
465
- name: StringOperators
466
- code: StringOperators
467
- _and: [FacetValueFilterParameter!]
468
- _or: [FacetValueFilterParameter!]
469
- }`}
470
- </GraphQLDoc>
471
-
472
- ## FacetValueListOptions {#facetvaluelistoptions}
473
-
474
- <GraphQLDoc
475
- type="input"
476
- typeName="FacetValueListOptions"
477
- typeLinks={{
478
- Int: '/reference/graphql-api/shop/object-types#int',
479
- FacetValueSortParameter: '/reference/graphql-api/shop/input-types#facetvaluesortparameter',
480
- FacetValueFilterParameter: '/reference/graphql-api/shop/input-types#facetvaluefilterparameter',
481
- LogicalOperator: '/reference/graphql-api/shop/enums#logicaloperator',
482
- }}
483
- >
484
- {`input FacetValueListOptions {
485
- """Skips the first n results, for use in pagination"""
486
- skip: Int
487
- """Takes n results, for use in pagination"""
488
- take: Int
489
- """Specifies which properties to sort the results by"""
490
- sort: FacetValueSortParameter
491
- """Allows the results to be filtered"""
492
- filter: FacetValueFilterParameter
493
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
494
- filterOperator: LogicalOperator
495
- }`}
496
- </GraphQLDoc>
497
-
498
- ## FacetValueSortParameter {#facetvaluesortparameter}
499
-
500
- <GraphQLDoc
501
- type="input"
502
- typeName="FacetValueSortParameter"
503
- typeLinks={{
504
- SortOrder: '/reference/graphql-api/shop/enums#sortorder',
505
- }}
506
- >
507
- {`input FacetValueSortParameter {
508
- id: SortOrder
509
- createdAt: SortOrder
510
- updatedAt: SortOrder
511
- facetId: SortOrder
512
- name: SortOrder
513
- code: SortOrder
514
- }`}
515
- </GraphQLDoc>
516
-
517
- ## HistoryEntryFilterParameter {#historyentryfilterparameter}
518
-
519
- <GraphQLDoc
520
- type="input"
521
- typeName="HistoryEntryFilterParameter"
522
- typeLinks={{
523
- IDOperators: '/reference/graphql-api/shop/input-types#idoperators',
524
- DateOperators: '/reference/graphql-api/shop/input-types#dateoperators',
525
- StringOperators: '/reference/graphql-api/shop/input-types#stringoperators',
526
- HistoryEntryFilterParameter: '/reference/graphql-api/shop/input-types#historyentryfilterparameter',
527
- }}
528
- >
529
- {`input HistoryEntryFilterParameter {
530
- id: IDOperators
531
- createdAt: DateOperators
532
- updatedAt: DateOperators
533
- type: StringOperators
534
- _and: [HistoryEntryFilterParameter!]
535
- _or: [HistoryEntryFilterParameter!]
536
- }`}
537
- </GraphQLDoc>
538
-
539
- ## HistoryEntryListOptions {#historyentrylistoptions}
540
-
541
- <GraphQLDoc
542
- type="input"
543
- typeName="HistoryEntryListOptions"
544
- typeLinks={{
545
- Int: '/reference/graphql-api/shop/object-types#int',
546
- HistoryEntrySortParameter: '/reference/graphql-api/shop/input-types#historyentrysortparameter',
547
- HistoryEntryFilterParameter: '/reference/graphql-api/shop/input-types#historyentryfilterparameter',
548
- LogicalOperator: '/reference/graphql-api/shop/enums#logicaloperator',
549
- }}
550
- >
551
- {`input HistoryEntryListOptions {
552
- """Skips the first n results, for use in pagination"""
553
- skip: Int
554
- """Takes n results, for use in pagination"""
555
- take: Int
556
- """Specifies which properties to sort the results by"""
557
- sort: HistoryEntrySortParameter
558
- """Allows the results to be filtered"""
559
- filter: HistoryEntryFilterParameter
560
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
561
- filterOperator: LogicalOperator
562
- }`}
563
- </GraphQLDoc>
564
-
565
- ## HistoryEntrySortParameter {#historyentrysortparameter}
566
-
567
- <GraphQLDoc
568
- type="input"
569
- typeName="HistoryEntrySortParameter"
570
- typeLinks={{
571
- SortOrder: '/reference/graphql-api/shop/enums#sortorder',
572
- }}
573
- >
574
- {`input HistoryEntrySortParameter {
575
- id: SortOrder
576
- createdAt: SortOrder
577
- updatedAt: SortOrder
578
- }`}
579
- </GraphQLDoc>
580
-
581
- ## IDListOperators {#idlistoperators}
582
-
583
- <GraphQLDoc
584
- type="input"
585
- typeName="IDListOperators"
586
- typeLinks={{
587
- ID: '/reference/graphql-api/shop/object-types#id',
588
- }}
589
- >
590
- {`"""Operators for filtering on a list of ID fields"""
591
- input IDListOperators {
592
- inList: ID!
593
- }`}
594
- </GraphQLDoc>
595
-
596
- ## IDOperators {#idoperators}
597
-
598
- <GraphQLDoc
599
- type="input"
600
- typeName="IDOperators"
601
- typeLinks={{
602
- String: '/reference/graphql-api/shop/object-types#string',
603
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
604
- }}
605
- >
606
- {`"""Operators for filtering on an ID field"""
607
- input IDOperators {
608
- eq: String
609
- notEq: String
610
- in: [String!]
611
- notIn: [String!]
612
- isNull: Boolean
613
- }`}
614
- </GraphQLDoc>
615
-
616
- ## NativeAuthInput {#nativeauthinput}
617
-
618
- <GraphQLDoc
619
- type="input"
620
- typeName="NativeAuthInput"
621
- typeLinks={{
622
- String: '/reference/graphql-api/shop/object-types#string',
623
- }}
624
- >
625
- {`input NativeAuthInput {
626
- username: String!
627
- password: String!
628
- }`}
629
- </GraphQLDoc>
630
-
631
- ## NumberListOperators {#numberlistoperators}
632
-
633
- <GraphQLDoc
634
- type="input"
635
- typeName="NumberListOperators"
636
- typeLinks={{
637
- Float: '/reference/graphql-api/shop/object-types#float',
638
- }}
639
- >
640
- {`"""Operators for filtering on a list of Number fields"""
641
- input NumberListOperators {
642
- inList: Float!
643
- }`}
644
- </GraphQLDoc>
645
-
646
- ## NumberOperators {#numberoperators}
647
-
648
- <GraphQLDoc
649
- type="input"
650
- typeName="NumberOperators"
651
- typeLinks={{
652
- Float: '/reference/graphql-api/shop/object-types#float',
653
- NumberRange: '/reference/graphql-api/shop/input-types#numberrange',
654
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
655
- }}
656
- >
657
- {`"""Operators for filtering on a Int or Float field"""
658
- input NumberOperators {
659
- eq: Float
660
- lt: Float
661
- lte: Float
662
- gt: Float
663
- gte: Float
664
- between: NumberRange
665
- isNull: Boolean
666
- }`}
667
- </GraphQLDoc>
668
-
669
- ## NumberRange {#numberrange}
670
-
671
- <GraphQLDoc
672
- type="input"
673
- typeName="NumberRange"
674
- typeLinks={{
675
- Float: '/reference/graphql-api/shop/object-types#float',
676
- }}
677
- >
678
- {`input NumberRange {
679
- start: Float!
680
- end: Float!
681
- }`}
682
- </GraphQLDoc>
683
-
684
- ## OrderFilterParameter {#orderfilterparameter}
685
-
686
- <GraphQLDoc
687
- type="input"
688
- typeName="OrderFilterParameter"
689
- typeLinks={{
690
- IDOperators: '/reference/graphql-api/shop/input-types#idoperators',
691
- DateOperators: '/reference/graphql-api/shop/input-types#dateoperators',
692
- StringOperators: '/reference/graphql-api/shop/input-types#stringoperators',
693
- BooleanOperators: '/reference/graphql-api/shop/input-types#booleanoperators',
694
- NumberOperators: '/reference/graphql-api/shop/input-types#numberoperators',
695
- OrderFilterParameter: '/reference/graphql-api/shop/input-types#orderfilterparameter',
696
- }}
697
- >
698
- {`input OrderFilterParameter {
699
- id: IDOperators
700
- createdAt: DateOperators
701
- updatedAt: DateOperators
702
- type: StringOperators
703
- orderPlacedAt: DateOperators
704
- code: StringOperators
705
- state: StringOperators
706
- active: BooleanOperators
707
- totalQuantity: NumberOperators
708
- subTotal: NumberOperators
709
- subTotalWithTax: NumberOperators
710
- currencyCode: StringOperators
711
- shipping: NumberOperators
712
- shippingWithTax: NumberOperators
713
- total: NumberOperators
714
- totalWithTax: NumberOperators
715
- _and: [OrderFilterParameter!]
716
- _or: [OrderFilterParameter!]
717
- }`}
718
- </GraphQLDoc>
719
-
720
- ## OrderListOptions {#orderlistoptions}
721
-
722
- <GraphQLDoc
723
- type="input"
724
- typeName="OrderListOptions"
725
- typeLinks={{
726
- Int: '/reference/graphql-api/shop/object-types#int',
727
- OrderSortParameter: '/reference/graphql-api/shop/input-types#ordersortparameter',
728
- OrderFilterParameter: '/reference/graphql-api/shop/input-types#orderfilterparameter',
729
- LogicalOperator: '/reference/graphql-api/shop/enums#logicaloperator',
730
- }}
731
- >
732
- {`input OrderListOptions {
733
- """Skips the first n results, for use in pagination"""
734
- skip: Int
735
- """Takes n results, for use in pagination"""
736
- take: Int
737
- """Specifies which properties to sort the results by"""
738
- sort: OrderSortParameter
739
- """Allows the results to be filtered"""
740
- filter: OrderFilterParameter
741
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
742
- filterOperator: LogicalOperator
743
- }`}
744
- </GraphQLDoc>
745
-
746
- ## OrderSortParameter {#ordersortparameter}
747
-
748
- <GraphQLDoc
749
- type="input"
750
- typeName="OrderSortParameter"
751
- typeLinks={{
752
- SortOrder: '/reference/graphql-api/shop/enums#sortorder',
753
- }}
754
- >
755
- {`input OrderSortParameter {
756
- id: SortOrder
757
- createdAt: SortOrder
758
- updatedAt: SortOrder
759
- orderPlacedAt: SortOrder
760
- code: SortOrder
761
- state: SortOrder
762
- totalQuantity: SortOrder
763
- subTotal: SortOrder
764
- subTotalWithTax: SortOrder
765
- shipping: SortOrder
766
- shippingWithTax: SortOrder
767
- total: SortOrder
768
- totalWithTax: SortOrder
769
- }`}
770
- </GraphQLDoc>
771
-
772
- ## PaymentInput {#paymentinput}
773
-
774
- <GraphQLDoc
775
- type="input"
776
- typeName="PaymentInput"
777
- typeLinks={{
778
- String: '/reference/graphql-api/shop/object-types#string',
779
- JSON: '/reference/graphql-api/shop/object-types#json',
780
- }}
781
- >
782
- {`"""Passed as input to the \`addPaymentToOrder\` mutation."""
783
- input PaymentInput {
784
- """This field should correspond to the \`code\` property of a PaymentMethod."""
785
- method: String!
786
- """
787
- This field should contain arbitrary data passed to the specified PaymentMethodHandler's \`createPayment()\` method
788
- as the "metadata" argument. For example, it could contain an ID for the payment and other
789
- data generated by the payment provider.
790
- """
791
- metadata: JSON!
792
- }`}
793
- </GraphQLDoc>
794
-
795
- ## ProductFilterParameter {#productfilterparameter}
796
-
797
- <GraphQLDoc
798
- type="input"
799
- typeName="ProductFilterParameter"
800
- typeLinks={{
801
- IDOperators: '/reference/graphql-api/shop/input-types#idoperators',
802
- DateOperators: '/reference/graphql-api/shop/input-types#dateoperators',
803
- StringOperators: '/reference/graphql-api/shop/input-types#stringoperators',
804
- BooleanOperators: '/reference/graphql-api/shop/input-types#booleanoperators',
805
- ProductFilterParameter: '/reference/graphql-api/shop/input-types#productfilterparameter',
806
- }}
807
- >
808
- {`input ProductFilterParameter {
809
- id: IDOperators
810
- createdAt: DateOperators
811
- updatedAt: DateOperators
812
- languageCode: StringOperators
813
- name: StringOperators
814
- slug: StringOperators
815
- description: StringOperators
816
- enabled: BooleanOperators
817
- _and: [ProductFilterParameter!]
818
- _or: [ProductFilterParameter!]
819
- }`}
820
- </GraphQLDoc>
821
-
822
- ## ProductListOptions {#productlistoptions}
823
-
824
- <GraphQLDoc
825
- type="input"
826
- typeName="ProductListOptions"
827
- typeLinks={{
828
- Int: '/reference/graphql-api/shop/object-types#int',
829
- ProductSortParameter: '/reference/graphql-api/shop/input-types#productsortparameter',
830
- ProductFilterParameter: '/reference/graphql-api/shop/input-types#productfilterparameter',
831
- LogicalOperator: '/reference/graphql-api/shop/enums#logicaloperator',
832
- }}
833
- >
834
- {`input ProductListOptions {
835
- """Skips the first n results, for use in pagination"""
836
- skip: Int
837
- """Takes n results, for use in pagination"""
838
- take: Int
839
- """Specifies which properties to sort the results by"""
840
- sort: ProductSortParameter
841
- """Allows the results to be filtered"""
842
- filter: ProductFilterParameter
843
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
844
- filterOperator: LogicalOperator
845
- }`}
846
- </GraphQLDoc>
847
-
848
- ## ProductSortParameter {#productsortparameter}
849
-
850
- <GraphQLDoc
851
- type="input"
852
- typeName="ProductSortParameter"
853
- typeLinks={{
854
- SortOrder: '/reference/graphql-api/shop/enums#sortorder',
855
- }}
856
- >
857
- {`input ProductSortParameter {
858
- id: SortOrder
859
- createdAt: SortOrder
860
- updatedAt: SortOrder
861
- name: SortOrder
862
- slug: SortOrder
863
- description: SortOrder
864
- }`}
865
- </GraphQLDoc>
866
-
867
- ## ProductVariantFilterParameter {#productvariantfilterparameter}
868
-
869
- <GraphQLDoc
870
- type="input"
871
- typeName="ProductVariantFilterParameter"
872
- typeLinks={{
873
- IDOperators: '/reference/graphql-api/shop/input-types#idoperators',
874
- DateOperators: '/reference/graphql-api/shop/input-types#dateoperators',
875
- StringOperators: '/reference/graphql-api/shop/input-types#stringoperators',
876
- NumberOperators: '/reference/graphql-api/shop/input-types#numberoperators',
877
- ProductVariantFilterParameter: '/reference/graphql-api/shop/input-types#productvariantfilterparameter',
878
- }}
879
- >
880
- {`input ProductVariantFilterParameter {
881
- id: IDOperators
882
- productId: IDOperators
883
- createdAt: DateOperators
884
- updatedAt: DateOperators
885
- languageCode: StringOperators
886
- sku: StringOperators
887
- name: StringOperators
888
- price: NumberOperators
889
- currencyCode: StringOperators
890
- priceWithTax: NumberOperators
891
- stockLevel: StringOperators
892
- _and: [ProductVariantFilterParameter!]
893
- _or: [ProductVariantFilterParameter!]
894
- }`}
895
- </GraphQLDoc>
896
-
897
- ## ProductVariantListOptions {#productvariantlistoptions}
898
-
899
- <GraphQLDoc
900
- type="input"
901
- typeName="ProductVariantListOptions"
902
- typeLinks={{
903
- Int: '/reference/graphql-api/shop/object-types#int',
904
- ProductVariantSortParameter: '/reference/graphql-api/shop/input-types#productvariantsortparameter',
905
- ProductVariantFilterParameter: '/reference/graphql-api/shop/input-types#productvariantfilterparameter',
906
- LogicalOperator: '/reference/graphql-api/shop/enums#logicaloperator',
907
- }}
908
- >
909
- {`input ProductVariantListOptions {
910
- """Skips the first n results, for use in pagination"""
911
- skip: Int
912
- """Takes n results, for use in pagination"""
913
- take: Int
914
- """Specifies which properties to sort the results by"""
915
- sort: ProductVariantSortParameter
916
- """Allows the results to be filtered"""
917
- filter: ProductVariantFilterParameter
918
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
919
- filterOperator: LogicalOperator
920
- }`}
921
- </GraphQLDoc>
922
-
923
- ## ProductVariantSortParameter {#productvariantsortparameter}
924
-
925
- <GraphQLDoc
926
- type="input"
927
- typeName="ProductVariantSortParameter"
928
- typeLinks={{
929
- SortOrder: '/reference/graphql-api/shop/enums#sortorder',
930
- }}
931
- >
932
- {`input ProductVariantSortParameter {
933
- id: SortOrder
934
- productId: SortOrder
935
- createdAt: SortOrder
936
- updatedAt: SortOrder
937
- sku: SortOrder
938
- name: SortOrder
939
- price: SortOrder
940
- priceWithTax: SortOrder
941
- stockLevel: SortOrder
942
- }`}
943
- </GraphQLDoc>
944
-
945
- ## RegisterCustomerInput {#registercustomerinput}
946
-
947
- <GraphQLDoc
948
- type="input"
949
- typeName="RegisterCustomerInput"
950
- typeLinks={{
951
- String: '/reference/graphql-api/shop/object-types#string',
952
- }}
953
- >
954
- {`input RegisterCustomerInput {
955
- emailAddress: String!
956
- title: String
957
- firstName: String
958
- lastName: String
959
- phoneNumber: String
960
- password: String
961
- }`}
962
- </GraphQLDoc>
963
-
964
- ## SearchInput {#searchinput}
965
-
966
- <GraphQLDoc
967
- type="input"
968
- typeName="SearchInput"
969
- typeLinks={{
970
- String: '/reference/graphql-api/shop/object-types#string',
971
- ID: '/reference/graphql-api/shop/object-types#id',
972
- LogicalOperator: '/reference/graphql-api/shop/enums#logicaloperator',
973
- FacetValueFilterInput: '/reference/graphql-api/shop/input-types#facetvaluefilterinput',
974
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
975
- Int: '/reference/graphql-api/shop/object-types#int',
976
- SearchResultSortParameter: '/reference/graphql-api/shop/input-types#searchresultsortparameter',
977
- }}
978
- >
979
- {`input SearchInput {
980
- term: String
981
- facetValueIds: [ID!]
982
- facetValueOperator: LogicalOperator
983
- facetValueFilters: [FacetValueFilterInput!]
984
- collectionId: ID
985
- collectionSlug: String
986
- groupByProduct: Boolean
987
- take: Int
988
- skip: Int
989
- sort: SearchResultSortParameter
990
- }`}
991
- </GraphQLDoc>
992
-
993
- ## SearchResultSortParameter {#searchresultsortparameter}
994
-
995
- <GraphQLDoc
996
- type="input"
997
- typeName="SearchResultSortParameter"
998
- typeLinks={{
999
- SortOrder: '/reference/graphql-api/shop/enums#sortorder',
1000
- }}
1001
- >
1002
- {`input SearchResultSortParameter {
1003
- name: SortOrder
1004
- price: SortOrder
1005
- }`}
1006
- </GraphQLDoc>
1007
-
1008
- ## StringListOperators {#stringlistoperators}
1009
-
1010
- <GraphQLDoc
1011
- type="input"
1012
- typeName="StringListOperators"
1013
- typeLinks={{
1014
- String: '/reference/graphql-api/shop/object-types#string',
1015
- }}
1016
- >
1017
- {`"""Operators for filtering on a list of String fields"""
1018
- input StringListOperators {
1019
- inList: String!
1020
- }`}
1021
- </GraphQLDoc>
1022
-
1023
- ## StringOperators {#stringoperators}
1024
-
1025
- <GraphQLDoc
1026
- type="input"
1027
- typeName="StringOperators"
1028
- typeLinks={{
1029
- String: '/reference/graphql-api/shop/object-types#string',
1030
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
1031
- }}
1032
- >
1033
- {`"""Operators for filtering on a String field"""
1034
- input StringOperators {
1035
- eq: String
1036
- notEq: String
1037
- contains: String
1038
- notContains: String
1039
- in: [String!]
1040
- notIn: [String!]
1041
- regex: String
1042
- isNull: Boolean
1043
- }`}
1044
- </GraphQLDoc>
1045
-
1046
- ## UpdateAddressInput {#updateaddressinput}
1047
-
1048
- <GraphQLDoc
1049
- type="input"
1050
- typeName="UpdateAddressInput"
1051
- typeLinks={{
1052
- ID: '/reference/graphql-api/shop/object-types#id',
1053
- String: '/reference/graphql-api/shop/object-types#string',
1054
- Boolean: '/reference/graphql-api/shop/object-types#boolean',
1055
- JSON: '/reference/graphql-api/shop/object-types#json',
1056
- }}
1057
- >
1058
- {`"""
1059
- Input used to update an Address.
1060
-
1061
- The countryCode must correspond to a \`code\` property of a Country that has been defined in the
1062
- Vendure server. The \`code\` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
1063
- If an invalid code is passed, the mutation will fail.
1064
- """
1065
- input UpdateAddressInput {
1066
- id: ID!
1067
- fullName: String
1068
- company: String
1069
- streetLine1: String
1070
- streetLine2: String
1071
- city: String
1072
- province: String
1073
- postalCode: String
1074
- countryCode: String
1075
- phoneNumber: String
1076
- defaultShippingAddress: Boolean
1077
- defaultBillingAddress: Boolean
1078
- customFields: JSON
1079
- }`}
1080
- </GraphQLDoc>
1081
-
1082
- ## UpdateCustomerInput {#updatecustomerinput}
1083
-
1084
- <GraphQLDoc
1085
- type="input"
1086
- typeName="UpdateCustomerInput"
1087
- typeLinks={{
1088
- String: '/reference/graphql-api/shop/object-types#string',
1089
- JSON: '/reference/graphql-api/shop/object-types#json',
1090
- }}
1091
- >
1092
- {`input UpdateCustomerInput {
1093
- title: String
1094
- firstName: String
1095
- lastName: String
1096
- phoneNumber: String
1097
- customFields: JSON
1098
- }`}
1099
- </GraphQLDoc>
1100
-
1101
- ## UpdateOrderInput {#updateorderinput}
1102
-
1103
- <GraphQLDoc
1104
- type="input"
1105
- typeName="UpdateOrderInput"
1106
- typeLinks={{
1107
- JSON: '/reference/graphql-api/shop/object-types#json',
1108
- }}
1109
- >
1110
- {`input UpdateOrderInput {
1111
- customFields: JSON
1112
- }`}
1113
- </GraphQLDoc>