@vendure/docs 0.0.0-202601161959 → 0.0.0-202601201656

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 (662) hide show
  1. package/README.md +35 -0
  2. package/dist/manifest.js +2 -2
  3. package/dist/manifest.js.map +1 -1
  4. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +0 -1
  5. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +0 -1
  6. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +0 -1
  7. package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.mdx +0 -1
  8. package/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.mdx +0 -1
  9. package/docs/reference/admin-ui-api/action-bar/add-action-bar-item.mdx +0 -1
  10. package/docs/reference/admin-ui-api/action-bar/index.mdx +0 -1
  11. package/docs/reference/admin-ui-api/action-bar/page-location-id.mdx +0 -1
  12. package/docs/reference/admin-ui-api/action-bar/router-link-definition.mdx +0 -1
  13. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +0 -1
  14. package/docs/reference/admin-ui-api/alerts/alert-context.mdx +0 -1
  15. package/docs/reference/admin-ui-api/alerts/index.mdx +0 -1
  16. package/docs/reference/admin-ui-api/alerts/register-alert.mdx +0 -1
  17. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +0 -1
  18. package/docs/reference/admin-ui-api/bulk-actions/index.mdx +0 -1
  19. package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.mdx +0 -1
  20. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +0 -1
  21. package/docs/reference/admin-ui-api/components/chip-component.mdx +1 -2
  22. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +1 -2
  23. package/docs/reference/admin-ui-api/components/data-table-component.mdx +1 -2
  24. package/docs/reference/admin-ui-api/components/data-table2component.mdx +0 -1
  25. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +1 -2
  26. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -2
  27. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +1 -2
  28. package/docs/reference/admin-ui-api/components/index.mdx +0 -1
  29. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -2
  30. package/docs/reference/admin-ui-api/components/order-state-label-component.mdx +1 -2
  31. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -2
  32. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +1 -2
  33. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +0 -1
  34. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +0 -1
  35. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.mdx +0 -1
  36. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +0 -1
  37. package/docs/reference/admin-ui-api/custom-detail-components/index.mdx +0 -1
  38. package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.mdx +0 -1
  39. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.mdx +0 -1
  40. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +0 -1
  41. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +0 -1
  42. package/docs/reference/admin-ui-api/custom-history-entry-components/index.mdx +0 -1
  43. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.mdx +0 -1
  44. package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.mdx +0 -1
  45. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +0 -1
  46. package/docs/reference/admin-ui-api/custom-input-components/form-input-component.mdx +0 -1
  47. package/docs/reference/admin-ui-api/custom-input-components/index.mdx +0 -1
  48. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +0 -1
  49. package/docs/reference/admin-ui-api/custom-table-components/custom-column-component.mdx +0 -1
  50. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +0 -1
  51. package/docs/reference/admin-ui-api/custom-table-components/index.mdx +0 -1
  52. package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.mdx +0 -1
  53. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +0 -1
  54. package/docs/reference/admin-ui-api/dashboard-widgets/index.mdx +0 -1
  55. package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.mdx +0 -1
  56. package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.mdx +0 -1
  57. package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.mdx +0 -1
  58. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +0 -1
  59. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +0 -1
  60. package/docs/reference/admin-ui-api/directives/index.mdx +0 -1
  61. package/docs/reference/admin-ui-api/index.mdx +1 -8
  62. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +0 -1
  63. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +0 -1
  64. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +0 -1
  65. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +0 -1
  66. package/docs/reference/admin-ui-api/list-detail-views/index.mdx +0 -1
  67. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +0 -1
  68. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +0 -1
  69. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.mdx +0 -1
  70. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.mdx +0 -1
  71. package/docs/reference/admin-ui-api/nav-menu/index.mdx +0 -1
  72. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +0 -1
  73. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +0 -1
  74. package/docs/reference/admin-ui-api/nav-menu/navigation-types.mdx +0 -1
  75. package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.mdx +1 -2
  76. package/docs/reference/admin-ui-api/pipes/duration-pipe.mdx +0 -1
  77. package/docs/reference/admin-ui-api/pipes/file-size-pipe.mdx +0 -1
  78. package/docs/reference/admin-ui-api/pipes/has-permission-pipe.mdx +1 -2
  79. package/docs/reference/admin-ui-api/pipes/index.mdx +0 -1
  80. package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.mdx +1 -2
  81. package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.mdx +1 -2
  82. package/docs/reference/admin-ui-api/pipes/locale-date-pipe.mdx +1 -2
  83. package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.mdx +1 -2
  84. package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.mdx +1 -2
  85. package/docs/reference/admin-ui-api/pipes/time-ago-pipe.mdx +1 -2
  86. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +0 -1
  87. package/docs/reference/admin-ui-api/react-components/card.mdx +0 -1
  88. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +0 -1
  89. package/docs/reference/admin-ui-api/react-components/form-field.mdx +0 -1
  90. package/docs/reference/admin-ui-api/react-components/index.mdx +0 -1
  91. package/docs/reference/admin-ui-api/react-components/link.mdx +0 -1
  92. package/docs/reference/admin-ui-api/react-components/page-block.mdx +0 -1
  93. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +0 -1
  94. package/docs/reference/admin-ui-api/react-components/rich-text-editor.mdx +0 -1
  95. package/docs/reference/admin-ui-api/react-extensions/index.mdx +0 -1
  96. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +0 -1
  97. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +0 -1
  98. package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.mdx +0 -1
  99. package/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.mdx +0 -1
  100. package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.mdx +0 -1
  101. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.mdx +0 -1
  102. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +0 -1
  103. package/docs/reference/admin-ui-api/react-hooks/index.mdx +0 -1
  104. package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.mdx +0 -1
  105. package/docs/reference/admin-ui-api/react-hooks/use-form-control.mdx +0 -1
  106. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +0 -1
  107. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +0 -1
  108. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +0 -1
  109. package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.mdx +0 -1
  110. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +0 -1
  111. package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.mdx +0 -1
  112. package/docs/reference/admin-ui-api/react-hooks/use-route-params.mdx +0 -1
  113. package/docs/reference/admin-ui-api/routes/index.mdx +0 -1
  114. package/docs/reference/admin-ui-api/routes/register-route-component-options.mdx +0 -1
  115. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +0 -1
  116. package/docs/reference/admin-ui-api/services/data-service.mdx +0 -1
  117. package/docs/reference/admin-ui-api/services/index.mdx +0 -1
  118. package/docs/reference/admin-ui-api/services/modal-service.mdx +0 -1
  119. package/docs/reference/admin-ui-api/services/notification-service.mdx +0 -1
  120. package/docs/reference/admin-ui-api/tabs/index.mdx +0 -1
  121. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +0 -1
  122. package/docs/reference/admin-ui-api/tabs/register-page-tab.mdx +0 -1
  123. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +0 -1
  124. package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.mdx +0 -1
  125. package/docs/reference/admin-ui-api/ui-devkit/helpers.mdx +0 -1
  126. package/docs/reference/admin-ui-api/ui-devkit/index.mdx +0 -1
  127. package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.mdx +0 -1
  128. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.mdx +0 -1
  129. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.mdx +0 -1
  130. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.mdx +0 -1
  131. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +0 -1
  132. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +0 -1
  133. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +0 -1
  134. package/docs/reference/core-plugins/asset-server-plugin/cache-config.mdx +0 -1
  135. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.mdx +0 -1
  136. package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.mdx +0 -1
  137. package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.mdx +0 -1
  138. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +0 -1
  139. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +0 -1
  140. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +0 -1
  141. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +0 -1
  142. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -3
  143. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +0 -1
  144. package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.mdx +0 -1
  145. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +0 -1
  146. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +1 -2
  147. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +0 -1
  148. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +0 -1
  149. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +0 -1
  150. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +0 -1
  151. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +0 -1
  152. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +0 -1
  153. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +0 -1
  154. package/docs/reference/core-plugins/email-plugin/email-send-event.mdx +0 -1
  155. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +0 -1
  156. package/docs/reference/core-plugins/email-plugin/email-utils.mdx +0 -1
  157. package/docs/reference/core-plugins/email-plugin/index.mdx +0 -1
  158. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +0 -1
  159. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +0 -1
  160. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +0 -1
  161. package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.mdx +0 -1
  162. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +0 -1
  163. package/docs/reference/core-plugins/harden-plugin/index.mdx +3 -4
  164. package/docs/reference/core-plugins/index.mdx +0 -1
  165. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.mdx +2 -3
  166. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +1 -2
  167. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +0 -1
  168. package/docs/reference/core-plugins/job-queue-plugin/index.mdx +0 -1
  169. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +1 -2
  170. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -2
  171. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +4 -5
  172. package/docs/reference/core-plugins/payments-plugin/index.mdx +0 -1
  173. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +2 -3
  174. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +2 -3
  175. package/docs/reference/core-plugins/sentry-plugin/index.mdx +3 -4
  176. package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.mdx +0 -1
  177. package/docs/reference/core-plugins/sentry-plugin/sentry-service.mdx +0 -1
  178. package/docs/reference/core-plugins/stellate-plugin/index.mdx +0 -1
  179. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +0 -1
  180. package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.mdx +0 -1
  181. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +0 -1
  182. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +0 -1
  183. package/docs/reference/core-plugins/telemetry-plugin/index.mdx +0 -1
  184. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.mdx +0 -1
  185. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +0 -1
  186. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +0 -1
  187. package/docs/reference/dashboard/components/asset-gallery.mdx +0 -1
  188. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +0 -1
  189. package/docs/reference/dashboard/components/channel-chip.mdx +0 -1
  190. package/docs/reference/dashboard/components/detail-page-button.mdx +0 -1
  191. package/docs/reference/dashboard/components/facet-value-chip.mdx +0 -1
  192. package/docs/reference/dashboard/components/facet-value-selector.mdx +0 -1
  193. package/docs/reference/dashboard/components/index.mdx +0 -1
  194. package/docs/reference/dashboard/components/permission-guard.mdx +0 -1
  195. package/docs/reference/dashboard/components/vendure-image.mdx +0 -1
  196. package/docs/reference/dashboard/detail-views/detail-page.mdx +0 -1
  197. package/docs/reference/dashboard/detail-views/index.mdx +0 -1
  198. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +0 -1
  199. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +0 -1
  200. package/docs/reference/dashboard/extensions-api/action-bar.mdx +0 -1
  201. package/docs/reference/dashboard/extensions-api/alerts.mdx +0 -1
  202. package/docs/reference/dashboard/extensions-api/data-tables.mdx +0 -1
  203. package/docs/reference/dashboard/extensions-api/define-dashboard-extension.mdx +0 -1
  204. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +0 -1
  205. package/docs/reference/dashboard/extensions-api/form-components.mdx +0 -1
  206. package/docs/reference/dashboard/extensions-api/history-entries.mdx +0 -1
  207. package/docs/reference/dashboard/extensions-api/index.mdx +0 -1
  208. package/docs/reference/dashboard/extensions-api/login.mdx +0 -1
  209. package/docs/reference/dashboard/extensions-api/navigation.mdx +0 -1
  210. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +0 -1
  211. package/docs/reference/dashboard/extensions-api/routes.mdx +0 -1
  212. package/docs/reference/dashboard/extensions-api/widgets.mdx +0 -1
  213. package/docs/reference/dashboard/form-components/affixed-input.mdx +0 -1
  214. package/docs/reference/dashboard/form-components/boolean-input.mdx +0 -1
  215. package/docs/reference/dashboard/form-components/checkbox-input.mdx +0 -1
  216. package/docs/reference/dashboard/form-components/date-time-input.mdx +0 -1
  217. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +0 -1
  218. package/docs/reference/dashboard/form-components/index.mdx +0 -1
  219. package/docs/reference/dashboard/form-components/money-input.mdx +0 -1
  220. package/docs/reference/dashboard/form-components/number-input.mdx +0 -1
  221. package/docs/reference/dashboard/form-components/password-input.mdx +0 -1
  222. package/docs/reference/dashboard/form-components/rich-text-input.mdx +0 -1
  223. package/docs/reference/dashboard/form-components/slug-input.mdx +0 -1
  224. package/docs/reference/dashboard/form-components/text-input.mdx +0 -1
  225. package/docs/reference/dashboard/form-components/textarea-input.mdx +0 -1
  226. package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.mdx +0 -1
  227. package/docs/reference/dashboard/hooks/index.mdx +0 -1
  228. package/docs/reference/dashboard/hooks/use-alerts.mdx +0 -1
  229. package/docs/reference/dashboard/hooks/use-auth.mdx +0 -1
  230. package/docs/reference/dashboard/hooks/use-channel.mdx +0 -1
  231. package/docs/reference/dashboard/hooks/use-custom-field-config.mdx +0 -1
  232. package/docs/reference/dashboard/hooks/use-display-locale.mdx +0 -1
  233. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +0 -1
  234. package/docs/reference/dashboard/hooks/use-local-format.mdx +0 -1
  235. package/docs/reference/dashboard/hooks/use-paginated-list.mdx +0 -1
  236. package/docs/reference/dashboard/hooks/use-permissions.mdx +0 -1
  237. package/docs/reference/dashboard/hooks/use-sorted-languages.mdx +0 -1
  238. package/docs/reference/dashboard/hooks/use-ui-language-loader.mdx +0 -1
  239. package/docs/reference/dashboard/hooks/use-widget-filters.mdx +0 -1
  240. package/docs/reference/dashboard/index.mdx +1 -2
  241. package/docs/reference/dashboard/list-views/bulk-actions.mdx +0 -1
  242. package/docs/reference/dashboard/list-views/data-table-cell-component.mdx +0 -1
  243. package/docs/reference/dashboard/list-views/data-table.mdx +0 -1
  244. package/docs/reference/dashboard/list-views/index.mdx +0 -1
  245. package/docs/reference/dashboard/list-views/list-page.mdx +0 -1
  246. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +0 -1
  247. package/docs/reference/dashboard/page-layout/index.mdx +0 -1
  248. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +0 -1
  249. package/docs/reference/dashboard/page-layout/page-block.mdx +0 -1
  250. package/docs/reference/dashboard/page-layout/page-title.mdx +0 -1
  251. package/docs/reference/dashboard/page-layout/page.mdx +0 -1
  252. package/docs/reference/dashboard/page-layout/use-page-block.mdx +0 -1
  253. package/docs/reference/dashboard/vite-plugin/index.mdx +0 -1
  254. package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.mdx +0 -1
  255. package/docs/reference/graphql-api/admin/_index.mdx +1 -8
  256. package/docs/reference/graphql-api/admin/enums.mdx +1132 -1135
  257. package/docs/reference/graphql-api/admin/input-types.mdx +4701 -4624
  258. package/docs/reference/graphql-api/admin/mutations.mdx +2743 -1978
  259. package/docs/reference/graphql-api/admin/object-types.mdx +4966 -4508
  260. package/docs/reference/graphql-api/admin/queries.mdx +1187 -753
  261. package/docs/reference/graphql-api/shop/_index.mdx +1 -8
  262. package/docs/reference/graphql-api/shop/enums.mdx +1056 -1065
  263. package/docs/reference/graphql-api/shop/input-types.mdx +1106 -1185
  264. package/docs/reference/graphql-api/shop/mutations.mdx +533 -424
  265. package/docs/reference/graphql-api/shop/object-types.mdx +3686 -3399
  266. package/docs/reference/graphql-api/shop/queries.mdx +307 -240
  267. package/docs/reference/index.mdx +2 -35
  268. package/docs/reference/typescript-api/_index.mdx +1 -8
  269. package/docs/reference/typescript-api/assets/asset-naming-strategy.mdx +0 -1
  270. package/docs/reference/typescript-api/assets/asset-options.mdx +0 -1
  271. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +0 -1
  272. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +0 -1
  273. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.mdx +0 -1
  274. package/docs/reference/typescript-api/assets/index.mdx +0 -1
  275. package/docs/reference/typescript-api/auth/auth-options.mdx +0 -1
  276. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +1 -2
  277. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +0 -1
  278. package/docs/reference/typescript-api/auth/cookie-options.mdx +0 -1
  279. package/docs/reference/typescript-api/auth/default-password-validation-strategy.mdx +0 -1
  280. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +0 -1
  281. package/docs/reference/typescript-api/auth/default-verification-token-strategy.mdx +0 -1
  282. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +0 -1
  283. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.mdx +0 -1
  284. package/docs/reference/typescript-api/auth/index.mdx +0 -1
  285. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +0 -1
  286. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.mdx +0 -1
  287. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +0 -1
  288. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +0 -1
  289. package/docs/reference/typescript-api/auth/permission-definition.mdx +0 -1
  290. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +0 -1
  291. package/docs/reference/typescript-api/auth/superadmin-credentials.mdx +0 -1
  292. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +0 -1
  293. package/docs/reference/typescript-api/cache/cache-config.mdx +0 -1
  294. package/docs/reference/typescript-api/cache/cache-service.mdx +0 -1
  295. package/docs/reference/typescript-api/cache/cache-strategy.mdx +0 -1
  296. package/docs/reference/typescript-api/cache/default-cache-plugin.mdx +0 -1
  297. package/docs/reference/typescript-api/cache/index.mdx +0 -1
  298. package/docs/reference/typescript-api/cache/redis-cache-plugin.mdx +1 -2
  299. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +1 -2
  300. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +0 -1
  301. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +0 -1
  302. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +0 -1
  303. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +0 -1
  304. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +0 -1
  305. package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.mdx +0 -1
  306. package/docs/reference/typescript-api/common/admin-ui/index.mdx +0 -1
  307. package/docs/reference/typescript-api/common/async-queue.mdx +0 -1
  308. package/docs/reference/typescript-api/common/bootstrap.mdx +0 -1
  309. package/docs/reference/typescript-api/common/currency-code.mdx +0 -1
  310. package/docs/reference/typescript-api/common/entity-relation-paths.mdx +0 -1
  311. package/docs/reference/typescript-api/common/i18n-service.mdx +0 -1
  312. package/docs/reference/typescript-api/common/id.mdx +0 -1
  313. package/docs/reference/typescript-api/common/index.mdx +0 -1
  314. package/docs/reference/typescript-api/common/injectable-strategy.mdx +0 -1
  315. package/docs/reference/typescript-api/common/injector.mdx +0 -1
  316. package/docs/reference/typescript-api/common/job-state.mdx +0 -1
  317. package/docs/reference/typescript-api/common/json-compatible.mdx +0 -1
  318. package/docs/reference/typescript-api/common/language-code.mdx +0 -1
  319. package/docs/reference/typescript-api/common/middleware.mdx +0 -1
  320. package/docs/reference/typescript-api/common/paginated-list.mdx +0 -1
  321. package/docs/reference/typescript-api/common/permission.mdx +0 -1
  322. package/docs/reference/typescript-api/common/price-calculation-result.mdx +0 -1
  323. package/docs/reference/typescript-api/common/process-context.mdx +0 -1
  324. package/docs/reference/typescript-api/common/vendure_version.mdx +0 -1
  325. package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.mdx +0 -1
  326. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +0 -1
  327. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.mdx +0 -1
  328. package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.mdx +0 -1
  329. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +0 -1
  330. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +0 -1
  331. package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.mdx +0 -1
  332. package/docs/reference/typescript-api/configuration/api-options.mdx +0 -1
  333. package/docs/reference/typescript-api/configuration/collection-filter.mdx +0 -1
  334. package/docs/reference/typescript-api/configuration/default-config.mdx +0 -1
  335. package/docs/reference/typescript-api/configuration/default-slug-strategy.mdx +0 -1
  336. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +0 -1
  337. package/docs/reference/typescript-api/configuration/entity-id-decorator.mdx +0 -1
  338. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +0 -1
  339. package/docs/reference/typescript-api/configuration/entity-options.mdx +0 -1
  340. package/docs/reference/typescript-api/configuration/index.mdx +0 -1
  341. package/docs/reference/typescript-api/configuration/merge-config.mdx +0 -1
  342. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +0 -1
  343. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +0 -1
  344. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +0 -1
  345. package/docs/reference/typescript-api/configuration/settings-store-fields.mdx +0 -1
  346. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +0 -1
  347. package/docs/reference/typescript-api/configuration/system-options.mdx +0 -1
  348. package/docs/reference/typescript-api/configuration/trust-proxy-options.mdx +0 -1
  349. package/docs/reference/typescript-api/configuration/vendure-config.mdx +0 -1
  350. package/docs/reference/typescript-api/custom-fields/custom-field-config.mdx +0 -1
  351. package/docs/reference/typescript-api/custom-fields/custom-field-type.mdx +0 -1
  352. package/docs/reference/typescript-api/custom-fields/index.mdx +0 -1
  353. package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.mdx +0 -1
  354. package/docs/reference/typescript-api/custom-fields/struct-field-config.mdx +0 -1
  355. package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.mdx +0 -1
  356. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +0 -1
  357. package/docs/reference/typescript-api/data-access/calculated.mdx +0 -1
  358. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +0 -1
  359. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +0 -1
  360. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +0 -1
  361. package/docs/reference/typescript-api/data-access/index.mdx +0 -1
  362. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +3 -4
  363. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +0 -1
  364. package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.mdx +0 -1
  365. package/docs/reference/typescript-api/default-search-plugin/index.mdx +0 -1
  366. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +0 -1
  367. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +0 -1
  368. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +0 -1
  369. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +0 -1
  370. package/docs/reference/typescript-api/entities/address.mdx +0 -1
  371. package/docs/reference/typescript-api/entities/administrator.mdx +0 -1
  372. package/docs/reference/typescript-api/entities/anonymous-session.mdx +0 -1
  373. package/docs/reference/typescript-api/entities/asset.mdx +0 -1
  374. package/docs/reference/typescript-api/entities/authenticated-session.mdx +0 -1
  375. package/docs/reference/typescript-api/entities/authentication-method.mdx +0 -1
  376. package/docs/reference/typescript-api/entities/channel.mdx +0 -1
  377. package/docs/reference/typescript-api/entities/collection.mdx +0 -1
  378. package/docs/reference/typescript-api/entities/country.mdx +0 -1
  379. package/docs/reference/typescript-api/entities/customer-group.mdx +0 -1
  380. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +0 -1
  381. package/docs/reference/typescript-api/entities/customer.mdx +0 -1
  382. package/docs/reference/typescript-api/entities/facet-value.mdx +0 -1
  383. package/docs/reference/typescript-api/entities/facet.mdx +0 -1
  384. package/docs/reference/typescript-api/entities/fulfillment.mdx +0 -1
  385. package/docs/reference/typescript-api/entities/global-settings.mdx +0 -1
  386. package/docs/reference/typescript-api/entities/history-entry.mdx +0 -1
  387. package/docs/reference/typescript-api/entities/index.mdx +0 -1
  388. package/docs/reference/typescript-api/entities/interfaces.mdx +0 -1
  389. package/docs/reference/typescript-api/entities/order-history-entry.mdx +0 -1
  390. package/docs/reference/typescript-api/entities/order-line-reference.mdx +0 -1
  391. package/docs/reference/typescript-api/entities/order-line.mdx +0 -1
  392. package/docs/reference/typescript-api/entities/order-modification.mdx +0 -1
  393. package/docs/reference/typescript-api/entities/order.mdx +0 -1
  394. package/docs/reference/typescript-api/entities/orderable-asset.mdx +0 -1
  395. package/docs/reference/typescript-api/entities/payment-method.mdx +0 -1
  396. package/docs/reference/typescript-api/entities/payment.mdx +0 -1
  397. package/docs/reference/typescript-api/entities/product-option-group.mdx +0 -1
  398. package/docs/reference/typescript-api/entities/product-option.mdx +0 -1
  399. package/docs/reference/typescript-api/entities/product-variant-price.mdx +0 -1
  400. package/docs/reference/typescript-api/entities/product-variant.mdx +0 -1
  401. package/docs/reference/typescript-api/entities/product.mdx +0 -1
  402. package/docs/reference/typescript-api/entities/promotion.mdx +0 -1
  403. package/docs/reference/typescript-api/entities/province.mdx +0 -1
  404. package/docs/reference/typescript-api/entities/refund.mdx +0 -1
  405. package/docs/reference/typescript-api/entities/region.mdx +0 -1
  406. package/docs/reference/typescript-api/entities/role.mdx +0 -1
  407. package/docs/reference/typescript-api/entities/seller.mdx +0 -1
  408. package/docs/reference/typescript-api/entities/session.mdx +0 -1
  409. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +0 -1
  410. package/docs/reference/typescript-api/entities/shipping-line.mdx +0 -1
  411. package/docs/reference/typescript-api/entities/shipping-method.mdx +0 -1
  412. package/docs/reference/typescript-api/entities/stock-level.mdx +0 -1
  413. package/docs/reference/typescript-api/entities/stock-location.mdx +0 -1
  414. package/docs/reference/typescript-api/entities/stock-movement.mdx +0 -1
  415. package/docs/reference/typescript-api/entities/surcharge.mdx +0 -1
  416. package/docs/reference/typescript-api/entities/tag.mdx +0 -1
  417. package/docs/reference/typescript-api/entities/tax-category.mdx +0 -1
  418. package/docs/reference/typescript-api/entities/tax-rate.mdx +0 -1
  419. package/docs/reference/typescript-api/entities/user.mdx +0 -1
  420. package/docs/reference/typescript-api/entities/vendure-entity.mdx +0 -1
  421. package/docs/reference/typescript-api/entities/zone.mdx +0 -1
  422. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +0 -1
  423. package/docs/reference/typescript-api/errors/error-result-union.mdx +0 -1
  424. package/docs/reference/typescript-api/errors/error-types.mdx +0 -1
  425. package/docs/reference/typescript-api/errors/i18n-error.mdx +0 -1
  426. package/docs/reference/typescript-api/errors/index.mdx +0 -1
  427. package/docs/reference/typescript-api/errors/is-graph-ql-error-result.mdx +0 -1
  428. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +0 -1
  429. package/docs/reference/typescript-api/events/event-bus.mdx +0 -1
  430. package/docs/reference/typescript-api/events/event-types.mdx +0 -1
  431. package/docs/reference/typescript-api/events/index.mdx +0 -1
  432. package/docs/reference/typescript-api/events/vendure-entity-event.mdx +0 -1
  433. package/docs/reference/typescript-api/events/vendure-event.mdx +0 -1
  434. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +0 -1
  435. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +0 -1
  436. package/docs/reference/typescript-api/fulfillment/fulfillment-state.mdx +0 -1
  437. package/docs/reference/typescript-api/fulfillment/fulfillment-states.mdx +0 -1
  438. package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.mdx +0 -1
  439. package/docs/reference/typescript-api/fulfillment/index.mdx +0 -1
  440. package/docs/reference/typescript-api/health-check/health-check-registry-service.mdx +0 -1
  441. package/docs/reference/typescript-api/health-check/health-check-strategy.mdx +0 -1
  442. package/docs/reference/typescript-api/health-check/http-health-check-strategy.mdx +0 -1
  443. package/docs/reference/typescript-api/health-check/index.mdx +0 -1
  444. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.mdx +0 -1
  445. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +0 -1
  446. package/docs/reference/typescript-api/import-export/asset-importer.mdx +0 -1
  447. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.mdx +0 -1
  448. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +0 -1
  449. package/docs/reference/typescript-api/import-export/import-export-options.mdx +0 -1
  450. package/docs/reference/typescript-api/import-export/import-parser.mdx +0 -1
  451. package/docs/reference/typescript-api/import-export/importer.mdx +0 -1
  452. package/docs/reference/typescript-api/import-export/index.mdx +0 -1
  453. package/docs/reference/typescript-api/import-export/initial-data.mdx +0 -1
  454. package/docs/reference/typescript-api/import-export/populate.mdx +0 -1
  455. package/docs/reference/typescript-api/import-export/populator.mdx +0 -1
  456. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +0 -1
  457. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +0 -1
  458. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +0 -1
  459. package/docs/reference/typescript-api/job-queue/index.mdx +0 -1
  460. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +0 -1
  461. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +0 -1
  462. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +0 -1
  463. package/docs/reference/typescript-api/job-queue/job-queue-options.mdx +0 -1
  464. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +0 -1
  465. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +0 -1
  466. package/docs/reference/typescript-api/job-queue/job.mdx +0 -1
  467. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +0 -1
  468. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +0 -1
  469. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +0 -1
  470. package/docs/reference/typescript-api/job-queue/types.mdx +0 -1
  471. package/docs/reference/typescript-api/logger/default-logger.mdx +0 -1
  472. package/docs/reference/typescript-api/logger/index.mdx +0 -1
  473. package/docs/reference/typescript-api/logger/log-level.mdx +0 -1
  474. package/docs/reference/typescript-api/logger/vendure-logger.mdx +0 -1
  475. package/docs/reference/typescript-api/migration/generate-migration.mdx +0 -1
  476. package/docs/reference/typescript-api/migration/index.mdx +0 -1
  477. package/docs/reference/typescript-api/migration/migration-options.mdx +0 -1
  478. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +0 -1
  479. package/docs/reference/typescript-api/migration/run-migrations.mdx +0 -1
  480. package/docs/reference/typescript-api/money/big-int-money-strategy.mdx +0 -1
  481. package/docs/reference/typescript-api/money/default-money-strategy.mdx +0 -1
  482. package/docs/reference/typescript-api/money/index.mdx +0 -1
  483. package/docs/reference/typescript-api/money/money-decorator.mdx +0 -1
  484. package/docs/reference/typescript-api/money/money-strategy.mdx +0 -1
  485. package/docs/reference/typescript-api/money/round-money.mdx +0 -1
  486. package/docs/reference/typescript-api/orders/active-order-service.mdx +0 -1
  487. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +2 -3
  488. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +0 -1
  489. package/docs/reference/typescript-api/orders/custom-order-states.mdx +0 -1
  490. package/docs/reference/typescript-api/orders/default-active-order-strategy.mdx +0 -1
  491. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +0 -1
  492. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +0 -1
  493. package/docs/reference/typescript-api/orders/default-order-placed-strategy.mdx +0 -1
  494. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +0 -1
  495. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +0 -1
  496. package/docs/reference/typescript-api/orders/index.mdx +0 -1
  497. package/docs/reference/typescript-api/orders/merge-strategies.mdx +0 -1
  498. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +0 -1
  499. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +0 -1
  500. package/docs/reference/typescript-api/orders/order-interceptor.mdx +0 -1
  501. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +0 -1
  502. package/docs/reference/typescript-api/orders/order-merge-strategy.mdx +0 -1
  503. package/docs/reference/typescript-api/orders/order-options.mdx +0 -1
  504. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +0 -1
  505. package/docs/reference/typescript-api/orders/order-process.mdx +0 -1
  506. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +0 -1
  507. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +0 -1
  508. package/docs/reference/typescript-api/payment/default-payment-process.mdx +0 -1
  509. package/docs/reference/typescript-api/payment/default-refund-process.mdx +0 -1
  510. package/docs/reference/typescript-api/payment/dummy-payment-handler.mdx +1 -2
  511. package/docs/reference/typescript-api/payment/index.mdx +0 -1
  512. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +0 -1
  513. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +0 -1
  514. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +0 -1
  515. package/docs/reference/typescript-api/payment/payment-method-types.mdx +0 -1
  516. package/docs/reference/typescript-api/payment/payment-options.mdx +0 -1
  517. package/docs/reference/typescript-api/payment/payment-process.mdx +0 -1
  518. package/docs/reference/typescript-api/payment/payment-state.mdx +0 -1
  519. package/docs/reference/typescript-api/payment/payment-states.mdx +0 -1
  520. package/docs/reference/typescript-api/payment/payment-transition-data.mdx +0 -1
  521. package/docs/reference/typescript-api/payment/refund-process.mdx +0 -1
  522. package/docs/reference/typescript-api/payment/refund-state.mdx +0 -1
  523. package/docs/reference/typescript-api/payment/refund-states.mdx +0 -1
  524. package/docs/reference/typescript-api/payment/refund-transition-data.mdx +0 -1
  525. package/docs/reference/typescript-api/plugin/index.mdx +0 -1
  526. package/docs/reference/typescript-api/plugin/plugin-common-module.mdx +0 -1
  527. package/docs/reference/typescript-api/plugin/plugin-utilities.mdx +0 -1
  528. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +0 -1
  529. package/docs/reference/typescript-api/plugin/vendure-plugin.mdx +0 -1
  530. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +0 -1
  531. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +0 -1
  532. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.mdx +0 -1
  533. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +0 -1
  534. package/docs/reference/typescript-api/products-stock/index.mdx +0 -1
  535. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +0 -1
  536. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +0 -1
  537. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +0 -1
  538. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +0 -1
  539. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +0 -1
  540. package/docs/reference/typescript-api/promotions/index.mdx +0 -1
  541. package/docs/reference/typescript-api/promotions/promotion-action.mdx +0 -1
  542. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +0 -1
  543. package/docs/reference/typescript-api/promotions/promotion-options.mdx +0 -1
  544. package/docs/reference/typescript-api/request/allow-decorator.mdx +0 -1
  545. package/docs/reference/typescript-api/request/api-decorator.mdx +0 -1
  546. package/docs/reference/typescript-api/request/api-type.mdx +0 -1
  547. package/docs/reference/typescript-api/request/ctx-decorator.mdx +0 -1
  548. package/docs/reference/typescript-api/request/index.mdx +0 -1
  549. package/docs/reference/typescript-api/request/relations-decorator.mdx +2 -3
  550. package/docs/reference/typescript-api/request/request-context-service.mdx +0 -1
  551. package/docs/reference/typescript-api/request/request-context.mdx +0 -1
  552. package/docs/reference/typescript-api/request/transaction-decorator.mdx +0 -1
  553. package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.mdx +0 -1
  554. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.mdx +0 -1
  555. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +0 -1
  556. package/docs/reference/typescript-api/scheduled-tasks/index.mdx +0 -1
  557. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +0 -1
  558. package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.mdx +0 -1
  559. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +0 -1
  560. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +0 -1
  561. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +0 -1
  562. package/docs/reference/typescript-api/service-helpers/index.mdx +0 -1
  563. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +0 -1
  564. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +0 -1
  565. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +0 -1
  566. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +0 -1
  567. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +0 -1
  568. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +0 -1
  569. package/docs/reference/typescript-api/services/administrator-service.mdx +0 -1
  570. package/docs/reference/typescript-api/services/asset-service.mdx +0 -1
  571. package/docs/reference/typescript-api/services/auth-service.mdx +0 -1
  572. package/docs/reference/typescript-api/services/channel-service.mdx +0 -1
  573. package/docs/reference/typescript-api/services/collection-service.mdx +0 -1
  574. package/docs/reference/typescript-api/services/country-service.mdx +0 -1
  575. package/docs/reference/typescript-api/services/customer-group-service.mdx +0 -1
  576. package/docs/reference/typescript-api/services/customer-service.mdx +0 -1
  577. package/docs/reference/typescript-api/services/entity-slug-service.mdx +0 -1
  578. package/docs/reference/typescript-api/services/facet-service.mdx +0 -1
  579. package/docs/reference/typescript-api/services/facet-value-service.mdx +0 -1
  580. package/docs/reference/typescript-api/services/fulfillment-service.mdx +0 -1
  581. package/docs/reference/typescript-api/services/global-settings-service.mdx +0 -1
  582. package/docs/reference/typescript-api/services/history-service.mdx +0 -1
  583. package/docs/reference/typescript-api/services/index.mdx +0 -1
  584. package/docs/reference/typescript-api/services/initializer-service.mdx +0 -1
  585. package/docs/reference/typescript-api/services/order-service.mdx +0 -1
  586. package/docs/reference/typescript-api/services/order-testing-service.mdx +0 -1
  587. package/docs/reference/typescript-api/services/payment-method-service.mdx +0 -1
  588. package/docs/reference/typescript-api/services/payment-service.mdx +0 -1
  589. package/docs/reference/typescript-api/services/product-option-group-service.mdx +0 -1
  590. package/docs/reference/typescript-api/services/product-option-service.mdx +0 -1
  591. package/docs/reference/typescript-api/services/product-service.mdx +0 -1
  592. package/docs/reference/typescript-api/services/product-variant-service.mdx +0 -1
  593. package/docs/reference/typescript-api/services/promotion-service.mdx +0 -1
  594. package/docs/reference/typescript-api/services/province-service.mdx +0 -1
  595. package/docs/reference/typescript-api/services/role-service.mdx +0 -1
  596. package/docs/reference/typescript-api/services/search-service.mdx +0 -1
  597. package/docs/reference/typescript-api/services/seller-service.mdx +0 -1
  598. package/docs/reference/typescript-api/services/session-service.mdx +0 -1
  599. package/docs/reference/typescript-api/services/settings-store-service.mdx +0 -1
  600. package/docs/reference/typescript-api/services/shipping-method-service.mdx +0 -1
  601. package/docs/reference/typescript-api/services/slug-service.mdx +0 -1
  602. package/docs/reference/typescript-api/services/stock-level-service.mdx +0 -1
  603. package/docs/reference/typescript-api/services/stock-location-service.mdx +0 -1
  604. package/docs/reference/typescript-api/services/stock-movement-service.mdx +0 -1
  605. package/docs/reference/typescript-api/services/tag-service.mdx +0 -1
  606. package/docs/reference/typescript-api/services/tax-category-service.mdx +0 -1
  607. package/docs/reference/typescript-api/services/tax-rate-service.mdx +0 -1
  608. package/docs/reference/typescript-api/services/user-service.mdx +0 -1
  609. package/docs/reference/typescript-api/services/zone-service.mdx +0 -1
  610. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options.mdx +0 -1
  611. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result.mdx +0 -1
  612. package/docs/reference/typescript-api/settings-store/index.mdx +0 -1
  613. package/docs/reference/typescript-api/settings-store/orphaned-settings-store-entry.mdx +0 -1
  614. package/docs/reference/typescript-api/settings-store/set-settings-store-value-result.mdx +0 -1
  615. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +0 -1
  616. package/docs/reference/typescript-api/settings-store/settings-store-registration.mdx +0 -1
  617. package/docs/reference/typescript-api/settings-store/settings-store-scope-function.mdx +0 -1
  618. package/docs/reference/typescript-api/settings-store/settings-store-scopes.mdx +0 -1
  619. package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.mdx +0 -1
  620. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +0 -1
  621. package/docs/reference/typescript-api/shipping/index.mdx +0 -1
  622. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +0 -1
  623. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +0 -1
  624. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +0 -1
  625. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +0 -1
  626. package/docs/reference/typescript-api/shipping/shipping-options.mdx +0 -1
  627. package/docs/reference/typescript-api/shipping/should-run-check-fn.mdx +0 -1
  628. package/docs/reference/typescript-api/state-machine/fsm.mdx +0 -1
  629. package/docs/reference/typescript-api/state-machine/index.mdx +0 -1
  630. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +0 -1
  631. package/docs/reference/typescript-api/state-machine/transitions.mdx +0 -1
  632. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.mdx +0 -1
  633. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.mdx +0 -1
  634. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.mdx +0 -1
  635. package/docs/reference/typescript-api/tax/index.mdx +0 -1
  636. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +0 -1
  637. package/docs/reference/typescript-api/tax/tax-options.mdx +0 -1
  638. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +0 -1
  639. package/docs/reference/typescript-api/telemetry/index.mdx +0 -1
  640. package/docs/reference/typescript-api/telemetry/instrument.mdx +0 -1
  641. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.mdx +0 -1
  642. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +0 -1
  643. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +0 -1
  644. package/docs/reference/typescript-api/testing/create-test-environment.mdx +0 -1
  645. package/docs/reference/typescript-api/testing/error-result-guard.mdx +0 -1
  646. package/docs/reference/typescript-api/testing/get-superadmin-context.mdx +0 -1
  647. package/docs/reference/typescript-api/testing/index.mdx +0 -1
  648. package/docs/reference/typescript-api/testing/register-initializer.mdx +0 -1
  649. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +0 -1
  650. package/docs/reference/typescript-api/testing/test-config.mdx +0 -1
  651. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +0 -1
  652. package/docs/reference/typescript-api/testing/test-environment.mdx +0 -1
  653. package/docs/reference/typescript-api/testing/test-server-options.mdx +0 -1
  654. package/docs/reference/typescript-api/testing/test-server.mdx +0 -1
  655. package/docs/reference/typescript-api/testing/testing-logger.mdx +0 -1
  656. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +0 -1
  657. package/docs/reference/typescript-api/worker/index.mdx +0 -1
  658. package/docs/reference/typescript-api/worker/vendure-worker.mdx +0 -1
  659. package/docs/reference/typescript-api/worker/worker-health-check-config.mdx +0 -1
  660. package/package.json +4 -3
  661. package/docs/reference/graphql-api/_index.mdx +0 -14
  662. package/docs/reference/links.webp +0 -0
@@ -2,759 +2,1193 @@
2
2
  title: "Queries"
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
- ## activeAdministrator
10
- <div class="graphql-code-block">
11
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
12
- <div class="graphql-code-line ">activeAdministrator: <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a></div>
13
-
14
-
15
- <div class="graphql-code-line top-level">&#125;</div>
16
- </div>
17
-
18
- ## activeChannel
19
- <div class="graphql-code-block">
20
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
21
- <div class="graphql-code-line ">activeChannel: <a href="/reference/graphql-api/admin/object-types#channel">Channel</a>!</div>
22
-
23
-
24
- <div class="graphql-code-line top-level">&#125;</div>
25
- </div>
26
-
27
- ## administrator
28
- <div class="graphql-code-block">
29
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
30
- <div class="graphql-code-line ">administrator(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#administrator">Administrator</a></div>
31
-
32
-
33
- <div class="graphql-code-line top-level">&#125;</div>
34
- </div>
35
-
36
- ## administrators
37
- <div class="graphql-code-block">
38
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
39
- <div class="graphql-code-line ">administrators(options: <a href="/reference/graphql-api/admin/input-types#administratorlistoptions">AdministratorListOptions</a>): <a href="/reference/graphql-api/admin/object-types#administratorlist">AdministratorList</a>!</div>
40
-
41
-
42
- <div class="graphql-code-line top-level">&#125;</div>
43
- </div>
44
-
45
- ## asset
46
- <div class="graphql-code-block">
47
- <div class="graphql-code-line top-level comment">"""</div>
48
- <div class="graphql-code-line top-level comment">Get a single Asset by id</div>
49
- <div class="graphql-code-line top-level comment">"""</div>
50
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
51
- <div class="graphql-code-line ">asset(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#asset">Asset</a></div>
52
-
53
-
54
- <div class="graphql-code-line top-level">&#125;</div>
55
- </div>
56
-
57
- ## assets
58
- <div class="graphql-code-block">
59
- <div class="graphql-code-line top-level comment">"""</div>
60
- <div class="graphql-code-line top-level comment">Get a list of Assets</div>
61
- <div class="graphql-code-line top-level comment">"""</div>
62
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
63
- <div class="graphql-code-line ">assets(options: <a href="/reference/graphql-api/admin/input-types#assetlistoptions">AssetListOptions</a>): <a href="/reference/graphql-api/admin/object-types#assetlist">AssetList</a>!</div>
64
-
65
-
66
- <div class="graphql-code-line top-level">&#125;</div>
67
- </div>
68
-
69
- ## channel
70
- <div class="graphql-code-block">
71
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
72
- <div class="graphql-code-line ">channel(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#channel">Channel</a></div>
73
-
74
-
75
- <div class="graphql-code-line top-level">&#125;</div>
76
- </div>
77
-
78
- ## channels
79
- <div class="graphql-code-block">
80
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
81
- <div class="graphql-code-line ">channels(options: <a href="/reference/graphql-api/admin/input-types#channellistoptions">ChannelListOptions</a>): <a href="/reference/graphql-api/admin/object-types#channellist">ChannelList</a>!</div>
82
-
83
-
84
- <div class="graphql-code-line top-level">&#125;</div>
85
- </div>
86
-
87
- ## collection
88
- <div class="graphql-code-block">
89
- <div class="graphql-code-line top-level comment">"""</div>
90
- <div class="graphql-code-line top-level comment">Get a Collection either by id or slug. If neither id nor slug is specified, an error will result.</div>
91
- <div class="graphql-code-line top-level comment">"""</div>
92
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
93
- <div class="graphql-code-line ">collection(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>, slug: <a href="/reference/graphql-api/admin/object-types#string">String</a>): <a href="/reference/graphql-api/admin/object-types#collection">Collection</a></div>
94
-
95
-
96
- <div class="graphql-code-line top-level">&#125;</div>
97
- </div>
98
-
99
- ## collectionFilters
100
- <div class="graphql-code-block">
101
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
102
- <div class="graphql-code-line ">collectionFilters: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
103
-
104
-
105
- <div class="graphql-code-line top-level">&#125;</div>
106
- </div>
107
-
108
- ## collections
109
- <div class="graphql-code-block">
110
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
111
- <div class="graphql-code-line ">collections(options: <a href="/reference/graphql-api/admin/input-types#collectionlistoptions">CollectionListOptions</a>): <a href="/reference/graphql-api/admin/object-types#collectionlist">CollectionList</a>!</div>
112
-
113
-
114
- <div class="graphql-code-line top-level">&#125;</div>
115
- </div>
116
-
117
- ## countries
118
- <div class="graphql-code-block">
119
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
120
- <div class="graphql-code-line ">countries(options: <a href="/reference/graphql-api/admin/input-types#countrylistoptions">CountryListOptions</a>): <a href="/reference/graphql-api/admin/object-types#countrylist">CountryList</a>!</div>
121
-
122
-
123
- <div class="graphql-code-line top-level">&#125;</div>
124
- </div>
125
-
126
- ## country
127
- <div class="graphql-code-block">
128
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
129
- <div class="graphql-code-line ">country(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#country">Country</a></div>
130
-
131
-
132
- <div class="graphql-code-line top-level">&#125;</div>
133
- </div>
134
-
135
- ## customer
136
- <div class="graphql-code-block">
137
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
138
- <div class="graphql-code-line ">customer(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#customer">Customer</a></div>
139
-
140
-
141
- <div class="graphql-code-line top-level">&#125;</div>
142
- </div>
143
-
144
- ## customerGroup
145
- <div class="graphql-code-block">
146
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
147
- <div class="graphql-code-line ">customerGroup(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#customergroup">CustomerGroup</a></div>
148
-
149
-
150
- <div class="graphql-code-line top-level">&#125;</div>
151
- </div>
152
-
153
- ## customerGroups
154
- <div class="graphql-code-block">
155
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
156
- <div class="graphql-code-line ">customerGroups(options: <a href="/reference/graphql-api/admin/input-types#customergrouplistoptions">CustomerGroupListOptions</a>): <a href="/reference/graphql-api/admin/object-types#customergrouplist">CustomerGroupList</a>!</div>
157
-
158
-
159
- <div class="graphql-code-line top-level">&#125;</div>
160
- </div>
161
-
162
- ## customers
163
- <div class="graphql-code-block">
164
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
165
- <div class="graphql-code-line ">customers(options: <a href="/reference/graphql-api/admin/input-types#customerlistoptions">CustomerListOptions</a>): <a href="/reference/graphql-api/admin/object-types#customerlist">CustomerList</a>!</div>
166
-
167
-
168
- <div class="graphql-code-line top-level">&#125;</div>
169
- </div>
170
-
171
- ## eligibleShippingMethodsForDraftOrder
172
- <div class="graphql-code-block">
173
- <div class="graphql-code-line top-level comment">"""</div>
174
- <div class="graphql-code-line top-level comment">Returns a list of eligible shipping methods for the draft Order</div>
175
- <div class="graphql-code-line top-level comment">"""</div>
176
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
177
- <div class="graphql-code-line ">eligibleShippingMethodsForDraftOrder(orderId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): [<a href="/reference/graphql-api/admin/object-types#shippingmethodquote">ShippingMethodQuote</a>!]!</div>
178
-
179
-
180
- <div class="graphql-code-line top-level">&#125;</div>
181
- </div>
182
-
183
- ## entityDuplicators
184
- <div class="graphql-code-block">
185
- <div class="graphql-code-line top-level comment">"""</div>
186
- <div class="graphql-code-line top-level comment">Returns all configured EntityDuplicators.</div>
187
- <div class="graphql-code-line top-level comment">"""</div>
188
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
189
- <div class="graphql-code-line ">entityDuplicators: [<a href="/reference/graphql-api/admin/object-types#entityduplicatordefinition">EntityDuplicatorDefinition</a>!]!</div>
190
-
191
-
192
- <div class="graphql-code-line top-level">&#125;</div>
193
- </div>
194
-
195
- ## facet
196
- <div class="graphql-code-block">
197
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
198
- <div class="graphql-code-line ">facet(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#facet">Facet</a></div>
199
-
200
-
201
- <div class="graphql-code-line top-level">&#125;</div>
202
- </div>
203
-
204
- ## facetValue
205
- <div class="graphql-code-block">
206
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
207
- <div class="graphql-code-line ">facetValue(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#facetvalue">FacetValue</a></div>
208
-
209
-
210
- <div class="graphql-code-line top-level">&#125;</div>
211
- </div>
212
-
213
- ## facetValues
214
- <div class="graphql-code-block">
215
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
216
- <div class="graphql-code-line ">facetValues(options: <a href="/reference/graphql-api/admin/input-types#facetvaluelistoptions">FacetValueListOptions</a>): <a href="/reference/graphql-api/admin/object-types#facetvaluelist">FacetValueList</a>!</div>
217
-
218
-
219
- <div class="graphql-code-line top-level">&#125;</div>
220
- </div>
221
-
222
- ## facets
223
- <div class="graphql-code-block">
224
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
225
- <div class="graphql-code-line ">facets(options: <a href="/reference/graphql-api/admin/input-types#facetlistoptions">FacetListOptions</a>): <a href="/reference/graphql-api/admin/object-types#facetlist">FacetList</a>!</div>
226
-
227
-
228
- <div class="graphql-code-line top-level">&#125;</div>
229
- </div>
230
-
231
- ## fulfillmentHandlers
232
- <div class="graphql-code-block">
233
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
234
- <div class="graphql-code-line ">fulfillmentHandlers: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
235
-
236
-
237
- <div class="graphql-code-line top-level">&#125;</div>
238
- </div>
239
-
240
- ## getSettingsStoreValue
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">Get value for a specific key (automatically scoped based on field configuration)</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">Query</span> &#123;</div>
246
- <div class="graphql-code-line ">getSettingsStoreValue(key: <a href="/reference/graphql-api/admin/object-types#string">String</a>!): <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
247
-
248
-
249
- <div class="graphql-code-line top-level">&#125;</div>
250
- </div>
251
-
252
- ## getSettingsStoreValues
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">Get multiple key-value pairs (each automatically scoped)</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">Query</span> &#123;</div>
258
- <div class="graphql-code-line ">getSettingsStoreValues(keys: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]!): <a href="/reference/graphql-api/admin/object-types#json">JSON</a></div>
259
-
260
-
261
- <div class="graphql-code-line top-level">&#125;</div>
262
- </div>
263
-
264
- ## globalSettings
265
- <div class="graphql-code-block">
266
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
267
- <div class="graphql-code-line ">globalSettings: <a href="/reference/graphql-api/admin/object-types#globalsettings">GlobalSettings</a>!</div>
268
-
269
-
270
- <div class="graphql-code-line top-level">&#125;</div>
271
- </div>
272
-
273
- ## job
274
- <div class="graphql-code-block">
275
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
276
- <div class="graphql-code-line ">job(jobId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#job">Job</a></div>
277
-
278
-
279
- <div class="graphql-code-line top-level">&#125;</div>
280
- </div>
281
-
282
- ## jobBufferSize
283
- <div class="graphql-code-block">
284
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
285
- <div class="graphql-code-line ">jobBufferSize(bufferIds: [<a href="/reference/graphql-api/admin/object-types#string">String</a>!]): [<a href="/reference/graphql-api/admin/object-types#jobbuffersize">JobBufferSize</a>!]!</div>
286
-
287
-
288
- <div class="graphql-code-line top-level">&#125;</div>
289
- </div>
290
-
291
- ## jobQueues
292
- <div class="graphql-code-block">
293
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
294
- <div class="graphql-code-line ">jobQueues: [<a href="/reference/graphql-api/admin/object-types#jobqueue">JobQueue</a>!]!</div>
295
-
296
-
297
- <div class="graphql-code-line top-level">&#125;</div>
298
- </div>
299
-
300
- ## jobs
301
- <div class="graphql-code-block">
302
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
303
- <div class="graphql-code-line ">jobs(options: <a href="/reference/graphql-api/admin/input-types#joblistoptions">JobListOptions</a>): <a href="/reference/graphql-api/admin/object-types#joblist">JobList</a>!</div>
304
-
305
-
306
- <div class="graphql-code-line top-level">&#125;</div>
307
- </div>
308
-
309
- ## jobsById
310
- <div class="graphql-code-block">
311
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
312
- <div class="graphql-code-line ">jobsById(jobIds: [<a href="/reference/graphql-api/admin/object-types#id">ID</a>!]!): [<a href="/reference/graphql-api/admin/object-types#job">Job</a>!]!</div>
313
-
314
-
315
- <div class="graphql-code-line top-level">&#125;</div>
316
- </div>
317
-
318
- ## me
319
- <div class="graphql-code-block">
320
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
321
- <div class="graphql-code-line ">me: <a href="/reference/graphql-api/admin/object-types#currentuser">CurrentUser</a></div>
322
-
323
-
324
- <div class="graphql-code-line top-level">&#125;</div>
325
- </div>
326
-
327
- ## metricSummary
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">Get metrics for the given interval and metric types.</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">Query</span> &#123;</div>
333
- <div class="graphql-code-line ">metricSummary(input: <a href="/reference/graphql-api/admin/input-types#metricsummaryinput">MetricSummaryInput</a>): [<a href="/reference/graphql-api/admin/object-types#metricsummary">MetricSummary</a>!]!</div>
334
-
335
-
336
- <div class="graphql-code-line top-level">&#125;</div>
337
- </div>
338
-
339
- ## order
340
- <div class="graphql-code-block">
341
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
342
- <div class="graphql-code-line ">order(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#order">Order</a></div>
343
-
344
-
345
- <div class="graphql-code-line top-level">&#125;</div>
346
- </div>
347
-
348
- ## orders
349
- <div class="graphql-code-block">
350
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
351
- <div class="graphql-code-line ">orders(options: <a href="/reference/graphql-api/admin/input-types#orderlistoptions">OrderListOptions</a>): <a href="/reference/graphql-api/admin/object-types#orderlist">OrderList</a>!</div>
352
-
353
-
354
- <div class="graphql-code-line top-level">&#125;</div>
355
- </div>
356
-
357
- ## paymentMethod
358
- <div class="graphql-code-block">
359
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
360
- <div class="graphql-code-line ">paymentMethod(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#paymentmethod">PaymentMethod</a></div>
361
-
362
-
363
- <div class="graphql-code-line top-level">&#125;</div>
364
- </div>
365
-
366
- ## paymentMethodEligibilityCheckers
367
- <div class="graphql-code-block">
368
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
369
- <div class="graphql-code-line ">paymentMethodEligibilityCheckers: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
370
-
371
-
372
- <div class="graphql-code-line top-level">&#125;</div>
373
- </div>
374
-
375
- ## paymentMethodHandlers
376
- <div class="graphql-code-block">
377
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
378
- <div class="graphql-code-line ">paymentMethodHandlers: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
379
-
380
-
381
- <div class="graphql-code-line top-level">&#125;</div>
382
- </div>
383
-
384
- ## paymentMethods
385
- <div class="graphql-code-block">
386
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
387
- <div class="graphql-code-line ">paymentMethods(options: <a href="/reference/graphql-api/admin/input-types#paymentmethodlistoptions">PaymentMethodListOptions</a>): <a href="/reference/graphql-api/admin/object-types#paymentmethodlist">PaymentMethodList</a>!</div>
388
-
389
-
390
- <div class="graphql-code-line top-level">&#125;</div>
391
- </div>
392
-
393
- ## pendingSearchIndexUpdates
394
- <div class="graphql-code-block">
395
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
396
- <div class="graphql-code-line ">pendingSearchIndexUpdates: <a href="/reference/graphql-api/admin/object-types#int">Int</a>!</div>
397
-
398
-
399
- <div class="graphql-code-line top-level">&#125;</div>
400
- </div>
401
-
402
- ## previewCollectionVariants
403
- <div class="graphql-code-block">
404
- <div class="graphql-code-line top-level comment">"""</div>
405
- <div class="graphql-code-line top-level comment">Used for real-time previews of the contents of a Collection</div>
406
- <div class="graphql-code-line top-level comment">"""</div>
407
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
408
- <div class="graphql-code-line ">previewCollectionVariants(input: <a href="/reference/graphql-api/admin/input-types#previewcollectionvariantsinput">PreviewCollectionVariantsInput</a>!, options: <a href="/reference/graphql-api/admin/input-types#productvariantlistoptions">ProductVariantListOptions</a>): <a href="/reference/graphql-api/admin/object-types#productvariantlist">ProductVariantList</a>!</div>
409
-
410
-
411
- <div class="graphql-code-line top-level">&#125;</div>
412
- </div>
413
-
414
- ## product
415
- <div class="graphql-code-block">
416
- <div class="graphql-code-line top-level comment">"""</div>
417
- <div class="graphql-code-line top-level comment">Get a Product either by id or slug. If neither id nor slug is specified, an error will result.</div>
418
- <div class="graphql-code-line top-level comment">"""</div>
419
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
420
- <div class="graphql-code-line ">product(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>, slug: <a href="/reference/graphql-api/admin/object-types#string">String</a>): <a href="/reference/graphql-api/admin/object-types#product">Product</a></div>
421
-
422
-
423
- <div class="graphql-code-line top-level">&#125;</div>
424
- </div>
425
-
426
- ## productOption
427
- <div class="graphql-code-block">
428
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
429
- <div class="graphql-code-line ">productOption(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#productoption">ProductOption</a></div>
430
-
431
-
432
- <div class="graphql-code-line top-level">&#125;</div>
433
- </div>
434
-
435
- ## productOptionGroup
436
- <div class="graphql-code-block">
437
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
438
- <div class="graphql-code-line ">productOptionGroup(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a></div>
439
-
440
-
441
- <div class="graphql-code-line top-level">&#125;</div>
442
- </div>
443
-
444
- ## productOptionGroups
445
- <div class="graphql-code-block">
446
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
447
- <div class="graphql-code-line ">productOptionGroups(filterTerm: <a href="/reference/graphql-api/admin/object-types#string">String</a>): [<a href="/reference/graphql-api/admin/object-types#productoptiongroup">ProductOptionGroup</a>!]!</div>
448
-
449
-
450
- <div class="graphql-code-line top-level">&#125;</div>
451
- </div>
452
-
453
- ## productOptions
454
- <div class="graphql-code-block">
455
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
456
- <div class="graphql-code-line ">productOptions(options: <a href="/reference/graphql-api/admin/input-types#productoptionlistoptions">ProductOptionListOptions</a>, groupId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>): <a href="/reference/graphql-api/admin/object-types#productoptionlist">ProductOptionList</a>!</div>
457
-
458
-
459
- <div class="graphql-code-line top-level">&#125;</div>
460
- </div>
461
-
462
- ## productVariant
463
- <div class="graphql-code-block">
464
- <div class="graphql-code-line top-level comment">"""</div>
465
- <div class="graphql-code-line top-level comment">Get a ProductVariant by id</div>
466
- <div class="graphql-code-line top-level comment">"""</div>
467
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
468
- <div class="graphql-code-line ">productVariant(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#productvariant">ProductVariant</a></div>
469
-
470
-
471
- <div class="graphql-code-line top-level">&#125;</div>
472
- </div>
473
-
474
- ## productVariants
475
- <div class="graphql-code-block">
476
- <div class="graphql-code-line top-level comment">"""</div>
477
- <div class="graphql-code-line top-level comment">List ProductVariants either all or for the specific product.</div>
478
- <div class="graphql-code-line top-level comment">"""</div>
479
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
480
- <div class="graphql-code-line ">productVariants(options: <a href="/reference/graphql-api/admin/input-types#productvariantlistoptions">ProductVariantListOptions</a>, productId: <a href="/reference/graphql-api/admin/object-types#id">ID</a>): <a href="/reference/graphql-api/admin/object-types#productvariantlist">ProductVariantList</a>!</div>
481
-
482
-
483
- <div class="graphql-code-line top-level">&#125;</div>
484
- </div>
485
-
486
- ## products
487
- <div class="graphql-code-block">
488
- <div class="graphql-code-line top-level comment">"""</div>
489
- <div class="graphql-code-line top-level comment">List Products</div>
490
- <div class="graphql-code-line top-level comment">"""</div>
491
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
492
- <div class="graphql-code-line ">products(options: <a href="/reference/graphql-api/admin/input-types#productlistoptions">ProductListOptions</a>): <a href="/reference/graphql-api/admin/object-types#productlist">ProductList</a>!</div>
493
-
494
-
495
- <div class="graphql-code-line top-level">&#125;</div>
496
- </div>
497
-
498
- ## promotion
499
- <div class="graphql-code-block">
500
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
501
- <div class="graphql-code-line ">promotion(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#promotion">Promotion</a></div>
502
-
503
-
504
- <div class="graphql-code-line top-level">&#125;</div>
505
- </div>
506
-
507
- ## promotionActions
508
- <div class="graphql-code-block">
509
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
510
- <div class="graphql-code-line ">promotionActions: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
511
-
512
-
513
- <div class="graphql-code-line top-level">&#125;</div>
514
- </div>
515
-
516
- ## promotionConditions
517
- <div class="graphql-code-block">
518
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
519
- <div class="graphql-code-line ">promotionConditions: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
520
-
521
-
522
- <div class="graphql-code-line top-level">&#125;</div>
523
- </div>
524
-
525
- ## promotions
526
- <div class="graphql-code-block">
527
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
528
- <div class="graphql-code-line ">promotions(options: <a href="/reference/graphql-api/admin/input-types#promotionlistoptions">PromotionListOptions</a>): <a href="/reference/graphql-api/admin/object-types#promotionlist">PromotionList</a>!</div>
529
-
530
-
531
- <div class="graphql-code-line top-level">&#125;</div>
532
- </div>
533
-
534
- ## province
535
- <div class="graphql-code-block">
536
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
537
- <div class="graphql-code-line ">province(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#province">Province</a></div>
538
-
539
-
540
- <div class="graphql-code-line top-level">&#125;</div>
541
- </div>
542
-
543
- ## provinces
544
- <div class="graphql-code-block">
545
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
546
- <div class="graphql-code-line ">provinces(options: <a href="/reference/graphql-api/admin/input-types#provincelistoptions">ProvinceListOptions</a>): <a href="/reference/graphql-api/admin/object-types#provincelist">ProvinceList</a>!</div>
547
-
548
-
549
- <div class="graphql-code-line top-level">&#125;</div>
550
- </div>
551
-
552
- ## role
553
- <div class="graphql-code-block">
554
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
555
- <div class="graphql-code-line ">role(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#role">Role</a></div>
556
-
557
-
558
- <div class="graphql-code-line top-level">&#125;</div>
559
- </div>
560
-
561
- ## roles
562
- <div class="graphql-code-block">
563
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
564
- <div class="graphql-code-line ">roles(options: <a href="/reference/graphql-api/admin/input-types#rolelistoptions">RoleListOptions</a>): <a href="/reference/graphql-api/admin/object-types#rolelist">RoleList</a>!</div>
565
-
566
-
567
- <div class="graphql-code-line top-level">&#125;</div>
568
- </div>
569
-
570
- ## scheduledTasks
571
- <div class="graphql-code-block">
572
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
573
- <div class="graphql-code-line ">scheduledTasks: [<a href="/reference/graphql-api/admin/object-types#scheduledtask">ScheduledTask</a>!]!</div>
574
-
575
-
576
- <div class="graphql-code-line top-level">&#125;</div>
577
- </div>
578
-
579
- ## search
580
- <div class="graphql-code-block">
581
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
582
- <div class="graphql-code-line ">search(input: <a href="/reference/graphql-api/admin/input-types#searchinput">SearchInput</a>!): <a href="/reference/graphql-api/admin/object-types#searchresponse">SearchResponse</a>!</div>
583
-
584
-
585
- <div class="graphql-code-line top-level">&#125;</div>
586
- </div>
587
-
588
- ## seller
589
- <div class="graphql-code-block">
590
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
591
- <div class="graphql-code-line ">seller(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#seller">Seller</a></div>
592
-
593
-
594
- <div class="graphql-code-line top-level">&#125;</div>
595
- </div>
596
-
597
- ## sellers
598
- <div class="graphql-code-block">
599
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
600
- <div class="graphql-code-line ">sellers(options: <a href="/reference/graphql-api/admin/input-types#sellerlistoptions">SellerListOptions</a>): <a href="/reference/graphql-api/admin/object-types#sellerlist">SellerList</a>!</div>
601
-
602
-
603
- <div class="graphql-code-line top-level">&#125;</div>
604
- </div>
605
-
606
- ## shippingCalculators
607
- <div class="graphql-code-block">
608
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
609
- <div class="graphql-code-line ">shippingCalculators: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
610
-
611
-
612
- <div class="graphql-code-line top-level">&#125;</div>
613
- </div>
614
-
615
- ## shippingEligibilityCheckers
616
- <div class="graphql-code-block">
617
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
618
- <div class="graphql-code-line ">shippingEligibilityCheckers: [<a href="/reference/graphql-api/admin/object-types#configurableoperationdefinition">ConfigurableOperationDefinition</a>!]!</div>
619
-
620
-
621
- <div class="graphql-code-line top-level">&#125;</div>
622
- </div>
623
-
624
- ## shippingMethod
625
- <div class="graphql-code-block">
626
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
627
- <div class="graphql-code-line ">shippingMethod(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#shippingmethod">ShippingMethod</a></div>
628
-
629
-
630
- <div class="graphql-code-line top-level">&#125;</div>
631
- </div>
632
-
633
- ## shippingMethods
634
- <div class="graphql-code-block">
635
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
636
- <div class="graphql-code-line ">shippingMethods(options: <a href="/reference/graphql-api/admin/input-types#shippingmethodlistoptions">ShippingMethodListOptions</a>): <a href="/reference/graphql-api/admin/object-types#shippingmethodlist">ShippingMethodList</a>!</div>
637
-
638
-
639
- <div class="graphql-code-line top-level">&#125;</div>
640
- </div>
641
-
642
- ## slugForEntity
643
- <div class="graphql-code-block">
644
- <div class="graphql-code-line top-level comment">"""</div>
645
- <div class="graphql-code-line top-level comment">Generate slug for entity</div>
646
- <div class="graphql-code-line top-level comment">"""</div>
647
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
648
- <div class="graphql-code-line ">slugForEntity(input: <a href="/reference/graphql-api/admin/input-types#slugforentityinput">SlugForEntityInput</a>!): <a href="/reference/graphql-api/admin/object-types#string">String</a>!</div>
649
-
650
-
651
- <div class="graphql-code-line top-level">&#125;</div>
652
- </div>
653
-
654
- ## stockLocation
655
- <div class="graphql-code-block">
656
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
657
- <div class="graphql-code-line ">stockLocation(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#stocklocation">StockLocation</a></div>
658
-
659
-
660
- <div class="graphql-code-line top-level">&#125;</div>
661
- </div>
662
-
663
- ## stockLocations
664
- <div class="graphql-code-block">
665
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
666
- <div class="graphql-code-line ">stockLocations(options: <a href="/reference/graphql-api/admin/input-types#stocklocationlistoptions">StockLocationListOptions</a>): <a href="/reference/graphql-api/admin/object-types#stocklocationlist">StockLocationList</a>!</div>
667
-
668
-
669
- <div class="graphql-code-line top-level">&#125;</div>
670
- </div>
671
-
672
- ## tag
673
- <div class="graphql-code-block">
674
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
675
- <div class="graphql-code-line ">tag(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#tag">Tag</a>!</div>
676
-
677
-
678
- <div class="graphql-code-line top-level">&#125;</div>
679
- </div>
680
-
681
- ## tags
682
- <div class="graphql-code-block">
683
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
684
- <div class="graphql-code-line ">tags(options: <a href="/reference/graphql-api/admin/input-types#taglistoptions">TagListOptions</a>): <a href="/reference/graphql-api/admin/object-types#taglist">TagList</a>!</div>
685
-
686
-
687
- <div class="graphql-code-line top-level">&#125;</div>
688
- </div>
689
-
690
- ## taxCategories
691
- <div class="graphql-code-block">
692
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
693
- <div class="graphql-code-line ">taxCategories(options: <a href="/reference/graphql-api/admin/input-types#taxcategorylistoptions">TaxCategoryListOptions</a>): <a href="/reference/graphql-api/admin/object-types#taxcategorylist">TaxCategoryList</a>!</div>
694
-
695
-
696
- <div class="graphql-code-line top-level">&#125;</div>
697
- </div>
698
-
699
- ## taxCategory
700
- <div class="graphql-code-block">
701
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
702
- <div class="graphql-code-line ">taxCategory(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#taxcategory">TaxCategory</a></div>
703
-
704
-
705
- <div class="graphql-code-line top-level">&#125;</div>
706
- </div>
707
-
708
- ## taxRate
709
- <div class="graphql-code-block">
710
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
711
- <div class="graphql-code-line ">taxRate(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#taxrate">TaxRate</a></div>
712
-
713
-
714
- <div class="graphql-code-line top-level">&#125;</div>
715
- </div>
716
-
717
- ## taxRates
718
- <div class="graphql-code-block">
719
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
720
- <div class="graphql-code-line ">taxRates(options: <a href="/reference/graphql-api/admin/input-types#taxratelistoptions">TaxRateListOptions</a>): <a href="/reference/graphql-api/admin/object-types#taxratelist">TaxRateList</a>!</div>
721
-
722
-
723
- <div class="graphql-code-line top-level">&#125;</div>
724
- </div>
725
-
726
- ## testEligibleShippingMethods
727
- <div class="graphql-code-block">
728
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
729
- <div class="graphql-code-line ">testEligibleShippingMethods(input: <a href="/reference/graphql-api/admin/input-types#testeligibleshippingmethodsinput">TestEligibleShippingMethodsInput</a>!): [<a href="/reference/graphql-api/admin/object-types#shippingmethodquote">ShippingMethodQuote</a>!]!</div>
730
-
731
-
732
- <div class="graphql-code-line top-level">&#125;</div>
733
- </div>
734
-
735
- ## testShippingMethod
736
- <div class="graphql-code-block">
737
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
738
- <div class="graphql-code-line ">testShippingMethod(input: <a href="/reference/graphql-api/admin/input-types#testshippingmethodinput">TestShippingMethodInput</a>!): <a href="/reference/graphql-api/admin/object-types#testshippingmethodresult">TestShippingMethodResult</a>!</div>
739
-
740
-
741
- <div class="graphql-code-line top-level">&#125;</div>
742
- </div>
743
-
744
- ## zone
745
- <div class="graphql-code-block">
746
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
747
- <div class="graphql-code-line ">zone(id: <a href="/reference/graphql-api/admin/object-types#id">ID</a>!): <a href="/reference/graphql-api/admin/object-types#zone">Zone</a></div>
748
-
749
-
750
- <div class="graphql-code-line top-level">&#125;</div>
751
- </div>
752
-
753
- ## zones
754
- <div class="graphql-code-block">
755
- <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Query</span> &#123;</div>
756
- <div class="graphql-code-line ">zones(options: <a href="/reference/graphql-api/admin/input-types#zonelistoptions">ZoneListOptions</a>): <a href="/reference/graphql-api/admin/object-types#zonelist">ZoneList</a>!</div>
757
-
758
-
759
- <div class="graphql-code-line top-level">&#125;</div>
760
- </div>
8
+ ## activeAdministrator {#activeadministrator}
9
+
10
+ <GraphQLDoc
11
+ type="query"
12
+ typeName="activeAdministrator"
13
+ typeLinks={{
14
+ Administrator: '/reference/graphql-api/admin/object-types#administrator',
15
+ }}
16
+ >
17
+ {`type Query {
18
+ activeAdministrator: Administrator
19
+ }`}
20
+ </GraphQLDoc>
21
+
22
+ ## activeChannel {#activechannel}
23
+
24
+ <GraphQLDoc
25
+ type="query"
26
+ typeName="activeChannel"
27
+ typeLinks={{
28
+ Channel: '/reference/graphql-api/admin/object-types#channel',
29
+ }}
30
+ >
31
+ {`type Query {
32
+ activeChannel: Channel!
33
+ }`}
34
+ </GraphQLDoc>
35
+
36
+ ## administrator {#administrator}
37
+
38
+ <GraphQLDoc
39
+ type="query"
40
+ typeName="administrator"
41
+ typeLinks={{
42
+ Administrator: '/reference/graphql-api/admin/object-types#administrator',
43
+ ID: '/reference/graphql-api/admin/object-types#id',
44
+ }}
45
+ >
46
+ {`type Query {
47
+ administrator(id: ID!): Administrator
48
+ }`}
49
+ </GraphQLDoc>
50
+
51
+ ## administrators {#administrators}
52
+
53
+ <GraphQLDoc
54
+ type="query"
55
+ typeName="administrators"
56
+ typeLinks={{
57
+ AdministratorList: '/reference/graphql-api/admin/object-types#administratorlist',
58
+ AdministratorListOptions: '/reference/graphql-api/admin/input-types#administratorlistoptions',
59
+ }}
60
+ >
61
+ {`type Query {
62
+ administrators(options: AdministratorListOptions): AdministratorList!
63
+ }`}
64
+ </GraphQLDoc>
65
+
66
+ ## asset {#asset}
67
+
68
+ <GraphQLDoc
69
+ type="query"
70
+ typeName="asset"
71
+ typeLinks={{
72
+ Asset: '/reference/graphql-api/admin/object-types#asset',
73
+ ID: '/reference/graphql-api/admin/object-types#id',
74
+ }}
75
+ >
76
+ {`"""Get a single Asset by id"""
77
+ type Query {
78
+ asset(id: ID!): Asset
79
+ }`}
80
+ </GraphQLDoc>
81
+
82
+ ## assets {#assets}
83
+
84
+ <GraphQLDoc
85
+ type="query"
86
+ typeName="assets"
87
+ typeLinks={{
88
+ AssetList: '/reference/graphql-api/admin/object-types#assetlist',
89
+ AssetListOptions: '/reference/graphql-api/admin/input-types#assetlistoptions',
90
+ }}
91
+ >
92
+ {`"""Get a list of Assets"""
93
+ type Query {
94
+ assets(options: AssetListOptions): AssetList!
95
+ }`}
96
+ </GraphQLDoc>
97
+
98
+ ## channel {#channel}
99
+
100
+ <GraphQLDoc
101
+ type="query"
102
+ typeName="channel"
103
+ typeLinks={{
104
+ Channel: '/reference/graphql-api/admin/object-types#channel',
105
+ ID: '/reference/graphql-api/admin/object-types#id',
106
+ }}
107
+ >
108
+ {`type Query {
109
+ channel(id: ID!): Channel
110
+ }`}
111
+ </GraphQLDoc>
112
+
113
+ ## channels {#channels}
114
+
115
+ <GraphQLDoc
116
+ type="query"
117
+ typeName="channels"
118
+ typeLinks={{
119
+ ChannelList: '/reference/graphql-api/admin/object-types#channellist',
120
+ ChannelListOptions: '/reference/graphql-api/admin/input-types#channellistoptions',
121
+ }}
122
+ >
123
+ {`type Query {
124
+ channels(options: ChannelListOptions): ChannelList!
125
+ }`}
126
+ </GraphQLDoc>
127
+
128
+ ## collection {#collection}
129
+
130
+ <GraphQLDoc
131
+ type="query"
132
+ typeName="collection"
133
+ typeLinks={{
134
+ Collection: '/reference/graphql-api/admin/object-types#collection',
135
+ ID: '/reference/graphql-api/admin/object-types#id',
136
+ String: '/reference/graphql-api/admin/object-types#string',
137
+ }}
138
+ >
139
+ {`"""Get a Collection either by id or slug. If neither id nor slug is specified, an error will result."""
140
+ type Query {
141
+ collection(id: ID, slug: String): Collection
142
+ }`}
143
+ </GraphQLDoc>
144
+
145
+ ## collectionFilters {#collectionfilters}
146
+
147
+ <GraphQLDoc
148
+ type="query"
149
+ typeName="collectionFilters"
150
+ typeLinks={{
151
+ ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
152
+ }}
153
+ >
154
+ {`type Query {
155
+ collectionFilters: [ConfigurableOperationDefinition!]!
156
+ }`}
157
+ </GraphQLDoc>
158
+
159
+ ## collections {#collections}
160
+
161
+ <GraphQLDoc
162
+ type="query"
163
+ typeName="collections"
164
+ typeLinks={{
165
+ CollectionList: '/reference/graphql-api/admin/object-types#collectionlist',
166
+ CollectionListOptions: '/reference/graphql-api/admin/input-types#collectionlistoptions',
167
+ }}
168
+ >
169
+ {`type Query {
170
+ collections(options: CollectionListOptions): CollectionList!
171
+ }`}
172
+ </GraphQLDoc>
173
+
174
+ ## countries {#countries}
175
+
176
+ <GraphQLDoc
177
+ type="query"
178
+ typeName="countries"
179
+ typeLinks={{
180
+ CountryList: '/reference/graphql-api/admin/object-types#countrylist',
181
+ CountryListOptions: '/reference/graphql-api/admin/input-types#countrylistoptions',
182
+ }}
183
+ >
184
+ {`type Query {
185
+ countries(options: CountryListOptions): CountryList!
186
+ }`}
187
+ </GraphQLDoc>
188
+
189
+ ## country {#country}
190
+
191
+ <GraphQLDoc
192
+ type="query"
193
+ typeName="country"
194
+ typeLinks={{
195
+ Country: '/reference/graphql-api/admin/object-types#country',
196
+ ID: '/reference/graphql-api/admin/object-types#id',
197
+ }}
198
+ >
199
+ {`type Query {
200
+ country(id: ID!): Country
201
+ }`}
202
+ </GraphQLDoc>
203
+
204
+ ## customer {#customer}
205
+
206
+ <GraphQLDoc
207
+ type="query"
208
+ typeName="customer"
209
+ typeLinks={{
210
+ Customer: '/reference/graphql-api/admin/object-types#customer',
211
+ ID: '/reference/graphql-api/admin/object-types#id',
212
+ }}
213
+ >
214
+ {`type Query {
215
+ customer(id: ID!): Customer
216
+ }`}
217
+ </GraphQLDoc>
218
+
219
+ ## customerGroup {#customergroup}
220
+
221
+ <GraphQLDoc
222
+ type="query"
223
+ typeName="customerGroup"
224
+ typeLinks={{
225
+ CustomerGroup: '/reference/graphql-api/admin/object-types#customergroup',
226
+ ID: '/reference/graphql-api/admin/object-types#id',
227
+ }}
228
+ >
229
+ {`type Query {
230
+ customerGroup(id: ID!): CustomerGroup
231
+ }`}
232
+ </GraphQLDoc>
233
+
234
+ ## customerGroups {#customergroups}
235
+
236
+ <GraphQLDoc
237
+ type="query"
238
+ typeName="customerGroups"
239
+ typeLinks={{
240
+ CustomerGroupList: '/reference/graphql-api/admin/object-types#customergrouplist',
241
+ CustomerGroupListOptions: '/reference/graphql-api/admin/input-types#customergrouplistoptions',
242
+ }}
243
+ >
244
+ {`type Query {
245
+ customerGroups(options: CustomerGroupListOptions): CustomerGroupList!
246
+ }`}
247
+ </GraphQLDoc>
248
+
249
+ ## customers {#customers}
250
+
251
+ <GraphQLDoc
252
+ type="query"
253
+ typeName="customers"
254
+ typeLinks={{
255
+ CustomerList: '/reference/graphql-api/admin/object-types#customerlist',
256
+ CustomerListOptions: '/reference/graphql-api/admin/input-types#customerlistoptions',
257
+ }}
258
+ >
259
+ {`type Query {
260
+ customers(options: CustomerListOptions): CustomerList!
261
+ }`}
262
+ </GraphQLDoc>
263
+
264
+ ## eligibleShippingMethodsForDraftOrder {#eligibleshippingmethodsfordraftorder}
265
+
266
+ <GraphQLDoc
267
+ type="query"
268
+ typeName="eligibleShippingMethodsForDraftOrder"
269
+ typeLinks={{
270
+ ShippingMethodQuote: '/reference/graphql-api/admin/object-types#shippingmethodquote',
271
+ ID: '/reference/graphql-api/admin/object-types#id',
272
+ }}
273
+ >
274
+ {`"""Returns a list of eligible shipping methods for the draft Order"""
275
+ type Query {
276
+ eligibleShippingMethodsForDraftOrder(orderId: ID!): [ShippingMethodQuote!]!
277
+ }`}
278
+ </GraphQLDoc>
279
+
280
+ ## entityDuplicators {#entityduplicators}
281
+
282
+ <GraphQLDoc
283
+ type="query"
284
+ typeName="entityDuplicators"
285
+ typeLinks={{
286
+ EntityDuplicatorDefinition: '/reference/graphql-api/admin/object-types#entityduplicatordefinition',
287
+ }}
288
+ >
289
+ {`"""Returns all configured EntityDuplicators."""
290
+ type Query {
291
+ entityDuplicators: [EntityDuplicatorDefinition!]!
292
+ }`}
293
+ </GraphQLDoc>
294
+
295
+ ## facet {#facet}
296
+
297
+ <GraphQLDoc
298
+ type="query"
299
+ typeName="facet"
300
+ typeLinks={{
301
+ Facet: '/reference/graphql-api/admin/object-types#facet',
302
+ ID: '/reference/graphql-api/admin/object-types#id',
303
+ }}
304
+ >
305
+ {`type Query {
306
+ facet(id: ID!): Facet
307
+ }`}
308
+ </GraphQLDoc>
309
+
310
+ ## facetValue {#facetvalue}
311
+
312
+ <GraphQLDoc
313
+ type="query"
314
+ typeName="facetValue"
315
+ typeLinks={{
316
+ FacetValue: '/reference/graphql-api/admin/object-types#facetvalue',
317
+ ID: '/reference/graphql-api/admin/object-types#id',
318
+ }}
319
+ >
320
+ {`type Query {
321
+ facetValue(id: ID!): FacetValue
322
+ }`}
323
+ </GraphQLDoc>
324
+
325
+ ## facetValues {#facetvalues}
326
+
327
+ <GraphQLDoc
328
+ type="query"
329
+ typeName="facetValues"
330
+ typeLinks={{
331
+ FacetValueList: '/reference/graphql-api/admin/object-types#facetvaluelist',
332
+ FacetValueListOptions: '/reference/graphql-api/admin/input-types#facetvaluelistoptions',
333
+ }}
334
+ >
335
+ {`type Query {
336
+ facetValues(options: FacetValueListOptions): FacetValueList!
337
+ }`}
338
+ </GraphQLDoc>
339
+
340
+ ## facets {#facets}
341
+
342
+ <GraphQLDoc
343
+ type="query"
344
+ typeName="facets"
345
+ typeLinks={{
346
+ FacetList: '/reference/graphql-api/admin/object-types#facetlist',
347
+ FacetListOptions: '/reference/graphql-api/admin/input-types#facetlistoptions',
348
+ }}
349
+ >
350
+ {`type Query {
351
+ facets(options: FacetListOptions): FacetList!
352
+ }`}
353
+ </GraphQLDoc>
354
+
355
+ ## fulfillmentHandlers {#fulfillmenthandlers}
356
+
357
+ <GraphQLDoc
358
+ type="query"
359
+ typeName="fulfillmentHandlers"
360
+ typeLinks={{
361
+ ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
362
+ }}
363
+ >
364
+ {`type Query {
365
+ fulfillmentHandlers: [ConfigurableOperationDefinition!]!
366
+ }`}
367
+ </GraphQLDoc>
368
+
369
+ ## getSettingsStoreValue {#getsettingsstorevalue}
370
+
371
+ <GraphQLDoc
372
+ type="query"
373
+ typeName="getSettingsStoreValue"
374
+ typeLinks={{
375
+ JSON: '/reference/graphql-api/admin/object-types#json',
376
+ String: '/reference/graphql-api/admin/object-types#string',
377
+ }}
378
+ >
379
+ {`"""Get value for a specific key (automatically scoped based on field configuration)"""
380
+ type Query {
381
+ getSettingsStoreValue(key: String!): JSON
382
+ }`}
383
+ </GraphQLDoc>
384
+
385
+ ## getSettingsStoreValues {#getsettingsstorevalues}
386
+
387
+ <GraphQLDoc
388
+ type="query"
389
+ typeName="getSettingsStoreValues"
390
+ typeLinks={{
391
+ JSON: '/reference/graphql-api/admin/object-types#json',
392
+ String: '/reference/graphql-api/admin/object-types#string',
393
+ }}
394
+ >
395
+ {`"""Get multiple key-value pairs (each automatically scoped)"""
396
+ type Query {
397
+ getSettingsStoreValues(keys: [String!]!): JSON
398
+ }`}
399
+ </GraphQLDoc>
400
+
401
+ ## globalSettings {#globalsettings}
402
+
403
+ <GraphQLDoc
404
+ type="query"
405
+ typeName="globalSettings"
406
+ typeLinks={{
407
+ GlobalSettings: '/reference/graphql-api/admin/object-types#globalsettings',
408
+ }}
409
+ >
410
+ {`type Query {
411
+ globalSettings: GlobalSettings!
412
+ }`}
413
+ </GraphQLDoc>
414
+
415
+ ## job {#job}
416
+
417
+ <GraphQLDoc
418
+ type="query"
419
+ typeName="job"
420
+ typeLinks={{
421
+ Job: '/reference/graphql-api/admin/object-types#job',
422
+ ID: '/reference/graphql-api/admin/object-types#id',
423
+ }}
424
+ >
425
+ {`type Query {
426
+ job(jobId: ID!): Job
427
+ }`}
428
+ </GraphQLDoc>
429
+
430
+ ## jobBufferSize {#jobbuffersize}
431
+
432
+ <GraphQLDoc
433
+ type="query"
434
+ typeName="jobBufferSize"
435
+ typeLinks={{
436
+ JobBufferSize: '/reference/graphql-api/admin/object-types#jobbuffersize',
437
+ String: '/reference/graphql-api/admin/object-types#string',
438
+ }}
439
+ >
440
+ {`type Query {
441
+ jobBufferSize(bufferIds: [String!]): [JobBufferSize!]!
442
+ }`}
443
+ </GraphQLDoc>
444
+
445
+ ## jobQueues {#jobqueues}
446
+
447
+ <GraphQLDoc
448
+ type="query"
449
+ typeName="jobQueues"
450
+ typeLinks={{
451
+ JobQueue: '/reference/graphql-api/admin/object-types#jobqueue',
452
+ }}
453
+ >
454
+ {`type Query {
455
+ jobQueues: [JobQueue!]!
456
+ }`}
457
+ </GraphQLDoc>
458
+
459
+ ## jobs {#jobs}
460
+
461
+ <GraphQLDoc
462
+ type="query"
463
+ typeName="jobs"
464
+ typeLinks={{
465
+ JobList: '/reference/graphql-api/admin/object-types#joblist',
466
+ JobListOptions: '/reference/graphql-api/admin/input-types#joblistoptions',
467
+ }}
468
+ >
469
+ {`type Query {
470
+ jobs(options: JobListOptions): JobList!
471
+ }`}
472
+ </GraphQLDoc>
473
+
474
+ ## jobsById {#jobsbyid}
475
+
476
+ <GraphQLDoc
477
+ type="query"
478
+ typeName="jobsById"
479
+ typeLinks={{
480
+ Job: '/reference/graphql-api/admin/object-types#job',
481
+ ID: '/reference/graphql-api/admin/object-types#id',
482
+ }}
483
+ >
484
+ {`type Query {
485
+ jobsById(jobIds: [ID!]!): [Job!]!
486
+ }`}
487
+ </GraphQLDoc>
488
+
489
+ ## me {#me}
490
+
491
+ <GraphQLDoc
492
+ type="query"
493
+ typeName="me"
494
+ typeLinks={{
495
+ CurrentUser: '/reference/graphql-api/admin/object-types#currentuser',
496
+ }}
497
+ >
498
+ {`type Query {
499
+ me: CurrentUser
500
+ }`}
501
+ </GraphQLDoc>
502
+
503
+ ## metricSummary {#metricsummary}
504
+
505
+ <GraphQLDoc
506
+ type="query"
507
+ typeName="metricSummary"
508
+ typeLinks={{
509
+ MetricSummary: '/reference/graphql-api/admin/object-types#metricsummary',
510
+ MetricSummaryInput: '/reference/graphql-api/admin/input-types#metricsummaryinput',
511
+ }}
512
+ >
513
+ {`"""Get metrics for the given interval and metric types."""
514
+ type Query {
515
+ metricSummary(input: MetricSummaryInput): [MetricSummary!]!
516
+ }`}
517
+ </GraphQLDoc>
518
+
519
+ ## order {#order}
520
+
521
+ <GraphQLDoc
522
+ type="query"
523
+ typeName="order"
524
+ typeLinks={{
525
+ Order: '/reference/graphql-api/admin/object-types#order',
526
+ ID: '/reference/graphql-api/admin/object-types#id',
527
+ }}
528
+ >
529
+ {`type Query {
530
+ order(id: ID!): Order
531
+ }`}
532
+ </GraphQLDoc>
533
+
534
+ ## orders {#orders}
535
+
536
+ <GraphQLDoc
537
+ type="query"
538
+ typeName="orders"
539
+ typeLinks={{
540
+ OrderList: '/reference/graphql-api/admin/object-types#orderlist',
541
+ OrderListOptions: '/reference/graphql-api/admin/input-types#orderlistoptions',
542
+ }}
543
+ >
544
+ {`type Query {
545
+ orders(options: OrderListOptions): OrderList!
546
+ }`}
547
+ </GraphQLDoc>
548
+
549
+ ## paymentMethod {#paymentmethod}
550
+
551
+ <GraphQLDoc
552
+ type="query"
553
+ typeName="paymentMethod"
554
+ typeLinks={{
555
+ PaymentMethod: '/reference/graphql-api/admin/object-types#paymentmethod',
556
+ ID: '/reference/graphql-api/admin/object-types#id',
557
+ }}
558
+ >
559
+ {`type Query {
560
+ paymentMethod(id: ID!): PaymentMethod
561
+ }`}
562
+ </GraphQLDoc>
563
+
564
+ ## paymentMethodEligibilityCheckers {#paymentmethodeligibilitycheckers}
565
+
566
+ <GraphQLDoc
567
+ type="query"
568
+ typeName="paymentMethodEligibilityCheckers"
569
+ typeLinks={{
570
+ ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
571
+ }}
572
+ >
573
+ {`type Query {
574
+ paymentMethodEligibilityCheckers: [ConfigurableOperationDefinition!]!
575
+ }`}
576
+ </GraphQLDoc>
577
+
578
+ ## paymentMethodHandlers {#paymentmethodhandlers}
579
+
580
+ <GraphQLDoc
581
+ type="query"
582
+ typeName="paymentMethodHandlers"
583
+ typeLinks={{
584
+ ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
585
+ }}
586
+ >
587
+ {`type Query {
588
+ paymentMethodHandlers: [ConfigurableOperationDefinition!]!
589
+ }`}
590
+ </GraphQLDoc>
591
+
592
+ ## paymentMethods {#paymentmethods}
593
+
594
+ <GraphQLDoc
595
+ type="query"
596
+ typeName="paymentMethods"
597
+ typeLinks={{
598
+ PaymentMethodList: '/reference/graphql-api/admin/object-types#paymentmethodlist',
599
+ PaymentMethodListOptions: '/reference/graphql-api/admin/input-types#paymentmethodlistoptions',
600
+ }}
601
+ >
602
+ {`type Query {
603
+ paymentMethods(options: PaymentMethodListOptions): PaymentMethodList!
604
+ }`}
605
+ </GraphQLDoc>
606
+
607
+ ## pendingSearchIndexUpdates {#pendingsearchindexupdates}
608
+
609
+ <GraphQLDoc
610
+ type="query"
611
+ typeName="pendingSearchIndexUpdates"
612
+ typeLinks={{
613
+ Int: '/reference/graphql-api/admin/object-types#int',
614
+ }}
615
+ >
616
+ {`type Query {
617
+ pendingSearchIndexUpdates: Int!
618
+ }`}
619
+ </GraphQLDoc>
620
+
621
+ ## previewCollectionVariants {#previewcollectionvariants}
622
+
623
+ <GraphQLDoc
624
+ type="query"
625
+ typeName="previewCollectionVariants"
626
+ typeLinks={{
627
+ ProductVariantList: '/reference/graphql-api/admin/object-types#productvariantlist',
628
+ PreviewCollectionVariantsInput: '/reference/graphql-api/admin/input-types#previewcollectionvariantsinput',
629
+ ProductVariantListOptions: '/reference/graphql-api/admin/input-types#productvariantlistoptions',
630
+ }}
631
+ >
632
+ {`"""Used for real-time previews of the contents of a Collection"""
633
+ type Query {
634
+ previewCollectionVariants(input: PreviewCollectionVariantsInput!, options: ProductVariantListOptions): ProductVariantList!
635
+ }`}
636
+ </GraphQLDoc>
637
+
638
+ ## product {#product}
639
+
640
+ <GraphQLDoc
641
+ type="query"
642
+ typeName="product"
643
+ typeLinks={{
644
+ Product: '/reference/graphql-api/admin/object-types#product',
645
+ ID: '/reference/graphql-api/admin/object-types#id',
646
+ String: '/reference/graphql-api/admin/object-types#string',
647
+ }}
648
+ >
649
+ {`"""Get a Product either by id or slug. If neither id nor slug is specified, an error will result."""
650
+ type Query {
651
+ product(id: ID, slug: String): Product
652
+ }`}
653
+ </GraphQLDoc>
654
+
655
+ ## productOption {#productoption}
656
+
657
+ <GraphQLDoc
658
+ type="query"
659
+ typeName="productOption"
660
+ typeLinks={{
661
+ ProductOption: '/reference/graphql-api/admin/object-types#productoption',
662
+ ID: '/reference/graphql-api/admin/object-types#id',
663
+ }}
664
+ >
665
+ {`type Query {
666
+ productOption(id: ID!): ProductOption
667
+ }`}
668
+ </GraphQLDoc>
669
+
670
+ ## productOptionGroup {#productoptiongroup}
671
+
672
+ <GraphQLDoc
673
+ type="query"
674
+ typeName="productOptionGroup"
675
+ typeLinks={{
676
+ ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
677
+ ID: '/reference/graphql-api/admin/object-types#id',
678
+ }}
679
+ >
680
+ {`type Query {
681
+ productOptionGroup(id: ID!): ProductOptionGroup
682
+ }`}
683
+ </GraphQLDoc>
684
+
685
+ ## productOptionGroups {#productoptiongroups}
686
+
687
+ <GraphQLDoc
688
+ type="query"
689
+ typeName="productOptionGroups"
690
+ typeLinks={{
691
+ ProductOptionGroup: '/reference/graphql-api/admin/object-types#productoptiongroup',
692
+ String: '/reference/graphql-api/admin/object-types#string',
693
+ }}
694
+ >
695
+ {`type Query {
696
+ productOptionGroups(filterTerm: String): [ProductOptionGroup!]!
697
+ }`}
698
+ </GraphQLDoc>
699
+
700
+ ## productOptions {#productoptions}
701
+
702
+ <GraphQLDoc
703
+ type="query"
704
+ typeName="productOptions"
705
+ typeLinks={{
706
+ ProductOptionList: '/reference/graphql-api/admin/object-types#productoptionlist',
707
+ ProductOptionListOptions: '/reference/graphql-api/admin/input-types#productoptionlistoptions',
708
+ ID: '/reference/graphql-api/admin/object-types#id',
709
+ }}
710
+ >
711
+ {`type Query {
712
+ productOptions(options: ProductOptionListOptions, groupId: ID): ProductOptionList!
713
+ }`}
714
+ </GraphQLDoc>
715
+
716
+ ## productVariant {#productvariant}
717
+
718
+ <GraphQLDoc
719
+ type="query"
720
+ typeName="productVariant"
721
+ typeLinks={{
722
+ ProductVariant: '/reference/graphql-api/admin/object-types#productvariant',
723
+ ID: '/reference/graphql-api/admin/object-types#id',
724
+ }}
725
+ >
726
+ {`"""Get a ProductVariant by id"""
727
+ type Query {
728
+ productVariant(id: ID!): ProductVariant
729
+ }`}
730
+ </GraphQLDoc>
731
+
732
+ ## productVariants {#productvariants}
733
+
734
+ <GraphQLDoc
735
+ type="query"
736
+ typeName="productVariants"
737
+ typeLinks={{
738
+ ProductVariantList: '/reference/graphql-api/admin/object-types#productvariantlist',
739
+ ProductVariantListOptions: '/reference/graphql-api/admin/input-types#productvariantlistoptions',
740
+ ID: '/reference/graphql-api/admin/object-types#id',
741
+ }}
742
+ >
743
+ {`"""List ProductVariants either all or for the specific product."""
744
+ type Query {
745
+ productVariants(options: ProductVariantListOptions, productId: ID): ProductVariantList!
746
+ }`}
747
+ </GraphQLDoc>
748
+
749
+ ## products {#products}
750
+
751
+ <GraphQLDoc
752
+ type="query"
753
+ typeName="products"
754
+ typeLinks={{
755
+ ProductList: '/reference/graphql-api/admin/object-types#productlist',
756
+ ProductListOptions: '/reference/graphql-api/admin/input-types#productlistoptions',
757
+ }}
758
+ >
759
+ {`"""List Products"""
760
+ type Query {
761
+ products(options: ProductListOptions): ProductList!
762
+ }`}
763
+ </GraphQLDoc>
764
+
765
+ ## promotion {#promotion}
766
+
767
+ <GraphQLDoc
768
+ type="query"
769
+ typeName="promotion"
770
+ typeLinks={{
771
+ Promotion: '/reference/graphql-api/admin/object-types#promotion',
772
+ ID: '/reference/graphql-api/admin/object-types#id',
773
+ }}
774
+ >
775
+ {`type Query {
776
+ promotion(id: ID!): Promotion
777
+ }`}
778
+ </GraphQLDoc>
779
+
780
+ ## promotionActions {#promotionactions}
781
+
782
+ <GraphQLDoc
783
+ type="query"
784
+ typeName="promotionActions"
785
+ typeLinks={{
786
+ ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
787
+ }}
788
+ >
789
+ {`type Query {
790
+ promotionActions: [ConfigurableOperationDefinition!]!
791
+ }`}
792
+ </GraphQLDoc>
793
+
794
+ ## promotionConditions {#promotionconditions}
795
+
796
+ <GraphQLDoc
797
+ type="query"
798
+ typeName="promotionConditions"
799
+ typeLinks={{
800
+ ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
801
+ }}
802
+ >
803
+ {`type Query {
804
+ promotionConditions: [ConfigurableOperationDefinition!]!
805
+ }`}
806
+ </GraphQLDoc>
807
+
808
+ ## promotions {#promotions}
809
+
810
+ <GraphQLDoc
811
+ type="query"
812
+ typeName="promotions"
813
+ typeLinks={{
814
+ PromotionList: '/reference/graphql-api/admin/object-types#promotionlist',
815
+ PromotionListOptions: '/reference/graphql-api/admin/input-types#promotionlistoptions',
816
+ }}
817
+ >
818
+ {`type Query {
819
+ promotions(options: PromotionListOptions): PromotionList!
820
+ }`}
821
+ </GraphQLDoc>
822
+
823
+ ## province {#province}
824
+
825
+ <GraphQLDoc
826
+ type="query"
827
+ typeName="province"
828
+ typeLinks={{
829
+ Province: '/reference/graphql-api/admin/object-types#province',
830
+ ID: '/reference/graphql-api/admin/object-types#id',
831
+ }}
832
+ >
833
+ {`type Query {
834
+ province(id: ID!): Province
835
+ }`}
836
+ </GraphQLDoc>
837
+
838
+ ## provinces {#provinces}
839
+
840
+ <GraphQLDoc
841
+ type="query"
842
+ typeName="provinces"
843
+ typeLinks={{
844
+ ProvinceList: '/reference/graphql-api/admin/object-types#provincelist',
845
+ ProvinceListOptions: '/reference/graphql-api/admin/input-types#provincelistoptions',
846
+ }}
847
+ >
848
+ {`type Query {
849
+ provinces(options: ProvinceListOptions): ProvinceList!
850
+ }`}
851
+ </GraphQLDoc>
852
+
853
+ ## role {#role}
854
+
855
+ <GraphQLDoc
856
+ type="query"
857
+ typeName="role"
858
+ typeLinks={{
859
+ Role: '/reference/graphql-api/admin/object-types#role',
860
+ ID: '/reference/graphql-api/admin/object-types#id',
861
+ }}
862
+ >
863
+ {`type Query {
864
+ role(id: ID!): Role
865
+ }`}
866
+ </GraphQLDoc>
867
+
868
+ ## roles {#roles}
869
+
870
+ <GraphQLDoc
871
+ type="query"
872
+ typeName="roles"
873
+ typeLinks={{
874
+ RoleList: '/reference/graphql-api/admin/object-types#rolelist',
875
+ RoleListOptions: '/reference/graphql-api/admin/input-types#rolelistoptions',
876
+ }}
877
+ >
878
+ {`type Query {
879
+ roles(options: RoleListOptions): RoleList!
880
+ }`}
881
+ </GraphQLDoc>
882
+
883
+ ## scheduledTasks {#scheduledtasks}
884
+
885
+ <GraphQLDoc
886
+ type="query"
887
+ typeName="scheduledTasks"
888
+ typeLinks={{
889
+ ScheduledTask: '/reference/graphql-api/admin/object-types#scheduledtask',
890
+ }}
891
+ >
892
+ {`type Query {
893
+ scheduledTasks: [ScheduledTask!]!
894
+ }`}
895
+ </GraphQLDoc>
896
+
897
+ ## search {#search}
898
+
899
+ <GraphQLDoc
900
+ type="query"
901
+ typeName="search"
902
+ typeLinks={{
903
+ SearchResponse: '/reference/graphql-api/admin/object-types#searchresponse',
904
+ SearchInput: '/reference/graphql-api/admin/input-types#searchinput',
905
+ }}
906
+ >
907
+ {`type Query {
908
+ search(input: SearchInput!): SearchResponse!
909
+ }`}
910
+ </GraphQLDoc>
911
+
912
+ ## seller {#seller}
913
+
914
+ <GraphQLDoc
915
+ type="query"
916
+ typeName="seller"
917
+ typeLinks={{
918
+ Seller: '/reference/graphql-api/admin/object-types#seller',
919
+ ID: '/reference/graphql-api/admin/object-types#id',
920
+ }}
921
+ >
922
+ {`type Query {
923
+ seller(id: ID!): Seller
924
+ }`}
925
+ </GraphQLDoc>
926
+
927
+ ## sellers {#sellers}
928
+
929
+ <GraphQLDoc
930
+ type="query"
931
+ typeName="sellers"
932
+ typeLinks={{
933
+ SellerList: '/reference/graphql-api/admin/object-types#sellerlist',
934
+ SellerListOptions: '/reference/graphql-api/admin/input-types#sellerlistoptions',
935
+ }}
936
+ >
937
+ {`type Query {
938
+ sellers(options: SellerListOptions): SellerList!
939
+ }`}
940
+ </GraphQLDoc>
941
+
942
+ ## shippingCalculators {#shippingcalculators}
943
+
944
+ <GraphQLDoc
945
+ type="query"
946
+ typeName="shippingCalculators"
947
+ typeLinks={{
948
+ ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
949
+ }}
950
+ >
951
+ {`type Query {
952
+ shippingCalculators: [ConfigurableOperationDefinition!]!
953
+ }`}
954
+ </GraphQLDoc>
955
+
956
+ ## shippingEligibilityCheckers {#shippingeligibilitycheckers}
957
+
958
+ <GraphQLDoc
959
+ type="query"
960
+ typeName="shippingEligibilityCheckers"
961
+ typeLinks={{
962
+ ConfigurableOperationDefinition: '/reference/graphql-api/admin/object-types#configurableoperationdefinition',
963
+ }}
964
+ >
965
+ {`type Query {
966
+ shippingEligibilityCheckers: [ConfigurableOperationDefinition!]!
967
+ }`}
968
+ </GraphQLDoc>
969
+
970
+ ## shippingMethod {#shippingmethod}
971
+
972
+ <GraphQLDoc
973
+ type="query"
974
+ typeName="shippingMethod"
975
+ typeLinks={{
976
+ ShippingMethod: '/reference/graphql-api/admin/object-types#shippingmethod',
977
+ ID: '/reference/graphql-api/admin/object-types#id',
978
+ }}
979
+ >
980
+ {`type Query {
981
+ shippingMethod(id: ID!): ShippingMethod
982
+ }`}
983
+ </GraphQLDoc>
984
+
985
+ ## shippingMethods {#shippingmethods}
986
+
987
+ <GraphQLDoc
988
+ type="query"
989
+ typeName="shippingMethods"
990
+ typeLinks={{
991
+ ShippingMethodList: '/reference/graphql-api/admin/object-types#shippingmethodlist',
992
+ ShippingMethodListOptions: '/reference/graphql-api/admin/input-types#shippingmethodlistoptions',
993
+ }}
994
+ >
995
+ {`type Query {
996
+ shippingMethods(options: ShippingMethodListOptions): ShippingMethodList!
997
+ }`}
998
+ </GraphQLDoc>
999
+
1000
+ ## slugForEntity {#slugforentity}
1001
+
1002
+ <GraphQLDoc
1003
+ type="query"
1004
+ typeName="slugForEntity"
1005
+ typeLinks={{
1006
+ String: '/reference/graphql-api/admin/object-types#string',
1007
+ SlugForEntityInput: '/reference/graphql-api/admin/input-types#slugforentityinput',
1008
+ }}
1009
+ >
1010
+ {`"""Generate slug for entity"""
1011
+ type Query {
1012
+ slugForEntity(input: SlugForEntityInput!): String!
1013
+ }`}
1014
+ </GraphQLDoc>
1015
+
1016
+ ## stockLocation {#stocklocation}
1017
+
1018
+ <GraphQLDoc
1019
+ type="query"
1020
+ typeName="stockLocation"
1021
+ typeLinks={{
1022
+ StockLocation: '/reference/graphql-api/admin/object-types#stocklocation',
1023
+ ID: '/reference/graphql-api/admin/object-types#id',
1024
+ }}
1025
+ >
1026
+ {`type Query {
1027
+ stockLocation(id: ID!): StockLocation
1028
+ }`}
1029
+ </GraphQLDoc>
1030
+
1031
+ ## stockLocations {#stocklocations}
1032
+
1033
+ <GraphQLDoc
1034
+ type="query"
1035
+ typeName="stockLocations"
1036
+ typeLinks={{
1037
+ StockLocationList: '/reference/graphql-api/admin/object-types#stocklocationlist',
1038
+ StockLocationListOptions: '/reference/graphql-api/admin/input-types#stocklocationlistoptions',
1039
+ }}
1040
+ >
1041
+ {`type Query {
1042
+ stockLocations(options: StockLocationListOptions): StockLocationList!
1043
+ }`}
1044
+ </GraphQLDoc>
1045
+
1046
+ ## tag {#tag}
1047
+
1048
+ <GraphQLDoc
1049
+ type="query"
1050
+ typeName="tag"
1051
+ typeLinks={{
1052
+ Tag: '/reference/graphql-api/admin/object-types#tag',
1053
+ ID: '/reference/graphql-api/admin/object-types#id',
1054
+ }}
1055
+ >
1056
+ {`type Query {
1057
+ tag(id: ID!): Tag!
1058
+ }`}
1059
+ </GraphQLDoc>
1060
+
1061
+ ## tags {#tags}
1062
+
1063
+ <GraphQLDoc
1064
+ type="query"
1065
+ typeName="tags"
1066
+ typeLinks={{
1067
+ TagList: '/reference/graphql-api/admin/object-types#taglist',
1068
+ TagListOptions: '/reference/graphql-api/admin/input-types#taglistoptions',
1069
+ }}
1070
+ >
1071
+ {`type Query {
1072
+ tags(options: TagListOptions): TagList!
1073
+ }`}
1074
+ </GraphQLDoc>
1075
+
1076
+ ## taxCategories {#taxcategories}
1077
+
1078
+ <GraphQLDoc
1079
+ type="query"
1080
+ typeName="taxCategories"
1081
+ typeLinks={{
1082
+ TaxCategoryList: '/reference/graphql-api/admin/object-types#taxcategorylist',
1083
+ TaxCategoryListOptions: '/reference/graphql-api/admin/input-types#taxcategorylistoptions',
1084
+ }}
1085
+ >
1086
+ {`type Query {
1087
+ taxCategories(options: TaxCategoryListOptions): TaxCategoryList!
1088
+ }`}
1089
+ </GraphQLDoc>
1090
+
1091
+ ## taxCategory {#taxcategory}
1092
+
1093
+ <GraphQLDoc
1094
+ type="query"
1095
+ typeName="taxCategory"
1096
+ typeLinks={{
1097
+ TaxCategory: '/reference/graphql-api/admin/object-types#taxcategory',
1098
+ ID: '/reference/graphql-api/admin/object-types#id',
1099
+ }}
1100
+ >
1101
+ {`type Query {
1102
+ taxCategory(id: ID!): TaxCategory
1103
+ }`}
1104
+ </GraphQLDoc>
1105
+
1106
+ ## taxRate {#taxrate}
1107
+
1108
+ <GraphQLDoc
1109
+ type="query"
1110
+ typeName="taxRate"
1111
+ typeLinks={{
1112
+ TaxRate: '/reference/graphql-api/admin/object-types#taxrate',
1113
+ ID: '/reference/graphql-api/admin/object-types#id',
1114
+ }}
1115
+ >
1116
+ {`type Query {
1117
+ taxRate(id: ID!): TaxRate
1118
+ }`}
1119
+ </GraphQLDoc>
1120
+
1121
+ ## taxRates {#taxrates}
1122
+
1123
+ <GraphQLDoc
1124
+ type="query"
1125
+ typeName="taxRates"
1126
+ typeLinks={{
1127
+ TaxRateList: '/reference/graphql-api/admin/object-types#taxratelist',
1128
+ TaxRateListOptions: '/reference/graphql-api/admin/input-types#taxratelistoptions',
1129
+ }}
1130
+ >
1131
+ {`type Query {
1132
+ taxRates(options: TaxRateListOptions): TaxRateList!
1133
+ }`}
1134
+ </GraphQLDoc>
1135
+
1136
+ ## testEligibleShippingMethods {#testeligibleshippingmethods}
1137
+
1138
+ <GraphQLDoc
1139
+ type="query"
1140
+ typeName="testEligibleShippingMethods"
1141
+ typeLinks={{
1142
+ ShippingMethodQuote: '/reference/graphql-api/admin/object-types#shippingmethodquote',
1143
+ TestEligibleShippingMethodsInput: '/reference/graphql-api/admin/input-types#testeligibleshippingmethodsinput',
1144
+ }}
1145
+ >
1146
+ {`type Query {
1147
+ testEligibleShippingMethods(input: TestEligibleShippingMethodsInput!): [ShippingMethodQuote!]!
1148
+ }`}
1149
+ </GraphQLDoc>
1150
+
1151
+ ## testShippingMethod {#testshippingmethod}
1152
+
1153
+ <GraphQLDoc
1154
+ type="query"
1155
+ typeName="testShippingMethod"
1156
+ typeLinks={{
1157
+ TestShippingMethodResult: '/reference/graphql-api/admin/object-types#testshippingmethodresult',
1158
+ TestShippingMethodInput: '/reference/graphql-api/admin/input-types#testshippingmethodinput',
1159
+ }}
1160
+ >
1161
+ {`type Query {
1162
+ testShippingMethod(input: TestShippingMethodInput!): TestShippingMethodResult!
1163
+ }`}
1164
+ </GraphQLDoc>
1165
+
1166
+ ## zone {#zone}
1167
+
1168
+ <GraphQLDoc
1169
+ type="query"
1170
+ typeName="zone"
1171
+ typeLinks={{
1172
+ Zone: '/reference/graphql-api/admin/object-types#zone',
1173
+ ID: '/reference/graphql-api/admin/object-types#id',
1174
+ }}
1175
+ >
1176
+ {`type Query {
1177
+ zone(id: ID!): Zone
1178
+ }`}
1179
+ </GraphQLDoc>
1180
+
1181
+ ## zones {#zones}
1182
+
1183
+ <GraphQLDoc
1184
+ type="query"
1185
+ typeName="zones"
1186
+ typeLinks={{
1187
+ ZoneList: '/reference/graphql-api/admin/object-types#zonelist',
1188
+ ZoneListOptions: '/reference/graphql-api/admin/input-types#zonelistoptions',
1189
+ }}
1190
+ >
1191
+ {`type Query {
1192
+ zones(options: ZoneListOptions): ZoneList!
1193
+ }`}
1194
+ </GraphQLDoc>