@vendure/docs 0.0.0-202601161707 → 0.0.0-20260116211406

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 (663) hide show
  1. package/dist/manifest.js +3 -3
  2. package/dist/manifest.js.map +1 -1
  3. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +0 -1
  4. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +0 -1
  5. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +0 -1
  6. package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +0 -1
  7. package/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.mdx +0 -1
  8. package/docs/reference/admin-ui-api/action-bar/add-action-bar-item.mdx +0 -1
  9. package/docs/reference/admin-ui-api/action-bar/index.mdx +0 -1
  10. package/docs/reference/admin-ui-api/action-bar/page-location-id.mdx +0 -1
  11. package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +0 -1
  12. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +0 -1
  13. package/docs/reference/admin-ui-api/alerts/alert-context.mdx +0 -1
  14. package/docs/reference/admin-ui-api/alerts/index.mdx +0 -1
  15. package/docs/reference/admin-ui-api/alerts/register-alert.mdx +0 -1
  16. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +0 -1
  17. package/docs/reference/admin-ui-api/bulk-actions/index.mdx +0 -1
  18. package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +0 -1
  19. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +0 -1
  20. package/docs/reference/admin-ui-api/components/chip-component.mdx +1 -2
  21. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +1 -2
  22. package/docs/reference/admin-ui-api/components/data-table-component.mdx +1 -2
  23. package/docs/reference/admin-ui-api/components/data-table2component.mdx +0 -1
  24. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +1 -2
  25. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -2
  26. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +1 -2
  27. package/docs/reference/admin-ui-api/components/index.mdx +0 -1
  28. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -2
  29. package/docs/reference/admin-ui-api/components/order-state-label-component.mdx +1 -2
  30. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -2
  31. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +1 -2
  32. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +0 -1
  33. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +0 -1
  34. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +0 -1
  35. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +0 -1
  36. package/docs/reference/admin-ui-api/custom-detail-components/index.mdx +0 -1
  37. package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +0 -1
  38. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +0 -1
  39. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +0 -1
  40. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +0 -1
  41. package/docs/reference/admin-ui-api/custom-history-entry-components/index.mdx +0 -1
  42. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +0 -1
  43. package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +0 -1
  44. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +0 -1
  45. package/docs/reference/admin-ui-api/custom-input-components/form-input-component.mdx +0 -1
  46. package/docs/reference/admin-ui-api/custom-input-components/index.mdx +0 -1
  47. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +0 -1
  48. package/docs/reference/admin-ui-api/custom-table-components/custom-column-component.mdx +0 -1
  49. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +0 -1
  50. package/docs/reference/admin-ui-api/custom-table-components/index.mdx +0 -1
  51. package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +0 -1
  52. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +0 -1
  53. package/docs/reference/admin-ui-api/dashboard-widgets/index.mdx +0 -1
  54. package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +0 -1
  55. package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.mdx +0 -1
  56. package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.mdx +0 -1
  57. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +0 -1
  58. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +0 -1
  59. package/docs/reference/admin-ui-api/directives/index.mdx +0 -1
  60. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +0 -1
  61. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +0 -1
  62. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +0 -1
  63. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +0 -1
  64. package/docs/reference/admin-ui-api/list-detail-views/index.mdx +0 -1
  65. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +0 -1
  66. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +0 -1
  67. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.mdx +0 -1
  68. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.mdx +0 -1
  69. package/docs/reference/admin-ui-api/nav-menu/index.mdx +0 -1
  70. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +0 -1
  71. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +0 -1
  72. package/docs/reference/admin-ui-api/nav-menu/navigation-types.mdx +0 -1
  73. package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx +1 -2
  74. package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx +0 -1
  75. package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx +0 -1
  76. package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx +1 -2
  77. package/docs/reference/admin-ui-api/pipes/index.mdx +0 -1
  78. package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx +1 -2
  79. package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx +1 -2
  80. package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx +1 -2
  81. package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx +1 -2
  82. package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx +1 -2
  83. package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx +1 -2
  84. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +0 -1
  85. package/docs/reference/admin-ui-api/react-components/card.mdx +0 -1
  86. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +0 -1
  87. package/docs/reference/admin-ui-api/react-components/form-field.mdx +0 -1
  88. package/docs/reference/admin-ui-api/react-components/index.mdx +0 -1
  89. package/docs/reference/admin-ui-api/react-components/link.mdx +0 -1
  90. package/docs/reference/admin-ui-api/react-components/page-block.mdx +0 -1
  91. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +0 -1
  92. package/docs/reference/admin-ui-api/react-components/rich-text-editor.mdx +0 -1
  93. package/docs/reference/admin-ui-api/react-extensions/index.mdx +0 -1
  94. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +0 -1
  95. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +0 -1
  96. package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +0 -1
  97. package/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.mdx +0 -1
  98. package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +0 -1
  99. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.mdx +0 -1
  100. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +0 -1
  101. package/docs/reference/admin-ui-api/react-hooks/index.mdx +0 -1
  102. package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.mdx +0 -1
  103. package/docs/reference/admin-ui-api/react-hooks/use-form-control.mdx +0 -1
  104. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +0 -1
  105. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +0 -1
  106. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +0 -1
  107. package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.mdx +0 -1
  108. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +0 -1
  109. package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.mdx +0 -1
  110. package/docs/reference/admin-ui-api/react-hooks/use-route-params.mdx +0 -1
  111. package/docs/reference/admin-ui-api/routes/index.mdx +0 -1
  112. package/docs/reference/admin-ui-api/routes/register-route-component-options.mdx +0 -1
  113. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +0 -1
  114. package/docs/reference/admin-ui-api/services/data-service.mdx +0 -1
  115. package/docs/reference/admin-ui-api/services/index.mdx +0 -1
  116. package/docs/reference/admin-ui-api/services/modal-service.mdx +0 -1
  117. package/docs/reference/admin-ui-api/services/notification-service.mdx +0 -1
  118. package/docs/reference/admin-ui-api/tabs/index.mdx +0 -1
  119. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +0 -1
  120. package/docs/reference/admin-ui-api/tabs/register-page-tab.mdx +0 -1
  121. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +0 -1
  122. package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.mdx +0 -1
  123. package/docs/reference/admin-ui-api/ui-devkit/helpers.mdx +0 -1
  124. package/docs/reference/admin-ui-api/ui-devkit/index.mdx +0 -1
  125. package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.mdx +0 -1
  126. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +0 -1
  127. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +0 -1
  128. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +0 -1
  129. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +0 -1
  130. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +0 -1
  131. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +0 -1
  132. package/docs/reference/core-plugins/asset-server-plugin/cache-config.mdx +0 -1
  133. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +0 -1
  134. package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.mdx +0 -1
  135. package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.mdx +0 -1
  136. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +0 -1
  137. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +0 -1
  138. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +0 -1
  139. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +0 -1
  140. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -3
  141. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +0 -1
  142. package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +0 -1
  143. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +0 -1
  144. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -2
  145. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +0 -1
  146. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +0 -1
  147. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +0 -1
  148. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +0 -1
  149. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +0 -1
  150. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +0 -1
  151. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +0 -1
  152. package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +0 -1
  153. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +0 -1
  154. package/docs/reference/core-plugins/email-plugin/email-utils.mdx +0 -1
  155. package/docs/reference/core-plugins/email-plugin/index.mdx +0 -1
  156. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +0 -1
  157. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +0 -1
  158. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +0 -1
  159. package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.mdx +0 -1
  160. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +0 -1
  161. package/docs/reference/core-plugins/harden-plugin/index.mdx +3 -4
  162. package/docs/reference/core-plugins/index.mdx +0 -1
  163. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.mdx +2 -3
  164. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -2
  165. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +0 -1
  166. package/docs/reference/core-plugins/job-queue-plugin/index.mdx +0 -1
  167. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -2
  168. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -2
  169. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +4 -5
  170. package/docs/reference/core-plugins/payments-plugin/index.mdx +0 -1
  171. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +2 -3
  172. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +2 -3
  173. package/docs/reference/core-plugins/sentry-plugin/index.mdx +3 -4
  174. package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +0 -1
  175. package/docs/reference/core-plugins/sentry-plugin/sentry-service.mdx +0 -1
  176. package/docs/reference/core-plugins/stellate-plugin/index.mdx +0 -1
  177. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +0 -1
  178. package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +0 -1
  179. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +0 -1
  180. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +0 -1
  181. package/docs/reference/core-plugins/telemetry-plugin/index.mdx +0 -1
  182. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +0 -1
  183. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +0 -1
  184. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +0 -1
  185. package/docs/reference/dashboard/components/asset-gallery.mdx +0 -1
  186. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +0 -1
  187. package/docs/reference/dashboard/components/channel-chip.mdx +0 -1
  188. package/docs/reference/dashboard/components/detail-page-button.mdx +0 -1
  189. package/docs/reference/dashboard/components/facet-value-chip.mdx +0 -1
  190. package/docs/reference/dashboard/components/facet-value-selector.mdx +0 -1
  191. package/docs/reference/dashboard/components/index.mdx +0 -1
  192. package/docs/reference/dashboard/components/permission-guard.mdx +0 -1
  193. package/docs/reference/dashboard/components/vendure-image.mdx +0 -1
  194. package/docs/reference/dashboard/detail-views/detail-page.mdx +0 -1
  195. package/docs/reference/dashboard/detail-views/index.mdx +0 -1
  196. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +0 -1
  197. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +0 -1
  198. package/docs/reference/dashboard/extensions-api/action-bar.mdx +0 -1
  199. package/docs/reference/dashboard/extensions-api/alerts.mdx +0 -1
  200. package/docs/reference/dashboard/extensions-api/data-tables.mdx +0 -1
  201. package/docs/reference/dashboard/extensions-api/define-dashboard-extension.mdx +0 -1
  202. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +0 -1
  203. package/docs/reference/dashboard/extensions-api/form-components.mdx +0 -1
  204. package/docs/reference/dashboard/extensions-api/history-entries.mdx +0 -1
  205. package/docs/reference/dashboard/extensions-api/index.mdx +0 -1
  206. package/docs/reference/dashboard/extensions-api/login.mdx +0 -1
  207. package/docs/reference/dashboard/extensions-api/navigation.mdx +0 -1
  208. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +0 -1
  209. package/docs/reference/dashboard/extensions-api/routes.mdx +0 -1
  210. package/docs/reference/dashboard/extensions-api/widgets.mdx +0 -1
  211. package/docs/reference/dashboard/form-components/affixed-input.mdx +0 -1
  212. package/docs/reference/dashboard/form-components/boolean-input.mdx +0 -1
  213. package/docs/reference/dashboard/form-components/checkbox-input.mdx +0 -1
  214. package/docs/reference/dashboard/form-components/date-time-input.mdx +0 -1
  215. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +0 -1
  216. package/docs/reference/dashboard/form-components/index.mdx +0 -1
  217. package/docs/reference/dashboard/form-components/money-input.mdx +0 -1
  218. package/docs/reference/dashboard/form-components/number-input.mdx +0 -1
  219. package/docs/reference/dashboard/form-components/password-input.mdx +0 -1
  220. package/docs/reference/dashboard/form-components/rich-text-input.mdx +0 -1
  221. package/docs/reference/dashboard/form-components/slug-input.mdx +0 -1
  222. package/docs/reference/dashboard/form-components/text-input.mdx +0 -1
  223. package/docs/reference/dashboard/form-components/textarea-input.mdx +0 -1
  224. package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +0 -1
  225. package/docs/reference/dashboard/hooks/index.mdx +0 -1
  226. package/docs/reference/dashboard/hooks/use-alerts.mdx +0 -1
  227. package/docs/reference/dashboard/hooks/use-auth.mdx +0 -1
  228. package/docs/reference/dashboard/hooks/use-channel.mdx +0 -1
  229. package/docs/reference/dashboard/hooks/use-custom-field-config.mdx +0 -1
  230. package/docs/reference/dashboard/hooks/use-display-locale.mdx +0 -1
  231. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +0 -1
  232. package/docs/reference/dashboard/hooks/use-local-format.mdx +0 -1
  233. package/docs/reference/dashboard/hooks/use-paginated-list.mdx +0 -1
  234. package/docs/reference/dashboard/hooks/use-permissions.mdx +0 -1
  235. package/docs/reference/dashboard/hooks/use-sorted-languages.mdx +0 -1
  236. package/docs/reference/dashboard/hooks/use-ui-language-loader.mdx +0 -1
  237. package/docs/reference/dashboard/hooks/use-widget-filters.mdx +0 -1
  238. package/docs/reference/dashboard/list-views/bulk-actions.mdx +0 -1
  239. package/docs/reference/dashboard/list-views/data-table-cell-component.mdx +0 -1
  240. package/docs/reference/dashboard/list-views/data-table.mdx +0 -1
  241. package/docs/reference/dashboard/list-views/index.mdx +0 -1
  242. package/docs/reference/dashboard/list-views/list-page.mdx +0 -1
  243. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +0 -1
  244. package/docs/reference/dashboard/page-layout/index.mdx +0 -1
  245. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +0 -1
  246. package/docs/reference/dashboard/page-layout/page-block.mdx +0 -1
  247. package/docs/reference/dashboard/page-layout/page-title.mdx +0 -1
  248. package/docs/reference/dashboard/page-layout/page.mdx +0 -1
  249. package/docs/reference/dashboard/page-layout/use-page-block.mdx +0 -1
  250. package/docs/reference/dashboard/vite-plugin/index.mdx +0 -1
  251. package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +0 -1
  252. package/docs/reference/graphql-api/admin/enums.mdx +1132 -1135
  253. package/docs/reference/graphql-api/admin/input-types.mdx +4701 -4624
  254. package/docs/reference/graphql-api/admin/mutations.mdx +2743 -1978
  255. package/docs/reference/graphql-api/admin/object-types.mdx +4966 -4508
  256. package/docs/reference/graphql-api/admin/queries.mdx +1187 -753
  257. package/docs/reference/graphql-api/shop/enums.mdx +1056 -1065
  258. package/docs/reference/graphql-api/shop/input-types.mdx +1106 -1185
  259. package/docs/reference/graphql-api/shop/mutations.mdx +533 -424
  260. package/docs/reference/graphql-api/shop/object-types.mdx +3686 -3399
  261. package/docs/reference/graphql-api/shop/queries.mdx +307 -240
  262. package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +0 -1
  263. package/docs/reference/typescript-api/assets/asset-options.mdx +0 -1
  264. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +0 -1
  265. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +0 -1
  266. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +0 -1
  267. package/docs/reference/typescript-api/assets/index.mdx +0 -1
  268. package/docs/reference/typescript-api/auth/auth-options.mdx +0 -1
  269. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +1 -2
  270. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +0 -1
  271. package/docs/reference/typescript-api/auth/cookie-options.mdx +0 -1
  272. package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +0 -1
  273. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +0 -1
  274. package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +0 -1
  275. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +0 -1
  276. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +0 -1
  277. package/docs/reference/typescript-api/auth/index.mdx +0 -1
  278. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +0 -1
  279. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +0 -1
  280. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +0 -1
  281. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +0 -1
  282. package/docs/reference/typescript-api/auth/permission-definition.mdx +0 -1
  283. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +0 -1
  284. package/docs/reference/typescript-api/auth/superadmin-credentials.mdx +0 -1
  285. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +0 -1
  286. package/docs/reference/typescript-api/cache/cache-config.mdx +0 -1
  287. package/docs/reference/typescript-api/cache/cache-service.mdx +0 -1
  288. package/docs/reference/typescript-api/cache/cache-strategy.mdx +0 -1
  289. package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +0 -1
  290. package/docs/reference/typescript-api/cache/index.mdx +0 -1
  291. package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +1 -2
  292. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +1 -2
  293. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +0 -1
  294. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +0 -1
  295. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +0 -1
  296. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +0 -1
  297. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +0 -1
  298. package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +0 -1
  299. package/docs/reference/typescript-api/common/admin-ui/index.mdx +0 -1
  300. package/docs/reference/typescript-api/common/async-queue.mdx +0 -1
  301. package/docs/reference/typescript-api/common/bootstrap.mdx +0 -1
  302. package/docs/reference/typescript-api/common/currency-code.mdx +0 -1
  303. package/docs/reference/typescript-api/common/entity-relation-paths.mdx +0 -1
  304. package/docs/reference/typescript-api/common/i18n-service.mdx +0 -1
  305. package/docs/reference/typescript-api/common/id.mdx +0 -1
  306. package/docs/reference/typescript-api/common/index.mdx +0 -1
  307. package/docs/reference/typescript-api/common/injectable-strategy.mdx +0 -1
  308. package/docs/reference/typescript-api/common/injector.mdx +0 -1
  309. package/docs/reference/typescript-api/common/job-state.mdx +0 -1
  310. package/docs/reference/typescript-api/common/json-compatible.mdx +0 -1
  311. package/docs/reference/typescript-api/common/language-code.mdx +0 -1
  312. package/docs/reference/typescript-api/common/middleware.mdx +0 -1
  313. package/docs/reference/typescript-api/common/paginated-list.mdx +0 -1
  314. package/docs/reference/typescript-api/common/permission.mdx +0 -1
  315. package/docs/reference/typescript-api/common/price-calculation-result.mdx +0 -1
  316. package/docs/reference/typescript-api/common/process-context.mdx +0 -1
  317. package/docs/reference/typescript-api/common/vendure_version.mdx +0 -1
  318. package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +0 -1
  319. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +0 -1
  320. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +0 -1
  321. package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.mdx +0 -1
  322. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +0 -1
  323. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +0 -1
  324. package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +0 -1
  325. package/docs/reference/typescript-api/configuration/api-options.mdx +0 -1
  326. package/docs/reference/typescript-api/configuration/collection-filter.mdx +0 -1
  327. package/docs/reference/typescript-api/configuration/default-config.mdx +0 -1
  328. package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +0 -1
  329. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +0 -1
  330. package/docs/reference/typescript-api/configuration/entity-id-decorator.mdx +0 -1
  331. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +0 -1
  332. package/docs/reference/typescript-api/configuration/entity-options.mdx +0 -1
  333. package/docs/reference/typescript-api/configuration/index.mdx +0 -1
  334. package/docs/reference/typescript-api/configuration/merge-config.mdx +0 -1
  335. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +0 -1
  336. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +0 -1
  337. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +0 -1
  338. package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +0 -1
  339. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +0 -1
  340. package/docs/reference/typescript-api/configuration/system-options.mdx +0 -1
  341. package/docs/reference/typescript-api/configuration/trust-proxy-options.mdx +0 -1
  342. package/docs/reference/typescript-api/configuration/vendure-config.mdx +0 -1
  343. package/docs/reference/typescript-api/custom-fields/custom-field-config.mdx +0 -1
  344. package/docs/reference/typescript-api/custom-fields/custom-field-type.mdx +0 -1
  345. package/docs/reference/typescript-api/custom-fields/index.mdx +0 -1
  346. package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.mdx +0 -1
  347. package/docs/reference/typescript-api/custom-fields/struct-field-config.mdx +0 -1
  348. package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +0 -1
  349. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +0 -1
  350. package/docs/reference/typescript-api/data-access/calculated.mdx +0 -1
  351. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +0 -1
  352. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +0 -1
  353. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +0 -1
  354. package/docs/reference/typescript-api/data-access/index.mdx +0 -1
  355. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +3 -4
  356. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +0 -1
  357. package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +0 -1
  358. package/docs/reference/typescript-api/default-search-plugin/index.mdx +0 -1
  359. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +0 -1
  360. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +0 -1
  361. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +0 -1
  362. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +0 -1
  363. package/docs/reference/typescript-api/entities/address.mdx +0 -1
  364. package/docs/reference/typescript-api/entities/administrator.mdx +0 -1
  365. package/docs/reference/typescript-api/entities/anonymous-session.mdx +0 -1
  366. package/docs/reference/typescript-api/entities/asset.mdx +0 -1
  367. package/docs/reference/typescript-api/entities/authenticated-session.mdx +0 -1
  368. package/docs/reference/typescript-api/entities/authentication-method.mdx +0 -1
  369. package/docs/reference/typescript-api/entities/channel.mdx +0 -1
  370. package/docs/reference/typescript-api/entities/collection.mdx +0 -1
  371. package/docs/reference/typescript-api/entities/country.mdx +0 -1
  372. package/docs/reference/typescript-api/entities/customer-group.mdx +0 -1
  373. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +0 -1
  374. package/docs/reference/typescript-api/entities/customer.mdx +0 -1
  375. package/docs/reference/typescript-api/entities/facet-value.mdx +0 -1
  376. package/docs/reference/typescript-api/entities/facet.mdx +0 -1
  377. package/docs/reference/typescript-api/entities/fulfillment.mdx +0 -1
  378. package/docs/reference/typescript-api/entities/global-settings.mdx +0 -1
  379. package/docs/reference/typescript-api/entities/history-entry.mdx +0 -1
  380. package/docs/reference/typescript-api/entities/index.mdx +0 -1
  381. package/docs/reference/typescript-api/entities/interfaces.mdx +0 -1
  382. package/docs/reference/typescript-api/entities/order-history-entry.mdx +0 -1
  383. package/docs/reference/typescript-api/entities/order-line-reference.mdx +0 -1
  384. package/docs/reference/typescript-api/entities/order-line.mdx +0 -1
  385. package/docs/reference/typescript-api/entities/order-modification.mdx +0 -1
  386. package/docs/reference/typescript-api/entities/order.mdx +0 -1
  387. package/docs/reference/typescript-api/entities/orderable-asset.mdx +0 -1
  388. package/docs/reference/typescript-api/entities/payment-method.mdx +0 -1
  389. package/docs/reference/typescript-api/entities/payment.mdx +0 -1
  390. package/docs/reference/typescript-api/entities/product-option-group.mdx +0 -1
  391. package/docs/reference/typescript-api/entities/product-option.mdx +0 -1
  392. package/docs/reference/typescript-api/entities/product-variant-price.mdx +0 -1
  393. package/docs/reference/typescript-api/entities/product-variant.mdx +0 -1
  394. package/docs/reference/typescript-api/entities/product.mdx +0 -1
  395. package/docs/reference/typescript-api/entities/promotion.mdx +0 -1
  396. package/docs/reference/typescript-api/entities/province.mdx +0 -1
  397. package/docs/reference/typescript-api/entities/refund.mdx +0 -1
  398. package/docs/reference/typescript-api/entities/region.mdx +0 -1
  399. package/docs/reference/typescript-api/entities/role.mdx +0 -1
  400. package/docs/reference/typescript-api/entities/seller.mdx +0 -1
  401. package/docs/reference/typescript-api/entities/session.mdx +0 -1
  402. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +0 -1
  403. package/docs/reference/typescript-api/entities/shipping-line.mdx +0 -1
  404. package/docs/reference/typescript-api/entities/shipping-method.mdx +0 -1
  405. package/docs/reference/typescript-api/entities/stock-level.mdx +0 -1
  406. package/docs/reference/typescript-api/entities/stock-location.mdx +0 -1
  407. package/docs/reference/typescript-api/entities/stock-movement.mdx +0 -1
  408. package/docs/reference/typescript-api/entities/surcharge.mdx +0 -1
  409. package/docs/reference/typescript-api/entities/tag.mdx +0 -1
  410. package/docs/reference/typescript-api/entities/tax-category.mdx +0 -1
  411. package/docs/reference/typescript-api/entities/tax-rate.mdx +0 -1
  412. package/docs/reference/typescript-api/entities/user.mdx +0 -1
  413. package/docs/reference/typescript-api/entities/vendure-entity.mdx +0 -1
  414. package/docs/reference/typescript-api/entities/zone.mdx +0 -1
  415. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +0 -1
  416. package/docs/reference/typescript-api/errors/error-result-union.mdx +0 -1
  417. package/docs/reference/typescript-api/errors/error-types.mdx +0 -1
  418. package/docs/reference/typescript-api/errors/i18n-error.mdx +0 -1
  419. package/docs/reference/typescript-api/errors/index.mdx +0 -1
  420. package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +0 -1
  421. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +0 -1
  422. package/docs/reference/typescript-api/events/event-bus.mdx +0 -1
  423. package/docs/reference/typescript-api/events/event-types.mdx +0 -1
  424. package/docs/reference/typescript-api/events/index.mdx +0 -1
  425. package/docs/reference/typescript-api/events/vendure-entity-event.mdx +0 -1
  426. package/docs/reference/typescript-api/events/vendure-event.mdx +0 -1
  427. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +0 -1
  428. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +0 -1
  429. package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +0 -1
  430. package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +0 -1
  431. package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.mdx +0 -1
  432. package/docs/reference/typescript-api/fulfillment/index.mdx +0 -1
  433. package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +0 -1
  434. package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +0 -1
  435. package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +0 -1
  436. package/docs/reference/typescript-api/health-check/index.mdx +0 -1
  437. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +0 -1
  438. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +0 -1
  439. package/docs/reference/typescript-api/import-export/asset-importer.mdx +0 -1
  440. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +0 -1
  441. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +0 -1
  442. package/docs/reference/typescript-api/import-export/import-export-options.mdx +0 -1
  443. package/docs/reference/typescript-api/import-export/import-parser.mdx +0 -1
  444. package/docs/reference/typescript-api/import-export/importer.mdx +0 -1
  445. package/docs/reference/typescript-api/import-export/index.mdx +0 -1
  446. package/docs/reference/typescript-api/import-export/initial-data.mdx +0 -1
  447. package/docs/reference/typescript-api/import-export/populate.mdx +0 -1
  448. package/docs/reference/typescript-api/import-export/populator.mdx +0 -1
  449. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +0 -1
  450. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +0 -1
  451. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +0 -1
  452. package/docs/reference/typescript-api/job-queue/index.mdx +0 -1
  453. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +0 -1
  454. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +0 -1
  455. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +0 -1
  456. package/docs/reference/typescript-api/job-queue/job-queue-options.mdx +0 -1
  457. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +0 -1
  458. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +0 -1
  459. package/docs/reference/typescript-api/job-queue/job.mdx +0 -1
  460. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +0 -1
  461. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +0 -1
  462. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +0 -1
  463. package/docs/reference/typescript-api/job-queue/types.mdx +0 -1
  464. package/docs/reference/typescript-api/logger/default-logger.mdx +0 -1
  465. package/docs/reference/typescript-api/logger/index.mdx +0 -1
  466. package/docs/reference/typescript-api/logger/log-level.mdx +0 -1
  467. package/docs/reference/typescript-api/logger/vendure-logger.mdx +0 -1
  468. package/docs/reference/typescript-api/migration/generate-migration.mdx +0 -1
  469. package/docs/reference/typescript-api/migration/index.mdx +0 -1
  470. package/docs/reference/typescript-api/migration/migration-options.mdx +0 -1
  471. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +0 -1
  472. package/docs/reference/typescript-api/migration/run-migrations.mdx +0 -1
  473. package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +0 -1
  474. package/docs/reference/typescript-api/money/default-money-strategy.mdx +0 -1
  475. package/docs/reference/typescript-api/money/index.mdx +0 -1
  476. package/docs/reference/typescript-api/money/money-decorator.mdx +0 -1
  477. package/docs/reference/typescript-api/money/money-strategy.mdx +0 -1
  478. package/docs/reference/typescript-api/money/round-money.mdx +0 -1
  479. package/docs/reference/typescript-api/orders/active-order-service.mdx +0 -1
  480. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +2 -3
  481. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +0 -1
  482. package/docs/reference/typescript-api/orders/custom-order-states.mdx +0 -1
  483. package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +0 -1
  484. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +0 -1
  485. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +0 -1
  486. package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +0 -1
  487. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +0 -1
  488. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +0 -1
  489. package/docs/reference/typescript-api/orders/index.mdx +0 -1
  490. package/docs/reference/typescript-api/orders/merge-strategies.mdx +0 -1
  491. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +0 -1
  492. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +0 -1
  493. package/docs/reference/typescript-api/orders/order-interceptor.mdx +0 -1
  494. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +0 -1
  495. package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +0 -1
  496. package/docs/reference/typescript-api/orders/order-options.mdx +0 -1
  497. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +0 -1
  498. package/docs/reference/typescript-api/orders/order-process.mdx +0 -1
  499. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +0 -1
  500. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +0 -1
  501. package/docs/reference/typescript-api/payment/default-payment-process.mdx +0 -1
  502. package/docs/reference/typescript-api/payment/default-refund-process.mdx +0 -1
  503. package/docs/reference/typescript-api/payment/dummy-payment-handler.mdx +1 -2
  504. package/docs/reference/typescript-api/payment/index.mdx +0 -1
  505. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +0 -1
  506. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +0 -1
  507. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +0 -1
  508. package/docs/reference/typescript-api/payment/payment-method-types.mdx +0 -1
  509. package/docs/reference/typescript-api/payment/payment-options.mdx +0 -1
  510. package/docs/reference/typescript-api/payment/payment-process.mdx +0 -1
  511. package/docs/reference/typescript-api/payment/payment-state.mdx +0 -1
  512. package/docs/reference/typescript-api/payment/payment-states.mdx +0 -1
  513. package/docs/reference/typescript-api/payment/payment-transition-data.mdx +0 -1
  514. package/docs/reference/typescript-api/payment/refund-process.mdx +0 -1
  515. package/docs/reference/typescript-api/payment/refund-state.mdx +0 -1
  516. package/docs/reference/typescript-api/payment/refund-states.mdx +0 -1
  517. package/docs/reference/typescript-api/payment/refund-transition-data.mdx +0 -1
  518. package/docs/reference/typescript-api/plugin/index.mdx +0 -1
  519. package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +0 -1
  520. package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +0 -1
  521. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +0 -1
  522. package/docs/reference/typescript-api/plugin/vendure-plugin.mdx +0 -1
  523. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +0 -1
  524. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +0 -1
  525. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +0 -1
  526. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +0 -1
  527. package/docs/reference/typescript-api/products-stock/index.mdx +0 -1
  528. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +0 -1
  529. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +0 -1
  530. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +0 -1
  531. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +0 -1
  532. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +0 -1
  533. package/docs/reference/typescript-api/promotions/index.mdx +0 -1
  534. package/docs/reference/typescript-api/promotions/promotion-action.mdx +0 -1
  535. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +0 -1
  536. package/docs/reference/typescript-api/promotions/promotion-options.mdx +0 -1
  537. package/docs/reference/typescript-api/request/allow-decorator.mdx +0 -1
  538. package/docs/reference/typescript-api/request/api-decorator.mdx +0 -1
  539. package/docs/reference/typescript-api/request/api-type.mdx +0 -1
  540. package/docs/reference/typescript-api/request/ctx-decorator.mdx +0 -1
  541. package/docs/reference/typescript-api/request/index.mdx +0 -1
  542. package/docs/reference/typescript-api/request/relations-decorator.mdx +2 -3
  543. package/docs/reference/typescript-api/request/request-context-service.mdx +0 -1
  544. package/docs/reference/typescript-api/request/request-context.mdx +0 -1
  545. package/docs/reference/typescript-api/request/transaction-decorator.mdx +0 -1
  546. package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +0 -1
  547. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +0 -1
  548. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +0 -1
  549. package/docs/reference/typescript-api/scheduled-tasks/index.mdx +0 -1
  550. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +0 -1
  551. package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +0 -1
  552. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +0 -1
  553. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +0 -1
  554. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +0 -1
  555. package/docs/reference/typescript-api/service-helpers/index.mdx +0 -1
  556. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +0 -1
  557. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +0 -1
  558. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +0 -1
  559. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +0 -1
  560. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +0 -1
  561. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +0 -1
  562. package/docs/reference/typescript-api/services/administrator-service.mdx +0 -1
  563. package/docs/reference/typescript-api/services/asset-service.mdx +0 -1
  564. package/docs/reference/typescript-api/services/auth-service.mdx +0 -1
  565. package/docs/reference/typescript-api/services/channel-service.mdx +0 -1
  566. package/docs/reference/typescript-api/services/collection-service.mdx +0 -1
  567. package/docs/reference/typescript-api/services/country-service.mdx +0 -1
  568. package/docs/reference/typescript-api/services/customer-group-service.mdx +0 -1
  569. package/docs/reference/typescript-api/services/customer-service.mdx +0 -1
  570. package/docs/reference/typescript-api/services/entity-slug-service.mdx +0 -1
  571. package/docs/reference/typescript-api/services/facet-service.mdx +0 -1
  572. package/docs/reference/typescript-api/services/facet-value-service.mdx +0 -1
  573. package/docs/reference/typescript-api/services/fulfillment-service.mdx +0 -1
  574. package/docs/reference/typescript-api/services/global-settings-service.mdx +0 -1
  575. package/docs/reference/typescript-api/services/history-service.mdx +0 -1
  576. package/docs/reference/typescript-api/services/index.mdx +0 -1
  577. package/docs/reference/typescript-api/services/initializer-service.mdx +0 -1
  578. package/docs/reference/typescript-api/services/order-service.mdx +0 -1
  579. package/docs/reference/typescript-api/services/order-testing-service.mdx +0 -1
  580. package/docs/reference/typescript-api/services/payment-method-service.mdx +0 -1
  581. package/docs/reference/typescript-api/services/payment-service.mdx +0 -1
  582. package/docs/reference/typescript-api/services/product-option-group-service.mdx +0 -1
  583. package/docs/reference/typescript-api/services/product-option-service.mdx +0 -1
  584. package/docs/reference/typescript-api/services/product-service.mdx +0 -1
  585. package/docs/reference/typescript-api/services/product-variant-service.mdx +0 -1
  586. package/docs/reference/typescript-api/services/promotion-service.mdx +0 -1
  587. package/docs/reference/typescript-api/services/province-service.mdx +0 -1
  588. package/docs/reference/typescript-api/services/role-service.mdx +0 -1
  589. package/docs/reference/typescript-api/services/search-service.mdx +0 -1
  590. package/docs/reference/typescript-api/services/seller-service.mdx +0 -1
  591. package/docs/reference/typescript-api/services/session-service.mdx +0 -1
  592. package/docs/reference/typescript-api/services/settings-store-service.mdx +0 -1
  593. package/docs/reference/typescript-api/services/shipping-method-service.mdx +0 -1
  594. package/docs/reference/typescript-api/services/slug-service.mdx +0 -1
  595. package/docs/reference/typescript-api/services/stock-level-service.mdx +0 -1
  596. package/docs/reference/typescript-api/services/stock-location-service.mdx +0 -1
  597. package/docs/reference/typescript-api/services/stock-movement-service.mdx +0 -1
  598. package/docs/reference/typescript-api/services/tag-service.mdx +0 -1
  599. package/docs/reference/typescript-api/services/tax-category-service.mdx +0 -1
  600. package/docs/reference/typescript-api/services/tax-rate-service.mdx +0 -1
  601. package/docs/reference/typescript-api/services/user-service.mdx +0 -1
  602. package/docs/reference/typescript-api/services/zone-service.mdx +0 -1
  603. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options.mdx +0 -1
  604. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result.mdx +0 -1
  605. package/docs/reference/typescript-api/settings-store/index.mdx +0 -1
  606. package/docs/reference/typescript-api/settings-store/orphaned-settings-store-entry.mdx +0 -1
  607. package/docs/reference/typescript-api/settings-store/set-settings-store-value-result.mdx +0 -1
  608. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +0 -1
  609. package/docs/reference/typescript-api/settings-store/settings-store-registration.mdx +0 -1
  610. package/docs/reference/typescript-api/settings-store/settings-store-scope-function.mdx +0 -1
  611. package/docs/reference/typescript-api/settings-store/settings-store-scopes.mdx +0 -1
  612. package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +0 -1
  613. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +0 -1
  614. package/docs/reference/typescript-api/shipping/index.mdx +0 -1
  615. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +0 -1
  616. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +0 -1
  617. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +0 -1
  618. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +0 -1
  619. package/docs/reference/typescript-api/shipping/shipping-options.mdx +0 -1
  620. package/docs/reference/typescript-api/shipping/should-run-check-fn.mdx +0 -1
  621. package/docs/reference/typescript-api/state-machine/fsm.mdx +0 -1
  622. package/docs/reference/typescript-api/state-machine/index.mdx +0 -1
  623. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +0 -1
  624. package/docs/reference/typescript-api/state-machine/transitions.mdx +0 -1
  625. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +0 -1
  626. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +0 -1
  627. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +0 -1
  628. package/docs/reference/typescript-api/tax/index.mdx +0 -1
  629. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +0 -1
  630. package/docs/reference/typescript-api/tax/tax-options.mdx +0 -1
  631. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +0 -1
  632. package/docs/reference/typescript-api/telemetry/index.mdx +0 -1
  633. package/docs/reference/typescript-api/telemetry/instrument.mdx +0 -1
  634. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +0 -1
  635. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +0 -1
  636. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +0 -1
  637. package/docs/reference/typescript-api/testing/create-test-environment.mdx +0 -1
  638. package/docs/reference/typescript-api/testing/error-result-guard.mdx +0 -1
  639. package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +0 -1
  640. package/docs/reference/typescript-api/testing/index.mdx +0 -1
  641. package/docs/reference/typescript-api/testing/register-initializer.mdx +0 -1
  642. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +0 -1
  643. package/docs/reference/typescript-api/testing/test-config.mdx +0 -1
  644. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +0 -1
  645. package/docs/reference/typescript-api/testing/test-environment.mdx +0 -1
  646. package/docs/reference/typescript-api/testing/test-server-options.mdx +0 -1
  647. package/docs/reference/typescript-api/testing/test-server.mdx +0 -1
  648. package/docs/reference/typescript-api/testing/testing-logger.mdx +0 -1
  649. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +0 -1
  650. package/docs/reference/typescript-api/worker/index.mdx +0 -1
  651. package/docs/reference/typescript-api/worker/vendure-worker.mdx +0 -1
  652. package/docs/reference/typescript-api/worker/worker-health-check-config.mdx +0 -1
  653. package/docs/user-guide/catalog/index.mdx +18 -0
  654. package/docs/user-guide/orders/index.mdx +14 -0
  655. package/docs/user-guide/settings/index.mdx +34 -0
  656. package/package.json +2 -2
  657. package/docs/reference/admin-ui-api/index.mdx +0 -11
  658. package/docs/reference/graphql-api/_index.mdx +0 -14
  659. package/docs/reference/graphql-api/admin/_index.mdx +0 -11
  660. package/docs/reference/graphql-api/shop/_index.mdx +0 -11
  661. package/docs/reference/index.mdx +0 -38
  662. package/docs/reference/links.webp +0 -0
  663. package/docs/reference/typescript-api/_index.mdx +0 -11
@@ -2,1984 +2,2749 @@
2
2
  title: "Mutations"
3
3
  generated: true
4
4
  ---
5
- <!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
6
5
 
7
6
 
8
7
 
9
- ## addCustomersToGroup
10
- <div class="graphql-code-block">
11
- <div class="graphql-code-line top-level comment">"""</div>
12
- <div class="graphql-code-line top-level comment">Add Customers to a CustomerGroup</div>
13
- <div class="graphql-code-line top-level comment">"""</div>
14
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
15
- <div class="graphql-code-line ">addCustomersToGroup(customerGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, customerIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
16
-
17
-
18
- <div class="graphql-code-line top-level">&#125;</div>
19
- </div>
20
-
21
- ## addFulfillmentToOrder
22
- <div class="graphql-code-block">
23
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
24
- <div class="graphql-code-line ">addFulfillmentToOrder(input: <a href="/reference/graphql-api/admin/input-types#fulfillorderinput">FulfillOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#addfulfillmenttoorderresult">AddFulfillmentToOrderResult</a>!</div>
25
-
26
-
27
- <div class="graphql-code-line top-level">&#125;</div>
28
- </div>
29
-
30
- ## addItemToDraftOrder
31
- <div class="graphql-code-block">
32
- <div class="graphql-code-line top-level comment">"""</div>
33
- <div class="graphql-code-line top-level comment">Adds an item to the draft Order.</div>
34
- <div class="graphql-code-line top-level comment">"""</div>
35
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
36
- <div class="graphql-code-line ">addItemToDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#additemtodraftorderinput">AddItemToDraftOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#updateorderitemsresult">UpdateOrderItemsResult</a>!</div>
37
-
38
-
39
- <div class="graphql-code-line top-level">&#125;</div>
40
- </div>
41
-
42
- ## addManualPaymentToOrder
43
- <div class="graphql-code-block">
44
- <div class="graphql-code-line top-level comment">"""</div>
45
- <div class="graphql-code-line top-level comment">Used to manually create a new Payment against an Order.</div>
46
-
47
- <div class="graphql-code-line top-level comment">This can be used by an Administrator when an Order is in the ArrangingPayment state.</div>
48
-
49
- <div class="graphql-code-line top-level comment"></div>
50
-
51
- <div class="graphql-code-line top-level comment">It is also used when a completed Order</div>
52
-
53
- <div class="graphql-code-line top-level comment">has been modified (using `modifyOrder`) and the price has increased. The extra payment</div>
54
-
55
- <div class="graphql-code-line top-level comment">can then be manually arranged by the administrator, and the details used to create a new</div>
56
-
57
- <div class="graphql-code-line top-level comment">Payment.</div>
58
- <div class="graphql-code-line top-level comment">"""</div>
59
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
60
- <div class="graphql-code-line ">addManualPaymentToOrder(input: <a href="/reference/graphql-api/admin/input-types#manualpaymentinput">ManualPaymentInput</a>!): <a href="/reference/graphql-api/admin/object-types#addmanualpaymenttoorderresult">AddManualPaymentToOrderResult</a>!</div>
61
-
62
-
63
- <div class="graphql-code-line top-level">&#125;</div>
64
- </div>
65
-
66
- ## addMembersToZone
67
- <div class="graphql-code-block">
68
- <div class="graphql-code-line top-level comment">"""</div>
69
- <div class="graphql-code-line top-level comment">Add members to a Zone</div>
70
- <div class="graphql-code-line top-level comment">"""</div>
71
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
72
- <div class="graphql-code-line ">addMembersToZone(zoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, memberIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
73
-
74
-
75
- <div class="graphql-code-line top-level">&#125;</div>
76
- </div>
77
-
78
- ## addNoteToCustomer
79
- <div class="graphql-code-block">
80
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
81
- <div class="graphql-code-line ">addNoteToCustomer(input: <a href="/reference/graphql-api/admin/input-types#addnotetocustomerinput">AddNoteToCustomerInput</a>!): <a href="/reference/graphql-api/admin/object-types#customer">Customer</a>!</div>
82
-
83
-
84
- <div class="graphql-code-line top-level">&#125;</div>
85
- </div>
86
-
87
- ## addNoteToOrder
88
- <div class="graphql-code-block">
89
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
90
- <div class="graphql-code-line ">addNoteToOrder(input: <a href="/reference/graphql-api/admin/input-types#addnotetoorderinput">AddNoteToOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
91
-
92
-
93
- <div class="graphql-code-line top-level">&#125;</div>
94
- </div>
95
-
96
- ## addOptionGroupToProduct
97
- <div class="graphql-code-block">
98
- <div class="graphql-code-line top-level comment">"""</div>
99
- <div class="graphql-code-line top-level comment">Add an OptionGroup to a Product</div>
100
- <div class="graphql-code-line top-level comment">"""</div>
101
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
102
- <div class="graphql-code-line ">addOptionGroupToProduct(productId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, optionGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#product">Product</a>!</div>
103
-
104
-
105
- <div class="graphql-code-line top-level">&#125;</div>
106
- </div>
107
-
108
- ## adjustDraftOrderLine
109
- <div class="graphql-code-block">
110
- <div class="graphql-code-line top-level comment">"""</div>
111
- <div class="graphql-code-line top-level comment">Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type <code>OrderLineCustomFieldsInput</code> will be available.</div>
112
- <div class="graphql-code-line top-level comment">"""</div>
113
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
114
- <div class="graphql-code-line ">adjustDraftOrderLine(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#adjustdraftorderlineinput">AdjustDraftOrderLineInput</a>!): <a href="/reference/graphql-api/admin/object-types#updateorderitemsresult">UpdateOrderItemsResult</a>!</div>
115
-
116
-
117
- <div class="graphql-code-line top-level">&#125;</div>
118
- </div>
119
-
120
- ## applyCouponCodeToDraftOrder
121
- <div class="graphql-code-block">
122
- <div class="graphql-code-line top-level comment">"""</div>
123
- <div class="graphql-code-line top-level comment">Applies the given coupon code to the draft Order</div>
124
- <div class="graphql-code-line top-level comment">"""</div>
125
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
126
- <div class="graphql-code-line ">applyCouponCodeToDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#applycouponcoderesult">ApplyCouponCodeResult</a>!</div>
127
-
128
-
129
- <div class="graphql-code-line top-level">&#125;</div>
130
- </div>
131
-
132
- ## assignAssetsToChannel
133
- <div class="graphql-code-block">
134
- <div class="graphql-code-line top-level comment">"""</div>
135
- <div class="graphql-code-line top-level comment">Assign assets to channel</div>
136
- <div class="graphql-code-line top-level comment">"""</div>
137
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
138
- <div class="graphql-code-line ">assignAssetsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignassetstochannelinput">AssignAssetsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#asset">Asset</a>!]!</div>
139
-
140
-
141
- <div class="graphql-code-line top-level">&#125;</div>
142
- </div>
143
-
144
- ## assignCollectionsToChannel
145
- <div class="graphql-code-block">
146
- <div class="graphql-code-line top-level comment">"""</div>
147
- <div class="graphql-code-line top-level comment">Assigns Collections to the specified Channel</div>
148
- <div class="graphql-code-line top-level comment">"""</div>
149
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
150
- <div class="graphql-code-line ">assignCollectionsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assigncollectionstochannelinput">AssignCollectionsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!]!</div>
151
-
152
-
153
- <div class="graphql-code-line top-level">&#125;</div>
154
- </div>
155
-
156
- ## assignFacetsToChannel
157
- <div class="graphql-code-block">
158
- <div class="graphql-code-line top-level comment">"""</div>
159
- <div class="graphql-code-line top-level comment">Assigns Facets to the specified Channel</div>
160
- <div class="graphql-code-line top-level comment">"""</div>
161
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
162
- <div class="graphql-code-line ">assignFacetsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignfacetstochannelinput">AssignFacetsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#facet">Facet</a>!]!</div>
163
-
164
-
165
- <div class="graphql-code-line top-level">&#125;</div>
166
- </div>
167
-
168
- ## assignPaymentMethodsToChannel
169
- <div class="graphql-code-block">
170
- <div class="graphql-code-line top-level comment">"""</div>
171
- <div class="graphql-code-line top-level comment">Assigns PaymentMethods to the specified Channel</div>
172
- <div class="graphql-code-line top-level comment">"""</div>
173
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
174
- <div class="graphql-code-line ">assignPaymentMethodsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignpaymentmethodstochannelinput">AssignPaymentMethodsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!]!</div>
175
-
176
-
177
- <div class="graphql-code-line top-level">&#125;</div>
178
- </div>
179
-
180
- ## assignProductVariantsToChannel
181
- <div class="graphql-code-block">
182
- <div class="graphql-code-line top-level comment">"""</div>
183
- <div class="graphql-code-line top-level comment">Assigns ProductVariants to the specified Channel</div>
184
- <div class="graphql-code-line top-level comment">"""</div>
185
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
186
- <div class="graphql-code-line ">assignProductVariantsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignproductvariantstochannelinput">AssignProductVariantsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!]!</div>
187
-
188
-
189
- <div class="graphql-code-line top-level">&#125;</div>
190
- </div>
191
-
192
- ## assignProductsToChannel
193
- <div class="graphql-code-block">
194
- <div class="graphql-code-line top-level comment">"""</div>
195
- <div class="graphql-code-line top-level comment">Assigns all ProductVariants of Product to the specified Channel</div>
196
- <div class="graphql-code-line top-level comment">"""</div>
197
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
198
- <div class="graphql-code-line ">assignProductsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignproductstochannelinput">AssignProductsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#product">Product</a>!]!</div>
199
-
200
-
201
- <div class="graphql-code-line top-level">&#125;</div>
202
- </div>
203
-
204
- ## assignPromotionsToChannel
205
- <div class="graphql-code-block">
206
- <div class="graphql-code-line top-level comment">"""</div>
207
- <div class="graphql-code-line top-level comment">Assigns Promotions to the specified Channel</div>
208
- <div class="graphql-code-line top-level comment">"""</div>
209
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
210
- <div class="graphql-code-line ">assignPromotionsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignpromotionstochannelinput">AssignPromotionsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a>!]!</div>
211
-
212
-
213
- <div class="graphql-code-line top-level">&#125;</div>
214
- </div>
215
-
216
- ## assignRoleToAdministrator
217
- <div class="graphql-code-block">
218
- <div class="graphql-code-line top-level comment">"""</div>
219
- <div class="graphql-code-line top-level comment">Assign a Role to an Administrator</div>
220
- <div class="graphql-code-line top-level comment">"""</div>
221
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
222
- <div class="graphql-code-line ">assignRoleToAdministrator(administratorId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, roleId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
223
-
224
-
225
- <div class="graphql-code-line top-level">&#125;</div>
226
- </div>
227
-
228
- ## assignShippingMethodsToChannel
229
- <div class="graphql-code-block">
230
- <div class="graphql-code-line top-level comment">"""</div>
231
- <div class="graphql-code-line top-level comment">Assigns ShippingMethods to the specified Channel</div>
232
- <div class="graphql-code-line top-level comment">"""</div>
233
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
234
- <div class="graphql-code-line ">assignShippingMethodsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignshippingmethodstochannelinput">AssignShippingMethodsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!]!</div>
235
-
236
-
237
- <div class="graphql-code-line top-level">&#125;</div>
238
- </div>
239
-
240
- ## assignStockLocationsToChannel
241
- <div class="graphql-code-block">
242
- <div class="graphql-code-line top-level comment">"""</div>
243
- <div class="graphql-code-line top-level comment">Assigns StockLocations to the specified Channel</div>
244
- <div class="graphql-code-line top-level comment">"""</div>
245
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
246
- <div class="graphql-code-line ">assignStockLocationsToChannel(input: <a href="/reference/graphql-api/admin/input-types#assignstocklocationstochannelinput">AssignStockLocationsToChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!]!</div>
247
-
248
-
249
- <div class="graphql-code-line top-level">&#125;</div>
250
- </div>
251
-
252
- ## authenticate
253
- <div class="graphql-code-block">
254
- <div class="graphql-code-line top-level comment">"""</div>
255
- <div class="graphql-code-line top-level comment">Authenticates the user using a named authentication strategy</div>
256
- <div class="graphql-code-line top-level comment">"""</div>
257
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
258
- <div class="graphql-code-line ">authenticate(input: <a href="/reference/graphql-api/admin/input-types#authenticationinput">AuthenticationInput</a>!, rememberMe: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#authenticationresult">AuthenticationResult</a>!</div>
259
-
260
-
261
- <div class="graphql-code-line top-level">&#125;</div>
262
- </div>
263
-
264
- ## cancelJob
265
- <div class="graphql-code-block">
266
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
267
- <div class="graphql-code-line ">cancelJob(jobId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#job">Job</a>!</div>
268
-
269
-
270
- <div class="graphql-code-line top-level">&#125;</div>
271
- </div>
272
-
273
- ## cancelOrder
274
- <div class="graphql-code-block">
275
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
276
- <div class="graphql-code-line ">cancelOrder(input: <a href="/reference/graphql-api/admin/input-types#cancelorderinput">CancelOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#cancelorderresult">CancelOrderResult</a>!</div>
277
-
278
-
279
- <div class="graphql-code-line top-level">&#125;</div>
280
- </div>
281
-
282
- ## cancelPayment
283
- <div class="graphql-code-block">
284
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
285
- <div class="graphql-code-line ">cancelPayment(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#cancelpaymentresult">CancelPaymentResult</a>!</div>
286
-
287
-
288
- <div class="graphql-code-line top-level">&#125;</div>
289
- </div>
290
-
291
- ## createAdministrator
292
- <div class="graphql-code-block">
293
- <div class="graphql-code-line top-level comment">"""</div>
294
- <div class="graphql-code-line top-level comment">Create a new Administrator</div>
295
- <div class="graphql-code-line top-level comment">"""</div>
296
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
297
- <div class="graphql-code-line ">createAdministrator(input: <a href="/reference/graphql-api/admin/input-types#createadministratorinput">CreateAdministratorInput</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
298
-
299
-
300
- <div class="graphql-code-line top-level">&#125;</div>
301
- </div>
302
-
303
- ## createAssets
304
- <div class="graphql-code-block">
305
- <div class="graphql-code-line top-level comment">"""</div>
306
- <div class="graphql-code-line top-level comment">Create a new Asset</div>
307
- <div class="graphql-code-line top-level comment">"""</div>
308
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
309
- <div class="graphql-code-line ">createAssets(input: [<a href="/reference/graphql-api/admin/input-types#createassetinput">CreateAssetInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#createassetresult">CreateAssetResult</a>!]!</div>
310
-
311
-
312
- <div class="graphql-code-line top-level">&#125;</div>
313
- </div>
314
-
315
- ## createChannel
316
- <div class="graphql-code-block">
317
- <div class="graphql-code-line top-level comment">"""</div>
318
- <div class="graphql-code-line top-level comment">Create a new Channel</div>
319
- <div class="graphql-code-line top-level comment">"""</div>
320
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
321
- <div class="graphql-code-line ">createChannel(input: <a href="/reference/graphql-api/admin/input-types#createchannelinput">CreateChannelInput</a>!): <a href="/reference/graphql-api/admin/object-types#createchannelresult">CreateChannelResult</a>!</div>
322
-
323
-
324
- <div class="graphql-code-line top-level">&#125;</div>
325
- </div>
326
-
327
- ## createCollection
328
- <div class="graphql-code-block">
329
- <div class="graphql-code-line top-level comment">"""</div>
330
- <div class="graphql-code-line top-level comment">Create a new Collection</div>
331
- <div class="graphql-code-line top-level comment">"""</div>
332
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
333
- <div class="graphql-code-line ">createCollection(input: <a href="/reference/graphql-api/admin/input-types#createcollectioninput">CreateCollectionInput</a>!): <a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!</div>
334
-
335
-
336
- <div class="graphql-code-line top-level">&#125;</div>
337
- </div>
338
-
339
- ## createCountry
340
- <div class="graphql-code-block">
341
- <div class="graphql-code-line top-level comment">"""</div>
342
- <div class="graphql-code-line top-level comment">Create a new Country</div>
343
- <div class="graphql-code-line top-level comment">"""</div>
344
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
345
- <div class="graphql-code-line ">createCountry(input: <a href="/reference/graphql-api/admin/input-types#createcountryinput">CreateCountryInput</a>!): <a href="/reference/graphql-api/admin/object-types#country">Country</a>!</div>
346
-
347
-
348
- <div class="graphql-code-line top-level">&#125;</div>
349
- </div>
350
-
351
- ## createCustomer
352
- <div class="graphql-code-block">
353
- <div class="graphql-code-line top-level comment">"""</div>
354
- <div class="graphql-code-line top-level comment">Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer.</div>
355
- <div class="graphql-code-line top-level comment">"""</div>
356
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
357
- <div class="graphql-code-line ">createCustomer(input: <a href="/reference/graphql-api/admin/input-types#createcustomerinput">CreateCustomerInput</a>!, password: <a href="/reference/graphql-api/admin/object-types#string">String</a>): <a href="/reference/graphql-api/admin/object-types#createcustomerresult">CreateCustomerResult</a>!</div>
358
-
359
-
360
- <div class="graphql-code-line top-level">&#125;</div>
361
- </div>
362
-
363
- ## createCustomerAddress
364
- <div class="graphql-code-block">
365
- <div class="graphql-code-line top-level comment">"""</div>
366
- <div class="graphql-code-line top-level comment">Create a new Address and associate it with the Customer specified by customerId</div>
367
- <div class="graphql-code-line top-level comment">"""</div>
368
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
369
- <div class="graphql-code-line ">createCustomerAddress(customerId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#address">Address</a>!</div>
370
-
371
-
372
- <div class="graphql-code-line top-level">&#125;</div>
373
- </div>
374
-
375
- ## createCustomerGroup
376
- <div class="graphql-code-block">
377
- <div class="graphql-code-line top-level comment">"""</div>
378
- <div class="graphql-code-line top-level comment">Create a new CustomerGroup</div>
379
- <div class="graphql-code-line top-level comment">"""</div>
380
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
381
- <div class="graphql-code-line ">createCustomerGroup(input: <a href="/reference/graphql-api/admin/input-types#createcustomergroupinput">CreateCustomerGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
382
-
383
-
384
- <div class="graphql-code-line top-level">&#125;</div>
385
- </div>
386
-
387
- ## createDraftOrder
388
- <div class="graphql-code-block">
389
- <div class="graphql-code-line top-level comment">"""</div>
390
- <div class="graphql-code-line top-level comment">Creates a draft Order</div>
391
- <div class="graphql-code-line top-level comment">"""</div>
392
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
393
- <div class="graphql-code-line ">createDraftOrder: <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
394
-
395
-
396
- <div class="graphql-code-line top-level">&#125;</div>
397
- </div>
398
-
399
- ## createFacet
400
- <div class="graphql-code-block">
401
- <div class="graphql-code-line top-level comment">"""</div>
402
- <div class="graphql-code-line top-level comment">Create a new Facet</div>
403
- <div class="graphql-code-line top-level comment">"""</div>
404
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
405
- <div class="graphql-code-line ">createFacet(input: <a href="/reference/graphql-api/admin/input-types#createfacetinput">CreateFacetInput</a>!): <a href="/reference/graphql-api/admin/object-types#facet">Facet</a>!</div>
406
-
407
-
408
- <div class="graphql-code-line top-level">&#125;</div>
409
- </div>
410
-
411
- ## createFacetValue
412
- <div class="graphql-code-block">
413
- <div class="graphql-code-line top-level comment">"""</div>
414
- <div class="graphql-code-line top-level comment">Create a single FacetValue</div>
415
- <div class="graphql-code-line top-level comment">"""</div>
416
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
417
- <div class="graphql-code-line ">createFacetValue(input: <a href="/reference/graphql-api/admin/input-types#createfacetvalueinput">CreateFacetValueInput</a>!): <a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!</div>
418
-
419
-
420
- <div class="graphql-code-line top-level">&#125;</div>
421
- </div>
422
-
423
- ## createFacetValues
424
- <div class="graphql-code-block">
425
- <div class="graphql-code-line top-level comment">"""</div>
426
- <div class="graphql-code-line top-level comment">Create one or more FacetValues</div>
427
- <div class="graphql-code-line top-level comment">"""</div>
428
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
429
- <div class="graphql-code-line ">createFacetValues(input: [<a href="/reference/graphql-api/admin/input-types#createfacetvalueinput">CreateFacetValueInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!]!</div>
430
-
431
-
432
- <div class="graphql-code-line top-level">&#125;</div>
433
- </div>
434
-
435
- ## createPaymentMethod
436
- <div class="graphql-code-block">
437
- <div class="graphql-code-line top-level comment">"""</div>
438
- <div class="graphql-code-line top-level comment">Create existing PaymentMethod</div>
439
- <div class="graphql-code-line top-level comment">"""</div>
440
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
441
- <div class="graphql-code-line ">createPaymentMethod(input: <a href="/reference/graphql-api/admin/input-types#createpaymentmethodinput">CreatePaymentMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!</div>
442
-
443
-
444
- <div class="graphql-code-line top-level">&#125;</div>
445
- </div>
446
-
447
- ## createProduct
448
- <div class="graphql-code-block">
449
- <div class="graphql-code-line top-level comment">"""</div>
450
- <div class="graphql-code-line top-level comment">Create a new Product</div>
451
- <div class="graphql-code-line top-level comment">"""</div>
452
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
453
- <div class="graphql-code-line ">createProduct(input: <a href="/reference/graphql-api/admin/input-types#createproductinput">CreateProductInput</a>!): <a href="/reference/graphql-api/admin/object-types#product">Product</a>!</div>
454
-
455
-
456
- <div class="graphql-code-line top-level">&#125;</div>
457
- </div>
458
-
459
- ## createProductOption
460
- <div class="graphql-code-block">
461
- <div class="graphql-code-line top-level comment">"""</div>
462
- <div class="graphql-code-line top-level comment">Create a new ProductOption within a ProductOptionGroup</div>
463
- <div class="graphql-code-line top-level comment">"""</div>
464
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
465
- <div class="graphql-code-line ">createProductOption(input: <a href="/reference/graphql-api/admin/input-types#createproductoptioninput">CreateProductOptionInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoption">ProductOption</a>!</div>
466
-
467
-
468
- <div class="graphql-code-line top-level">&#125;</div>
469
- </div>
470
-
471
- ## createProductOptionGroup
472
- <div class="graphql-code-block">
473
- <div class="graphql-code-line top-level comment">"""</div>
474
- <div class="graphql-code-line top-level comment">Create a new ProductOptionGroup</div>
475
- <div class="graphql-code-line top-level comment">"""</div>
476
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
477
- <div class="graphql-code-line ">createProductOptionGroup(input: <a href="/reference/graphql-api/admin/input-types#createproductoptiongroupinput">CreateProductOptionGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a>!</div>
478
-
479
-
480
- <div class="graphql-code-line top-level">&#125;</div>
481
- </div>
482
-
483
- ## createProductVariants
484
- <div class="graphql-code-block">
485
- <div class="graphql-code-line top-level comment">"""</div>
486
- <div class="graphql-code-line top-level comment">Create a set of ProductVariants based on the OptionGroups assigned to the given Product</div>
487
- <div class="graphql-code-line top-level comment">"""</div>
488
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
489
- <div class="graphql-code-line ">createProductVariants(input: [<a href="/reference/graphql-api/admin/input-types#createproductvariantinput">CreateProductVariantInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>]!</div>
490
-
491
-
492
- <div class="graphql-code-line top-level">&#125;</div>
493
- </div>
494
-
495
- ## createPromotion
496
- <div class="graphql-code-block">
497
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
498
- <div class="graphql-code-line ">createPromotion(input: <a href="/reference/graphql-api/admin/input-types#createpromotioninput">CreatePromotionInput</a>!): <a href="/reference/graphql-api/admin/object-types#createpromotionresult">CreatePromotionResult</a>!</div>
499
-
500
-
501
- <div class="graphql-code-line top-level">&#125;</div>
502
- </div>
503
-
504
- ## createProvince
505
- <div class="graphql-code-block">
506
- <div class="graphql-code-line top-level comment">"""</div>
507
- <div class="graphql-code-line top-level comment">Create a new Province</div>
508
- <div class="graphql-code-line top-level comment">"""</div>
509
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
510
- <div class="graphql-code-line ">createProvince(input: <a href="/reference/graphql-api/admin/input-types#createprovinceinput">CreateProvinceInput</a>!): <a href="/reference/graphql-api/admin/object-types#province">Province</a>!</div>
511
-
512
-
513
- <div class="graphql-code-line top-level">&#125;</div>
514
- </div>
515
-
516
- ## createRole
517
- <div class="graphql-code-block">
518
- <div class="graphql-code-line top-level comment">"""</div>
519
- <div class="graphql-code-line top-level comment">Create a new Role</div>
520
- <div class="graphql-code-line top-level comment">"""</div>
521
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
522
- <div class="graphql-code-line ">createRole(input: <a href="/reference/graphql-api/admin/input-types#createroleinput">CreateRoleInput</a>!): <a href="/reference/graphql-api/admin/object-types#role">Role</a>!</div>
523
-
524
-
525
- <div class="graphql-code-line top-level">&#125;</div>
526
- </div>
527
-
528
- ## createSeller
529
- <div class="graphql-code-block">
530
- <div class="graphql-code-line top-level comment">"""</div>
531
- <div class="graphql-code-line top-level comment">Create a new Seller</div>
532
- <div class="graphql-code-line top-level comment">"""</div>
533
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
534
- <div class="graphql-code-line ">createSeller(input: <a href="/reference/graphql-api/admin/input-types#createsellerinput">CreateSellerInput</a>!): <a href="/reference/graphql-api/admin/object-types#seller">Seller</a>!</div>
535
-
536
-
537
- <div class="graphql-code-line top-level">&#125;</div>
538
- </div>
539
-
540
- ## createShippingMethod
541
- <div class="graphql-code-block">
542
- <div class="graphql-code-line top-level comment">"""</div>
543
- <div class="graphql-code-line top-level comment">Create a new ShippingMethod</div>
544
- <div class="graphql-code-line top-level comment">"""</div>
545
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
546
- <div class="graphql-code-line ">createShippingMethod(input: <a href="/reference/graphql-api/admin/input-types#createshippingmethodinput">CreateShippingMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!</div>
547
-
548
-
549
- <div class="graphql-code-line top-level">&#125;</div>
550
- </div>
551
-
552
- ## createStockLocation
553
- <div class="graphql-code-block">
554
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
555
- <div class="graphql-code-line ">createStockLocation(input: <a href="/reference/graphql-api/admin/input-types#createstocklocationinput">CreateStockLocationInput</a>!): <a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!</div>
556
-
557
-
558
- <div class="graphql-code-line top-level">&#125;</div>
559
- </div>
560
-
561
- ## createTag
562
- <div class="graphql-code-block">
563
- <div class="graphql-code-line top-level comment">"""</div>
564
- <div class="graphql-code-line top-level comment">Create a new Tag</div>
565
- <div class="graphql-code-line top-level comment">"""</div>
566
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
567
- <div class="graphql-code-line ">createTag(input: <a href="/reference/graphql-api/admin/input-types#createtaginput">CreateTagInput</a>!): <a href="/reference/graphql-api/admin/object-types#tag">Tag</a>!</div>
568
-
569
-
570
- <div class="graphql-code-line top-level">&#125;</div>
571
- </div>
572
-
573
- ## createTaxCategory
574
- <div class="graphql-code-block">
575
- <div class="graphql-code-line top-level comment">"""</div>
576
- <div class="graphql-code-line top-level comment">Create a new TaxCategory</div>
577
- <div class="graphql-code-line top-level comment">"""</div>
578
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
579
- <div class="graphql-code-line ">createTaxCategory(input: <a href="/reference/graphql-api/admin/input-types#createtaxcategoryinput">CreateTaxCategoryInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxcategory">TaxCategory</a>!</div>
580
-
581
-
582
- <div class="graphql-code-line top-level">&#125;</div>
583
- </div>
584
-
585
- ## createTaxRate
586
- <div class="graphql-code-block">
587
- <div class="graphql-code-line top-level comment">"""</div>
588
- <div class="graphql-code-line top-level comment">Create a new TaxRate</div>
589
- <div class="graphql-code-line top-level comment">"""</div>
590
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
591
- <div class="graphql-code-line ">createTaxRate(input: <a href="/reference/graphql-api/admin/input-types#createtaxrateinput">CreateTaxRateInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxrate">TaxRate</a>!</div>
592
-
593
-
594
- <div class="graphql-code-line top-level">&#125;</div>
595
- </div>
596
-
597
- ## createZone
598
- <div class="graphql-code-block">
599
- <div class="graphql-code-line top-level comment">"""</div>
600
- <div class="graphql-code-line top-level comment">Create a new Zone</div>
601
- <div class="graphql-code-line top-level comment">"""</div>
602
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
603
- <div class="graphql-code-line ">createZone(input: <a href="/reference/graphql-api/admin/input-types#createzoneinput">CreateZoneInput</a>!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
604
-
605
-
606
- <div class="graphql-code-line top-level">&#125;</div>
607
- </div>
608
-
609
- ## deleteAdministrator
610
- <div class="graphql-code-block">
611
- <div class="graphql-code-line top-level comment">"""</div>
612
- <div class="graphql-code-line top-level comment">Delete an Administrator</div>
613
- <div class="graphql-code-line top-level comment">"""</div>
614
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
615
- <div class="graphql-code-line ">deleteAdministrator(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
616
-
617
-
618
- <div class="graphql-code-line top-level">&#125;</div>
619
- </div>
620
-
621
- ## deleteAdministrators
622
- <div class="graphql-code-block">
623
- <div class="graphql-code-line top-level comment">"""</div>
624
- <div class="graphql-code-line top-level comment">Delete multiple Administrators</div>
625
- <div class="graphql-code-line top-level comment">"""</div>
626
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
627
- <div class="graphql-code-line ">deleteAdministrators(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
628
-
629
-
630
- <div class="graphql-code-line top-level">&#125;</div>
631
- </div>
632
-
633
- ## deleteAsset
634
- <div class="graphql-code-block">
635
- <div class="graphql-code-line top-level comment">"""</div>
636
- <div class="graphql-code-line top-level comment">Delete an Asset</div>
637
- <div class="graphql-code-line top-level comment">"""</div>
638
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
639
- <div class="graphql-code-line ">deleteAsset(input: <a href="/reference/graphql-api/admin/input-types#deleteassetinput">DeleteAssetInput</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
640
-
641
-
642
- <div class="graphql-code-line top-level">&#125;</div>
643
- </div>
644
-
645
- ## deleteAssets
646
- <div class="graphql-code-block">
647
- <div class="graphql-code-line top-level comment">"""</div>
648
- <div class="graphql-code-line top-level comment">Delete multiple Assets</div>
649
- <div class="graphql-code-line top-level comment">"""</div>
650
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
651
- <div class="graphql-code-line ">deleteAssets(input: <a href="/reference/graphql-api/admin/input-types#deleteassetsinput">DeleteAssetsInput</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
652
-
653
-
654
- <div class="graphql-code-line top-level">&#125;</div>
655
- </div>
656
-
657
- ## deleteChannel
658
- <div class="graphql-code-block">
659
- <div class="graphql-code-line top-level comment">"""</div>
660
- <div class="graphql-code-line top-level comment">Delete a Channel</div>
661
- <div class="graphql-code-line top-level comment">"""</div>
662
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
663
- <div class="graphql-code-line ">deleteChannel(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
664
-
665
-
666
- <div class="graphql-code-line top-level">&#125;</div>
667
- </div>
668
-
669
- ## deleteChannels
670
- <div class="graphql-code-block">
671
- <div class="graphql-code-line top-level comment">"""</div>
672
- <div class="graphql-code-line top-level comment">Delete multiple Channels</div>
673
- <div class="graphql-code-line top-level comment">"""</div>
674
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
675
- <div class="graphql-code-line ">deleteChannels(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
676
-
677
-
678
- <div class="graphql-code-line top-level">&#125;</div>
679
- </div>
680
-
681
- ## deleteCollection
682
- <div class="graphql-code-block">
683
- <div class="graphql-code-line top-level comment">"""</div>
684
- <div class="graphql-code-line top-level comment">Delete a Collection and all of its descendants</div>
685
- <div class="graphql-code-line top-level comment">"""</div>
686
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
687
- <div class="graphql-code-line ">deleteCollection(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
688
-
689
-
690
- <div class="graphql-code-line top-level">&#125;</div>
691
- </div>
692
-
693
- ## deleteCollections
694
- <div class="graphql-code-block">
695
- <div class="graphql-code-line top-level comment">"""</div>
696
- <div class="graphql-code-line top-level comment">Delete multiple Collections and all of their descendants</div>
697
- <div class="graphql-code-line top-level comment">"""</div>
698
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
699
- <div class="graphql-code-line ">deleteCollections(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
700
-
701
-
702
- <div class="graphql-code-line top-level">&#125;</div>
703
- </div>
704
-
705
- ## deleteCountries
706
- <div class="graphql-code-block">
707
- <div class="graphql-code-line top-level comment">"""</div>
708
- <div class="graphql-code-line top-level comment">Delete multiple Countries</div>
709
- <div class="graphql-code-line top-level comment">"""</div>
710
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
711
- <div class="graphql-code-line ">deleteCountries(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
712
-
713
-
714
- <div class="graphql-code-line top-level">&#125;</div>
715
- </div>
716
-
717
- ## deleteCountry
718
- <div class="graphql-code-block">
719
- <div class="graphql-code-line top-level comment">"""</div>
720
- <div class="graphql-code-line top-level comment">Delete a Country</div>
721
- <div class="graphql-code-line top-level comment">"""</div>
722
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
723
- <div class="graphql-code-line ">deleteCountry(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
724
-
725
-
726
- <div class="graphql-code-line top-level">&#125;</div>
727
- </div>
728
-
729
- ## deleteCustomer
730
- <div class="graphql-code-block">
731
- <div class="graphql-code-line top-level comment">"""</div>
732
- <div class="graphql-code-line top-level comment">Delete a Customer</div>
733
- <div class="graphql-code-line top-level comment">"""</div>
734
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
735
- <div class="graphql-code-line ">deleteCustomer(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
736
-
737
-
738
- <div class="graphql-code-line top-level">&#125;</div>
739
- </div>
740
-
741
- ## deleteCustomerAddress
742
- <div class="graphql-code-block">
743
- <div class="graphql-code-line top-level comment">"""</div>
744
- <div class="graphql-code-line top-level comment">Update an existing Address</div>
745
- <div class="graphql-code-line top-level comment">"""</div>
746
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
747
- <div class="graphql-code-line ">deleteCustomerAddress(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
748
-
749
-
750
- <div class="graphql-code-line top-level">&#125;</div>
751
- </div>
752
-
753
- ## deleteCustomerGroup
754
- <div class="graphql-code-block">
755
- <div class="graphql-code-line top-level comment">"""</div>
756
- <div class="graphql-code-line top-level comment">Delete a CustomerGroup</div>
757
- <div class="graphql-code-line top-level comment">"""</div>
758
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
759
- <div class="graphql-code-line ">deleteCustomerGroup(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
760
-
761
-
762
- <div class="graphql-code-line top-level">&#125;</div>
763
- </div>
764
-
765
- ## deleteCustomerGroups
766
- <div class="graphql-code-block">
767
- <div class="graphql-code-line top-level comment">"""</div>
768
- <div class="graphql-code-line top-level comment">Delete multiple CustomerGroups</div>
769
- <div class="graphql-code-line top-level comment">"""</div>
770
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
771
- <div class="graphql-code-line ">deleteCustomerGroups(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
772
-
773
-
774
- <div class="graphql-code-line top-level">&#125;</div>
775
- </div>
776
-
777
- ## deleteCustomerNote
778
- <div class="graphql-code-block">
779
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
780
- <div class="graphql-code-line ">deleteCustomerNote(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
781
-
782
-
783
- <div class="graphql-code-line top-level">&#125;</div>
784
- </div>
785
-
786
- ## deleteCustomers
787
- <div class="graphql-code-block">
788
- <div class="graphql-code-line top-level comment">"""</div>
789
- <div class="graphql-code-line top-level comment">Deletes Customers</div>
790
- <div class="graphql-code-line top-level comment">"""</div>
791
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
792
- <div class="graphql-code-line ">deleteCustomers(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
793
-
794
-
795
- <div class="graphql-code-line top-level">&#125;</div>
796
- </div>
797
-
798
- ## deleteDraftOrder
799
- <div class="graphql-code-block">
800
- <div class="graphql-code-line top-level comment">"""</div>
801
- <div class="graphql-code-line top-level comment">Deletes a draft Order</div>
802
- <div class="graphql-code-line top-level comment">"""</div>
803
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
804
- <div class="graphql-code-line ">deleteDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
805
-
806
-
807
- <div class="graphql-code-line top-level">&#125;</div>
808
- </div>
809
-
810
- ## deleteFacet
811
- <div class="graphql-code-block">
812
- <div class="graphql-code-line top-level comment">"""</div>
813
- <div class="graphql-code-line top-level comment">Delete an existing Facet</div>
814
- <div class="graphql-code-line top-level comment">"""</div>
815
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
816
- <div class="graphql-code-line ">deleteFacet(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
817
-
818
-
819
- <div class="graphql-code-line top-level">&#125;</div>
820
- </div>
821
-
822
- ## deleteFacetValues
823
- <div class="graphql-code-block">
824
- <div class="graphql-code-line top-level comment">"""</div>
825
- <div class="graphql-code-line top-level comment">Delete one or more FacetValues</div>
826
- <div class="graphql-code-line top-level comment">"""</div>
827
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
828
- <div class="graphql-code-line ">deleteFacetValues(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
829
-
830
-
831
- <div class="graphql-code-line top-level">&#125;</div>
832
- </div>
833
-
834
- ## deleteFacets
835
- <div class="graphql-code-block">
836
- <div class="graphql-code-line top-level comment">"""</div>
837
- <div class="graphql-code-line top-level comment">Delete multiple existing Facets</div>
838
- <div class="graphql-code-line top-level comment">"""</div>
839
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
840
- <div class="graphql-code-line ">deleteFacets(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
841
-
842
-
843
- <div class="graphql-code-line top-level">&#125;</div>
844
- </div>
845
-
846
- ## deleteOrderNote
847
- <div class="graphql-code-block">
848
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
849
- <div class="graphql-code-line ">deleteOrderNote(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
850
-
851
-
852
- <div class="graphql-code-line top-level">&#125;</div>
853
- </div>
854
-
855
- ## deletePaymentMethod
856
- <div class="graphql-code-block">
857
- <div class="graphql-code-line top-level comment">"""</div>
858
- <div class="graphql-code-line top-level comment">Delete a PaymentMethod</div>
859
- <div class="graphql-code-line top-level comment">"""</div>
860
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
861
- <div class="graphql-code-line ">deletePaymentMethod(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
862
-
863
-
864
- <div class="graphql-code-line top-level">&#125;</div>
865
- </div>
866
-
867
- ## deletePaymentMethods
868
- <div class="graphql-code-block">
869
- <div class="graphql-code-line top-level comment">"""</div>
870
- <div class="graphql-code-line top-level comment">Delete multiple PaymentMethods</div>
871
- <div class="graphql-code-line top-level comment">"""</div>
872
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
873
- <div class="graphql-code-line ">deletePaymentMethods(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
874
-
875
-
876
- <div class="graphql-code-line top-level">&#125;</div>
877
- </div>
878
-
879
- ## deleteProduct
880
- <div class="graphql-code-block">
881
- <div class="graphql-code-line top-level comment">"""</div>
882
- <div class="graphql-code-line top-level comment">Delete a Product</div>
883
- <div class="graphql-code-line top-level comment">"""</div>
884
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
885
- <div class="graphql-code-line ">deleteProduct(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
886
-
887
-
888
- <div class="graphql-code-line top-level">&#125;</div>
889
- </div>
890
-
891
- ## deleteProductOption
892
- <div class="graphql-code-block">
893
- <div class="graphql-code-line top-level comment">"""</div>
894
- <div class="graphql-code-line top-level comment">Delete a ProductOption</div>
895
- <div class="graphql-code-line top-level comment">"""</div>
896
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
897
- <div class="graphql-code-line ">deleteProductOption(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
898
-
899
-
900
- <div class="graphql-code-line top-level">&#125;</div>
901
- </div>
902
-
903
- ## deleteProductVariant
904
- <div class="graphql-code-block">
905
- <div class="graphql-code-line top-level comment">"""</div>
906
- <div class="graphql-code-line top-level comment">Delete a ProductVariant</div>
907
- <div class="graphql-code-line top-level comment">"""</div>
908
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
909
- <div class="graphql-code-line ">deleteProductVariant(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
910
-
911
-
912
- <div class="graphql-code-line top-level">&#125;</div>
913
- </div>
914
-
915
- ## deleteProductVariants
916
- <div class="graphql-code-block">
917
- <div class="graphql-code-line top-level comment">"""</div>
918
- <div class="graphql-code-line top-level comment">Delete multiple ProductVariants</div>
919
- <div class="graphql-code-line top-level comment">"""</div>
920
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
921
- <div class="graphql-code-line ">deleteProductVariants(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
922
-
923
-
924
- <div class="graphql-code-line top-level">&#125;</div>
925
- </div>
926
-
927
- ## deleteProducts
928
- <div class="graphql-code-block">
929
- <div class="graphql-code-line top-level comment">"""</div>
930
- <div class="graphql-code-line top-level comment">Delete multiple Products</div>
931
- <div class="graphql-code-line top-level comment">"""</div>
932
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
933
- <div class="graphql-code-line ">deleteProducts(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
934
-
935
-
936
- <div class="graphql-code-line top-level">&#125;</div>
937
- </div>
938
-
939
- ## deletePromotion
940
- <div class="graphql-code-block">
941
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
942
- <div class="graphql-code-line ">deletePromotion(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
943
-
944
-
945
- <div class="graphql-code-line top-level">&#125;</div>
946
- </div>
947
-
948
- ## deletePromotions
949
- <div class="graphql-code-block">
950
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
951
- <div class="graphql-code-line ">deletePromotions(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
952
-
953
-
954
- <div class="graphql-code-line top-level">&#125;</div>
955
- </div>
956
-
957
- ## deleteProvince
958
- <div class="graphql-code-block">
959
- <div class="graphql-code-line top-level comment">"""</div>
960
- <div class="graphql-code-line top-level comment">Delete a Province</div>
961
- <div class="graphql-code-line top-level comment">"""</div>
962
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
963
- <div class="graphql-code-line ">deleteProvince(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
964
-
965
-
966
- <div class="graphql-code-line top-level">&#125;</div>
967
- </div>
968
-
969
- ## deleteRole
970
- <div class="graphql-code-block">
971
- <div class="graphql-code-line top-level comment">"""</div>
972
- <div class="graphql-code-line top-level comment">Delete an existing Role</div>
973
- <div class="graphql-code-line top-level comment">"""</div>
974
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
975
- <div class="graphql-code-line ">deleteRole(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
976
-
977
-
978
- <div class="graphql-code-line top-level">&#125;</div>
979
- </div>
980
-
981
- ## deleteRoles
982
- <div class="graphql-code-block">
983
- <div class="graphql-code-line top-level comment">"""</div>
984
- <div class="graphql-code-line top-level comment">Delete multiple Roles</div>
985
- <div class="graphql-code-line top-level comment">"""</div>
986
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
987
- <div class="graphql-code-line ">deleteRoles(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
988
-
989
-
990
- <div class="graphql-code-line top-level">&#125;</div>
991
- </div>
992
-
993
- ## deleteSeller
994
- <div class="graphql-code-block">
995
- <div class="graphql-code-line top-level comment">"""</div>
996
- <div class="graphql-code-line top-level comment">Delete a Seller</div>
997
- <div class="graphql-code-line top-level comment">"""</div>
998
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
999
- <div class="graphql-code-line ">deleteSeller(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
1000
-
1001
-
1002
- <div class="graphql-code-line top-level">&#125;</div>
1003
- </div>
1004
-
1005
- ## deleteSellers
1006
- <div class="graphql-code-block">
1007
- <div class="graphql-code-line top-level comment">"""</div>
1008
- <div class="graphql-code-line top-level comment">Delete multiple Sellers</div>
1009
- <div class="graphql-code-line top-level comment">"""</div>
1010
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1011
- <div class="graphql-code-line ">deleteSellers(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
1012
-
1013
-
1014
- <div class="graphql-code-line top-level">&#125;</div>
1015
- </div>
1016
-
1017
- ## deleteShippingMethod
1018
- <div class="graphql-code-block">
1019
- <div class="graphql-code-line top-level comment">"""</div>
1020
- <div class="graphql-code-line top-level comment">Delete a ShippingMethod</div>
1021
- <div class="graphql-code-line top-level comment">"""</div>
1022
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1023
- <div class="graphql-code-line ">deleteShippingMethod(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
1024
-
1025
-
1026
- <div class="graphql-code-line top-level">&#125;</div>
1027
- </div>
1028
-
1029
- ## deleteShippingMethods
1030
- <div class="graphql-code-block">
1031
- <div class="graphql-code-line top-level comment">"""</div>
1032
- <div class="graphql-code-line top-level comment">Delete multiple ShippingMethods</div>
1033
- <div class="graphql-code-line top-level comment">"""</div>
1034
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1035
- <div class="graphql-code-line ">deleteShippingMethods(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
1036
-
1037
-
1038
- <div class="graphql-code-line top-level">&#125;</div>
1039
- </div>
1040
-
1041
- ## deleteStockLocation
1042
- <div class="graphql-code-block">
1043
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1044
- <div class="graphql-code-line ">deleteStockLocation(input: <a href="/reference/graphql-api/admin/input-types#deletestocklocationinput">DeleteStockLocationInput</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
1045
-
1046
-
1047
- <div class="graphql-code-line top-level">&#125;</div>
1048
- </div>
1049
-
1050
- ## deleteStockLocations
1051
- <div class="graphql-code-block">
1052
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1053
- <div class="graphql-code-line ">deleteStockLocations(input: [<a href="/reference/graphql-api/admin/input-types#deletestocklocationinput">DeleteStockLocationInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
1054
-
1055
-
1056
- <div class="graphql-code-line top-level">&#125;</div>
1057
- </div>
1058
-
1059
- ## deleteTag
1060
- <div class="graphql-code-block">
1061
- <div class="graphql-code-line top-level comment">"""</div>
1062
- <div class="graphql-code-line top-level comment">Delete an existing Tag</div>
1063
- <div class="graphql-code-line top-level comment">"""</div>
1064
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1065
- <div class="graphql-code-line ">deleteTag(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
1066
-
1067
-
1068
- <div class="graphql-code-line top-level">&#125;</div>
1069
- </div>
1070
-
1071
- ## deleteTaxCategories
1072
- <div class="graphql-code-block">
1073
- <div class="graphql-code-line top-level comment">"""</div>
1074
- <div class="graphql-code-line top-level comment">Deletes multiple TaxCategories</div>
1075
- <div class="graphql-code-line top-level comment">"""</div>
1076
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1077
- <div class="graphql-code-line ">deleteTaxCategories(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
1078
-
1079
-
1080
- <div class="graphql-code-line top-level">&#125;</div>
1081
- </div>
1082
-
1083
- ## deleteTaxCategory
1084
- <div class="graphql-code-block">
1085
- <div class="graphql-code-line top-level comment">"""</div>
1086
- <div class="graphql-code-line top-level comment">Deletes a TaxCategory</div>
1087
- <div class="graphql-code-line top-level comment">"""</div>
1088
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1089
- <div class="graphql-code-line ">deleteTaxCategory(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
1090
-
1091
-
1092
- <div class="graphql-code-line top-level">&#125;</div>
1093
- </div>
1094
-
1095
- ## deleteTaxRate
1096
- <div class="graphql-code-block">
1097
- <div class="graphql-code-line top-level comment">"""</div>
1098
- <div class="graphql-code-line top-level comment">Delete a TaxRate</div>
1099
- <div class="graphql-code-line top-level comment">"""</div>
1100
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1101
- <div class="graphql-code-line ">deleteTaxRate(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
1102
-
1103
-
1104
- <div class="graphql-code-line top-level">&#125;</div>
1105
- </div>
1106
-
1107
- ## deleteTaxRates
1108
- <div class="graphql-code-block">
1109
- <div class="graphql-code-line top-level comment">"""</div>
1110
- <div class="graphql-code-line top-level comment">Delete multiple TaxRates</div>
1111
- <div class="graphql-code-line top-level comment">"""</div>
1112
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1113
- <div class="graphql-code-line ">deleteTaxRates(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
1114
-
1115
-
1116
- <div class="graphql-code-line top-level">&#125;</div>
1117
- </div>
1118
-
1119
- ## deleteZone
1120
- <div class="graphql-code-block">
1121
- <div class="graphql-code-line top-level comment">"""</div>
1122
- <div class="graphql-code-line top-level comment">Delete a Zone</div>
1123
- <div class="graphql-code-line top-level comment">"""</div>
1124
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1125
- <div class="graphql-code-line ">deleteZone(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!</div>
1126
-
1127
-
1128
- <div class="graphql-code-line top-level">&#125;</div>
1129
- </div>
1130
-
1131
- ## deleteZones
1132
- <div class="graphql-code-block">
1133
- <div class="graphql-code-line top-level comment">"""</div>
1134
- <div class="graphql-code-line top-level comment">Delete a Zone</div>
1135
- <div class="graphql-code-line top-level comment">"""</div>
1136
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1137
- <div class="graphql-code-line ">deleteZones(ids: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#deletionresponse">DeletionResponse</a>!]!</div>
1138
-
1139
-
1140
- <div class="graphql-code-line top-level">&#125;</div>
1141
- </div>
1142
-
1143
- ## duplicateEntity
1144
- <div class="graphql-code-block">
1145
- <div class="graphql-code-line top-level comment">"""</div>
1146
- <div class="graphql-code-line top-level comment">Duplicate an existing entity using a specific EntityDuplicator.</div>
1147
-
1148
- <div class="graphql-code-line top-level comment">Since v2.2.0.</div>
1149
- <div class="graphql-code-line top-level comment">"""</div>
1150
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1151
- <div class="graphql-code-line ">duplicateEntity(input: <a href="/reference/graphql-api/admin/input-types#duplicateentityinput">DuplicateEntityInput</a>!): <a href="/reference/graphql-api/admin/object-types#duplicateentityresult">DuplicateEntityResult</a>!</div>
1152
-
1153
-
1154
- <div class="graphql-code-line top-level">&#125;</div>
1155
- </div>
1156
-
1157
- ## flushBufferedJobs
1158
- <div class="graphql-code-block">
1159
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1160
- <div class="graphql-code-line ">flushBufferedJobs(bufferIds: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]): <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
1161
-
1162
-
1163
- <div class="graphql-code-line top-level">&#125;</div>
1164
- </div>
1165
-
1166
- ## importProducts
1167
- <div class="graphql-code-block">
1168
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1169
- <div class="graphql-code-line ">importProducts(csvFile: <a href="/reference/graphql-api/admin/object-types#upload">Upload</a>!): <a href="/reference/graphql-api/admin/object-types#importinfo">ImportInfo</a></div>
1170
-
1171
-
1172
- <div class="graphql-code-line top-level">&#125;</div>
1173
- </div>
1174
-
1175
- ## login
1176
- <div class="graphql-code-block">
1177
- <div class="graphql-code-line top-level comment">"""</div>
1178
- <div class="graphql-code-line top-level comment">Authenticates the user using the native authentication strategy. This mutation is an alias for authenticate(&#123; native: &#123; ... &#125;&#125;)</div>
1179
-
1180
- <div class="graphql-code-line top-level comment"></div>
1181
-
1182
- <div class="graphql-code-line top-level comment">The <code>rememberMe</code> option applies when using cookie-based sessions, and if <code>true</code> it will set the maxAge of the session cookie</div>
1183
-
1184
- <div class="graphql-code-line top-level comment">to 1 year.</div>
1185
- <div class="graphql-code-line top-level comment">"""</div>
1186
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1187
- <div class="graphql-code-line ">login(username: <a href="/reference/graphql-api/admin/object-types#string">String</a>!, password: <a href="/reference/graphql-api/admin/object-types#string">String</a>!, rememberMe: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#nativeauthenticationresult">NativeAuthenticationResult</a>!</div>
1188
-
1189
-
1190
- <div class="graphql-code-line top-level">&#125;</div>
1191
- </div>
1192
-
1193
- ## logout
1194
- <div class="graphql-code-block">
1195
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1196
- <div class="graphql-code-line ">logout: <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
1197
-
1198
-
1199
- <div class="graphql-code-line top-level">&#125;</div>
1200
- </div>
1201
-
1202
- ## modifyOrder
1203
- <div class="graphql-code-block">
1204
- <div class="graphql-code-line top-level comment">"""</div>
1205
- <div class="graphql-code-line top-level comment">Allows an Order to be modified after it has been completed by the Customer. The Order must first</div>
1206
-
1207
- <div class="graphql-code-line top-level comment">be in the <code>Modifying</code> state.</div>
1208
- <div class="graphql-code-line top-level comment">"""</div>
1209
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1210
- <div class="graphql-code-line ">modifyOrder(input: <a href="/reference/graphql-api/admin/input-types#modifyorderinput">ModifyOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#modifyorderresult">ModifyOrderResult</a>!</div>
1211
-
1212
-
1213
- <div class="graphql-code-line top-level">&#125;</div>
1214
- </div>
1215
-
1216
- ## moveCollection
1217
- <div class="graphql-code-block">
1218
- <div class="graphql-code-line top-level comment">"""</div>
1219
- <div class="graphql-code-line top-level comment">Move a Collection to a different parent or index</div>
1220
- <div class="graphql-code-line top-level comment">"""</div>
1221
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1222
- <div class="graphql-code-line ">moveCollection(input: <a href="/reference/graphql-api/admin/input-types#movecollectioninput">MoveCollectionInput</a>!): <a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!</div>
1223
-
1224
-
1225
- <div class="graphql-code-line top-level">&#125;</div>
1226
- </div>
1227
-
1228
- ## refundOrder
1229
- <div class="graphql-code-block">
1230
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1231
- <div class="graphql-code-line ">refundOrder(input: <a href="/reference/graphql-api/admin/input-types#refundorderinput">RefundOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#refundorderresult">RefundOrderResult</a>!</div>
1232
-
1233
-
1234
- <div class="graphql-code-line top-level">&#125;</div>
1235
- </div>
1236
-
1237
- ## reindex
1238
- <div class="graphql-code-block">
1239
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1240
- <div class="graphql-code-line ">reindex: <a href="/reference/graphql-api/admin/object-types#job">Job</a>!</div>
1241
-
1242
-
1243
- <div class="graphql-code-line top-level">&#125;</div>
1244
- </div>
1245
-
1246
- ## removeCollectionsFromChannel
1247
- <div class="graphql-code-block">
1248
- <div class="graphql-code-line top-level comment">"""</div>
1249
- <div class="graphql-code-line top-level comment">Removes Collections from the specified Channel</div>
1250
- <div class="graphql-code-line top-level comment">"""</div>
1251
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1252
- <div class="graphql-code-line ">removeCollectionsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removecollectionsfromchannelinput">RemoveCollectionsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!]!</div>
1253
-
1254
-
1255
- <div class="graphql-code-line top-level">&#125;</div>
1256
- </div>
1257
-
1258
- ## removeCouponCodeFromDraftOrder
1259
- <div class="graphql-code-block">
1260
- <div class="graphql-code-line top-level comment">"""</div>
1261
- <div class="graphql-code-line top-level comment">Removes the given coupon code from the draft Order</div>
1262
- <div class="graphql-code-line top-level comment">"""</div>
1263
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1264
- <div class="graphql-code-line ">removeCouponCodeFromDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, couponCode: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
1265
-
1266
-
1267
- <div class="graphql-code-line top-level">&#125;</div>
1268
- </div>
1269
-
1270
- ## removeCustomersFromGroup
1271
- <div class="graphql-code-block">
1272
- <div class="graphql-code-line top-level comment">"""</div>
1273
- <div class="graphql-code-line top-level comment">Remove Customers from a CustomerGroup</div>
1274
- <div class="graphql-code-line top-level comment">"""</div>
1275
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1276
- <div class="graphql-code-line ">removeCustomersFromGroup(customerGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, customerIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
1277
-
1278
-
1279
- <div class="graphql-code-line top-level">&#125;</div>
1280
- </div>
1281
-
1282
- ## removeDraftOrderLine
1283
- <div class="graphql-code-block">
1284
- <div class="graphql-code-line top-level comment">"""</div>
1285
- <div class="graphql-code-line top-level comment">Remove an OrderLine from the draft Order</div>
1286
- <div class="graphql-code-line top-level comment">"""</div>
1287
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1288
- <div class="graphql-code-line ">removeDraftOrderLine(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, orderLineId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#removeorderitemsresult">RemoveOrderItemsResult</a>!</div>
1289
-
1290
-
1291
- <div class="graphql-code-line top-level">&#125;</div>
1292
- </div>
1293
-
1294
- ## removeFacetsFromChannel
1295
- <div class="graphql-code-block">
1296
- <div class="graphql-code-line top-level comment">"""</div>
1297
- <div class="graphql-code-line top-level comment">Removes Facets from the specified Channel</div>
1298
- <div class="graphql-code-line top-level comment">"""</div>
1299
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1300
- <div class="graphql-code-line ">removeFacetsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removefacetsfromchannelinput">RemoveFacetsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#removefacetfromchannelresult">RemoveFacetFromChannelResult</a>!]!</div>
1301
-
1302
-
1303
- <div class="graphql-code-line top-level">&#125;</div>
1304
- </div>
1305
-
1306
- ## removeMembersFromZone
1307
- <div class="graphql-code-block">
1308
- <div class="graphql-code-line top-level comment">"""</div>
1309
- <div class="graphql-code-line top-level comment">Remove members from a Zone</div>
1310
- <div class="graphql-code-line top-level comment">"""</div>
1311
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1312
- <div class="graphql-code-line ">removeMembersFromZone(zoneId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, memberIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
1313
-
1314
-
1315
- <div class="graphql-code-line top-level">&#125;</div>
1316
- </div>
1317
-
1318
- ## removeOptionGroupFromProduct
1319
- <div class="graphql-code-block">
1320
- <div class="graphql-code-line top-level comment">"""</div>
1321
- <div class="graphql-code-line top-level comment">Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants</div>
1322
-
1323
- <div class="graphql-code-line top-level comment">the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed.</div>
1324
-
1325
- <div class="graphql-code-line top-level comment">Setting the <code>force</code> argument to <code>true</code> will override this and remove the OptionGroup anyway,</div>
1326
-
1327
- <div class="graphql-code-line top-level comment">as well as removing any of the group's options from the Product's ProductVariants.</div>
1328
- <div class="graphql-code-line top-level comment">"""</div>
1329
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1330
- <div class="graphql-code-line ">removeOptionGroupFromProduct(productId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, optionGroupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, force: <a href="/reference/graphql-api/admin/object-types#boolean">Boolean</a>): <a href="/reference/graphql-api/admin/object-types#removeoptiongroupfromproductresult">RemoveOptionGroupFromProductResult</a>!</div>
1331
-
1332
-
1333
- <div class="graphql-code-line top-level">&#125;</div>
1334
- </div>
1335
-
1336
- ## removePaymentMethodsFromChannel
1337
- <div class="graphql-code-block">
1338
- <div class="graphql-code-line top-level comment">"""</div>
1339
- <div class="graphql-code-line top-level comment">Removes PaymentMethods from the specified Channel</div>
1340
- <div class="graphql-code-line top-level comment">"""</div>
1341
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1342
- <div class="graphql-code-line ">removePaymentMethodsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removepaymentmethodsfromchannelinput">RemovePaymentMethodsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!]!</div>
1343
-
1344
-
1345
- <div class="graphql-code-line top-level">&#125;</div>
1346
- </div>
1347
-
1348
- ## removeProductVariantsFromChannel
1349
- <div class="graphql-code-block">
1350
- <div class="graphql-code-line top-level comment">"""</div>
1351
- <div class="graphql-code-line top-level comment">Removes ProductVariants from the specified Channel</div>
1352
- <div class="graphql-code-line top-level comment">"""</div>
1353
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1354
- <div class="graphql-code-line ">removeProductVariantsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removeproductvariantsfromchannelinput">RemoveProductVariantsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!]!</div>
1355
-
1356
-
1357
- <div class="graphql-code-line top-level">&#125;</div>
1358
- </div>
1359
-
1360
- ## removeProductsFromChannel
1361
- <div class="graphql-code-block">
1362
- <div class="graphql-code-line top-level comment">"""</div>
1363
- <div class="graphql-code-line top-level comment">Removes all ProductVariants of Product from the specified Channel</div>
1364
- <div class="graphql-code-line top-level comment">"""</div>
1365
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1366
- <div class="graphql-code-line ">removeProductsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removeproductsfromchannelinput">RemoveProductsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#product">Product</a>!]!</div>
1367
-
1368
-
1369
- <div class="graphql-code-line top-level">&#125;</div>
1370
- </div>
1371
-
1372
- ## removePromotionsFromChannel
1373
- <div class="graphql-code-block">
1374
- <div class="graphql-code-line top-level comment">"""</div>
1375
- <div class="graphql-code-line top-level comment">Removes Promotions from the specified Channel</div>
1376
- <div class="graphql-code-line top-level comment">"""</div>
1377
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1378
- <div class="graphql-code-line ">removePromotionsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removepromotionsfromchannelinput">RemovePromotionsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a>!]!</div>
1379
-
1380
-
1381
- <div class="graphql-code-line top-level">&#125;</div>
1382
- </div>
1383
-
1384
- ## removeSettledJobs
1385
- <div class="graphql-code-block">
1386
- <div class="graphql-code-line top-level comment">"""</div>
1387
- <div class="graphql-code-line top-level comment">Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted.</div>
1388
- <div class="graphql-code-line top-level comment">"""</div>
1389
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1390
- <div class="graphql-code-line ">removeSettledJobs(queueNames: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!], olderThan: <a href="/reference/graphql-api/admin/object-types#datetime">DateTime</a>): <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
1391
-
1392
-
1393
- <div class="graphql-code-line top-level">&#125;</div>
1394
- </div>
1395
-
1396
- ## removeShippingMethodsFromChannel
1397
- <div class="graphql-code-block">
1398
- <div class="graphql-code-line top-level comment">"""</div>
1399
- <div class="graphql-code-line top-level comment">Removes ShippingMethods from the specified Channel</div>
1400
- <div class="graphql-code-line top-level comment">"""</div>
1401
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1402
- <div class="graphql-code-line ">removeShippingMethodsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removeshippingmethodsfromchannelinput">RemoveShippingMethodsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!]!</div>
1403
-
1404
-
1405
- <div class="graphql-code-line top-level">&#125;</div>
1406
- </div>
1407
-
1408
- ## removeStockLocationsFromChannel
1409
- <div class="graphql-code-block">
1410
- <div class="graphql-code-line top-level comment">"""</div>
1411
- <div class="graphql-code-line top-level comment">Removes StockLocations from the specified Channel</div>
1412
- <div class="graphql-code-line top-level comment">"""</div>
1413
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1414
- <div class="graphql-code-line ">removeStockLocationsFromChannel(input: <a href="/reference/graphql-api/admin/input-types#removestocklocationsfromchannelinput">RemoveStockLocationsFromChannelInput</a>!): [<a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!]!</div>
1415
-
1416
-
1417
- <div class="graphql-code-line top-level">&#125;</div>
1418
- </div>
1419
-
1420
- ## runPendingSearchIndexUpdates
1421
- <div class="graphql-code-block">
1422
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1423
- <div class="graphql-code-line ">runPendingSearchIndexUpdates: <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
1424
-
1425
-
1426
- <div class="graphql-code-line top-level">&#125;</div>
1427
- </div>
1428
-
1429
- ## runScheduledTask
1430
- <div class="graphql-code-block">
1431
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1432
- <div class="graphql-code-line ">runScheduledTask(id: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#success">Success</a>!</div>
1433
-
1434
-
1435
- <div class="graphql-code-line top-level">&#125;</div>
1436
- </div>
1437
-
1438
- ## setCustomerForDraftOrder
1439
- <div class="graphql-code-block">
1440
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1441
- <div class="graphql-code-line ">setCustomerForDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, customerId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>, input: <a href="/reference/graphql-api/admin/input-types#createcustomerinput">CreateCustomerInput</a>): <a href="/reference/graphql-api/admin/object-types#setcustomerfordraftorderresult">SetCustomerForDraftOrderResult</a>!</div>
1442
-
1443
-
1444
- <div class="graphql-code-line top-level">&#125;</div>
1445
- </div>
1446
-
1447
- ## setDraftOrderBillingAddress
1448
- <div class="graphql-code-block">
1449
- <div class="graphql-code-line top-level comment">"""</div>
1450
- <div class="graphql-code-line top-level comment">Sets the billing address for a draft Order</div>
1451
- <div class="graphql-code-line top-level comment">"""</div>
1452
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1453
- <div class="graphql-code-line ">setDraftOrderBillingAddress(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
1454
-
1455
-
1456
- <div class="graphql-code-line top-level">&#125;</div>
1457
- </div>
1458
-
1459
- ## setDraftOrderCustomFields
1460
- <div class="graphql-code-block">
1461
- <div class="graphql-code-line top-level comment">"""</div>
1462
- <div class="graphql-code-line top-level comment">Allows any custom fields to be set for the active order</div>
1463
- <div class="graphql-code-line top-level comment">"""</div>
1464
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1465
- <div class="graphql-code-line ">setDraftOrderCustomFields(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#updateorderinput">UpdateOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
1466
-
1467
-
1468
- <div class="graphql-code-line top-level">&#125;</div>
1469
- </div>
1470
-
1471
- ## setDraftOrderShippingAddress
1472
- <div class="graphql-code-block">
1473
- <div class="graphql-code-line top-level comment">"""</div>
1474
- <div class="graphql-code-line top-level comment">Sets the shipping address for a draft Order</div>
1475
- <div class="graphql-code-line top-level comment">"""</div>
1476
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1477
- <div class="graphql-code-line ">setDraftOrderShippingAddress(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, input: <a href="/reference/graphql-api/admin/input-types#createaddressinput">CreateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
1478
-
1479
-
1480
- <div class="graphql-code-line top-level">&#125;</div>
1481
- </div>
1482
-
1483
- ## setDraftOrderShippingMethod
1484
- <div class="graphql-code-block">
1485
- <div class="graphql-code-line top-level comment">"""</div>
1486
- <div class="graphql-code-line top-level comment">Sets the shipping method by id, which can be obtained with the <code>eligibleShippingMethodsForDraftOrder</code> query</div>
1487
- <div class="graphql-code-line top-level comment">"""</div>
1488
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1489
- <div class="graphql-code-line ">setDraftOrderShippingMethod(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, shippingMethodId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#setordershippingmethodresult">SetOrderShippingMethodResult</a>!</div>
1490
-
1491
-
1492
- <div class="graphql-code-line top-level">&#125;</div>
1493
- </div>
1494
-
1495
- ## setOrderCustomFields
1496
- <div class="graphql-code-block">
1497
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1498
- <div class="graphql-code-line ">setOrderCustomFields(input: <a href="/reference/graphql-api/admin/input-types#updateorderinput">UpdateOrderInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
1499
-
1500
-
1501
- <div class="graphql-code-line top-level">&#125;</div>
1502
- </div>
1503
-
1504
- ## setOrderCustomer
1505
- <div class="graphql-code-block">
1506
- <div class="graphql-code-line top-level comment">"""</div>
1507
- <div class="graphql-code-line top-level comment">Allows a different Customer to be assigned to an Order. Added in v2.2.0.</div>
1508
- <div class="graphql-code-line top-level comment">"""</div>
1509
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1510
- <div class="graphql-code-line ">setOrderCustomer(input: <a href="/reference/graphql-api/admin/input-types#setordercustomerinput">SetOrderCustomerInput</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
1511
-
1512
-
1513
- <div class="graphql-code-line top-level">&#125;</div>
1514
- </div>
1515
-
1516
- ## setSettingsStoreValue
1517
- <div class="graphql-code-block">
1518
- <div class="graphql-code-line top-level comment">"""</div>
1519
- <div class="graphql-code-line top-level comment">Set a single key-value pair (automatically scoped based on field configuration)</div>
1520
- <div class="graphql-code-line top-level comment">"""</div>
1521
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1522
- <div class="graphql-code-line ">setSettingsStoreValue(input: <a href="/reference/graphql-api/admin/input-types#settingsstoreinput">SettingsStoreInput</a>!): <a href="/reference/graphql-api/admin/object-types#setsettingsstorevalueresult">SetSettingsStoreValueResult</a>!</div>
1523
-
1524
-
1525
- <div class="graphql-code-line top-level">&#125;</div>
1526
- </div>
1527
-
1528
- ## setSettingsStoreValues
1529
- <div class="graphql-code-block">
1530
- <div class="graphql-code-line top-level comment">"""</div>
1531
- <div class="graphql-code-line top-level comment">Set multiple key-value pairs in a transaction (each automatically scoped)</div>
1532
- <div class="graphql-code-line top-level comment">"""</div>
1533
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1534
- <div class="graphql-code-line ">setSettingsStoreValues(inputs: [<a href="/reference/graphql-api/admin/input-types#settingsstoreinput">SettingsStoreInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#setsettingsstorevalueresult">SetSettingsStoreValueResult</a>!]!</div>
1535
-
1536
-
1537
- <div class="graphql-code-line top-level">&#125;</div>
1538
- </div>
1539
-
1540
- ## settlePayment
1541
- <div class="graphql-code-block">
1542
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1543
- <div class="graphql-code-line ">settlePayment(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#settlepaymentresult">SettlePaymentResult</a>!</div>
1544
-
1545
-
1546
- <div class="graphql-code-line top-level">&#125;</div>
1547
- </div>
1548
-
1549
- ## settleRefund
1550
- <div class="graphql-code-block">
1551
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1552
- <div class="graphql-code-line ">settleRefund(input: <a href="/reference/graphql-api/admin/input-types#settlerefundinput">SettleRefundInput</a>!): <a href="/reference/graphql-api/admin/object-types#settlerefundresult">SettleRefundResult</a>!</div>
1553
-
1554
-
1555
- <div class="graphql-code-line top-level">&#125;</div>
1556
- </div>
1557
-
1558
- ## transitionFulfillmentToState
1559
- <div class="graphql-code-block">
1560
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1561
- <div class="graphql-code-line ">transitionFulfillmentToState(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#transitionfulfillmenttostateresult">TransitionFulfillmentToStateResult</a>!</div>
1562
-
1563
-
1564
- <div class="graphql-code-line top-level">&#125;</div>
1565
- </div>
1566
-
1567
- ## transitionOrderToState
1568
- <div class="graphql-code-block">
1569
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1570
- <div class="graphql-code-line ">transitionOrderToState(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#transitionordertostateresult">TransitionOrderToStateResult</a></div>
1571
-
1572
-
1573
- <div class="graphql-code-line top-level">&#125;</div>
1574
- </div>
1575
-
1576
- ## transitionPaymentToState
1577
- <div class="graphql-code-block">
1578
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1579
- <div class="graphql-code-line ">transitionPaymentToState(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!, state: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#transitionpaymenttostateresult">TransitionPaymentToStateResult</a>!</div>
1580
-
1581
-
1582
- <div class="graphql-code-line top-level">&#125;</div>
1583
- </div>
1584
-
1585
- ## unsetDraftOrderBillingAddress
1586
- <div class="graphql-code-block">
1587
- <div class="graphql-code-line top-level comment">"""</div>
1588
- <div class="graphql-code-line top-level comment">Unsets the billing address for a draft Order</div>
1589
- <div class="graphql-code-line top-level comment">"""</div>
1590
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1591
- <div class="graphql-code-line ">unsetDraftOrderBillingAddress(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
1592
-
1593
-
1594
- <div class="graphql-code-line top-level">&#125;</div>
1595
- </div>
1596
-
1597
- ## unsetDraftOrderShippingAddress
1598
- <div class="graphql-code-block">
1599
- <div class="graphql-code-line top-level comment">"""</div>
1600
- <div class="graphql-code-line top-level comment">Unsets the shipping address for a draft Order</div>
1601
- <div class="graphql-code-line top-level comment">"""</div>
1602
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1603
- <div class="graphql-code-line ">unsetDraftOrderShippingAddress(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a>!</div>
1604
-
1605
-
1606
- <div class="graphql-code-line top-level">&#125;</div>
1607
- </div>
1608
-
1609
- ## updateActiveAdministrator
1610
- <div class="graphql-code-block">
1611
- <div class="graphql-code-line top-level comment">"""</div>
1612
- <div class="graphql-code-line top-level comment">Update the active (currently logged-in) Administrator</div>
1613
- <div class="graphql-code-line top-level comment">"""</div>
1614
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1615
- <div class="graphql-code-line ">updateActiveAdministrator(input: <a href="/reference/graphql-api/admin/input-types#updateactiveadministratorinput">UpdateActiveAdministratorInput</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
1616
-
1617
-
1618
- <div class="graphql-code-line top-level">&#125;</div>
1619
- </div>
1620
-
1621
- ## updateAdministrator
1622
- <div class="graphql-code-block">
1623
- <div class="graphql-code-line top-level comment">"""</div>
1624
- <div class="graphql-code-line top-level comment">Update an existing Administrator</div>
1625
- <div class="graphql-code-line top-level comment">"""</div>
1626
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1627
- <div class="graphql-code-line ">updateAdministrator(input: <a href="/reference/graphql-api/admin/input-types#updateadministratorinput">UpdateAdministratorInput</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a>!</div>
1628
-
1629
-
1630
- <div class="graphql-code-line top-level">&#125;</div>
1631
- </div>
1632
-
1633
- ## updateAsset
1634
- <div class="graphql-code-block">
1635
- <div class="graphql-code-line top-level comment">"""</div>
1636
- <div class="graphql-code-line top-level comment">Update an existing Asset</div>
1637
- <div class="graphql-code-line top-level comment">"""</div>
1638
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1639
- <div class="graphql-code-line ">updateAsset(input: <a href="/reference/graphql-api/admin/input-types#updateassetinput">UpdateAssetInput</a>!): <a href="/reference/graphql-api/admin/object-types#asset">Asset</a>!</div>
1640
-
1641
-
1642
- <div class="graphql-code-line top-level">&#125;</div>
1643
- </div>
1644
-
1645
- ## updateChannel
1646
- <div class="graphql-code-block">
1647
- <div class="graphql-code-line top-level comment">"""</div>
1648
- <div class="graphql-code-line top-level comment">Update an existing Channel</div>
1649
- <div class="graphql-code-line top-level comment">"""</div>
1650
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1651
- <div class="graphql-code-line ">updateChannel(input: <a href="/reference/graphql-api/admin/input-types#updatechannelinput">UpdateChannelInput</a>!): <a href="/reference/graphql-api/admin/object-types#updatechannelresult">UpdateChannelResult</a>!</div>
1652
-
1653
-
1654
- <div class="graphql-code-line top-level">&#125;</div>
1655
- </div>
1656
-
1657
- ## updateCollection
1658
- <div class="graphql-code-block">
1659
- <div class="graphql-code-line top-level comment">"""</div>
1660
- <div class="graphql-code-line top-level comment">Update an existing Collection</div>
1661
- <div class="graphql-code-line top-level comment">"""</div>
1662
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1663
- <div class="graphql-code-line ">updateCollection(input: <a href="/reference/graphql-api/admin/input-types#updatecollectioninput">UpdateCollectionInput</a>!): <a href="/reference/graphql-api/admin/object-types#collection">Collection</a>!</div>
1664
-
1665
-
1666
- <div class="graphql-code-line top-level">&#125;</div>
1667
- </div>
1668
-
1669
- ## updateCountry
1670
- <div class="graphql-code-block">
1671
- <div class="graphql-code-line top-level comment">"""</div>
1672
- <div class="graphql-code-line top-level comment">Update an existing Country</div>
1673
- <div class="graphql-code-line top-level comment">"""</div>
1674
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1675
- <div class="graphql-code-line ">updateCountry(input: <a href="/reference/graphql-api/admin/input-types#updatecountryinput">UpdateCountryInput</a>!): <a href="/reference/graphql-api/admin/object-types#country">Country</a>!</div>
1676
-
1677
-
1678
- <div class="graphql-code-line top-level">&#125;</div>
1679
- </div>
1680
-
1681
- ## updateCustomer
1682
- <div class="graphql-code-block">
1683
- <div class="graphql-code-line top-level comment">"""</div>
1684
- <div class="graphql-code-line top-level comment">Update an existing Customer</div>
1685
- <div class="graphql-code-line top-level comment">"""</div>
1686
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1687
- <div class="graphql-code-line ">updateCustomer(input: <a href="/reference/graphql-api/admin/input-types#updatecustomerinput">UpdateCustomerInput</a>!): <a href="/reference/graphql-api/admin/object-types#updatecustomerresult">UpdateCustomerResult</a>!</div>
1688
-
1689
-
1690
- <div class="graphql-code-line top-level">&#125;</div>
1691
- </div>
1692
-
1693
- ## updateCustomerAddress
1694
- <div class="graphql-code-block">
1695
- <div class="graphql-code-line top-level comment">"""</div>
1696
- <div class="graphql-code-line top-level comment">Update an existing Address</div>
1697
- <div class="graphql-code-line top-level comment">"""</div>
1698
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1699
- <div class="graphql-code-line ">updateCustomerAddress(input: <a href="/reference/graphql-api/admin/input-types#updateaddressinput">UpdateAddressInput</a>!): <a href="/reference/graphql-api/admin/object-types#address">Address</a>!</div>
1700
-
1701
-
1702
- <div class="graphql-code-line top-level">&#125;</div>
1703
- </div>
1704
-
1705
- ## updateCustomerGroup
1706
- <div class="graphql-code-block">
1707
- <div class="graphql-code-line top-level comment">"""</div>
1708
- <div class="graphql-code-line top-level comment">Update an existing CustomerGroup</div>
1709
- <div class="graphql-code-line top-level comment">"""</div>
1710
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1711
- <div class="graphql-code-line ">updateCustomerGroup(input: <a href="/reference/graphql-api/admin/input-types#updatecustomergroupinput">UpdateCustomerGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a>!</div>
1712
-
1713
-
1714
- <div class="graphql-code-line top-level">&#125;</div>
1715
- </div>
1716
-
1717
- ## updateCustomerNote
1718
- <div class="graphql-code-block">
1719
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1720
- <div class="graphql-code-line ">updateCustomerNote(input: <a href="/reference/graphql-api/admin/input-types#updatecustomernoteinput">UpdateCustomerNoteInput</a>!): <a href="/reference/graphql-api/admin/object-types#historyentry">HistoryEntry</a>!</div>
1721
-
1722
-
1723
- <div class="graphql-code-line top-level">&#125;</div>
1724
- </div>
1725
-
1726
- ## updateFacet
1727
- <div class="graphql-code-block">
1728
- <div class="graphql-code-line top-level comment">"""</div>
1729
- <div class="graphql-code-line top-level comment">Update an existing Facet</div>
1730
- <div class="graphql-code-line top-level comment">"""</div>
1731
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1732
- <div class="graphql-code-line ">updateFacet(input: <a href="/reference/graphql-api/admin/input-types#updatefacetinput">UpdateFacetInput</a>!): <a href="/reference/graphql-api/admin/object-types#facet">Facet</a>!</div>
1733
-
1734
-
1735
- <div class="graphql-code-line top-level">&#125;</div>
1736
- </div>
1737
-
1738
- ## updateFacetValue
1739
- <div class="graphql-code-block">
1740
- <div class="graphql-code-line top-level comment">"""</div>
1741
- <div class="graphql-code-line top-level comment">Update a single FacetValue</div>
1742
- <div class="graphql-code-line top-level comment">"""</div>
1743
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1744
- <div class="graphql-code-line ">updateFacetValue(input: <a href="/reference/graphql-api/admin/input-types#updatefacetvalueinput">UpdateFacetValueInput</a>!): <a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!</div>
1745
-
1746
-
1747
- <div class="graphql-code-line top-level">&#125;</div>
1748
- </div>
1749
-
1750
- ## updateFacetValues
1751
- <div class="graphql-code-block">
1752
- <div class="graphql-code-line top-level comment">"""</div>
1753
- <div class="graphql-code-line top-level comment">Update one or more FacetValues</div>
1754
- <div class="graphql-code-line top-level comment">"""</div>
1755
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1756
- <div class="graphql-code-line ">updateFacetValues(input: [<a href="/reference/graphql-api/admin/input-types#updatefacetvalueinput">UpdateFacetValueInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a>!]!</div>
1757
-
1758
-
1759
- <div class="graphql-code-line top-level">&#125;</div>
1760
- </div>
1761
-
1762
- ## updateGlobalSettings
1763
- <div class="graphql-code-block">
1764
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1765
- <div class="graphql-code-line ">updateGlobalSettings(input: <a href="/reference/graphql-api/admin/input-types#updateglobalsettingsinput">UpdateGlobalSettingsInput</a>!): <a href="/reference/graphql-api/admin/object-types#updateglobalsettingsresult">UpdateGlobalSettingsResult</a>!</div>
1766
-
1767
-
1768
- <div class="graphql-code-line top-level">&#125;</div>
1769
- </div>
1770
-
1771
- ## updateOrderNote
1772
- <div class="graphql-code-block">
1773
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1774
- <div class="graphql-code-line ">updateOrderNote(input: <a href="/reference/graphql-api/admin/input-types#updateordernoteinput">UpdateOrderNoteInput</a>!): <a href="/reference/graphql-api/admin/object-types#historyentry">HistoryEntry</a>!</div>
1775
-
1776
-
1777
- <div class="graphql-code-line top-level">&#125;</div>
1778
- </div>
1779
-
1780
- ## updatePaymentMethod
1781
- <div class="graphql-code-block">
1782
- <div class="graphql-code-line top-level comment">"""</div>
1783
- <div class="graphql-code-line top-level comment">Update an existing PaymentMethod</div>
1784
- <div class="graphql-code-line top-level comment">"""</div>
1785
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1786
- <div class="graphql-code-line ">updatePaymentMethod(input: <a href="/reference/graphql-api/admin/input-types#updatepaymentmethodinput">UpdatePaymentMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a>!</div>
1787
-
1788
-
1789
- <div class="graphql-code-line top-level">&#125;</div>
1790
- </div>
1791
-
1792
- ## updateProduct
1793
- <div class="graphql-code-block">
1794
- <div class="graphql-code-line top-level comment">"""</div>
1795
- <div class="graphql-code-line top-level comment">Update an existing Product</div>
1796
- <div class="graphql-code-line top-level comment">"""</div>
1797
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1798
- <div class="graphql-code-line ">updateProduct(input: <a href="/reference/graphql-api/admin/input-types#updateproductinput">UpdateProductInput</a>!): <a href="/reference/graphql-api/admin/object-types#product">Product</a>!</div>
1799
-
1800
-
1801
- <div class="graphql-code-line top-level">&#125;</div>
1802
- </div>
1803
-
1804
- ## updateProductOption
1805
- <div class="graphql-code-block">
1806
- <div class="graphql-code-line top-level comment">"""</div>
1807
- <div class="graphql-code-line top-level comment">Create a new ProductOption within a ProductOptionGroup</div>
1808
- <div class="graphql-code-line top-level comment">"""</div>
1809
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1810
- <div class="graphql-code-line ">updateProductOption(input: <a href="/reference/graphql-api/admin/input-types#updateproductoptioninput">UpdateProductOptionInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoption">ProductOption</a>!</div>
1811
-
1812
-
1813
- <div class="graphql-code-line top-level">&#125;</div>
1814
- </div>
1815
-
1816
- ## updateProductOptionGroup
1817
- <div class="graphql-code-block">
1818
- <div class="graphql-code-line top-level comment">"""</div>
1819
- <div class="graphql-code-line top-level comment">Update an existing ProductOptionGroup</div>
1820
- <div class="graphql-code-line top-level comment">"""</div>
1821
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1822
- <div class="graphql-code-line ">updateProductOptionGroup(input: <a href="/reference/graphql-api/admin/input-types#updateproductoptiongroupinput">UpdateProductOptionGroupInput</a>!): <a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a>!</div>
1823
-
1824
-
1825
- <div class="graphql-code-line top-level">&#125;</div>
1826
- </div>
1827
-
1828
- ## updateProductVariant
1829
- <div class="graphql-code-block">
1830
- <div class="graphql-code-line top-level comment">"""</div>
1831
- <div class="graphql-code-line top-level comment">Update an existing ProductVariant</div>
1832
- <div class="graphql-code-line top-level comment">"""</div>
1833
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1834
- <div class="graphql-code-line ">updateProductVariant(input: <a href="/reference/graphql-api/admin/input-types#updateproductvariantinput">UpdateProductVariantInput</a>!): <a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>!</div>
1835
-
1836
-
1837
- <div class="graphql-code-line top-level">&#125;</div>
1838
- </div>
1839
-
1840
- ## updateProductVariants
1841
- <div class="graphql-code-block">
1842
- <div class="graphql-code-line top-level comment">"""</div>
1843
- <div class="graphql-code-line top-level comment">Update existing ProductVariants</div>
1844
- <div class="graphql-code-line top-level comment">"""</div>
1845
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1846
- <div class="graphql-code-line ">updateProductVariants(input: [<a href="/reference/graphql-api/admin/input-types#updateproductvariantinput">UpdateProductVariantInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a>]!</div>
1847
-
1848
-
1849
- <div class="graphql-code-line top-level">&#125;</div>
1850
- </div>
1851
-
1852
- ## updateProducts
1853
- <div class="graphql-code-block">
1854
- <div class="graphql-code-line top-level comment">"""</div>
1855
- <div class="graphql-code-line top-level comment">Update multiple existing Products</div>
1856
- <div class="graphql-code-line top-level comment">"""</div>
1857
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1858
- <div class="graphql-code-line ">updateProducts(input: [<a href="/reference/graphql-api/admin/input-types#updateproductinput">UpdateProductInput</a>!]!): [<a href="/reference/graphql-api/admin/object-types#product">Product</a>!]!</div>
1859
-
1860
-
1861
- <div class="graphql-code-line top-level">&#125;</div>
1862
- </div>
1863
-
1864
- ## updatePromotion
1865
- <div class="graphql-code-block">
1866
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1867
- <div class="graphql-code-line ">updatePromotion(input: <a href="/reference/graphql-api/admin/input-types#updatepromotioninput">UpdatePromotionInput</a>!): <a href="/reference/graphql-api/admin/object-types#updatepromotionresult">UpdatePromotionResult</a>!</div>
1868
-
1869
-
1870
- <div class="graphql-code-line top-level">&#125;</div>
1871
- </div>
1872
-
1873
- ## updateProvince
1874
- <div class="graphql-code-block">
1875
- <div class="graphql-code-line top-level comment">"""</div>
1876
- <div class="graphql-code-line top-level comment">Update an existing Province</div>
1877
- <div class="graphql-code-line top-level comment">"""</div>
1878
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1879
- <div class="graphql-code-line ">updateProvince(input: <a href="/reference/graphql-api/admin/input-types#updateprovinceinput">UpdateProvinceInput</a>!): <a href="/reference/graphql-api/admin/object-types#province">Province</a>!</div>
1880
-
1881
-
1882
- <div class="graphql-code-line top-level">&#125;</div>
1883
- </div>
1884
-
1885
- ## updateRole
1886
- <div class="graphql-code-block">
1887
- <div class="graphql-code-line top-level comment">"""</div>
1888
- <div class="graphql-code-line top-level comment">Update an existing Role</div>
1889
- <div class="graphql-code-line top-level comment">"""</div>
1890
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1891
- <div class="graphql-code-line ">updateRole(input: <a href="/reference/graphql-api/admin/input-types#updateroleinput">UpdateRoleInput</a>!): <a href="/reference/graphql-api/admin/object-types#role">Role</a>!</div>
1892
-
1893
-
1894
- <div class="graphql-code-line top-level">&#125;</div>
1895
- </div>
1896
-
1897
- ## updateScheduledTask
1898
- <div class="graphql-code-block">
1899
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1900
- <div class="graphql-code-line ">updateScheduledTask(input: <a href="/reference/graphql-api/admin/input-types#updatescheduledtaskinput">UpdateScheduledTaskInput</a>!): <a href="/reference/graphql-api/admin/object-types#scheduledtask">ScheduledTask</a>!</div>
1901
-
1902
-
1903
- <div class="graphql-code-line top-level">&#125;</div>
1904
- </div>
1905
-
1906
- ## updateSeller
1907
- <div class="graphql-code-block">
1908
- <div class="graphql-code-line top-level comment">"""</div>
1909
- <div class="graphql-code-line top-level comment">Update an existing Seller</div>
1910
- <div class="graphql-code-line top-level comment">"""</div>
1911
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1912
- <div class="graphql-code-line ">updateSeller(input: <a href="/reference/graphql-api/admin/input-types#updatesellerinput">UpdateSellerInput</a>!): <a href="/reference/graphql-api/admin/object-types#seller">Seller</a>!</div>
1913
-
1914
-
1915
- <div class="graphql-code-line top-level">&#125;</div>
1916
- </div>
1917
-
1918
- ## updateShippingMethod
1919
- <div class="graphql-code-block">
1920
- <div class="graphql-code-line top-level comment">"""</div>
1921
- <div class="graphql-code-line top-level comment">Update an existing ShippingMethod</div>
1922
- <div class="graphql-code-line top-level comment">"""</div>
1923
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1924
- <div class="graphql-code-line ">updateShippingMethod(input: <a href="/reference/graphql-api/admin/input-types#updateshippingmethodinput">UpdateShippingMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a>!</div>
1925
-
1926
-
1927
- <div class="graphql-code-line top-level">&#125;</div>
1928
- </div>
1929
-
1930
- ## updateStockLocation
1931
- <div class="graphql-code-block">
1932
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1933
- <div class="graphql-code-line ">updateStockLocation(input: <a href="/reference/graphql-api/admin/input-types#updatestocklocationinput">UpdateStockLocationInput</a>!): <a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a>!</div>
1934
-
1935
-
1936
- <div class="graphql-code-line top-level">&#125;</div>
1937
- </div>
1938
-
1939
- ## updateTag
1940
- <div class="graphql-code-block">
1941
- <div class="graphql-code-line top-level comment">"""</div>
1942
- <div class="graphql-code-line top-level comment">Update an existing Tag</div>
1943
- <div class="graphql-code-line top-level comment">"""</div>
1944
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1945
- <div class="graphql-code-line ">updateTag(input: <a href="/reference/graphql-api/admin/input-types#updatetaginput">UpdateTagInput</a>!): <a href="/reference/graphql-api/admin/object-types#tag">Tag</a>!</div>
1946
-
1947
-
1948
- <div class="graphql-code-line top-level">&#125;</div>
1949
- </div>
1950
-
1951
- ## updateTaxCategory
1952
- <div class="graphql-code-block">
1953
- <div class="graphql-code-line top-level comment">"""</div>
1954
- <div class="graphql-code-line top-level comment">Update an existing TaxCategory</div>
1955
- <div class="graphql-code-line top-level comment">"""</div>
1956
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1957
- <div class="graphql-code-line ">updateTaxCategory(input: <a href="/reference/graphql-api/admin/input-types#updatetaxcategoryinput">UpdateTaxCategoryInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxcategory">TaxCategory</a>!</div>
1958
-
1959
-
1960
- <div class="graphql-code-line top-level">&#125;</div>
1961
- </div>
1962
-
1963
- ## updateTaxRate
1964
- <div class="graphql-code-block">
1965
- <div class="graphql-code-line top-level comment">"""</div>
1966
- <div class="graphql-code-line top-level comment">Update an existing TaxRate</div>
1967
- <div class="graphql-code-line top-level comment">"""</div>
1968
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1969
- <div class="graphql-code-line ">updateTaxRate(input: <a href="/reference/graphql-api/admin/input-types#updatetaxrateinput">UpdateTaxRateInput</a>!): <a href="/reference/graphql-api/admin/object-types#taxrate">TaxRate</a>!</div>
1970
-
1971
-
1972
- <div class="graphql-code-line top-level">&#125;</div>
1973
- </div>
1974
-
1975
- ## updateZone
1976
- <div class="graphql-code-block">
1977
- <div class="graphql-code-line top-level comment">"""</div>
1978
- <div class="graphql-code-line top-level comment">Update an existing Zone</div>
1979
- <div class="graphql-code-line top-level comment">"""</div>
1980
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Mutation</span> &#123;</div>
1981
- <div class="graphql-code-line ">updateZone(input: <a href="/reference/graphql-api/admin/input-types#updatezoneinput">UpdateZoneInput</a>!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a>!</div>
1982
-
1983
-
1984
- <div class="graphql-code-line top-level">&#125;</div>
1985
- </div>
8
+ ## addCustomersToGroup {#addcustomerstogroup}
9
+
10
+ <GraphQLDoc
11
+ type="mutation"
12
+ typeName="addCustomersToGroup"
13
+ typeLinks={{
14
+ CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
15
+ ID: '/reference/graphql-api/admin/object-types#id',
16
+ }}
17
+ >
18
+ {`"""Add Customers to a CustomerGroup"""
19
+ type Mutation {
20
+ addCustomersToGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup!
21
+ }`}
22
+ </GraphQLDoc>
23
+
24
+ ## addFulfillmentToOrder {#addfulfillmenttoorder}
25
+
26
+ <GraphQLDoc
27
+ type="mutation"
28
+ typeName="addFulfillmentToOrder"
29
+ typeLinks={{
30
+ AddFulfillmentToOrderResult: '/reference/graphql-api/admin/object-types#addfulfillmenttoorderresult',
31
+ FulfillOrderInput: '/reference/graphql-api/admin/input-types#fulfillorderinput',
32
+ }}
33
+ >
34
+ {`type Mutation {
35
+ addFulfillmentToOrder(input: FulfillOrderInput!): AddFulfillmentToOrderResult!
36
+ }`}
37
+ </GraphQLDoc>
38
+
39
+ ## addItemToDraftOrder {#additemtodraftorder}
40
+
41
+ <GraphQLDoc
42
+ type="mutation"
43
+ typeName="addItemToDraftOrder"
44
+ typeLinks={{
45
+ UpdateOrderItemsResult: '/reference/graphql-api/admin/object-types#updateorderitemsresult',
46
+ ID: '/reference/graphql-api/admin/object-types#id',
47
+ AddItemToDraftOrderInput: '/reference/graphql-api/admin/input-types#additemtodraftorderinput',
48
+ }}
49
+ >
50
+ {`"""Adds an item to the draft Order."""
51
+ type Mutation {
52
+ addItemToDraftOrder(orderId: ID!, input: AddItemToDraftOrderInput!): UpdateOrderItemsResult!
53
+ }`}
54
+ </GraphQLDoc>
55
+
56
+ ## addManualPaymentToOrder {#addmanualpaymenttoorder}
57
+
58
+ <GraphQLDoc
59
+ type="mutation"
60
+ typeName="addManualPaymentToOrder"
61
+ typeLinks={{
62
+ AddManualPaymentToOrderResult: '/reference/graphql-api/admin/object-types#addmanualpaymenttoorderresult',
63
+ ManualPaymentInput: '/reference/graphql-api/admin/input-types#manualpaymentinput',
64
+ }}
65
+ >
66
+ {`"""
67
+ Used to manually create a new Payment against an Order.
68
+ This can be used by an Administrator when an Order is in the ArrangingPayment state.
69
+
70
+ It is also used when a completed Order
71
+ has been modified (using \`modifyOrder\`) and the price has increased. The extra payment
72
+ can then be manually arranged by the administrator, and the details used to create a new
73
+ Payment.
74
+ """
75
+ type Mutation {
76
+ addManualPaymentToOrder(input: ManualPaymentInput!): AddManualPaymentToOrderResult!
77
+ }`}
78
+ </GraphQLDoc>
79
+
80
+ ## addMembersToZone {#addmemberstozone}
81
+
82
+ <GraphQLDoc
83
+ type="mutation"
84
+ typeName="addMembersToZone"
85
+ typeLinks={{
86
+ Zone: '/reference/graphql-api/admin/object-types#zone',
87
+ ID: '/reference/graphql-api/admin/object-types#id',
88
+ }}
89
+ >
90
+ {`"""Add members to a Zone"""
91
+ type Mutation {
92
+ addMembersToZone(zoneId: ID!, memberIds: [ID!]!): Zone!
93
+ }`}
94
+ </GraphQLDoc>
95
+
96
+ ## addNoteToCustomer {#addnotetocustomer}
97
+
98
+ <GraphQLDoc
99
+ type="mutation"
100
+ typeName="addNoteToCustomer"
101
+ typeLinks={{
102
+ Customer: '/reference/graphql-api/admin/object-types#customer',
103
+ AddNoteToCustomerInput: '/reference/graphql-api/admin/input-types#addnotetocustomerinput',
104
+ }}
105
+ >
106
+ {`type Mutation {
107
+ addNoteToCustomer(input: AddNoteToCustomerInput!): Customer!
108
+ }`}
109
+ </GraphQLDoc>
110
+
111
+ ## addNoteToOrder {#addnotetoorder}
112
+
113
+ <GraphQLDoc
114
+ type="mutation"
115
+ typeName="addNoteToOrder"
116
+ typeLinks={{
117
+ Order: '/reference/graphql-api/admin/object-types#order',
118
+ AddNoteToOrderInput: '/reference/graphql-api/admin/input-types#addnotetoorderinput',
119
+ }}
120
+ >
121
+ {`type Mutation {
122
+ addNoteToOrder(input: AddNoteToOrderInput!): Order!
123
+ }`}
124
+ </GraphQLDoc>
125
+
126
+ ## addOptionGroupToProduct {#addoptiongrouptoproduct}
127
+
128
+ <GraphQLDoc
129
+ type="mutation"
130
+ typeName="addOptionGroupToProduct"
131
+ typeLinks={{
132
+ Product: '/reference/graphql-api/admin/object-types#product',
133
+ ID: '/reference/graphql-api/admin/object-types#id',
134
+ }}
135
+ >
136
+ {`"""Add an OptionGroup to a Product"""
137
+ type Mutation {
138
+ addOptionGroupToProduct(productId: ID!, optionGroupId: ID!): Product!
139
+ }`}
140
+ </GraphQLDoc>
141
+
142
+ ## adjustDraftOrderLine {#adjustdraftorderline}
143
+
144
+ <GraphQLDoc
145
+ type="mutation"
146
+ typeName="adjustDraftOrderLine"
147
+ typeLinks={{
148
+ UpdateOrderItemsResult: '/reference/graphql-api/admin/object-types#updateorderitemsresult',
149
+ ID: '/reference/graphql-api/admin/object-types#id',
150
+ AdjustDraftOrderLineInput: '/reference/graphql-api/admin/input-types#adjustdraftorderlineinput',
151
+ }}
152
+ >
153
+ {`"""Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type \`OrderLineCustomFieldsInput\` will be available."""
154
+ type Mutation {
155
+ adjustDraftOrderLine(orderId: ID!, input: AdjustDraftOrderLineInput!): UpdateOrderItemsResult!
156
+ }`}
157
+ </GraphQLDoc>
158
+
159
+ ## applyCouponCodeToDraftOrder {#applycouponcodetodraftorder}
160
+
161
+ <GraphQLDoc
162
+ type="mutation"
163
+ typeName="applyCouponCodeToDraftOrder"
164
+ typeLinks={{
165
+ ApplyCouponCodeResult: '/reference/graphql-api/admin/object-types#applycouponcoderesult',
166
+ ID: '/reference/graphql-api/admin/object-types#id',
167
+ String: '/reference/graphql-api/admin/object-types#string',
168
+ }}
169
+ >
170
+ {`"""Applies the given coupon code to the draft Order"""
171
+ type Mutation {
172
+ applyCouponCodeToDraftOrder(orderId: ID!, couponCode: String!): ApplyCouponCodeResult!
173
+ }`}
174
+ </GraphQLDoc>
175
+
176
+ ## assignAssetsToChannel {#assignassetstochannel}
177
+
178
+ <GraphQLDoc
179
+ type="mutation"
180
+ typeName="assignAssetsToChannel"
181
+ typeLinks={{
182
+ Asset: '/reference/graphql-api/admin/object-types#asset',
183
+ AssignAssetsToChannelInput: '/reference/graphql-api/admin/input-types#assignassetstochannelinput',
184
+ }}
185
+ >
186
+ {`"""Assign assets to channel"""
187
+ type Mutation {
188
+ assignAssetsToChannel(input: AssignAssetsToChannelInput!): [Asset!]!
189
+ }`}
190
+ </GraphQLDoc>
191
+
192
+ ## assignCollectionsToChannel {#assigncollectionstochannel}
193
+
194
+ <GraphQLDoc
195
+ type="mutation"
196
+ typeName="assignCollectionsToChannel"
197
+ typeLinks={{
198
+ Collection: '/reference/graphql-api/admin/object-types#collection',
199
+ AssignCollectionsToChannelInput: '/reference/graphql-api/admin/input-types#assigncollectionstochannelinput',
200
+ }}
201
+ >
202
+ {`"""Assigns Collections to the specified Channel"""
203
+ type Mutation {
204
+ assignCollectionsToChannel(input: AssignCollectionsToChannelInput!): [Collection!]!
205
+ }`}
206
+ </GraphQLDoc>
207
+
208
+ ## assignFacetsToChannel {#assignfacetstochannel}
209
+
210
+ <GraphQLDoc
211
+ type="mutation"
212
+ typeName="assignFacetsToChannel"
213
+ typeLinks={{
214
+ Facet: '/reference/graphql-api/admin/object-types#facet',
215
+ AssignFacetsToChannelInput: '/reference/graphql-api/admin/input-types#assignfacetstochannelinput',
216
+ }}
217
+ >
218
+ {`"""Assigns Facets to the specified Channel"""
219
+ type Mutation {
220
+ assignFacetsToChannel(input: AssignFacetsToChannelInput!): [Facet!]!
221
+ }`}
222
+ </GraphQLDoc>
223
+
224
+ ## assignPaymentMethodsToChannel {#assignpaymentmethodstochannel}
225
+
226
+ <GraphQLDoc
227
+ type="mutation"
228
+ typeName="assignPaymentMethodsToChannel"
229
+ typeLinks={{
230
+ PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
231
+ AssignPaymentMethodsToChannelInput: '/reference/graphql-api/admin/input-types#assignpaymentmethodstochannelinput',
232
+ }}
233
+ >
234
+ {`"""Assigns PaymentMethods to the specified Channel"""
235
+ type Mutation {
236
+ assignPaymentMethodsToChannel(input: AssignPaymentMethodsToChannelInput!): [PaymentMethod!]!
237
+ }`}
238
+ </GraphQLDoc>
239
+
240
+ ## assignProductVariantsToChannel {#assignproductvariantstochannel}
241
+
242
+ <GraphQLDoc
243
+ type="mutation"
244
+ typeName="assignProductVariantsToChannel"
245
+ typeLinks={{
246
+ ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
247
+ AssignProductVariantsToChannelInput: '/reference/graphql-api/admin/input-types#assignproductvariantstochannelinput',
248
+ }}
249
+ >
250
+ {`"""Assigns ProductVariants to the specified Channel"""
251
+ type Mutation {
252
+ assignProductVariantsToChannel(input: AssignProductVariantsToChannelInput!): [ProductVariant!]!
253
+ }`}
254
+ </GraphQLDoc>
255
+
256
+ ## assignProductsToChannel {#assignproductstochannel}
257
+
258
+ <GraphQLDoc
259
+ type="mutation"
260
+ typeName="assignProductsToChannel"
261
+ typeLinks={{
262
+ Product: '/reference/graphql-api/admin/object-types#product',
263
+ AssignProductsToChannelInput: '/reference/graphql-api/admin/input-types#assignproductstochannelinput',
264
+ }}
265
+ >
266
+ {`"""Assigns all ProductVariants of Product to the specified Channel"""
267
+ type Mutation {
268
+ assignProductsToChannel(input: AssignProductsToChannelInput!): [Product!]!
269
+ }`}
270
+ </GraphQLDoc>
271
+
272
+ ## assignPromotionsToChannel {#assignpromotionstochannel}
273
+
274
+ <GraphQLDoc
275
+ type="mutation"
276
+ typeName="assignPromotionsToChannel"
277
+ typeLinks={{
278
+ Promotion: '/reference/graphql-api/admin/object-types#promotion',
279
+ AssignPromotionsToChannelInput: '/reference/graphql-api/admin/input-types#assignpromotionstochannelinput',
280
+ }}
281
+ >
282
+ {`"""Assigns Promotions to the specified Channel"""
283
+ type Mutation {
284
+ assignPromotionsToChannel(input: AssignPromotionsToChannelInput!): [Promotion!]!
285
+ }`}
286
+ </GraphQLDoc>
287
+
288
+ ## assignRoleToAdministrator {#assignroletoadministrator}
289
+
290
+ <GraphQLDoc
291
+ type="mutation"
292
+ typeName="assignRoleToAdministrator"
293
+ typeLinks={{
294
+ Administrator: '/reference/graphql-api/admin/object-types#administrator',
295
+ ID: '/reference/graphql-api/admin/object-types#id',
296
+ }}
297
+ >
298
+ {`"""Assign a Role to an Administrator"""
299
+ type Mutation {
300
+ assignRoleToAdministrator(administratorId: ID!, roleId: ID!): Administrator!
301
+ }`}
302
+ </GraphQLDoc>
303
+
304
+ ## assignShippingMethodsToChannel {#assignshippingmethodstochannel}
305
+
306
+ <GraphQLDoc
307
+ type="mutation"
308
+ typeName="assignShippingMethodsToChannel"
309
+ typeLinks={{
310
+ ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
311
+ AssignShippingMethodsToChannelInput: '/reference/graphql-api/admin/input-types#assignshippingmethodstochannelinput',
312
+ }}
313
+ >
314
+ {`"""Assigns ShippingMethods to the specified Channel"""
315
+ type Mutation {
316
+ assignShippingMethodsToChannel(input: AssignShippingMethodsToChannelInput!): [ShippingMethod!]!
317
+ }`}
318
+ </GraphQLDoc>
319
+
320
+ ## assignStockLocationsToChannel {#assignstocklocationstochannel}
321
+
322
+ <GraphQLDoc
323
+ type="mutation"
324
+ typeName="assignStockLocationsToChannel"
325
+ typeLinks={{
326
+ StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
327
+ AssignStockLocationsToChannelInput: '/reference/graphql-api/admin/input-types#assignstocklocationstochannelinput',
328
+ }}
329
+ >
330
+ {`"""Assigns StockLocations to the specified Channel"""
331
+ type Mutation {
332
+ assignStockLocationsToChannel(input: AssignStockLocationsToChannelInput!): [StockLocation!]!
333
+ }`}
334
+ </GraphQLDoc>
335
+
336
+ ## authenticate {#authenticate}
337
+
338
+ <GraphQLDoc
339
+ type="mutation"
340
+ typeName="authenticate"
341
+ typeLinks={{
342
+ AuthenticationResult: '/reference/graphql-api/admin/object-types#authenticationresult',
343
+ AuthenticationInput: '/reference/graphql-api/admin/input-types#authenticationinput',
344
+ Boolean: '/reference/graphql-api/admin/object-types#boolean',
345
+ }}
346
+ >
347
+ {`"""Authenticates the user using a named authentication strategy"""
348
+ type Mutation {
349
+ authenticate(input: AuthenticationInput!, rememberMe: Boolean): AuthenticationResult!
350
+ }`}
351
+ </GraphQLDoc>
352
+
353
+ ## cancelJob {#canceljob}
354
+
355
+ <GraphQLDoc
356
+ type="mutation"
357
+ typeName="cancelJob"
358
+ typeLinks={{
359
+ Job: '/reference/graphql-api/admin/object-types#job',
360
+ ID: '/reference/graphql-api/admin/object-types#id',
361
+ }}
362
+ >
363
+ {`type Mutation {
364
+ cancelJob(jobId: ID!): Job!
365
+ }`}
366
+ </GraphQLDoc>
367
+
368
+ ## cancelOrder {#cancelorder}
369
+
370
+ <GraphQLDoc
371
+ type="mutation"
372
+ typeName="cancelOrder"
373
+ typeLinks={{
374
+ CancelOrderResult: '/reference/graphql-api/admin/object-types#cancelorderresult',
375
+ CancelOrderInput: '/reference/graphql-api/admin/input-types#cancelorderinput',
376
+ }}
377
+ >
378
+ {`type Mutation {
379
+ cancelOrder(input: CancelOrderInput!): CancelOrderResult!
380
+ }`}
381
+ </GraphQLDoc>
382
+
383
+ ## cancelPayment {#cancelpayment}
384
+
385
+ <GraphQLDoc
386
+ type="mutation"
387
+ typeName="cancelPayment"
388
+ typeLinks={{
389
+ CancelPaymentResult: '/reference/graphql-api/admin/object-types#cancelpaymentresult',
390
+ ID: '/reference/graphql-api/admin/object-types#id',
391
+ }}
392
+ >
393
+ {`type Mutation {
394
+ cancelPayment(id: ID!): CancelPaymentResult!
395
+ }`}
396
+ </GraphQLDoc>
397
+
398
+ ## createAdministrator {#createadministrator}
399
+
400
+ <GraphQLDoc
401
+ type="mutation"
402
+ typeName="createAdministrator"
403
+ typeLinks={{
404
+ Administrator: '/reference/graphql-api/admin/object-types#administrator',
405
+ CreateAdministratorInput: '/reference/graphql-api/admin/input-types#createadministratorinput',
406
+ }}
407
+ >
408
+ {`"""Create a new Administrator"""
409
+ type Mutation {
410
+ createAdministrator(input: CreateAdministratorInput!): Administrator!
411
+ }`}
412
+ </GraphQLDoc>
413
+
414
+ ## createAssets {#createassets}
415
+
416
+ <GraphQLDoc
417
+ type="mutation"
418
+ typeName="createAssets"
419
+ typeLinks={{
420
+ CreateAssetResult: '/reference/graphql-api/admin/object-types#createassetresult',
421
+ CreateAssetInput: '/reference/graphql-api/admin/input-types#createassetinput',
422
+ }}
423
+ >
424
+ {`"""Create a new Asset"""
425
+ type Mutation {
426
+ createAssets(input: [CreateAssetInput!]!): [CreateAssetResult!]!
427
+ }`}
428
+ </GraphQLDoc>
429
+
430
+ ## createChannel {#createchannel}
431
+
432
+ <GraphQLDoc
433
+ type="mutation"
434
+ typeName="createChannel"
435
+ typeLinks={{
436
+ CreateChannelResult: '/reference/graphql-api/admin/object-types#createchannelresult',
437
+ CreateChannelInput: '/reference/graphql-api/admin/input-types#createchannelinput',
438
+ }}
439
+ >
440
+ {`"""Create a new Channel"""
441
+ type Mutation {
442
+ createChannel(input: CreateChannelInput!): CreateChannelResult!
443
+ }`}
444
+ </GraphQLDoc>
445
+
446
+ ## createCollection {#createcollection}
447
+
448
+ <GraphQLDoc
449
+ type="mutation"
450
+ typeName="createCollection"
451
+ typeLinks={{
452
+ Collection: '/reference/graphql-api/admin/object-types#collection',
453
+ CreateCollectionInput: '/reference/graphql-api/admin/input-types#createcollectioninput',
454
+ }}
455
+ >
456
+ {`"""Create a new Collection"""
457
+ type Mutation {
458
+ createCollection(input: CreateCollectionInput!): Collection!
459
+ }`}
460
+ </GraphQLDoc>
461
+
462
+ ## createCountry {#createcountry}
463
+
464
+ <GraphQLDoc
465
+ type="mutation"
466
+ typeName="createCountry"
467
+ typeLinks={{
468
+ Country: '/reference/graphql-api/admin/object-types#country',
469
+ CreateCountryInput: '/reference/graphql-api/admin/input-types#createcountryinput',
470
+ }}
471
+ >
472
+ {`"""Create a new Country"""
473
+ type Mutation {
474
+ createCountry(input: CreateCountryInput!): Country!
475
+ }`}
476
+ </GraphQLDoc>
477
+
478
+ ## createCustomer {#createcustomer}
479
+
480
+ <GraphQLDoc
481
+ type="mutation"
482
+ typeName="createCustomer"
483
+ typeLinks={{
484
+ CreateCustomerResult: '/reference/graphql-api/admin/object-types#createcustomerresult',
485
+ CreateCustomerInput: '/reference/graphql-api/admin/input-types#createcustomerinput',
486
+ String: '/reference/graphql-api/admin/object-types#string',
487
+ }}
488
+ >
489
+ {`"""Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer."""
490
+ type Mutation {
491
+ createCustomer(input: CreateCustomerInput!, password: String): CreateCustomerResult!
492
+ }`}
493
+ </GraphQLDoc>
494
+
495
+ ## createCustomerAddress {#createcustomeraddress}
496
+
497
+ <GraphQLDoc
498
+ type="mutation"
499
+ typeName="createCustomerAddress"
500
+ typeLinks={{
501
+ Address: '/reference/graphql-api/admin/object-types#address',
502
+ ID: '/reference/graphql-api/admin/object-types#id',
503
+ CreateAddressInput: '/reference/graphql-api/admin/input-types#createaddressinput',
504
+ }}
505
+ >
506
+ {`"""Create a new Address and associate it with the Customer specified by customerId"""
507
+ type Mutation {
508
+ createCustomerAddress(customerId: ID!, input: CreateAddressInput!): Address!
509
+ }`}
510
+ </GraphQLDoc>
511
+
512
+ ## createCustomerGroup {#createcustomergroup}
513
+
514
+ <GraphQLDoc
515
+ type="mutation"
516
+ typeName="createCustomerGroup"
517
+ typeLinks={{
518
+ CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
519
+ CreateCustomerGroupInput: '/reference/graphql-api/admin/input-types#createcustomergroupinput',
520
+ }}
521
+ >
522
+ {`"""Create a new CustomerGroup"""
523
+ type Mutation {
524
+ createCustomerGroup(input: CreateCustomerGroupInput!): CustomerGroup!
525
+ }`}
526
+ </GraphQLDoc>
527
+
528
+ ## createDraftOrder {#createdraftorder}
529
+
530
+ <GraphQLDoc
531
+ type="mutation"
532
+ typeName="createDraftOrder"
533
+ typeLinks={{
534
+ Order: '/reference/graphql-api/admin/object-types#order',
535
+ }}
536
+ >
537
+ {`"""Creates a draft Order"""
538
+ type Mutation {
539
+ createDraftOrder: Order!
540
+ }`}
541
+ </GraphQLDoc>
542
+
543
+ ## createFacet {#createfacet}
544
+
545
+ <GraphQLDoc
546
+ type="mutation"
547
+ typeName="createFacet"
548
+ typeLinks={{
549
+ Facet: '/reference/graphql-api/admin/object-types#facet',
550
+ CreateFacetInput: '/reference/graphql-api/admin/input-types#createfacetinput',
551
+ }}
552
+ >
553
+ {`"""Create a new Facet"""
554
+ type Mutation {
555
+ createFacet(input: CreateFacetInput!): Facet!
556
+ }`}
557
+ </GraphQLDoc>
558
+
559
+ ## createFacetValue {#createfacetvalue}
560
+
561
+ <GraphQLDoc
562
+ type="mutation"
563
+ typeName="createFacetValue"
564
+ typeLinks={{
565
+ FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
566
+ CreateFacetValueInput: '/reference/graphql-api/admin/input-types#createfacetvalueinput',
567
+ }}
568
+ >
569
+ {`"""Create a single FacetValue"""
570
+ type Mutation {
571
+ createFacetValue(input: CreateFacetValueInput!): FacetValue!
572
+ }`}
573
+ </GraphQLDoc>
574
+
575
+ ## createFacetValues {#createfacetvalues}
576
+
577
+ <GraphQLDoc
578
+ type="mutation"
579
+ typeName="createFacetValues"
580
+ typeLinks={{
581
+ FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
582
+ CreateFacetValueInput: '/reference/graphql-api/admin/input-types#createfacetvalueinput',
583
+ }}
584
+ >
585
+ {`"""Create one or more FacetValues"""
586
+ type Mutation {
587
+ createFacetValues(input: [CreateFacetValueInput!]!): [FacetValue!]!
588
+ }`}
589
+ </GraphQLDoc>
590
+
591
+ ## createPaymentMethod {#createpaymentmethod}
592
+
593
+ <GraphQLDoc
594
+ type="mutation"
595
+ typeName="createPaymentMethod"
596
+ typeLinks={{
597
+ PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
598
+ CreatePaymentMethodInput: '/reference/graphql-api/admin/input-types#createpaymentmethodinput',
599
+ }}
600
+ >
601
+ {`"""Create existing PaymentMethod"""
602
+ type Mutation {
603
+ createPaymentMethod(input: CreatePaymentMethodInput!): PaymentMethod!
604
+ }`}
605
+ </GraphQLDoc>
606
+
607
+ ## createProduct {#createproduct}
608
+
609
+ <GraphQLDoc
610
+ type="mutation"
611
+ typeName="createProduct"
612
+ typeLinks={{
613
+ Product: '/reference/graphql-api/admin/object-types#product',
614
+ CreateProductInput: '/reference/graphql-api/admin/input-types#createproductinput',
615
+ }}
616
+ >
617
+ {`"""Create a new Product"""
618
+ type Mutation {
619
+ createProduct(input: CreateProductInput!): Product!
620
+ }`}
621
+ </GraphQLDoc>
622
+
623
+ ## createProductOption {#createproductoption}
624
+
625
+ <GraphQLDoc
626
+ type="mutation"
627
+ typeName="createProductOption"
628
+ typeLinks={{
629
+ ProductOption: '/reference/graphql-api/admin/object-types#productoption',
630
+ CreateProductOptionInput: '/reference/graphql-api/admin/input-types#createproductoptioninput',
631
+ }}
632
+ >
633
+ {`"""Create a new ProductOption within a ProductOptionGroup"""
634
+ type Mutation {
635
+ createProductOption(input: CreateProductOptionInput!): ProductOption!
636
+ }`}
637
+ </GraphQLDoc>
638
+
639
+ ## createProductOptionGroup {#createproductoptiongroup}
640
+
641
+ <GraphQLDoc
642
+ type="mutation"
643
+ typeName="createProductOptionGroup"
644
+ typeLinks={{
645
+ ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
646
+ CreateProductOptionGroupInput: '/reference/graphql-api/admin/input-types#createproductoptiongroupinput',
647
+ }}
648
+ >
649
+ {`"""Create a new ProductOptionGroup"""
650
+ type Mutation {
651
+ createProductOptionGroup(input: CreateProductOptionGroupInput!): ProductOptionGroup!
652
+ }`}
653
+ </GraphQLDoc>
654
+
655
+ ## createProductVariants {#createproductvariants}
656
+
657
+ <GraphQLDoc
658
+ type="mutation"
659
+ typeName="createProductVariants"
660
+ typeLinks={{
661
+ ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
662
+ CreateProductVariantInput: '/reference/graphql-api/admin/input-types#createproductvariantinput',
663
+ }}
664
+ >
665
+ {`"""Create a set of ProductVariants based on the OptionGroups assigned to the given Product"""
666
+ type Mutation {
667
+ createProductVariants(input: [CreateProductVariantInput!]!): [ProductVariant]!
668
+ }`}
669
+ </GraphQLDoc>
670
+
671
+ ## createPromotion {#createpromotion}
672
+
673
+ <GraphQLDoc
674
+ type="mutation"
675
+ typeName="createPromotion"
676
+ typeLinks={{
677
+ CreatePromotionResult: '/reference/graphql-api/admin/object-types#createpromotionresult',
678
+ CreatePromotionInput: '/reference/graphql-api/admin/input-types#createpromotioninput',
679
+ }}
680
+ >
681
+ {`type Mutation {
682
+ createPromotion(input: CreatePromotionInput!): CreatePromotionResult!
683
+ }`}
684
+ </GraphQLDoc>
685
+
686
+ ## createProvince {#createprovince}
687
+
688
+ <GraphQLDoc
689
+ type="mutation"
690
+ typeName="createProvince"
691
+ typeLinks={{
692
+ Province: '/reference/graphql-api/admin/object-types#province',
693
+ CreateProvinceInput: '/reference/graphql-api/admin/input-types#createprovinceinput',
694
+ }}
695
+ >
696
+ {`"""Create a new Province"""
697
+ type Mutation {
698
+ createProvince(input: CreateProvinceInput!): Province!
699
+ }`}
700
+ </GraphQLDoc>
701
+
702
+ ## createRole {#createrole}
703
+
704
+ <GraphQLDoc
705
+ type="mutation"
706
+ typeName="createRole"
707
+ typeLinks={{
708
+ Role: '/reference/graphql-api/admin/object-types#role',
709
+ CreateRoleInput: '/reference/graphql-api/admin/input-types#createroleinput',
710
+ }}
711
+ >
712
+ {`"""Create a new Role"""
713
+ type Mutation {
714
+ createRole(input: CreateRoleInput!): Role!
715
+ }`}
716
+ </GraphQLDoc>
717
+
718
+ ## createSeller {#createseller}
719
+
720
+ <GraphQLDoc
721
+ type="mutation"
722
+ typeName="createSeller"
723
+ typeLinks={{
724
+ Seller: '/reference/graphql-api/admin/object-types#seller',
725
+ CreateSellerInput: '/reference/graphql-api/admin/input-types#createsellerinput',
726
+ }}
727
+ >
728
+ {`"""Create a new Seller"""
729
+ type Mutation {
730
+ createSeller(input: CreateSellerInput!): Seller!
731
+ }`}
732
+ </GraphQLDoc>
733
+
734
+ ## createShippingMethod {#createshippingmethod}
735
+
736
+ <GraphQLDoc
737
+ type="mutation"
738
+ typeName="createShippingMethod"
739
+ typeLinks={{
740
+ ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
741
+ CreateShippingMethodInput: '/reference/graphql-api/admin/input-types#createshippingmethodinput',
742
+ }}
743
+ >
744
+ {`"""Create a new ShippingMethod"""
745
+ type Mutation {
746
+ createShippingMethod(input: CreateShippingMethodInput!): ShippingMethod!
747
+ }`}
748
+ </GraphQLDoc>
749
+
750
+ ## createStockLocation {#createstocklocation}
751
+
752
+ <GraphQLDoc
753
+ type="mutation"
754
+ typeName="createStockLocation"
755
+ typeLinks={{
756
+ StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
757
+ CreateStockLocationInput: '/reference/graphql-api/admin/input-types#createstocklocationinput',
758
+ }}
759
+ >
760
+ {`type Mutation {
761
+ createStockLocation(input: CreateStockLocationInput!): StockLocation!
762
+ }`}
763
+ </GraphQLDoc>
764
+
765
+ ## createTag {#createtag}
766
+
767
+ <GraphQLDoc
768
+ type="mutation"
769
+ typeName="createTag"
770
+ typeLinks={{
771
+ Tag: '/reference/graphql-api/admin/object-types#tag',
772
+ CreateTagInput: '/reference/graphql-api/admin/input-types#createtaginput',
773
+ }}
774
+ >
775
+ {`"""Create a new Tag"""
776
+ type Mutation {
777
+ createTag(input: CreateTagInput!): Tag!
778
+ }`}
779
+ </GraphQLDoc>
780
+
781
+ ## createTaxCategory {#createtaxcategory}
782
+
783
+ <GraphQLDoc
784
+ type="mutation"
785
+ typeName="createTaxCategory"
786
+ typeLinks={{
787
+ TaxCategory: '/reference/graphql-api/admin/object-types#taxcategory',
788
+ CreateTaxCategoryInput: '/reference/graphql-api/admin/input-types#createtaxcategoryinput',
789
+ }}
790
+ >
791
+ {`"""Create a new TaxCategory"""
792
+ type Mutation {
793
+ createTaxCategory(input: CreateTaxCategoryInput!): TaxCategory!
794
+ }`}
795
+ </GraphQLDoc>
796
+
797
+ ## createTaxRate {#createtaxrate}
798
+
799
+ <GraphQLDoc
800
+ type="mutation"
801
+ typeName="createTaxRate"
802
+ typeLinks={{
803
+ TaxRate: '/reference/graphql-api/admin/object-types#taxrate',
804
+ CreateTaxRateInput: '/reference/graphql-api/admin/input-types#createtaxrateinput',
805
+ }}
806
+ >
807
+ {`"""Create a new TaxRate"""
808
+ type Mutation {
809
+ createTaxRate(input: CreateTaxRateInput!): TaxRate!
810
+ }`}
811
+ </GraphQLDoc>
812
+
813
+ ## createZone {#createzone}
814
+
815
+ <GraphQLDoc
816
+ type="mutation"
817
+ typeName="createZone"
818
+ typeLinks={{
819
+ Zone: '/reference/graphql-api/admin/object-types#zone',
820
+ CreateZoneInput: '/reference/graphql-api/admin/input-types#createzoneinput',
821
+ }}
822
+ >
823
+ {`"""Create a new Zone"""
824
+ type Mutation {
825
+ createZone(input: CreateZoneInput!): Zone!
826
+ }`}
827
+ </GraphQLDoc>
828
+
829
+ ## deleteAdministrator {#deleteadministrator}
830
+
831
+ <GraphQLDoc
832
+ type="mutation"
833
+ typeName="deleteAdministrator"
834
+ typeLinks={{
835
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
836
+ ID: '/reference/graphql-api/admin/object-types#id',
837
+ }}
838
+ >
839
+ {`"""Delete an Administrator"""
840
+ type Mutation {
841
+ deleteAdministrator(id: ID!): DeletionResponse!
842
+ }`}
843
+ </GraphQLDoc>
844
+
845
+ ## deleteAdministrators {#deleteadministrators}
846
+
847
+ <GraphQLDoc
848
+ type="mutation"
849
+ typeName="deleteAdministrators"
850
+ typeLinks={{
851
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
852
+ ID: '/reference/graphql-api/admin/object-types#id',
853
+ }}
854
+ >
855
+ {`"""Delete multiple Administrators"""
856
+ type Mutation {
857
+ deleteAdministrators(ids: [ID!]!): [DeletionResponse!]!
858
+ }`}
859
+ </GraphQLDoc>
860
+
861
+ ## deleteAsset {#deleteasset}
862
+
863
+ <GraphQLDoc
864
+ type="mutation"
865
+ typeName="deleteAsset"
866
+ typeLinks={{
867
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
868
+ DeleteAssetInput: '/reference/graphql-api/admin/input-types#deleteassetinput',
869
+ }}
870
+ >
871
+ {`"""Delete an Asset"""
872
+ type Mutation {
873
+ deleteAsset(input: DeleteAssetInput!): DeletionResponse!
874
+ }`}
875
+ </GraphQLDoc>
876
+
877
+ ## deleteAssets {#deleteassets}
878
+
879
+ <GraphQLDoc
880
+ type="mutation"
881
+ typeName="deleteAssets"
882
+ typeLinks={{
883
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
884
+ DeleteAssetsInput: '/reference/graphql-api/admin/input-types#deleteassetsinput',
885
+ }}
886
+ >
887
+ {`"""Delete multiple Assets"""
888
+ type Mutation {
889
+ deleteAssets(input: DeleteAssetsInput!): DeletionResponse!
890
+ }`}
891
+ </GraphQLDoc>
892
+
893
+ ## deleteChannel {#deletechannel}
894
+
895
+ <GraphQLDoc
896
+ type="mutation"
897
+ typeName="deleteChannel"
898
+ typeLinks={{
899
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
900
+ ID: '/reference/graphql-api/admin/object-types#id',
901
+ }}
902
+ >
903
+ {`"""Delete a Channel"""
904
+ type Mutation {
905
+ deleteChannel(id: ID!): DeletionResponse!
906
+ }`}
907
+ </GraphQLDoc>
908
+
909
+ ## deleteChannels {#deletechannels}
910
+
911
+ <GraphQLDoc
912
+ type="mutation"
913
+ typeName="deleteChannels"
914
+ typeLinks={{
915
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
916
+ ID: '/reference/graphql-api/admin/object-types#id',
917
+ }}
918
+ >
919
+ {`"""Delete multiple Channels"""
920
+ type Mutation {
921
+ deleteChannels(ids: [ID!]!): [DeletionResponse!]!
922
+ }`}
923
+ </GraphQLDoc>
924
+
925
+ ## deleteCollection {#deletecollection}
926
+
927
+ <GraphQLDoc
928
+ type="mutation"
929
+ typeName="deleteCollection"
930
+ typeLinks={{
931
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
932
+ ID: '/reference/graphql-api/admin/object-types#id',
933
+ }}
934
+ >
935
+ {`"""Delete a Collection and all of its descendants"""
936
+ type Mutation {
937
+ deleteCollection(id: ID!): DeletionResponse!
938
+ }`}
939
+ </GraphQLDoc>
940
+
941
+ ## deleteCollections {#deletecollections}
942
+
943
+ <GraphQLDoc
944
+ type="mutation"
945
+ typeName="deleteCollections"
946
+ typeLinks={{
947
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
948
+ ID: '/reference/graphql-api/admin/object-types#id',
949
+ }}
950
+ >
951
+ {`"""Delete multiple Collections and all of their descendants"""
952
+ type Mutation {
953
+ deleteCollections(ids: [ID!]!): [DeletionResponse!]!
954
+ }`}
955
+ </GraphQLDoc>
956
+
957
+ ## deleteCountries {#deletecountries}
958
+
959
+ <GraphQLDoc
960
+ type="mutation"
961
+ typeName="deleteCountries"
962
+ typeLinks={{
963
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
964
+ ID: '/reference/graphql-api/admin/object-types#id',
965
+ }}
966
+ >
967
+ {`"""Delete multiple Countries"""
968
+ type Mutation {
969
+ deleteCountries(ids: [ID!]!): [DeletionResponse!]!
970
+ }`}
971
+ </GraphQLDoc>
972
+
973
+ ## deleteCountry {#deletecountry}
974
+
975
+ <GraphQLDoc
976
+ type="mutation"
977
+ typeName="deleteCountry"
978
+ typeLinks={{
979
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
980
+ ID: '/reference/graphql-api/admin/object-types#id',
981
+ }}
982
+ >
983
+ {`"""Delete a Country"""
984
+ type Mutation {
985
+ deleteCountry(id: ID!): DeletionResponse!
986
+ }`}
987
+ </GraphQLDoc>
988
+
989
+ ## deleteCustomer {#deletecustomer}
990
+
991
+ <GraphQLDoc
992
+ type="mutation"
993
+ typeName="deleteCustomer"
994
+ typeLinks={{
995
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
996
+ ID: '/reference/graphql-api/admin/object-types#id',
997
+ }}
998
+ >
999
+ {`"""Delete a Customer"""
1000
+ type Mutation {
1001
+ deleteCustomer(id: ID!): DeletionResponse!
1002
+ }`}
1003
+ </GraphQLDoc>
1004
+
1005
+ ## deleteCustomerAddress {#deletecustomeraddress}
1006
+
1007
+ <GraphQLDoc
1008
+ type="mutation"
1009
+ typeName="deleteCustomerAddress"
1010
+ typeLinks={{
1011
+ Success: '/reference/graphql-api/admin/object-types#success',
1012
+ ID: '/reference/graphql-api/admin/object-types#id',
1013
+ }}
1014
+ >
1015
+ {`"""Update an existing Address"""
1016
+ type Mutation {
1017
+ deleteCustomerAddress(id: ID!): Success!
1018
+ }`}
1019
+ </GraphQLDoc>
1020
+
1021
+ ## deleteCustomerGroup {#deletecustomergroup}
1022
+
1023
+ <GraphQLDoc
1024
+ type="mutation"
1025
+ typeName="deleteCustomerGroup"
1026
+ typeLinks={{
1027
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1028
+ ID: '/reference/graphql-api/admin/object-types#id',
1029
+ }}
1030
+ >
1031
+ {`"""Delete a CustomerGroup"""
1032
+ type Mutation {
1033
+ deleteCustomerGroup(id: ID!): DeletionResponse!
1034
+ }`}
1035
+ </GraphQLDoc>
1036
+
1037
+ ## deleteCustomerGroups {#deletecustomergroups}
1038
+
1039
+ <GraphQLDoc
1040
+ type="mutation"
1041
+ typeName="deleteCustomerGroups"
1042
+ typeLinks={{
1043
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1044
+ ID: '/reference/graphql-api/admin/object-types#id',
1045
+ }}
1046
+ >
1047
+ {`"""Delete multiple CustomerGroups"""
1048
+ type Mutation {
1049
+ deleteCustomerGroups(ids: [ID!]!): [DeletionResponse!]!
1050
+ }`}
1051
+ </GraphQLDoc>
1052
+
1053
+ ## deleteCustomerNote {#deletecustomernote}
1054
+
1055
+ <GraphQLDoc
1056
+ type="mutation"
1057
+ typeName="deleteCustomerNote"
1058
+ typeLinks={{
1059
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1060
+ ID: '/reference/graphql-api/admin/object-types#id',
1061
+ }}
1062
+ >
1063
+ {`type Mutation {
1064
+ deleteCustomerNote(id: ID!): DeletionResponse!
1065
+ }`}
1066
+ </GraphQLDoc>
1067
+
1068
+ ## deleteCustomers {#deletecustomers}
1069
+
1070
+ <GraphQLDoc
1071
+ type="mutation"
1072
+ typeName="deleteCustomers"
1073
+ typeLinks={{
1074
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1075
+ ID: '/reference/graphql-api/admin/object-types#id',
1076
+ }}
1077
+ >
1078
+ {`"""Deletes Customers"""
1079
+ type Mutation {
1080
+ deleteCustomers(ids: [ID!]!): [DeletionResponse!]!
1081
+ }`}
1082
+ </GraphQLDoc>
1083
+
1084
+ ## deleteDraftOrder {#deletedraftorder}
1085
+
1086
+ <GraphQLDoc
1087
+ type="mutation"
1088
+ typeName="deleteDraftOrder"
1089
+ typeLinks={{
1090
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1091
+ ID: '/reference/graphql-api/admin/object-types#id',
1092
+ }}
1093
+ >
1094
+ {`"""Deletes a draft Order"""
1095
+ type Mutation {
1096
+ deleteDraftOrder(orderId: ID!): DeletionResponse!
1097
+ }`}
1098
+ </GraphQLDoc>
1099
+
1100
+ ## deleteFacet {#deletefacet}
1101
+
1102
+ <GraphQLDoc
1103
+ type="mutation"
1104
+ typeName="deleteFacet"
1105
+ typeLinks={{
1106
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1107
+ ID: '/reference/graphql-api/admin/object-types#id',
1108
+ Boolean: '/reference/graphql-api/admin/object-types#boolean',
1109
+ }}
1110
+ >
1111
+ {`"""Delete an existing Facet"""
1112
+ type Mutation {
1113
+ deleteFacet(id: ID!, force: Boolean): DeletionResponse!
1114
+ }`}
1115
+ </GraphQLDoc>
1116
+
1117
+ ## deleteFacetValues {#deletefacetvalues}
1118
+
1119
+ <GraphQLDoc
1120
+ type="mutation"
1121
+ typeName="deleteFacetValues"
1122
+ typeLinks={{
1123
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1124
+ ID: '/reference/graphql-api/admin/object-types#id',
1125
+ Boolean: '/reference/graphql-api/admin/object-types#boolean',
1126
+ }}
1127
+ >
1128
+ {`"""Delete one or more FacetValues"""
1129
+ type Mutation {
1130
+ deleteFacetValues(ids: [ID!]!, force: Boolean): [DeletionResponse!]!
1131
+ }`}
1132
+ </GraphQLDoc>
1133
+
1134
+ ## deleteFacets {#deletefacets}
1135
+
1136
+ <GraphQLDoc
1137
+ type="mutation"
1138
+ typeName="deleteFacets"
1139
+ typeLinks={{
1140
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1141
+ ID: '/reference/graphql-api/admin/object-types#id',
1142
+ Boolean: '/reference/graphql-api/admin/object-types#boolean',
1143
+ }}
1144
+ >
1145
+ {`"""Delete multiple existing Facets"""
1146
+ type Mutation {
1147
+ deleteFacets(ids: [ID!]!, force: Boolean): [DeletionResponse!]!
1148
+ }`}
1149
+ </GraphQLDoc>
1150
+
1151
+ ## deleteOrderNote {#deleteordernote}
1152
+
1153
+ <GraphQLDoc
1154
+ type="mutation"
1155
+ typeName="deleteOrderNote"
1156
+ typeLinks={{
1157
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1158
+ ID: '/reference/graphql-api/admin/object-types#id',
1159
+ }}
1160
+ >
1161
+ {`type Mutation {
1162
+ deleteOrderNote(id: ID!): DeletionResponse!
1163
+ }`}
1164
+ </GraphQLDoc>
1165
+
1166
+ ## deletePaymentMethod {#deletepaymentmethod}
1167
+
1168
+ <GraphQLDoc
1169
+ type="mutation"
1170
+ typeName="deletePaymentMethod"
1171
+ typeLinks={{
1172
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1173
+ ID: '/reference/graphql-api/admin/object-types#id',
1174
+ Boolean: '/reference/graphql-api/admin/object-types#boolean',
1175
+ }}
1176
+ >
1177
+ {`"""Delete a PaymentMethod"""
1178
+ type Mutation {
1179
+ deletePaymentMethod(id: ID!, force: Boolean): DeletionResponse!
1180
+ }`}
1181
+ </GraphQLDoc>
1182
+
1183
+ ## deletePaymentMethods {#deletepaymentmethods}
1184
+
1185
+ <GraphQLDoc
1186
+ type="mutation"
1187
+ typeName="deletePaymentMethods"
1188
+ typeLinks={{
1189
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1190
+ ID: '/reference/graphql-api/admin/object-types#id',
1191
+ Boolean: '/reference/graphql-api/admin/object-types#boolean',
1192
+ }}
1193
+ >
1194
+ {`"""Delete multiple PaymentMethods"""
1195
+ type Mutation {
1196
+ deletePaymentMethods(ids: [ID!]!, force: Boolean): [DeletionResponse!]!
1197
+ }`}
1198
+ </GraphQLDoc>
1199
+
1200
+ ## deleteProduct {#deleteproduct}
1201
+
1202
+ <GraphQLDoc
1203
+ type="mutation"
1204
+ typeName="deleteProduct"
1205
+ typeLinks={{
1206
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1207
+ ID: '/reference/graphql-api/admin/object-types#id',
1208
+ }}
1209
+ >
1210
+ {`"""Delete a Product"""
1211
+ type Mutation {
1212
+ deleteProduct(id: ID!): DeletionResponse!
1213
+ }`}
1214
+ </GraphQLDoc>
1215
+
1216
+ ## deleteProductOption {#deleteproductoption}
1217
+
1218
+ <GraphQLDoc
1219
+ type="mutation"
1220
+ typeName="deleteProductOption"
1221
+ typeLinks={{
1222
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1223
+ ID: '/reference/graphql-api/admin/object-types#id',
1224
+ }}
1225
+ >
1226
+ {`"""Delete a ProductOption"""
1227
+ type Mutation {
1228
+ deleteProductOption(id: ID!): DeletionResponse!
1229
+ }`}
1230
+ </GraphQLDoc>
1231
+
1232
+ ## deleteProductVariant {#deleteproductvariant}
1233
+
1234
+ <GraphQLDoc
1235
+ type="mutation"
1236
+ typeName="deleteProductVariant"
1237
+ typeLinks={{
1238
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1239
+ ID: '/reference/graphql-api/admin/object-types#id',
1240
+ }}
1241
+ >
1242
+ {`"""Delete a ProductVariant"""
1243
+ type Mutation {
1244
+ deleteProductVariant(id: ID!): DeletionResponse!
1245
+ }`}
1246
+ </GraphQLDoc>
1247
+
1248
+ ## deleteProductVariants {#deleteproductvariants}
1249
+
1250
+ <GraphQLDoc
1251
+ type="mutation"
1252
+ typeName="deleteProductVariants"
1253
+ typeLinks={{
1254
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1255
+ ID: '/reference/graphql-api/admin/object-types#id',
1256
+ }}
1257
+ >
1258
+ {`"""Delete multiple ProductVariants"""
1259
+ type Mutation {
1260
+ deleteProductVariants(ids: [ID!]!): [DeletionResponse!]!
1261
+ }`}
1262
+ </GraphQLDoc>
1263
+
1264
+ ## deleteProducts {#deleteproducts}
1265
+
1266
+ <GraphQLDoc
1267
+ type="mutation"
1268
+ typeName="deleteProducts"
1269
+ typeLinks={{
1270
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1271
+ ID: '/reference/graphql-api/admin/object-types#id',
1272
+ }}
1273
+ >
1274
+ {`"""Delete multiple Products"""
1275
+ type Mutation {
1276
+ deleteProducts(ids: [ID!]!): [DeletionResponse!]!
1277
+ }`}
1278
+ </GraphQLDoc>
1279
+
1280
+ ## deletePromotion {#deletepromotion}
1281
+
1282
+ <GraphQLDoc
1283
+ type="mutation"
1284
+ typeName="deletePromotion"
1285
+ typeLinks={{
1286
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1287
+ ID: '/reference/graphql-api/admin/object-types#id',
1288
+ }}
1289
+ >
1290
+ {`type Mutation {
1291
+ deletePromotion(id: ID!): DeletionResponse!
1292
+ }`}
1293
+ </GraphQLDoc>
1294
+
1295
+ ## deletePromotions {#deletepromotions}
1296
+
1297
+ <GraphQLDoc
1298
+ type="mutation"
1299
+ typeName="deletePromotions"
1300
+ typeLinks={{
1301
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1302
+ ID: '/reference/graphql-api/admin/object-types#id',
1303
+ }}
1304
+ >
1305
+ {`type Mutation {
1306
+ deletePromotions(ids: [ID!]!): [DeletionResponse!]!
1307
+ }`}
1308
+ </GraphQLDoc>
1309
+
1310
+ ## deleteProvince {#deleteprovince}
1311
+
1312
+ <GraphQLDoc
1313
+ type="mutation"
1314
+ typeName="deleteProvince"
1315
+ typeLinks={{
1316
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1317
+ ID: '/reference/graphql-api/admin/object-types#id',
1318
+ }}
1319
+ >
1320
+ {`"""Delete a Province"""
1321
+ type Mutation {
1322
+ deleteProvince(id: ID!): DeletionResponse!
1323
+ }`}
1324
+ </GraphQLDoc>
1325
+
1326
+ ## deleteRole {#deleterole}
1327
+
1328
+ <GraphQLDoc
1329
+ type="mutation"
1330
+ typeName="deleteRole"
1331
+ typeLinks={{
1332
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1333
+ ID: '/reference/graphql-api/admin/object-types#id',
1334
+ }}
1335
+ >
1336
+ {`"""Delete an existing Role"""
1337
+ type Mutation {
1338
+ deleteRole(id: ID!): DeletionResponse!
1339
+ }`}
1340
+ </GraphQLDoc>
1341
+
1342
+ ## deleteRoles {#deleteroles}
1343
+
1344
+ <GraphQLDoc
1345
+ type="mutation"
1346
+ typeName="deleteRoles"
1347
+ typeLinks={{
1348
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1349
+ ID: '/reference/graphql-api/admin/object-types#id',
1350
+ }}
1351
+ >
1352
+ {`"""Delete multiple Roles"""
1353
+ type Mutation {
1354
+ deleteRoles(ids: [ID!]!): [DeletionResponse!]!
1355
+ }`}
1356
+ </GraphQLDoc>
1357
+
1358
+ ## deleteSeller {#deleteseller}
1359
+
1360
+ <GraphQLDoc
1361
+ type="mutation"
1362
+ typeName="deleteSeller"
1363
+ typeLinks={{
1364
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1365
+ ID: '/reference/graphql-api/admin/object-types#id',
1366
+ }}
1367
+ >
1368
+ {`"""Delete a Seller"""
1369
+ type Mutation {
1370
+ deleteSeller(id: ID!): DeletionResponse!
1371
+ }`}
1372
+ </GraphQLDoc>
1373
+
1374
+ ## deleteSellers {#deletesellers}
1375
+
1376
+ <GraphQLDoc
1377
+ type="mutation"
1378
+ typeName="deleteSellers"
1379
+ typeLinks={{
1380
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1381
+ ID: '/reference/graphql-api/admin/object-types#id',
1382
+ }}
1383
+ >
1384
+ {`"""Delete multiple Sellers"""
1385
+ type Mutation {
1386
+ deleteSellers(ids: [ID!]!): [DeletionResponse!]!
1387
+ }`}
1388
+ </GraphQLDoc>
1389
+
1390
+ ## deleteShippingMethod {#deleteshippingmethod}
1391
+
1392
+ <GraphQLDoc
1393
+ type="mutation"
1394
+ typeName="deleteShippingMethod"
1395
+ typeLinks={{
1396
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1397
+ ID: '/reference/graphql-api/admin/object-types#id',
1398
+ }}
1399
+ >
1400
+ {`"""Delete a ShippingMethod"""
1401
+ type Mutation {
1402
+ deleteShippingMethod(id: ID!): DeletionResponse!
1403
+ }`}
1404
+ </GraphQLDoc>
1405
+
1406
+ ## deleteShippingMethods {#deleteshippingmethods}
1407
+
1408
+ <GraphQLDoc
1409
+ type="mutation"
1410
+ typeName="deleteShippingMethods"
1411
+ typeLinks={{
1412
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1413
+ ID: '/reference/graphql-api/admin/object-types#id',
1414
+ }}
1415
+ >
1416
+ {`"""Delete multiple ShippingMethods"""
1417
+ type Mutation {
1418
+ deleteShippingMethods(ids: [ID!]!): [DeletionResponse!]!
1419
+ }`}
1420
+ </GraphQLDoc>
1421
+
1422
+ ## deleteStockLocation {#deletestocklocation}
1423
+
1424
+ <GraphQLDoc
1425
+ type="mutation"
1426
+ typeName="deleteStockLocation"
1427
+ typeLinks={{
1428
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1429
+ DeleteStockLocationInput: '/reference/graphql-api/admin/input-types#deletestocklocationinput',
1430
+ }}
1431
+ >
1432
+ {`type Mutation {
1433
+ deleteStockLocation(input: DeleteStockLocationInput!): DeletionResponse!
1434
+ }`}
1435
+ </GraphQLDoc>
1436
+
1437
+ ## deleteStockLocations {#deletestocklocations}
1438
+
1439
+ <GraphQLDoc
1440
+ type="mutation"
1441
+ typeName="deleteStockLocations"
1442
+ typeLinks={{
1443
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1444
+ DeleteStockLocationInput: '/reference/graphql-api/admin/input-types#deletestocklocationinput',
1445
+ }}
1446
+ >
1447
+ {`type Mutation {
1448
+ deleteStockLocations(input: [DeleteStockLocationInput!]!): [DeletionResponse!]!
1449
+ }`}
1450
+ </GraphQLDoc>
1451
+
1452
+ ## deleteTag {#deletetag}
1453
+
1454
+ <GraphQLDoc
1455
+ type="mutation"
1456
+ typeName="deleteTag"
1457
+ typeLinks={{
1458
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1459
+ ID: '/reference/graphql-api/admin/object-types#id',
1460
+ }}
1461
+ >
1462
+ {`"""Delete an existing Tag"""
1463
+ type Mutation {
1464
+ deleteTag(id: ID!): DeletionResponse!
1465
+ }`}
1466
+ </GraphQLDoc>
1467
+
1468
+ ## deleteTaxCategories {#deletetaxcategories}
1469
+
1470
+ <GraphQLDoc
1471
+ type="mutation"
1472
+ typeName="deleteTaxCategories"
1473
+ typeLinks={{
1474
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1475
+ ID: '/reference/graphql-api/admin/object-types#id',
1476
+ }}
1477
+ >
1478
+ {`"""Deletes multiple TaxCategories"""
1479
+ type Mutation {
1480
+ deleteTaxCategories(ids: [ID!]!): [DeletionResponse!]!
1481
+ }`}
1482
+ </GraphQLDoc>
1483
+
1484
+ ## deleteTaxCategory {#deletetaxcategory}
1485
+
1486
+ <GraphQLDoc
1487
+ type="mutation"
1488
+ typeName="deleteTaxCategory"
1489
+ typeLinks={{
1490
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1491
+ ID: '/reference/graphql-api/admin/object-types#id',
1492
+ }}
1493
+ >
1494
+ {`"""Deletes a TaxCategory"""
1495
+ type Mutation {
1496
+ deleteTaxCategory(id: ID!): DeletionResponse!
1497
+ }`}
1498
+ </GraphQLDoc>
1499
+
1500
+ ## deleteTaxRate {#deletetaxrate}
1501
+
1502
+ <GraphQLDoc
1503
+ type="mutation"
1504
+ typeName="deleteTaxRate"
1505
+ typeLinks={{
1506
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1507
+ ID: '/reference/graphql-api/admin/object-types#id',
1508
+ }}
1509
+ >
1510
+ {`"""Delete a TaxRate"""
1511
+ type Mutation {
1512
+ deleteTaxRate(id: ID!): DeletionResponse!
1513
+ }`}
1514
+ </GraphQLDoc>
1515
+
1516
+ ## deleteTaxRates {#deletetaxrates}
1517
+
1518
+ <GraphQLDoc
1519
+ type="mutation"
1520
+ typeName="deleteTaxRates"
1521
+ typeLinks={{
1522
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1523
+ ID: '/reference/graphql-api/admin/object-types#id',
1524
+ }}
1525
+ >
1526
+ {`"""Delete multiple TaxRates"""
1527
+ type Mutation {
1528
+ deleteTaxRates(ids: [ID!]!): [DeletionResponse!]!
1529
+ }`}
1530
+ </GraphQLDoc>
1531
+
1532
+ ## deleteZone {#deletezone}
1533
+
1534
+ <GraphQLDoc
1535
+ type="mutation"
1536
+ typeName="deleteZone"
1537
+ typeLinks={{
1538
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1539
+ ID: '/reference/graphql-api/admin/object-types#id',
1540
+ }}
1541
+ >
1542
+ {`"""Delete a Zone"""
1543
+ type Mutation {
1544
+ deleteZone(id: ID!): DeletionResponse!
1545
+ }`}
1546
+ </GraphQLDoc>
1547
+
1548
+ ## deleteZones {#deletezones}
1549
+
1550
+ <GraphQLDoc
1551
+ type="mutation"
1552
+ typeName="deleteZones"
1553
+ typeLinks={{
1554
+ DeletionResponse: '/reference/graphql-api/admin/object-types#deletionresponse',
1555
+ ID: '/reference/graphql-api/admin/object-types#id',
1556
+ }}
1557
+ >
1558
+ {`"""Delete a Zone"""
1559
+ type Mutation {
1560
+ deleteZones(ids: [ID!]!): [DeletionResponse!]!
1561
+ }`}
1562
+ </GraphQLDoc>
1563
+
1564
+ ## duplicateEntity {#duplicateentity}
1565
+
1566
+ <GraphQLDoc
1567
+ type="mutation"
1568
+ typeName="duplicateEntity"
1569
+ typeLinks={{
1570
+ DuplicateEntityResult: '/reference/graphql-api/admin/object-types#duplicateentityresult',
1571
+ DuplicateEntityInput: '/reference/graphql-api/admin/input-types#duplicateentityinput',
1572
+ }}
1573
+ >
1574
+ {`"""
1575
+ Duplicate an existing entity using a specific EntityDuplicator.
1576
+ Since v2.2.0.
1577
+ """
1578
+ type Mutation {
1579
+ duplicateEntity(input: DuplicateEntityInput!): DuplicateEntityResult!
1580
+ }`}
1581
+ </GraphQLDoc>
1582
+
1583
+ ## flushBufferedJobs {#flushbufferedjobs}
1584
+
1585
+ <GraphQLDoc
1586
+ type="mutation"
1587
+ typeName="flushBufferedJobs"
1588
+ typeLinks={{
1589
+ Success: '/reference/graphql-api/admin/object-types#success',
1590
+ String: '/reference/graphql-api/admin/object-types#string',
1591
+ }}
1592
+ >
1593
+ {`type Mutation {
1594
+ flushBufferedJobs(bufferIds: [String!]): Success!
1595
+ }`}
1596
+ </GraphQLDoc>
1597
+
1598
+ ## importProducts {#importproducts}
1599
+
1600
+ <GraphQLDoc
1601
+ type="mutation"
1602
+ typeName="importProducts"
1603
+ typeLinks={{
1604
+ ImportInfo: '/reference/graphql-api/admin/object-types#importinfo',
1605
+ Upload: '/reference/graphql-api/admin/object-types#upload',
1606
+ }}
1607
+ >
1608
+ {`type Mutation {
1609
+ importProducts(csvFile: Upload!): ImportInfo
1610
+ }`}
1611
+ </GraphQLDoc>
1612
+
1613
+ ## login {#login}
1614
+
1615
+ <GraphQLDoc
1616
+ type="mutation"
1617
+ typeName="login"
1618
+ typeLinks={{
1619
+ NativeAuthenticationResult: '/reference/graphql-api/admin/object-types#nativeauthenticationresult',
1620
+ String: '/reference/graphql-api/admin/object-types#string',
1621
+ Boolean: '/reference/graphql-api/admin/object-types#boolean',
1622
+ }}
1623
+ >
1624
+ {`"""
1625
+ Authenticates the user using the native authentication strategy. This mutation is an alias for authenticate({ native: { ... }})
1626
+
1627
+ The \`rememberMe\` option applies when using cookie-based sessions, and if \`true\` it will set the maxAge of the session cookie
1628
+ to 1 year.
1629
+ """
1630
+ type Mutation {
1631
+ login(username: String!, password: String!, rememberMe: Boolean): NativeAuthenticationResult!
1632
+ }`}
1633
+ </GraphQLDoc>
1634
+
1635
+ ## logout {#logout}
1636
+
1637
+ <GraphQLDoc
1638
+ type="mutation"
1639
+ typeName="logout"
1640
+ typeLinks={{
1641
+ Success: '/reference/graphql-api/admin/object-types#success',
1642
+ }}
1643
+ >
1644
+ {`type Mutation {
1645
+ logout: Success!
1646
+ }`}
1647
+ </GraphQLDoc>
1648
+
1649
+ ## modifyOrder {#modifyorder}
1650
+
1651
+ <GraphQLDoc
1652
+ type="mutation"
1653
+ typeName="modifyOrder"
1654
+ typeLinks={{
1655
+ ModifyOrderResult: '/reference/graphql-api/admin/object-types#modifyorderresult',
1656
+ ModifyOrderInput: '/reference/graphql-api/admin/input-types#modifyorderinput',
1657
+ }}
1658
+ >
1659
+ {`"""
1660
+ Allows an Order to be modified after it has been completed by the Customer. The Order must first
1661
+ be in the \`Modifying\` state.
1662
+ """
1663
+ type Mutation {
1664
+ modifyOrder(input: ModifyOrderInput!): ModifyOrderResult!
1665
+ }`}
1666
+ </GraphQLDoc>
1667
+
1668
+ ## moveCollection {#movecollection}
1669
+
1670
+ <GraphQLDoc
1671
+ type="mutation"
1672
+ typeName="moveCollection"
1673
+ typeLinks={{
1674
+ Collection: '/reference/graphql-api/admin/object-types#collection',
1675
+ MoveCollectionInput: '/reference/graphql-api/admin/input-types#movecollectioninput',
1676
+ }}
1677
+ >
1678
+ {`"""Move a Collection to a different parent or index"""
1679
+ type Mutation {
1680
+ moveCollection(input: MoveCollectionInput!): Collection!
1681
+ }`}
1682
+ </GraphQLDoc>
1683
+
1684
+ ## refundOrder {#refundorder}
1685
+
1686
+ <GraphQLDoc
1687
+ type="mutation"
1688
+ typeName="refundOrder"
1689
+ typeLinks={{
1690
+ RefundOrderResult: '/reference/graphql-api/admin/object-types#refundorderresult',
1691
+ RefundOrderInput: '/reference/graphql-api/admin/input-types#refundorderinput',
1692
+ }}
1693
+ >
1694
+ {`type Mutation {
1695
+ refundOrder(input: RefundOrderInput!): RefundOrderResult!
1696
+ }`}
1697
+ </GraphQLDoc>
1698
+
1699
+ ## reindex {#reindex}
1700
+
1701
+ <GraphQLDoc
1702
+ type="mutation"
1703
+ typeName="reindex"
1704
+ typeLinks={{
1705
+ Job: '/reference/graphql-api/admin/object-types#job',
1706
+ }}
1707
+ >
1708
+ {`type Mutation {
1709
+ reindex: Job!
1710
+ }`}
1711
+ </GraphQLDoc>
1712
+
1713
+ ## removeCollectionsFromChannel {#removecollectionsfromchannel}
1714
+
1715
+ <GraphQLDoc
1716
+ type="mutation"
1717
+ typeName="removeCollectionsFromChannel"
1718
+ typeLinks={{
1719
+ Collection: '/reference/graphql-api/admin/object-types#collection',
1720
+ RemoveCollectionsFromChannelInput: '/reference/graphql-api/admin/input-types#removecollectionsfromchannelinput',
1721
+ }}
1722
+ >
1723
+ {`"""Removes Collections from the specified Channel"""
1724
+ type Mutation {
1725
+ removeCollectionsFromChannel(input: RemoveCollectionsFromChannelInput!): [Collection!]!
1726
+ }`}
1727
+ </GraphQLDoc>
1728
+
1729
+ ## removeCouponCodeFromDraftOrder {#removecouponcodefromdraftorder}
1730
+
1731
+ <GraphQLDoc
1732
+ type="mutation"
1733
+ typeName="removeCouponCodeFromDraftOrder"
1734
+ typeLinks={{
1735
+ Order: '/reference/graphql-api/admin/object-types#order',
1736
+ ID: '/reference/graphql-api/admin/object-types#id',
1737
+ String: '/reference/graphql-api/admin/object-types#string',
1738
+ }}
1739
+ >
1740
+ {`"""Removes the given coupon code from the draft Order"""
1741
+ type Mutation {
1742
+ removeCouponCodeFromDraftOrder(orderId: ID!, couponCode: String!): Order
1743
+ }`}
1744
+ </GraphQLDoc>
1745
+
1746
+ ## removeCustomersFromGroup {#removecustomersfromgroup}
1747
+
1748
+ <GraphQLDoc
1749
+ type="mutation"
1750
+ typeName="removeCustomersFromGroup"
1751
+ typeLinks={{
1752
+ CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
1753
+ ID: '/reference/graphql-api/admin/object-types#id',
1754
+ }}
1755
+ >
1756
+ {`"""Remove Customers from a CustomerGroup"""
1757
+ type Mutation {
1758
+ removeCustomersFromGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup!
1759
+ }`}
1760
+ </GraphQLDoc>
1761
+
1762
+ ## removeDraftOrderLine {#removedraftorderline}
1763
+
1764
+ <GraphQLDoc
1765
+ type="mutation"
1766
+ typeName="removeDraftOrderLine"
1767
+ typeLinks={{
1768
+ RemoveOrderItemsResult: '/reference/graphql-api/admin/object-types#removeorderitemsresult',
1769
+ ID: '/reference/graphql-api/admin/object-types#id',
1770
+ }}
1771
+ >
1772
+ {`"""Remove an OrderLine from the draft Order"""
1773
+ type Mutation {
1774
+ removeDraftOrderLine(orderId: ID!, orderLineId: ID!): RemoveOrderItemsResult!
1775
+ }`}
1776
+ </GraphQLDoc>
1777
+
1778
+ ## removeFacetsFromChannel {#removefacetsfromchannel}
1779
+
1780
+ <GraphQLDoc
1781
+ type="mutation"
1782
+ typeName="removeFacetsFromChannel"
1783
+ typeLinks={{
1784
+ RemoveFacetFromChannelResult: '/reference/graphql-api/admin/object-types#removefacetfromchannelresult',
1785
+ RemoveFacetsFromChannelInput: '/reference/graphql-api/admin/input-types#removefacetsfromchannelinput',
1786
+ }}
1787
+ >
1788
+ {`"""Removes Facets from the specified Channel"""
1789
+ type Mutation {
1790
+ removeFacetsFromChannel(input: RemoveFacetsFromChannelInput!): [RemoveFacetFromChannelResult!]!
1791
+ }`}
1792
+ </GraphQLDoc>
1793
+
1794
+ ## removeMembersFromZone {#removemembersfromzone}
1795
+
1796
+ <GraphQLDoc
1797
+ type="mutation"
1798
+ typeName="removeMembersFromZone"
1799
+ typeLinks={{
1800
+ Zone: '/reference/graphql-api/admin/object-types#zone',
1801
+ ID: '/reference/graphql-api/admin/object-types#id',
1802
+ }}
1803
+ >
1804
+ {`"""Remove members from a Zone"""
1805
+ type Mutation {
1806
+ removeMembersFromZone(zoneId: ID!, memberIds: [ID!]!): Zone!
1807
+ }`}
1808
+ </GraphQLDoc>
1809
+
1810
+ ## removeOptionGroupFromProduct {#removeoptiongroupfromproduct}
1811
+
1812
+ <GraphQLDoc
1813
+ type="mutation"
1814
+ typeName="removeOptionGroupFromProduct"
1815
+ typeLinks={{
1816
+ RemoveOptionGroupFromProductResult: '/reference/graphql-api/admin/object-types#removeoptiongroupfromproductresult',
1817
+ ID: '/reference/graphql-api/admin/object-types#id',
1818
+ Boolean: '/reference/graphql-api/admin/object-types#boolean',
1819
+ }}
1820
+ >
1821
+ {`"""
1822
+ Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants
1823
+ the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed.
1824
+ Setting the \`force\` argument to \`true\` will override this and remove the OptionGroup anyway,
1825
+ as well as removing any of the group's options from the Product's ProductVariants.
1826
+ """
1827
+ type Mutation {
1828
+ removeOptionGroupFromProduct(productId: ID!, optionGroupId: ID!, force: Boolean): RemoveOptionGroupFromProductResult!
1829
+ }`}
1830
+ </GraphQLDoc>
1831
+
1832
+ ## removePaymentMethodsFromChannel {#removepaymentmethodsfromchannel}
1833
+
1834
+ <GraphQLDoc
1835
+ type="mutation"
1836
+ typeName="removePaymentMethodsFromChannel"
1837
+ typeLinks={{
1838
+ PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
1839
+ RemovePaymentMethodsFromChannelInput: '/reference/graphql-api/admin/input-types#removepaymentmethodsfromchannelinput',
1840
+ }}
1841
+ >
1842
+ {`"""Removes PaymentMethods from the specified Channel"""
1843
+ type Mutation {
1844
+ removePaymentMethodsFromChannel(input: RemovePaymentMethodsFromChannelInput!): [PaymentMethod!]!
1845
+ }`}
1846
+ </GraphQLDoc>
1847
+
1848
+ ## removeProductVariantsFromChannel {#removeproductvariantsfromchannel}
1849
+
1850
+ <GraphQLDoc
1851
+ type="mutation"
1852
+ typeName="removeProductVariantsFromChannel"
1853
+ typeLinks={{
1854
+ ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
1855
+ RemoveProductVariantsFromChannelInput: '/reference/graphql-api/admin/input-types#removeproductvariantsfromchannelinput',
1856
+ }}
1857
+ >
1858
+ {`"""Removes ProductVariants from the specified Channel"""
1859
+ type Mutation {
1860
+ removeProductVariantsFromChannel(input: RemoveProductVariantsFromChannelInput!): [ProductVariant!]!
1861
+ }`}
1862
+ </GraphQLDoc>
1863
+
1864
+ ## removeProductsFromChannel {#removeproductsfromchannel}
1865
+
1866
+ <GraphQLDoc
1867
+ type="mutation"
1868
+ typeName="removeProductsFromChannel"
1869
+ typeLinks={{
1870
+ Product: '/reference/graphql-api/admin/object-types#product',
1871
+ RemoveProductsFromChannelInput: '/reference/graphql-api/admin/input-types#removeproductsfromchannelinput',
1872
+ }}
1873
+ >
1874
+ {`"""Removes all ProductVariants of Product from the specified Channel"""
1875
+ type Mutation {
1876
+ removeProductsFromChannel(input: RemoveProductsFromChannelInput!): [Product!]!
1877
+ }`}
1878
+ </GraphQLDoc>
1879
+
1880
+ ## removePromotionsFromChannel {#removepromotionsfromchannel}
1881
+
1882
+ <GraphQLDoc
1883
+ type="mutation"
1884
+ typeName="removePromotionsFromChannel"
1885
+ typeLinks={{
1886
+ Promotion: '/reference/graphql-api/admin/object-types#promotion',
1887
+ RemovePromotionsFromChannelInput: '/reference/graphql-api/admin/input-types#removepromotionsfromchannelinput',
1888
+ }}
1889
+ >
1890
+ {`"""Removes Promotions from the specified Channel"""
1891
+ type Mutation {
1892
+ removePromotionsFromChannel(input: RemovePromotionsFromChannelInput!): [Promotion!]!
1893
+ }`}
1894
+ </GraphQLDoc>
1895
+
1896
+ ## removeSettledJobs {#removesettledjobs}
1897
+
1898
+ <GraphQLDoc
1899
+ type="mutation"
1900
+ typeName="removeSettledJobs"
1901
+ typeLinks={{
1902
+ Int: '/reference/graphql-api/admin/object-types#int',
1903
+ String: '/reference/graphql-api/admin/object-types#string',
1904
+ DateTime: '/reference/graphql-api/admin/object-types#datetime',
1905
+ }}
1906
+ >
1907
+ {`"""Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted."""
1908
+ type Mutation {
1909
+ removeSettledJobs(queueNames: [String!], olderThan: DateTime): Int!
1910
+ }`}
1911
+ </GraphQLDoc>
1912
+
1913
+ ## removeShippingMethodsFromChannel {#removeshippingmethodsfromchannel}
1914
+
1915
+ <GraphQLDoc
1916
+ type="mutation"
1917
+ typeName="removeShippingMethodsFromChannel"
1918
+ typeLinks={{
1919
+ ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
1920
+ RemoveShippingMethodsFromChannelInput: '/reference/graphql-api/admin/input-types#removeshippingmethodsfromchannelinput',
1921
+ }}
1922
+ >
1923
+ {`"""Removes ShippingMethods from the specified Channel"""
1924
+ type Mutation {
1925
+ removeShippingMethodsFromChannel(input: RemoveShippingMethodsFromChannelInput!): [ShippingMethod!]!
1926
+ }`}
1927
+ </GraphQLDoc>
1928
+
1929
+ ## removeStockLocationsFromChannel {#removestocklocationsfromchannel}
1930
+
1931
+ <GraphQLDoc
1932
+ type="mutation"
1933
+ typeName="removeStockLocationsFromChannel"
1934
+ typeLinks={{
1935
+ StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
1936
+ RemoveStockLocationsFromChannelInput: '/reference/graphql-api/admin/input-types#removestocklocationsfromchannelinput',
1937
+ }}
1938
+ >
1939
+ {`"""Removes StockLocations from the specified Channel"""
1940
+ type Mutation {
1941
+ removeStockLocationsFromChannel(input: RemoveStockLocationsFromChannelInput!): [StockLocation!]!
1942
+ }`}
1943
+ </GraphQLDoc>
1944
+
1945
+ ## runPendingSearchIndexUpdates {#runpendingsearchindexupdates}
1946
+
1947
+ <GraphQLDoc
1948
+ type="mutation"
1949
+ typeName="runPendingSearchIndexUpdates"
1950
+ typeLinks={{
1951
+ Success: '/reference/graphql-api/admin/object-types#success',
1952
+ }}
1953
+ >
1954
+ {`type Mutation {
1955
+ runPendingSearchIndexUpdates: Success!
1956
+ }`}
1957
+ </GraphQLDoc>
1958
+
1959
+ ## runScheduledTask {#runscheduledtask}
1960
+
1961
+ <GraphQLDoc
1962
+ type="mutation"
1963
+ typeName="runScheduledTask"
1964
+ typeLinks={{
1965
+ Success: '/reference/graphql-api/admin/object-types#success',
1966
+ String: '/reference/graphql-api/admin/object-types#string',
1967
+ }}
1968
+ >
1969
+ {`type Mutation {
1970
+ runScheduledTask(id: String!): Success!
1971
+ }`}
1972
+ </GraphQLDoc>
1973
+
1974
+ ## setCustomerForDraftOrder {#setcustomerfordraftorder}
1975
+
1976
+ <GraphQLDoc
1977
+ type="mutation"
1978
+ typeName="setCustomerForDraftOrder"
1979
+ typeLinks={{
1980
+ SetCustomerForDraftOrderResult: '/reference/graphql-api/admin/object-types#setcustomerfordraftorderresult',
1981
+ ID: '/reference/graphql-api/admin/object-types#id',
1982
+ CreateCustomerInput: '/reference/graphql-api/admin/input-types#createcustomerinput',
1983
+ }}
1984
+ >
1985
+ {`type Mutation {
1986
+ setCustomerForDraftOrder(orderId: ID!, customerId: ID, input: CreateCustomerInput): SetCustomerForDraftOrderResult!
1987
+ }`}
1988
+ </GraphQLDoc>
1989
+
1990
+ ## setDraftOrderBillingAddress {#setdraftorderbillingaddress}
1991
+
1992
+ <GraphQLDoc
1993
+ type="mutation"
1994
+ typeName="setDraftOrderBillingAddress"
1995
+ typeLinks={{
1996
+ Order: '/reference/graphql-api/admin/object-types#order',
1997
+ ID: '/reference/graphql-api/admin/object-types#id',
1998
+ CreateAddressInput: '/reference/graphql-api/admin/input-types#createaddressinput',
1999
+ }}
2000
+ >
2001
+ {`"""Sets the billing address for a draft Order"""
2002
+ type Mutation {
2003
+ setDraftOrderBillingAddress(orderId: ID!, input: CreateAddressInput!): Order!
2004
+ }`}
2005
+ </GraphQLDoc>
2006
+
2007
+ ## setDraftOrderCustomFields {#setdraftordercustomfields}
2008
+
2009
+ <GraphQLDoc
2010
+ type="mutation"
2011
+ typeName="setDraftOrderCustomFields"
2012
+ typeLinks={{
2013
+ Order: '/reference/graphql-api/admin/object-types#order',
2014
+ ID: '/reference/graphql-api/admin/object-types#id',
2015
+ UpdateOrderInput: '/reference/graphql-api/admin/input-types#updateorderinput',
2016
+ }}
2017
+ >
2018
+ {`"""Allows any custom fields to be set for the active order"""
2019
+ type Mutation {
2020
+ setDraftOrderCustomFields(orderId: ID!, input: UpdateOrderInput!): Order!
2021
+ }`}
2022
+ </GraphQLDoc>
2023
+
2024
+ ## setDraftOrderShippingAddress {#setdraftordershippingaddress}
2025
+
2026
+ <GraphQLDoc
2027
+ type="mutation"
2028
+ typeName="setDraftOrderShippingAddress"
2029
+ typeLinks={{
2030
+ Order: '/reference/graphql-api/admin/object-types#order',
2031
+ ID: '/reference/graphql-api/admin/object-types#id',
2032
+ CreateAddressInput: '/reference/graphql-api/admin/input-types#createaddressinput',
2033
+ }}
2034
+ >
2035
+ {`"""Sets the shipping address for a draft Order"""
2036
+ type Mutation {
2037
+ setDraftOrderShippingAddress(orderId: ID!, input: CreateAddressInput!): Order!
2038
+ }`}
2039
+ </GraphQLDoc>
2040
+
2041
+ ## setDraftOrderShippingMethod {#setdraftordershippingmethod}
2042
+
2043
+ <GraphQLDoc
2044
+ type="mutation"
2045
+ typeName="setDraftOrderShippingMethod"
2046
+ typeLinks={{
2047
+ SetOrderShippingMethodResult: '/reference/graphql-api/admin/object-types#setordershippingmethodresult',
2048
+ ID: '/reference/graphql-api/admin/object-types#id',
2049
+ }}
2050
+ >
2051
+ {`"""Sets the shipping method by id, which can be obtained with the \`eligibleShippingMethodsForDraftOrder\` query"""
2052
+ type Mutation {
2053
+ setDraftOrderShippingMethod(orderId: ID!, shippingMethodId: ID!): SetOrderShippingMethodResult!
2054
+ }`}
2055
+ </GraphQLDoc>
2056
+
2057
+ ## setOrderCustomFields {#setordercustomfields}
2058
+
2059
+ <GraphQLDoc
2060
+ type="mutation"
2061
+ typeName="setOrderCustomFields"
2062
+ typeLinks={{
2063
+ Order: '/reference/graphql-api/admin/object-types#order',
2064
+ UpdateOrderInput: '/reference/graphql-api/admin/input-types#updateorderinput',
2065
+ }}
2066
+ >
2067
+ {`type Mutation {
2068
+ setOrderCustomFields(input: UpdateOrderInput!): Order
2069
+ }`}
2070
+ </GraphQLDoc>
2071
+
2072
+ ## setOrderCustomer {#setordercustomer}
2073
+
2074
+ <GraphQLDoc
2075
+ type="mutation"
2076
+ typeName="setOrderCustomer"
2077
+ typeLinks={{
2078
+ Order: '/reference/graphql-api/admin/object-types#order',
2079
+ SetOrderCustomerInput: '/reference/graphql-api/admin/input-types#setordercustomerinput',
2080
+ }}
2081
+ >
2082
+ {`"""Allows a different Customer to be assigned to an Order. Added in v2.2.0."""
2083
+ type Mutation {
2084
+ setOrderCustomer(input: SetOrderCustomerInput!): Order
2085
+ }`}
2086
+ </GraphQLDoc>
2087
+
2088
+ ## setSettingsStoreValue {#setsettingsstorevalue}
2089
+
2090
+ <GraphQLDoc
2091
+ type="mutation"
2092
+ typeName="setSettingsStoreValue"
2093
+ typeLinks={{
2094
+ SetSettingsStoreValueResult: '/reference/graphql-api/admin/object-types#setsettingsstorevalueresult',
2095
+ SettingsStoreInput: '/reference/graphql-api/admin/input-types#settingsstoreinput',
2096
+ }}
2097
+ >
2098
+ {`"""Set a single key-value pair (automatically scoped based on field configuration)"""
2099
+ type Mutation {
2100
+ setSettingsStoreValue(input: SettingsStoreInput!): SetSettingsStoreValueResult!
2101
+ }`}
2102
+ </GraphQLDoc>
2103
+
2104
+ ## setSettingsStoreValues {#setsettingsstorevalues}
2105
+
2106
+ <GraphQLDoc
2107
+ type="mutation"
2108
+ typeName="setSettingsStoreValues"
2109
+ typeLinks={{
2110
+ SetSettingsStoreValueResult: '/reference/graphql-api/admin/object-types#setsettingsstorevalueresult',
2111
+ SettingsStoreInput: '/reference/graphql-api/admin/input-types#settingsstoreinput',
2112
+ }}
2113
+ >
2114
+ {`"""Set multiple key-value pairs in a transaction (each automatically scoped)"""
2115
+ type Mutation {
2116
+ setSettingsStoreValues(inputs: [SettingsStoreInput!]!): [SetSettingsStoreValueResult!]!
2117
+ }`}
2118
+ </GraphQLDoc>
2119
+
2120
+ ## settlePayment {#settlepayment}
2121
+
2122
+ <GraphQLDoc
2123
+ type="mutation"
2124
+ typeName="settlePayment"
2125
+ typeLinks={{
2126
+ SettlePaymentResult: '/reference/graphql-api/admin/object-types#settlepaymentresult',
2127
+ ID: '/reference/graphql-api/admin/object-types#id',
2128
+ }}
2129
+ >
2130
+ {`type Mutation {
2131
+ settlePayment(id: ID!): SettlePaymentResult!
2132
+ }`}
2133
+ </GraphQLDoc>
2134
+
2135
+ ## settleRefund {#settlerefund}
2136
+
2137
+ <GraphQLDoc
2138
+ type="mutation"
2139
+ typeName="settleRefund"
2140
+ typeLinks={{
2141
+ SettleRefundResult: '/reference/graphql-api/admin/object-types#settlerefundresult',
2142
+ SettleRefundInput: '/reference/graphql-api/admin/input-types#settlerefundinput',
2143
+ }}
2144
+ >
2145
+ {`type Mutation {
2146
+ settleRefund(input: SettleRefundInput!): SettleRefundResult!
2147
+ }`}
2148
+ </GraphQLDoc>
2149
+
2150
+ ## transitionFulfillmentToState {#transitionfulfillmenttostate}
2151
+
2152
+ <GraphQLDoc
2153
+ type="mutation"
2154
+ typeName="transitionFulfillmentToState"
2155
+ typeLinks={{
2156
+ TransitionFulfillmentToStateResult: '/reference/graphql-api/admin/object-types#transitionfulfillmenttostateresult',
2157
+ ID: '/reference/graphql-api/admin/object-types#id',
2158
+ String: '/reference/graphql-api/admin/object-types#string',
2159
+ }}
2160
+ >
2161
+ {`type Mutation {
2162
+ transitionFulfillmentToState(id: ID!, state: String!): TransitionFulfillmentToStateResult!
2163
+ }`}
2164
+ </GraphQLDoc>
2165
+
2166
+ ## transitionOrderToState {#transitionordertostate}
2167
+
2168
+ <GraphQLDoc
2169
+ type="mutation"
2170
+ typeName="transitionOrderToState"
2171
+ typeLinks={{
2172
+ TransitionOrderToStateResult: '/reference/graphql-api/admin/object-types#transitionordertostateresult',
2173
+ ID: '/reference/graphql-api/admin/object-types#id',
2174
+ String: '/reference/graphql-api/admin/object-types#string',
2175
+ }}
2176
+ >
2177
+ {`type Mutation {
2178
+ transitionOrderToState(id: ID!, state: String!): TransitionOrderToStateResult
2179
+ }`}
2180
+ </GraphQLDoc>
2181
+
2182
+ ## transitionPaymentToState {#transitionpaymenttostate}
2183
+
2184
+ <GraphQLDoc
2185
+ type="mutation"
2186
+ typeName="transitionPaymentToState"
2187
+ typeLinks={{
2188
+ TransitionPaymentToStateResult: '/reference/graphql-api/admin/object-types#transitionpaymenttostateresult',
2189
+ ID: '/reference/graphql-api/admin/object-types#id',
2190
+ String: '/reference/graphql-api/admin/object-types#string',
2191
+ }}
2192
+ >
2193
+ {`type Mutation {
2194
+ transitionPaymentToState(id: ID!, state: String!): TransitionPaymentToStateResult!
2195
+ }`}
2196
+ </GraphQLDoc>
2197
+
2198
+ ## unsetDraftOrderBillingAddress {#unsetdraftorderbillingaddress}
2199
+
2200
+ <GraphQLDoc
2201
+ type="mutation"
2202
+ typeName="unsetDraftOrderBillingAddress"
2203
+ typeLinks={{
2204
+ Order: '/reference/graphql-api/admin/object-types#order',
2205
+ ID: '/reference/graphql-api/admin/object-types#id',
2206
+ }}
2207
+ >
2208
+ {`"""Unsets the billing address for a draft Order"""
2209
+ type Mutation {
2210
+ unsetDraftOrderBillingAddress(orderId: ID!): Order!
2211
+ }`}
2212
+ </GraphQLDoc>
2213
+
2214
+ ## unsetDraftOrderShippingAddress {#unsetdraftordershippingaddress}
2215
+
2216
+ <GraphQLDoc
2217
+ type="mutation"
2218
+ typeName="unsetDraftOrderShippingAddress"
2219
+ typeLinks={{
2220
+ Order: '/reference/graphql-api/admin/object-types#order',
2221
+ ID: '/reference/graphql-api/admin/object-types#id',
2222
+ }}
2223
+ >
2224
+ {`"""Unsets the shipping address for a draft Order"""
2225
+ type Mutation {
2226
+ unsetDraftOrderShippingAddress(orderId: ID!): Order!
2227
+ }`}
2228
+ </GraphQLDoc>
2229
+
2230
+ ## updateActiveAdministrator {#updateactiveadministrator}
2231
+
2232
+ <GraphQLDoc
2233
+ type="mutation"
2234
+ typeName="updateActiveAdministrator"
2235
+ typeLinks={{
2236
+ Administrator: '/reference/graphql-api/admin/object-types#administrator',
2237
+ UpdateActiveAdministratorInput: '/reference/graphql-api/admin/input-types#updateactiveadministratorinput',
2238
+ }}
2239
+ >
2240
+ {`"""Update the active (currently logged-in) Administrator"""
2241
+ type Mutation {
2242
+ updateActiveAdministrator(input: UpdateActiveAdministratorInput!): Administrator!
2243
+ }`}
2244
+ </GraphQLDoc>
2245
+
2246
+ ## updateAdministrator {#updateadministrator}
2247
+
2248
+ <GraphQLDoc
2249
+ type="mutation"
2250
+ typeName="updateAdministrator"
2251
+ typeLinks={{
2252
+ Administrator: '/reference/graphql-api/admin/object-types#administrator',
2253
+ UpdateAdministratorInput: '/reference/graphql-api/admin/input-types#updateadministratorinput',
2254
+ }}
2255
+ >
2256
+ {`"""Update an existing Administrator"""
2257
+ type Mutation {
2258
+ updateAdministrator(input: UpdateAdministratorInput!): Administrator!
2259
+ }`}
2260
+ </GraphQLDoc>
2261
+
2262
+ ## updateAsset {#updateasset}
2263
+
2264
+ <GraphQLDoc
2265
+ type="mutation"
2266
+ typeName="updateAsset"
2267
+ typeLinks={{
2268
+ Asset: '/reference/graphql-api/admin/object-types#asset',
2269
+ UpdateAssetInput: '/reference/graphql-api/admin/input-types#updateassetinput',
2270
+ }}
2271
+ >
2272
+ {`"""Update an existing Asset"""
2273
+ type Mutation {
2274
+ updateAsset(input: UpdateAssetInput!): Asset!
2275
+ }`}
2276
+ </GraphQLDoc>
2277
+
2278
+ ## updateChannel {#updatechannel}
2279
+
2280
+ <GraphQLDoc
2281
+ type="mutation"
2282
+ typeName="updateChannel"
2283
+ typeLinks={{
2284
+ UpdateChannelResult: '/reference/graphql-api/admin/object-types#updatechannelresult',
2285
+ UpdateChannelInput: '/reference/graphql-api/admin/input-types#updatechannelinput',
2286
+ }}
2287
+ >
2288
+ {`"""Update an existing Channel"""
2289
+ type Mutation {
2290
+ updateChannel(input: UpdateChannelInput!): UpdateChannelResult!
2291
+ }`}
2292
+ </GraphQLDoc>
2293
+
2294
+ ## updateCollection {#updatecollection}
2295
+
2296
+ <GraphQLDoc
2297
+ type="mutation"
2298
+ typeName="updateCollection"
2299
+ typeLinks={{
2300
+ Collection: '/reference/graphql-api/admin/object-types#collection',
2301
+ UpdateCollectionInput: '/reference/graphql-api/admin/input-types#updatecollectioninput',
2302
+ }}
2303
+ >
2304
+ {`"""Update an existing Collection"""
2305
+ type Mutation {
2306
+ updateCollection(input: UpdateCollectionInput!): Collection!
2307
+ }`}
2308
+ </GraphQLDoc>
2309
+
2310
+ ## updateCountry {#updatecountry}
2311
+
2312
+ <GraphQLDoc
2313
+ type="mutation"
2314
+ typeName="updateCountry"
2315
+ typeLinks={{
2316
+ Country: '/reference/graphql-api/admin/object-types#country',
2317
+ UpdateCountryInput: '/reference/graphql-api/admin/input-types#updatecountryinput',
2318
+ }}
2319
+ >
2320
+ {`"""Update an existing Country"""
2321
+ type Mutation {
2322
+ updateCountry(input: UpdateCountryInput!): Country!
2323
+ }`}
2324
+ </GraphQLDoc>
2325
+
2326
+ ## updateCustomer {#updatecustomer}
2327
+
2328
+ <GraphQLDoc
2329
+ type="mutation"
2330
+ typeName="updateCustomer"
2331
+ typeLinks={{
2332
+ UpdateCustomerResult: '/reference/graphql-api/admin/object-types#updatecustomerresult',
2333
+ UpdateCustomerInput: '/reference/graphql-api/admin/input-types#updatecustomerinput',
2334
+ }}
2335
+ >
2336
+ {`"""Update an existing Customer"""
2337
+ type Mutation {
2338
+ updateCustomer(input: UpdateCustomerInput!): UpdateCustomerResult!
2339
+ }`}
2340
+ </GraphQLDoc>
2341
+
2342
+ ## updateCustomerAddress {#updatecustomeraddress}
2343
+
2344
+ <GraphQLDoc
2345
+ type="mutation"
2346
+ typeName="updateCustomerAddress"
2347
+ typeLinks={{
2348
+ Address: '/reference/graphql-api/admin/object-types#address',
2349
+ UpdateAddressInput: '/reference/graphql-api/admin/input-types#updateaddressinput',
2350
+ }}
2351
+ >
2352
+ {`"""Update an existing Address"""
2353
+ type Mutation {
2354
+ updateCustomerAddress(input: UpdateAddressInput!): Address!
2355
+ }`}
2356
+ </GraphQLDoc>
2357
+
2358
+ ## updateCustomerGroup {#updatecustomergroup}
2359
+
2360
+ <GraphQLDoc
2361
+ type="mutation"
2362
+ typeName="updateCustomerGroup"
2363
+ typeLinks={{
2364
+ CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
2365
+ UpdateCustomerGroupInput: '/reference/graphql-api/admin/input-types#updatecustomergroupinput',
2366
+ }}
2367
+ >
2368
+ {`"""Update an existing CustomerGroup"""
2369
+ type Mutation {
2370
+ updateCustomerGroup(input: UpdateCustomerGroupInput!): CustomerGroup!
2371
+ }`}
2372
+ </GraphQLDoc>
2373
+
2374
+ ## updateCustomerNote {#updatecustomernote}
2375
+
2376
+ <GraphQLDoc
2377
+ type="mutation"
2378
+ typeName="updateCustomerNote"
2379
+ typeLinks={{
2380
+ HistoryEntry: '/reference/graphql-api/admin/object-types#historyentry',
2381
+ UpdateCustomerNoteInput: '/reference/graphql-api/admin/input-types#updatecustomernoteinput',
2382
+ }}
2383
+ >
2384
+ {`type Mutation {
2385
+ updateCustomerNote(input: UpdateCustomerNoteInput!): HistoryEntry!
2386
+ }`}
2387
+ </GraphQLDoc>
2388
+
2389
+ ## updateFacet {#updatefacet}
2390
+
2391
+ <GraphQLDoc
2392
+ type="mutation"
2393
+ typeName="updateFacet"
2394
+ typeLinks={{
2395
+ Facet: '/reference/graphql-api/admin/object-types#facet',
2396
+ UpdateFacetInput: '/reference/graphql-api/admin/input-types#updatefacetinput',
2397
+ }}
2398
+ >
2399
+ {`"""Update an existing Facet"""
2400
+ type Mutation {
2401
+ updateFacet(input: UpdateFacetInput!): Facet!
2402
+ }`}
2403
+ </GraphQLDoc>
2404
+
2405
+ ## updateFacetValue {#updatefacetvalue}
2406
+
2407
+ <GraphQLDoc
2408
+ type="mutation"
2409
+ typeName="updateFacetValue"
2410
+ typeLinks={{
2411
+ FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
2412
+ UpdateFacetValueInput: '/reference/graphql-api/admin/input-types#updatefacetvalueinput',
2413
+ }}
2414
+ >
2415
+ {`"""Update a single FacetValue"""
2416
+ type Mutation {
2417
+ updateFacetValue(input: UpdateFacetValueInput!): FacetValue!
2418
+ }`}
2419
+ </GraphQLDoc>
2420
+
2421
+ ## updateFacetValues {#updatefacetvalues}
2422
+
2423
+ <GraphQLDoc
2424
+ type="mutation"
2425
+ typeName="updateFacetValues"
2426
+ typeLinks={{
2427
+ FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
2428
+ UpdateFacetValueInput: '/reference/graphql-api/admin/input-types#updatefacetvalueinput',
2429
+ }}
2430
+ >
2431
+ {`"""Update one or more FacetValues"""
2432
+ type Mutation {
2433
+ updateFacetValues(input: [UpdateFacetValueInput!]!): [FacetValue!]!
2434
+ }`}
2435
+ </GraphQLDoc>
2436
+
2437
+ ## updateGlobalSettings {#updateglobalsettings}
2438
+
2439
+ <GraphQLDoc
2440
+ type="mutation"
2441
+ typeName="updateGlobalSettings"
2442
+ typeLinks={{
2443
+ UpdateGlobalSettingsResult: '/reference/graphql-api/admin/object-types#updateglobalsettingsresult',
2444
+ UpdateGlobalSettingsInput: '/reference/graphql-api/admin/input-types#updateglobalsettingsinput',
2445
+ }}
2446
+ >
2447
+ {`type Mutation {
2448
+ updateGlobalSettings(input: UpdateGlobalSettingsInput!): UpdateGlobalSettingsResult!
2449
+ }`}
2450
+ </GraphQLDoc>
2451
+
2452
+ ## updateOrderNote {#updateordernote}
2453
+
2454
+ <GraphQLDoc
2455
+ type="mutation"
2456
+ typeName="updateOrderNote"
2457
+ typeLinks={{
2458
+ HistoryEntry: '/reference/graphql-api/admin/object-types#historyentry',
2459
+ UpdateOrderNoteInput: '/reference/graphql-api/admin/input-types#updateordernoteinput',
2460
+ }}
2461
+ >
2462
+ {`type Mutation {
2463
+ updateOrderNote(input: UpdateOrderNoteInput!): HistoryEntry!
2464
+ }`}
2465
+ </GraphQLDoc>
2466
+
2467
+ ## updatePaymentMethod {#updatepaymentmethod}
2468
+
2469
+ <GraphQLDoc
2470
+ type="mutation"
2471
+ typeName="updatePaymentMethod"
2472
+ typeLinks={{
2473
+ PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
2474
+ UpdatePaymentMethodInput: '/reference/graphql-api/admin/input-types#updatepaymentmethodinput',
2475
+ }}
2476
+ >
2477
+ {`"""Update an existing PaymentMethod"""
2478
+ type Mutation {
2479
+ updatePaymentMethod(input: UpdatePaymentMethodInput!): PaymentMethod!
2480
+ }`}
2481
+ </GraphQLDoc>
2482
+
2483
+ ## updateProduct {#updateproduct}
2484
+
2485
+ <GraphQLDoc
2486
+ type="mutation"
2487
+ typeName="updateProduct"
2488
+ typeLinks={{
2489
+ Product: '/reference/graphql-api/admin/object-types#product',
2490
+ UpdateProductInput: '/reference/graphql-api/admin/input-types#updateproductinput',
2491
+ }}
2492
+ >
2493
+ {`"""Update an existing Product"""
2494
+ type Mutation {
2495
+ updateProduct(input: UpdateProductInput!): Product!
2496
+ }`}
2497
+ </GraphQLDoc>
2498
+
2499
+ ## updateProductOption {#updateproductoption}
2500
+
2501
+ <GraphQLDoc
2502
+ type="mutation"
2503
+ typeName="updateProductOption"
2504
+ typeLinks={{
2505
+ ProductOption: '/reference/graphql-api/admin/object-types#productoption',
2506
+ UpdateProductOptionInput: '/reference/graphql-api/admin/input-types#updateproductoptioninput',
2507
+ }}
2508
+ >
2509
+ {`"""Create a new ProductOption within a ProductOptionGroup"""
2510
+ type Mutation {
2511
+ updateProductOption(input: UpdateProductOptionInput!): ProductOption!
2512
+ }`}
2513
+ </GraphQLDoc>
2514
+
2515
+ ## updateProductOptionGroup {#updateproductoptiongroup}
2516
+
2517
+ <GraphQLDoc
2518
+ type="mutation"
2519
+ typeName="updateProductOptionGroup"
2520
+ typeLinks={{
2521
+ ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
2522
+ UpdateProductOptionGroupInput: '/reference/graphql-api/admin/input-types#updateproductoptiongroupinput',
2523
+ }}
2524
+ >
2525
+ {`"""Update an existing ProductOptionGroup"""
2526
+ type Mutation {
2527
+ updateProductOptionGroup(input: UpdateProductOptionGroupInput!): ProductOptionGroup!
2528
+ }`}
2529
+ </GraphQLDoc>
2530
+
2531
+ ## updateProductVariant {#updateproductvariant}
2532
+
2533
+ <GraphQLDoc
2534
+ type="mutation"
2535
+ typeName="updateProductVariant"
2536
+ typeLinks={{
2537
+ ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
2538
+ UpdateProductVariantInput: '/reference/graphql-api/admin/input-types#updateproductvariantinput',
2539
+ }}
2540
+ >
2541
+ {`"""Update an existing ProductVariant"""
2542
+ type Mutation {
2543
+ updateProductVariant(input: UpdateProductVariantInput!): ProductVariant!
2544
+ }`}
2545
+ </GraphQLDoc>
2546
+
2547
+ ## updateProductVariants {#updateproductvariants}
2548
+
2549
+ <GraphQLDoc
2550
+ type="mutation"
2551
+ typeName="updateProductVariants"
2552
+ typeLinks={{
2553
+ ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
2554
+ UpdateProductVariantInput: '/reference/graphql-api/admin/input-types#updateproductvariantinput',
2555
+ }}
2556
+ >
2557
+ {`"""Update existing ProductVariants"""
2558
+ type Mutation {
2559
+ updateProductVariants(input: [UpdateProductVariantInput!]!): [ProductVariant]!
2560
+ }`}
2561
+ </GraphQLDoc>
2562
+
2563
+ ## updateProducts {#updateproducts}
2564
+
2565
+ <GraphQLDoc
2566
+ type="mutation"
2567
+ typeName="updateProducts"
2568
+ typeLinks={{
2569
+ Product: '/reference/graphql-api/admin/object-types#product',
2570
+ UpdateProductInput: '/reference/graphql-api/admin/input-types#updateproductinput',
2571
+ }}
2572
+ >
2573
+ {`"""Update multiple existing Products"""
2574
+ type Mutation {
2575
+ updateProducts(input: [UpdateProductInput!]!): [Product!]!
2576
+ }`}
2577
+ </GraphQLDoc>
2578
+
2579
+ ## updatePromotion {#updatepromotion}
2580
+
2581
+ <GraphQLDoc
2582
+ type="mutation"
2583
+ typeName="updatePromotion"
2584
+ typeLinks={{
2585
+ UpdatePromotionResult: '/reference/graphql-api/admin/object-types#updatepromotionresult',
2586
+ UpdatePromotionInput: '/reference/graphql-api/admin/input-types#updatepromotioninput',
2587
+ }}
2588
+ >
2589
+ {`type Mutation {
2590
+ updatePromotion(input: UpdatePromotionInput!): UpdatePromotionResult!
2591
+ }`}
2592
+ </GraphQLDoc>
2593
+
2594
+ ## updateProvince {#updateprovince}
2595
+
2596
+ <GraphQLDoc
2597
+ type="mutation"
2598
+ typeName="updateProvince"
2599
+ typeLinks={{
2600
+ Province: '/reference/graphql-api/admin/object-types#province',
2601
+ UpdateProvinceInput: '/reference/graphql-api/admin/input-types#updateprovinceinput',
2602
+ }}
2603
+ >
2604
+ {`"""Update an existing Province"""
2605
+ type Mutation {
2606
+ updateProvince(input: UpdateProvinceInput!): Province!
2607
+ }`}
2608
+ </GraphQLDoc>
2609
+
2610
+ ## updateRole {#updaterole}
2611
+
2612
+ <GraphQLDoc
2613
+ type="mutation"
2614
+ typeName="updateRole"
2615
+ typeLinks={{
2616
+ Role: '/reference/graphql-api/admin/object-types#role',
2617
+ UpdateRoleInput: '/reference/graphql-api/admin/input-types#updateroleinput',
2618
+ }}
2619
+ >
2620
+ {`"""Update an existing Role"""
2621
+ type Mutation {
2622
+ updateRole(input: UpdateRoleInput!): Role!
2623
+ }`}
2624
+ </GraphQLDoc>
2625
+
2626
+ ## updateScheduledTask {#updatescheduledtask}
2627
+
2628
+ <GraphQLDoc
2629
+ type="mutation"
2630
+ typeName="updateScheduledTask"
2631
+ typeLinks={{
2632
+ ScheduledTask: '/reference/graphql-api/admin/object-types#scheduledtask',
2633
+ UpdateScheduledTaskInput: '/reference/graphql-api/admin/input-types#updatescheduledtaskinput',
2634
+ }}
2635
+ >
2636
+ {`type Mutation {
2637
+ updateScheduledTask(input: UpdateScheduledTaskInput!): ScheduledTask!
2638
+ }`}
2639
+ </GraphQLDoc>
2640
+
2641
+ ## updateSeller {#updateseller}
2642
+
2643
+ <GraphQLDoc
2644
+ type="mutation"
2645
+ typeName="updateSeller"
2646
+ typeLinks={{
2647
+ Seller: '/reference/graphql-api/admin/object-types#seller',
2648
+ UpdateSellerInput: '/reference/graphql-api/admin/input-types#updatesellerinput',
2649
+ }}
2650
+ >
2651
+ {`"""Update an existing Seller"""
2652
+ type Mutation {
2653
+ updateSeller(input: UpdateSellerInput!): Seller!
2654
+ }`}
2655
+ </GraphQLDoc>
2656
+
2657
+ ## updateShippingMethod {#updateshippingmethod}
2658
+
2659
+ <GraphQLDoc
2660
+ type="mutation"
2661
+ typeName="updateShippingMethod"
2662
+ typeLinks={{
2663
+ ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
2664
+ UpdateShippingMethodInput: '/reference/graphql-api/admin/input-types#updateshippingmethodinput',
2665
+ }}
2666
+ >
2667
+ {`"""Update an existing ShippingMethod"""
2668
+ type Mutation {
2669
+ updateShippingMethod(input: UpdateShippingMethodInput!): ShippingMethod!
2670
+ }`}
2671
+ </GraphQLDoc>
2672
+
2673
+ ## updateStockLocation {#updatestocklocation}
2674
+
2675
+ <GraphQLDoc
2676
+ type="mutation"
2677
+ typeName="updateStockLocation"
2678
+ typeLinks={{
2679
+ StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
2680
+ UpdateStockLocationInput: '/reference/graphql-api/admin/input-types#updatestocklocationinput',
2681
+ }}
2682
+ >
2683
+ {`type Mutation {
2684
+ updateStockLocation(input: UpdateStockLocationInput!): StockLocation!
2685
+ }`}
2686
+ </GraphQLDoc>
2687
+
2688
+ ## updateTag {#updatetag}
2689
+
2690
+ <GraphQLDoc
2691
+ type="mutation"
2692
+ typeName="updateTag"
2693
+ typeLinks={{
2694
+ Tag: '/reference/graphql-api/admin/object-types#tag',
2695
+ UpdateTagInput: '/reference/graphql-api/admin/input-types#updatetaginput',
2696
+ }}
2697
+ >
2698
+ {`"""Update an existing Tag"""
2699
+ type Mutation {
2700
+ updateTag(input: UpdateTagInput!): Tag!
2701
+ }`}
2702
+ </GraphQLDoc>
2703
+
2704
+ ## updateTaxCategory {#updatetaxcategory}
2705
+
2706
+ <GraphQLDoc
2707
+ type="mutation"
2708
+ typeName="updateTaxCategory"
2709
+ typeLinks={{
2710
+ TaxCategory: '/reference/graphql-api/admin/object-types#taxcategory',
2711
+ UpdateTaxCategoryInput: '/reference/graphql-api/admin/input-types#updatetaxcategoryinput',
2712
+ }}
2713
+ >
2714
+ {`"""Update an existing TaxCategory"""
2715
+ type Mutation {
2716
+ updateTaxCategory(input: UpdateTaxCategoryInput!): TaxCategory!
2717
+ }`}
2718
+ </GraphQLDoc>
2719
+
2720
+ ## updateTaxRate {#updatetaxrate}
2721
+
2722
+ <GraphQLDoc
2723
+ type="mutation"
2724
+ typeName="updateTaxRate"
2725
+ typeLinks={{
2726
+ TaxRate: '/reference/graphql-api/admin/object-types#taxrate',
2727
+ UpdateTaxRateInput: '/reference/graphql-api/admin/input-types#updatetaxrateinput',
2728
+ }}
2729
+ >
2730
+ {`"""Update an existing TaxRate"""
2731
+ type Mutation {
2732
+ updateTaxRate(input: UpdateTaxRateInput!): TaxRate!
2733
+ }`}
2734
+ </GraphQLDoc>
2735
+
2736
+ ## updateZone {#updatezone}
2737
+
2738
+ <GraphQLDoc
2739
+ type="mutation"
2740
+ typeName="updateZone"
2741
+ typeLinks={{
2742
+ Zone: '/reference/graphql-api/admin/object-types#zone',
2743
+ UpdateZoneInput: '/reference/graphql-api/admin/input-types#updatezoneinput',
2744
+ }}
2745
+ >
2746
+ {`"""Update an existing Zone"""
2747
+ type Mutation {
2748
+ updateZone(input: UpdateZoneInput!): Zone!
2749
+ }`}
2750
+ </GraphQLDoc>