@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,4708 +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/admin/object-types#id',
15
- Int: '/reference/graphql-api/admin/object-types#int',
16
- }}
17
- >
18
- {`input AddItemInput {
19
- productVariantId: ID!
20
- quantity: Int!
21
- }`}
22
- </GraphQLDoc>
23
-
24
- ## AddItemToDraftOrderInput {#additemtodraftorderinput}
25
-
26
- <GraphQLDoc
27
- type="input"
28
- typeName="AddItemToDraftOrderInput"
29
- typeLinks={{
30
- ID: '/reference/graphql-api/admin/object-types#id',
31
- Int: '/reference/graphql-api/admin/object-types#int',
32
- }}
33
- >
34
- {`input AddItemToDraftOrderInput {
35
- productVariantId: ID!
36
- quantity: Int!
37
- }`}
38
- </GraphQLDoc>
39
-
40
- ## AddNoteToCustomerInput {#addnotetocustomerinput}
41
-
42
- <GraphQLDoc
43
- type="input"
44
- typeName="AddNoteToCustomerInput"
45
- typeLinks={{
46
- ID: '/reference/graphql-api/admin/object-types#id',
47
- String: '/reference/graphql-api/admin/object-types#string',
48
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
49
- }}
50
- >
51
- {`input AddNoteToCustomerInput {
52
- id: ID!
53
- note: String!
54
- isPublic: Boolean!
55
- }`}
56
- </GraphQLDoc>
57
-
58
- ## AddNoteToOrderInput {#addnotetoorderinput}
59
-
60
- <GraphQLDoc
61
- type="input"
62
- typeName="AddNoteToOrderInput"
63
- typeLinks={{
64
- ID: '/reference/graphql-api/admin/object-types#id',
65
- String: '/reference/graphql-api/admin/object-types#string',
66
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
67
- }}
68
- >
69
- {`input AddNoteToOrderInput {
70
- id: ID!
71
- note: String!
72
- isPublic: Boolean!
73
- }`}
74
- </GraphQLDoc>
75
-
76
- ## AdjustDraftOrderLineInput {#adjustdraftorderlineinput}
77
-
78
- <GraphQLDoc
79
- type="input"
80
- typeName="AdjustDraftOrderLineInput"
81
- typeLinks={{
82
- ID: '/reference/graphql-api/admin/object-types#id',
83
- Int: '/reference/graphql-api/admin/object-types#int',
84
- }}
85
- >
86
- {`input AdjustDraftOrderLineInput {
87
- orderLineId: ID!
88
- quantity: Int!
89
- }`}
90
- </GraphQLDoc>
91
-
92
- ## AdministratorFilterParameter {#administratorfilterparameter}
93
-
94
- <GraphQLDoc
95
- type="input"
96
- typeName="AdministratorFilterParameter"
97
- typeLinks={{
98
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
99
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
100
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
101
- AdministratorFilterParameter: '/reference/graphql-api/admin/input-types#administratorfilterparameter',
102
- }}
103
- >
104
- {`input AdministratorFilterParameter {
105
- id: IDOperators
106
- createdAt: DateOperators
107
- updatedAt: DateOperators
108
- firstName: StringOperators
109
- lastName: StringOperators
110
- emailAddress: StringOperators
111
- _and: [AdministratorFilterParameter!]
112
- _or: [AdministratorFilterParameter!]
113
- }`}
114
- </GraphQLDoc>
115
-
116
- ## AdministratorListOptions {#administratorlistoptions}
117
-
118
- <GraphQLDoc
119
- type="input"
120
- typeName="AdministratorListOptions"
121
- typeLinks={{
122
- Int: '/reference/graphql-api/admin/object-types#int',
123
- AdministratorSortParameter: '/reference/graphql-api/admin/input-types#administratorsortparameter',
124
- AdministratorFilterParameter: '/reference/graphql-api/admin/input-types#administratorfilterparameter',
125
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
126
- }}
127
- >
128
- {`input AdministratorListOptions {
129
- """Skips the first n results, for use in pagination"""
130
- skip: Int
131
- """Takes n results, for use in pagination"""
132
- take: Int
133
- """Specifies which properties to sort the results by"""
134
- sort: AdministratorSortParameter
135
- """Allows the results to be filtered"""
136
- filter: AdministratorFilterParameter
137
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
138
- filterOperator: LogicalOperator
139
- }`}
140
- </GraphQLDoc>
141
-
142
- ## AdministratorPaymentInput {#administratorpaymentinput}
143
-
144
- <GraphQLDoc
145
- type="input"
146
- typeName="AdministratorPaymentInput"
147
- typeLinks={{
148
- String: '/reference/graphql-api/admin/object-types#string',
149
- JSON: '/reference/graphql-api/admin/object-types#json',
150
- }}
151
- >
152
- {`input AdministratorPaymentInput {
153
- paymentMethod: String
154
- metadata: JSON
155
- }`}
156
- </GraphQLDoc>
157
-
158
- ## AdministratorRefundInput {#administratorrefundinput}
159
-
160
- <GraphQLDoc
161
- type="input"
162
- typeName="AdministratorRefundInput"
163
- typeLinks={{
164
- ID: '/reference/graphql-api/admin/object-types#id',
165
- String: '/reference/graphql-api/admin/object-types#string',
166
- Money: '/reference/graphql-api/admin/object-types#money',
167
- }}
168
- >
169
- {`input AdministratorRefundInput {
170
- paymentId: ID!
171
- reason: String
172
- """
173
- The amount to be refunded to this particular Payment. This was introduced in
174
- v2.2.0 as the preferred way to specify the refund amount. The \`lines\`, \`shipping\` and \`adjustment\`
175
- fields will be removed in a future version.
176
- """
177
- amount: Money
178
- }`}
179
- </GraphQLDoc>
180
-
181
- ## AdministratorSortParameter {#administratorsortparameter}
182
-
183
- <GraphQLDoc
184
- type="input"
185
- typeName="AdministratorSortParameter"
186
- typeLinks={{
187
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
188
- }}
189
- >
190
- {`input AdministratorSortParameter {
191
- id: SortOrder
192
- createdAt: SortOrder
193
- updatedAt: SortOrder
194
- firstName: SortOrder
195
- lastName: SortOrder
196
- emailAddress: SortOrder
197
- }`}
198
- </GraphQLDoc>
199
-
200
- ## AssetFilterParameter {#assetfilterparameter}
201
-
202
- <GraphQLDoc
203
- type="input"
204
- typeName="AssetFilterParameter"
205
- typeLinks={{
206
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
207
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
208
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
209
- NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
210
- AssetFilterParameter: '/reference/graphql-api/admin/input-types#assetfilterparameter',
211
- }}
212
- >
213
- {`input AssetFilterParameter {
214
- id: IDOperators
215
- createdAt: DateOperators
216
- updatedAt: DateOperators
217
- name: StringOperators
218
- type: StringOperators
219
- fileSize: NumberOperators
220
- mimeType: StringOperators
221
- width: NumberOperators
222
- height: NumberOperators
223
- source: StringOperators
224
- preview: StringOperators
225
- _and: [AssetFilterParameter!]
226
- _or: [AssetFilterParameter!]
227
- }`}
228
- </GraphQLDoc>
229
-
230
- ## AssetListOptions {#assetlistoptions}
231
-
232
- <GraphQLDoc
233
- type="input"
234
- typeName="AssetListOptions"
235
- typeLinks={{
236
- String: '/reference/graphql-api/admin/object-types#string',
237
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
238
- Int: '/reference/graphql-api/admin/object-types#int',
239
- AssetSortParameter: '/reference/graphql-api/admin/input-types#assetsortparameter',
240
- AssetFilterParameter: '/reference/graphql-api/admin/input-types#assetfilterparameter',
241
- }}
242
- >
243
- {`input AssetListOptions {
244
- tags: [String!]
245
- tagsOperator: LogicalOperator
246
- """Skips the first n results, for use in pagination"""
247
- skip: Int
248
- """Takes n results, for use in pagination"""
249
- take: Int
250
- """Specifies which properties to sort the results by"""
251
- sort: AssetSortParameter
252
- """Allows the results to be filtered"""
253
- filter: AssetFilterParameter
254
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
255
- filterOperator: LogicalOperator
256
- }`}
257
- </GraphQLDoc>
258
-
259
- ## AssetSortParameter {#assetsortparameter}
260
-
261
- <GraphQLDoc
262
- type="input"
263
- typeName="AssetSortParameter"
264
- typeLinks={{
265
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
266
- }}
267
- >
268
- {`input AssetSortParameter {
269
- id: SortOrder
270
- createdAt: SortOrder
271
- updatedAt: SortOrder
272
- name: SortOrder
273
- fileSize: SortOrder
274
- mimeType: SortOrder
275
- width: SortOrder
276
- height: SortOrder
277
- source: SortOrder
278
- preview: SortOrder
279
- }`}
280
- </GraphQLDoc>
281
-
282
- ## AssignAssetsToChannelInput {#assignassetstochannelinput}
283
-
284
- <GraphQLDoc
285
- type="input"
286
- typeName="AssignAssetsToChannelInput"
287
- typeLinks={{
288
- ID: '/reference/graphql-api/admin/object-types#id',
289
- }}
290
- >
291
- {`input AssignAssetsToChannelInput {
292
- assetIds: [ID!]!
293
- channelId: ID!
294
- }`}
295
- </GraphQLDoc>
296
-
297
- ## AssignCollectionsToChannelInput {#assigncollectionstochannelinput}
298
-
299
- <GraphQLDoc
300
- type="input"
301
- typeName="AssignCollectionsToChannelInput"
302
- typeLinks={{
303
- ID: '/reference/graphql-api/admin/object-types#id',
304
- }}
305
- >
306
- {`input AssignCollectionsToChannelInput {
307
- collectionIds: [ID!]!
308
- channelId: ID!
309
- }`}
310
- </GraphQLDoc>
311
-
312
- ## AssignFacetsToChannelInput {#assignfacetstochannelinput}
313
-
314
- <GraphQLDoc
315
- type="input"
316
- typeName="AssignFacetsToChannelInput"
317
- typeLinks={{
318
- ID: '/reference/graphql-api/admin/object-types#id',
319
- }}
320
- >
321
- {`input AssignFacetsToChannelInput {
322
- facetIds: [ID!]!
323
- channelId: ID!
324
- }`}
325
- </GraphQLDoc>
326
-
327
- ## AssignPaymentMethodsToChannelInput {#assignpaymentmethodstochannelinput}
328
-
329
- <GraphQLDoc
330
- type="input"
331
- typeName="AssignPaymentMethodsToChannelInput"
332
- typeLinks={{
333
- ID: '/reference/graphql-api/admin/object-types#id',
334
- }}
335
- >
336
- {`input AssignPaymentMethodsToChannelInput {
337
- paymentMethodIds: [ID!]!
338
- channelId: ID!
339
- }`}
340
- </GraphQLDoc>
341
-
342
- ## AssignProductVariantsToChannelInput {#assignproductvariantstochannelinput}
343
-
344
- <GraphQLDoc
345
- type="input"
346
- typeName="AssignProductVariantsToChannelInput"
347
- typeLinks={{
348
- ID: '/reference/graphql-api/admin/object-types#id',
349
- Float: '/reference/graphql-api/admin/object-types#float',
350
- }}
351
- >
352
- {`input AssignProductVariantsToChannelInput {
353
- productVariantIds: [ID!]!
354
- channelId: ID!
355
- priceFactor: Float
356
- }`}
357
- </GraphQLDoc>
358
-
359
- ## AssignProductsToChannelInput {#assignproductstochannelinput}
360
-
361
- <GraphQLDoc
362
- type="input"
363
- typeName="AssignProductsToChannelInput"
364
- typeLinks={{
365
- ID: '/reference/graphql-api/admin/object-types#id',
366
- Float: '/reference/graphql-api/admin/object-types#float',
367
- }}
368
- >
369
- {`input AssignProductsToChannelInput {
370
- productIds: [ID!]!
371
- channelId: ID!
372
- priceFactor: Float
373
- }`}
374
- </GraphQLDoc>
375
-
376
- ## AssignPromotionsToChannelInput {#assignpromotionstochannelinput}
377
-
378
- <GraphQLDoc
379
- type="input"
380
- typeName="AssignPromotionsToChannelInput"
381
- typeLinks={{
382
- ID: '/reference/graphql-api/admin/object-types#id',
383
- }}
384
- >
385
- {`input AssignPromotionsToChannelInput {
386
- promotionIds: [ID!]!
387
- channelId: ID!
388
- }`}
389
- </GraphQLDoc>
390
-
391
- ## AssignShippingMethodsToChannelInput {#assignshippingmethodstochannelinput}
392
-
393
- <GraphQLDoc
394
- type="input"
395
- typeName="AssignShippingMethodsToChannelInput"
396
- typeLinks={{
397
- ID: '/reference/graphql-api/admin/object-types#id',
398
- }}
399
- >
400
- {`input AssignShippingMethodsToChannelInput {
401
- shippingMethodIds: [ID!]!
402
- channelId: ID!
403
- }`}
404
- </GraphQLDoc>
405
-
406
- ## AssignStockLocationsToChannelInput {#assignstocklocationstochannelinput}
407
-
408
- <GraphQLDoc
409
- type="input"
410
- typeName="AssignStockLocationsToChannelInput"
411
- typeLinks={{
412
- ID: '/reference/graphql-api/admin/object-types#id',
413
- }}
414
- >
415
- {`input AssignStockLocationsToChannelInput {
416
- stockLocationIds: [ID!]!
417
- channelId: ID!
418
- }`}
419
- </GraphQLDoc>
420
-
421
- ## AuthenticationInput {#authenticationinput}
422
-
423
- <GraphQLDoc
424
- type="input"
425
- typeName="AuthenticationInput"
426
- typeLinks={{
427
- NativeAuthInput: '/reference/graphql-api/admin/input-types#nativeauthinput',
428
- }}
429
- >
430
- {`input AuthenticationInput {
431
- native: NativeAuthInput
432
- }`}
433
- </GraphQLDoc>
434
-
435
- ## BooleanListOperators {#booleanlistoperators}
436
-
437
- <GraphQLDoc
438
- type="input"
439
- typeName="BooleanListOperators"
440
- typeLinks={{
441
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
442
- }}
443
- >
444
- {`"""Operators for filtering on a list of Boolean fields"""
445
- input BooleanListOperators {
446
- inList: Boolean!
447
- }`}
448
- </GraphQLDoc>
449
-
450
- ## BooleanOperators {#booleanoperators}
451
-
452
- <GraphQLDoc
453
- type="input"
454
- typeName="BooleanOperators"
455
- typeLinks={{
456
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
457
- }}
458
- >
459
- {`"""Operators for filtering on a Boolean field"""
460
- input BooleanOperators {
461
- eq: Boolean
462
- isNull: Boolean
463
- }`}
464
- </GraphQLDoc>
465
-
466
- ## CancelOrderInput {#cancelorderinput}
467
-
468
- <GraphQLDoc
469
- type="input"
470
- typeName="CancelOrderInput"
471
- typeLinks={{
472
- ID: '/reference/graphql-api/admin/object-types#id',
473
- OrderLineInput: '/reference/graphql-api/admin/input-types#orderlineinput',
474
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
475
- String: '/reference/graphql-api/admin/object-types#string',
476
- }}
477
- >
478
- {`input CancelOrderInput {
479
- """The id of the order to be cancelled"""
480
- orderId: ID!
481
- """Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled"""
482
- lines: [OrderLineInput!]
483
- """Specify whether the shipping charges should also be cancelled. Defaults to false"""
484
- cancelShipping: Boolean
485
- reason: String
486
- }`}
487
- </GraphQLDoc>
488
-
489
- ## ChannelFilterParameter {#channelfilterparameter}
490
-
491
- <GraphQLDoc
492
- type="input"
493
- typeName="ChannelFilterParameter"
494
- typeLinks={{
495
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
496
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
497
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
498
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
499
- NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
500
- ChannelFilterParameter: '/reference/graphql-api/admin/input-types#channelfilterparameter',
501
- }}
502
- >
503
- {`input ChannelFilterParameter {
504
- id: IDOperators
505
- createdAt: DateOperators
506
- updatedAt: DateOperators
507
- code: StringOperators
508
- token: StringOperators
509
- defaultLanguageCode: StringOperators
510
- currencyCode: StringOperators
511
- defaultCurrencyCode: StringOperators
512
- trackInventory: BooleanOperators
513
- outOfStockThreshold: NumberOperators
514
- pricesIncludeTax: BooleanOperators
515
- _and: [ChannelFilterParameter!]
516
- _or: [ChannelFilterParameter!]
517
- }`}
518
- </GraphQLDoc>
519
-
520
- ## ChannelListOptions {#channellistoptions}
521
-
522
- <GraphQLDoc
523
- type="input"
524
- typeName="ChannelListOptions"
525
- typeLinks={{
526
- Int: '/reference/graphql-api/admin/object-types#int',
527
- ChannelSortParameter: '/reference/graphql-api/admin/input-types#channelsortparameter',
528
- ChannelFilterParameter: '/reference/graphql-api/admin/input-types#channelfilterparameter',
529
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
530
- }}
531
- >
532
- {`input ChannelListOptions {
533
- """Skips the first n results, for use in pagination"""
534
- skip: Int
535
- """Takes n results, for use in pagination"""
536
- take: Int
537
- """Specifies which properties to sort the results by"""
538
- sort: ChannelSortParameter
539
- """Allows the results to be filtered"""
540
- filter: ChannelFilterParameter
541
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
542
- filterOperator: LogicalOperator
543
- }`}
544
- </GraphQLDoc>
545
-
546
- ## ChannelSortParameter {#channelsortparameter}
547
-
548
- <GraphQLDoc
549
- type="input"
550
- typeName="ChannelSortParameter"
551
- typeLinks={{
552
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
553
- }}
554
- >
555
- {`input ChannelSortParameter {
556
- id: SortOrder
557
- createdAt: SortOrder
558
- updatedAt: SortOrder
559
- code: SortOrder
560
- token: SortOrder
561
- outOfStockThreshold: SortOrder
562
- }`}
563
- </GraphQLDoc>
564
-
565
- ## CollectionFilterParameter {#collectionfilterparameter}
566
-
567
- <GraphQLDoc
568
- type="input"
569
- typeName="CollectionFilterParameter"
570
- typeLinks={{
571
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
572
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
573
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
574
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
575
- NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
576
- CollectionFilterParameter: '/reference/graphql-api/admin/input-types#collectionfilterparameter',
577
- }}
578
- >
579
- {`input CollectionFilterParameter {
580
- isPrivate: BooleanOperators
581
- inheritFilters: BooleanOperators
582
- id: IDOperators
583
- createdAt: DateOperators
584
- updatedAt: DateOperators
585
- languageCode: StringOperators
586
- name: StringOperators
587
- slug: StringOperators
588
- position: NumberOperators
589
- description: StringOperators
590
- parentId: IDOperators
591
- _and: [CollectionFilterParameter!]
592
- _or: [CollectionFilterParameter!]
593
- }`}
594
- </GraphQLDoc>
595
-
596
- ## CollectionListOptions {#collectionlistoptions}
597
-
598
- <GraphQLDoc
599
- type="input"
600
- typeName="CollectionListOptions"
601
- typeLinks={{
602
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
603
- Int: '/reference/graphql-api/admin/object-types#int',
604
- CollectionSortParameter: '/reference/graphql-api/admin/input-types#collectionsortparameter',
605
- CollectionFilterParameter: '/reference/graphql-api/admin/input-types#collectionfilterparameter',
606
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
607
- }}
608
- >
609
- {`input CollectionListOptions {
610
- topLevelOnly: Boolean
611
- """Skips the first n results, for use in pagination"""
612
- skip: Int
613
- """Takes n results, for use in pagination"""
614
- take: Int
615
- """Specifies which properties to sort the results by"""
616
- sort: CollectionSortParameter
617
- """Allows the results to be filtered"""
618
- filter: CollectionFilterParameter
619
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
620
- filterOperator: LogicalOperator
621
- }`}
622
- </GraphQLDoc>
623
-
624
- ## CollectionSortParameter {#collectionsortparameter}
625
-
626
- <GraphQLDoc
627
- type="input"
628
- typeName="CollectionSortParameter"
629
- typeLinks={{
630
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
631
- }}
632
- >
633
- {`input CollectionSortParameter {
634
- id: SortOrder
635
- createdAt: SortOrder
636
- updatedAt: SortOrder
637
- name: SortOrder
638
- slug: SortOrder
639
- position: SortOrder
640
- description: SortOrder
641
- parentId: SortOrder
642
- }`}
643
- </GraphQLDoc>
644
-
645
- ## ConfigArgInput {#configarginput}
646
-
647
- <GraphQLDoc
648
- type="input"
649
- typeName="ConfigArgInput"
650
- typeLinks={{
651
- String: '/reference/graphql-api/admin/object-types#string',
652
- }}
653
- >
654
- {`input ConfigArgInput {
655
- name: String!
656
- """A JSON stringified representation of the actual value"""
657
- value: String!
658
- }`}
659
- </GraphQLDoc>
660
-
661
- ## ConfigurableOperationInput {#configurableoperationinput}
662
-
663
- <GraphQLDoc
664
- type="input"
665
- typeName="ConfigurableOperationInput"
666
- typeLinks={{
667
- String: '/reference/graphql-api/admin/object-types#string',
668
- ConfigArgInput: '/reference/graphql-api/admin/input-types#configarginput',
669
- }}
670
- >
671
- {`input ConfigurableOperationInput {
672
- code: String!
673
- arguments: [ConfigArgInput!]!
674
- }`}
675
- </GraphQLDoc>
676
-
677
- ## CoordinateInput {#coordinateinput}
678
-
679
- <GraphQLDoc
680
- type="input"
681
- typeName="CoordinateInput"
682
- typeLinks={{
683
- Float: '/reference/graphql-api/admin/object-types#float',
684
- }}
685
- >
686
- {`input CoordinateInput {
687
- x: Float!
688
- y: Float!
689
- }`}
690
- </GraphQLDoc>
691
-
692
- ## CountryFilterParameter {#countryfilterparameter}
693
-
694
- <GraphQLDoc
695
- type="input"
696
- typeName="CountryFilterParameter"
697
- typeLinks={{
698
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
699
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
700
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
701
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
702
- CountryFilterParameter: '/reference/graphql-api/admin/input-types#countryfilterparameter',
703
- }}
704
- >
705
- {`input CountryFilterParameter {
706
- id: IDOperators
707
- createdAt: DateOperators
708
- updatedAt: DateOperators
709
- languageCode: StringOperators
710
- code: StringOperators
711
- type: StringOperators
712
- name: StringOperators
713
- enabled: BooleanOperators
714
- parentId: IDOperators
715
- _and: [CountryFilterParameter!]
716
- _or: [CountryFilterParameter!]
717
- }`}
718
- </GraphQLDoc>
719
-
720
- ## CountryListOptions {#countrylistoptions}
721
-
722
- <GraphQLDoc
723
- type="input"
724
- typeName="CountryListOptions"
725
- typeLinks={{
726
- Int: '/reference/graphql-api/admin/object-types#int',
727
- CountrySortParameter: '/reference/graphql-api/admin/input-types#countrysortparameter',
728
- CountryFilterParameter: '/reference/graphql-api/admin/input-types#countryfilterparameter',
729
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
730
- }}
731
- >
732
- {`input CountryListOptions {
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: CountrySortParameter
739
- """Allows the results to be filtered"""
740
- filter: CountryFilterParameter
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
- ## CountrySortParameter {#countrysortparameter}
747
-
748
- <GraphQLDoc
749
- type="input"
750
- typeName="CountrySortParameter"
751
- typeLinks={{
752
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
753
- }}
754
- >
755
- {`input CountrySortParameter {
756
- id: SortOrder
757
- createdAt: SortOrder
758
- updatedAt: SortOrder
759
- code: SortOrder
760
- type: SortOrder
761
- name: SortOrder
762
- parentId: SortOrder
763
- }`}
764
- </GraphQLDoc>
765
-
766
- ## CountryTranslationInput {#countrytranslationinput}
767
-
768
- <GraphQLDoc
769
- type="input"
770
- typeName="CountryTranslationInput"
771
- typeLinks={{
772
- ID: '/reference/graphql-api/admin/object-types#id',
773
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
774
- String: '/reference/graphql-api/admin/object-types#string',
775
- JSON: '/reference/graphql-api/admin/object-types#json',
776
- }}
777
- >
778
- {`input CountryTranslationInput {
779
- id: ID
780
- languageCode: LanguageCode!
781
- name: String
782
- customFields: JSON
783
- }`}
784
- </GraphQLDoc>
785
-
786
- ## CreateAddressInput {#createaddressinput}
787
-
788
- <GraphQLDoc
789
- type="input"
790
- typeName="CreateAddressInput"
791
- typeLinks={{
792
- String: '/reference/graphql-api/admin/object-types#string',
793
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
794
- JSON: '/reference/graphql-api/admin/object-types#json',
795
- }}
796
- >
797
- {`"""
798
- Input used to create an Address.
799
-
800
- The countryCode must correspond to a \`code\` property of a Country that has been defined in the
801
- Vendure server. The \`code\` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
802
- If an invalid code is passed, the mutation will fail.
803
- """
804
- input CreateAddressInput {
805
- fullName: String
806
- company: String
807
- streetLine1: String!
808
- streetLine2: String
809
- city: String
810
- province: String
811
- postalCode: String
812
- countryCode: String!
813
- phoneNumber: String
814
- defaultShippingAddress: Boolean
815
- defaultBillingAddress: Boolean
816
- customFields: JSON
817
- }`}
818
- </GraphQLDoc>
819
-
820
- ## CreateAdministratorInput {#createadministratorinput}
821
-
822
- <GraphQLDoc
823
- type="input"
824
- typeName="CreateAdministratorInput"
825
- typeLinks={{
826
- String: '/reference/graphql-api/admin/object-types#string',
827
- ID: '/reference/graphql-api/admin/object-types#id',
828
- JSON: '/reference/graphql-api/admin/object-types#json',
829
- }}
830
- >
831
- {`input CreateAdministratorInput {
832
- firstName: String!
833
- lastName: String!
834
- emailAddress: String!
835
- password: String!
836
- roleIds: [ID!]!
837
- customFields: JSON
838
- }`}
839
- </GraphQLDoc>
840
-
841
- ## CreateAssetInput {#createassetinput}
842
-
843
- <GraphQLDoc
844
- type="input"
845
- typeName="CreateAssetInput"
846
- typeLinks={{
847
- Upload: '/reference/graphql-api/admin/object-types#upload',
848
- String: '/reference/graphql-api/admin/object-types#string',
849
- JSON: '/reference/graphql-api/admin/object-types#json',
850
- }}
851
- >
852
- {`input CreateAssetInput {
853
- file: Upload!
854
- tags: [String!]
855
- customFields: JSON
856
- }`}
857
- </GraphQLDoc>
858
-
859
- ## CreateChannelInput {#createchannelinput}
860
-
861
- <GraphQLDoc
862
- type="input"
863
- typeName="CreateChannelInput"
864
- typeLinks={{
865
- String: '/reference/graphql-api/admin/object-types#string',
866
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
867
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
868
- CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
869
- Int: '/reference/graphql-api/admin/object-types#int',
870
- ID: '/reference/graphql-api/admin/object-types#id',
871
- JSON: '/reference/graphql-api/admin/object-types#json',
872
- }}
873
- >
874
- {`input CreateChannelInput {
875
- code: String!
876
- token: String!
877
- defaultLanguageCode: LanguageCode!
878
- availableLanguageCodes: [LanguageCode!]
879
- pricesIncludeTax: Boolean!
880
- currencyCode: CurrencyCode
881
- defaultCurrencyCode: CurrencyCode
882
- availableCurrencyCodes: [CurrencyCode!]
883
- trackInventory: Boolean
884
- outOfStockThreshold: Int
885
- defaultTaxZoneId: ID!
886
- defaultShippingZoneId: ID!
887
- sellerId: ID
888
- customFields: JSON
889
- }`}
890
- </GraphQLDoc>
891
-
892
- ## CreateCollectionInput {#createcollectioninput}
893
-
894
- <GraphQLDoc
895
- type="input"
896
- typeName="CreateCollectionInput"
897
- typeLinks={{
898
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
899
- ID: '/reference/graphql-api/admin/object-types#id',
900
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
901
- CreateCollectionTranslationInput: '/reference/graphql-api/admin/input-types#createcollectiontranslationinput',
902
- JSON: '/reference/graphql-api/admin/object-types#json',
903
- }}
904
- >
905
- {`input CreateCollectionInput {
906
- isPrivate: Boolean
907
- featuredAssetId: ID
908
- assetIds: [ID!]
909
- parentId: ID
910
- inheritFilters: Boolean
911
- filters: [ConfigurableOperationInput!]!
912
- translations: [CreateCollectionTranslationInput!]!
913
- customFields: JSON
914
- }`}
915
- </GraphQLDoc>
916
-
917
- ## CreateCollectionTranslationInput {#createcollectiontranslationinput}
918
-
919
- <GraphQLDoc
920
- type="input"
921
- typeName="CreateCollectionTranslationInput"
922
- typeLinks={{
923
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
924
- String: '/reference/graphql-api/admin/object-types#string',
925
- JSON: '/reference/graphql-api/admin/object-types#json',
926
- }}
927
- >
928
- {`input CreateCollectionTranslationInput {
929
- languageCode: LanguageCode!
930
- name: String!
931
- slug: String!
932
- description: String!
933
- customFields: JSON
934
- }`}
935
- </GraphQLDoc>
936
-
937
- ## CreateCountryInput {#createcountryinput}
938
-
939
- <GraphQLDoc
940
- type="input"
941
- typeName="CreateCountryInput"
942
- typeLinks={{
943
- String: '/reference/graphql-api/admin/object-types#string',
944
- CountryTranslationInput: '/reference/graphql-api/admin/input-types#countrytranslationinput',
945
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
946
- JSON: '/reference/graphql-api/admin/object-types#json',
947
- }}
948
- >
949
- {`input CreateCountryInput {
950
- code: String!
951
- translations: [CountryTranslationInput!]!
952
- enabled: Boolean!
953
- customFields: JSON
954
- }`}
955
- </GraphQLDoc>
956
-
957
- ## CreateCustomerGroupInput {#createcustomergroupinput}
958
-
959
- <GraphQLDoc
960
- type="input"
961
- typeName="CreateCustomerGroupInput"
962
- typeLinks={{
963
- String: '/reference/graphql-api/admin/object-types#string',
964
- ID: '/reference/graphql-api/admin/object-types#id',
965
- JSON: '/reference/graphql-api/admin/object-types#json',
966
- }}
967
- >
968
- {`input CreateCustomerGroupInput {
969
- name: String!
970
- customerIds: [ID!]
971
- customFields: JSON
972
- }`}
973
- </GraphQLDoc>
974
-
975
- ## CreateCustomerInput {#createcustomerinput}
976
-
977
- <GraphQLDoc
978
- type="input"
979
- typeName="CreateCustomerInput"
980
- typeLinks={{
981
- String: '/reference/graphql-api/admin/object-types#string',
982
- JSON: '/reference/graphql-api/admin/object-types#json',
983
- }}
984
- >
985
- {`input CreateCustomerInput {
986
- title: String
987
- firstName: String!
988
- lastName: String!
989
- phoneNumber: String
990
- emailAddress: String!
991
- customFields: JSON
992
- }`}
993
- </GraphQLDoc>
994
-
995
- ## CreateFacetInput {#createfacetinput}
996
-
997
- <GraphQLDoc
998
- type="input"
999
- typeName="CreateFacetInput"
1000
- typeLinks={{
1001
- String: '/reference/graphql-api/admin/object-types#string',
1002
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1003
- FacetTranslationInput: '/reference/graphql-api/admin/input-types#facettranslationinput',
1004
- CreateFacetValueWithFacetInput: '/reference/graphql-api/admin/input-types#createfacetvaluewithfacetinput',
1005
- JSON: '/reference/graphql-api/admin/object-types#json',
1006
- }}
1007
- >
1008
- {`input CreateFacetInput {
1009
- code: String!
1010
- isPrivate: Boolean!
1011
- translations: [FacetTranslationInput!]!
1012
- values: [CreateFacetValueWithFacetInput!]
1013
- customFields: JSON
1014
- }`}
1015
- </GraphQLDoc>
1016
-
1017
- ## CreateFacetValueInput {#createfacetvalueinput}
1018
-
1019
- <GraphQLDoc
1020
- type="input"
1021
- typeName="CreateFacetValueInput"
1022
- typeLinks={{
1023
- ID: '/reference/graphql-api/admin/object-types#id',
1024
- String: '/reference/graphql-api/admin/object-types#string',
1025
- FacetValueTranslationInput: '/reference/graphql-api/admin/input-types#facetvaluetranslationinput',
1026
- JSON: '/reference/graphql-api/admin/object-types#json',
1027
- }}
1028
- >
1029
- {`input CreateFacetValueInput {
1030
- facetId: ID!
1031
- code: String!
1032
- translations: [FacetValueTranslationInput!]!
1033
- customFields: JSON
1034
- }`}
1035
- </GraphQLDoc>
1036
-
1037
- ## CreateFacetValueWithFacetInput {#createfacetvaluewithfacetinput}
1038
-
1039
- <GraphQLDoc
1040
- type="input"
1041
- typeName="CreateFacetValueWithFacetInput"
1042
- typeLinks={{
1043
- String: '/reference/graphql-api/admin/object-types#string',
1044
- FacetValueTranslationInput: '/reference/graphql-api/admin/input-types#facetvaluetranslationinput',
1045
- }}
1046
- >
1047
- {`input CreateFacetValueWithFacetInput {
1048
- code: String!
1049
- translations: [FacetValueTranslationInput!]!
1050
- }`}
1051
- </GraphQLDoc>
1052
-
1053
- ## CreateGroupOptionInput {#creategroupoptioninput}
1054
-
1055
- <GraphQLDoc
1056
- type="input"
1057
- typeName="CreateGroupOptionInput"
1058
- typeLinks={{
1059
- String: '/reference/graphql-api/admin/object-types#string',
1060
- ProductOptionGroupTranslationInput: '/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput',
1061
- }}
1062
- >
1063
- {`input CreateGroupOptionInput {
1064
- code: String!
1065
- translations: [ProductOptionGroupTranslationInput!]!
1066
- }`}
1067
- </GraphQLDoc>
1068
-
1069
- ## CreatePaymentMethodInput {#createpaymentmethodinput}
1070
-
1071
- <GraphQLDoc
1072
- type="input"
1073
- typeName="CreatePaymentMethodInput"
1074
- typeLinks={{
1075
- String: '/reference/graphql-api/admin/object-types#string',
1076
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1077
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
1078
- PaymentMethodTranslationInput: '/reference/graphql-api/admin/input-types#paymentmethodtranslationinput',
1079
- JSON: '/reference/graphql-api/admin/object-types#json',
1080
- }}
1081
- >
1082
- {`input CreatePaymentMethodInput {
1083
- code: String!
1084
- enabled: Boolean!
1085
- checker: ConfigurableOperationInput
1086
- handler: ConfigurableOperationInput!
1087
- translations: [PaymentMethodTranslationInput!]!
1088
- customFields: JSON
1089
- }`}
1090
- </GraphQLDoc>
1091
-
1092
- ## CreateProductInput {#createproductinput}
1093
-
1094
- <GraphQLDoc
1095
- type="input"
1096
- typeName="CreateProductInput"
1097
- typeLinks={{
1098
- ID: '/reference/graphql-api/admin/object-types#id',
1099
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1100
- ProductTranslationInput: '/reference/graphql-api/admin/input-types#producttranslationinput',
1101
- JSON: '/reference/graphql-api/admin/object-types#json',
1102
- }}
1103
- >
1104
- {`input CreateProductInput {
1105
- featuredAssetId: ID
1106
- enabled: Boolean
1107
- assetIds: [ID!]
1108
- facetValueIds: [ID!]
1109
- translations: [ProductTranslationInput!]!
1110
- customFields: JSON
1111
- }`}
1112
- </GraphQLDoc>
1113
-
1114
- ## CreateProductOptionGroupInput {#createproductoptiongroupinput}
1115
-
1116
- <GraphQLDoc
1117
- type="input"
1118
- typeName="CreateProductOptionGroupInput"
1119
- typeLinks={{
1120
- String: '/reference/graphql-api/admin/object-types#string',
1121
- ProductOptionGroupTranslationInput: '/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput',
1122
- CreateGroupOptionInput: '/reference/graphql-api/admin/input-types#creategroupoptioninput',
1123
- JSON: '/reference/graphql-api/admin/object-types#json',
1124
- }}
1125
- >
1126
- {`input CreateProductOptionGroupInput {
1127
- code: String!
1128
- translations: [ProductOptionGroupTranslationInput!]!
1129
- options: [CreateGroupOptionInput!]!
1130
- customFields: JSON
1131
- }`}
1132
- </GraphQLDoc>
1133
-
1134
- ## CreateProductOptionInput {#createproductoptioninput}
1135
-
1136
- <GraphQLDoc
1137
- type="input"
1138
- typeName="CreateProductOptionInput"
1139
- typeLinks={{
1140
- ID: '/reference/graphql-api/admin/object-types#id',
1141
- String: '/reference/graphql-api/admin/object-types#string',
1142
- ProductOptionGroupTranslationInput: '/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput',
1143
- JSON: '/reference/graphql-api/admin/object-types#json',
1144
- }}
1145
- >
1146
- {`input CreateProductOptionInput {
1147
- productOptionGroupId: ID!
1148
- code: String!
1149
- translations: [ProductOptionGroupTranslationInput!]!
1150
- customFields: JSON
1151
- }`}
1152
- </GraphQLDoc>
1153
-
1154
- ## CreateProductVariantInput {#createproductvariantinput}
1155
-
1156
- <GraphQLDoc
1157
- type="input"
1158
- typeName="CreateProductVariantInput"
1159
- typeLinks={{
1160
- ID: '/reference/graphql-api/admin/object-types#id',
1161
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1162
- ProductVariantTranslationInput: '/reference/graphql-api/admin/input-types#productvarianttranslationinput',
1163
- String: '/reference/graphql-api/admin/object-types#string',
1164
- Money: '/reference/graphql-api/admin/object-types#money',
1165
- CreateProductVariantPriceInput: '/reference/graphql-api/admin/input-types#createproductvariantpriceinput',
1166
- Int: '/reference/graphql-api/admin/object-types#int',
1167
- StockLevelInput: '/reference/graphql-api/admin/input-types#stocklevelinput',
1168
- GlobalFlag: '/reference/graphql-api/admin/enums#globalflag',
1169
- JSON: '/reference/graphql-api/admin/object-types#json',
1170
- }}
1171
- >
1172
- {`input CreateProductVariantInput {
1173
- productId: ID!
1174
- enabled: Boolean
1175
- translations: [ProductVariantTranslationInput!]!
1176
- facetValueIds: [ID!]
1177
- sku: String!
1178
- price: Money
1179
- prices: [CreateProductVariantPriceInput]
1180
- taxCategoryId: ID
1181
- optionIds: [ID!]
1182
- featuredAssetId: ID
1183
- assetIds: [ID!]
1184
- stockOnHand: Int
1185
- stockLevels: [StockLevelInput!]
1186
- outOfStockThreshold: Int
1187
- useGlobalOutOfStockThreshold: Boolean
1188
- trackInventory: GlobalFlag
1189
- customFields: JSON
1190
- }`}
1191
- </GraphQLDoc>
1192
-
1193
- ## CreateProductVariantOptionInput {#createproductvariantoptioninput}
1194
-
1195
- <GraphQLDoc
1196
- type="input"
1197
- typeName="CreateProductVariantOptionInput"
1198
- typeLinks={{
1199
- ID: '/reference/graphql-api/admin/object-types#id',
1200
- String: '/reference/graphql-api/admin/object-types#string',
1201
- ProductOptionTranslationInput: '/reference/graphql-api/admin/input-types#productoptiontranslationinput',
1202
- }}
1203
- >
1204
- {`input CreateProductVariantOptionInput {
1205
- optionGroupId: ID!
1206
- code: String!
1207
- translations: [ProductOptionTranslationInput!]!
1208
- }`}
1209
- </GraphQLDoc>
1210
-
1211
- ## CreateProductVariantPriceInput {#createproductvariantpriceinput}
1212
-
1213
- <GraphQLDoc
1214
- type="input"
1215
- typeName="CreateProductVariantPriceInput"
1216
- typeLinks={{
1217
- CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
1218
- Money: '/reference/graphql-api/admin/object-types#money',
1219
- JSON: '/reference/graphql-api/admin/object-types#json',
1220
- }}
1221
- >
1222
- {`input CreateProductVariantPriceInput {
1223
- currencyCode: CurrencyCode!
1224
- price: Money!
1225
- customFields: JSON
1226
- }`}
1227
- </GraphQLDoc>
1228
-
1229
- ## CreatePromotionInput {#createpromotioninput}
1230
-
1231
- <GraphQLDoc
1232
- type="input"
1233
- typeName="CreatePromotionInput"
1234
- typeLinks={{
1235
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1236
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1237
- String: '/reference/graphql-api/admin/object-types#string',
1238
- Int: '/reference/graphql-api/admin/object-types#int',
1239
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
1240
- PromotionTranslationInput: '/reference/graphql-api/admin/input-types#promotiontranslationinput',
1241
- JSON: '/reference/graphql-api/admin/object-types#json',
1242
- }}
1243
- >
1244
- {`input CreatePromotionInput {
1245
- enabled: Boolean!
1246
- startsAt: DateTime
1247
- endsAt: DateTime
1248
- couponCode: String
1249
- perCustomerUsageLimit: Int
1250
- usageLimit: Int
1251
- conditions: [ConfigurableOperationInput!]!
1252
- actions: [ConfigurableOperationInput!]!
1253
- translations: [PromotionTranslationInput!]!
1254
- customFields: JSON
1255
- }`}
1256
- </GraphQLDoc>
1257
-
1258
- ## CreateProvinceInput {#createprovinceinput}
1259
-
1260
- <GraphQLDoc
1261
- type="input"
1262
- typeName="CreateProvinceInput"
1263
- typeLinks={{
1264
- String: '/reference/graphql-api/admin/object-types#string',
1265
- ProvinceTranslationInput: '/reference/graphql-api/admin/input-types#provincetranslationinput',
1266
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1267
- JSON: '/reference/graphql-api/admin/object-types#json',
1268
- }}
1269
- >
1270
- {`input CreateProvinceInput {
1271
- code: String!
1272
- translations: [ProvinceTranslationInput!]!
1273
- enabled: Boolean!
1274
- customFields: JSON
1275
- }`}
1276
- </GraphQLDoc>
1277
-
1278
- ## CreateRoleInput {#createroleinput}
1279
-
1280
- <GraphQLDoc
1281
- type="input"
1282
- typeName="CreateRoleInput"
1283
- typeLinks={{
1284
- String: '/reference/graphql-api/admin/object-types#string',
1285
- Permission: '/reference/graphql-api/admin/enums#permission',
1286
- ID: '/reference/graphql-api/admin/object-types#id',
1287
- }}
1288
- >
1289
- {`input CreateRoleInput {
1290
- code: String!
1291
- description: String!
1292
- permissions: [Permission!]!
1293
- channelIds: [ID!]
1294
- }`}
1295
- </GraphQLDoc>
1296
-
1297
- ## CreateSellerInput {#createsellerinput}
1298
-
1299
- <GraphQLDoc
1300
- type="input"
1301
- typeName="CreateSellerInput"
1302
- typeLinks={{
1303
- String: '/reference/graphql-api/admin/object-types#string',
1304
- JSON: '/reference/graphql-api/admin/object-types#json',
1305
- }}
1306
- >
1307
- {`input CreateSellerInput {
1308
- name: String!
1309
- customFields: JSON
1310
- }`}
1311
- </GraphQLDoc>
1312
-
1313
- ## CreateShippingMethodInput {#createshippingmethodinput}
1314
-
1315
- <GraphQLDoc
1316
- type="input"
1317
- typeName="CreateShippingMethodInput"
1318
- typeLinks={{
1319
- String: '/reference/graphql-api/admin/object-types#string',
1320
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
1321
- ShippingMethodTranslationInput: '/reference/graphql-api/admin/input-types#shippingmethodtranslationinput',
1322
- JSON: '/reference/graphql-api/admin/object-types#json',
1323
- }}
1324
- >
1325
- {`input CreateShippingMethodInput {
1326
- code: String!
1327
- fulfillmentHandler: String!
1328
- checker: ConfigurableOperationInput!
1329
- calculator: ConfigurableOperationInput!
1330
- translations: [ShippingMethodTranslationInput!]!
1331
- customFields: JSON
1332
- }`}
1333
- </GraphQLDoc>
1334
-
1335
- ## CreateStockLocationInput {#createstocklocationinput}
1336
-
1337
- <GraphQLDoc
1338
- type="input"
1339
- typeName="CreateStockLocationInput"
1340
- typeLinks={{
1341
- String: '/reference/graphql-api/admin/object-types#string',
1342
- JSON: '/reference/graphql-api/admin/object-types#json',
1343
- }}
1344
- >
1345
- {`input CreateStockLocationInput {
1346
- name: String!
1347
- description: String
1348
- customFields: JSON
1349
- }`}
1350
- </GraphQLDoc>
1351
-
1352
- ## CreateTagInput {#createtaginput}
1353
-
1354
- <GraphQLDoc
1355
- type="input"
1356
- typeName="CreateTagInput"
1357
- typeLinks={{
1358
- String: '/reference/graphql-api/admin/object-types#string',
1359
- }}
1360
- >
1361
- {`input CreateTagInput {
1362
- value: String!
1363
- }`}
1364
- </GraphQLDoc>
1365
-
1366
- ## CreateTaxCategoryInput {#createtaxcategoryinput}
1367
-
1368
- <GraphQLDoc
1369
- type="input"
1370
- typeName="CreateTaxCategoryInput"
1371
- typeLinks={{
1372
- String: '/reference/graphql-api/admin/object-types#string',
1373
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1374
- JSON: '/reference/graphql-api/admin/object-types#json',
1375
- }}
1376
- >
1377
- {`input CreateTaxCategoryInput {
1378
- name: String!
1379
- isDefault: Boolean
1380
- customFields: JSON
1381
- }`}
1382
- </GraphQLDoc>
1383
-
1384
- ## CreateTaxRateInput {#createtaxrateinput}
1385
-
1386
- <GraphQLDoc
1387
- type="input"
1388
- typeName="CreateTaxRateInput"
1389
- typeLinks={{
1390
- String: '/reference/graphql-api/admin/object-types#string',
1391
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1392
- Float: '/reference/graphql-api/admin/object-types#float',
1393
- ID: '/reference/graphql-api/admin/object-types#id',
1394
- JSON: '/reference/graphql-api/admin/object-types#json',
1395
- }}
1396
- >
1397
- {`input CreateTaxRateInput {
1398
- name: String!
1399
- enabled: Boolean!
1400
- value: Float!
1401
- categoryId: ID!
1402
- zoneId: ID!
1403
- customerGroupId: ID
1404
- customFields: JSON
1405
- }`}
1406
- </GraphQLDoc>
1407
-
1408
- ## CreateZoneInput {#createzoneinput}
1409
-
1410
- <GraphQLDoc
1411
- type="input"
1412
- typeName="CreateZoneInput"
1413
- typeLinks={{
1414
- String: '/reference/graphql-api/admin/object-types#string',
1415
- ID: '/reference/graphql-api/admin/object-types#id',
1416
- JSON: '/reference/graphql-api/admin/object-types#json',
1417
- }}
1418
- >
1419
- {`input CreateZoneInput {
1420
- name: String!
1421
- memberIds: [ID!]
1422
- customFields: JSON
1423
- }`}
1424
- </GraphQLDoc>
1425
-
1426
- ## CustomerFilterParameter {#customerfilterparameter}
1427
-
1428
- <GraphQLDoc
1429
- type="input"
1430
- typeName="CustomerFilterParameter"
1431
- typeLinks={{
1432
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
1433
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
1434
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
1435
- CustomerFilterParameter: '/reference/graphql-api/admin/input-types#customerfilterparameter',
1436
- }}
1437
- >
1438
- {`input CustomerFilterParameter {
1439
- postalCode: StringOperators
1440
- id: IDOperators
1441
- createdAt: DateOperators
1442
- updatedAt: DateOperators
1443
- title: StringOperators
1444
- firstName: StringOperators
1445
- lastName: StringOperators
1446
- phoneNumber: StringOperators
1447
- emailAddress: StringOperators
1448
- _and: [CustomerFilterParameter!]
1449
- _or: [CustomerFilterParameter!]
1450
- }`}
1451
- </GraphQLDoc>
1452
-
1453
- ## CustomerGroupFilterParameter {#customergroupfilterparameter}
1454
-
1455
- <GraphQLDoc
1456
- type="input"
1457
- typeName="CustomerGroupFilterParameter"
1458
- typeLinks={{
1459
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
1460
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
1461
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
1462
- CustomerGroupFilterParameter: '/reference/graphql-api/admin/input-types#customergroupfilterparameter',
1463
- }}
1464
- >
1465
- {`input CustomerGroupFilterParameter {
1466
- id: IDOperators
1467
- createdAt: DateOperators
1468
- updatedAt: DateOperators
1469
- name: StringOperators
1470
- _and: [CustomerGroupFilterParameter!]
1471
- _or: [CustomerGroupFilterParameter!]
1472
- }`}
1473
- </GraphQLDoc>
1474
-
1475
- ## CustomerGroupListOptions {#customergrouplistoptions}
1476
-
1477
- <GraphQLDoc
1478
- type="input"
1479
- typeName="CustomerGroupListOptions"
1480
- typeLinks={{
1481
- Int: '/reference/graphql-api/admin/object-types#int',
1482
- CustomerGroupSortParameter: '/reference/graphql-api/admin/input-types#customergroupsortparameter',
1483
- CustomerGroupFilterParameter: '/reference/graphql-api/admin/input-types#customergroupfilterparameter',
1484
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
1485
- }}
1486
- >
1487
- {`input CustomerGroupListOptions {
1488
- """Skips the first n results, for use in pagination"""
1489
- skip: Int
1490
- """Takes n results, for use in pagination"""
1491
- take: Int
1492
- """Specifies which properties to sort the results by"""
1493
- sort: CustomerGroupSortParameter
1494
- """Allows the results to be filtered"""
1495
- filter: CustomerGroupFilterParameter
1496
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
1497
- filterOperator: LogicalOperator
1498
- }`}
1499
- </GraphQLDoc>
1500
-
1501
- ## CustomerGroupSortParameter {#customergroupsortparameter}
1502
-
1503
- <GraphQLDoc
1504
- type="input"
1505
- typeName="CustomerGroupSortParameter"
1506
- typeLinks={{
1507
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
1508
- }}
1509
- >
1510
- {`input CustomerGroupSortParameter {
1511
- id: SortOrder
1512
- createdAt: SortOrder
1513
- updatedAt: SortOrder
1514
- name: SortOrder
1515
- }`}
1516
- </GraphQLDoc>
1517
-
1518
- ## CustomerListOptions {#customerlistoptions}
1519
-
1520
- <GraphQLDoc
1521
- type="input"
1522
- typeName="CustomerListOptions"
1523
- typeLinks={{
1524
- Int: '/reference/graphql-api/admin/object-types#int',
1525
- CustomerSortParameter: '/reference/graphql-api/admin/input-types#customersortparameter',
1526
- CustomerFilterParameter: '/reference/graphql-api/admin/input-types#customerfilterparameter',
1527
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
1528
- }}
1529
- >
1530
- {`input CustomerListOptions {
1531
- """Skips the first n results, for use in pagination"""
1532
- skip: Int
1533
- """Takes n results, for use in pagination"""
1534
- take: Int
1535
- """Specifies which properties to sort the results by"""
1536
- sort: CustomerSortParameter
1537
- """Allows the results to be filtered"""
1538
- filter: CustomerFilterParameter
1539
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
1540
- filterOperator: LogicalOperator
1541
- }`}
1542
- </GraphQLDoc>
1543
-
1544
- ## CustomerSortParameter {#customersortparameter}
1545
-
1546
- <GraphQLDoc
1547
- type="input"
1548
- typeName="CustomerSortParameter"
1549
- typeLinks={{
1550
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
1551
- }}
1552
- >
1553
- {`input CustomerSortParameter {
1554
- id: SortOrder
1555
- createdAt: SortOrder
1556
- updatedAt: SortOrder
1557
- title: SortOrder
1558
- firstName: SortOrder
1559
- lastName: SortOrder
1560
- phoneNumber: SortOrder
1561
- emailAddress: SortOrder
1562
- }`}
1563
- </GraphQLDoc>
1564
-
1565
- ## DateListOperators {#datelistoperators}
1566
-
1567
- <GraphQLDoc
1568
- type="input"
1569
- typeName="DateListOperators"
1570
- typeLinks={{
1571
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1572
- }}
1573
- >
1574
- {`"""Operators for filtering on a list of Date fields"""
1575
- input DateListOperators {
1576
- inList: DateTime!
1577
- }`}
1578
- </GraphQLDoc>
1579
-
1580
- ## DateOperators {#dateoperators}
1581
-
1582
- <GraphQLDoc
1583
- type="input"
1584
- typeName="DateOperators"
1585
- typeLinks={{
1586
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1587
- DateRange: '/reference/graphql-api/admin/input-types#daterange',
1588
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1589
- }}
1590
- >
1591
- {`"""Operators for filtering on a DateTime field"""
1592
- input DateOperators {
1593
- eq: DateTime
1594
- before: DateTime
1595
- after: DateTime
1596
- between: DateRange
1597
- isNull: Boolean
1598
- }`}
1599
- </GraphQLDoc>
1600
-
1601
- ## DateRange {#daterange}
1602
-
1603
- <GraphQLDoc
1604
- type="input"
1605
- typeName="DateRange"
1606
- typeLinks={{
1607
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
1608
- }}
1609
- >
1610
- {`input DateRange {
1611
- start: DateTime!
1612
- end: DateTime!
1613
- }`}
1614
- </GraphQLDoc>
1615
-
1616
- ## DeleteAssetInput {#deleteassetinput}
1617
-
1618
- <GraphQLDoc
1619
- type="input"
1620
- typeName="DeleteAssetInput"
1621
- typeLinks={{
1622
- ID: '/reference/graphql-api/admin/object-types#id',
1623
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1624
- }}
1625
- >
1626
- {`input DeleteAssetInput {
1627
- assetId: ID!
1628
- force: Boolean
1629
- deleteFromAllChannels: Boolean
1630
- }`}
1631
- </GraphQLDoc>
1632
-
1633
- ## DeleteAssetsInput {#deleteassetsinput}
1634
-
1635
- <GraphQLDoc
1636
- type="input"
1637
- typeName="DeleteAssetsInput"
1638
- typeLinks={{
1639
- ID: '/reference/graphql-api/admin/object-types#id',
1640
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1641
- }}
1642
- >
1643
- {`input DeleteAssetsInput {
1644
- assetIds: [ID!]!
1645
- force: Boolean
1646
- deleteFromAllChannels: Boolean
1647
- }`}
1648
- </GraphQLDoc>
1649
-
1650
- ## DeleteStockLocationInput {#deletestocklocationinput}
1651
-
1652
- <GraphQLDoc
1653
- type="input"
1654
- typeName="DeleteStockLocationInput"
1655
- typeLinks={{
1656
- ID: '/reference/graphql-api/admin/object-types#id',
1657
- }}
1658
- >
1659
- {`input DeleteStockLocationInput {
1660
- id: ID!
1661
- transferToLocationId: ID
1662
- }`}
1663
- </GraphQLDoc>
1664
-
1665
- ## DuplicateEntityInput {#duplicateentityinput}
1666
-
1667
- <GraphQLDoc
1668
- type="input"
1669
- typeName="DuplicateEntityInput"
1670
- typeLinks={{
1671
- String: '/reference/graphql-api/admin/object-types#string',
1672
- ID: '/reference/graphql-api/admin/object-types#id',
1673
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
1674
- }}
1675
- >
1676
- {`input DuplicateEntityInput {
1677
- entityName: String!
1678
- entityId: ID!
1679
- duplicatorInput: ConfigurableOperationInput!
1680
- }`}
1681
- </GraphQLDoc>
1682
-
1683
- ## FacetFilterParameter {#facetfilterparameter}
1684
-
1685
- <GraphQLDoc
1686
- type="input"
1687
- typeName="FacetFilterParameter"
1688
- typeLinks={{
1689
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
1690
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
1691
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
1692
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
1693
- FacetFilterParameter: '/reference/graphql-api/admin/input-types#facetfilterparameter',
1694
- }}
1695
- >
1696
- {`input FacetFilterParameter {
1697
- isPrivate: BooleanOperators
1698
- id: IDOperators
1699
- createdAt: DateOperators
1700
- updatedAt: DateOperators
1701
- languageCode: StringOperators
1702
- name: StringOperators
1703
- code: StringOperators
1704
- _and: [FacetFilterParameter!]
1705
- _or: [FacetFilterParameter!]
1706
- }`}
1707
- </GraphQLDoc>
1708
-
1709
- ## FacetListOptions {#facetlistoptions}
1710
-
1711
- <GraphQLDoc
1712
- type="input"
1713
- typeName="FacetListOptions"
1714
- typeLinks={{
1715
- Int: '/reference/graphql-api/admin/object-types#int',
1716
- FacetSortParameter: '/reference/graphql-api/admin/input-types#facetsortparameter',
1717
- FacetFilterParameter: '/reference/graphql-api/admin/input-types#facetfilterparameter',
1718
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
1719
- }}
1720
- >
1721
- {`input FacetListOptions {
1722
- """Skips the first n results, for use in pagination"""
1723
- skip: Int
1724
- """Takes n results, for use in pagination"""
1725
- take: Int
1726
- """Specifies which properties to sort the results by"""
1727
- sort: FacetSortParameter
1728
- """Allows the results to be filtered"""
1729
- filter: FacetFilterParameter
1730
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
1731
- filterOperator: LogicalOperator
1732
- }`}
1733
- </GraphQLDoc>
1734
-
1735
- ## FacetSortParameter {#facetsortparameter}
1736
-
1737
- <GraphQLDoc
1738
- type="input"
1739
- typeName="FacetSortParameter"
1740
- typeLinks={{
1741
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
1742
- }}
1743
- >
1744
- {`input FacetSortParameter {
1745
- id: SortOrder
1746
- createdAt: SortOrder
1747
- updatedAt: SortOrder
1748
- name: SortOrder
1749
- code: SortOrder
1750
- }`}
1751
- </GraphQLDoc>
1752
-
1753
- ## FacetTranslationInput {#facettranslationinput}
1754
-
1755
- <GraphQLDoc
1756
- type="input"
1757
- typeName="FacetTranslationInput"
1758
- typeLinks={{
1759
- ID: '/reference/graphql-api/admin/object-types#id',
1760
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
1761
- String: '/reference/graphql-api/admin/object-types#string',
1762
- JSON: '/reference/graphql-api/admin/object-types#json',
1763
- }}
1764
- >
1765
- {`input FacetTranslationInput {
1766
- id: ID
1767
- languageCode: LanguageCode!
1768
- name: String
1769
- customFields: JSON
1770
- }`}
1771
- </GraphQLDoc>
1772
-
1773
- ## FacetValueFilterInput {#facetvaluefilterinput}
1774
-
1775
- <GraphQLDoc
1776
- type="input"
1777
- typeName="FacetValueFilterInput"
1778
- typeLinks={{
1779
- ID: '/reference/graphql-api/admin/object-types#id',
1780
- }}
1781
- >
1782
- {`"""
1783
- Used to construct boolean expressions for filtering search results
1784
- by FacetValue ID. Examples:
1785
-
1786
- * ID=1 OR ID=2: \`{ facetValueFilters: [{ or: [1,2] }] }\`
1787
- * ID=1 AND ID=2: \`{ facetValueFilters: [{ and: 1 }, { and: 2 }] }\`
1788
- * ID=1 AND (ID=2 OR ID=3): \`{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }\`
1789
- """
1790
- input FacetValueFilterInput {
1791
- and: ID
1792
- or: [ID!]
1793
- }`}
1794
- </GraphQLDoc>
1795
-
1796
- ## FacetValueFilterParameter {#facetvaluefilterparameter}
1797
-
1798
- <GraphQLDoc
1799
- type="input"
1800
- typeName="FacetValueFilterParameter"
1801
- typeLinks={{
1802
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
1803
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
1804
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
1805
- FacetValueFilterParameter: '/reference/graphql-api/admin/input-types#facetvaluefilterparameter',
1806
- }}
1807
- >
1808
- {`input FacetValueFilterParameter {
1809
- id: IDOperators
1810
- createdAt: DateOperators
1811
- updatedAt: DateOperators
1812
- languageCode: StringOperators
1813
- facetId: IDOperators
1814
- name: StringOperators
1815
- code: StringOperators
1816
- _and: [FacetValueFilterParameter!]
1817
- _or: [FacetValueFilterParameter!]
1818
- }`}
1819
- </GraphQLDoc>
1820
-
1821
- ## FacetValueListOptions {#facetvaluelistoptions}
1822
-
1823
- <GraphQLDoc
1824
- type="input"
1825
- typeName="FacetValueListOptions"
1826
- typeLinks={{
1827
- Int: '/reference/graphql-api/admin/object-types#int',
1828
- FacetValueSortParameter: '/reference/graphql-api/admin/input-types#facetvaluesortparameter',
1829
- FacetValueFilterParameter: '/reference/graphql-api/admin/input-types#facetvaluefilterparameter',
1830
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
1831
- }}
1832
- >
1833
- {`input FacetValueListOptions {
1834
- """Skips the first n results, for use in pagination"""
1835
- skip: Int
1836
- """Takes n results, for use in pagination"""
1837
- take: Int
1838
- """Specifies which properties to sort the results by"""
1839
- sort: FacetValueSortParameter
1840
- """Allows the results to be filtered"""
1841
- filter: FacetValueFilterParameter
1842
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
1843
- filterOperator: LogicalOperator
1844
- }`}
1845
- </GraphQLDoc>
1846
-
1847
- ## FacetValueSortParameter {#facetvaluesortparameter}
1848
-
1849
- <GraphQLDoc
1850
- type="input"
1851
- typeName="FacetValueSortParameter"
1852
- typeLinks={{
1853
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
1854
- }}
1855
- >
1856
- {`input FacetValueSortParameter {
1857
- id: SortOrder
1858
- createdAt: SortOrder
1859
- updatedAt: SortOrder
1860
- facetId: SortOrder
1861
- name: SortOrder
1862
- code: SortOrder
1863
- }`}
1864
- </GraphQLDoc>
1865
-
1866
- ## FacetValueTranslationInput {#facetvaluetranslationinput}
1867
-
1868
- <GraphQLDoc
1869
- type="input"
1870
- typeName="FacetValueTranslationInput"
1871
- typeLinks={{
1872
- ID: '/reference/graphql-api/admin/object-types#id',
1873
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
1874
- String: '/reference/graphql-api/admin/object-types#string',
1875
- JSON: '/reference/graphql-api/admin/object-types#json',
1876
- }}
1877
- >
1878
- {`input FacetValueTranslationInput {
1879
- id: ID
1880
- languageCode: LanguageCode!
1881
- name: String
1882
- customFields: JSON
1883
- }`}
1884
- </GraphQLDoc>
1885
-
1886
- ## FulfillOrderInput {#fulfillorderinput}
1887
-
1888
- <GraphQLDoc
1889
- type="input"
1890
- typeName="FulfillOrderInput"
1891
- typeLinks={{
1892
- OrderLineInput: '/reference/graphql-api/admin/input-types#orderlineinput',
1893
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
1894
- }}
1895
- >
1896
- {`input FulfillOrderInput {
1897
- lines: [OrderLineInput!]!
1898
- handler: ConfigurableOperationInput!
1899
- }`}
1900
- </GraphQLDoc>
1901
-
1902
- ## HistoryEntryFilterParameter {#historyentryfilterparameter}
1903
-
1904
- <GraphQLDoc
1905
- type="input"
1906
- typeName="HistoryEntryFilterParameter"
1907
- typeLinks={{
1908
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
1909
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
1910
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
1911
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
1912
- HistoryEntryFilterParameter: '/reference/graphql-api/admin/input-types#historyentryfilterparameter',
1913
- }}
1914
- >
1915
- {`input HistoryEntryFilterParameter {
1916
- isPublic: BooleanOperators
1917
- id: IDOperators
1918
- createdAt: DateOperators
1919
- updatedAt: DateOperators
1920
- type: StringOperators
1921
- _and: [HistoryEntryFilterParameter!]
1922
- _or: [HistoryEntryFilterParameter!]
1923
- }`}
1924
- </GraphQLDoc>
1925
-
1926
- ## HistoryEntryListOptions {#historyentrylistoptions}
1927
-
1928
- <GraphQLDoc
1929
- type="input"
1930
- typeName="HistoryEntryListOptions"
1931
- typeLinks={{
1932
- Int: '/reference/graphql-api/admin/object-types#int',
1933
- HistoryEntrySortParameter: '/reference/graphql-api/admin/input-types#historyentrysortparameter',
1934
- HistoryEntryFilterParameter: '/reference/graphql-api/admin/input-types#historyentryfilterparameter',
1935
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
1936
- }}
1937
- >
1938
- {`input HistoryEntryListOptions {
1939
- """Skips the first n results, for use in pagination"""
1940
- skip: Int
1941
- """Takes n results, for use in pagination"""
1942
- take: Int
1943
- """Specifies which properties to sort the results by"""
1944
- sort: HistoryEntrySortParameter
1945
- """Allows the results to be filtered"""
1946
- filter: HistoryEntryFilterParameter
1947
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
1948
- filterOperator: LogicalOperator
1949
- }`}
1950
- </GraphQLDoc>
1951
-
1952
- ## HistoryEntrySortParameter {#historyentrysortparameter}
1953
-
1954
- <GraphQLDoc
1955
- type="input"
1956
- typeName="HistoryEntrySortParameter"
1957
- typeLinks={{
1958
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
1959
- }}
1960
- >
1961
- {`input HistoryEntrySortParameter {
1962
- id: SortOrder
1963
- createdAt: SortOrder
1964
- updatedAt: SortOrder
1965
- }`}
1966
- </GraphQLDoc>
1967
-
1968
- ## IDListOperators {#idlistoperators}
1969
-
1970
- <GraphQLDoc
1971
- type="input"
1972
- typeName="IDListOperators"
1973
- typeLinks={{
1974
- ID: '/reference/graphql-api/admin/object-types#id',
1975
- }}
1976
- >
1977
- {`"""Operators for filtering on a list of ID fields"""
1978
- input IDListOperators {
1979
- inList: ID!
1980
- }`}
1981
- </GraphQLDoc>
1982
-
1983
- ## IDOperators {#idoperators}
1984
-
1985
- <GraphQLDoc
1986
- type="input"
1987
- typeName="IDOperators"
1988
- typeLinks={{
1989
- String: '/reference/graphql-api/admin/object-types#string',
1990
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
1991
- }}
1992
- >
1993
- {`"""Operators for filtering on an ID field"""
1994
- input IDOperators {
1995
- eq: String
1996
- notEq: String
1997
- in: [String!]
1998
- notIn: [String!]
1999
- isNull: Boolean
2000
- }`}
2001
- </GraphQLDoc>
2002
-
2003
- ## JobFilterParameter {#jobfilterparameter}
2004
-
2005
- <GraphQLDoc
2006
- type="input"
2007
- typeName="JobFilterParameter"
2008
- typeLinks={{
2009
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
2010
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
2011
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
2012
- NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
2013
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
2014
- JobFilterParameter: '/reference/graphql-api/admin/input-types#jobfilterparameter',
2015
- }}
2016
- >
2017
- {`input JobFilterParameter {
2018
- id: IDOperators
2019
- createdAt: DateOperators
2020
- startedAt: DateOperators
2021
- settledAt: DateOperators
2022
- queueName: StringOperators
2023
- state: StringOperators
2024
- progress: NumberOperators
2025
- isSettled: BooleanOperators
2026
- duration: NumberOperators
2027
- retries: NumberOperators
2028
- attempts: NumberOperators
2029
- _and: [JobFilterParameter!]
2030
- _or: [JobFilterParameter!]
2031
- }`}
2032
- </GraphQLDoc>
2033
-
2034
- ## JobListOptions {#joblistoptions}
2035
-
2036
- <GraphQLDoc
2037
- type="input"
2038
- typeName="JobListOptions"
2039
- typeLinks={{
2040
- Int: '/reference/graphql-api/admin/object-types#int',
2041
- JobSortParameter: '/reference/graphql-api/admin/input-types#jobsortparameter',
2042
- JobFilterParameter: '/reference/graphql-api/admin/input-types#jobfilterparameter',
2043
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
2044
- }}
2045
- >
2046
- {`input JobListOptions {
2047
- """Skips the first n results, for use in pagination"""
2048
- skip: Int
2049
- """Takes n results, for use in pagination"""
2050
- take: Int
2051
- """Specifies which properties to sort the results by"""
2052
- sort: JobSortParameter
2053
- """Allows the results to be filtered"""
2054
- filter: JobFilterParameter
2055
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
2056
- filterOperator: LogicalOperator
2057
- }`}
2058
- </GraphQLDoc>
2059
-
2060
- ## JobSortParameter {#jobsortparameter}
2061
-
2062
- <GraphQLDoc
2063
- type="input"
2064
- typeName="JobSortParameter"
2065
- typeLinks={{
2066
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
2067
- }}
2068
- >
2069
- {`input JobSortParameter {
2070
- id: SortOrder
2071
- createdAt: SortOrder
2072
- startedAt: SortOrder
2073
- settledAt: SortOrder
2074
- queueName: SortOrder
2075
- progress: SortOrder
2076
- duration: SortOrder
2077
- retries: SortOrder
2078
- attempts: SortOrder
2079
- }`}
2080
- </GraphQLDoc>
2081
-
2082
- ## ManualPaymentInput {#manualpaymentinput}
2083
-
2084
- <GraphQLDoc
2085
- type="input"
2086
- typeName="ManualPaymentInput"
2087
- typeLinks={{
2088
- ID: '/reference/graphql-api/admin/object-types#id',
2089
- String: '/reference/graphql-api/admin/object-types#string',
2090
- JSON: '/reference/graphql-api/admin/object-types#json',
2091
- }}
2092
- >
2093
- {`input ManualPaymentInput {
2094
- orderId: ID!
2095
- method: String!
2096
- transactionId: String
2097
- metadata: JSON
2098
- }`}
2099
- </GraphQLDoc>
2100
-
2101
- ## MetricSummaryInput {#metricsummaryinput}
2102
-
2103
- <GraphQLDoc
2104
- type="input"
2105
- typeName="MetricSummaryInput"
2106
- typeLinks={{
2107
- MetricInterval: '/reference/graphql-api/admin/enums#metricinterval',
2108
- MetricType: '/reference/graphql-api/admin/enums#metrictype',
2109
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2110
- }}
2111
- >
2112
- {`input MetricSummaryInput {
2113
- interval: MetricInterval!
2114
- types: [MetricType!]!
2115
- refresh: Boolean
2116
- }`}
2117
- </GraphQLDoc>
2118
-
2119
- ## ModifyOrderInput {#modifyorderinput}
2120
-
2121
- <GraphQLDoc
2122
- type="input"
2123
- typeName="ModifyOrderInput"
2124
- typeLinks={{
2125
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2126
- ID: '/reference/graphql-api/admin/object-types#id',
2127
- AddItemInput: '/reference/graphql-api/admin/input-types#additeminput',
2128
- OrderLineInput: '/reference/graphql-api/admin/input-types#orderlineinput',
2129
- SurchargeInput: '/reference/graphql-api/admin/input-types#surchargeinput',
2130
- UpdateOrderAddressInput: '/reference/graphql-api/admin/input-types#updateorderaddressinput',
2131
- String: '/reference/graphql-api/admin/object-types#string',
2132
- AdministratorRefundInput: '/reference/graphql-api/admin/input-types#administratorrefundinput',
2133
- ModifyOrderOptions: '/reference/graphql-api/admin/input-types#modifyorderoptions',
2134
- }}
2135
- >
2136
- {`input ModifyOrderInput {
2137
- dryRun: Boolean!
2138
- orderId: ID!
2139
- addItems: [AddItemInput!]
2140
- adjustOrderLines: [OrderLineInput!]
2141
- surcharges: [SurchargeInput!]
2142
- updateShippingAddress: UpdateOrderAddressInput
2143
- updateBillingAddress: UpdateOrderAddressInput
2144
- note: String
2145
- """
2146
- Deprecated in v2.2.0. Use \`refunds\` instead to allow multiple refunds to be
2147
- applied in the case that multiple payment methods have been used on the order.
2148
- """
2149
- refund: AdministratorRefundInput
2150
- refunds: [AdministratorRefundInput!]
2151
- options: ModifyOrderOptions
2152
- couponCodes: [String!]
2153
- """Added in v2.2"""
2154
- shippingMethodIds: [ID!]
2155
- }`}
2156
- </GraphQLDoc>
2157
-
2158
- ## ModifyOrderOptions {#modifyorderoptions}
2159
-
2160
- <GraphQLDoc
2161
- type="input"
2162
- typeName="ModifyOrderOptions"
2163
- typeLinks={{
2164
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2165
- }}
2166
- >
2167
- {`input ModifyOrderOptions {
2168
- freezePromotions: Boolean
2169
- recalculateShipping: Boolean
2170
- }`}
2171
- </GraphQLDoc>
2172
-
2173
- ## MoveCollectionInput {#movecollectioninput}
2174
-
2175
- <GraphQLDoc
2176
- type="input"
2177
- typeName="MoveCollectionInput"
2178
- typeLinks={{
2179
- ID: '/reference/graphql-api/admin/object-types#id',
2180
- Int: '/reference/graphql-api/admin/object-types#int',
2181
- }}
2182
- >
2183
- {`input MoveCollectionInput {
2184
- collectionId: ID!
2185
- parentId: ID!
2186
- index: Int!
2187
- }`}
2188
- </GraphQLDoc>
2189
-
2190
- ## NativeAuthInput {#nativeauthinput}
2191
-
2192
- <GraphQLDoc
2193
- type="input"
2194
- typeName="NativeAuthInput"
2195
- typeLinks={{
2196
- String: '/reference/graphql-api/admin/object-types#string',
2197
- }}
2198
- >
2199
- {`input NativeAuthInput {
2200
- username: String!
2201
- password: String!
2202
- }`}
2203
- </GraphQLDoc>
2204
-
2205
- ## NumberListOperators {#numberlistoperators}
2206
-
2207
- <GraphQLDoc
2208
- type="input"
2209
- typeName="NumberListOperators"
2210
- typeLinks={{
2211
- Float: '/reference/graphql-api/admin/object-types#float',
2212
- }}
2213
- >
2214
- {`"""Operators for filtering on a list of Number fields"""
2215
- input NumberListOperators {
2216
- inList: Float!
2217
- }`}
2218
- </GraphQLDoc>
2219
-
2220
- ## NumberOperators {#numberoperators}
2221
-
2222
- <GraphQLDoc
2223
- type="input"
2224
- typeName="NumberOperators"
2225
- typeLinks={{
2226
- Float: '/reference/graphql-api/admin/object-types#float',
2227
- NumberRange: '/reference/graphql-api/admin/input-types#numberrange',
2228
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2229
- }}
2230
- >
2231
- {`"""Operators for filtering on a Int or Float field"""
2232
- input NumberOperators {
2233
- eq: Float
2234
- lt: Float
2235
- lte: Float
2236
- gt: Float
2237
- gte: Float
2238
- between: NumberRange
2239
- isNull: Boolean
2240
- }`}
2241
- </GraphQLDoc>
2242
-
2243
- ## NumberRange {#numberrange}
2244
-
2245
- <GraphQLDoc
2246
- type="input"
2247
- typeName="NumberRange"
2248
- typeLinks={{
2249
- Float: '/reference/graphql-api/admin/object-types#float',
2250
- }}
2251
- >
2252
- {`input NumberRange {
2253
- start: Float!
2254
- end: Float!
2255
- }`}
2256
- </GraphQLDoc>
2257
-
2258
- ## OrderFilterParameter {#orderfilterparameter}
2259
-
2260
- <GraphQLDoc
2261
- type="input"
2262
- typeName="OrderFilterParameter"
2263
- typeLinks={{
2264
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
2265
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
2266
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
2267
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
2268
- NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
2269
- OrderFilterParameter: '/reference/graphql-api/admin/input-types#orderfilterparameter',
2270
- }}
2271
- >
2272
- {`input OrderFilterParameter {
2273
- customerLastName: StringOperators
2274
- transactionId: StringOperators
2275
- aggregateOrderId: IDOperators
2276
- id: IDOperators
2277
- createdAt: DateOperators
2278
- updatedAt: DateOperators
2279
- type: StringOperators
2280
- orderPlacedAt: DateOperators
2281
- code: StringOperators
2282
- state: StringOperators
2283
- active: BooleanOperators
2284
- totalQuantity: NumberOperators
2285
- subTotal: NumberOperators
2286
- subTotalWithTax: NumberOperators
2287
- currencyCode: StringOperators
2288
- shipping: NumberOperators
2289
- shippingWithTax: NumberOperators
2290
- total: NumberOperators
2291
- totalWithTax: NumberOperators
2292
- _and: [OrderFilterParameter!]
2293
- _or: [OrderFilterParameter!]
2294
- }`}
2295
- </GraphQLDoc>
2296
-
2297
- ## OrderLineInput {#orderlineinput}
2298
-
2299
- <GraphQLDoc
2300
- type="input"
2301
- typeName="OrderLineInput"
2302
- typeLinks={{
2303
- ID: '/reference/graphql-api/admin/object-types#id',
2304
- Int: '/reference/graphql-api/admin/object-types#int',
2305
- }}
2306
- >
2307
- {`input OrderLineInput {
2308
- orderLineId: ID!
2309
- quantity: Int!
2310
- }`}
2311
- </GraphQLDoc>
2312
-
2313
- ## OrderListOptions {#orderlistoptions}
2314
-
2315
- <GraphQLDoc
2316
- type="input"
2317
- typeName="OrderListOptions"
2318
- typeLinks={{
2319
- Int: '/reference/graphql-api/admin/object-types#int',
2320
- OrderSortParameter: '/reference/graphql-api/admin/input-types#ordersortparameter',
2321
- OrderFilterParameter: '/reference/graphql-api/admin/input-types#orderfilterparameter',
2322
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
2323
- }}
2324
- >
2325
- {`input OrderListOptions {
2326
- """Skips the first n results, for use in pagination"""
2327
- skip: Int
2328
- """Takes n results, for use in pagination"""
2329
- take: Int
2330
- """Specifies which properties to sort the results by"""
2331
- sort: OrderSortParameter
2332
- """Allows the results to be filtered"""
2333
- filter: OrderFilterParameter
2334
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
2335
- filterOperator: LogicalOperator
2336
- }`}
2337
- </GraphQLDoc>
2338
-
2339
- ## OrderSortParameter {#ordersortparameter}
2340
-
2341
- <GraphQLDoc
2342
- type="input"
2343
- typeName="OrderSortParameter"
2344
- typeLinks={{
2345
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
2346
- }}
2347
- >
2348
- {`input OrderSortParameter {
2349
- customerLastName: SortOrder
2350
- transactionId: SortOrder
2351
- aggregateOrderId: SortOrder
2352
- id: SortOrder
2353
- createdAt: SortOrder
2354
- updatedAt: SortOrder
2355
- orderPlacedAt: SortOrder
2356
- code: SortOrder
2357
- state: SortOrder
2358
- totalQuantity: SortOrder
2359
- subTotal: SortOrder
2360
- subTotalWithTax: SortOrder
2361
- shipping: SortOrder
2362
- shippingWithTax: SortOrder
2363
- total: SortOrder
2364
- totalWithTax: SortOrder
2365
- }`}
2366
- </GraphQLDoc>
2367
-
2368
- ## PaymentMethodFilterParameter {#paymentmethodfilterparameter}
2369
-
2370
- <GraphQLDoc
2371
- type="input"
2372
- typeName="PaymentMethodFilterParameter"
2373
- typeLinks={{
2374
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
2375
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
2376
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
2377
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
2378
- PaymentMethodFilterParameter: '/reference/graphql-api/admin/input-types#paymentmethodfilterparameter',
2379
- }}
2380
- >
2381
- {`input PaymentMethodFilterParameter {
2382
- id: IDOperators
2383
- createdAt: DateOperators
2384
- updatedAt: DateOperators
2385
- name: StringOperators
2386
- code: StringOperators
2387
- description: StringOperators
2388
- enabled: BooleanOperators
2389
- _and: [PaymentMethodFilterParameter!]
2390
- _or: [PaymentMethodFilterParameter!]
2391
- }`}
2392
- </GraphQLDoc>
2393
-
2394
- ## PaymentMethodListOptions {#paymentmethodlistoptions}
2395
-
2396
- <GraphQLDoc
2397
- type="input"
2398
- typeName="PaymentMethodListOptions"
2399
- typeLinks={{
2400
- Int: '/reference/graphql-api/admin/object-types#int',
2401
- PaymentMethodSortParameter: '/reference/graphql-api/admin/input-types#paymentmethodsortparameter',
2402
- PaymentMethodFilterParameter: '/reference/graphql-api/admin/input-types#paymentmethodfilterparameter',
2403
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
2404
- }}
2405
- >
2406
- {`input PaymentMethodListOptions {
2407
- """Skips the first n results, for use in pagination"""
2408
- skip: Int
2409
- """Takes n results, for use in pagination"""
2410
- take: Int
2411
- """Specifies which properties to sort the results by"""
2412
- sort: PaymentMethodSortParameter
2413
- """Allows the results to be filtered"""
2414
- filter: PaymentMethodFilterParameter
2415
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
2416
- filterOperator: LogicalOperator
2417
- }`}
2418
- </GraphQLDoc>
2419
-
2420
- ## PaymentMethodSortParameter {#paymentmethodsortparameter}
2421
-
2422
- <GraphQLDoc
2423
- type="input"
2424
- typeName="PaymentMethodSortParameter"
2425
- typeLinks={{
2426
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
2427
- }}
2428
- >
2429
- {`input PaymentMethodSortParameter {
2430
- id: SortOrder
2431
- createdAt: SortOrder
2432
- updatedAt: SortOrder
2433
- name: SortOrder
2434
- code: SortOrder
2435
- description: SortOrder
2436
- }`}
2437
- </GraphQLDoc>
2438
-
2439
- ## PaymentMethodTranslationInput {#paymentmethodtranslationinput}
2440
-
2441
- <GraphQLDoc
2442
- type="input"
2443
- typeName="PaymentMethodTranslationInput"
2444
- typeLinks={{
2445
- ID: '/reference/graphql-api/admin/object-types#id',
2446
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
2447
- String: '/reference/graphql-api/admin/object-types#string',
2448
- JSON: '/reference/graphql-api/admin/object-types#json',
2449
- }}
2450
- >
2451
- {`input PaymentMethodTranslationInput {
2452
- id: ID
2453
- languageCode: LanguageCode!
2454
- name: String
2455
- description: String
2456
- customFields: JSON
2457
- }`}
2458
- </GraphQLDoc>
2459
-
2460
- ## PreviewCollectionVariantsInput {#previewcollectionvariantsinput}
2461
-
2462
- <GraphQLDoc
2463
- type="input"
2464
- typeName="PreviewCollectionVariantsInput"
2465
- typeLinks={{
2466
- ID: '/reference/graphql-api/admin/object-types#id',
2467
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
2468
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
2469
- }}
2470
- >
2471
- {`input PreviewCollectionVariantsInput {
2472
- parentId: ID
2473
- inheritFilters: Boolean!
2474
- filters: [ConfigurableOperationInput!]!
2475
- }`}
2476
- </GraphQLDoc>
2477
-
2478
- ## ProductFilterParameter {#productfilterparameter}
2479
-
2480
- <GraphQLDoc
2481
- type="input"
2482
- typeName="ProductFilterParameter"
2483
- typeLinks={{
2484
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
2485
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
2486
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
2487
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
2488
- ProductFilterParameter: '/reference/graphql-api/admin/input-types#productfilterparameter',
2489
- }}
2490
- >
2491
- {`input ProductFilterParameter {
2492
- facetValueId: IDOperators
2493
- sku: StringOperators
2494
- id: IDOperators
2495
- createdAt: DateOperators
2496
- updatedAt: DateOperators
2497
- languageCode: StringOperators
2498
- name: StringOperators
2499
- slug: StringOperators
2500
- description: StringOperators
2501
- enabled: BooleanOperators
2502
- _and: [ProductFilterParameter!]
2503
- _or: [ProductFilterParameter!]
2504
- }`}
2505
- </GraphQLDoc>
2506
-
2507
- ## ProductListOptions {#productlistoptions}
2508
-
2509
- <GraphQLDoc
2510
- type="input"
2511
- typeName="ProductListOptions"
2512
- typeLinks={{
2513
- Int: '/reference/graphql-api/admin/object-types#int',
2514
- ProductSortParameter: '/reference/graphql-api/admin/input-types#productsortparameter',
2515
- ProductFilterParameter: '/reference/graphql-api/admin/input-types#productfilterparameter',
2516
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
2517
- }}
2518
- >
2519
- {`input ProductListOptions {
2520
- """Skips the first n results, for use in pagination"""
2521
- skip: Int
2522
- """Takes n results, for use in pagination"""
2523
- take: Int
2524
- """Specifies which properties to sort the results by"""
2525
- sort: ProductSortParameter
2526
- """Allows the results to be filtered"""
2527
- filter: ProductFilterParameter
2528
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
2529
- filterOperator: LogicalOperator
2530
- }`}
2531
- </GraphQLDoc>
2532
-
2533
- ## ProductOptionFilterParameter {#productoptionfilterparameter}
2534
-
2535
- <GraphQLDoc
2536
- type="input"
2537
- typeName="ProductOptionFilterParameter"
2538
- typeLinks={{
2539
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
2540
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
2541
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
2542
- ProductOptionFilterParameter: '/reference/graphql-api/admin/input-types#productoptionfilterparameter',
2543
- }}
2544
- >
2545
- {`input ProductOptionFilterParameter {
2546
- id: IDOperators
2547
- createdAt: DateOperators
2548
- updatedAt: DateOperators
2549
- languageCode: StringOperators
2550
- code: StringOperators
2551
- name: StringOperators
2552
- groupId: IDOperators
2553
- _and: [ProductOptionFilterParameter!]
2554
- _or: [ProductOptionFilterParameter!]
2555
- }`}
2556
- </GraphQLDoc>
2557
-
2558
- ## ProductOptionGroupTranslationInput {#productoptiongrouptranslationinput}
2559
-
2560
- <GraphQLDoc
2561
- type="input"
2562
- typeName="ProductOptionGroupTranslationInput"
2563
- typeLinks={{
2564
- ID: '/reference/graphql-api/admin/object-types#id',
2565
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
2566
- String: '/reference/graphql-api/admin/object-types#string',
2567
- JSON: '/reference/graphql-api/admin/object-types#json',
2568
- }}
2569
- >
2570
- {`input ProductOptionGroupTranslationInput {
2571
- id: ID
2572
- languageCode: LanguageCode!
2573
- name: String
2574
- customFields: JSON
2575
- }`}
2576
- </GraphQLDoc>
2577
-
2578
- ## ProductOptionListOptions {#productoptionlistoptions}
2579
-
2580
- <GraphQLDoc
2581
- type="input"
2582
- typeName="ProductOptionListOptions"
2583
- typeLinks={{
2584
- Int: '/reference/graphql-api/admin/object-types#int',
2585
- ProductOptionSortParameter: '/reference/graphql-api/admin/input-types#productoptionsortparameter',
2586
- ProductOptionFilterParameter: '/reference/graphql-api/admin/input-types#productoptionfilterparameter',
2587
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
2588
- }}
2589
- >
2590
- {`input ProductOptionListOptions {
2591
- """Skips the first n results, for use in pagination"""
2592
- skip: Int
2593
- """Takes n results, for use in pagination"""
2594
- take: Int
2595
- """Specifies which properties to sort the results by"""
2596
- sort: ProductOptionSortParameter
2597
- """Allows the results to be filtered"""
2598
- filter: ProductOptionFilterParameter
2599
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
2600
- filterOperator: LogicalOperator
2601
- }`}
2602
- </GraphQLDoc>
2603
-
2604
- ## ProductOptionSortParameter {#productoptionsortparameter}
2605
-
2606
- <GraphQLDoc
2607
- type="input"
2608
- typeName="ProductOptionSortParameter"
2609
- typeLinks={{
2610
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
2611
- }}
2612
- >
2613
- {`input ProductOptionSortParameter {
2614
- id: SortOrder
2615
- createdAt: SortOrder
2616
- updatedAt: SortOrder
2617
- code: SortOrder
2618
- name: SortOrder
2619
- groupId: SortOrder
2620
- }`}
2621
- </GraphQLDoc>
2622
-
2623
- ## ProductOptionTranslationInput {#productoptiontranslationinput}
2624
-
2625
- <GraphQLDoc
2626
- type="input"
2627
- typeName="ProductOptionTranslationInput"
2628
- typeLinks={{
2629
- ID: '/reference/graphql-api/admin/object-types#id',
2630
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
2631
- String: '/reference/graphql-api/admin/object-types#string',
2632
- JSON: '/reference/graphql-api/admin/object-types#json',
2633
- }}
2634
- >
2635
- {`input ProductOptionTranslationInput {
2636
- id: ID
2637
- languageCode: LanguageCode!
2638
- name: String
2639
- customFields: JSON
2640
- }`}
2641
- </GraphQLDoc>
2642
-
2643
- ## ProductSortParameter {#productsortparameter}
2644
-
2645
- <GraphQLDoc
2646
- type="input"
2647
- typeName="ProductSortParameter"
2648
- typeLinks={{
2649
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
2650
- }}
2651
- >
2652
- {`input ProductSortParameter {
2653
- id: SortOrder
2654
- createdAt: SortOrder
2655
- updatedAt: SortOrder
2656
- name: SortOrder
2657
- slug: SortOrder
2658
- description: SortOrder
2659
- }`}
2660
- </GraphQLDoc>
2661
-
2662
- ## ProductTranslationInput {#producttranslationinput}
2663
-
2664
- <GraphQLDoc
2665
- type="input"
2666
- typeName="ProductTranslationInput"
2667
- typeLinks={{
2668
- ID: '/reference/graphql-api/admin/object-types#id',
2669
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
2670
- String: '/reference/graphql-api/admin/object-types#string',
2671
- JSON: '/reference/graphql-api/admin/object-types#json',
2672
- }}
2673
- >
2674
- {`input ProductTranslationInput {
2675
- id: ID
2676
- languageCode: LanguageCode!
2677
- name: String
2678
- slug: String
2679
- description: String
2680
- customFields: JSON
2681
- }`}
2682
- </GraphQLDoc>
2683
-
2684
- ## ProductVariantFilterParameter {#productvariantfilterparameter}
2685
-
2686
- <GraphQLDoc
2687
- type="input"
2688
- typeName="ProductVariantFilterParameter"
2689
- typeLinks={{
2690
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
2691
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
2692
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
2693
- NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
2694
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
2695
- ProductVariantFilterParameter: '/reference/graphql-api/admin/input-types#productvariantfilterparameter',
2696
- }}
2697
- >
2698
- {`input ProductVariantFilterParameter {
2699
- facetValueId: IDOperators
2700
- enabled: BooleanOperators
2701
- trackInventory: StringOperators
2702
- stockOnHand: NumberOperators
2703
- stockAllocated: NumberOperators
2704
- outOfStockThreshold: NumberOperators
2705
- useGlobalOutOfStockThreshold: BooleanOperators
2706
- id: IDOperators
2707
- productId: IDOperators
2708
- createdAt: DateOperators
2709
- updatedAt: DateOperators
2710
- languageCode: StringOperators
2711
- sku: StringOperators
2712
- name: StringOperators
2713
- price: NumberOperators
2714
- currencyCode: StringOperators
2715
- priceWithTax: NumberOperators
2716
- stockLevel: StringOperators
2717
- _and: [ProductVariantFilterParameter!]
2718
- _or: [ProductVariantFilterParameter!]
2719
- }`}
2720
- </GraphQLDoc>
2721
-
2722
- ## ProductVariantListOptions {#productvariantlistoptions}
2723
-
2724
- <GraphQLDoc
2725
- type="input"
2726
- typeName="ProductVariantListOptions"
2727
- typeLinks={{
2728
- Int: '/reference/graphql-api/admin/object-types#int',
2729
- ProductVariantSortParameter: '/reference/graphql-api/admin/input-types#productvariantsortparameter',
2730
- ProductVariantFilterParameter: '/reference/graphql-api/admin/input-types#productvariantfilterparameter',
2731
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
2732
- }}
2733
- >
2734
- {`input ProductVariantListOptions {
2735
- """Skips the first n results, for use in pagination"""
2736
- skip: Int
2737
- """Takes n results, for use in pagination"""
2738
- take: Int
2739
- """Specifies which properties to sort the results by"""
2740
- sort: ProductVariantSortParameter
2741
- """Allows the results to be filtered"""
2742
- filter: ProductVariantFilterParameter
2743
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
2744
- filterOperator: LogicalOperator
2745
- }`}
2746
- </GraphQLDoc>
2747
-
2748
- ## ProductVariantSortParameter {#productvariantsortparameter}
2749
-
2750
- <GraphQLDoc
2751
- type="input"
2752
- typeName="ProductVariantSortParameter"
2753
- typeLinks={{
2754
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
2755
- }}
2756
- >
2757
- {`input ProductVariantSortParameter {
2758
- stockOnHand: SortOrder
2759
- stockAllocated: SortOrder
2760
- outOfStockThreshold: SortOrder
2761
- id: SortOrder
2762
- productId: SortOrder
2763
- createdAt: SortOrder
2764
- updatedAt: SortOrder
2765
- sku: SortOrder
2766
- name: SortOrder
2767
- price: SortOrder
2768
- priceWithTax: SortOrder
2769
- stockLevel: SortOrder
2770
- }`}
2771
- </GraphQLDoc>
2772
-
2773
- ## ProductVariantTranslationInput {#productvarianttranslationinput}
2774
-
2775
- <GraphQLDoc
2776
- type="input"
2777
- typeName="ProductVariantTranslationInput"
2778
- typeLinks={{
2779
- ID: '/reference/graphql-api/admin/object-types#id',
2780
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
2781
- String: '/reference/graphql-api/admin/object-types#string',
2782
- JSON: '/reference/graphql-api/admin/object-types#json',
2783
- }}
2784
- >
2785
- {`input ProductVariantTranslationInput {
2786
- id: ID
2787
- languageCode: LanguageCode!
2788
- name: String
2789
- customFields: JSON
2790
- }`}
2791
- </GraphQLDoc>
2792
-
2793
- ## PromotionFilterParameter {#promotionfilterparameter}
2794
-
2795
- <GraphQLDoc
2796
- type="input"
2797
- typeName="PromotionFilterParameter"
2798
- typeLinks={{
2799
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
2800
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
2801
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
2802
- NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
2803
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
2804
- PromotionFilterParameter: '/reference/graphql-api/admin/input-types#promotionfilterparameter',
2805
- }}
2806
- >
2807
- {`input PromotionFilterParameter {
2808
- id: IDOperators
2809
- createdAt: DateOperators
2810
- updatedAt: DateOperators
2811
- startsAt: DateOperators
2812
- endsAt: DateOperators
2813
- couponCode: StringOperators
2814
- perCustomerUsageLimit: NumberOperators
2815
- usageLimit: NumberOperators
2816
- name: StringOperators
2817
- description: StringOperators
2818
- enabled: BooleanOperators
2819
- _and: [PromotionFilterParameter!]
2820
- _or: [PromotionFilterParameter!]
2821
- }`}
2822
- </GraphQLDoc>
2823
-
2824
- ## PromotionListOptions {#promotionlistoptions}
2825
-
2826
- <GraphQLDoc
2827
- type="input"
2828
- typeName="PromotionListOptions"
2829
- typeLinks={{
2830
- Int: '/reference/graphql-api/admin/object-types#int',
2831
- PromotionSortParameter: '/reference/graphql-api/admin/input-types#promotionsortparameter',
2832
- PromotionFilterParameter: '/reference/graphql-api/admin/input-types#promotionfilterparameter',
2833
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
2834
- }}
2835
- >
2836
- {`input PromotionListOptions {
2837
- """Skips the first n results, for use in pagination"""
2838
- skip: Int
2839
- """Takes n results, for use in pagination"""
2840
- take: Int
2841
- """Specifies which properties to sort the results by"""
2842
- sort: PromotionSortParameter
2843
- """Allows the results to be filtered"""
2844
- filter: PromotionFilterParameter
2845
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
2846
- filterOperator: LogicalOperator
2847
- }`}
2848
- </GraphQLDoc>
2849
-
2850
- ## PromotionSortParameter {#promotionsortparameter}
2851
-
2852
- <GraphQLDoc
2853
- type="input"
2854
- typeName="PromotionSortParameter"
2855
- typeLinks={{
2856
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
2857
- }}
2858
- >
2859
- {`input PromotionSortParameter {
2860
- id: SortOrder
2861
- createdAt: SortOrder
2862
- updatedAt: SortOrder
2863
- startsAt: SortOrder
2864
- endsAt: SortOrder
2865
- couponCode: SortOrder
2866
- perCustomerUsageLimit: SortOrder
2867
- usageLimit: SortOrder
2868
- name: SortOrder
2869
- description: SortOrder
2870
- }`}
2871
- </GraphQLDoc>
2872
-
2873
- ## PromotionTranslationInput {#promotiontranslationinput}
2874
-
2875
- <GraphQLDoc
2876
- type="input"
2877
- typeName="PromotionTranslationInput"
2878
- typeLinks={{
2879
- ID: '/reference/graphql-api/admin/object-types#id',
2880
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
2881
- String: '/reference/graphql-api/admin/object-types#string',
2882
- JSON: '/reference/graphql-api/admin/object-types#json',
2883
- }}
2884
- >
2885
- {`input PromotionTranslationInput {
2886
- id: ID
2887
- languageCode: LanguageCode!
2888
- name: String
2889
- description: String
2890
- customFields: JSON
2891
- }`}
2892
- </GraphQLDoc>
2893
-
2894
- ## ProvinceFilterParameter {#provincefilterparameter}
2895
-
2896
- <GraphQLDoc
2897
- type="input"
2898
- typeName="ProvinceFilterParameter"
2899
- typeLinks={{
2900
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
2901
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
2902
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
2903
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
2904
- ProvinceFilterParameter: '/reference/graphql-api/admin/input-types#provincefilterparameter',
2905
- }}
2906
- >
2907
- {`input ProvinceFilterParameter {
2908
- id: IDOperators
2909
- createdAt: DateOperators
2910
- updatedAt: DateOperators
2911
- languageCode: StringOperators
2912
- code: StringOperators
2913
- type: StringOperators
2914
- name: StringOperators
2915
- enabled: BooleanOperators
2916
- parentId: IDOperators
2917
- _and: [ProvinceFilterParameter!]
2918
- _or: [ProvinceFilterParameter!]
2919
- }`}
2920
- </GraphQLDoc>
2921
-
2922
- ## ProvinceListOptions {#provincelistoptions}
2923
-
2924
- <GraphQLDoc
2925
- type="input"
2926
- typeName="ProvinceListOptions"
2927
- typeLinks={{
2928
- Int: '/reference/graphql-api/admin/object-types#int',
2929
- ProvinceSortParameter: '/reference/graphql-api/admin/input-types#provincesortparameter',
2930
- ProvinceFilterParameter: '/reference/graphql-api/admin/input-types#provincefilterparameter',
2931
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
2932
- }}
2933
- >
2934
- {`input ProvinceListOptions {
2935
- """Skips the first n results, for use in pagination"""
2936
- skip: Int
2937
- """Takes n results, for use in pagination"""
2938
- take: Int
2939
- """Specifies which properties to sort the results by"""
2940
- sort: ProvinceSortParameter
2941
- """Allows the results to be filtered"""
2942
- filter: ProvinceFilterParameter
2943
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
2944
- filterOperator: LogicalOperator
2945
- }`}
2946
- </GraphQLDoc>
2947
-
2948
- ## ProvinceSortParameter {#provincesortparameter}
2949
-
2950
- <GraphQLDoc
2951
- type="input"
2952
- typeName="ProvinceSortParameter"
2953
- typeLinks={{
2954
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
2955
- }}
2956
- >
2957
- {`input ProvinceSortParameter {
2958
- id: SortOrder
2959
- createdAt: SortOrder
2960
- updatedAt: SortOrder
2961
- code: SortOrder
2962
- type: SortOrder
2963
- name: SortOrder
2964
- parentId: SortOrder
2965
- }`}
2966
- </GraphQLDoc>
2967
-
2968
- ## ProvinceTranslationInput {#provincetranslationinput}
2969
-
2970
- <GraphQLDoc
2971
- type="input"
2972
- typeName="ProvinceTranslationInput"
2973
- typeLinks={{
2974
- ID: '/reference/graphql-api/admin/object-types#id',
2975
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
2976
- String: '/reference/graphql-api/admin/object-types#string',
2977
- JSON: '/reference/graphql-api/admin/object-types#json',
2978
- }}
2979
- >
2980
- {`input ProvinceTranslationInput {
2981
- id: ID
2982
- languageCode: LanguageCode!
2983
- name: String
2984
- customFields: JSON
2985
- }`}
2986
- </GraphQLDoc>
2987
-
2988
- ## RefundOrderInput {#refundorderinput}
2989
-
2990
- <GraphQLDoc
2991
- type="input"
2992
- typeName="RefundOrderInput"
2993
- typeLinks={{
2994
- OrderLineInput: '/reference/graphql-api/admin/input-types#orderlineinput',
2995
- Money: '/reference/graphql-api/admin/object-types#money',
2996
- ID: '/reference/graphql-api/admin/object-types#id',
2997
- String: '/reference/graphql-api/admin/object-types#string',
2998
- }}
2999
- >
3000
- {`input RefundOrderInput {
3001
- lines: [OrderLineInput!]
3002
- shipping: Money
3003
- adjustment: Money
3004
- """
3005
- 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.
3006
- Can be as much as the total amount of the payment minus the sum of all previous refunds.
3007
- """
3008
- amount: Money
3009
- paymentId: ID!
3010
- reason: String
3011
- }`}
3012
- </GraphQLDoc>
3013
-
3014
- ## RemoveCollectionsFromChannelInput {#removecollectionsfromchannelinput}
3015
-
3016
- <GraphQLDoc
3017
- type="input"
3018
- typeName="RemoveCollectionsFromChannelInput"
3019
- typeLinks={{
3020
- ID: '/reference/graphql-api/admin/object-types#id',
3021
- }}
3022
- >
3023
- {`input RemoveCollectionsFromChannelInput {
3024
- collectionIds: [ID!]!
3025
- channelId: ID!
3026
- }`}
3027
- </GraphQLDoc>
3028
-
3029
- ## RemoveFacetsFromChannelInput {#removefacetsfromchannelinput}
3030
-
3031
- <GraphQLDoc
3032
- type="input"
3033
- typeName="RemoveFacetsFromChannelInput"
3034
- typeLinks={{
3035
- ID: '/reference/graphql-api/admin/object-types#id',
3036
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3037
- }}
3038
- >
3039
- {`input RemoveFacetsFromChannelInput {
3040
- facetIds: [ID!]!
3041
- channelId: ID!
3042
- force: Boolean
3043
- }`}
3044
- </GraphQLDoc>
3045
-
3046
- ## RemovePaymentMethodsFromChannelInput {#removepaymentmethodsfromchannelinput}
3047
-
3048
- <GraphQLDoc
3049
- type="input"
3050
- typeName="RemovePaymentMethodsFromChannelInput"
3051
- typeLinks={{
3052
- ID: '/reference/graphql-api/admin/object-types#id',
3053
- }}
3054
- >
3055
- {`input RemovePaymentMethodsFromChannelInput {
3056
- paymentMethodIds: [ID!]!
3057
- channelId: ID!
3058
- }`}
3059
- </GraphQLDoc>
3060
-
3061
- ## RemoveProductVariantsFromChannelInput {#removeproductvariantsfromchannelinput}
3062
-
3063
- <GraphQLDoc
3064
- type="input"
3065
- typeName="RemoveProductVariantsFromChannelInput"
3066
- typeLinks={{
3067
- ID: '/reference/graphql-api/admin/object-types#id',
3068
- }}
3069
- >
3070
- {`input RemoveProductVariantsFromChannelInput {
3071
- productVariantIds: [ID!]!
3072
- channelId: ID!
3073
- }`}
3074
- </GraphQLDoc>
3075
-
3076
- ## RemoveProductsFromChannelInput {#removeproductsfromchannelinput}
3077
-
3078
- <GraphQLDoc
3079
- type="input"
3080
- typeName="RemoveProductsFromChannelInput"
3081
- typeLinks={{
3082
- ID: '/reference/graphql-api/admin/object-types#id',
3083
- }}
3084
- >
3085
- {`input RemoveProductsFromChannelInput {
3086
- productIds: [ID!]!
3087
- channelId: ID!
3088
- }`}
3089
- </GraphQLDoc>
3090
-
3091
- ## RemovePromotionsFromChannelInput {#removepromotionsfromchannelinput}
3092
-
3093
- <GraphQLDoc
3094
- type="input"
3095
- typeName="RemovePromotionsFromChannelInput"
3096
- typeLinks={{
3097
- ID: '/reference/graphql-api/admin/object-types#id',
3098
- }}
3099
- >
3100
- {`input RemovePromotionsFromChannelInput {
3101
- promotionIds: [ID!]!
3102
- channelId: ID!
3103
- }`}
3104
- </GraphQLDoc>
3105
-
3106
- ## RemoveShippingMethodsFromChannelInput {#removeshippingmethodsfromchannelinput}
3107
-
3108
- <GraphQLDoc
3109
- type="input"
3110
- typeName="RemoveShippingMethodsFromChannelInput"
3111
- typeLinks={{
3112
- ID: '/reference/graphql-api/admin/object-types#id',
3113
- }}
3114
- >
3115
- {`input RemoveShippingMethodsFromChannelInput {
3116
- shippingMethodIds: [ID!]!
3117
- channelId: ID!
3118
- }`}
3119
- </GraphQLDoc>
3120
-
3121
- ## RemoveStockLocationsFromChannelInput {#removestocklocationsfromchannelinput}
3122
-
3123
- <GraphQLDoc
3124
- type="input"
3125
- typeName="RemoveStockLocationsFromChannelInput"
3126
- typeLinks={{
3127
- ID: '/reference/graphql-api/admin/object-types#id',
3128
- }}
3129
- >
3130
- {`input RemoveStockLocationsFromChannelInput {
3131
- stockLocationIds: [ID!]!
3132
- channelId: ID!
3133
- }`}
3134
- </GraphQLDoc>
3135
-
3136
- ## RoleFilterParameter {#rolefilterparameter}
3137
-
3138
- <GraphQLDoc
3139
- type="input"
3140
- typeName="RoleFilterParameter"
3141
- typeLinks={{
3142
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
3143
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
3144
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
3145
- RoleFilterParameter: '/reference/graphql-api/admin/input-types#rolefilterparameter',
3146
- }}
3147
- >
3148
- {`input RoleFilterParameter {
3149
- id: IDOperators
3150
- createdAt: DateOperators
3151
- updatedAt: DateOperators
3152
- code: StringOperators
3153
- description: StringOperators
3154
- _and: [RoleFilterParameter!]
3155
- _or: [RoleFilterParameter!]
3156
- }`}
3157
- </GraphQLDoc>
3158
-
3159
- ## RoleListOptions {#rolelistoptions}
3160
-
3161
- <GraphQLDoc
3162
- type="input"
3163
- typeName="RoleListOptions"
3164
- typeLinks={{
3165
- Int: '/reference/graphql-api/admin/object-types#int',
3166
- RoleSortParameter: '/reference/graphql-api/admin/input-types#rolesortparameter',
3167
- RoleFilterParameter: '/reference/graphql-api/admin/input-types#rolefilterparameter',
3168
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
3169
- }}
3170
- >
3171
- {`input RoleListOptions {
3172
- """Skips the first n results, for use in pagination"""
3173
- skip: Int
3174
- """Takes n results, for use in pagination"""
3175
- take: Int
3176
- """Specifies which properties to sort the results by"""
3177
- sort: RoleSortParameter
3178
- """Allows the results to be filtered"""
3179
- filter: RoleFilterParameter
3180
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
3181
- filterOperator: LogicalOperator
3182
- }`}
3183
- </GraphQLDoc>
3184
-
3185
- ## RoleSortParameter {#rolesortparameter}
3186
-
3187
- <GraphQLDoc
3188
- type="input"
3189
- typeName="RoleSortParameter"
3190
- typeLinks={{
3191
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
3192
- }}
3193
- >
3194
- {`input RoleSortParameter {
3195
- id: SortOrder
3196
- createdAt: SortOrder
3197
- updatedAt: SortOrder
3198
- code: SortOrder
3199
- description: SortOrder
3200
- }`}
3201
- </GraphQLDoc>
3202
-
3203
- ## SearchInput {#searchinput}
3204
-
3205
- <GraphQLDoc
3206
- type="input"
3207
- typeName="SearchInput"
3208
- typeLinks={{
3209
- String: '/reference/graphql-api/admin/object-types#string',
3210
- ID: '/reference/graphql-api/admin/object-types#id',
3211
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
3212
- FacetValueFilterInput: '/reference/graphql-api/admin/input-types#facetvaluefilterinput',
3213
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3214
- Int: '/reference/graphql-api/admin/object-types#int',
3215
- SearchResultSortParameter: '/reference/graphql-api/admin/input-types#searchresultsortparameter',
3216
- }}
3217
- >
3218
- {`input SearchInput {
3219
- term: String
3220
- facetValueIds: [ID!]
3221
- facetValueOperator: LogicalOperator
3222
- facetValueFilters: [FacetValueFilterInput!]
3223
- collectionId: ID
3224
- collectionSlug: String
3225
- groupByProduct: Boolean
3226
- take: Int
3227
- skip: Int
3228
- sort: SearchResultSortParameter
3229
- }`}
3230
- </GraphQLDoc>
3231
-
3232
- ## SearchResultSortParameter {#searchresultsortparameter}
3233
-
3234
- <GraphQLDoc
3235
- type="input"
3236
- typeName="SearchResultSortParameter"
3237
- typeLinks={{
3238
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
3239
- }}
3240
- >
3241
- {`input SearchResultSortParameter {
3242
- name: SortOrder
3243
- price: SortOrder
3244
- }`}
3245
- </GraphQLDoc>
3246
-
3247
- ## SellerFilterParameter {#sellerfilterparameter}
3248
-
3249
- <GraphQLDoc
3250
- type="input"
3251
- typeName="SellerFilterParameter"
3252
- typeLinks={{
3253
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
3254
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
3255
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
3256
- SellerFilterParameter: '/reference/graphql-api/admin/input-types#sellerfilterparameter',
3257
- }}
3258
- >
3259
- {`input SellerFilterParameter {
3260
- id: IDOperators
3261
- createdAt: DateOperators
3262
- updatedAt: DateOperators
3263
- name: StringOperators
3264
- _and: [SellerFilterParameter!]
3265
- _or: [SellerFilterParameter!]
3266
- }`}
3267
- </GraphQLDoc>
3268
-
3269
- ## SellerListOptions {#sellerlistoptions}
3270
-
3271
- <GraphQLDoc
3272
- type="input"
3273
- typeName="SellerListOptions"
3274
- typeLinks={{
3275
- Int: '/reference/graphql-api/admin/object-types#int',
3276
- SellerSortParameter: '/reference/graphql-api/admin/input-types#sellersortparameter',
3277
- SellerFilterParameter: '/reference/graphql-api/admin/input-types#sellerfilterparameter',
3278
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
3279
- }}
3280
- >
3281
- {`input SellerListOptions {
3282
- """Skips the first n results, for use in pagination"""
3283
- skip: Int
3284
- """Takes n results, for use in pagination"""
3285
- take: Int
3286
- """Specifies which properties to sort the results by"""
3287
- sort: SellerSortParameter
3288
- """Allows the results to be filtered"""
3289
- filter: SellerFilterParameter
3290
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
3291
- filterOperator: LogicalOperator
3292
- }`}
3293
- </GraphQLDoc>
3294
-
3295
- ## SellerSortParameter {#sellersortparameter}
3296
-
3297
- <GraphQLDoc
3298
- type="input"
3299
- typeName="SellerSortParameter"
3300
- typeLinks={{
3301
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
3302
- }}
3303
- >
3304
- {`input SellerSortParameter {
3305
- id: SortOrder
3306
- createdAt: SortOrder
3307
- updatedAt: SortOrder
3308
- name: SortOrder
3309
- }`}
3310
- </GraphQLDoc>
3311
-
3312
- ## SetOrderCustomerInput {#setordercustomerinput}
3313
-
3314
- <GraphQLDoc
3315
- type="input"
3316
- typeName="SetOrderCustomerInput"
3317
- typeLinks={{
3318
- ID: '/reference/graphql-api/admin/object-types#id',
3319
- String: '/reference/graphql-api/admin/object-types#string',
3320
- }}
3321
- >
3322
- {`input SetOrderCustomerInput {
3323
- orderId: ID!
3324
- customerId: ID!
3325
- note: String
3326
- }`}
3327
- </GraphQLDoc>
3328
-
3329
- ## SettingsStoreInput {#settingsstoreinput}
3330
-
3331
- <GraphQLDoc
3332
- type="input"
3333
- typeName="SettingsStoreInput"
3334
- typeLinks={{
3335
- String: '/reference/graphql-api/admin/object-types#string',
3336
- JSON: '/reference/graphql-api/admin/object-types#json',
3337
- }}
3338
- >
3339
- {`input SettingsStoreInput {
3340
- key: String!
3341
- value: JSON!
3342
- }`}
3343
- </GraphQLDoc>
3344
-
3345
- ## SettleRefundInput {#settlerefundinput}
3346
-
3347
- <GraphQLDoc
3348
- type="input"
3349
- typeName="SettleRefundInput"
3350
- typeLinks={{
3351
- ID: '/reference/graphql-api/admin/object-types#id',
3352
- String: '/reference/graphql-api/admin/object-types#string',
3353
- }}
3354
- >
3355
- {`input SettleRefundInput {
3356
- id: ID!
3357
- transactionId: String!
3358
- }`}
3359
- </GraphQLDoc>
3360
-
3361
- ## ShippingMethodFilterParameter {#shippingmethodfilterparameter}
3362
-
3363
- <GraphQLDoc
3364
- type="input"
3365
- typeName="ShippingMethodFilterParameter"
3366
- typeLinks={{
3367
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
3368
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
3369
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
3370
- ShippingMethodFilterParameter: '/reference/graphql-api/admin/input-types#shippingmethodfilterparameter',
3371
- }}
3372
- >
3373
- {`input ShippingMethodFilterParameter {
3374
- id: IDOperators
3375
- createdAt: DateOperators
3376
- updatedAt: DateOperators
3377
- languageCode: StringOperators
3378
- code: StringOperators
3379
- name: StringOperators
3380
- description: StringOperators
3381
- fulfillmentHandlerCode: StringOperators
3382
- _and: [ShippingMethodFilterParameter!]
3383
- _or: [ShippingMethodFilterParameter!]
3384
- }`}
3385
- </GraphQLDoc>
3386
-
3387
- ## ShippingMethodListOptions {#shippingmethodlistoptions}
3388
-
3389
- <GraphQLDoc
3390
- type="input"
3391
- typeName="ShippingMethodListOptions"
3392
- typeLinks={{
3393
- Int: '/reference/graphql-api/admin/object-types#int',
3394
- ShippingMethodSortParameter: '/reference/graphql-api/admin/input-types#shippingmethodsortparameter',
3395
- ShippingMethodFilterParameter: '/reference/graphql-api/admin/input-types#shippingmethodfilterparameter',
3396
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
3397
- }}
3398
- >
3399
- {`input ShippingMethodListOptions {
3400
- """Skips the first n results, for use in pagination"""
3401
- skip: Int
3402
- """Takes n results, for use in pagination"""
3403
- take: Int
3404
- """Specifies which properties to sort the results by"""
3405
- sort: ShippingMethodSortParameter
3406
- """Allows the results to be filtered"""
3407
- filter: ShippingMethodFilterParameter
3408
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
3409
- filterOperator: LogicalOperator
3410
- }`}
3411
- </GraphQLDoc>
3412
-
3413
- ## ShippingMethodSortParameter {#shippingmethodsortparameter}
3414
-
3415
- <GraphQLDoc
3416
- type="input"
3417
- typeName="ShippingMethodSortParameter"
3418
- typeLinks={{
3419
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
3420
- }}
3421
- >
3422
- {`input ShippingMethodSortParameter {
3423
- id: SortOrder
3424
- createdAt: SortOrder
3425
- updatedAt: SortOrder
3426
- code: SortOrder
3427
- name: SortOrder
3428
- description: SortOrder
3429
- fulfillmentHandlerCode: SortOrder
3430
- }`}
3431
- </GraphQLDoc>
3432
-
3433
- ## ShippingMethodTranslationInput {#shippingmethodtranslationinput}
3434
-
3435
- <GraphQLDoc
3436
- type="input"
3437
- typeName="ShippingMethodTranslationInput"
3438
- typeLinks={{
3439
- ID: '/reference/graphql-api/admin/object-types#id',
3440
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3441
- String: '/reference/graphql-api/admin/object-types#string',
3442
- JSON: '/reference/graphql-api/admin/object-types#json',
3443
- }}
3444
- >
3445
- {`input ShippingMethodTranslationInput {
3446
- id: ID
3447
- languageCode: LanguageCode!
3448
- name: String
3449
- description: String
3450
- customFields: JSON
3451
- }`}
3452
- </GraphQLDoc>
3453
-
3454
- ## SlugForEntityInput {#slugforentityinput}
3455
-
3456
- <GraphQLDoc
3457
- type="input"
3458
- typeName="SlugForEntityInput"
3459
- typeLinks={{
3460
- String: '/reference/graphql-api/admin/object-types#string',
3461
- ID: '/reference/graphql-api/admin/object-types#id',
3462
- }}
3463
- >
3464
- {`input SlugForEntityInput {
3465
- entityName: String!
3466
- fieldName: String!
3467
- inputValue: String!
3468
- entityId: ID
3469
- }`}
3470
- </GraphQLDoc>
3471
-
3472
- ## StockLevelInput {#stocklevelinput}
3473
-
3474
- <GraphQLDoc
3475
- type="input"
3476
- typeName="StockLevelInput"
3477
- typeLinks={{
3478
- ID: '/reference/graphql-api/admin/object-types#id',
3479
- Int: '/reference/graphql-api/admin/object-types#int',
3480
- }}
3481
- >
3482
- {`input StockLevelInput {
3483
- stockLocationId: ID!
3484
- stockOnHand: Int!
3485
- }`}
3486
- </GraphQLDoc>
3487
-
3488
- ## StockLocationFilterParameter {#stocklocationfilterparameter}
3489
-
3490
- <GraphQLDoc
3491
- type="input"
3492
- typeName="StockLocationFilterParameter"
3493
- typeLinks={{
3494
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
3495
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
3496
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
3497
- StockLocationFilterParameter: '/reference/graphql-api/admin/input-types#stocklocationfilterparameter',
3498
- }}
3499
- >
3500
- {`input StockLocationFilterParameter {
3501
- id: IDOperators
3502
- createdAt: DateOperators
3503
- updatedAt: DateOperators
3504
- name: StringOperators
3505
- description: StringOperators
3506
- _and: [StockLocationFilterParameter!]
3507
- _or: [StockLocationFilterParameter!]
3508
- }`}
3509
- </GraphQLDoc>
3510
-
3511
- ## StockLocationListOptions {#stocklocationlistoptions}
3512
-
3513
- <GraphQLDoc
3514
- type="input"
3515
- typeName="StockLocationListOptions"
3516
- typeLinks={{
3517
- Int: '/reference/graphql-api/admin/object-types#int',
3518
- StockLocationSortParameter: '/reference/graphql-api/admin/input-types#stocklocationsortparameter',
3519
- StockLocationFilterParameter: '/reference/graphql-api/admin/input-types#stocklocationfilterparameter',
3520
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
3521
- }}
3522
- >
3523
- {`input StockLocationListOptions {
3524
- """Skips the first n results, for use in pagination"""
3525
- skip: Int
3526
- """Takes n results, for use in pagination"""
3527
- take: Int
3528
- """Specifies which properties to sort the results by"""
3529
- sort: StockLocationSortParameter
3530
- """Allows the results to be filtered"""
3531
- filter: StockLocationFilterParameter
3532
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
3533
- filterOperator: LogicalOperator
3534
- }`}
3535
- </GraphQLDoc>
3536
-
3537
- ## StockLocationSortParameter {#stocklocationsortparameter}
3538
-
3539
- <GraphQLDoc
3540
- type="input"
3541
- typeName="StockLocationSortParameter"
3542
- typeLinks={{
3543
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
3544
- }}
3545
- >
3546
- {`input StockLocationSortParameter {
3547
- id: SortOrder
3548
- createdAt: SortOrder
3549
- updatedAt: SortOrder
3550
- name: SortOrder
3551
- description: SortOrder
3552
- }`}
3553
- </GraphQLDoc>
3554
-
3555
- ## StockMovementListOptions {#stockmovementlistoptions}
3556
-
3557
- <GraphQLDoc
3558
- type="input"
3559
- typeName="StockMovementListOptions"
3560
- typeLinks={{
3561
- StockMovementType: '/reference/graphql-api/admin/enums#stockmovementtype',
3562
- Int: '/reference/graphql-api/admin/object-types#int',
3563
- }}
3564
- >
3565
- {`input StockMovementListOptions {
3566
- type: StockMovementType
3567
- skip: Int
3568
- take: Int
3569
- }`}
3570
- </GraphQLDoc>
3571
-
3572
- ## StringListOperators {#stringlistoperators}
3573
-
3574
- <GraphQLDoc
3575
- type="input"
3576
- typeName="StringListOperators"
3577
- typeLinks={{
3578
- String: '/reference/graphql-api/admin/object-types#string',
3579
- }}
3580
- >
3581
- {`"""Operators for filtering on a list of String fields"""
3582
- input StringListOperators {
3583
- inList: String!
3584
- }`}
3585
- </GraphQLDoc>
3586
-
3587
- ## StringOperators {#stringoperators}
3588
-
3589
- <GraphQLDoc
3590
- type="input"
3591
- typeName="StringOperators"
3592
- typeLinks={{
3593
- String: '/reference/graphql-api/admin/object-types#string',
3594
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3595
- }}
3596
- >
3597
- {`"""Operators for filtering on a String field"""
3598
- input StringOperators {
3599
- eq: String
3600
- notEq: String
3601
- contains: String
3602
- notContains: String
3603
- in: [String!]
3604
- notIn: [String!]
3605
- regex: String
3606
- isNull: Boolean
3607
- }`}
3608
- </GraphQLDoc>
3609
-
3610
- ## SurchargeInput {#surchargeinput}
3611
-
3612
- <GraphQLDoc
3613
- type="input"
3614
- typeName="SurchargeInput"
3615
- typeLinks={{
3616
- String: '/reference/graphql-api/admin/object-types#string',
3617
- Money: '/reference/graphql-api/admin/object-types#money',
3618
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3619
- Float: '/reference/graphql-api/admin/object-types#float',
3620
- }}
3621
- >
3622
- {`input SurchargeInput {
3623
- description: String!
3624
- sku: String
3625
- price: Money!
3626
- priceIncludesTax: Boolean!
3627
- taxRate: Float
3628
- taxDescription: String
3629
- }`}
3630
- </GraphQLDoc>
3631
-
3632
- ## TagFilterParameter {#tagfilterparameter}
3633
-
3634
- <GraphQLDoc
3635
- type="input"
3636
- typeName="TagFilterParameter"
3637
- typeLinks={{
3638
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
3639
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
3640
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
3641
- TagFilterParameter: '/reference/graphql-api/admin/input-types#tagfilterparameter',
3642
- }}
3643
- >
3644
- {`input TagFilterParameter {
3645
- id: IDOperators
3646
- createdAt: DateOperators
3647
- updatedAt: DateOperators
3648
- value: StringOperators
3649
- _and: [TagFilterParameter!]
3650
- _or: [TagFilterParameter!]
3651
- }`}
3652
- </GraphQLDoc>
3653
-
3654
- ## TagListOptions {#taglistoptions}
3655
-
3656
- <GraphQLDoc
3657
- type="input"
3658
- typeName="TagListOptions"
3659
- typeLinks={{
3660
- Int: '/reference/graphql-api/admin/object-types#int',
3661
- TagSortParameter: '/reference/graphql-api/admin/input-types#tagsortparameter',
3662
- TagFilterParameter: '/reference/graphql-api/admin/input-types#tagfilterparameter',
3663
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
3664
- }}
3665
- >
3666
- {`input TagListOptions {
3667
- """Skips the first n results, for use in pagination"""
3668
- skip: Int
3669
- """Takes n results, for use in pagination"""
3670
- take: Int
3671
- """Specifies which properties to sort the results by"""
3672
- sort: TagSortParameter
3673
- """Allows the results to be filtered"""
3674
- filter: TagFilterParameter
3675
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
3676
- filterOperator: LogicalOperator
3677
- }`}
3678
- </GraphQLDoc>
3679
-
3680
- ## TagSortParameter {#tagsortparameter}
3681
-
3682
- <GraphQLDoc
3683
- type="input"
3684
- typeName="TagSortParameter"
3685
- typeLinks={{
3686
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
3687
- }}
3688
- >
3689
- {`input TagSortParameter {
3690
- id: SortOrder
3691
- createdAt: SortOrder
3692
- updatedAt: SortOrder
3693
- value: SortOrder
3694
- }`}
3695
- </GraphQLDoc>
3696
-
3697
- ## TaxCategoryFilterParameter {#taxcategoryfilterparameter}
3698
-
3699
- <GraphQLDoc
3700
- type="input"
3701
- typeName="TaxCategoryFilterParameter"
3702
- typeLinks={{
3703
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
3704
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
3705
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
3706
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
3707
- TaxCategoryFilterParameter: '/reference/graphql-api/admin/input-types#taxcategoryfilterparameter',
3708
- }}
3709
- >
3710
- {`input TaxCategoryFilterParameter {
3711
- id: IDOperators
3712
- createdAt: DateOperators
3713
- updatedAt: DateOperators
3714
- name: StringOperators
3715
- isDefault: BooleanOperators
3716
- _and: [TaxCategoryFilterParameter!]
3717
- _or: [TaxCategoryFilterParameter!]
3718
- }`}
3719
- </GraphQLDoc>
3720
-
3721
- ## TaxCategoryListOptions {#taxcategorylistoptions}
3722
-
3723
- <GraphQLDoc
3724
- type="input"
3725
- typeName="TaxCategoryListOptions"
3726
- typeLinks={{
3727
- Int: '/reference/graphql-api/admin/object-types#int',
3728
- TaxCategorySortParameter: '/reference/graphql-api/admin/input-types#taxcategorysortparameter',
3729
- TaxCategoryFilterParameter: '/reference/graphql-api/admin/input-types#taxcategoryfilterparameter',
3730
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
3731
- }}
3732
- >
3733
- {`input TaxCategoryListOptions {
3734
- """Skips the first n results, for use in pagination"""
3735
- skip: Int
3736
- """Takes n results, for use in pagination"""
3737
- take: Int
3738
- """Specifies which properties to sort the results by"""
3739
- sort: TaxCategorySortParameter
3740
- """Allows the results to be filtered"""
3741
- filter: TaxCategoryFilterParameter
3742
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
3743
- filterOperator: LogicalOperator
3744
- }`}
3745
- </GraphQLDoc>
3746
-
3747
- ## TaxCategorySortParameter {#taxcategorysortparameter}
3748
-
3749
- <GraphQLDoc
3750
- type="input"
3751
- typeName="TaxCategorySortParameter"
3752
- typeLinks={{
3753
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
3754
- }}
3755
- >
3756
- {`input TaxCategorySortParameter {
3757
- id: SortOrder
3758
- createdAt: SortOrder
3759
- updatedAt: SortOrder
3760
- name: SortOrder
3761
- }`}
3762
- </GraphQLDoc>
3763
-
3764
- ## TaxRateFilterParameter {#taxratefilterparameter}
3765
-
3766
- <GraphQLDoc
3767
- type="input"
3768
- typeName="TaxRateFilterParameter"
3769
- typeLinks={{
3770
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
3771
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
3772
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
3773
- BooleanOperators: '/reference/graphql-api/admin/input-types#booleanoperators',
3774
- NumberOperators: '/reference/graphql-api/admin/input-types#numberoperators',
3775
- TaxRateFilterParameter: '/reference/graphql-api/admin/input-types#taxratefilterparameter',
3776
- }}
3777
- >
3778
- {`input TaxRateFilterParameter {
3779
- zoneId: IDOperators
3780
- categoryId: IDOperators
3781
- id: IDOperators
3782
- createdAt: DateOperators
3783
- updatedAt: DateOperators
3784
- name: StringOperators
3785
- enabled: BooleanOperators
3786
- value: NumberOperators
3787
- _and: [TaxRateFilterParameter!]
3788
- _or: [TaxRateFilterParameter!]
3789
- }`}
3790
- </GraphQLDoc>
3791
-
3792
- ## TaxRateListOptions {#taxratelistoptions}
3793
-
3794
- <GraphQLDoc
3795
- type="input"
3796
- typeName="TaxRateListOptions"
3797
- typeLinks={{
3798
- Int: '/reference/graphql-api/admin/object-types#int',
3799
- TaxRateSortParameter: '/reference/graphql-api/admin/input-types#taxratesortparameter',
3800
- TaxRateFilterParameter: '/reference/graphql-api/admin/input-types#taxratefilterparameter',
3801
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
3802
- }}
3803
- >
3804
- {`input TaxRateListOptions {
3805
- """Skips the first n results, for use in pagination"""
3806
- skip: Int
3807
- """Takes n results, for use in pagination"""
3808
- take: Int
3809
- """Specifies which properties to sort the results by"""
3810
- sort: TaxRateSortParameter
3811
- """Allows the results to be filtered"""
3812
- filter: TaxRateFilterParameter
3813
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
3814
- filterOperator: LogicalOperator
3815
- }`}
3816
- </GraphQLDoc>
3817
-
3818
- ## TaxRateSortParameter {#taxratesortparameter}
3819
-
3820
- <GraphQLDoc
3821
- type="input"
3822
- typeName="TaxRateSortParameter"
3823
- typeLinks={{
3824
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
3825
- }}
3826
- >
3827
- {`input TaxRateSortParameter {
3828
- id: SortOrder
3829
- createdAt: SortOrder
3830
- updatedAt: SortOrder
3831
- name: SortOrder
3832
- value: SortOrder
3833
- }`}
3834
- </GraphQLDoc>
3835
-
3836
- ## TestEligibleShippingMethodsInput {#testeligibleshippingmethodsinput}
3837
-
3838
- <GraphQLDoc
3839
- type="input"
3840
- typeName="TestEligibleShippingMethodsInput"
3841
- typeLinks={{
3842
- CreateAddressInput: '/reference/graphql-api/admin/input-types#createaddressinput',
3843
- TestShippingMethodOrderLineInput: '/reference/graphql-api/admin/input-types#testshippingmethodorderlineinput',
3844
- }}
3845
- >
3846
- {`input TestEligibleShippingMethodsInput {
3847
- shippingAddress: CreateAddressInput!
3848
- lines: [TestShippingMethodOrderLineInput!]!
3849
- }`}
3850
- </GraphQLDoc>
3851
-
3852
- ## TestShippingMethodInput {#testshippingmethodinput}
3853
-
3854
- <GraphQLDoc
3855
- type="input"
3856
- typeName="TestShippingMethodInput"
3857
- typeLinks={{
3858
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
3859
- CreateAddressInput: '/reference/graphql-api/admin/input-types#createaddressinput',
3860
- TestShippingMethodOrderLineInput: '/reference/graphql-api/admin/input-types#testshippingmethodorderlineinput',
3861
- }}
3862
- >
3863
- {`input TestShippingMethodInput {
3864
- checker: ConfigurableOperationInput!
3865
- calculator: ConfigurableOperationInput!
3866
- shippingAddress: CreateAddressInput!
3867
- lines: [TestShippingMethodOrderLineInput!]!
3868
- }`}
3869
- </GraphQLDoc>
3870
-
3871
- ## TestShippingMethodOrderLineInput {#testshippingmethodorderlineinput}
3872
-
3873
- <GraphQLDoc
3874
- type="input"
3875
- typeName="TestShippingMethodOrderLineInput"
3876
- typeLinks={{
3877
- ID: '/reference/graphql-api/admin/object-types#id',
3878
- Int: '/reference/graphql-api/admin/object-types#int',
3879
- }}
3880
- >
3881
- {`input TestShippingMethodOrderLineInput {
3882
- productVariantId: ID!
3883
- quantity: Int!
3884
- }`}
3885
- </GraphQLDoc>
3886
-
3887
- ## UpdateActiveAdministratorInput {#updateactiveadministratorinput}
3888
-
3889
- <GraphQLDoc
3890
- type="input"
3891
- typeName="UpdateActiveAdministratorInput"
3892
- typeLinks={{
3893
- String: '/reference/graphql-api/admin/object-types#string',
3894
- JSON: '/reference/graphql-api/admin/object-types#json',
3895
- }}
3896
- >
3897
- {`input UpdateActiveAdministratorInput {
3898
- firstName: String
3899
- lastName: String
3900
- emailAddress: String
3901
- password: String
3902
- customFields: JSON
3903
- }`}
3904
- </GraphQLDoc>
3905
-
3906
- ## UpdateAddressInput {#updateaddressinput}
3907
-
3908
- <GraphQLDoc
3909
- type="input"
3910
- typeName="UpdateAddressInput"
3911
- typeLinks={{
3912
- ID: '/reference/graphql-api/admin/object-types#id',
3913
- String: '/reference/graphql-api/admin/object-types#string',
3914
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3915
- JSON: '/reference/graphql-api/admin/object-types#json',
3916
- }}
3917
- >
3918
- {`"""
3919
- Input used to update an Address.
3920
-
3921
- The countryCode must correspond to a \`code\` property of a Country that has been defined in the
3922
- Vendure server. The \`code\` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
3923
- If an invalid code is passed, the mutation will fail.
3924
- """
3925
- input UpdateAddressInput {
3926
- id: ID!
3927
- fullName: String
3928
- company: String
3929
- streetLine1: String
3930
- streetLine2: String
3931
- city: String
3932
- province: String
3933
- postalCode: String
3934
- countryCode: String
3935
- phoneNumber: String
3936
- defaultShippingAddress: Boolean
3937
- defaultBillingAddress: Boolean
3938
- customFields: JSON
3939
- }`}
3940
- </GraphQLDoc>
3941
-
3942
- ## UpdateAdministratorInput {#updateadministratorinput}
3943
-
3944
- <GraphQLDoc
3945
- type="input"
3946
- typeName="UpdateAdministratorInput"
3947
- typeLinks={{
3948
- ID: '/reference/graphql-api/admin/object-types#id',
3949
- String: '/reference/graphql-api/admin/object-types#string',
3950
- JSON: '/reference/graphql-api/admin/object-types#json',
3951
- }}
3952
- >
3953
- {`input UpdateAdministratorInput {
3954
- id: ID!
3955
- firstName: String
3956
- lastName: String
3957
- emailAddress: String
3958
- password: String
3959
- roleIds: [ID!]
3960
- customFields: JSON
3961
- }`}
3962
- </GraphQLDoc>
3963
-
3964
- ## UpdateAssetInput {#updateassetinput}
3965
-
3966
- <GraphQLDoc
3967
- type="input"
3968
- typeName="UpdateAssetInput"
3969
- typeLinks={{
3970
- ID: '/reference/graphql-api/admin/object-types#id',
3971
- String: '/reference/graphql-api/admin/object-types#string',
3972
- CoordinateInput: '/reference/graphql-api/admin/input-types#coordinateinput',
3973
- JSON: '/reference/graphql-api/admin/object-types#json',
3974
- }}
3975
- >
3976
- {`input UpdateAssetInput {
3977
- id: ID!
3978
- name: String
3979
- focalPoint: CoordinateInput
3980
- tags: [String!]
3981
- customFields: JSON
3982
- }`}
3983
- </GraphQLDoc>
3984
-
3985
- ## UpdateChannelInput {#updatechannelinput}
3986
-
3987
- <GraphQLDoc
3988
- type="input"
3989
- typeName="UpdateChannelInput"
3990
- typeLinks={{
3991
- ID: '/reference/graphql-api/admin/object-types#id',
3992
- String: '/reference/graphql-api/admin/object-types#string',
3993
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
3994
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
3995
- CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
3996
- Int: '/reference/graphql-api/admin/object-types#int',
3997
- JSON: '/reference/graphql-api/admin/object-types#json',
3998
- }}
3999
- >
4000
- {`input UpdateChannelInput {
4001
- id: ID!
4002
- code: String
4003
- token: String
4004
- defaultLanguageCode: LanguageCode
4005
- availableLanguageCodes: [LanguageCode!]
4006
- pricesIncludeTax: Boolean
4007
- currencyCode: CurrencyCode
4008
- defaultCurrencyCode: CurrencyCode
4009
- availableCurrencyCodes: [CurrencyCode!]
4010
- trackInventory: Boolean
4011
- outOfStockThreshold: Int
4012
- defaultTaxZoneId: ID
4013
- defaultShippingZoneId: ID
4014
- sellerId: ID
4015
- customFields: JSON
4016
- }`}
4017
- </GraphQLDoc>
4018
-
4019
- ## UpdateCollectionInput {#updatecollectioninput}
4020
-
4021
- <GraphQLDoc
4022
- type="input"
4023
- typeName="UpdateCollectionInput"
4024
- typeLinks={{
4025
- ID: '/reference/graphql-api/admin/object-types#id',
4026
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4027
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
4028
- UpdateCollectionTranslationInput: '/reference/graphql-api/admin/input-types#updatecollectiontranslationinput',
4029
- JSON: '/reference/graphql-api/admin/object-types#json',
4030
- }}
4031
- >
4032
- {`input UpdateCollectionInput {
4033
- id: ID!
4034
- isPrivate: Boolean
4035
- featuredAssetId: ID
4036
- parentId: ID
4037
- assetIds: [ID!]
4038
- inheritFilters: Boolean
4039
- filters: [ConfigurableOperationInput!]
4040
- translations: [UpdateCollectionTranslationInput!]
4041
- customFields: JSON
4042
- }`}
4043
- </GraphQLDoc>
4044
-
4045
- ## UpdateCollectionTranslationInput {#updatecollectiontranslationinput}
4046
-
4047
- <GraphQLDoc
4048
- type="input"
4049
- typeName="UpdateCollectionTranslationInput"
4050
- typeLinks={{
4051
- ID: '/reference/graphql-api/admin/object-types#id',
4052
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
4053
- String: '/reference/graphql-api/admin/object-types#string',
4054
- JSON: '/reference/graphql-api/admin/object-types#json',
4055
- }}
4056
- >
4057
- {`input UpdateCollectionTranslationInput {
4058
- id: ID
4059
- languageCode: LanguageCode!
4060
- name: String
4061
- slug: String
4062
- description: String
4063
- customFields: JSON
4064
- }`}
4065
- </GraphQLDoc>
4066
-
4067
- ## UpdateCountryInput {#updatecountryinput}
4068
-
4069
- <GraphQLDoc
4070
- type="input"
4071
- typeName="UpdateCountryInput"
4072
- typeLinks={{
4073
- ID: '/reference/graphql-api/admin/object-types#id',
4074
- String: '/reference/graphql-api/admin/object-types#string',
4075
- CountryTranslationInput: '/reference/graphql-api/admin/input-types#countrytranslationinput',
4076
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4077
- JSON: '/reference/graphql-api/admin/object-types#json',
4078
- }}
4079
- >
4080
- {`input UpdateCountryInput {
4081
- id: ID!
4082
- code: String
4083
- translations: [CountryTranslationInput!]
4084
- enabled: Boolean
4085
- customFields: JSON
4086
- }`}
4087
- </GraphQLDoc>
4088
-
4089
- ## UpdateCustomerGroupInput {#updatecustomergroupinput}
4090
-
4091
- <GraphQLDoc
4092
- type="input"
4093
- typeName="UpdateCustomerGroupInput"
4094
- typeLinks={{
4095
- ID: '/reference/graphql-api/admin/object-types#id',
4096
- String: '/reference/graphql-api/admin/object-types#string',
4097
- JSON: '/reference/graphql-api/admin/object-types#json',
4098
- }}
4099
- >
4100
- {`input UpdateCustomerGroupInput {
4101
- id: ID!
4102
- name: String
4103
- customFields: JSON
4104
- }`}
4105
- </GraphQLDoc>
4106
-
4107
- ## UpdateCustomerInput {#updatecustomerinput}
4108
-
4109
- <GraphQLDoc
4110
- type="input"
4111
- typeName="UpdateCustomerInput"
4112
- typeLinks={{
4113
- ID: '/reference/graphql-api/admin/object-types#id',
4114
- String: '/reference/graphql-api/admin/object-types#string',
4115
- JSON: '/reference/graphql-api/admin/object-types#json',
4116
- }}
4117
- >
4118
- {`input UpdateCustomerInput {
4119
- id: ID!
4120
- title: String
4121
- firstName: String
4122
- lastName: String
4123
- phoneNumber: String
4124
- emailAddress: String
4125
- customFields: JSON
4126
- }`}
4127
- </GraphQLDoc>
4128
-
4129
- ## UpdateCustomerNoteInput {#updatecustomernoteinput}
4130
-
4131
- <GraphQLDoc
4132
- type="input"
4133
- typeName="UpdateCustomerNoteInput"
4134
- typeLinks={{
4135
- ID: '/reference/graphql-api/admin/object-types#id',
4136
- String: '/reference/graphql-api/admin/object-types#string',
4137
- }}
4138
- >
4139
- {`input UpdateCustomerNoteInput {
4140
- noteId: ID!
4141
- note: String!
4142
- }`}
4143
- </GraphQLDoc>
4144
-
4145
- ## UpdateFacetInput {#updatefacetinput}
4146
-
4147
- <GraphQLDoc
4148
- type="input"
4149
- typeName="UpdateFacetInput"
4150
- typeLinks={{
4151
- ID: '/reference/graphql-api/admin/object-types#id',
4152
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4153
- String: '/reference/graphql-api/admin/object-types#string',
4154
- FacetTranslationInput: '/reference/graphql-api/admin/input-types#facettranslationinput',
4155
- JSON: '/reference/graphql-api/admin/object-types#json',
4156
- }}
4157
- >
4158
- {`input UpdateFacetInput {
4159
- id: ID!
4160
- isPrivate: Boolean
4161
- code: String
4162
- translations: [FacetTranslationInput!]
4163
- customFields: JSON
4164
- }`}
4165
- </GraphQLDoc>
4166
-
4167
- ## UpdateFacetValueInput {#updatefacetvalueinput}
4168
-
4169
- <GraphQLDoc
4170
- type="input"
4171
- typeName="UpdateFacetValueInput"
4172
- typeLinks={{
4173
- ID: '/reference/graphql-api/admin/object-types#id',
4174
- String: '/reference/graphql-api/admin/object-types#string',
4175
- FacetValueTranslationInput: '/reference/graphql-api/admin/input-types#facetvaluetranslationinput',
4176
- JSON: '/reference/graphql-api/admin/object-types#json',
4177
- }}
4178
- >
4179
- {`input UpdateFacetValueInput {
4180
- id: ID!
4181
- code: String
4182
- translations: [FacetValueTranslationInput!]
4183
- customFields: JSON
4184
- }`}
4185
- </GraphQLDoc>
4186
-
4187
- ## UpdateGlobalSettingsInput {#updateglobalsettingsinput}
4188
-
4189
- <GraphQLDoc
4190
- type="input"
4191
- typeName="UpdateGlobalSettingsInput"
4192
- typeLinks={{
4193
- LanguageCode: '/reference/graphql-api/admin/enums#languagecode',
4194
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4195
- Int: '/reference/graphql-api/admin/object-types#int',
4196
- JSON: '/reference/graphql-api/admin/object-types#json',
4197
- }}
4198
- >
4199
- {`input UpdateGlobalSettingsInput {
4200
- availableLanguages: [LanguageCode!]
4201
- trackInventory: Boolean
4202
- outOfStockThreshold: Int
4203
- customFields: JSON
4204
- }`}
4205
- </GraphQLDoc>
4206
-
4207
- ## UpdateOrderAddressInput {#updateorderaddressinput}
4208
-
4209
- <GraphQLDoc
4210
- type="input"
4211
- typeName="UpdateOrderAddressInput"
4212
- typeLinks={{
4213
- String: '/reference/graphql-api/admin/object-types#string',
4214
- }}
4215
- >
4216
- {`input UpdateOrderAddressInput {
4217
- fullName: String
4218
- company: String
4219
- streetLine1: String
4220
- streetLine2: String
4221
- city: String
4222
- province: String
4223
- postalCode: String
4224
- countryCode: String
4225
- phoneNumber: String
4226
- }`}
4227
- </GraphQLDoc>
4228
-
4229
- ## UpdateOrderInput {#updateorderinput}
4230
-
4231
- <GraphQLDoc
4232
- type="input"
4233
- typeName="UpdateOrderInput"
4234
- typeLinks={{
4235
- ID: '/reference/graphql-api/admin/object-types#id',
4236
- JSON: '/reference/graphql-api/admin/object-types#json',
4237
- }}
4238
- >
4239
- {`input UpdateOrderInput {
4240
- id: ID!
4241
- customFields: JSON
4242
- }`}
4243
- </GraphQLDoc>
4244
-
4245
- ## UpdateOrderNoteInput {#updateordernoteinput}
4246
-
4247
- <GraphQLDoc
4248
- type="input"
4249
- typeName="UpdateOrderNoteInput"
4250
- typeLinks={{
4251
- ID: '/reference/graphql-api/admin/object-types#id',
4252
- String: '/reference/graphql-api/admin/object-types#string',
4253
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4254
- }}
4255
- >
4256
- {`input UpdateOrderNoteInput {
4257
- noteId: ID!
4258
- note: String
4259
- isPublic: Boolean
4260
- }`}
4261
- </GraphQLDoc>
4262
-
4263
- ## UpdatePaymentMethodInput {#updatepaymentmethodinput}
4264
-
4265
- <GraphQLDoc
4266
- type="input"
4267
- typeName="UpdatePaymentMethodInput"
4268
- typeLinks={{
4269
- ID: '/reference/graphql-api/admin/object-types#id',
4270
- String: '/reference/graphql-api/admin/object-types#string',
4271
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4272
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
4273
- PaymentMethodTranslationInput: '/reference/graphql-api/admin/input-types#paymentmethodtranslationinput',
4274
- JSON: '/reference/graphql-api/admin/object-types#json',
4275
- }}
4276
- >
4277
- {`input UpdatePaymentMethodInput {
4278
- id: ID!
4279
- code: String
4280
- enabled: Boolean
4281
- checker: ConfigurableOperationInput
4282
- handler: ConfigurableOperationInput
4283
- translations: [PaymentMethodTranslationInput!]
4284
- customFields: JSON
4285
- }`}
4286
- </GraphQLDoc>
4287
-
4288
- ## UpdateProductInput {#updateproductinput}
4289
-
4290
- <GraphQLDoc
4291
- type="input"
4292
- typeName="UpdateProductInput"
4293
- typeLinks={{
4294
- ID: '/reference/graphql-api/admin/object-types#id',
4295
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4296
- ProductTranslationInput: '/reference/graphql-api/admin/input-types#producttranslationinput',
4297
- JSON: '/reference/graphql-api/admin/object-types#json',
4298
- }}
4299
- >
4300
- {`input UpdateProductInput {
4301
- id: ID!
4302
- enabled: Boolean
4303
- featuredAssetId: ID
4304
- assetIds: [ID!]
4305
- facetValueIds: [ID!]
4306
- translations: [ProductTranslationInput!]
4307
- customFields: JSON
4308
- }`}
4309
- </GraphQLDoc>
4310
-
4311
- ## UpdateProductOptionGroupInput {#updateproductoptiongroupinput}
4312
-
4313
- <GraphQLDoc
4314
- type="input"
4315
- typeName="UpdateProductOptionGroupInput"
4316
- typeLinks={{
4317
- ID: '/reference/graphql-api/admin/object-types#id',
4318
- String: '/reference/graphql-api/admin/object-types#string',
4319
- ProductOptionGroupTranslationInput: '/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput',
4320
- JSON: '/reference/graphql-api/admin/object-types#json',
4321
- }}
4322
- >
4323
- {`input UpdateProductOptionGroupInput {
4324
- id: ID!
4325
- code: String
4326
- translations: [ProductOptionGroupTranslationInput!]
4327
- customFields: JSON
4328
- }`}
4329
- </GraphQLDoc>
4330
-
4331
- ## UpdateProductOptionInput {#updateproductoptioninput}
4332
-
4333
- <GraphQLDoc
4334
- type="input"
4335
- typeName="UpdateProductOptionInput"
4336
- typeLinks={{
4337
- ID: '/reference/graphql-api/admin/object-types#id',
4338
- String: '/reference/graphql-api/admin/object-types#string',
4339
- ProductOptionGroupTranslationInput: '/reference/graphql-api/admin/input-types#productoptiongrouptranslationinput',
4340
- JSON: '/reference/graphql-api/admin/object-types#json',
4341
- }}
4342
- >
4343
- {`input UpdateProductOptionInput {
4344
- id: ID!
4345
- code: String
4346
- translations: [ProductOptionGroupTranslationInput!]
4347
- customFields: JSON
4348
- }`}
4349
- </GraphQLDoc>
4350
-
4351
- ## UpdateProductVariantInput {#updateproductvariantinput}
4352
-
4353
- <GraphQLDoc
4354
- type="input"
4355
- typeName="UpdateProductVariantInput"
4356
- typeLinks={{
4357
- ID: '/reference/graphql-api/admin/object-types#id',
4358
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4359
- ProductVariantTranslationInput: '/reference/graphql-api/admin/input-types#productvarianttranslationinput',
4360
- String: '/reference/graphql-api/admin/object-types#string',
4361
- Money: '/reference/graphql-api/admin/object-types#money',
4362
- UpdateProductVariantPriceInput: '/reference/graphql-api/admin/input-types#updateproductvariantpriceinput',
4363
- Int: '/reference/graphql-api/admin/object-types#int',
4364
- StockLevelInput: '/reference/graphql-api/admin/input-types#stocklevelinput',
4365
- GlobalFlag: '/reference/graphql-api/admin/enums#globalflag',
4366
- JSON: '/reference/graphql-api/admin/object-types#json',
4367
- }}
4368
- >
4369
- {`input UpdateProductVariantInput {
4370
- id: ID!
4371
- enabled: Boolean
4372
- translations: [ProductVariantTranslationInput!]
4373
- facetValueIds: [ID!]
4374
- optionIds: [ID!]
4375
- sku: String
4376
- taxCategoryId: ID
4377
- """Sets the price for the ProductVariant in the Channel's default currency"""
4378
- price: Money
4379
- """Allows multiple prices to be set for the ProductVariant in different currencies."""
4380
- prices: [UpdateProductVariantPriceInput!]
4381
- featuredAssetId: ID
4382
- assetIds: [ID!]
4383
- stockOnHand: Int
4384
- stockLevels: [StockLevelInput!]
4385
- outOfStockThreshold: Int
4386
- useGlobalOutOfStockThreshold: Boolean
4387
- trackInventory: GlobalFlag
4388
- customFields: JSON
4389
- }`}
4390
- </GraphQLDoc>
4391
-
4392
- ## UpdateProductVariantPriceInput {#updateproductvariantpriceinput}
4393
-
4394
- <GraphQLDoc
4395
- type="input"
4396
- typeName="UpdateProductVariantPriceInput"
4397
- typeLinks={{
4398
- CurrencyCode: '/reference/graphql-api/admin/enums#currencycode',
4399
- Money: '/reference/graphql-api/admin/object-types#money',
4400
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4401
- JSON: '/reference/graphql-api/admin/object-types#json',
4402
- }}
4403
- >
4404
- {`"""
4405
- Used to set up update the price of a ProductVariant in a particular Channel.
4406
- If the \`delete\` flag is \`true\`, the price will be deleted for the given Channel.
4407
- """
4408
- input UpdateProductVariantPriceInput {
4409
- currencyCode: CurrencyCode!
4410
- price: Money!
4411
- delete: Boolean
4412
- customFields: JSON
4413
- }`}
4414
- </GraphQLDoc>
4415
-
4416
- ## UpdatePromotionInput {#updatepromotioninput}
4417
-
4418
- <GraphQLDoc
4419
- type="input"
4420
- typeName="UpdatePromotionInput"
4421
- typeLinks={{
4422
- ID: '/reference/graphql-api/admin/object-types#id',
4423
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4424
- DateTime: '/reference/graphql-api/admin/object-types#datetime',
4425
- String: '/reference/graphql-api/admin/object-types#string',
4426
- Int: '/reference/graphql-api/admin/object-types#int',
4427
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
4428
- PromotionTranslationInput: '/reference/graphql-api/admin/input-types#promotiontranslationinput',
4429
- JSON: '/reference/graphql-api/admin/object-types#json',
4430
- }}
4431
- >
4432
- {`input UpdatePromotionInput {
4433
- id: ID!
4434
- enabled: Boolean
4435
- startsAt: DateTime
4436
- endsAt: DateTime
4437
- couponCode: String
4438
- perCustomerUsageLimit: Int
4439
- usageLimit: Int
4440
- conditions: [ConfigurableOperationInput!]
4441
- actions: [ConfigurableOperationInput!]
4442
- translations: [PromotionTranslationInput!]
4443
- customFields: JSON
4444
- }`}
4445
- </GraphQLDoc>
4446
-
4447
- ## UpdateProvinceInput {#updateprovinceinput}
4448
-
4449
- <GraphQLDoc
4450
- type="input"
4451
- typeName="UpdateProvinceInput"
4452
- typeLinks={{
4453
- ID: '/reference/graphql-api/admin/object-types#id',
4454
- String: '/reference/graphql-api/admin/object-types#string',
4455
- ProvinceTranslationInput: '/reference/graphql-api/admin/input-types#provincetranslationinput',
4456
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4457
- JSON: '/reference/graphql-api/admin/object-types#json',
4458
- }}
4459
- >
4460
- {`input UpdateProvinceInput {
4461
- id: ID!
4462
- code: String
4463
- translations: [ProvinceTranslationInput!]
4464
- enabled: Boolean
4465
- customFields: JSON
4466
- }`}
4467
- </GraphQLDoc>
4468
-
4469
- ## UpdateRoleInput {#updateroleinput}
4470
-
4471
- <GraphQLDoc
4472
- type="input"
4473
- typeName="UpdateRoleInput"
4474
- typeLinks={{
4475
- ID: '/reference/graphql-api/admin/object-types#id',
4476
- String: '/reference/graphql-api/admin/object-types#string',
4477
- Permission: '/reference/graphql-api/admin/enums#permission',
4478
- }}
4479
- >
4480
- {`input UpdateRoleInput {
4481
- id: ID!
4482
- code: String
4483
- description: String
4484
- permissions: [Permission!]
4485
- channelIds: [ID!]
4486
- }`}
4487
- </GraphQLDoc>
4488
-
4489
- ## UpdateScheduledTaskInput {#updatescheduledtaskinput}
4490
-
4491
- <GraphQLDoc
4492
- type="input"
4493
- typeName="UpdateScheduledTaskInput"
4494
- typeLinks={{
4495
- String: '/reference/graphql-api/admin/object-types#string',
4496
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4497
- }}
4498
- >
4499
- {`input UpdateScheduledTaskInput {
4500
- id: String!
4501
- enabled: Boolean
4502
- }`}
4503
- </GraphQLDoc>
4504
-
4505
- ## UpdateSellerInput {#updatesellerinput}
4506
-
4507
- <GraphQLDoc
4508
- type="input"
4509
- typeName="UpdateSellerInput"
4510
- typeLinks={{
4511
- ID: '/reference/graphql-api/admin/object-types#id',
4512
- String: '/reference/graphql-api/admin/object-types#string',
4513
- JSON: '/reference/graphql-api/admin/object-types#json',
4514
- }}
4515
- >
4516
- {`input UpdateSellerInput {
4517
- id: ID!
4518
- name: String
4519
- customFields: JSON
4520
- }`}
4521
- </GraphQLDoc>
4522
-
4523
- ## UpdateShippingMethodInput {#updateshippingmethodinput}
4524
-
4525
- <GraphQLDoc
4526
- type="input"
4527
- typeName="UpdateShippingMethodInput"
4528
- typeLinks={{
4529
- ID: '/reference/graphql-api/admin/object-types#id',
4530
- String: '/reference/graphql-api/admin/object-types#string',
4531
- ConfigurableOperationInput: '/reference/graphql-api/admin/input-types#configurableoperationinput',
4532
- ShippingMethodTranslationInput: '/reference/graphql-api/admin/input-types#shippingmethodtranslationinput',
4533
- JSON: '/reference/graphql-api/admin/object-types#json',
4534
- }}
4535
- >
4536
- {`input UpdateShippingMethodInput {
4537
- id: ID!
4538
- code: String
4539
- fulfillmentHandler: String
4540
- checker: ConfigurableOperationInput
4541
- calculator: ConfigurableOperationInput
4542
- translations: [ShippingMethodTranslationInput!]!
4543
- customFields: JSON
4544
- }`}
4545
- </GraphQLDoc>
4546
-
4547
- ## UpdateStockLocationInput {#updatestocklocationinput}
4548
-
4549
- <GraphQLDoc
4550
- type="input"
4551
- typeName="UpdateStockLocationInput"
4552
- typeLinks={{
4553
- ID: '/reference/graphql-api/admin/object-types#id',
4554
- String: '/reference/graphql-api/admin/object-types#string',
4555
- JSON: '/reference/graphql-api/admin/object-types#json',
4556
- }}
4557
- >
4558
- {`input UpdateStockLocationInput {
4559
- id: ID!
4560
- name: String
4561
- description: String
4562
- customFields: JSON
4563
- }`}
4564
- </GraphQLDoc>
4565
-
4566
- ## UpdateTagInput {#updatetaginput}
4567
-
4568
- <GraphQLDoc
4569
- type="input"
4570
- typeName="UpdateTagInput"
4571
- typeLinks={{
4572
- ID: '/reference/graphql-api/admin/object-types#id',
4573
- String: '/reference/graphql-api/admin/object-types#string',
4574
- }}
4575
- >
4576
- {`input UpdateTagInput {
4577
- id: ID!
4578
- value: String
4579
- }`}
4580
- </GraphQLDoc>
4581
-
4582
- ## UpdateTaxCategoryInput {#updatetaxcategoryinput}
4583
-
4584
- <GraphQLDoc
4585
- type="input"
4586
- typeName="UpdateTaxCategoryInput"
4587
- typeLinks={{
4588
- ID: '/reference/graphql-api/admin/object-types#id',
4589
- String: '/reference/graphql-api/admin/object-types#string',
4590
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4591
- JSON: '/reference/graphql-api/admin/object-types#json',
4592
- }}
4593
- >
4594
- {`input UpdateTaxCategoryInput {
4595
- id: ID!
4596
- name: String
4597
- isDefault: Boolean
4598
- customFields: JSON
4599
- }`}
4600
- </GraphQLDoc>
4601
-
4602
- ## UpdateTaxRateInput {#updatetaxrateinput}
4603
-
4604
- <GraphQLDoc
4605
- type="input"
4606
- typeName="UpdateTaxRateInput"
4607
- typeLinks={{
4608
- ID: '/reference/graphql-api/admin/object-types#id',
4609
- String: '/reference/graphql-api/admin/object-types#string',
4610
- Float: '/reference/graphql-api/admin/object-types#float',
4611
- Boolean: '/reference/graphql-api/admin/object-types#boolean',
4612
- JSON: '/reference/graphql-api/admin/object-types#json',
4613
- }}
4614
- >
4615
- {`input UpdateTaxRateInput {
4616
- id: ID!
4617
- name: String
4618
- value: Float
4619
- enabled: Boolean
4620
- categoryId: ID
4621
- zoneId: ID
4622
- customerGroupId: ID
4623
- customFields: JSON
4624
- }`}
4625
- </GraphQLDoc>
4626
-
4627
- ## UpdateZoneInput {#updatezoneinput}
4628
-
4629
- <GraphQLDoc
4630
- type="input"
4631
- typeName="UpdateZoneInput"
4632
- typeLinks={{
4633
- ID: '/reference/graphql-api/admin/object-types#id',
4634
- String: '/reference/graphql-api/admin/object-types#string',
4635
- JSON: '/reference/graphql-api/admin/object-types#json',
4636
- }}
4637
- >
4638
- {`input UpdateZoneInput {
4639
- id: ID!
4640
- name: String
4641
- customFields: JSON
4642
- }`}
4643
- </GraphQLDoc>
4644
-
4645
- ## ZoneFilterParameter {#zonefilterparameter}
4646
-
4647
- <GraphQLDoc
4648
- type="input"
4649
- typeName="ZoneFilterParameter"
4650
- typeLinks={{
4651
- IDOperators: '/reference/graphql-api/admin/input-types#idoperators',
4652
- DateOperators: '/reference/graphql-api/admin/input-types#dateoperators',
4653
- StringOperators: '/reference/graphql-api/admin/input-types#stringoperators',
4654
- ZoneFilterParameter: '/reference/graphql-api/admin/input-types#zonefilterparameter',
4655
- }}
4656
- >
4657
- {`input ZoneFilterParameter {
4658
- id: IDOperators
4659
- createdAt: DateOperators
4660
- updatedAt: DateOperators
4661
- name: StringOperators
4662
- _and: [ZoneFilterParameter!]
4663
- _or: [ZoneFilterParameter!]
4664
- }`}
4665
- </GraphQLDoc>
4666
-
4667
- ## ZoneListOptions {#zonelistoptions}
4668
-
4669
- <GraphQLDoc
4670
- type="input"
4671
- typeName="ZoneListOptions"
4672
- typeLinks={{
4673
- Int: '/reference/graphql-api/admin/object-types#int',
4674
- ZoneSortParameter: '/reference/graphql-api/admin/input-types#zonesortparameter',
4675
- ZoneFilterParameter: '/reference/graphql-api/admin/input-types#zonefilterparameter',
4676
- LogicalOperator: '/reference/graphql-api/admin/enums#logicaloperator',
4677
- }}
4678
- >
4679
- {`input ZoneListOptions {
4680
- """Skips the first n results, for use in pagination"""
4681
- skip: Int
4682
- """Takes n results, for use in pagination"""
4683
- take: Int
4684
- """Specifies which properties to sort the results by"""
4685
- sort: ZoneSortParameter
4686
- """Allows the results to be filtered"""
4687
- filter: ZoneFilterParameter
4688
- """Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND."""
4689
- filterOperator: LogicalOperator
4690
- }`}
4691
- </GraphQLDoc>
4692
-
4693
- ## ZoneSortParameter {#zonesortparameter}
4694
-
4695
- <GraphQLDoc
4696
- type="input"
4697
- typeName="ZoneSortParameter"
4698
- typeLinks={{
4699
- SortOrder: '/reference/graphql-api/admin/enums#sortorder',
4700
- }}
4701
- >
4702
- {`input ZoneSortParameter {
4703
- id: SortOrder
4704
- createdAt: SortOrder
4705
- updatedAt: SortOrder
4706
- name: SortOrder
4707
- }`}
4708
- </GraphQLDoc>