@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,1141 +2,1138 @@
2
2
  title: "Enums"
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
- ## AdjustmentType
10
-
11
- <div class="graphql-code-block">
12
-
13
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">AdjustmentType</span> &#123;</div>
14
- <div class="graphql-code-line ">PROMOTION</div>
15
- <div class="graphql-code-line ">DISTRIBUTED_ORDER_PROMOTION</div>
16
- <div class="graphql-code-line ">OTHER</div>
17
- <div class="graphql-code-line top-level">&#125;</div>
18
- </div>
19
-
20
- ## AssetType
21
-
22
- <div class="graphql-code-block">
23
-
24
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">AssetType</span> &#123;</div>
25
- <div class="graphql-code-line ">IMAGE</div>
26
- <div class="graphql-code-line ">VIDEO</div>
27
- <div class="graphql-code-line ">BINARY</div>
28
- <div class="graphql-code-line top-level">&#125;</div>
29
- </div>
30
-
31
- ## CurrencyCode
32
-
33
- <div class="graphql-code-block">
34
- <div class="graphql-code-line comment">"""</div>
35
- <div class="graphql-code-line comment">ISO 4217 currency code</div>
36
-
37
- <div class="graphql-code-line comment"></div>
38
-
39
- <div class="graphql-code-line comment"></div>
40
- <div class="graphql-code-line comment">"""</div>
41
-
42
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">CurrencyCode</span> &#123;</div>
43
- <div class="graphql-code-line comment">"""United Arab Emirates dirham"""</div>
44
- <div class="graphql-code-line ">AED</div>
45
- <div class="graphql-code-line comment">"""Afghan afghani"""</div>
46
- <div class="graphql-code-line ">AFN</div>
47
- <div class="graphql-code-line comment">"""Albanian lek"""</div>
48
- <div class="graphql-code-line ">ALL</div>
49
- <div class="graphql-code-line comment">"""Armenian dram"""</div>
50
- <div class="graphql-code-line ">AMD</div>
51
- <div class="graphql-code-line comment">"""Netherlands Antillean guilder"""</div>
52
- <div class="graphql-code-line ">ANG</div>
53
- <div class="graphql-code-line comment">"""Angolan kwanza"""</div>
54
- <div class="graphql-code-line ">AOA</div>
55
- <div class="graphql-code-line comment">"""Argentine peso"""</div>
56
- <div class="graphql-code-line ">ARS</div>
57
- <div class="graphql-code-line comment">"""Australian dollar"""</div>
58
- <div class="graphql-code-line ">AUD</div>
59
- <div class="graphql-code-line comment">"""Aruban florin"""</div>
60
- <div class="graphql-code-line ">AWG</div>
61
- <div class="graphql-code-line comment">"""Azerbaijani manat"""</div>
62
- <div class="graphql-code-line ">AZN</div>
63
- <div class="graphql-code-line comment">"""Bosnia and Herzegovina convertible mark"""</div>
64
- <div class="graphql-code-line ">BAM</div>
65
- <div class="graphql-code-line comment">"""Barbados dollar"""</div>
66
- <div class="graphql-code-line ">BBD</div>
67
- <div class="graphql-code-line comment">"""Bangladeshi taka"""</div>
68
- <div class="graphql-code-line ">BDT</div>
69
- <div class="graphql-code-line comment">"""Bulgarian lev"""</div>
70
- <div class="graphql-code-line ">BGN</div>
71
- <div class="graphql-code-line comment">"""Bahraini dinar"""</div>
72
- <div class="graphql-code-line ">BHD</div>
73
- <div class="graphql-code-line comment">"""Burundian franc"""</div>
74
- <div class="graphql-code-line ">BIF</div>
75
- <div class="graphql-code-line comment">"""Bermudian dollar"""</div>
76
- <div class="graphql-code-line ">BMD</div>
77
- <div class="graphql-code-line comment">"""Brunei dollar"""</div>
78
- <div class="graphql-code-line ">BND</div>
79
- <div class="graphql-code-line comment">"""Boliviano"""</div>
80
- <div class="graphql-code-line ">BOB</div>
81
- <div class="graphql-code-line comment">"""Brazilian real"""</div>
82
- <div class="graphql-code-line ">BRL</div>
83
- <div class="graphql-code-line comment">"""Bahamian dollar"""</div>
84
- <div class="graphql-code-line ">BSD</div>
85
- <div class="graphql-code-line comment">"""Bhutanese ngultrum"""</div>
86
- <div class="graphql-code-line ">BTN</div>
87
- <div class="graphql-code-line comment">"""Botswana pula"""</div>
88
- <div class="graphql-code-line ">BWP</div>
89
- <div class="graphql-code-line comment">"""Belarusian ruble"""</div>
90
- <div class="graphql-code-line ">BYN</div>
91
- <div class="graphql-code-line comment">"""Belize dollar"""</div>
92
- <div class="graphql-code-line ">BZD</div>
93
- <div class="graphql-code-line comment">"""Canadian dollar"""</div>
94
- <div class="graphql-code-line ">CAD</div>
95
- <div class="graphql-code-line comment">"""Congolese franc"""</div>
96
- <div class="graphql-code-line ">CDF</div>
97
- <div class="graphql-code-line comment">"""Swiss franc"""</div>
98
- <div class="graphql-code-line ">CHF</div>
99
- <div class="graphql-code-line comment">"""Chilean peso"""</div>
100
- <div class="graphql-code-line ">CLP</div>
101
- <div class="graphql-code-line comment">"""Renminbi (Chinese) yuan"""</div>
102
- <div class="graphql-code-line ">CNY</div>
103
- <div class="graphql-code-line comment">"""Colombian peso"""</div>
104
- <div class="graphql-code-line ">COP</div>
105
- <div class="graphql-code-line comment">"""Costa Rican colon"""</div>
106
- <div class="graphql-code-line ">CRC</div>
107
- <div class="graphql-code-line comment">"""Cuban convertible peso"""</div>
108
- <div class="graphql-code-line ">CUC</div>
109
- <div class="graphql-code-line comment">"""Cuban peso"""</div>
110
- <div class="graphql-code-line ">CUP</div>
111
- <div class="graphql-code-line comment">"""Cape Verde escudo"""</div>
112
- <div class="graphql-code-line ">CVE</div>
113
- <div class="graphql-code-line comment">"""Czech koruna"""</div>
114
- <div class="graphql-code-line ">CZK</div>
115
- <div class="graphql-code-line comment">"""Djiboutian franc"""</div>
116
- <div class="graphql-code-line ">DJF</div>
117
- <div class="graphql-code-line comment">"""Danish krone"""</div>
118
- <div class="graphql-code-line ">DKK</div>
119
- <div class="graphql-code-line comment">"""Dominican peso"""</div>
120
- <div class="graphql-code-line ">DOP</div>
121
- <div class="graphql-code-line comment">"""Algerian dinar"""</div>
122
- <div class="graphql-code-line ">DZD</div>
123
- <div class="graphql-code-line comment">"""Egyptian pound"""</div>
124
- <div class="graphql-code-line ">EGP</div>
125
- <div class="graphql-code-line comment">"""Eritrean nakfa"""</div>
126
- <div class="graphql-code-line ">ERN</div>
127
- <div class="graphql-code-line comment">"""Ethiopian birr"""</div>
128
- <div class="graphql-code-line ">ETB</div>
129
- <div class="graphql-code-line comment">"""Euro"""</div>
130
- <div class="graphql-code-line ">EUR</div>
131
- <div class="graphql-code-line comment">"""Fiji dollar"""</div>
132
- <div class="graphql-code-line ">FJD</div>
133
- <div class="graphql-code-line comment">"""Falkland Islands pound"""</div>
134
- <div class="graphql-code-line ">FKP</div>
135
- <div class="graphql-code-line comment">"""Pound sterling"""</div>
136
- <div class="graphql-code-line ">GBP</div>
137
- <div class="graphql-code-line comment">"""Georgian lari"""</div>
138
- <div class="graphql-code-line ">GEL</div>
139
- <div class="graphql-code-line comment">"""Ghanaian cedi"""</div>
140
- <div class="graphql-code-line ">GHS</div>
141
- <div class="graphql-code-line comment">"""Gibraltar pound"""</div>
142
- <div class="graphql-code-line ">GIP</div>
143
- <div class="graphql-code-line comment">"""Gambian dalasi"""</div>
144
- <div class="graphql-code-line ">GMD</div>
145
- <div class="graphql-code-line comment">"""Guinean franc"""</div>
146
- <div class="graphql-code-line ">GNF</div>
147
- <div class="graphql-code-line comment">"""Guatemalan quetzal"""</div>
148
- <div class="graphql-code-line ">GTQ</div>
149
- <div class="graphql-code-line comment">"""Guyanese dollar"""</div>
150
- <div class="graphql-code-line ">GYD</div>
151
- <div class="graphql-code-line comment">"""Hong Kong dollar"""</div>
152
- <div class="graphql-code-line ">HKD</div>
153
- <div class="graphql-code-line comment">"""Honduran lempira"""</div>
154
- <div class="graphql-code-line ">HNL</div>
155
- <div class="graphql-code-line comment">"""Croatian kuna"""</div>
156
- <div class="graphql-code-line ">HRK</div>
157
- <div class="graphql-code-line comment">"""Haitian gourde"""</div>
158
- <div class="graphql-code-line ">HTG</div>
159
- <div class="graphql-code-line comment">"""Hungarian forint"""</div>
160
- <div class="graphql-code-line ">HUF</div>
161
- <div class="graphql-code-line comment">"""Indonesian rupiah"""</div>
162
- <div class="graphql-code-line ">IDR</div>
163
- <div class="graphql-code-line comment">"""Israeli new shekel"""</div>
164
- <div class="graphql-code-line ">ILS</div>
165
- <div class="graphql-code-line comment">"""Indian rupee"""</div>
166
- <div class="graphql-code-line ">INR</div>
167
- <div class="graphql-code-line comment">"""Iraqi dinar"""</div>
168
- <div class="graphql-code-line ">IQD</div>
169
- <div class="graphql-code-line comment">"""Iranian rial"""</div>
170
- <div class="graphql-code-line ">IRR</div>
171
- <div class="graphql-code-line comment">"""Icelandic króna"""</div>
172
- <div class="graphql-code-line ">ISK</div>
173
- <div class="graphql-code-line comment">"""Jamaican dollar"""</div>
174
- <div class="graphql-code-line ">JMD</div>
175
- <div class="graphql-code-line comment">"""Jordanian dinar"""</div>
176
- <div class="graphql-code-line ">JOD</div>
177
- <div class="graphql-code-line comment">"""Japanese yen"""</div>
178
- <div class="graphql-code-line ">JPY</div>
179
- <div class="graphql-code-line comment">"""Kenyan shilling"""</div>
180
- <div class="graphql-code-line ">KES</div>
181
- <div class="graphql-code-line comment">"""Kyrgyzstani som"""</div>
182
- <div class="graphql-code-line ">KGS</div>
183
- <div class="graphql-code-line comment">"""Cambodian riel"""</div>
184
- <div class="graphql-code-line ">KHR</div>
185
- <div class="graphql-code-line comment">"""Comoro franc"""</div>
186
- <div class="graphql-code-line ">KMF</div>
187
- <div class="graphql-code-line comment">"""North Korean won"""</div>
188
- <div class="graphql-code-line ">KPW</div>
189
- <div class="graphql-code-line comment">"""South Korean won"""</div>
190
- <div class="graphql-code-line ">KRW</div>
191
- <div class="graphql-code-line comment">"""Kuwaiti dinar"""</div>
192
- <div class="graphql-code-line ">KWD</div>
193
- <div class="graphql-code-line comment">"""Cayman Islands dollar"""</div>
194
- <div class="graphql-code-line ">KYD</div>
195
- <div class="graphql-code-line comment">"""Kazakhstani tenge"""</div>
196
- <div class="graphql-code-line ">KZT</div>
197
- <div class="graphql-code-line comment">"""Lao kip"""</div>
198
- <div class="graphql-code-line ">LAK</div>
199
- <div class="graphql-code-line comment">"""Lebanese pound"""</div>
200
- <div class="graphql-code-line ">LBP</div>
201
- <div class="graphql-code-line comment">"""Sri Lankan rupee"""</div>
202
- <div class="graphql-code-line ">LKR</div>
203
- <div class="graphql-code-line comment">"""Liberian dollar"""</div>
204
- <div class="graphql-code-line ">LRD</div>
205
- <div class="graphql-code-line comment">"""Lesotho loti"""</div>
206
- <div class="graphql-code-line ">LSL</div>
207
- <div class="graphql-code-line comment">"""Libyan dinar"""</div>
208
- <div class="graphql-code-line ">LYD</div>
209
- <div class="graphql-code-line comment">"""Moroccan dirham"""</div>
210
- <div class="graphql-code-line ">MAD</div>
211
- <div class="graphql-code-line comment">"""Moldovan leu"""</div>
212
- <div class="graphql-code-line ">MDL</div>
213
- <div class="graphql-code-line comment">"""Malagasy ariary"""</div>
214
- <div class="graphql-code-line ">MGA</div>
215
- <div class="graphql-code-line comment">"""Macedonian denar"""</div>
216
- <div class="graphql-code-line ">MKD</div>
217
- <div class="graphql-code-line comment">"""Myanmar kyat"""</div>
218
- <div class="graphql-code-line ">MMK</div>
219
- <div class="graphql-code-line comment">"""Mongolian tögrög"""</div>
220
- <div class="graphql-code-line ">MNT</div>
221
- <div class="graphql-code-line comment">"""Macanese pataca"""</div>
222
- <div class="graphql-code-line ">MOP</div>
223
- <div class="graphql-code-line comment">"""Mauritanian ouguiya"""</div>
224
- <div class="graphql-code-line ">MRU</div>
225
- <div class="graphql-code-line comment">"""Mauritian rupee"""</div>
226
- <div class="graphql-code-line ">MUR</div>
227
- <div class="graphql-code-line comment">"""Maldivian rufiyaa"""</div>
228
- <div class="graphql-code-line ">MVR</div>
229
- <div class="graphql-code-line comment">"""Malawian kwacha"""</div>
230
- <div class="graphql-code-line ">MWK</div>
231
- <div class="graphql-code-line comment">"""Mexican peso"""</div>
232
- <div class="graphql-code-line ">MXN</div>
233
- <div class="graphql-code-line comment">"""Malaysian ringgit"""</div>
234
- <div class="graphql-code-line ">MYR</div>
235
- <div class="graphql-code-line comment">"""Mozambican metical"""</div>
236
- <div class="graphql-code-line ">MZN</div>
237
- <div class="graphql-code-line comment">"""Namibian dollar"""</div>
238
- <div class="graphql-code-line ">NAD</div>
239
- <div class="graphql-code-line comment">"""Nigerian naira"""</div>
240
- <div class="graphql-code-line ">NGN</div>
241
- <div class="graphql-code-line comment">"""Nicaraguan córdoba"""</div>
242
- <div class="graphql-code-line ">NIO</div>
243
- <div class="graphql-code-line comment">"""Norwegian krone"""</div>
244
- <div class="graphql-code-line ">NOK</div>
245
- <div class="graphql-code-line comment">"""Nepalese rupee"""</div>
246
- <div class="graphql-code-line ">NPR</div>
247
- <div class="graphql-code-line comment">"""New Zealand dollar"""</div>
248
- <div class="graphql-code-line ">NZD</div>
249
- <div class="graphql-code-line comment">"""Omani rial"""</div>
250
- <div class="graphql-code-line ">OMR</div>
251
- <div class="graphql-code-line comment">"""Panamanian balboa"""</div>
252
- <div class="graphql-code-line ">PAB</div>
253
- <div class="graphql-code-line comment">"""Peruvian sol"""</div>
254
- <div class="graphql-code-line ">PEN</div>
255
- <div class="graphql-code-line comment">"""Papua New Guinean kina"""</div>
256
- <div class="graphql-code-line ">PGK</div>
257
- <div class="graphql-code-line comment">"""Philippine peso"""</div>
258
- <div class="graphql-code-line ">PHP</div>
259
- <div class="graphql-code-line comment">"""Pakistani rupee"""</div>
260
- <div class="graphql-code-line ">PKR</div>
261
- <div class="graphql-code-line comment">"""Polish złoty"""</div>
262
- <div class="graphql-code-line ">PLN</div>
263
- <div class="graphql-code-line comment">"""Paraguayan guaraní"""</div>
264
- <div class="graphql-code-line ">PYG</div>
265
- <div class="graphql-code-line comment">"""Qatari riyal"""</div>
266
- <div class="graphql-code-line ">QAR</div>
267
- <div class="graphql-code-line comment">"""Romanian leu"""</div>
268
- <div class="graphql-code-line ">RON</div>
269
- <div class="graphql-code-line comment">"""Serbian dinar"""</div>
270
- <div class="graphql-code-line ">RSD</div>
271
- <div class="graphql-code-line comment">"""Russian ruble"""</div>
272
- <div class="graphql-code-line ">RUB</div>
273
- <div class="graphql-code-line comment">"""Rwandan franc"""</div>
274
- <div class="graphql-code-line ">RWF</div>
275
- <div class="graphql-code-line comment">"""Saudi riyal"""</div>
276
- <div class="graphql-code-line ">SAR</div>
277
- <div class="graphql-code-line comment">"""Solomon Islands dollar"""</div>
278
- <div class="graphql-code-line ">SBD</div>
279
- <div class="graphql-code-line comment">"""Seychelles rupee"""</div>
280
- <div class="graphql-code-line ">SCR</div>
281
- <div class="graphql-code-line comment">"""Sudanese pound"""</div>
282
- <div class="graphql-code-line ">SDG</div>
283
- <div class="graphql-code-line comment">"""Swedish krona/kronor"""</div>
284
- <div class="graphql-code-line ">SEK</div>
285
- <div class="graphql-code-line comment">"""Singapore dollar"""</div>
286
- <div class="graphql-code-line ">SGD</div>
287
- <div class="graphql-code-line comment">"""Saint Helena pound"""</div>
288
- <div class="graphql-code-line ">SHP</div>
289
- <div class="graphql-code-line comment">"""Sierra Leonean leone"""</div>
290
- <div class="graphql-code-line ">SLL</div>
291
- <div class="graphql-code-line comment">"""Somali shilling"""</div>
292
- <div class="graphql-code-line ">SOS</div>
293
- <div class="graphql-code-line comment">"""Surinamese dollar"""</div>
294
- <div class="graphql-code-line ">SRD</div>
295
- <div class="graphql-code-line comment">"""South Sudanese pound"""</div>
296
- <div class="graphql-code-line ">SSP</div>
297
- <div class="graphql-code-line comment">"""São Tomé and Príncipe dobra"""</div>
298
- <div class="graphql-code-line ">STN</div>
299
- <div class="graphql-code-line comment">"""Salvadoran colón"""</div>
300
- <div class="graphql-code-line ">SVC</div>
301
- <div class="graphql-code-line comment">"""Syrian pound"""</div>
302
- <div class="graphql-code-line ">SYP</div>
303
- <div class="graphql-code-line comment">"""Swazi lilangeni"""</div>
304
- <div class="graphql-code-line ">SZL</div>
305
- <div class="graphql-code-line comment">"""Thai baht"""</div>
306
- <div class="graphql-code-line ">THB</div>
307
- <div class="graphql-code-line comment">"""Tajikistani somoni"""</div>
308
- <div class="graphql-code-line ">TJS</div>
309
- <div class="graphql-code-line comment">"""Turkmenistan manat"""</div>
310
- <div class="graphql-code-line ">TMT</div>
311
- <div class="graphql-code-line comment">"""Tunisian dinar"""</div>
312
- <div class="graphql-code-line ">TND</div>
313
- <div class="graphql-code-line comment">"""Tongan paʻanga"""</div>
314
- <div class="graphql-code-line ">TOP</div>
315
- <div class="graphql-code-line comment">"""Turkish lira"""</div>
316
- <div class="graphql-code-line ">TRY</div>
317
- <div class="graphql-code-line comment">"""Trinidad and Tobago dollar"""</div>
318
- <div class="graphql-code-line ">TTD</div>
319
- <div class="graphql-code-line comment">"""New Taiwan dollar"""</div>
320
- <div class="graphql-code-line ">TWD</div>
321
- <div class="graphql-code-line comment">"""Tanzanian shilling"""</div>
322
- <div class="graphql-code-line ">TZS</div>
323
- <div class="graphql-code-line comment">"""Ukrainian hryvnia"""</div>
324
- <div class="graphql-code-line ">UAH</div>
325
- <div class="graphql-code-line comment">"""Ugandan shilling"""</div>
326
- <div class="graphql-code-line ">UGX</div>
327
- <div class="graphql-code-line comment">"""United States dollar"""</div>
328
- <div class="graphql-code-line ">USD</div>
329
- <div class="graphql-code-line comment">"""Uruguayan peso"""</div>
330
- <div class="graphql-code-line ">UYU</div>
331
- <div class="graphql-code-line comment">"""Uzbekistan som"""</div>
332
- <div class="graphql-code-line ">UZS</div>
333
- <div class="graphql-code-line comment">"""Venezuelan bolívar soberano"""</div>
334
- <div class="graphql-code-line ">VES</div>
335
- <div class="graphql-code-line comment">"""Vietnamese đồng"""</div>
336
- <div class="graphql-code-line ">VND</div>
337
- <div class="graphql-code-line comment">"""Vanuatu vatu"""</div>
338
- <div class="graphql-code-line ">VUV</div>
339
- <div class="graphql-code-line comment">"""Samoan tala"""</div>
340
- <div class="graphql-code-line ">WST</div>
341
- <div class="graphql-code-line comment">"""CFA franc BEAC"""</div>
342
- <div class="graphql-code-line ">XAF</div>
343
- <div class="graphql-code-line comment">"""East Caribbean dollar"""</div>
344
- <div class="graphql-code-line ">XCD</div>
345
- <div class="graphql-code-line comment">"""CFA franc BCEAO"""</div>
346
- <div class="graphql-code-line ">XOF</div>
347
- <div class="graphql-code-line comment">"""CFP franc (franc Pacifique)"""</div>
348
- <div class="graphql-code-line ">XPF</div>
349
- <div class="graphql-code-line comment">"""Yemeni rial"""</div>
350
- <div class="graphql-code-line ">YER</div>
351
- <div class="graphql-code-line comment">"""South African rand"""</div>
352
- <div class="graphql-code-line ">ZAR</div>
353
- <div class="graphql-code-line comment">"""Zambian kwacha"""</div>
354
- <div class="graphql-code-line ">ZMW</div>
355
- <div class="graphql-code-line comment">"""Zimbabwean dollar"""</div>
356
- <div class="graphql-code-line ">ZWL</div>
357
- <div class="graphql-code-line top-level">&#125;</div>
358
- </div>
359
-
360
- ## DeletionResult
361
-
362
- <div class="graphql-code-block">
363
-
364
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">DeletionResult</span> &#123;</div>
365
- <div class="graphql-code-line comment">"""The entity was successfully deleted"""</div>
366
- <div class="graphql-code-line ">DELETED</div>
367
- <div class="graphql-code-line comment">"""Deletion did not take place, reason given in message"""</div>
368
- <div class="graphql-code-line ">NOT_DELETED</div>
369
- <div class="graphql-code-line top-level">&#125;</div>
370
- </div>
371
-
372
- ## ErrorCode
373
-
374
- <div class="graphql-code-block">
375
-
376
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">ErrorCode</span> &#123;</div>
377
- <div class="graphql-code-line ">UNKNOWN_ERROR</div>
378
- <div class="graphql-code-line ">MIME_TYPE_ERROR</div>
379
- <div class="graphql-code-line ">LANGUAGE_NOT_AVAILABLE_ERROR</div>
380
- <div class="graphql-code-line ">DUPLICATE_ENTITY_ERROR</div>
381
- <div class="graphql-code-line ">FACET_IN_USE_ERROR</div>
382
- <div class="graphql-code-line ">CHANNEL_DEFAULT_LANGUAGE_ERROR</div>
383
- <div class="graphql-code-line ">SETTLE_PAYMENT_ERROR</div>
384
- <div class="graphql-code-line ">CANCEL_PAYMENT_ERROR</div>
385
- <div class="graphql-code-line ">EMPTY_ORDER_LINE_SELECTION_ERROR</div>
386
- <div class="graphql-code-line ">ITEMS_ALREADY_FULFILLED_ERROR</div>
387
- <div class="graphql-code-line ">INVALID_FULFILLMENT_HANDLER_ERROR</div>
388
- <div class="graphql-code-line ">CREATE_FULFILLMENT_ERROR</div>
389
- <div class="graphql-code-line ">INSUFFICIENT_STOCK_ON_HAND_ERROR</div>
390
- <div class="graphql-code-line ">MULTIPLE_ORDER_ERROR</div>
391
- <div class="graphql-code-line ">CANCEL_ACTIVE_ORDER_ERROR</div>
392
- <div class="graphql-code-line ">PAYMENT_ORDER_MISMATCH_ERROR</div>
393
- <div class="graphql-code-line ">REFUND_ORDER_STATE_ERROR</div>
394
- <div class="graphql-code-line ">NOTHING_TO_REFUND_ERROR</div>
395
- <div class="graphql-code-line ">ALREADY_REFUNDED_ERROR</div>
396
- <div class="graphql-code-line ">QUANTITY_TOO_GREAT_ERROR</div>
397
- <div class="graphql-code-line ">REFUND_AMOUNT_ERROR</div>
398
- <div class="graphql-code-line ">REFUND_STATE_TRANSITION_ERROR</div>
399
- <div class="graphql-code-line ">PAYMENT_STATE_TRANSITION_ERROR</div>
400
- <div class="graphql-code-line ">FULFILLMENT_STATE_TRANSITION_ERROR</div>
401
- <div class="graphql-code-line ">ORDER_MODIFICATION_STATE_ERROR</div>
402
- <div class="graphql-code-line ">NO_CHANGES_SPECIFIED_ERROR</div>
403
- <div class="graphql-code-line ">PAYMENT_METHOD_MISSING_ERROR</div>
404
- <div class="graphql-code-line ">REFUND_PAYMENT_ID_MISSING_ERROR</div>
405
- <div class="graphql-code-line ">MANUAL_PAYMENT_STATE_ERROR</div>
406
- <div class="graphql-code-line ">PRODUCT_OPTION_IN_USE_ERROR</div>
407
- <div class="graphql-code-line ">MISSING_CONDITIONS_ERROR</div>
408
- <div class="graphql-code-line ">NATIVE_AUTH_STRATEGY_ERROR</div>
409
- <div class="graphql-code-line ">INVALID_CREDENTIALS_ERROR</div>
410
- <div class="graphql-code-line ">ORDER_STATE_TRANSITION_ERROR</div>
411
- <div class="graphql-code-line ">EMAIL_ADDRESS_CONFLICT_ERROR</div>
412
- <div class="graphql-code-line ">GUEST_CHECKOUT_ERROR</div>
413
- <div class="graphql-code-line ">ORDER_LIMIT_ERROR</div>
414
- <div class="graphql-code-line ">NEGATIVE_QUANTITY_ERROR</div>
415
- <div class="graphql-code-line ">INSUFFICIENT_STOCK_ERROR</div>
416
- <div class="graphql-code-line ">COUPON_CODE_INVALID_ERROR</div>
417
- <div class="graphql-code-line ">COUPON_CODE_EXPIRED_ERROR</div>
418
- <div class="graphql-code-line ">COUPON_CODE_LIMIT_ERROR</div>
419
- <div class="graphql-code-line ">ORDER_MODIFICATION_ERROR</div>
420
- <div class="graphql-code-line ">INELIGIBLE_SHIPPING_METHOD_ERROR</div>
421
- <div class="graphql-code-line ">NO_ACTIVE_ORDER_ERROR</div>
422
- <div class="graphql-code-line ">ORDER_INTERCEPTOR_ERROR</div>
423
- <div class="graphql-code-line top-level">&#125;</div>
424
- </div>
425
-
426
- ## GlobalFlag
427
-
428
- <div class="graphql-code-block">
429
-
430
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">GlobalFlag</span> &#123;</div>
431
- <div class="graphql-code-line ">TRUE</div>
432
- <div class="graphql-code-line ">FALSE</div>
433
- <div class="graphql-code-line ">INHERIT</div>
434
- <div class="graphql-code-line top-level">&#125;</div>
435
- </div>
436
-
437
- ## HistoryEntryType
438
-
439
- <div class="graphql-code-block">
440
-
441
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">HistoryEntryType</span> &#123;</div>
442
- <div class="graphql-code-line ">CUSTOMER_REGISTERED</div>
443
- <div class="graphql-code-line ">CUSTOMER_VERIFIED</div>
444
- <div class="graphql-code-line ">CUSTOMER_DETAIL_UPDATED</div>
445
- <div class="graphql-code-line ">CUSTOMER_ADDED_TO_GROUP</div>
446
- <div class="graphql-code-line ">CUSTOMER_REMOVED_FROM_GROUP</div>
447
- <div class="graphql-code-line ">CUSTOMER_ADDRESS_CREATED</div>
448
- <div class="graphql-code-line ">CUSTOMER_ADDRESS_UPDATED</div>
449
- <div class="graphql-code-line ">CUSTOMER_ADDRESS_DELETED</div>
450
- <div class="graphql-code-line ">CUSTOMER_PASSWORD_UPDATED</div>
451
- <div class="graphql-code-line ">CUSTOMER_PASSWORD_RESET_REQUESTED</div>
452
- <div class="graphql-code-line ">CUSTOMER_PASSWORD_RESET_VERIFIED</div>
453
- <div class="graphql-code-line ">CUSTOMER_EMAIL_UPDATE_REQUESTED</div>
454
- <div class="graphql-code-line ">CUSTOMER_EMAIL_UPDATE_VERIFIED</div>
455
- <div class="graphql-code-line ">CUSTOMER_NOTE</div>
456
- <div class="graphql-code-line ">ORDER_STATE_TRANSITION</div>
457
- <div class="graphql-code-line ">ORDER_PAYMENT_TRANSITION</div>
458
- <div class="graphql-code-line ">ORDER_FULFILLMENT</div>
459
- <div class="graphql-code-line ">ORDER_CANCELLATION</div>
460
- <div class="graphql-code-line ">ORDER_REFUND_TRANSITION</div>
461
- <div class="graphql-code-line ">ORDER_FULFILLMENT_TRANSITION</div>
462
- <div class="graphql-code-line ">ORDER_NOTE</div>
463
- <div class="graphql-code-line ">ORDER_COUPON_APPLIED</div>
464
- <div class="graphql-code-line ">ORDER_COUPON_REMOVED</div>
465
- <div class="graphql-code-line ">ORDER_MODIFIED</div>
466
- <div class="graphql-code-line ">ORDER_CUSTOMER_UPDATED</div>
467
- <div class="graphql-code-line top-level">&#125;</div>
468
- </div>
469
-
470
- ## JobState
471
-
472
- <div class="graphql-code-block">
473
- <div class="graphql-code-line comment">"""</div>
474
- <div class="graphql-code-line comment">The state of a Job in the JobQueue</div>
475
-
476
- <div class="graphql-code-line comment"></div>
477
-
478
- <div class="graphql-code-line comment"></div>
479
- <div class="graphql-code-line comment">"""</div>
480
-
481
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">JobState</span> &#123;</div>
482
- <div class="graphql-code-line ">PENDING</div>
483
- <div class="graphql-code-line ">RUNNING</div>
484
- <div class="graphql-code-line ">COMPLETED</div>
485
- <div class="graphql-code-line ">RETRYING</div>
486
- <div class="graphql-code-line ">FAILED</div>
487
- <div class="graphql-code-line ">CANCELLED</div>
488
- <div class="graphql-code-line top-level">&#125;</div>
489
- </div>
490
-
491
- ## LanguageCode
492
-
493
- <div class="graphql-code-block">
494
- <div class="graphql-code-line comment">"""</div>
495
- <div class="graphql-code-line comment">Languages in the form of a ISO 639-1 language code with optional</div>
496
-
497
- <div class="graphql-code-line comment">region or script modifier (e.g. de_AT). The selection available is based</div>
498
-
499
- <div class="graphql-code-line comment">on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)</div>
500
-
501
- <div class="graphql-code-line comment">and includes the major spoken languages of the world and any widely-used variants.</div>
502
-
503
- <div class="graphql-code-line comment"></div>
504
-
505
- <div class="graphql-code-line comment"></div>
506
- <div class="graphql-code-line comment">"""</div>
507
-
508
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">LanguageCode</span> &#123;</div>
509
- <div class="graphql-code-line comment">"""Afrikaans"""</div>
510
- <div class="graphql-code-line ">af</div>
511
- <div class="graphql-code-line comment">"""Akan"""</div>
512
- <div class="graphql-code-line ">ak</div>
513
- <div class="graphql-code-line comment">"""Albanian"""</div>
514
- <div class="graphql-code-line ">sq</div>
515
- <div class="graphql-code-line comment">"""Amharic"""</div>
516
- <div class="graphql-code-line ">am</div>
517
- <div class="graphql-code-line comment">"""Arabic"""</div>
518
- <div class="graphql-code-line ">ar</div>
519
- <div class="graphql-code-line comment">"""Armenian"""</div>
520
- <div class="graphql-code-line ">hy</div>
521
- <div class="graphql-code-line comment">"""Assamese"""</div>
522
- <div class="graphql-code-line ">as</div>
523
- <div class="graphql-code-line comment">"""Azerbaijani"""</div>
524
- <div class="graphql-code-line ">az</div>
525
- <div class="graphql-code-line comment">"""Bambara"""</div>
526
- <div class="graphql-code-line ">bm</div>
527
- <div class="graphql-code-line comment">"""Bangla"""</div>
528
- <div class="graphql-code-line ">bn</div>
529
- <div class="graphql-code-line comment">"""Basque"""</div>
530
- <div class="graphql-code-line ">eu</div>
531
- <div class="graphql-code-line comment">"""Belarusian"""</div>
532
- <div class="graphql-code-line ">be</div>
533
- <div class="graphql-code-line comment">"""Bosnian"""</div>
534
- <div class="graphql-code-line ">bs</div>
535
- <div class="graphql-code-line comment">"""Breton"""</div>
536
- <div class="graphql-code-line ">br</div>
537
- <div class="graphql-code-line comment">"""Bulgarian"""</div>
538
- <div class="graphql-code-line ">bg</div>
539
- <div class="graphql-code-line comment">"""Burmese"""</div>
540
- <div class="graphql-code-line ">my</div>
541
- <div class="graphql-code-line comment">"""Catalan"""</div>
542
- <div class="graphql-code-line ">ca</div>
543
- <div class="graphql-code-line comment">"""Chechen"""</div>
544
- <div class="graphql-code-line ">ce</div>
545
- <div class="graphql-code-line comment">"""Chinese"""</div>
546
- <div class="graphql-code-line ">zh</div>
547
- <div class="graphql-code-line comment">"""Simplified Chinese"""</div>
548
- <div class="graphql-code-line ">zh_Hans</div>
549
- <div class="graphql-code-line comment">"""Traditional Chinese"""</div>
550
- <div class="graphql-code-line ">zh_Hant</div>
551
- <div class="graphql-code-line comment">"""Church Slavic"""</div>
552
- <div class="graphql-code-line ">cu</div>
553
- <div class="graphql-code-line comment">"""Cornish"""</div>
554
- <div class="graphql-code-line ">kw</div>
555
- <div class="graphql-code-line comment">"""Corsican"""</div>
556
- <div class="graphql-code-line ">co</div>
557
- <div class="graphql-code-line comment">"""Croatian"""</div>
558
- <div class="graphql-code-line ">hr</div>
559
- <div class="graphql-code-line comment">"""Czech"""</div>
560
- <div class="graphql-code-line ">cs</div>
561
- <div class="graphql-code-line comment">"""Danish"""</div>
562
- <div class="graphql-code-line ">da</div>
563
- <div class="graphql-code-line comment">"""Dutch"""</div>
564
- <div class="graphql-code-line ">nl</div>
565
- <div class="graphql-code-line comment">"""Flemish"""</div>
566
- <div class="graphql-code-line ">nl_BE</div>
567
- <div class="graphql-code-line comment">"""Dzongkha"""</div>
568
- <div class="graphql-code-line ">dz</div>
569
- <div class="graphql-code-line comment">"""English"""</div>
570
- <div class="graphql-code-line ">en</div>
571
- <div class="graphql-code-line comment">"""Australian English"""</div>
572
- <div class="graphql-code-line ">en_AU</div>
573
- <div class="graphql-code-line comment">"""Canadian English"""</div>
574
- <div class="graphql-code-line ">en_CA</div>
575
- <div class="graphql-code-line comment">"""British English"""</div>
576
- <div class="graphql-code-line ">en_GB</div>
577
- <div class="graphql-code-line comment">"""American English"""</div>
578
- <div class="graphql-code-line ">en_US</div>
579
- <div class="graphql-code-line comment">"""Esperanto"""</div>
580
- <div class="graphql-code-line ">eo</div>
581
- <div class="graphql-code-line comment">"""Estonian"""</div>
582
- <div class="graphql-code-line ">et</div>
583
- <div class="graphql-code-line comment">"""Ewe"""</div>
584
- <div class="graphql-code-line ">ee</div>
585
- <div class="graphql-code-line comment">"""Faroese"""</div>
586
- <div class="graphql-code-line ">fo</div>
587
- <div class="graphql-code-line comment">"""Finnish"""</div>
588
- <div class="graphql-code-line ">fi</div>
589
- <div class="graphql-code-line comment">"""French"""</div>
590
- <div class="graphql-code-line ">fr</div>
591
- <div class="graphql-code-line comment">"""Canadian French"""</div>
592
- <div class="graphql-code-line ">fr_CA</div>
593
- <div class="graphql-code-line comment">"""Swiss French"""</div>
594
- <div class="graphql-code-line ">fr_CH</div>
595
- <div class="graphql-code-line comment">"""Fulah"""</div>
596
- <div class="graphql-code-line ">ff</div>
597
- <div class="graphql-code-line comment">"""Galician"""</div>
598
- <div class="graphql-code-line ">gl</div>
599
- <div class="graphql-code-line comment">"""Ganda"""</div>
600
- <div class="graphql-code-line ">lg</div>
601
- <div class="graphql-code-line comment">"""Georgian"""</div>
602
- <div class="graphql-code-line ">ka</div>
603
- <div class="graphql-code-line comment">"""German"""</div>
604
- <div class="graphql-code-line ">de</div>
605
- <div class="graphql-code-line comment">"""Austrian German"""</div>
606
- <div class="graphql-code-line ">de_AT</div>
607
- <div class="graphql-code-line comment">"""Swiss High German"""</div>
608
- <div class="graphql-code-line ">de_CH</div>
609
- <div class="graphql-code-line comment">"""Greek"""</div>
610
- <div class="graphql-code-line ">el</div>
611
- <div class="graphql-code-line comment">"""Gujarati"""</div>
612
- <div class="graphql-code-line ">gu</div>
613
- <div class="graphql-code-line comment">"""Haitian Creole"""</div>
614
- <div class="graphql-code-line ">ht</div>
615
- <div class="graphql-code-line comment">"""Hausa"""</div>
616
- <div class="graphql-code-line ">ha</div>
617
- <div class="graphql-code-line comment">"""Hebrew"""</div>
618
- <div class="graphql-code-line ">he</div>
619
- <div class="graphql-code-line comment">"""Hindi"""</div>
620
- <div class="graphql-code-line ">hi</div>
621
- <div class="graphql-code-line comment">"""Hungarian"""</div>
622
- <div class="graphql-code-line ">hu</div>
623
- <div class="graphql-code-line comment">"""Icelandic"""</div>
624
- <div class="graphql-code-line ">is</div>
625
- <div class="graphql-code-line comment">"""Igbo"""</div>
626
- <div class="graphql-code-line ">ig</div>
627
- <div class="graphql-code-line comment">"""Indonesian"""</div>
628
- <div class="graphql-code-line ">id</div>
629
- <div class="graphql-code-line comment">"""Interlingua"""</div>
630
- <div class="graphql-code-line ">ia</div>
631
- <div class="graphql-code-line comment">"""Irish"""</div>
632
- <div class="graphql-code-line ">ga</div>
633
- <div class="graphql-code-line comment">"""Italian"""</div>
634
- <div class="graphql-code-line ">it</div>
635
- <div class="graphql-code-line comment">"""Japanese"""</div>
636
- <div class="graphql-code-line ">ja</div>
637
- <div class="graphql-code-line comment">"""Javanese"""</div>
638
- <div class="graphql-code-line ">jv</div>
639
- <div class="graphql-code-line comment">"""Kalaallisut"""</div>
640
- <div class="graphql-code-line ">kl</div>
641
- <div class="graphql-code-line comment">"""Kannada"""</div>
642
- <div class="graphql-code-line ">kn</div>
643
- <div class="graphql-code-line comment">"""Kashmiri"""</div>
644
- <div class="graphql-code-line ">ks</div>
645
- <div class="graphql-code-line comment">"""Kazakh"""</div>
646
- <div class="graphql-code-line ">kk</div>
647
- <div class="graphql-code-line comment">"""Khmer"""</div>
648
- <div class="graphql-code-line ">km</div>
649
- <div class="graphql-code-line comment">"""Kikuyu"""</div>
650
- <div class="graphql-code-line ">ki</div>
651
- <div class="graphql-code-line comment">"""Kinyarwanda"""</div>
652
- <div class="graphql-code-line ">rw</div>
653
- <div class="graphql-code-line comment">"""Korean"""</div>
654
- <div class="graphql-code-line ">ko</div>
655
- <div class="graphql-code-line comment">"""Kurdish"""</div>
656
- <div class="graphql-code-line ">ku</div>
657
- <div class="graphql-code-line comment">"""Kyrgyz"""</div>
658
- <div class="graphql-code-line ">ky</div>
659
- <div class="graphql-code-line comment">"""Lao"""</div>
660
- <div class="graphql-code-line ">lo</div>
661
- <div class="graphql-code-line comment">"""Latin"""</div>
662
- <div class="graphql-code-line ">la</div>
663
- <div class="graphql-code-line comment">"""Latvian"""</div>
664
- <div class="graphql-code-line ">lv</div>
665
- <div class="graphql-code-line comment">"""Lingala"""</div>
666
- <div class="graphql-code-line ">ln</div>
667
- <div class="graphql-code-line comment">"""Lithuanian"""</div>
668
- <div class="graphql-code-line ">lt</div>
669
- <div class="graphql-code-line comment">"""Luba-Katanga"""</div>
670
- <div class="graphql-code-line ">lu</div>
671
- <div class="graphql-code-line comment">"""Luxembourgish"""</div>
672
- <div class="graphql-code-line ">lb</div>
673
- <div class="graphql-code-line comment">"""Macedonian"""</div>
674
- <div class="graphql-code-line ">mk</div>
675
- <div class="graphql-code-line comment">"""Malagasy"""</div>
676
- <div class="graphql-code-line ">mg</div>
677
- <div class="graphql-code-line comment">"""Malay"""</div>
678
- <div class="graphql-code-line ">ms</div>
679
- <div class="graphql-code-line comment">"""Malayalam"""</div>
680
- <div class="graphql-code-line ">ml</div>
681
- <div class="graphql-code-line comment">"""Maltese"""</div>
682
- <div class="graphql-code-line ">mt</div>
683
- <div class="graphql-code-line comment">"""Manx"""</div>
684
- <div class="graphql-code-line ">gv</div>
685
- <div class="graphql-code-line comment">"""Maori"""</div>
686
- <div class="graphql-code-line ">mi</div>
687
- <div class="graphql-code-line comment">"""Marathi"""</div>
688
- <div class="graphql-code-line ">mr</div>
689
- <div class="graphql-code-line comment">"""Mongolian"""</div>
690
- <div class="graphql-code-line ">mn</div>
691
- <div class="graphql-code-line comment">"""Nepali"""</div>
692
- <div class="graphql-code-line ">ne</div>
693
- <div class="graphql-code-line comment">"""North Ndebele"""</div>
694
- <div class="graphql-code-line ">nd</div>
695
- <div class="graphql-code-line comment">"""Northern Sami"""</div>
696
- <div class="graphql-code-line ">se</div>
697
- <div class="graphql-code-line comment">"""Norwegian Bokmål"""</div>
698
- <div class="graphql-code-line ">nb</div>
699
- <div class="graphql-code-line comment">"""Norwegian Nynorsk"""</div>
700
- <div class="graphql-code-line ">nn</div>
701
- <div class="graphql-code-line comment">"""Nyanja"""</div>
702
- <div class="graphql-code-line ">ny</div>
703
- <div class="graphql-code-line comment">"""Odia"""</div>
704
- <div class="graphql-code-line ">or</div>
705
- <div class="graphql-code-line comment">"""Oromo"""</div>
706
- <div class="graphql-code-line ">om</div>
707
- <div class="graphql-code-line comment">"""Ossetic"""</div>
708
- <div class="graphql-code-line ">os</div>
709
- <div class="graphql-code-line comment">"""Pashto"""</div>
710
- <div class="graphql-code-line ">ps</div>
711
- <div class="graphql-code-line comment">"""Persian"""</div>
712
- <div class="graphql-code-line ">fa</div>
713
- <div class="graphql-code-line comment">"""Dari"""</div>
714
- <div class="graphql-code-line ">fa_AF</div>
715
- <div class="graphql-code-line comment">"""Polish"""</div>
716
- <div class="graphql-code-line ">pl</div>
717
- <div class="graphql-code-line comment">"""Portuguese"""</div>
718
- <div class="graphql-code-line ">pt</div>
719
- <div class="graphql-code-line comment">"""Brazilian Portuguese"""</div>
720
- <div class="graphql-code-line ">pt_BR</div>
721
- <div class="graphql-code-line comment">"""European Portuguese"""</div>
722
- <div class="graphql-code-line ">pt_PT</div>
723
- <div class="graphql-code-line comment">"""Punjabi"""</div>
724
- <div class="graphql-code-line ">pa</div>
725
- <div class="graphql-code-line comment">"""Quechua"""</div>
726
- <div class="graphql-code-line ">qu</div>
727
- <div class="graphql-code-line comment">"""Romanian"""</div>
728
- <div class="graphql-code-line ">ro</div>
729
- <div class="graphql-code-line comment">"""Moldavian"""</div>
730
- <div class="graphql-code-line ">ro_MD</div>
731
- <div class="graphql-code-line comment">"""Romansh"""</div>
732
- <div class="graphql-code-line ">rm</div>
733
- <div class="graphql-code-line comment">"""Rundi"""</div>
734
- <div class="graphql-code-line ">rn</div>
735
- <div class="graphql-code-line comment">"""Russian"""</div>
736
- <div class="graphql-code-line ">ru</div>
737
- <div class="graphql-code-line comment">"""Samoan"""</div>
738
- <div class="graphql-code-line ">sm</div>
739
- <div class="graphql-code-line comment">"""Sango"""</div>
740
- <div class="graphql-code-line ">sg</div>
741
- <div class="graphql-code-line comment">"""Sanskrit"""</div>
742
- <div class="graphql-code-line ">sa</div>
743
- <div class="graphql-code-line comment">"""Scottish Gaelic"""</div>
744
- <div class="graphql-code-line ">gd</div>
745
- <div class="graphql-code-line comment">"""Serbian"""</div>
746
- <div class="graphql-code-line ">sr</div>
747
- <div class="graphql-code-line comment">"""Shona"""</div>
748
- <div class="graphql-code-line ">sn</div>
749
- <div class="graphql-code-line comment">"""Sichuan Yi"""</div>
750
- <div class="graphql-code-line ">ii</div>
751
- <div class="graphql-code-line comment">"""Sindhi"""</div>
752
- <div class="graphql-code-line ">sd</div>
753
- <div class="graphql-code-line comment">"""Sinhala"""</div>
754
- <div class="graphql-code-line ">si</div>
755
- <div class="graphql-code-line comment">"""Slovak"""</div>
756
- <div class="graphql-code-line ">sk</div>
757
- <div class="graphql-code-line comment">"""Slovenian"""</div>
758
- <div class="graphql-code-line ">sl</div>
759
- <div class="graphql-code-line comment">"""Somali"""</div>
760
- <div class="graphql-code-line ">so</div>
761
- <div class="graphql-code-line comment">"""Southern Sotho"""</div>
762
- <div class="graphql-code-line ">st</div>
763
- <div class="graphql-code-line comment">"""Spanish"""</div>
764
- <div class="graphql-code-line ">es</div>
765
- <div class="graphql-code-line comment">"""European Spanish"""</div>
766
- <div class="graphql-code-line ">es_ES</div>
767
- <div class="graphql-code-line comment">"""Mexican Spanish"""</div>
768
- <div class="graphql-code-line ">es_MX</div>
769
- <div class="graphql-code-line comment">"""Sundanese"""</div>
770
- <div class="graphql-code-line ">su</div>
771
- <div class="graphql-code-line comment">"""Swahili"""</div>
772
- <div class="graphql-code-line ">sw</div>
773
- <div class="graphql-code-line comment">"""Congo Swahili"""</div>
774
- <div class="graphql-code-line ">sw_CD</div>
775
- <div class="graphql-code-line comment">"""Swedish"""</div>
776
- <div class="graphql-code-line ">sv</div>
777
- <div class="graphql-code-line comment">"""Tajik"""</div>
778
- <div class="graphql-code-line ">tg</div>
779
- <div class="graphql-code-line comment">"""Tamil"""</div>
780
- <div class="graphql-code-line ">ta</div>
781
- <div class="graphql-code-line comment">"""Tatar"""</div>
782
- <div class="graphql-code-line ">tt</div>
783
- <div class="graphql-code-line comment">"""Telugu"""</div>
784
- <div class="graphql-code-line ">te</div>
785
- <div class="graphql-code-line comment">"""Thai"""</div>
786
- <div class="graphql-code-line ">th</div>
787
- <div class="graphql-code-line comment">"""Tibetan"""</div>
788
- <div class="graphql-code-line ">bo</div>
789
- <div class="graphql-code-line comment">"""Tigrinya"""</div>
790
- <div class="graphql-code-line ">ti</div>
791
- <div class="graphql-code-line comment">"""Tongan"""</div>
792
- <div class="graphql-code-line ">to</div>
793
- <div class="graphql-code-line comment">"""Turkish"""</div>
794
- <div class="graphql-code-line ">tr</div>
795
- <div class="graphql-code-line comment">"""Turkmen"""</div>
796
- <div class="graphql-code-line ">tk</div>
797
- <div class="graphql-code-line comment">"""Ukrainian"""</div>
798
- <div class="graphql-code-line ">uk</div>
799
- <div class="graphql-code-line comment">"""Urdu"""</div>
800
- <div class="graphql-code-line ">ur</div>
801
- <div class="graphql-code-line comment">"""Uyghur"""</div>
802
- <div class="graphql-code-line ">ug</div>
803
- <div class="graphql-code-line comment">"""Uzbek"""</div>
804
- <div class="graphql-code-line ">uz</div>
805
- <div class="graphql-code-line comment">"""Vietnamese"""</div>
806
- <div class="graphql-code-line ">vi</div>
807
- <div class="graphql-code-line comment">"""Volapük"""</div>
808
- <div class="graphql-code-line ">vo</div>
809
- <div class="graphql-code-line comment">"""Welsh"""</div>
810
- <div class="graphql-code-line ">cy</div>
811
- <div class="graphql-code-line comment">"""Western Frisian"""</div>
812
- <div class="graphql-code-line ">fy</div>
813
- <div class="graphql-code-line comment">"""Wolof"""</div>
814
- <div class="graphql-code-line ">wo</div>
815
- <div class="graphql-code-line comment">"""Xhosa"""</div>
816
- <div class="graphql-code-line ">xh</div>
817
- <div class="graphql-code-line comment">"""Yiddish"""</div>
818
- <div class="graphql-code-line ">yi</div>
819
- <div class="graphql-code-line comment">"""Yoruba"""</div>
820
- <div class="graphql-code-line ">yo</div>
821
- <div class="graphql-code-line comment">"""Zulu"""</div>
822
- <div class="graphql-code-line ">zu</div>
823
- <div class="graphql-code-line top-level">&#125;</div>
824
- </div>
825
-
826
- ## LogicalOperator
827
-
828
- <div class="graphql-code-block">
829
-
830
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">LogicalOperator</span> &#123;</div>
831
- <div class="graphql-code-line ">AND</div>
832
- <div class="graphql-code-line ">OR</div>
833
- <div class="graphql-code-line top-level">&#125;</div>
834
- </div>
835
-
836
- ## MetricInterval
837
-
838
- <div class="graphql-code-block">
839
-
840
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">MetricInterval</span> &#123;</div>
841
- <div class="graphql-code-line ">Daily</div>
842
- <div class="graphql-code-line top-level">&#125;</div>
843
- </div>
844
-
845
- ## MetricType
846
-
847
- <div class="graphql-code-block">
848
-
849
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">MetricType</span> &#123;</div>
850
- <div class="graphql-code-line ">OrderCount</div>
851
- <div class="graphql-code-line ">OrderTotal</div>
852
- <div class="graphql-code-line ">AverageOrderValue</div>
853
- <div class="graphql-code-line top-level">&#125;</div>
854
- </div>
855
-
856
- ## OrderType
857
-
858
- <div class="graphql-code-block">
859
-
860
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">OrderType</span> &#123;</div>
861
- <div class="graphql-code-line ">Regular</div>
862
- <div class="graphql-code-line ">Seller</div>
863
- <div class="graphql-code-line ">Aggregate</div>
864
- <div class="graphql-code-line top-level">&#125;</div>
865
- </div>
866
-
867
- ## Permission
868
-
869
- <div class="graphql-code-block">
870
- <div class="graphql-code-line comment">"""</div>
871
- <div class="graphql-code-line comment">Permissions for administrators and customers. Used to control access to</div>
872
-
873
- <div class="graphql-code-line comment">GraphQL resolvers via the &#123;@link Allow&#125; decorator.</div>
874
-
875
- <div class="graphql-code-line comment"></div>
876
-
877
- <div class="graphql-code-line comment">## Understanding Permission.Owner</div>
878
-
879
- <div class="graphql-code-line comment"></div>
880
-
881
- <div class="graphql-code-line comment">`Permission.Owner` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only</div>
882
-
883
- <div class="graphql-code-line comment">be accessible to the "owner" of that resource.</div>
884
-
885
- <div class="graphql-code-line comment"></div>
886
-
887
- <div class="graphql-code-line comment">For example, the Shop API <code>activeCustomer</code> query resolver should only return the Customer object for the "owner" of that Customer, i.e.</div>
888
-
889
- <div class="graphql-code-line comment">based on the activeUserId of the current session. As a result, the resolver code looks like this:</div>
890
-
891
- <div class="graphql-code-line comment"></div>
892
-
893
- <div class="graphql-code-line comment">@example</div>
894
-
895
- <div class="graphql-code-line comment">```TypeScript</div>
896
-
897
- <div class="graphql-code-line comment">\@Query()</div>
898
-
899
- <div class="graphql-code-line comment">\@Allow(Permission.Owner)</div>
900
-
901
- <div class="graphql-code-line comment">async activeCustomer(\@Ctx() ctx: RequestContext): Promise&lt;Customer | undefined&gt; &#123;</div>
902
-
903
- <div class="graphql-code-line comment"> const userId = ctx.activeUserId;</div>
904
-
905
- <div class="graphql-code-line comment"> if (userId) &#123;</div>
906
-
907
- <div class="graphql-code-line comment"> return this.customerService.findOneByUserId(ctx, userId);</div>
908
-
909
- <div class="graphql-code-line comment"> &#125;</div>
910
-
911
- <div class="graphql-code-line comment">&#125;</div>
912
-
913
- <div class="graphql-code-line comment">```</div>
914
-
915
- <div class="graphql-code-line comment"></div>
916
-
917
- <div class="graphql-code-line comment">Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally</div>
918
-
919
- <div class="graphql-code-line comment">nor statically encoded at build-time, any resolvers using <code>Permission.Owner</code> **must** include logic to enforce that only the owner</div>
920
-
921
- <div class="graphql-code-line comment">of the resource has access. If not, then it is the equivalent of using `Permission.Public`.</div>
922
-
923
- <div class="graphql-code-line comment"></div>
924
-
925
- <div class="graphql-code-line comment"></div>
926
-
927
- <div class="graphql-code-line comment"></div>
928
- <div class="graphql-code-line comment">"""</div>
929
-
930
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">Permission</span> &#123;</div>
931
- <div class="graphql-code-line comment">"""Authenticated means simply that the user is logged in"""</div>
932
- <div class="graphql-code-line ">Authenticated</div>
933
- <div class="graphql-code-line comment">"""SuperAdmin has unrestricted access to all operations"""</div>
934
- <div class="graphql-code-line ">SuperAdmin</div>
935
- <div class="graphql-code-line comment">"""Owner means the user owns this entity, e.g. a Customer's own Order"""</div>
936
- <div class="graphql-code-line ">Owner</div>
937
- <div class="graphql-code-line comment">"""Public means any unauthenticated user may perform the operation"""</div>
938
- <div class="graphql-code-line ">Public</div>
939
- <div class="graphql-code-line comment">"""Grants permission to update GlobalSettings"""</div>
940
- <div class="graphql-code-line ">UpdateGlobalSettings</div>
941
- <div class="graphql-code-line comment">"""Grants permission to create Products, Facets, Assets, Collections"""</div>
942
- <div class="graphql-code-line ">CreateCatalog</div>
943
- <div class="graphql-code-line comment">"""Grants permission to read Products, Facets, Assets, Collections"""</div>
944
- <div class="graphql-code-line ">ReadCatalog</div>
945
- <div class="graphql-code-line comment">"""Grants permission to update Products, Facets, Assets, Collections"""</div>
946
- <div class="graphql-code-line ">UpdateCatalog</div>
947
- <div class="graphql-code-line comment">"""Grants permission to delete Products, Facets, Assets, Collections"""</div>
948
- <div class="graphql-code-line ">DeleteCatalog</div>
949
- <div class="graphql-code-line comment">"""Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
950
- <div class="graphql-code-line ">CreateSettings</div>
951
- <div class="graphql-code-line comment">"""Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
952
- <div class="graphql-code-line ">ReadSettings</div>
953
- <div class="graphql-code-line comment">"""Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
954
- <div class="graphql-code-line ">UpdateSettings</div>
955
- <div class="graphql-code-line comment">"""Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""</div>
956
- <div class="graphql-code-line ">DeleteSettings</div>
957
- <div class="graphql-code-line comment">"""Grants permission to create Administrator"""</div>
958
- <div class="graphql-code-line ">CreateAdministrator</div>
959
- <div class="graphql-code-line comment">"""Grants permission to read Administrator"""</div>
960
- <div class="graphql-code-line ">ReadAdministrator</div>
961
- <div class="graphql-code-line comment">"""Grants permission to update Administrator"""</div>
962
- <div class="graphql-code-line ">UpdateAdministrator</div>
963
- <div class="graphql-code-line comment">"""Grants permission to delete Administrator"""</div>
964
- <div class="graphql-code-line ">DeleteAdministrator</div>
965
- <div class="graphql-code-line comment">"""Grants permission to create Asset"""</div>
966
- <div class="graphql-code-line ">CreateAsset</div>
967
- <div class="graphql-code-line comment">"""Grants permission to read Asset"""</div>
968
- <div class="graphql-code-line ">ReadAsset</div>
969
- <div class="graphql-code-line comment">"""Grants permission to update Asset"""</div>
970
- <div class="graphql-code-line ">UpdateAsset</div>
971
- <div class="graphql-code-line comment">"""Grants permission to delete Asset"""</div>
972
- <div class="graphql-code-line ">DeleteAsset</div>
973
- <div class="graphql-code-line comment">"""Grants permission to create Channel"""</div>
974
- <div class="graphql-code-line ">CreateChannel</div>
975
- <div class="graphql-code-line comment">"""Grants permission to read Channel"""</div>
976
- <div class="graphql-code-line ">ReadChannel</div>
977
- <div class="graphql-code-line comment">"""Grants permission to update Channel"""</div>
978
- <div class="graphql-code-line ">UpdateChannel</div>
979
- <div class="graphql-code-line comment">"""Grants permission to delete Channel"""</div>
980
- <div class="graphql-code-line ">DeleteChannel</div>
981
- <div class="graphql-code-line comment">"""Grants permission to create Collection"""</div>
982
- <div class="graphql-code-line ">CreateCollection</div>
983
- <div class="graphql-code-line comment">"""Grants permission to read Collection"""</div>
984
- <div class="graphql-code-line ">ReadCollection</div>
985
- <div class="graphql-code-line comment">"""Grants permission to update Collection"""</div>
986
- <div class="graphql-code-line ">UpdateCollection</div>
987
- <div class="graphql-code-line comment">"""Grants permission to delete Collection"""</div>
988
- <div class="graphql-code-line ">DeleteCollection</div>
989
- <div class="graphql-code-line comment">"""Grants permission to create Country"""</div>
990
- <div class="graphql-code-line ">CreateCountry</div>
991
- <div class="graphql-code-line comment">"""Grants permission to read Country"""</div>
992
- <div class="graphql-code-line ">ReadCountry</div>
993
- <div class="graphql-code-line comment">"""Grants permission to update Country"""</div>
994
- <div class="graphql-code-line ">UpdateCountry</div>
995
- <div class="graphql-code-line comment">"""Grants permission to delete Country"""</div>
996
- <div class="graphql-code-line ">DeleteCountry</div>
997
- <div class="graphql-code-line comment">"""Grants permission to create Customer"""</div>
998
- <div class="graphql-code-line ">CreateCustomer</div>
999
- <div class="graphql-code-line comment">"""Grants permission to read Customer"""</div>
1000
- <div class="graphql-code-line ">ReadCustomer</div>
1001
- <div class="graphql-code-line comment">"""Grants permission to update Customer"""</div>
1002
- <div class="graphql-code-line ">UpdateCustomer</div>
1003
- <div class="graphql-code-line comment">"""Grants permission to delete Customer"""</div>
1004
- <div class="graphql-code-line ">DeleteCustomer</div>
1005
- <div class="graphql-code-line comment">"""Grants permission to create CustomerGroup"""</div>
1006
- <div class="graphql-code-line ">CreateCustomerGroup</div>
1007
- <div class="graphql-code-line comment">"""Grants permission to read CustomerGroup"""</div>
1008
- <div class="graphql-code-line ">ReadCustomerGroup</div>
1009
- <div class="graphql-code-line comment">"""Grants permission to update CustomerGroup"""</div>
1010
- <div class="graphql-code-line ">UpdateCustomerGroup</div>
1011
- <div class="graphql-code-line comment">"""Grants permission to delete CustomerGroup"""</div>
1012
- <div class="graphql-code-line ">DeleteCustomerGroup</div>
1013
- <div class="graphql-code-line comment">"""Grants permission to create Facet"""</div>
1014
- <div class="graphql-code-line ">CreateFacet</div>
1015
- <div class="graphql-code-line comment">"""Grants permission to read Facet"""</div>
1016
- <div class="graphql-code-line ">ReadFacet</div>
1017
- <div class="graphql-code-line comment">"""Grants permission to update Facet"""</div>
1018
- <div class="graphql-code-line ">UpdateFacet</div>
1019
- <div class="graphql-code-line comment">"""Grants permission to delete Facet"""</div>
1020
- <div class="graphql-code-line ">DeleteFacet</div>
1021
- <div class="graphql-code-line comment">"""Grants permission to create Order"""</div>
1022
- <div class="graphql-code-line ">CreateOrder</div>
1023
- <div class="graphql-code-line comment">"""Grants permission to read Order"""</div>
1024
- <div class="graphql-code-line ">ReadOrder</div>
1025
- <div class="graphql-code-line comment">"""Grants permission to update Order"""</div>
1026
- <div class="graphql-code-line ">UpdateOrder</div>
1027
- <div class="graphql-code-line comment">"""Grants permission to delete Order"""</div>
1028
- <div class="graphql-code-line ">DeleteOrder</div>
1029
- <div class="graphql-code-line comment">"""Grants permission to create PaymentMethod"""</div>
1030
- <div class="graphql-code-line ">CreatePaymentMethod</div>
1031
- <div class="graphql-code-line comment">"""Grants permission to read PaymentMethod"""</div>
1032
- <div class="graphql-code-line ">ReadPaymentMethod</div>
1033
- <div class="graphql-code-line comment">"""Grants permission to update PaymentMethod"""</div>
1034
- <div class="graphql-code-line ">UpdatePaymentMethod</div>
1035
- <div class="graphql-code-line comment">"""Grants permission to delete PaymentMethod"""</div>
1036
- <div class="graphql-code-line ">DeletePaymentMethod</div>
1037
- <div class="graphql-code-line comment">"""Grants permission to create Product"""</div>
1038
- <div class="graphql-code-line ">CreateProduct</div>
1039
- <div class="graphql-code-line comment">"""Grants permission to read Product"""</div>
1040
- <div class="graphql-code-line ">ReadProduct</div>
1041
- <div class="graphql-code-line comment">"""Grants permission to update Product"""</div>
1042
- <div class="graphql-code-line ">UpdateProduct</div>
1043
- <div class="graphql-code-line comment">"""Grants permission to delete Product"""</div>
1044
- <div class="graphql-code-line ">DeleteProduct</div>
1045
- <div class="graphql-code-line comment">"""Grants permission to create Promotion"""</div>
1046
- <div class="graphql-code-line ">CreatePromotion</div>
1047
- <div class="graphql-code-line comment">"""Grants permission to read Promotion"""</div>
1048
- <div class="graphql-code-line ">ReadPromotion</div>
1049
- <div class="graphql-code-line comment">"""Grants permission to update Promotion"""</div>
1050
- <div class="graphql-code-line ">UpdatePromotion</div>
1051
- <div class="graphql-code-line comment">"""Grants permission to delete Promotion"""</div>
1052
- <div class="graphql-code-line ">DeletePromotion</div>
1053
- <div class="graphql-code-line comment">"""Grants permission to create ShippingMethod"""</div>
1054
- <div class="graphql-code-line ">CreateShippingMethod</div>
1055
- <div class="graphql-code-line comment">"""Grants permission to read ShippingMethod"""</div>
1056
- <div class="graphql-code-line ">ReadShippingMethod</div>
1057
- <div class="graphql-code-line comment">"""Grants permission to update ShippingMethod"""</div>
1058
- <div class="graphql-code-line ">UpdateShippingMethod</div>
1059
- <div class="graphql-code-line comment">"""Grants permission to delete ShippingMethod"""</div>
1060
- <div class="graphql-code-line ">DeleteShippingMethod</div>
1061
- <div class="graphql-code-line comment">"""Grants permission to create Tag"""</div>
1062
- <div class="graphql-code-line ">CreateTag</div>
1063
- <div class="graphql-code-line comment">"""Grants permission to read Tag"""</div>
1064
- <div class="graphql-code-line ">ReadTag</div>
1065
- <div class="graphql-code-line comment">"""Grants permission to update Tag"""</div>
1066
- <div class="graphql-code-line ">UpdateTag</div>
1067
- <div class="graphql-code-line comment">"""Grants permission to delete Tag"""</div>
1068
- <div class="graphql-code-line ">DeleteTag</div>
1069
- <div class="graphql-code-line comment">"""Grants permission to create TaxCategory"""</div>
1070
- <div class="graphql-code-line ">CreateTaxCategory</div>
1071
- <div class="graphql-code-line comment">"""Grants permission to read TaxCategory"""</div>
1072
- <div class="graphql-code-line ">ReadTaxCategory</div>
1073
- <div class="graphql-code-line comment">"""Grants permission to update TaxCategory"""</div>
1074
- <div class="graphql-code-line ">UpdateTaxCategory</div>
1075
- <div class="graphql-code-line comment">"""Grants permission to delete TaxCategory"""</div>
1076
- <div class="graphql-code-line ">DeleteTaxCategory</div>
1077
- <div class="graphql-code-line comment">"""Grants permission to create TaxRate"""</div>
1078
- <div class="graphql-code-line ">CreateTaxRate</div>
1079
- <div class="graphql-code-line comment">"""Grants permission to read TaxRate"""</div>
1080
- <div class="graphql-code-line ">ReadTaxRate</div>
1081
- <div class="graphql-code-line comment">"""Grants permission to update TaxRate"""</div>
1082
- <div class="graphql-code-line ">UpdateTaxRate</div>
1083
- <div class="graphql-code-line comment">"""Grants permission to delete TaxRate"""</div>
1084
- <div class="graphql-code-line ">DeleteTaxRate</div>
1085
- <div class="graphql-code-line comment">"""Grants permission to create Seller"""</div>
1086
- <div class="graphql-code-line ">CreateSeller</div>
1087
- <div class="graphql-code-line comment">"""Grants permission to read Seller"""</div>
1088
- <div class="graphql-code-line ">ReadSeller</div>
1089
- <div class="graphql-code-line comment">"""Grants permission to update Seller"""</div>
1090
- <div class="graphql-code-line ">UpdateSeller</div>
1091
- <div class="graphql-code-line comment">"""Grants permission to delete Seller"""</div>
1092
- <div class="graphql-code-line ">DeleteSeller</div>
1093
- <div class="graphql-code-line comment">"""Grants permission to create StockLocation"""</div>
1094
- <div class="graphql-code-line ">CreateStockLocation</div>
1095
- <div class="graphql-code-line comment">"""Grants permission to read StockLocation"""</div>
1096
- <div class="graphql-code-line ">ReadStockLocation</div>
1097
- <div class="graphql-code-line comment">"""Grants permission to update StockLocation"""</div>
1098
- <div class="graphql-code-line ">UpdateStockLocation</div>
1099
- <div class="graphql-code-line comment">"""Grants permission to delete StockLocation"""</div>
1100
- <div class="graphql-code-line ">DeleteStockLocation</div>
1101
- <div class="graphql-code-line comment">"""Grants permission to create System"""</div>
1102
- <div class="graphql-code-line ">CreateSystem</div>
1103
- <div class="graphql-code-line comment">"""Grants permission to read System"""</div>
1104
- <div class="graphql-code-line ">ReadSystem</div>
1105
- <div class="graphql-code-line comment">"""Grants permission to update System"""</div>
1106
- <div class="graphql-code-line ">UpdateSystem</div>
1107
- <div class="graphql-code-line comment">"""Grants permission to delete System"""</div>
1108
- <div class="graphql-code-line ">DeleteSystem</div>
1109
- <div class="graphql-code-line comment">"""Grants permission to create Zone"""</div>
1110
- <div class="graphql-code-line ">CreateZone</div>
1111
- <div class="graphql-code-line comment">"""Grants permission to read Zone"""</div>
1112
- <div class="graphql-code-line ">ReadZone</div>
1113
- <div class="graphql-code-line comment">"""Grants permission to update Zone"""</div>
1114
- <div class="graphql-code-line ">UpdateZone</div>
1115
- <div class="graphql-code-line comment">"""Grants permission to delete Zone"""</div>
1116
- <div class="graphql-code-line ">DeleteZone</div>
1117
- <div class="graphql-code-line top-level">&#125;</div>
1118
- </div>
1119
-
1120
- ## SortOrder
1121
-
1122
- <div class="graphql-code-block">
1123
-
1124
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">SortOrder</span> &#123;</div>
1125
- <div class="graphql-code-line ">ASC</div>
1126
- <div class="graphql-code-line ">DESC</div>
1127
- <div class="graphql-code-line top-level">&#125;</div>
1128
- </div>
1129
-
1130
- ## StockMovementType
1131
-
1132
- <div class="graphql-code-block">
1133
-
1134
- <div class="graphql-code-line top-level">enum <span class="graphql-code-identifier">StockMovementType</span> &#123;</div>
1135
- <div class="graphql-code-line ">ADJUSTMENT</div>
1136
- <div class="graphql-code-line ">ALLOCATION</div>
1137
- <div class="graphql-code-line ">RELEASE</div>
1138
- <div class="graphql-code-line ">SALE</div>
1139
- <div class="graphql-code-line ">CANCELLATION</div>
1140
- <div class="graphql-code-line ">RETURN</div>
1141
- <div class="graphql-code-line top-level">&#125;</div>
1142
- </div>
8
+ ## AdjustmentType {#adjustmenttype}
9
+
10
+ <GraphQLDoc
11
+ type="enum"
12
+ typeName="AdjustmentType"
13
+ typeLinks={{}}
14
+ >
15
+ {`enum AdjustmentType {
16
+ PROMOTION
17
+ DISTRIBUTED_ORDER_PROMOTION
18
+ OTHER
19
+ }`}
20
+ </GraphQLDoc>
21
+
22
+ ## AssetType {#assettype}
23
+
24
+ <GraphQLDoc
25
+ type="enum"
26
+ typeName="AssetType"
27
+ typeLinks={{}}
28
+ >
29
+ {`enum AssetType {
30
+ IMAGE
31
+ VIDEO
32
+ BINARY
33
+ }`}
34
+ </GraphQLDoc>
35
+
36
+ ## CurrencyCode {#currencycode}
37
+
38
+ <GraphQLDoc
39
+ type="enum"
40
+ typeName="CurrencyCode"
41
+ typeLinks={{}}
42
+ >
43
+ {`"""ISO 4217 currency code"""
44
+ enum CurrencyCode {
45
+ """United Arab Emirates dirham"""
46
+ AED
47
+ """Afghan afghani"""
48
+ AFN
49
+ """Albanian lek"""
50
+ ALL
51
+ """Armenian dram"""
52
+ AMD
53
+ """Netherlands Antillean guilder"""
54
+ ANG
55
+ """Angolan kwanza"""
56
+ AOA
57
+ """Argentine peso"""
58
+ ARS
59
+ """Australian dollar"""
60
+ AUD
61
+ """Aruban florin"""
62
+ AWG
63
+ """Azerbaijani manat"""
64
+ AZN
65
+ """Bosnia and Herzegovina convertible mark"""
66
+ BAM
67
+ """Barbados dollar"""
68
+ BBD
69
+ """Bangladeshi taka"""
70
+ BDT
71
+ """Bulgarian lev"""
72
+ BGN
73
+ """Bahraini dinar"""
74
+ BHD
75
+ """Burundian franc"""
76
+ BIF
77
+ """Bermudian dollar"""
78
+ BMD
79
+ """Brunei dollar"""
80
+ BND
81
+ """Boliviano"""
82
+ BOB
83
+ """Brazilian real"""
84
+ BRL
85
+ """Bahamian dollar"""
86
+ BSD
87
+ """Bhutanese ngultrum"""
88
+ BTN
89
+ """Botswana pula"""
90
+ BWP
91
+ """Belarusian ruble"""
92
+ BYN
93
+ """Belize dollar"""
94
+ BZD
95
+ """Canadian dollar"""
96
+ CAD
97
+ """Congolese franc"""
98
+ CDF
99
+ """Swiss franc"""
100
+ CHF
101
+ """Chilean peso"""
102
+ CLP
103
+ """Renminbi (Chinese) yuan"""
104
+ CNY
105
+ """Colombian peso"""
106
+ COP
107
+ """Costa Rican colon"""
108
+ CRC
109
+ """Cuban convertible peso"""
110
+ CUC
111
+ """Cuban peso"""
112
+ CUP
113
+ """Cape Verde escudo"""
114
+ CVE
115
+ """Czech koruna"""
116
+ CZK
117
+ """Djiboutian franc"""
118
+ DJF
119
+ """Danish krone"""
120
+ DKK
121
+ """Dominican peso"""
122
+ DOP
123
+ """Algerian dinar"""
124
+ DZD
125
+ """Egyptian pound"""
126
+ EGP
127
+ """Eritrean nakfa"""
128
+ ERN
129
+ """Ethiopian birr"""
130
+ ETB
131
+ """Euro"""
132
+ EUR
133
+ """Fiji dollar"""
134
+ FJD
135
+ """Falkland Islands pound"""
136
+ FKP
137
+ """Pound sterling"""
138
+ GBP
139
+ """Georgian lari"""
140
+ GEL
141
+ """Ghanaian cedi"""
142
+ GHS
143
+ """Gibraltar pound"""
144
+ GIP
145
+ """Gambian dalasi"""
146
+ GMD
147
+ """Guinean franc"""
148
+ GNF
149
+ """Guatemalan quetzal"""
150
+ GTQ
151
+ """Guyanese dollar"""
152
+ GYD
153
+ """Hong Kong dollar"""
154
+ HKD
155
+ """Honduran lempira"""
156
+ HNL
157
+ """Croatian kuna"""
158
+ HRK
159
+ """Haitian gourde"""
160
+ HTG
161
+ """Hungarian forint"""
162
+ HUF
163
+ """Indonesian rupiah"""
164
+ IDR
165
+ """Israeli new shekel"""
166
+ ILS
167
+ """Indian rupee"""
168
+ INR
169
+ """Iraqi dinar"""
170
+ IQD
171
+ """Iranian rial"""
172
+ IRR
173
+ """Icelandic króna"""
174
+ ISK
175
+ """Jamaican dollar"""
176
+ JMD
177
+ """Jordanian dinar"""
178
+ JOD
179
+ """Japanese yen"""
180
+ JPY
181
+ """Kenyan shilling"""
182
+ KES
183
+ """Kyrgyzstani som"""
184
+ KGS
185
+ """Cambodian riel"""
186
+ KHR
187
+ """Comoro franc"""
188
+ KMF
189
+ """North Korean won"""
190
+ KPW
191
+ """South Korean won"""
192
+ KRW
193
+ """Kuwaiti dinar"""
194
+ KWD
195
+ """Cayman Islands dollar"""
196
+ KYD
197
+ """Kazakhstani tenge"""
198
+ KZT
199
+ """Lao kip"""
200
+ LAK
201
+ """Lebanese pound"""
202
+ LBP
203
+ """Sri Lankan rupee"""
204
+ LKR
205
+ """Liberian dollar"""
206
+ LRD
207
+ """Lesotho loti"""
208
+ LSL
209
+ """Libyan dinar"""
210
+ LYD
211
+ """Moroccan dirham"""
212
+ MAD
213
+ """Moldovan leu"""
214
+ MDL
215
+ """Malagasy ariary"""
216
+ MGA
217
+ """Macedonian denar"""
218
+ MKD
219
+ """Myanmar kyat"""
220
+ MMK
221
+ """Mongolian tögrög"""
222
+ MNT
223
+ """Macanese pataca"""
224
+ MOP
225
+ """Mauritanian ouguiya"""
226
+ MRU
227
+ """Mauritian rupee"""
228
+ MUR
229
+ """Maldivian rufiyaa"""
230
+ MVR
231
+ """Malawian kwacha"""
232
+ MWK
233
+ """Mexican peso"""
234
+ MXN
235
+ """Malaysian ringgit"""
236
+ MYR
237
+ """Mozambican metical"""
238
+ MZN
239
+ """Namibian dollar"""
240
+ NAD
241
+ """Nigerian naira"""
242
+ NGN
243
+ """Nicaraguan córdoba"""
244
+ NIO
245
+ """Norwegian krone"""
246
+ NOK
247
+ """Nepalese rupee"""
248
+ NPR
249
+ """New Zealand dollar"""
250
+ NZD
251
+ """Omani rial"""
252
+ OMR
253
+ """Panamanian balboa"""
254
+ PAB
255
+ """Peruvian sol"""
256
+ PEN
257
+ """Papua New Guinean kina"""
258
+ PGK
259
+ """Philippine peso"""
260
+ PHP
261
+ """Pakistani rupee"""
262
+ PKR
263
+ """Polish złoty"""
264
+ PLN
265
+ """Paraguayan guaraní"""
266
+ PYG
267
+ """Qatari riyal"""
268
+ QAR
269
+ """Romanian leu"""
270
+ RON
271
+ """Serbian dinar"""
272
+ RSD
273
+ """Russian ruble"""
274
+ RUB
275
+ """Rwandan franc"""
276
+ RWF
277
+ """Saudi riyal"""
278
+ SAR
279
+ """Solomon Islands dollar"""
280
+ SBD
281
+ """Seychelles rupee"""
282
+ SCR
283
+ """Sudanese pound"""
284
+ SDG
285
+ """Swedish krona/kronor"""
286
+ SEK
287
+ """Singapore dollar"""
288
+ SGD
289
+ """Saint Helena pound"""
290
+ SHP
291
+ """Sierra Leonean leone"""
292
+ SLL
293
+ """Somali shilling"""
294
+ SOS
295
+ """Surinamese dollar"""
296
+ SRD
297
+ """South Sudanese pound"""
298
+ SSP
299
+ """São Tomé and Príncipe dobra"""
300
+ STN
301
+ """Salvadoran colón"""
302
+ SVC
303
+ """Syrian pound"""
304
+ SYP
305
+ """Swazi lilangeni"""
306
+ SZL
307
+ """Thai baht"""
308
+ THB
309
+ """Tajikistani somoni"""
310
+ TJS
311
+ """Turkmenistan manat"""
312
+ TMT
313
+ """Tunisian dinar"""
314
+ TND
315
+ """Tongan paʻanga"""
316
+ TOP
317
+ """Turkish lira"""
318
+ TRY
319
+ """Trinidad and Tobago dollar"""
320
+ TTD
321
+ """New Taiwan dollar"""
322
+ TWD
323
+ """Tanzanian shilling"""
324
+ TZS
325
+ """Ukrainian hryvnia"""
326
+ UAH
327
+ """Ugandan shilling"""
328
+ UGX
329
+ """United States dollar"""
330
+ USD
331
+ """Uruguayan peso"""
332
+ UYU
333
+ """Uzbekistan som"""
334
+ UZS
335
+ """Venezuelan bolívar soberano"""
336
+ VES
337
+ """Vietnamese đồng"""
338
+ VND
339
+ """Vanuatu vatu"""
340
+ VUV
341
+ """Samoan tala"""
342
+ WST
343
+ """CFA franc BEAC"""
344
+ XAF
345
+ """East Caribbean dollar"""
346
+ XCD
347
+ """CFA franc BCEAO"""
348
+ XOF
349
+ """CFP franc (franc Pacifique)"""
350
+ XPF
351
+ """Yemeni rial"""
352
+ YER
353
+ """South African rand"""
354
+ ZAR
355
+ """Zambian kwacha"""
356
+ ZMW
357
+ """Zimbabwean dollar"""
358
+ ZWL
359
+ }`}
360
+ </GraphQLDoc>
361
+
362
+ ## DeletionResult {#deletionresult}
363
+
364
+ <GraphQLDoc
365
+ type="enum"
366
+ typeName="DeletionResult"
367
+ typeLinks={{}}
368
+ >
369
+ {`enum DeletionResult {
370
+ """The entity was successfully deleted"""
371
+ DELETED
372
+ """Deletion did not take place, reason given in message"""
373
+ NOT_DELETED
374
+ }`}
375
+ </GraphQLDoc>
376
+
377
+ ## ErrorCode {#errorcode}
378
+
379
+ <GraphQLDoc
380
+ type="enum"
381
+ typeName="ErrorCode"
382
+ typeLinks={{}}
383
+ >
384
+ {`enum ErrorCode {
385
+ UNKNOWN_ERROR
386
+ MIME_TYPE_ERROR
387
+ LANGUAGE_NOT_AVAILABLE_ERROR
388
+ DUPLICATE_ENTITY_ERROR
389
+ FACET_IN_USE_ERROR
390
+ CHANNEL_DEFAULT_LANGUAGE_ERROR
391
+ SETTLE_PAYMENT_ERROR
392
+ CANCEL_PAYMENT_ERROR
393
+ EMPTY_ORDER_LINE_SELECTION_ERROR
394
+ ITEMS_ALREADY_FULFILLED_ERROR
395
+ INVALID_FULFILLMENT_HANDLER_ERROR
396
+ CREATE_FULFILLMENT_ERROR
397
+ INSUFFICIENT_STOCK_ON_HAND_ERROR
398
+ MULTIPLE_ORDER_ERROR
399
+ CANCEL_ACTIVE_ORDER_ERROR
400
+ PAYMENT_ORDER_MISMATCH_ERROR
401
+ REFUND_ORDER_STATE_ERROR
402
+ NOTHING_TO_REFUND_ERROR
403
+ ALREADY_REFUNDED_ERROR
404
+ QUANTITY_TOO_GREAT_ERROR
405
+ REFUND_AMOUNT_ERROR
406
+ REFUND_STATE_TRANSITION_ERROR
407
+ PAYMENT_STATE_TRANSITION_ERROR
408
+ FULFILLMENT_STATE_TRANSITION_ERROR
409
+ ORDER_MODIFICATION_STATE_ERROR
410
+ NO_CHANGES_SPECIFIED_ERROR
411
+ PAYMENT_METHOD_MISSING_ERROR
412
+ REFUND_PAYMENT_ID_MISSING_ERROR
413
+ MANUAL_PAYMENT_STATE_ERROR
414
+ PRODUCT_OPTION_IN_USE_ERROR
415
+ MISSING_CONDITIONS_ERROR
416
+ NATIVE_AUTH_STRATEGY_ERROR
417
+ INVALID_CREDENTIALS_ERROR
418
+ ORDER_STATE_TRANSITION_ERROR
419
+ EMAIL_ADDRESS_CONFLICT_ERROR
420
+ GUEST_CHECKOUT_ERROR
421
+ ORDER_LIMIT_ERROR
422
+ NEGATIVE_QUANTITY_ERROR
423
+ INSUFFICIENT_STOCK_ERROR
424
+ COUPON_CODE_INVALID_ERROR
425
+ COUPON_CODE_EXPIRED_ERROR
426
+ COUPON_CODE_LIMIT_ERROR
427
+ ORDER_MODIFICATION_ERROR
428
+ INELIGIBLE_SHIPPING_METHOD_ERROR
429
+ NO_ACTIVE_ORDER_ERROR
430
+ ORDER_INTERCEPTOR_ERROR
431
+ }`}
432
+ </GraphQLDoc>
433
+
434
+ ## GlobalFlag {#globalflag}
435
+
436
+ <GraphQLDoc
437
+ type="enum"
438
+ typeName="GlobalFlag"
439
+ typeLinks={{}}
440
+ >
441
+ {`enum GlobalFlag {
442
+ TRUE
443
+ FALSE
444
+ INHERIT
445
+ }`}
446
+ </GraphQLDoc>
447
+
448
+ ## HistoryEntryType {#historyentrytype}
449
+
450
+ <GraphQLDoc
451
+ type="enum"
452
+ typeName="HistoryEntryType"
453
+ typeLinks={{}}
454
+ >
455
+ {`enum HistoryEntryType {
456
+ CUSTOMER_REGISTERED
457
+ CUSTOMER_VERIFIED
458
+ CUSTOMER_DETAIL_UPDATED
459
+ CUSTOMER_ADDED_TO_GROUP
460
+ CUSTOMER_REMOVED_FROM_GROUP
461
+ CUSTOMER_ADDRESS_CREATED
462
+ CUSTOMER_ADDRESS_UPDATED
463
+ CUSTOMER_ADDRESS_DELETED
464
+ CUSTOMER_PASSWORD_UPDATED
465
+ CUSTOMER_PASSWORD_RESET_REQUESTED
466
+ CUSTOMER_PASSWORD_RESET_VERIFIED
467
+ CUSTOMER_EMAIL_UPDATE_REQUESTED
468
+ CUSTOMER_EMAIL_UPDATE_VERIFIED
469
+ CUSTOMER_NOTE
470
+ ORDER_STATE_TRANSITION
471
+ ORDER_PAYMENT_TRANSITION
472
+ ORDER_FULFILLMENT
473
+ ORDER_CANCELLATION
474
+ ORDER_REFUND_TRANSITION
475
+ ORDER_FULFILLMENT_TRANSITION
476
+ ORDER_NOTE
477
+ ORDER_COUPON_APPLIED
478
+ ORDER_COUPON_REMOVED
479
+ ORDER_MODIFIED
480
+ ORDER_CUSTOMER_UPDATED
481
+ }`}
482
+ </GraphQLDoc>
483
+
484
+ ## JobState {#jobstate}
485
+
486
+ <GraphQLDoc
487
+ type="enum"
488
+ typeName="JobState"
489
+ typeLinks={{}}
490
+ >
491
+ {`"""The state of a Job in the JobQueue"""
492
+ enum JobState {
493
+ PENDING
494
+ RUNNING
495
+ COMPLETED
496
+ RETRYING
497
+ FAILED
498
+ CANCELLED
499
+ }`}
500
+ </GraphQLDoc>
501
+
502
+ ## LanguageCode {#languagecode}
503
+
504
+ <GraphQLDoc
505
+ type="enum"
506
+ typeName="LanguageCode"
507
+ typeLinks={{}}
508
+ >
509
+ {`"""
510
+ Languages in the form of a ISO 639-1 language code with optional
511
+ region or script modifier (e.g. de_AT). The selection available is based
512
+ on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
513
+ and includes the major spoken languages of the world and any widely-used variants.
514
+ """
515
+ enum LanguageCode {
516
+ """Afrikaans"""
517
+ af
518
+ """Akan"""
519
+ ak
520
+ """Albanian"""
521
+ sq
522
+ """Amharic"""
523
+ am
524
+ """Arabic"""
525
+ ar
526
+ """Armenian"""
527
+ hy
528
+ """Assamese"""
529
+ as
530
+ """Azerbaijani"""
531
+ az
532
+ """Bambara"""
533
+ bm
534
+ """Bangla"""
535
+ bn
536
+ """Basque"""
537
+ eu
538
+ """Belarusian"""
539
+ be
540
+ """Bosnian"""
541
+ bs
542
+ """Breton"""
543
+ br
544
+ """Bulgarian"""
545
+ bg
546
+ """Burmese"""
547
+ my
548
+ """Catalan"""
549
+ ca
550
+ """Chechen"""
551
+ ce
552
+ """Chinese"""
553
+ zh
554
+ """Simplified Chinese"""
555
+ zh_Hans
556
+ """Traditional Chinese"""
557
+ zh_Hant
558
+ """Church Slavic"""
559
+ cu
560
+ """Cornish"""
561
+ kw
562
+ """Corsican"""
563
+ co
564
+ """Croatian"""
565
+ hr
566
+ """Czech"""
567
+ cs
568
+ """Danish"""
569
+ da
570
+ """Dutch"""
571
+ nl
572
+ """Flemish"""
573
+ nl_BE
574
+ """Dzongkha"""
575
+ dz
576
+ """English"""
577
+ en
578
+ """Australian English"""
579
+ en_AU
580
+ """Canadian English"""
581
+ en_CA
582
+ """British English"""
583
+ en_GB
584
+ """American English"""
585
+ en_US
586
+ """Esperanto"""
587
+ eo
588
+ """Estonian"""
589
+ et
590
+ """Ewe"""
591
+ ee
592
+ """Faroese"""
593
+ fo
594
+ """Finnish"""
595
+ fi
596
+ """French"""
597
+ fr
598
+ """Canadian French"""
599
+ fr_CA
600
+ """Swiss French"""
601
+ fr_CH
602
+ """Fulah"""
603
+ ff
604
+ """Galician"""
605
+ gl
606
+ """Ganda"""
607
+ lg
608
+ """Georgian"""
609
+ ka
610
+ """German"""
611
+ de
612
+ """Austrian German"""
613
+ de_AT
614
+ """Swiss High German"""
615
+ de_CH
616
+ """Greek"""
617
+ el
618
+ """Gujarati"""
619
+ gu
620
+ """Haitian Creole"""
621
+ ht
622
+ """Hausa"""
623
+ ha
624
+ """Hebrew"""
625
+ he
626
+ """Hindi"""
627
+ hi
628
+ """Hungarian"""
629
+ hu
630
+ """Icelandic"""
631
+ is
632
+ """Igbo"""
633
+ ig
634
+ """Indonesian"""
635
+ id
636
+ """Interlingua"""
637
+ ia
638
+ """Irish"""
639
+ ga
640
+ """Italian"""
641
+ it
642
+ """Japanese"""
643
+ ja
644
+ """Javanese"""
645
+ jv
646
+ """Kalaallisut"""
647
+ kl
648
+ """Kannada"""
649
+ kn
650
+ """Kashmiri"""
651
+ ks
652
+ """Kazakh"""
653
+ kk
654
+ """Khmer"""
655
+ km
656
+ """Kikuyu"""
657
+ ki
658
+ """Kinyarwanda"""
659
+ rw
660
+ """Korean"""
661
+ ko
662
+ """Kurdish"""
663
+ ku
664
+ """Kyrgyz"""
665
+ ky
666
+ """Lao"""
667
+ lo
668
+ """Latin"""
669
+ la
670
+ """Latvian"""
671
+ lv
672
+ """Lingala"""
673
+ ln
674
+ """Lithuanian"""
675
+ lt
676
+ """Luba-Katanga"""
677
+ lu
678
+ """Luxembourgish"""
679
+ lb
680
+ """Macedonian"""
681
+ mk
682
+ """Malagasy"""
683
+ mg
684
+ """Malay"""
685
+ ms
686
+ """Malayalam"""
687
+ ml
688
+ """Maltese"""
689
+ mt
690
+ """Manx"""
691
+ gv
692
+ """Maori"""
693
+ mi
694
+ """Marathi"""
695
+ mr
696
+ """Mongolian"""
697
+ mn
698
+ """Nepali"""
699
+ ne
700
+ """North Ndebele"""
701
+ nd
702
+ """Northern Sami"""
703
+ se
704
+ """Norwegian Bokmål"""
705
+ nb
706
+ """Norwegian Nynorsk"""
707
+ nn
708
+ """Nyanja"""
709
+ ny
710
+ """Odia"""
711
+ or
712
+ """Oromo"""
713
+ om
714
+ """Ossetic"""
715
+ os
716
+ """Pashto"""
717
+ ps
718
+ """Persian"""
719
+ fa
720
+ """Dari"""
721
+ fa_AF
722
+ """Polish"""
723
+ pl
724
+ """Portuguese"""
725
+ pt
726
+ """Brazilian Portuguese"""
727
+ pt_BR
728
+ """European Portuguese"""
729
+ pt_PT
730
+ """Punjabi"""
731
+ pa
732
+ """Quechua"""
733
+ qu
734
+ """Romanian"""
735
+ ro
736
+ """Moldavian"""
737
+ ro_MD
738
+ """Romansh"""
739
+ rm
740
+ """Rundi"""
741
+ rn
742
+ """Russian"""
743
+ ru
744
+ """Samoan"""
745
+ sm
746
+ """Sango"""
747
+ sg
748
+ """Sanskrit"""
749
+ sa
750
+ """Scottish Gaelic"""
751
+ gd
752
+ """Serbian"""
753
+ sr
754
+ """Shona"""
755
+ sn
756
+ """Sichuan Yi"""
757
+ ii
758
+ """Sindhi"""
759
+ sd
760
+ """Sinhala"""
761
+ si
762
+ """Slovak"""
763
+ sk
764
+ """Slovenian"""
765
+ sl
766
+ """Somali"""
767
+ so
768
+ """Southern Sotho"""
769
+ st
770
+ """Spanish"""
771
+ es
772
+ """European Spanish"""
773
+ es_ES
774
+ """Mexican Spanish"""
775
+ es_MX
776
+ """Sundanese"""
777
+ su
778
+ """Swahili"""
779
+ sw
780
+ """Congo Swahili"""
781
+ sw_CD
782
+ """Swedish"""
783
+ sv
784
+ """Tajik"""
785
+ tg
786
+ """Tamil"""
787
+ ta
788
+ """Tatar"""
789
+ tt
790
+ """Telugu"""
791
+ te
792
+ """Thai"""
793
+ th
794
+ """Tibetan"""
795
+ bo
796
+ """Tigrinya"""
797
+ ti
798
+ """Tongan"""
799
+ to
800
+ """Turkish"""
801
+ tr
802
+ """Turkmen"""
803
+ tk
804
+ """Ukrainian"""
805
+ uk
806
+ """Urdu"""
807
+ ur
808
+ """Uyghur"""
809
+ ug
810
+ """Uzbek"""
811
+ uz
812
+ """Vietnamese"""
813
+ vi
814
+ """Volapük"""
815
+ vo
816
+ """Welsh"""
817
+ cy
818
+ """Western Frisian"""
819
+ fy
820
+ """Wolof"""
821
+ wo
822
+ """Xhosa"""
823
+ xh
824
+ """Yiddish"""
825
+ yi
826
+ """Yoruba"""
827
+ yo
828
+ """Zulu"""
829
+ zu
830
+ }`}
831
+ </GraphQLDoc>
832
+
833
+ ## LogicalOperator {#logicaloperator}
834
+
835
+ <GraphQLDoc
836
+ type="enum"
837
+ typeName="LogicalOperator"
838
+ typeLinks={{}}
839
+ >
840
+ {`enum LogicalOperator {
841
+ AND
842
+ OR
843
+ }`}
844
+ </GraphQLDoc>
845
+
846
+ ## MetricInterval {#metricinterval}
847
+
848
+ <GraphQLDoc
849
+ type="enum"
850
+ typeName="MetricInterval"
851
+ typeLinks={{}}
852
+ >
853
+ {`enum MetricInterval {
854
+ Daily
855
+ }`}
856
+ </GraphQLDoc>
857
+
858
+ ## MetricType {#metrictype}
859
+
860
+ <GraphQLDoc
861
+ type="enum"
862
+ typeName="MetricType"
863
+ typeLinks={{}}
864
+ >
865
+ {`enum MetricType {
866
+ OrderCount
867
+ OrderTotal
868
+ AverageOrderValue
869
+ }`}
870
+ </GraphQLDoc>
871
+
872
+ ## OrderType {#ordertype}
873
+
874
+ <GraphQLDoc
875
+ type="enum"
876
+ typeName="OrderType"
877
+ typeLinks={{}}
878
+ >
879
+ {`enum OrderType {
880
+ Regular
881
+ Seller
882
+ Aggregate
883
+ }`}
884
+ </GraphQLDoc>
885
+
886
+ ## Permission {#permission}
887
+
888
+ <GraphQLDoc
889
+ type="enum"
890
+ typeName="Permission"
891
+ typeLinks={{}}
892
+ >
893
+ {`"""
894
+ Permissions for administrators and customers. Used to control access to
895
+ GraphQL resolvers via the {@link Allow} decorator.
896
+
897
+ ## Understanding Permission.Owner
898
+
899
+ \`Permission.Owner\` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only
900
+ be accessible to the "owner" of that resource.
901
+
902
+ For example, the Shop API \`activeCustomer\` query resolver should only return the Customer object for the "owner" of that Customer, i.e.
903
+ based on the activeUserId of the current session. As a result, the resolver code looks like this:
904
+
905
+ @example
906
+ \`\`\`TypeScript
907
+ \@Query()
908
+ \@Allow(Permission.Owner)
909
+ async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {
910
+ const userId = ctx.activeUserId;
911
+ if (userId) {
912
+ return this.customerService.findOneByUserId(ctx, userId);
913
+ }
914
+ }
915
+ \`\`\`
916
+
917
+ Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally
918
+ nor statically encoded at build-time, any resolvers using \`Permission.Owner\` **must** include logic to enforce that only the owner
919
+ of the resource has access. If not, then it is the equivalent of using \`Permission.Public\`.
920
+ """
921
+ enum Permission {
922
+ """Authenticated means simply that the user is logged in"""
923
+ Authenticated
924
+ """SuperAdmin has unrestricted access to all operations"""
925
+ SuperAdmin
926
+ """Owner means the user owns this entity, e.g. a Customer's own Order"""
927
+ Owner
928
+ """Public means any unauthenticated user may perform the operation"""
929
+ Public
930
+ """Grants permission to update GlobalSettings"""
931
+ UpdateGlobalSettings
932
+ """Grants permission to create Products, Facets, Assets, Collections"""
933
+ CreateCatalog
934
+ """Grants permission to read Products, Facets, Assets, Collections"""
935
+ ReadCatalog
936
+ """Grants permission to update Products, Facets, Assets, Collections"""
937
+ UpdateCatalog
938
+ """Grants permission to delete Products, Facets, Assets, Collections"""
939
+ DeleteCatalog
940
+ """Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""
941
+ CreateSettings
942
+ """Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""
943
+ ReadSettings
944
+ """Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""
945
+ UpdateSettings
946
+ """Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""
947
+ DeleteSettings
948
+ """Grants permission to create Administrator"""
949
+ CreateAdministrator
950
+ """Grants permission to read Administrator"""
951
+ ReadAdministrator
952
+ """Grants permission to update Administrator"""
953
+ UpdateAdministrator
954
+ """Grants permission to delete Administrator"""
955
+ DeleteAdministrator
956
+ """Grants permission to create Asset"""
957
+ CreateAsset
958
+ """Grants permission to read Asset"""
959
+ ReadAsset
960
+ """Grants permission to update Asset"""
961
+ UpdateAsset
962
+ """Grants permission to delete Asset"""
963
+ DeleteAsset
964
+ """Grants permission to create Channel"""
965
+ CreateChannel
966
+ """Grants permission to read Channel"""
967
+ ReadChannel
968
+ """Grants permission to update Channel"""
969
+ UpdateChannel
970
+ """Grants permission to delete Channel"""
971
+ DeleteChannel
972
+ """Grants permission to create Collection"""
973
+ CreateCollection
974
+ """Grants permission to read Collection"""
975
+ ReadCollection
976
+ """Grants permission to update Collection"""
977
+ UpdateCollection
978
+ """Grants permission to delete Collection"""
979
+ DeleteCollection
980
+ """Grants permission to create Country"""
981
+ CreateCountry
982
+ """Grants permission to read Country"""
983
+ ReadCountry
984
+ """Grants permission to update Country"""
985
+ UpdateCountry
986
+ """Grants permission to delete Country"""
987
+ DeleteCountry
988
+ """Grants permission to create Customer"""
989
+ CreateCustomer
990
+ """Grants permission to read Customer"""
991
+ ReadCustomer
992
+ """Grants permission to update Customer"""
993
+ UpdateCustomer
994
+ """Grants permission to delete Customer"""
995
+ DeleteCustomer
996
+ """Grants permission to create CustomerGroup"""
997
+ CreateCustomerGroup
998
+ """Grants permission to read CustomerGroup"""
999
+ ReadCustomerGroup
1000
+ """Grants permission to update CustomerGroup"""
1001
+ UpdateCustomerGroup
1002
+ """Grants permission to delete CustomerGroup"""
1003
+ DeleteCustomerGroup
1004
+ """Grants permission to create Facet"""
1005
+ CreateFacet
1006
+ """Grants permission to read Facet"""
1007
+ ReadFacet
1008
+ """Grants permission to update Facet"""
1009
+ UpdateFacet
1010
+ """Grants permission to delete Facet"""
1011
+ DeleteFacet
1012
+ """Grants permission to create Order"""
1013
+ CreateOrder
1014
+ """Grants permission to read Order"""
1015
+ ReadOrder
1016
+ """Grants permission to update Order"""
1017
+ UpdateOrder
1018
+ """Grants permission to delete Order"""
1019
+ DeleteOrder
1020
+ """Grants permission to create PaymentMethod"""
1021
+ CreatePaymentMethod
1022
+ """Grants permission to read PaymentMethod"""
1023
+ ReadPaymentMethod
1024
+ """Grants permission to update PaymentMethod"""
1025
+ UpdatePaymentMethod
1026
+ """Grants permission to delete PaymentMethod"""
1027
+ DeletePaymentMethod
1028
+ """Grants permission to create Product"""
1029
+ CreateProduct
1030
+ """Grants permission to read Product"""
1031
+ ReadProduct
1032
+ """Grants permission to update Product"""
1033
+ UpdateProduct
1034
+ """Grants permission to delete Product"""
1035
+ DeleteProduct
1036
+ """Grants permission to create Promotion"""
1037
+ CreatePromotion
1038
+ """Grants permission to read Promotion"""
1039
+ ReadPromotion
1040
+ """Grants permission to update Promotion"""
1041
+ UpdatePromotion
1042
+ """Grants permission to delete Promotion"""
1043
+ DeletePromotion
1044
+ """Grants permission to create ShippingMethod"""
1045
+ CreateShippingMethod
1046
+ """Grants permission to read ShippingMethod"""
1047
+ ReadShippingMethod
1048
+ """Grants permission to update ShippingMethod"""
1049
+ UpdateShippingMethod
1050
+ """Grants permission to delete ShippingMethod"""
1051
+ DeleteShippingMethod
1052
+ """Grants permission to create Tag"""
1053
+ CreateTag
1054
+ """Grants permission to read Tag"""
1055
+ ReadTag
1056
+ """Grants permission to update Tag"""
1057
+ UpdateTag
1058
+ """Grants permission to delete Tag"""
1059
+ DeleteTag
1060
+ """Grants permission to create TaxCategory"""
1061
+ CreateTaxCategory
1062
+ """Grants permission to read TaxCategory"""
1063
+ ReadTaxCategory
1064
+ """Grants permission to update TaxCategory"""
1065
+ UpdateTaxCategory
1066
+ """Grants permission to delete TaxCategory"""
1067
+ DeleteTaxCategory
1068
+ """Grants permission to create TaxRate"""
1069
+ CreateTaxRate
1070
+ """Grants permission to read TaxRate"""
1071
+ ReadTaxRate
1072
+ """Grants permission to update TaxRate"""
1073
+ UpdateTaxRate
1074
+ """Grants permission to delete TaxRate"""
1075
+ DeleteTaxRate
1076
+ """Grants permission to create Seller"""
1077
+ CreateSeller
1078
+ """Grants permission to read Seller"""
1079
+ ReadSeller
1080
+ """Grants permission to update Seller"""
1081
+ UpdateSeller
1082
+ """Grants permission to delete Seller"""
1083
+ DeleteSeller
1084
+ """Grants permission to create StockLocation"""
1085
+ CreateStockLocation
1086
+ """Grants permission to read StockLocation"""
1087
+ ReadStockLocation
1088
+ """Grants permission to update StockLocation"""
1089
+ UpdateStockLocation
1090
+ """Grants permission to delete StockLocation"""
1091
+ DeleteStockLocation
1092
+ """Grants permission to create System"""
1093
+ CreateSystem
1094
+ """Grants permission to read System"""
1095
+ ReadSystem
1096
+ """Grants permission to update System"""
1097
+ UpdateSystem
1098
+ """Grants permission to delete System"""
1099
+ DeleteSystem
1100
+ """Grants permission to create Zone"""
1101
+ CreateZone
1102
+ """Grants permission to read Zone"""
1103
+ ReadZone
1104
+ """Grants permission to update Zone"""
1105
+ UpdateZone
1106
+ """Grants permission to delete Zone"""
1107
+ DeleteZone
1108
+ }`}
1109
+ </GraphQLDoc>
1110
+
1111
+ ## SortOrder {#sortorder}
1112
+
1113
+ <GraphQLDoc
1114
+ type="enum"
1115
+ typeName="SortOrder"
1116
+ typeLinks={{}}
1117
+ >
1118
+ {`enum SortOrder {
1119
+ ASC
1120
+ DESC
1121
+ }`}
1122
+ </GraphQLDoc>
1123
+
1124
+ ## StockMovementType {#stockmovementtype}
1125
+
1126
+ <GraphQLDoc
1127
+ type="enum"
1128
+ typeName="StockMovementType"
1129
+ typeLinks={{}}
1130
+ >
1131
+ {`enum StockMovementType {
1132
+ ADJUSTMENT
1133
+ ALLOCATION
1134
+ RELEASE
1135
+ SALE
1136
+ CANCELLATION
1137
+ RETURN
1138
+ }`}
1139
+ </GraphQLDoc>