@vendure/docs 0.0.0-202601161541

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 (968) hide show
  1. package/dist/index.d.ts +3 -0
  2. package/dist/index.d.ts.map +1 -0
  3. package/dist/index.js +2 -0
  4. package/dist/index.js.map +1 -0
  5. package/dist/manifest.d.ts +3 -0
  6. package/dist/manifest.d.ts.map +1 -0
  7. package/dist/manifest.js +857 -0
  8. package/dist/manifest.js.map +1 -0
  9. package/docs/guides/core-concepts/auth/admin-role.webp +0 -0
  10. package/docs/guides/core-concepts/auth/admin.webp +0 -0
  11. package/docs/guides/core-concepts/auth/customer.webp +0 -0
  12. package/docs/guides/core-concepts/auth/index.md +557 -0
  13. package/docs/guides/core-concepts/auth/roles.webp +0 -0
  14. package/docs/guides/core-concepts/channels/channel-token.webp +0 -0
  15. package/docs/guides/core-concepts/channels/channels.webp +0 -0
  16. package/docs/guides/core-concepts/channels/channels_currencies_diagram.png +0 -0
  17. package/docs/guides/core-concepts/channels/channels_diagram.png +0 -0
  18. package/docs/guides/core-concepts/channels/channels_prices_diagram.png +0 -0
  19. package/docs/guides/core-concepts/channels/default-currency.webp +0 -0
  20. package/docs/guides/core-concepts/channels/index.md +154 -0
  21. package/docs/guides/core-concepts/channels/variant-prices.webp +0 -0
  22. package/docs/guides/core-concepts/collections/collection-filters.webp +0 -0
  23. package/docs/guides/core-concepts/collections/collections.webp +0 -0
  24. package/docs/guides/core-concepts/collections/filter-inheritance.webp +0 -0
  25. package/docs/guides/core-concepts/collections/index.mdx +125 -0
  26. package/docs/guides/core-concepts/customers/customer.webp +0 -0
  27. package/docs/guides/core-concepts/customers/index.mdx +21 -0
  28. package/docs/guides/core-concepts/email/email-plugin-flow.webp +0 -0
  29. package/docs/guides/core-concepts/email/index.mdx +155 -0
  30. package/docs/guides/core-concepts/images-assets/asset-flow.webp +0 -0
  31. package/docs/guides/core-concepts/images-assets/asset-tags.webp +0 -0
  32. package/docs/guides/core-concepts/images-assets/index.mdx +42 -0
  33. package/docs/guides/core-concepts/money/index.mdx +246 -0
  34. package/docs/guides/core-concepts/orders/custom-order-ui.webp +0 -0
  35. package/docs/guides/core-concepts/orders/index.md +366 -0
  36. package/docs/guides/core-concepts/orders/order-process.webp +0 -0
  37. package/docs/guides/core-concepts/orders/order.webp +0 -0
  38. package/docs/guides/core-concepts/payment/index.md +410 -0
  39. package/docs/guides/core-concepts/payment/payment-method.webp +0 -0
  40. package/docs/guides/core-concepts/payment/payment_sequence_one_step.png +0 -0
  41. package/docs/guides/core-concepts/payment/payment_sequence_two_step.png +0 -0
  42. package/docs/guides/core-concepts/products/facets.webp +0 -0
  43. package/docs/guides/core-concepts/products/index.mdx +59 -0
  44. package/docs/guides/core-concepts/products/product-relations.webp +0 -0
  45. package/docs/guides/core-concepts/products/products-variants.webp +0 -0
  46. package/docs/guides/core-concepts/promotions/index.md +324 -0
  47. package/docs/guides/core-concepts/shipping/index.md +225 -0
  48. package/docs/guides/core-concepts/shipping/shipping-method.webp +0 -0
  49. package/docs/guides/core-concepts/stock-control/global-stock-control.webp +0 -0
  50. package/docs/guides/core-concepts/stock-control/index.md +233 -0
  51. package/docs/guides/core-concepts/stock-control/stock-levels.webp +0 -0
  52. package/docs/guides/core-concepts/taxes/index.mdx +76 -0
  53. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/01-create-space.webp +0 -0
  54. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/02-space-access-keys.webp +0 -0
  55. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/03-create-app.webp +0 -0
  56. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/04-configure-server.webp +0 -0
  57. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/05-open-server-settings.webp +0 -0
  58. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/06-admin-app-route.webp +0 -0
  59. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/07-open-app.webp +0 -0
  60. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/deploy-to-do-app-platform.webp +0 -0
  61. package/docs/guides/deployment/deploy-to-digital-ocean-app-platform/index.md +246 -0
  62. package/docs/guides/deployment/deploy-to-google-cloud-run/deploy-to-gcr.webp +0 -0
  63. package/docs/guides/deployment/deploy-to-google-cloud-run/index.md +53 -0
  64. package/docs/guides/deployment/deploy-to-northflank/01-create-template-screen.webp +0 -0
  65. package/docs/guides/deployment/deploy-to-northflank/02-paste-config.webp +0 -0
  66. package/docs/guides/deployment/deploy-to-northflank/03-run-template.webp +0 -0
  67. package/docs/guides/deployment/deploy-to-northflank/04-find-project.webp +0 -0
  68. package/docs/guides/deployment/deploy-to-northflank/05-server-service.webp +0 -0
  69. package/docs/guides/deployment/deploy-to-northflank/06-find-url.webp +0 -0
  70. package/docs/guides/deployment/deploy-to-northflank/deploy-to-northflank.webp +0 -0
  71. package/docs/guides/deployment/deploy-to-northflank/index.md +606 -0
  72. package/docs/guides/deployment/deploy-to-railway/01-new-service.webp +0 -0
  73. package/docs/guides/deployment/deploy-to-railway/02-env-vars.webp +0 -0
  74. package/docs/guides/deployment/deploy-to-railway/03-test-server.webp +0 -0
  75. package/docs/guides/deployment/deploy-to-railway/deploy-to-railway.webp +0 -0
  76. package/docs/guides/deployment/deploy-to-railway/index.md +202 -0
  77. package/docs/guides/deployment/deploy-to-render/01-create-db.webp +0 -0
  78. package/docs/guides/deployment/deploy-to-render/02-env-group.webp +0 -0
  79. package/docs/guides/deployment/deploy-to-render/03-db-connection.webp +0 -0
  80. package/docs/guides/deployment/deploy-to-render/04-link-env-group.webp +0 -0
  81. package/docs/guides/deployment/deploy-to-render/05-server-url.webp +0 -0
  82. package/docs/guides/deployment/deploy-to-render/deploy-to-render.webp +0 -0
  83. package/docs/guides/deployment/deploy-to-render/index.md +221 -0
  84. package/docs/guides/deployment/deploying-admin-ui.md +130 -0
  85. package/docs/guides/deployment/getting-data-into-production.md +50 -0
  86. package/docs/guides/deployment/horizontal-scaling.md +75 -0
  87. package/docs/guides/deployment/production-configuration/env-var-ui.webp +0 -0
  88. package/docs/guides/deployment/production-configuration/index.md +140 -0
  89. package/docs/guides/deployment/server-resource-requirements.md +29 -0
  90. package/docs/guides/deployment/using-docker.md +193 -0
  91. package/docs/guides/developer-guide/cache/cache-service.webp +0 -0
  92. package/docs/guides/developer-guide/cache/index.mdx +327 -0
  93. package/docs/guides/developer-guide/channel-aware/index.md +117 -0
  94. package/docs/guides/developer-guide/cli/add-command.webp +0 -0
  95. package/docs/guides/developer-guide/cli/index.md +418 -0
  96. package/docs/guides/developer-guide/cli/migrate-command.webp +0 -0
  97. package/docs/guides/developer-guide/cli/schema-command.webp +0 -0
  98. package/docs/guides/developer-guide/configuration/index.md +226 -0
  99. package/docs/guides/developer-guide/custom-fields/custom-fields-data-table.webp +0 -0
  100. package/docs/guides/developer-guide/custom-fields/custom-fields-ui.webp +0 -0
  101. package/docs/guides/developer-guide/custom-fields/index.md +1423 -0
  102. package/docs/guides/developer-guide/custom-permissions/index.md +186 -0
  103. package/docs/guides/developer-guide/custom-strategies-in-plugins/index.mdx +467 -0
  104. package/docs/guides/developer-guide/database-entity/index.md +136 -0
  105. package/docs/guides/developer-guide/dataloaders/index.md +137 -0
  106. package/docs/guides/developer-guide/db-subscribers/index.md +115 -0
  107. package/docs/guides/developer-guide/error-handling/index.mdx +324 -0
  108. package/docs/guides/developer-guide/events/index.mdx +406 -0
  109. package/docs/guides/developer-guide/extend-graphql-api/index.md +501 -0
  110. package/docs/guides/developer-guide/has-custom-fields/index.md +174 -0
  111. package/docs/guides/developer-guide/importing-data/index.md +488 -0
  112. package/docs/guides/developer-guide/importing-data/reindex.webp +0 -0
  113. package/docs/guides/developer-guide/logging/index.md +77 -0
  114. package/docs/guides/developer-guide/migrating-from-v1/breaking-api-changes.md +213 -0
  115. package/docs/guides/developer-guide/migrating-from-v1/database-migration.md +39 -0
  116. package/docs/guides/developer-guide/migrating-from-v1/index.md +41 -0
  117. package/docs/guides/developer-guide/migrating-from-v1/storefront-migration.md +30 -0
  118. package/docs/guides/developer-guide/migrations/index.md +197 -0
  119. package/docs/guides/developer-guide/migrations/migration.webp +0 -0
  120. package/docs/guides/developer-guide/nest-devtools/index.md +74 -0
  121. package/docs/guides/developer-guide/nest-devtools/nest-devtools-bootstrap-perf.webp +0 -0
  122. package/docs/guides/developer-guide/nest-devtools/nest-devtools-graph.webp +0 -0
  123. package/docs/guides/developer-guide/overview/Vendure_docs-architecture.webp +0 -0
  124. package/docs/guides/developer-guide/overview/index.md +40 -0
  125. package/docs/guides/developer-guide/plugins/index.mdx +806 -0
  126. package/docs/guides/developer-guide/rest-endpoint/index.md +99 -0
  127. package/docs/guides/developer-guide/scheduled-tasks/index.md +298 -0
  128. package/docs/guides/developer-guide/security/index.md +264 -0
  129. package/docs/guides/developer-guide/settings-store/index.mdx +553 -0
  130. package/docs/guides/developer-guide/stand-alone-scripts/index.md +119 -0
  131. package/docs/guides/developer-guide/strategies-configurable-operations/collection-filters-args.webp +0 -0
  132. package/docs/guides/developer-guide/strategies-configurable-operations/collection-filters.webp +0 -0
  133. package/docs/guides/developer-guide/strategies-configurable-operations/index.mdx +373 -0
  134. package/docs/guides/developer-guide/testing/index.md +254 -0
  135. package/docs/guides/developer-guide/the-api-layer/Vendure_docs-api_request.webp +0 -0
  136. package/docs/guides/developer-guide/the-api-layer/index.mdx +474 -0
  137. package/docs/guides/developer-guide/the-service-layer/index.mdx +311 -0
  138. package/docs/guides/developer-guide/translatable/index.md +224 -0
  139. package/docs/guides/developer-guide/translations/index.md +165 -0
  140. package/docs/guides/developer-guide/updating/index.md +79 -0
  141. package/docs/guides/developer-guide/uploading-files/index.md +220 -0
  142. package/docs/guides/developer-guide/worker-job-queue/Vendure_docs-job-queue-2.webp +0 -0
  143. package/docs/guides/developer-guide/worker-job-queue/Vendure_docs-job-queue-3.webp +0 -0
  144. package/docs/guides/developer-guide/worker-job-queue/Vendure_docs-job-queue.webp +0 -0
  145. package/docs/guides/developer-guide/worker-job-queue/index.mdx +522 -0
  146. package/docs/guides/developer-guide/worker-job-queue/worker-job-queue.webp +0 -0
  147. package/docs/guides/extending-the-admin-ui/add-actions-to-pages/index.md +233 -0
  148. package/docs/guides/extending-the-admin-ui/add-actions-to-pages/ui-extensions-actionbar-dropdown.webp +0 -0
  149. package/docs/guides/extending-the-admin-ui/add-actions-to-pages/ui-extensions-actionbar.webp +0 -0
  150. package/docs/guides/extending-the-admin-ui/adding-ui-translations/index.md +113 -0
  151. package/docs/guides/extending-the-admin-ui/adding-ui-translations/ui-translations-01.webp +0 -0
  152. package/docs/guides/extending-the-admin-ui/admin-ui-theming-branding/index.md +133 -0
  153. package/docs/guides/extending-the-admin-ui/alerts/alerts-01.webp +0 -0
  154. package/docs/guides/extending-the-admin-ui/alerts/index.md +56 -0
  155. package/docs/guides/extending-the-admin-ui/bulk-actions/bulk-actions-screenshot.webp +0 -0
  156. package/docs/guides/extending-the-admin-ui/bulk-actions/index.md +78 -0
  157. package/docs/guides/extending-the-admin-ui/creating-detail-views/index.md +332 -0
  158. package/docs/guides/extending-the-admin-ui/creating-list-views/index.md +331 -0
  159. package/docs/guides/extending-the-admin-ui/custom-data-table-components/custom-data-table-location.webp +0 -0
  160. package/docs/guides/extending-the-admin-ui/custom-data-table-components/custom-data-table.webp +0 -0
  161. package/docs/guides/extending-the-admin-ui/custom-data-table-components/index.md +111 -0
  162. package/docs/guides/extending-the-admin-ui/custom-detail-components/detail-component.webp +0 -0
  163. package/docs/guides/extending-the-admin-ui/custom-detail-components/index.md +198 -0
  164. package/docs/guides/extending-the-admin-ui/custom-form-inputs/index.md +285 -0
  165. package/docs/guides/extending-the-admin-ui/custom-form-inputs/ui-extensions-custom-field-default.webp +0 -0
  166. package/docs/guides/extending-the-admin-ui/custom-form-inputs/ui-extensions-custom-field-slider.webp +0 -0
  167. package/docs/guides/extending-the-admin-ui/custom-timeline-components/index.md +79 -0
  168. package/docs/guides/extending-the-admin-ui/custom-timeline-components/timeline-entry.webp +0 -0
  169. package/docs/guides/extending-the-admin-ui/dashboard-widgets/dashboard-widgets.webp +0 -0
  170. package/docs/guides/extending-the-admin-ui/dashboard-widgets/index.md +149 -0
  171. package/docs/guides/extending-the-admin-ui/defining-routes/index.md +777 -0
  172. package/docs/guides/extending-the-admin-ui/defining-routes/route-area.webp +0 -0
  173. package/docs/guides/extending-the-admin-ui/defining-routes/ui-extensions-greeter.webp +0 -0
  174. package/docs/guides/extending-the-admin-ui/getting-started/index.md +656 -0
  175. package/docs/guides/extending-the-admin-ui/getting-started/provider-extension-points.webp +0 -0
  176. package/docs/guides/extending-the-admin-ui/nav-menu/index.md +97 -0
  177. package/docs/guides/extending-the-admin-ui/nav-menu/nav-menu-id.webp +0 -0
  178. package/docs/guides/extending-the-admin-ui/nav-menu/ui-extensions-navbar.webp +0 -0
  179. package/docs/guides/extending-the-admin-ui/page-tabs/index.md +44 -0
  180. package/docs/guides/extending-the-admin-ui/page-tabs/ui-extensions-tabs.webp +0 -0
  181. package/docs/guides/extending-the-admin-ui/ui-library/buttons.webp +0 -0
  182. package/docs/guides/extending-the-admin-ui/ui-library/card.webp +0 -0
  183. package/docs/guides/extending-the-admin-ui/ui-library/form-inputs.webp +0 -0
  184. package/docs/guides/extending-the-admin-ui/ui-library/icons.webp +0 -0
  185. package/docs/guides/extending-the-admin-ui/ui-library/index.md +356 -0
  186. package/docs/guides/extending-the-admin-ui/ui-library/layout.webp +0 -0
  187. package/docs/guides/extending-the-admin-ui/using-other-frameworks/index.md +205 -0
  188. package/docs/guides/extending-the-admin-ui/using-other-frameworks/ui-extensions-cra.jpg +0 -0
  189. package/docs/guides/extending-the-dashboard/alerts/alert.webp +0 -0
  190. package/docs/guides/extending-the-dashboard/alerts/index.md +89 -0
  191. package/docs/guides/extending-the-dashboard/creating-pages/detail-pages.md +316 -0
  192. package/docs/guides/extending-the-dashboard/creating-pages/index.md +90 -0
  193. package/docs/guides/extending-the-dashboard/creating-pages/list-pages.md +206 -0
  194. package/docs/guides/extending-the-dashboard/creating-pages/tabbed-page-example.webp +0 -0
  195. package/docs/guides/extending-the-dashboard/creating-pages/tabbed-pages.md +144 -0
  196. package/docs/guides/extending-the-dashboard/custom-form-components/color-picker.webp +0 -0
  197. package/docs/guides/extending-the-dashboard/custom-form-components/dev-mode.webp +0 -0
  198. package/docs/guides/extending-the-dashboard/custom-form-components/example-currency-input.webp +0 -0
  199. package/docs/guides/extending-the-dashboard/custom-form-components/example-email-input.webp +0 -0
  200. package/docs/guides/extending-the-dashboard/custom-form-components/example-slug-input.webp +0 -0
  201. package/docs/guides/extending-the-dashboard/custom-form-components/example-tags-input.webp +0 -0
  202. package/docs/guides/extending-the-dashboard/custom-form-components/form-component-examples.mdx +445 -0
  203. package/docs/guides/extending-the-dashboard/custom-form-components/index.md +465 -0
  204. package/docs/guides/extending-the-dashboard/custom-form-components/locator.webp +0 -0
  205. package/docs/guides/extending-the-dashboard/custom-form-components/relation-selectors.md +687 -0
  206. package/docs/guides/extending-the-dashboard/customizing-pages/action-bar-button.webp +0 -0
  207. package/docs/guides/extending-the-dashboard/customizing-pages/action-bar-dropdown.webp +0 -0
  208. package/docs/guides/extending-the-dashboard/customizing-pages/action-bar-items.md +272 -0
  209. package/docs/guides/extending-the-dashboard/customizing-pages/custom-widget.webp +0 -0
  210. package/docs/guides/extending-the-dashboard/customizing-pages/customizing-detail-pages.md +129 -0
  211. package/docs/guides/extending-the-dashboard/customizing-pages/customizing-list-pages.md +93 -0
  212. package/docs/guides/extending-the-dashboard/customizing-pages/customizing-login-page.md +66 -0
  213. package/docs/guides/extending-the-dashboard/customizing-pages/history-entries.md +43 -0
  214. package/docs/guides/extending-the-dashboard/customizing-pages/history-entry.webp +0 -0
  215. package/docs/guides/extending-the-dashboard/customizing-pages/index.md +10 -0
  216. package/docs/guides/extending-the-dashboard/customizing-pages/insights-widgets.md +57 -0
  217. package/docs/guides/extending-the-dashboard/customizing-pages/login-page.webp +0 -0
  218. package/docs/guides/extending-the-dashboard/customizing-pages/page-blocks.md +244 -0
  219. package/docs/guides/extending-the-dashboard/data-fetching/index.md +126 -0
  220. package/docs/guides/extending-the-dashboard/data-fetching/type-inference.webp +0 -0
  221. package/docs/guides/extending-the-dashboard/deployment/index.md +200 -0
  222. package/docs/guides/extending-the-dashboard/extending-overview/dev-mode.webp +0 -0
  223. package/docs/guides/extending-the-dashboard/extending-overview/index.md +228 -0
  224. package/docs/guides/extending-the-dashboard/extending-overview/location-id.webp +0 -0
  225. package/docs/guides/extending-the-dashboard/getting-started/detail-view.webp +0 -0
  226. package/docs/guides/extending-the-dashboard/getting-started/index.md +194 -0
  227. package/docs/guides/extending-the-dashboard/getting-started/list-view-empty.webp +0 -0
  228. package/docs/guides/extending-the-dashboard/getting-started/list-view-full.webp +0 -0
  229. package/docs/guides/extending-the-dashboard/getting-started/page-block.webp +0 -0
  230. package/docs/guides/extending-the-dashboard/getting-started/test-page.webp +0 -0
  231. package/docs/guides/extending-the-dashboard/localization/index.md +94 -0
  232. package/docs/guides/extending-the-dashboard/migration/index.md +1902 -0
  233. package/docs/guides/extending-the-dashboard/navigation/dev-mode-nav.webp +0 -0
  234. package/docs/guides/extending-the-dashboard/navigation/index.md +322 -0
  235. package/docs/guides/extending-the-dashboard/navigation/unauthenticated-page.webp +0 -0
  236. package/docs/guides/extending-the-dashboard/tech-stack/index.md +395 -0
  237. package/docs/guides/extending-the-dashboard/theming/index.md +180 -0
  238. package/docs/guides/extending-the-dashboard/theming/show-colour-value-inspection.gif +0 -0
  239. package/docs/guides/getting-started/graphql-intro/index.mdx +572 -0
  240. package/docs/guides/getting-started/installation/app-screens.webp +0 -0
  241. package/docs/guides/getting-started/installation/index.md +234 -0
  242. package/docs/guides/getting-started/try-the-api/graphiql-docs.jpeg +0 -0
  243. package/docs/guides/getting-started/try-the-api/graphiql.jpeg +0 -0
  244. package/docs/guides/getting-started/try-the-api/index.mdx +238 -0
  245. package/docs/guides/how-to/cms-integration-plugin/index.mdx +2083 -0
  246. package/docs/guides/how-to/codegen/index.md +280 -0
  247. package/docs/guides/how-to/configurable-products/index.md +138 -0
  248. package/docs/guides/how-to/digital-products/index.mdx +485 -0
  249. package/docs/guides/how-to/digital-products/product-variant.webp +0 -0
  250. package/docs/guides/how-to/digital-products/shipping-method.webp +0 -0
  251. package/docs/guides/how-to/github-oauth-authentication/index.mdx +360 -0
  252. package/docs/guides/how-to/google-oauth-authentication/index.mdx +494 -0
  253. package/docs/guides/how-to/multi-vendor-marketplaces/aggregate-order.webp +0 -0
  254. package/docs/guides/how-to/multi-vendor-marketplaces/index.md +197 -0
  255. package/docs/guides/how-to/paginated-list/index.mdx +360 -0
  256. package/docs/guides/how-to/publish-plugin/index.mdx +402 -0
  257. package/docs/guides/how-to/s3-asset-storage/index.mdx +572 -0
  258. package/docs/guides/how-to/telemetry/grafana-logs.webp +0 -0
  259. package/docs/guides/how-to/telemetry/grafana-trace.webp +0 -0
  260. package/docs/guides/how-to/telemetry/index.md +260 -0
  261. package/docs/guides/how-to/telemetry/jaeger-trace.webp +0 -0
  262. package/docs/guides/storefront/active-order/index.mdx +201 -0
  263. package/docs/guides/storefront/checkout-flow/index.mdx +428 -0
  264. package/docs/guides/storefront/codegen/index.mdx +157 -0
  265. package/docs/guides/storefront/connect-api/index.mdx +677 -0
  266. package/docs/guides/storefront/customer-accounts/index.mdx +389 -0
  267. package/docs/guides/storefront/customer-accounts/pw-reset.webp +0 -0
  268. package/docs/guides/storefront/customer-accounts/verification.webp +0 -0
  269. package/docs/guides/storefront/listing-products/index.mdx +711 -0
  270. package/docs/guides/storefront/navigation-menu/index.mdx +157 -0
  271. package/docs/guides/storefront/order-workflow/index.md +231 -0
  272. package/docs/guides/storefront/order-workflow/order_class_diagram.png +0 -0
  273. package/docs/guides/storefront/order-workflow/order_state_diagram.png +0 -0
  274. package/docs/guides/storefront/product-detail/index.mdx +295 -0
  275. package/docs/guides/storefront/storefront-starters/angular-storefront.webp +0 -0
  276. package/docs/guides/storefront/storefront-starters/index.mdx +69 -0
  277. package/docs/guides/storefront/storefront-starters/next-storefront.webp +0 -0
  278. package/docs/guides/storefront/storefront-starters/qwik-storefront.webp +0 -0
  279. package/docs/guides/storefront/storefront-starters/remix-storefront.webp +0 -0
  280. package/docs/reference/admin-ui-api/action-bar/action-bar-context.md +82 -0
  281. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.md +93 -0
  282. package/docs/reference/admin-ui-api/action-bar/action-bar-item.md +106 -0
  283. package/docs/reference/admin-ui-api/action-bar/action-bar-location-id.md +17 -0
  284. package/docs/reference/admin-ui-api/action-bar/add-action-bar-dropdown-menu-item.md +38 -0
  285. package/docs/reference/admin-ui-api/action-bar/add-action-bar-item.md +36 -0
  286. package/docs/reference/admin-ui-api/action-bar/index.md +5 -0
  287. package/docs/reference/admin-ui-api/action-bar/page-location-id.md +61 -0
  288. package/docs/reference/admin-ui-api/action-bar/router-link-definition.md +16 -0
  289. package/docs/reference/admin-ui-api/alerts/alert-config.md +88 -0
  290. package/docs/reference/admin-ui-api/alerts/alert-context.md +52 -0
  291. package/docs/reference/admin-ui-api/alerts/index.md +5 -0
  292. package/docs/reference/admin-ui-api/alerts/register-alert.md +23 -0
  293. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.md +229 -0
  294. package/docs/reference/admin-ui-api/bulk-actions/index.md +5 -0
  295. package/docs/reference/admin-ui-api/bulk-actions/register-bulk-action.md +63 -0
  296. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.md +160 -0
  297. package/docs/reference/admin-ui-api/components/chip-component.md +63 -0
  298. package/docs/reference/admin-ui-api/components/currency-input-component.md +174 -0
  299. package/docs/reference/admin-ui-api/components/data-table-component.md +238 -0
  300. package/docs/reference/admin-ui-api/components/data-table2component.md +354 -0
  301. package/docs/reference/admin-ui-api/components/datetime-picker-component.md +262 -0
  302. package/docs/reference/admin-ui-api/components/dropdown-component.md +86 -0
  303. package/docs/reference/admin-ui-api/components/facet-value-selector-component.md +155 -0
  304. package/docs/reference/admin-ui-api/components/index.md +5 -0
  305. package/docs/reference/admin-ui-api/components/object-tree-component.md +86 -0
  306. package/docs/reference/admin-ui-api/components/order-state-label-component.md +41 -0
  307. package/docs/reference/admin-ui-api/components/product-variant-selector-component.md +75 -0
  308. package/docs/reference/admin-ui-api/components/rich-text-editor-component.md +108 -0
  309. package/docs/reference/admin-ui-api/components/zone-selector-component.md +124 -0
  310. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.md +41 -0
  311. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-location-id.md +36 -0
  312. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.md +36 -0
  313. package/docs/reference/admin-ui-api/custom-detail-components/index.md +5 -0
  314. package/docs/reference/admin-ui-api/custom-detail-components/register-custom-detail-component.md +69 -0
  315. package/docs/reference/admin-ui-api/custom-history-entry-components/customer-history-entry-component.md +32 -0
  316. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.md +57 -0
  317. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.md +35 -0
  318. package/docs/reference/admin-ui-api/custom-history-entry-components/index.md +5 -0
  319. package/docs/reference/admin-ui-api/custom-history-entry-components/order-history-entry-component.md +32 -0
  320. package/docs/reference/admin-ui-api/custom-history-entry-components/register-history-entry-component.md +79 -0
  321. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.md +1034 -0
  322. package/docs/reference/admin-ui-api/custom-input-components/form-input-component.md +56 -0
  323. package/docs/reference/admin-ui-api/custom-input-components/index.md +5 -0
  324. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.md +71 -0
  325. package/docs/reference/admin-ui-api/custom-table-components/custom-column-component.md +32 -0
  326. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.md +48 -0
  327. package/docs/reference/admin-ui-api/custom-table-components/index.md +5 -0
  328. package/docs/reference/admin-ui-api/custom-table-components/register-data-table-component.md +55 -0
  329. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.md +60 -0
  330. package/docs/reference/admin-ui-api/dashboard-widgets/index.md +5 -0
  331. package/docs/reference/admin-ui-api/dashboard-widgets/register-dashboard-widget.md +27 -0
  332. package/docs/reference/admin-ui-api/dashboard-widgets/set-dashboard-widget-layout.md +22 -0
  333. package/docs/reference/admin-ui-api/dashboard-widgets/widget-layout-definition.md +16 -0
  334. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.md +41 -0
  335. package/docs/reference/admin-ui-api/directives/if-permissions-directive.md +43 -0
  336. package/docs/reference/admin-ui-api/directives/index.md +5 -0
  337. package/docs/reference/admin-ui-api/index.md +13 -0
  338. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.md +168 -0
  339. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.md +54 -0
  340. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.md +155 -0
  341. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.md +52 -0
  342. package/docs/reference/admin-ui-api/list-detail-views/index.md +5 -0
  343. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.md +51 -0
  344. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.md +125 -0
  345. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-item.md +52 -0
  346. package/docs/reference/admin-ui-api/nav-menu/add-nav-menu-section.md +47 -0
  347. package/docs/reference/admin-ui-api/nav-menu/index.md +5 -0
  348. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.md +66 -0
  349. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.md +83 -0
  350. package/docs/reference/admin-ui-api/nav-menu/navigation-types.md +38 -0
  351. package/docs/reference/admin-ui-api/pipes/asset-preview-pipe.md +41 -0
  352. package/docs/reference/admin-ui-api/pipes/duration-pipe.md +45 -0
  353. package/docs/reference/admin-ui-api/pipes/file-size-pipe.md +38 -0
  354. package/docs/reference/admin-ui-api/pipes/has-permission-pipe.md +51 -0
  355. package/docs/reference/admin-ui-api/pipes/index.md +5 -0
  356. package/docs/reference/admin-ui-api/pipes/locale-currency-name-pipe.md +47 -0
  357. package/docs/reference/admin-ui-api/pipes/locale-currency-pipe.md +54 -0
  358. package/docs/reference/admin-ui-api/pipes/locale-date-pipe.md +48 -0
  359. package/docs/reference/admin-ui-api/pipes/locale-language-name-pipe.md +47 -0
  360. package/docs/reference/admin-ui-api/pipes/locale-region-name-pipe.md +47 -0
  361. package/docs/reference/admin-ui-api/pipes/time-ago-pipe.md +44 -0
  362. package/docs/reference/admin-ui-api/react-components/action-bar.md +36 -0
  363. package/docs/reference/admin-ui-api/react-components/card.md +36 -0
  364. package/docs/reference/admin-ui-api/react-components/cds-icon.md +34 -0
  365. package/docs/reference/admin-ui-api/react-components/form-field.md +42 -0
  366. package/docs/reference/admin-ui-api/react-components/index.md +5 -0
  367. package/docs/reference/admin-ui-api/react-components/link.md +34 -0
  368. package/docs/reference/admin-ui-api/react-components/page-block.md +36 -0
  369. package/docs/reference/admin-ui-api/react-components/page-detail-layout.md +36 -0
  370. package/docs/reference/admin-ui-api/react-components/rich-text-editor.md +42 -0
  371. package/docs/reference/admin-ui-api/react-extensions/index.md +5 -0
  372. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.md +41 -0
  373. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.md +48 -0
  374. package/docs/reference/admin-ui-api/react-extensions/register-react-custom-detail-component.md +23 -0
  375. package/docs/reference/admin-ui-api/react-extensions/register-react-data-table-component.md +55 -0
  376. package/docs/reference/admin-ui-api/react-extensions/register-react-form-input-component.md +26 -0
  377. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component-options.md +18 -0
  378. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.md +22 -0
  379. package/docs/reference/admin-ui-api/react-hooks/index.md +5 -0
  380. package/docs/reference/admin-ui-api/react-hooks/use-detail-component-data.md +39 -0
  381. package/docs/reference/admin-ui-api/react-hooks/use-form-control.md +36 -0
  382. package/docs/reference/admin-ui-api/react-hooks/use-injector.md +39 -0
  383. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.md +74 -0
  384. package/docs/reference/admin-ui-api/react-hooks/use-mutation.md +62 -0
  385. package/docs/reference/admin-ui-api/react-hooks/use-page-metadata.md +36 -0
  386. package/docs/reference/admin-ui-api/react-hooks/use-query.md +59 -0
  387. package/docs/reference/admin-ui-api/react-hooks/use-rich-text-editor.md +30 -0
  388. package/docs/reference/admin-ui-api/react-hooks/use-route-params.md +29 -0
  389. package/docs/reference/admin-ui-api/routes/index.md +5 -0
  390. package/docs/reference/admin-ui-api/routes/register-route-component-options.md +28 -0
  391. package/docs/reference/admin-ui-api/routes/register-route-component.md +57 -0
  392. package/docs/reference/admin-ui-api/services/data-service.md +142 -0
  393. package/docs/reference/admin-ui-api/services/index.md +5 -0
  394. package/docs/reference/admin-ui-api/services/modal-service.md +199 -0
  395. package/docs/reference/admin-ui-api/services/notification-service.md +126 -0
  396. package/docs/reference/admin-ui-api/tabs/index.md +5 -0
  397. package/docs/reference/admin-ui-api/tabs/page-tab-config.md +70 -0
  398. package/docs/reference/admin-ui-api/tabs/register-page-tab.md +38 -0
  399. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.md +417 -0
  400. package/docs/reference/admin-ui-api/ui-devkit/compile-ui-extensions.md +22 -0
  401. package/docs/reference/admin-ui-api/ui-devkit/helpers.md +39 -0
  402. package/docs/reference/admin-ui-api/ui-devkit/index.md +5 -0
  403. package/docs/reference/admin-ui-api/ui-devkit/ui-devkit-client.md +160 -0
  404. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-build-command.md +16 -0
  405. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-options.md +118 -0
  406. package/docs/reference/admin-ui-api/ui-devkit/ui-extension-compiler-process-argument.md +16 -0
  407. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.md +67 -0
  408. package/docs/reference/core-plugins/admin-ui-plugin/index.md +94 -0
  409. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.md +106 -0
  410. package/docs/reference/core-plugins/asset-server-plugin/cache-config.md +36 -0
  411. package/docs/reference/core-plugins/asset-server-plugin/hashed-asset-naming-strategy.md +47 -0
  412. package/docs/reference/core-plugins/asset-server-plugin/image-transform-mode.md +21 -0
  413. package/docs/reference/core-plugins/asset-server-plugin/image-transform-preset.md +57 -0
  414. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.md +144 -0
  415. package/docs/reference/core-plugins/asset-server-plugin/index.md +189 -0
  416. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.md +74 -0
  417. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.md +118 -0
  418. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.md +225 -0
  419. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.md +118 -0
  420. package/docs/reference/core-plugins/dashboard-plugin/dashboard-plugin-options.md +43 -0
  421. package/docs/reference/core-plugins/dashboard-plugin/index.md +106 -0
  422. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.md +695 -0
  423. package/docs/reference/core-plugins/elasticsearch-plugin/index.md +193 -0
  424. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.md +33 -0
  425. package/docs/reference/core-plugins/email-plugin/email-event-handler.md +299 -0
  426. package/docs/reference/core-plugins/email-plugin/email-event-listener.md +42 -0
  427. package/docs/reference/core-plugins/email-plugin/email-generator.md +78 -0
  428. package/docs/reference/core-plugins/email-plugin/email-plugin-options.md +154 -0
  429. package/docs/reference/core-plugins/email-plugin/email-plugin-types.md +276 -0
  430. package/docs/reference/core-plugins/email-plugin/email-send-event.md +34 -0
  431. package/docs/reference/core-plugins/email-plugin/email-sender.md +92 -0
  432. package/docs/reference/core-plugins/email-plugin/email-utils.md +54 -0
  433. package/docs/reference/core-plugins/email-plugin/index.md +309 -0
  434. package/docs/reference/core-plugins/email-plugin/template-loader.md +96 -0
  435. package/docs/reference/core-plugins/email-plugin/transport-options.md +241 -0
  436. package/docs/reference/core-plugins/graphiql-plugin/index.md +89 -0
  437. package/docs/reference/core-plugins/harden-plugin/default-vendure-complexity-estimator.md +30 -0
  438. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.md +106 -0
  439. package/docs/reference/core-plugins/harden-plugin/index.md +169 -0
  440. package/docs/reference/core-plugins/index.md +5 -0
  441. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-plugin.md +211 -0
  442. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.md +93 -0
  443. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.md +142 -0
  444. package/docs/reference/core-plugins/job-queue-plugin/index.md +5 -0
  445. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.md +65 -0
  446. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.md +36 -0
  447. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.md +350 -0
  448. package/docs/reference/core-plugins/payments-plugin/index.md +5 -0
  449. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.md +209 -0
  450. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.md +355 -0
  451. package/docs/reference/core-plugins/sentry-plugin/index.md +158 -0
  452. package/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.md +32 -0
  453. package/docs/reference/core-plugins/sentry-plugin/sentry-service.md +47 -0
  454. package/docs/reference/core-plugins/stellate-plugin/index.md +277 -0
  455. package/docs/reference/core-plugins/stellate-plugin/purge-rule.md +91 -0
  456. package/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.md +65 -0
  457. package/docs/reference/core-plugins/stellate-plugin/stellate-service.md +71 -0
  458. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.md +92 -0
  459. package/docs/reference/core-plugins/telemetry-plugin/index.md +131 -0
  460. package/docs/reference/core-plugins/telemetry-plugin/otel-logger.md +102 -0
  461. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.md +46 -0
  462. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.md +77 -0
  463. package/docs/reference/dashboard/components/asset-gallery.md +127 -0
  464. package/docs/reference/dashboard/components/asset-picker-dialog.md +76 -0
  465. package/docs/reference/dashboard/components/channel-chip.md +22 -0
  466. package/docs/reference/dashboard/components/detail-page-button.md +49 -0
  467. package/docs/reference/dashboard/components/facet-value-chip.md +22 -0
  468. package/docs/reference/dashboard/components/facet-value-selector.md +85 -0
  469. package/docs/reference/dashboard/components/index.md +5 -0
  470. package/docs/reference/dashboard/components/permission-guard.md +63 -0
  471. package/docs/reference/dashboard/components/vendure-image.md +199 -0
  472. package/docs/reference/dashboard/detail-views/detail-page.md +91 -0
  473. package/docs/reference/dashboard/detail-views/index.md +5 -0
  474. package/docs/reference/dashboard/detail-views/use-detail-page.md +234 -0
  475. package/docs/reference/dashboard/detail-views/use-generated-form.md +105 -0
  476. package/docs/reference/dashboard/extensions-api/action-bar.md +66 -0
  477. package/docs/reference/dashboard/extensions-api/alerts.md +78 -0
  478. package/docs/reference/dashboard/extensions-api/data-tables.md +55 -0
  479. package/docs/reference/dashboard/extensions-api/define-dashboard-extension.md +142 -0
  480. package/docs/reference/dashboard/extensions-api/detail-forms.md +81 -0
  481. package/docs/reference/dashboard/extensions-api/form-components.md +188 -0
  482. package/docs/reference/dashboard/extensions-api/history-entries.md +246 -0
  483. package/docs/reference/dashboard/extensions-api/index.md +5 -0
  484. package/docs/reference/dashboard/extensions-api/login.md +113 -0
  485. package/docs/reference/dashboard/extensions-api/navigation.md +128 -0
  486. package/docs/reference/dashboard/extensions-api/page-blocks.md +143 -0
  487. package/docs/reference/dashboard/extensions-api/routes.md +69 -0
  488. package/docs/reference/dashboard/extensions-api/widgets.md +61 -0
  489. package/docs/reference/dashboard/form-components/affixed-input.md +34 -0
  490. package/docs/reference/dashboard/form-components/boolean-input.md +22 -0
  491. package/docs/reference/dashboard/form-components/checkbox-input.md +22 -0
  492. package/docs/reference/dashboard/form-components/date-time-input.md +22 -0
  493. package/docs/reference/dashboard/form-components/form-field-wrapper.md +80 -0
  494. package/docs/reference/dashboard/form-components/index.md +5 -0
  495. package/docs/reference/dashboard/form-components/money-input.md +23 -0
  496. package/docs/reference/dashboard/form-components/number-input.md +22 -0
  497. package/docs/reference/dashboard/form-components/password-input.md +22 -0
  498. package/docs/reference/dashboard/form-components/rich-text-input.md +22 -0
  499. package/docs/reference/dashboard/form-components/slug-input.md +57 -0
  500. package/docs/reference/dashboard/form-components/text-input.md +13 -0
  501. package/docs/reference/dashboard/form-components/textarea-input.md +22 -0
  502. package/docs/reference/dashboard/form-components/translatable-form-field-wrapper.md +70 -0
  503. package/docs/reference/dashboard/hooks/index.md +5 -0
  504. package/docs/reference/dashboard/hooks/use-alerts.md +65 -0
  505. package/docs/reference/dashboard/hooks/use-auth.md +84 -0
  506. package/docs/reference/dashboard/hooks/use-channel.md +72 -0
  507. package/docs/reference/dashboard/hooks/use-custom-field-config.md +24 -0
  508. package/docs/reference/dashboard/hooks/use-display-locale.md +32 -0
  509. package/docs/reference/dashboard/hooks/use-drag-and-drop.md +22 -0
  510. package/docs/reference/dashboard/hooks/use-local-format.md +30 -0
  511. package/docs/reference/dashboard/hooks/use-paginated-list.md +29 -0
  512. package/docs/reference/dashboard/hooks/use-permissions.md +25 -0
  513. package/docs/reference/dashboard/hooks/use-sorted-languages.md +30 -0
  514. package/docs/reference/dashboard/hooks/use-ui-language-loader.md +18 -0
  515. package/docs/reference/dashboard/hooks/use-widget-filters.md +16 -0
  516. package/docs/reference/dashboard/list-views/bulk-actions.md +199 -0
  517. package/docs/reference/dashboard/list-views/data-table-cell-component.md +45 -0
  518. package/docs/reference/dashboard/list-views/data-table.md +209 -0
  519. package/docs/reference/dashboard/list-views/index.md +5 -0
  520. package/docs/reference/dashboard/list-views/list-page.md +493 -0
  521. package/docs/reference/dashboard/list-views/paginated-list-data-table.md +303 -0
  522. package/docs/reference/dashboard/page-layout/index.md +54 -0
  523. package/docs/reference/dashboard/page-layout/page-action-bar.md +62 -0
  524. package/docs/reference/dashboard/page-layout/page-block.md +137 -0
  525. package/docs/reference/dashboard/page-layout/page-title.md +22 -0
  526. package/docs/reference/dashboard/page-layout/page.md +100 -0
  527. package/docs/reference/dashboard/page-layout/use-page-block.md +32 -0
  528. package/docs/reference/dashboard/vite-plugin/index.md +5 -0
  529. package/docs/reference/dashboard/vite-plugin/vendure-dashboard-plugin.md +356 -0
  530. package/docs/reference/graphql-api/_index.md +16 -0
  531. package/docs/reference/graphql-api/admin/_index.md +13 -0
  532. package/docs/reference/graphql-api/admin/enums.md +1142 -0
  533. package/docs/reference/graphql-api/admin/input-types.md +4631 -0
  534. package/docs/reference/graphql-api/admin/mutations.md +1985 -0
  535. package/docs/reference/graphql-api/admin/object-types.md +4515 -0
  536. package/docs/reference/graphql-api/admin/queries.md +760 -0
  537. package/docs/reference/graphql-api/shop/_index.md +13 -0
  538. package/docs/reference/graphql-api/shop/enums.md +1072 -0
  539. package/docs/reference/graphql-api/shop/input-types.md +1192 -0
  540. package/docs/reference/graphql-api/shop/mutations.md +431 -0
  541. package/docs/reference/graphql-api/shop/object-types.md +3406 -0
  542. package/docs/reference/graphql-api/shop/queries.md +247 -0
  543. package/docs/reference/index.mdx +38 -0
  544. package/docs/reference/links.webp +0 -0
  545. package/docs/reference/typescript-api/_index.md +13 -0
  546. package/docs/reference/typescript-api/assets/asset-naming-strategy.md +56 -0
  547. package/docs/reference/typescript-api/assets/asset-options.md +58 -0
  548. package/docs/reference/typescript-api/assets/asset-preview-strategy.md +45 -0
  549. package/docs/reference/typescript-api/assets/asset-storage-strategy.md +84 -0
  550. package/docs/reference/typescript-api/assets/default-asset-naming-strategy.md +39 -0
  551. package/docs/reference/typescript-api/assets/index.md +5 -0
  552. package/docs/reference/typescript-api/auth/auth-options.md +165 -0
  553. package/docs/reference/typescript-api/auth/authentication-strategy.md +97 -0
  554. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.md +38 -0
  555. package/docs/reference/typescript-api/auth/cookie-options.md +108 -0
  556. package/docs/reference/typescript-api/auth/default-password-validation-strategy.md +44 -0
  557. package/docs/reference/typescript-api/auth/default-session-cache-strategy.md +73 -0
  558. package/docs/reference/typescript-api/auth/default-verification-token-strategy.md +47 -0
  559. package/docs/reference/typescript-api/auth/external-authentication-service.md +98 -0
  560. package/docs/reference/typescript-api/auth/in-memory-session-cache-strategy.md +63 -0
  561. package/docs/reference/typescript-api/auth/index.md +5 -0
  562. package/docs/reference/typescript-api/auth/native-authentication-strategy.md +58 -0
  563. package/docs/reference/typescript-api/auth/noop-session-cache-strategy.md +51 -0
  564. package/docs/reference/typescript-api/auth/password-hashing-strategy.md +45 -0
  565. package/docs/reference/typescript-api/auth/password-validation-strategy.md +43 -0
  566. package/docs/reference/typescript-api/auth/permission-definition.md +269 -0
  567. package/docs/reference/typescript-api/auth/session-cache-strategy.md +275 -0
  568. package/docs/reference/typescript-api/auth/superadmin-credentials.md +36 -0
  569. package/docs/reference/typescript-api/auth/verification-token-strategy.md +45 -0
  570. package/docs/reference/typescript-api/cache/cache-config.md +44 -0
  571. package/docs/reference/typescript-api/cache/cache-service.md +76 -0
  572. package/docs/reference/typescript-api/cache/cache-strategy.md +103 -0
  573. package/docs/reference/typescript-api/cache/default-cache-plugin.md +73 -0
  574. package/docs/reference/typescript-api/cache/index.md +79 -0
  575. package/docs/reference/typescript-api/cache/redis-cache-plugin.md +85 -0
  576. package/docs/reference/typescript-api/cache/redis-cache-strategy.md +75 -0
  577. package/docs/reference/typescript-api/cache/request-context-cache-service.md +54 -0
  578. package/docs/reference/typescript-api/cache/self-refreshing-cache.md +152 -0
  579. package/docs/reference/typescript-api/cache/sql-cache-strategy.md +87 -0
  580. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.md +43 -0
  581. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.md +47 -0
  582. package/docs/reference/typescript-api/common/admin-ui/admin-ui-config.md +139 -0
  583. package/docs/reference/typescript-api/common/admin-ui/index.md +5 -0
  584. package/docs/reference/typescript-api/common/async-queue.md +38 -0
  585. package/docs/reference/typescript-api/common/bootstrap.md +129 -0
  586. package/docs/reference/typescript-api/common/currency-code.md +174 -0
  587. package/docs/reference/typescript-api/common/entity-relation-paths.md +34 -0
  588. package/docs/reference/typescript-api/common/i18n-service.md +74 -0
  589. package/docs/reference/typescript-api/common/id.md +17 -0
  590. package/docs/reference/typescript-api/common/index.md +5 -0
  591. package/docs/reference/typescript-api/common/injectable-strategy.md +48 -0
  592. package/docs/reference/typescript-api/common/injector.md +47 -0
  593. package/docs/reference/typescript-api/common/job-state.md +23 -0
  594. package/docs/reference/typescript-api/common/json-compatible.md +23 -0
  595. package/docs/reference/typescript-api/common/language-code.md +177 -0
  596. package/docs/reference/typescript-api/common/middleware.md +72 -0
  597. package/docs/reference/typescript-api/common/paginated-list.md +36 -0
  598. package/docs/reference/typescript-api/common/permission.md +136 -0
  599. package/docs/reference/typescript-api/common/price-calculation-result.md +36 -0
  600. package/docs/reference/typescript-api/common/process-context.md +55 -0
  601. package/docs/reference/typescript-api/common/vendure_version.md +22 -0
  602. package/docs/reference/typescript-api/configurable-operation-def/config-arg-type.md +22 -0
  603. package/docs/reference/typescript-api/configurable-operation-def/config-args.md +89 -0
  604. package/docs/reference/typescript-api/configurable-operation-def/configurable-operation-def-options.md +57 -0
  605. package/docs/reference/typescript-api/configurable-operation-def/default-form-component-id.md +34 -0
  606. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.md +137 -0
  607. package/docs/reference/typescript-api/configurable-operation-def/index.md +149 -0
  608. package/docs/reference/typescript-api/configurable-operation-def/localized-string-array.md +28 -0
  609. package/docs/reference/typescript-api/configuration/api-options.md +159 -0
  610. package/docs/reference/typescript-api/configuration/collection-filter.md +76 -0
  611. package/docs/reference/typescript-api/configuration/default-config.md +13 -0
  612. package/docs/reference/typescript-api/configuration/default-slug-strategy.md +46 -0
  613. package/docs/reference/typescript-api/configuration/entity-duplicator.md +195 -0
  614. package/docs/reference/typescript-api/configuration/entity-id-decorator.md +24 -0
  615. package/docs/reference/typescript-api/configuration/entity-id-strategy.md +168 -0
  616. package/docs/reference/typescript-api/configuration/entity-options.md +153 -0
  617. package/docs/reference/typescript-api/configuration/index.md +5 -0
  618. package/docs/reference/typescript-api/configuration/merge-config.md +49 -0
  619. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.md +71 -0
  620. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.md +185 -0
  621. package/docs/reference/typescript-api/configuration/runtime-vendure-config.md +111 -0
  622. package/docs/reference/typescript-api/configuration/settings-store-fields.md +29 -0
  623. package/docs/reference/typescript-api/configuration/slug-strategy.md +47 -0
  624. package/docs/reference/typescript-api/configuration/system-options.md +50 -0
  625. package/docs/reference/typescript-api/configuration/trust-proxy-options.md +19 -0
  626. package/docs/reference/typescript-api/configuration/vendure-config.md +168 -0
  627. package/docs/reference/typescript-api/custom-fields/custom-field-config.md +25 -0
  628. package/docs/reference/typescript-api/custom-fields/custom-field-type.md +42 -0
  629. package/docs/reference/typescript-api/custom-fields/index.md +70 -0
  630. package/docs/reference/typescript-api/custom-fields/struct-custom-field-config.md +21 -0
  631. package/docs/reference/typescript-api/custom-fields/struct-field-config.md +41 -0
  632. package/docs/reference/typescript-api/custom-fields/typed-custom-single-field-config.md +24 -0
  633. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.md +38 -0
  634. package/docs/reference/typescript-api/data-access/calculated.md +62 -0
  635. package/docs/reference/typescript-api/data-access/entity-hydrator.md +103 -0
  636. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.md +53 -0
  637. package/docs/reference/typescript-api/data-access/hydrate-options.md +40 -0
  638. package/docs/reference/typescript-api/data-access/index.md +5 -0
  639. package/docs/reference/typescript-api/data-access/list-query-builder.md +239 -0
  640. package/docs/reference/typescript-api/data-access/transactional-connection.md +173 -0
  641. package/docs/reference/typescript-api/default-search-plugin/default-search-plugin-init-options.md +126 -0
  642. package/docs/reference/typescript-api/default-search-plugin/index.md +64 -0
  643. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.md +56 -0
  644. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.md +56 -0
  645. package/docs/reference/typescript-api/default-search-plugin/search-strategy.md +58 -0
  646. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.md +57 -0
  647. package/docs/reference/typescript-api/entities/address.md +124 -0
  648. package/docs/reference/typescript-api/entities/administrator.md +78 -0
  649. package/docs/reference/typescript-api/entities/anonymous-session.md +34 -0
  650. package/docs/reference/typescript-api/entities/asset.md +135 -0
  651. package/docs/reference/typescript-api/entities/authenticated-session.md +48 -0
  652. package/docs/reference/typescript-api/entities/authentication-method.md +156 -0
  653. package/docs/reference/typescript-api/entities/channel.md +233 -0
  654. package/docs/reference/typescript-api/entities/collection.md +152 -0
  655. package/docs/reference/typescript-api/entities/country.md +40 -0
  656. package/docs/reference/typescript-api/entities/customer-group.md +63 -0
  657. package/docs/reference/typescript-api/entities/customer-history-entry.md +40 -0
  658. package/docs/reference/typescript-api/entities/customer.md +122 -0
  659. package/docs/reference/typescript-api/entities/facet-value.md +98 -0
  660. package/docs/reference/typescript-api/entities/facet.md +89 -0
  661. package/docs/reference/typescript-api/entities/fulfillment.md +84 -0
  662. package/docs/reference/typescript-api/entities/global-settings.md +66 -0
  663. package/docs/reference/typescript-api/entities/history-entry.md +66 -0
  664. package/docs/reference/typescript-api/entities/index.md +5 -0
  665. package/docs/reference/typescript-api/entities/interfaces.md +125 -0
  666. package/docs/reference/typescript-api/entities/order-history-entry.md +40 -0
  667. package/docs/reference/typescript-api/entities/order-line-reference.md +174 -0
  668. package/docs/reference/typescript-api/entities/order-line.md +344 -0
  669. package/docs/reference/typescript-api/entities/order-modification.md +103 -0
  670. package/docs/reference/typescript-api/entities/order.md +284 -0
  671. package/docs/reference/typescript-api/entities/orderable-asset.md +61 -0
  672. package/docs/reference/typescript-api/entities/payment-method.md +94 -0
  673. package/docs/reference/typescript-api/entities/payment.md +96 -0
  674. package/docs/reference/typescript-api/entities/product-option-group.md +84 -0
  675. package/docs/reference/typescript-api/entities/product-option.md +90 -0
  676. package/docs/reference/typescript-api/entities/product-variant-price.md +70 -0
  677. package/docs/reference/typescript-api/entities/product-variant.md +251 -0
  678. package/docs/reference/typescript-api/entities/product.md +134 -0
  679. package/docs/reference/typescript-api/entities/promotion.md +190 -0
  680. package/docs/reference/typescript-api/entities/province.md +39 -0
  681. package/docs/reference/typescript-api/entities/refund.md +120 -0
  682. package/docs/reference/typescript-api/entities/region.md +87 -0
  683. package/docs/reference/typescript-api/entities/role.md +62 -0
  684. package/docs/reference/typescript-api/entities/seller.md +63 -0
  685. package/docs/reference/typescript-api/entities/session.md +87 -0
  686. package/docs/reference/typescript-api/entities/settings-store-entry.md +57 -0
  687. package/docs/reference/typescript-api/entities/shipping-line.md +150 -0
  688. package/docs/reference/typescript-api/entities/shipping-method.md +123 -0
  689. package/docs/reference/typescript-api/entities/stock-level.md +87 -0
  690. package/docs/reference/typescript-api/entities/stock-location.md +76 -0
  691. package/docs/reference/typescript-api/entities/stock-movement.md +270 -0
  692. package/docs/reference/typescript-api/entities/surcharge.md +102 -0
  693. package/docs/reference/typescript-api/entities/tag.md +40 -0
  694. package/docs/reference/typescript-api/entities/tax-category.md +68 -0
  695. package/docs/reference/typescript-api/entities/tax-rate.md +138 -0
  696. package/docs/reference/typescript-api/entities/user.md +111 -0
  697. package/docs/reference/typescript-api/entities/vendure-entity.md +49 -0
  698. package/docs/reference/typescript-api/entities/zone.md +78 -0
  699. package/docs/reference/typescript-api/errors/error-handler-strategy.md +88 -0
  700. package/docs/reference/typescript-api/errors/error-result-union.md +30 -0
  701. package/docs/reference/typescript-api/errors/error-types.md +197 -0
  702. package/docs/reference/typescript-api/errors/i18n-error.md +39 -0
  703. package/docs/reference/typescript-api/errors/index.md +5 -0
  704. package/docs/reference/typescript-api/errors/is-graph-ql-error-result.md +40 -0
  705. package/docs/reference/typescript-api/events/blocking-event-handler-options.md +57 -0
  706. package/docs/reference/typescript-api/events/event-bus.md +136 -0
  707. package/docs/reference/typescript-api/events/event-types.md +1689 -0
  708. package/docs/reference/typescript-api/events/index.md +5 -0
  709. package/docs/reference/typescript-api/events/vendure-entity-event.md +57 -0
  710. package/docs/reference/typescript-api/events/vendure-event.md +35 -0
  711. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.md +173 -0
  712. package/docs/reference/typescript-api/fulfillment/fulfillment-process.md +71 -0
  713. package/docs/reference/typescript-api/fulfillment/fulfillment-state.md +21 -0
  714. package/docs/reference/typescript-api/fulfillment/fulfillment-states.md +18 -0
  715. package/docs/reference/typescript-api/fulfillment/fulfillment-transition-data.md +41 -0
  716. package/docs/reference/typescript-api/fulfillment/index.md +5 -0
  717. package/docs/reference/typescript-api/health-check/health-check-registry-service.md +70 -0
  718. package/docs/reference/typescript-api/health-check/health-check-strategy.md +70 -0
  719. package/docs/reference/typescript-api/health-check/http-health-check-strategy.md +61 -0
  720. package/docs/reference/typescript-api/health-check/index.md +5 -0
  721. package/docs/reference/typescript-api/health-check/type-ormhealth-check-strategy.md +64 -0
  722. package/docs/reference/typescript-api/import-export/asset-import-strategy.md +46 -0
  723. package/docs/reference/typescript-api/import-export/asset-importer.md +32 -0
  724. package/docs/reference/typescript-api/import-export/default-asset-import-strategy.md +48 -0
  725. package/docs/reference/typescript-api/import-export/fast-importer-service.md +67 -0
  726. package/docs/reference/typescript-api/import-export/import-export-options.md +36 -0
  727. package/docs/reference/typescript-api/import-export/import-parser.md +280 -0
  728. package/docs/reference/typescript-api/import-export/importer.md +54 -0
  729. package/docs/reference/typescript-api/import-export/index.md +5 -0
  730. package/docs/reference/typescript-api/import-export/initial-data.md +71 -0
  731. package/docs/reference/typescript-api/import-export/populate.md +71 -0
  732. package/docs/reference/typescript-api/import-export/populator.md +38 -0
  733. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.md +245 -0
  734. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.md +55 -0
  735. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.md +110 -0
  736. package/docs/reference/typescript-api/job-queue/index.md +84 -0
  737. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.md +60 -0
  738. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.md +78 -0
  739. package/docs/reference/typescript-api/job-queue/job-buffer.md +119 -0
  740. package/docs/reference/typescript-api/job-queue/job-queue-options.md +56 -0
  741. package/docs/reference/typescript-api/job-queue/job-queue-service.md +128 -0
  742. package/docs/reference/typescript-api/job-queue/job-queue-strategy.md +59 -0
  743. package/docs/reference/typescript-api/job-queue/job.md +195 -0
  744. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.md +122 -0
  745. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.md +84 -0
  746. package/docs/reference/typescript-api/job-queue/subscribable-job.md +44 -0
  747. package/docs/reference/typescript-api/job-queue/types.md +199 -0
  748. package/docs/reference/typescript-api/logger/default-logger.md +81 -0
  749. package/docs/reference/typescript-api/logger/index.md +120 -0
  750. package/docs/reference/typescript-api/logger/log-level.md +30 -0
  751. package/docs/reference/typescript-api/logger/vendure-logger.md +60 -0
  752. package/docs/reference/typescript-api/migration/generate-migration.md +28 -0
  753. package/docs/reference/typescript-api/migration/index.md +5 -0
  754. package/docs/reference/typescript-api/migration/migration-options.md +36 -0
  755. package/docs/reference/typescript-api/migration/revert-last-migration.md +23 -0
  756. package/docs/reference/typescript-api/migration/run-migrations.md +23 -0
  757. package/docs/reference/typescript-api/money/big-int-money-strategy.md +68 -0
  758. package/docs/reference/typescript-api/money/default-money-strategy.md +47 -0
  759. package/docs/reference/typescript-api/money/index.md +5 -0
  760. package/docs/reference/typescript-api/money/money-decorator.md +23 -0
  761. package/docs/reference/typescript-api/money/money-strategy.md +116 -0
  762. package/docs/reference/typescript-api/money/round-money.md +26 -0
  763. package/docs/reference/typescript-api/orders/active-order-service.md +69 -0
  764. package/docs/reference/typescript-api/orders/active-order-strategy.md +203 -0
  765. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.md +51 -0
  766. package/docs/reference/typescript-api/orders/custom-order-states.md +18 -0
  767. package/docs/reference/typescript-api/orders/default-active-order-strategy.md +52 -0
  768. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.md +93 -0
  769. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.md +33 -0
  770. package/docs/reference/typescript-api/orders/default-order-placed-strategy.md +33 -0
  771. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.md +33 -0
  772. package/docs/reference/typescript-api/orders/guest-checkout-strategy.md +56 -0
  773. package/docs/reference/typescript-api/orders/index.md +5 -0
  774. package/docs/reference/typescript-api/orders/merge-strategies.md +114 -0
  775. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.md +91 -0
  776. package/docs/reference/typescript-api/orders/order-code-strategy.md +88 -0
  777. package/docs/reference/typescript-api/orders/order-interceptor.md +250 -0
  778. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.md +91 -0
  779. package/docs/reference/typescript-api/orders/order-merge-strategy.md +80 -0
  780. package/docs/reference/typescript-api/orders/order-options.md +145 -0
  781. package/docs/reference/typescript-api/orders/order-placed-strategy.md +54 -0
  782. package/docs/reference/typescript-api/orders/order-process.md +271 -0
  783. package/docs/reference/typescript-api/orders/order-seller-strategy.md +124 -0
  784. package/docs/reference/typescript-api/orders/stock-allocation-strategy.md +46 -0
  785. package/docs/reference/typescript-api/payment/default-payment-process.md +13 -0
  786. package/docs/reference/typescript-api/payment/default-refund-process.md +13 -0
  787. package/docs/reference/typescript-api/payment/dummy-payment-handler.md +31 -0
  788. package/docs/reference/typescript-api/payment/index.md +5 -0
  789. package/docs/reference/typescript-api/payment/payment-method-config-options.md +69 -0
  790. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.md +95 -0
  791. package/docs/reference/typescript-api/payment/payment-method-handler.md +83 -0
  792. package/docs/reference/typescript-api/payment/payment-method-types.md +386 -0
  793. package/docs/reference/typescript-api/payment/payment-options.md +57 -0
  794. package/docs/reference/typescript-api/payment/payment-process.md +62 -0
  795. package/docs/reference/typescript-api/payment/payment-state.md +20 -0
  796. package/docs/reference/typescript-api/payment/payment-states.md +18 -0
  797. package/docs/reference/typescript-api/payment/payment-transition-data.md +42 -0
  798. package/docs/reference/typescript-api/payment/refund-process.md +55 -0
  799. package/docs/reference/typescript-api/payment/refund-state.md +16 -0
  800. package/docs/reference/typescript-api/payment/refund-states.md +18 -0
  801. package/docs/reference/typescript-api/payment/refund-transition-data.md +41 -0
  802. package/docs/reference/typescript-api/plugin/index.md +5 -0
  803. package/docs/reference/typescript-api/plugin/plugin-common-module.md +28 -0
  804. package/docs/reference/typescript-api/plugin/plugin-utilities.md +96 -0
  805. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.md +147 -0
  806. package/docs/reference/typescript-api/plugin/vendure-plugin.md +52 -0
  807. package/docs/reference/typescript-api/products-stock/catalog-options.md +70 -0
  808. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.md +38 -0
  809. package/docs/reference/typescript-api/products-stock/default-stock-display-strategy.md +40 -0
  810. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.md +47 -0
  811. package/docs/reference/typescript-api/products-stock/index.md +5 -0
  812. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.md +47 -0
  813. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.md +95 -0
  814. package/docs/reference/typescript-api/products-stock/stock-display-strategy.md +47 -0
  815. package/docs/reference/typescript-api/products-stock/stock-location-strategy.md +157 -0
  816. package/docs/reference/typescript-api/promotions/facet-value-checker.md +78 -0
  817. package/docs/reference/typescript-api/promotions/index.md +5 -0
  818. package/docs/reference/typescript-api/promotions/promotion-action.md +454 -0
  819. package/docs/reference/typescript-api/promotions/promotion-condition.md +117 -0
  820. package/docs/reference/typescript-api/promotions/promotion-options.md +35 -0
  821. package/docs/reference/typescript-api/request/allow-decorator.md +53 -0
  822. package/docs/reference/typescript-api/request/api-decorator.md +28 -0
  823. package/docs/reference/typescript-api/request/api-type.md +16 -0
  824. package/docs/reference/typescript-api/request/ctx-decorator.md +23 -0
  825. package/docs/reference/typescript-api/request/index.md +5 -0
  826. package/docs/reference/typescript-api/request/relations-decorator.md +116 -0
  827. package/docs/reference/typescript-api/request/request-context-service.md +47 -0
  828. package/docs/reference/typescript-api/request/request-context.md +205 -0
  829. package/docs/reference/typescript-api/request/transaction-decorator.md +82 -0
  830. package/docs/reference/typescript-api/scheduled-tasks/clean-sessions-task.md +40 -0
  831. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-plugin.md +86 -0
  832. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.md +76 -0
  833. package/docs/reference/typescript-api/scheduled-tasks/index.md +5 -0
  834. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.md +196 -0
  835. package/docs/reference/typescript-api/scheduled-tasks/scheduler-options.md +47 -0
  836. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.md +62 -0
  837. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.md +141 -0
  838. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.md +43 -0
  839. package/docs/reference/typescript-api/service-helpers/index.md +5 -0
  840. package/docs/reference/typescript-api/service-helpers/order-calculator.md +54 -0
  841. package/docs/reference/typescript-api/service-helpers/order-modifier.md +91 -0
  842. package/docs/reference/typescript-api/service-helpers/product-price-applicator.md +62 -0
  843. package/docs/reference/typescript-api/service-helpers/slug-validator.md +86 -0
  844. package/docs/reference/typescript-api/service-helpers/translatable-saver.md +66 -0
  845. package/docs/reference/typescript-api/service-helpers/translator-service.md +63 -0
  846. package/docs/reference/typescript-api/services/administrator-service.md +71 -0
  847. package/docs/reference/typescript-api/services/asset-service.md +177 -0
  848. package/docs/reference/typescript-api/services/auth-service.md +54 -0
  849. package/docs/reference/typescript-api/services/channel-service.md +111 -0
  850. package/docs/reference/typescript-api/services/collection-service.md +186 -0
  851. package/docs/reference/typescript-api/services/country-service.md +71 -0
  852. package/docs/reference/typescript-api/services/customer-group-service.md +77 -0
  853. package/docs/reference/typescript-api/services/customer-service.md +203 -0
  854. package/docs/reference/typescript-api/services/entity-slug-service.md +37 -0
  855. package/docs/reference/typescript-api/services/facet-service.md +95 -0
  856. package/docs/reference/typescript-api/services/facet-value-service.md +104 -0
  857. package/docs/reference/typescript-api/services/fulfillment-service.md +69 -0
  858. package/docs/reference/typescript-api/services/global-settings-service.md +41 -0
  859. package/docs/reference/typescript-api/services/history-service.md +172 -0
  860. package/docs/reference/typescript-api/services/index.md +5 -0
  861. package/docs/reference/typescript-api/services/initializer-service.md +36 -0
  862. package/docs/reference/typescript-api/services/order-service.md +440 -0
  863. package/docs/reference/typescript-api/services/order-testing-service.md +44 -0
  864. package/docs/reference/typescript-api/services/payment-method-service.md +105 -0
  865. package/docs/reference/typescript-api/services/payment-service.md +105 -0
  866. package/docs/reference/typescript-api/services/product-option-group-service.md +67 -0
  867. package/docs/reference/typescript-api/services/product-option-service.md +64 -0
  868. package/docs/reference/typescript-api/services/product-service.md +111 -0
  869. package/docs/reference/typescript-api/services/product-variant-service.md +179 -0
  870. package/docs/reference/typescript-api/services/promotion-service.md +127 -0
  871. package/docs/reference/typescript-api/services/province-service.md +59 -0
  872. package/docs/reference/typescript-api/services/role-service.md +113 -0
  873. package/docs/reference/typescript-api/services/search-service.md +37 -0
  874. package/docs/reference/typescript-api/services/seller-service.md +65 -0
  875. package/docs/reference/typescript-api/services/session-service.md +105 -0
  876. package/docs/reference/typescript-api/services/settings-store-service.md +194 -0
  877. package/docs/reference/typescript-api/services/shipping-method-service.md +95 -0
  878. package/docs/reference/typescript-api/services/slug-service.md +35 -0
  879. package/docs/reference/typescript-api/services/stock-level-service.md +62 -0
  880. package/docs/reference/typescript-api/services/stock-location-service.md +115 -0
  881. package/docs/reference/typescript-api/services/stock-movement-service.md +95 -0
  882. package/docs/reference/typescript-api/services/tag-service.md +71 -0
  883. package/docs/reference/typescript-api/services/tax-category-service.md +59 -0
  884. package/docs/reference/typescript-api/services/tax-rate-service.md +66 -0
  885. package/docs/reference/typescript-api/services/user-service.md +132 -0
  886. package/docs/reference/typescript-api/services/zone-service.md +77 -0
  887. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-options.md +48 -0
  888. package/docs/reference/typescript-api/settings-store/cleanup-orphaned-settings-store-entries-result.md +41 -0
  889. package/docs/reference/typescript-api/settings-store/index.md +38 -0
  890. package/docs/reference/typescript-api/settings-store/orphaned-settings-store-entry.md +48 -0
  891. package/docs/reference/typescript-api/settings-store/set-settings-store-value-result.md +42 -0
  892. package/docs/reference/typescript-api/settings-store/settings-store-field-config.md +92 -0
  893. package/docs/reference/typescript-api/settings-store/settings-store-registration.md +36 -0
  894. package/docs/reference/typescript-api/settings-store/settings-store-scope-function.md +35 -0
  895. package/docs/reference/typescript-api/settings-store/settings-store-scopes.md +36 -0
  896. package/docs/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn.md +27 -0
  897. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.md +33 -0
  898. package/docs/reference/typescript-api/shipping/index.md +5 -0
  899. package/docs/reference/typescript-api/shipping/shipping-calculator.md +121 -0
  900. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.md +39 -0
  901. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.md +60 -0
  902. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.md +75 -0
  903. package/docs/reference/typescript-api/shipping/shipping-options.md +63 -0
  904. package/docs/reference/typescript-api/shipping/should-run-check-fn.md +44 -0
  905. package/docs/reference/typescript-api/state-machine/fsm.md +66 -0
  906. package/docs/reference/typescript-api/state-machine/index.md +5 -0
  907. package/docs/reference/typescript-api/state-machine/state-machine-config.md +103 -0
  908. package/docs/reference/typescript-api/state-machine/transitions.md +43 -0
  909. package/docs/reference/typescript-api/tax/address-based-tax-zone-strategy.md +57 -0
  910. package/docs/reference/typescript-api/tax/default-tax-line-calculation-strategy.md +33 -0
  911. package/docs/reference/typescript-api/tax/default-tax-zone-strategy.md +35 -0
  912. package/docs/reference/typescript-api/tax/index.md +5 -0
  913. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.md +90 -0
  914. package/docs/reference/typescript-api/tax/tax-options.md +35 -0
  915. package/docs/reference/typescript-api/tax/tax-zone-strategy.md +54 -0
  916. package/docs/reference/typescript-api/telemetry/index.md +5 -0
  917. package/docs/reference/typescript-api/telemetry/instrument.md +47 -0
  918. package/docs/reference/typescript-api/telemetry/instrumentation-strategy.md +35 -0
  919. package/docs/reference/typescript-api/telemetry/wrapped-method-args.md +56 -0
  920. package/docs/reference/typescript-api/testing/create-error-result-guard.md +33 -0
  921. package/docs/reference/typescript-api/testing/create-test-environment.md +47 -0
  922. package/docs/reference/typescript-api/testing/error-result-guard.md +73 -0
  923. package/docs/reference/typescript-api/testing/get-superadmin-context.md +23 -0
  924. package/docs/reference/typescript-api/testing/index.md +5 -0
  925. package/docs/reference/typescript-api/testing/register-initializer.md +27 -0
  926. package/docs/reference/typescript-api/testing/simple-graph-qlclient.md +123 -0
  927. package/docs/reference/typescript-api/testing/test-config.md +30 -0
  928. package/docs/reference/typescript-api/testing/test-db-initializer.md +60 -0
  929. package/docs/reference/typescript-api/testing/test-environment.md +42 -0
  930. package/docs/reference/typescript-api/testing/test-server-options.md +47 -0
  931. package/docs/reference/typescript-api/testing/test-server.md +60 -0
  932. package/docs/reference/typescript-api/testing/testing-logger.md +140 -0
  933. package/docs/reference/typescript-api/worker/bootstrap-worker.md +76 -0
  934. package/docs/reference/typescript-api/worker/index.md +5 -0
  935. package/docs/reference/typescript-api/worker/vendure-worker.md +50 -0
  936. package/docs/reference/typescript-api/worker/worker-health-check-config.md +41 -0
  937. package/docs/user-guide/catalog/collections.md +27 -0
  938. package/docs/user-guide/catalog/facets.md +34 -0
  939. package/docs/user-guide/catalog/product-variants.png +0 -0
  940. package/docs/user-guide/catalog/products.md +35 -0
  941. package/docs/user-guide/catalog/screen-facet-add.webp +0 -0
  942. package/docs/user-guide/catalog/screen-facet-list.webp +0 -0
  943. package/docs/user-guide/catalog/screen-inventory.webp +0 -0
  944. package/docs/user-guide/customers/index.md +30 -0
  945. package/docs/user-guide/customers/screen-customer-group.webp +0 -0
  946. package/docs/user-guide/index.md +7 -0
  947. package/docs/user-guide/localization/index.md +42 -0
  948. package/docs/user-guide/localization/screen-ui-language.webp +0 -0
  949. package/docs/user-guide/orders/draft-orders.md +28 -0
  950. package/docs/user-guide/orders/order-state-diagram-for-admin.png +0 -0
  951. package/docs/user-guide/orders/orders.md +65 -0
  952. package/docs/user-guide/orders/screen-fulfillment-shipped.webp +0 -0
  953. package/docs/user-guide/orders/screen-fulfillment.webp +0 -0
  954. package/docs/user-guide/orders/screen-modification.webp +0 -0
  955. package/docs/user-guide/orders/screen-modify-button.webp +0 -0
  956. package/docs/user-guide/orders/screen-refund-button.webp +0 -0
  957. package/docs/user-guide/orders/screen-settle-payment.webp +0 -0
  958. package/docs/user-guide/promotions/index.md +44 -0
  959. package/docs/user-guide/settings/administrators-roles.md +34 -0
  960. package/docs/user-guide/settings/channels.md +18 -0
  961. package/docs/user-guide/settings/countries-zones.md +12 -0
  962. package/docs/user-guide/settings/global-settings.md +12 -0
  963. package/docs/user-guide/settings/payment-methods.md +32 -0
  964. package/docs/user-guide/settings/screen-shipping-test.webp +0 -0
  965. package/docs/user-guide/settings/screen-translations.webp +0 -0
  966. package/docs/user-guide/settings/shipping-methods.md +55 -0
  967. package/docs/user-guide/settings/taxes.md +32 -0
  968. package/package.json +32 -0
@@ -0,0 +1,3406 @@
1
+ ---
2
+ title: "Types"
3
+ generated: true
4
+ ---
5
+ <!-- This file was generated from the Vendure source. Do not modify. Instead, re-run the "docs:build" script -->
6
+
7
+
8
+
9
+ ## ActiveOrderResult
10
+
11
+ <div class="graphql-code-block">
12
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">ActiveOrderResult</span> =</div>
13
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#noactiveordererror">NoActiveOrderError</a></div>
14
+ </div>
15
+
16
+ ## AddPaymentToOrderResult
17
+
18
+ <div class="graphql-code-block">
19
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">AddPaymentToOrderResult</span> =</div>
20
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#orderpaymentstateerror">OrderPaymentStateError</a> | <a href="/reference/graphql-api/shop/object-types#ineligiblepaymentmethoderror">IneligiblePaymentMethodError</a> | <a href="/reference/graphql-api/shop/object-types#paymentfailederror">PaymentFailedError</a> | <a href="/reference/graphql-api/shop/object-types#paymentdeclinederror">PaymentDeclinedError</a> | <a href="/reference/graphql-api/shop/object-types#orderstatetransitionerror">OrderStateTransitionError</a> | <a href="/reference/graphql-api/shop/object-types#noactiveordererror">NoActiveOrderError</a></div>
21
+ </div>
22
+
23
+ ## Address
24
+
25
+ <div class="graphql-code-block">
26
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Address</span> &#123;</div>
27
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
28
+
29
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
30
+
31
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
32
+
33
+ <div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
34
+
35
+ <div class="graphql-code-line ">company: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
36
+
37
+ <div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
38
+
39
+ <div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
40
+
41
+ <div class="graphql-code-line ">city: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
42
+
43
+ <div class="graphql-code-line ">province: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
44
+
45
+ <div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
46
+
47
+ <div class="graphql-code-line ">country: <a href="/reference/graphql-api/shop/object-types#country">Country</a>!</div>
48
+
49
+ <div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
50
+
51
+ <div class="graphql-code-line ">defaultShippingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
52
+
53
+ <div class="graphql-code-line ">defaultBillingAddress: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
54
+
55
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
56
+
57
+
58
+ <div class="graphql-code-line top-level">&#125;</div>
59
+ </div>
60
+
61
+ ## Adjustment
62
+
63
+ <div class="graphql-code-block">
64
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Adjustment</span> &#123;</div>
65
+ <div class="graphql-code-line ">adjustmentSource: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
66
+
67
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/enums#adjustmenttype">AdjustmentType</a>!</div>
68
+
69
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
70
+
71
+ <div class="graphql-code-line ">amount: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
72
+
73
+ <div class="graphql-code-line ">data: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
74
+
75
+
76
+ <div class="graphql-code-line top-level">&#125;</div>
77
+ </div>
78
+
79
+ ## AlreadyLoggedInError
80
+
81
+ <div class="graphql-code-block">
82
+ <div class="graphql-code-line top-level comment">"""</div>
83
+ <div class="graphql-code-line top-level comment">Returned when attempting to set the Customer for an Order when already logged in.</div>
84
+ <div class="graphql-code-line top-level comment">"""</div>
85
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">AlreadyLoggedInError</span> &#123;</div>
86
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
87
+
88
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
89
+
90
+
91
+ <div class="graphql-code-line top-level">&#125;</div>
92
+ </div>
93
+
94
+ ## ApplyCouponCodeResult
95
+
96
+ <div class="graphql-code-block">
97
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">ApplyCouponCodeResult</span> =</div>
98
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#couponcodeexpirederror">CouponCodeExpiredError</a> | <a href="/reference/graphql-api/shop/object-types#couponcodeinvaliderror">CouponCodeInvalidError</a> | <a href="/reference/graphql-api/shop/object-types#couponcodelimiterror">CouponCodeLimitError</a></div>
99
+ </div>
100
+
101
+ ## Asset
102
+
103
+ <div class="graphql-code-block">
104
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Asset</span> &#123;</div>
105
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
106
+
107
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
108
+
109
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
110
+
111
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
112
+
113
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/enums#assettype">AssetType</a>!</div>
114
+
115
+ <div class="graphql-code-line ">fileSize: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
116
+
117
+ <div class="graphql-code-line ">mimeType: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
118
+
119
+ <div class="graphql-code-line ">width: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
120
+
121
+ <div class="graphql-code-line ">height: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
122
+
123
+ <div class="graphql-code-line ">source: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
124
+
125
+ <div class="graphql-code-line ">preview: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
126
+
127
+ <div class="graphql-code-line ">focalPoint: <a href="/reference/graphql-api/shop/object-types#coordinate">Coordinate</a></div>
128
+
129
+ <div class="graphql-code-line ">tags: [<a href="/reference/graphql-api/shop/object-types#tag">Tag</a>!]!</div>
130
+
131
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
132
+
133
+
134
+ <div class="graphql-code-line top-level">&#125;</div>
135
+ </div>
136
+
137
+ ## AssetList
138
+
139
+ <div class="graphql-code-block">
140
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">AssetList</span> &#123;</div>
141
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#asset">Asset</a>!]!</div>
142
+
143
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
144
+
145
+
146
+ <div class="graphql-code-line top-level">&#125;</div>
147
+ </div>
148
+
149
+ ## AuthenticationMethod
150
+
151
+ <div class="graphql-code-block">
152
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">AuthenticationMethod</span> &#123;</div>
153
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
154
+
155
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
156
+
157
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
158
+
159
+ <div class="graphql-code-line ">strategy: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
160
+
161
+
162
+ <div class="graphql-code-line top-level">&#125;</div>
163
+ </div>
164
+
165
+ ## AuthenticationResult
166
+
167
+ <div class="graphql-code-block">
168
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">AuthenticationResult</span> =</div>
169
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#currentuser">CurrentUser</a> | <a href="/reference/graphql-api/shop/object-types#invalidcredentialserror">InvalidCredentialsError</a> | <a href="/reference/graphql-api/shop/object-types#notverifiederror">NotVerifiedError</a></div>
170
+ </div>
171
+
172
+ ## Boolean
173
+
174
+ <div class="graphql-code-block">
175
+ <div class="graphql-code-line top-level comment">"""</div>
176
+ <div class="graphql-code-line top-level comment">The <code>Boolean</code> scalar type represents <code>true</code> or `false`.</div>
177
+ <div class="graphql-code-line top-level comment">"""</div>
178
+ <div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Boolean</span></div>
179
+ </div>
180
+
181
+ ## BooleanCustomFieldConfig
182
+
183
+ <div class="graphql-code-block">
184
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">BooleanCustomFieldConfig</span> &#123;</div>
185
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
186
+
187
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
188
+
189
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
190
+
191
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
192
+
193
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
194
+
195
+ <div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
196
+
197
+ <div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
198
+
199
+ <div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
200
+
201
+ <div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
202
+
203
+ <div class="graphql-code-line ">deprecated: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
204
+
205
+ <div class="graphql-code-line ">deprecationReason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
206
+
207
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
208
+
209
+
210
+ <div class="graphql-code-line top-level">&#125;</div>
211
+ </div>
212
+
213
+ ## BooleanStructFieldConfig
214
+
215
+ <div class="graphql-code-block">
216
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">BooleanStructFieldConfig</span> &#123;</div>
217
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
218
+
219
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
220
+
221
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
222
+
223
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
224
+
225
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
226
+
227
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
228
+
229
+
230
+ <div class="graphql-code-line top-level">&#125;</div>
231
+ </div>
232
+
233
+ ## Channel
234
+
235
+ <div class="graphql-code-block">
236
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Channel</span> &#123;</div>
237
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
238
+
239
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
240
+
241
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
242
+
243
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
244
+
245
+ <div class="graphql-code-line ">token: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
246
+
247
+ <div class="graphql-code-line ">defaultTaxZone: <a href="/reference/graphql-api/shop/object-types#zone">Zone</a></div>
248
+
249
+ <div class="graphql-code-line ">defaultShippingZone: <a href="/reference/graphql-api/shop/object-types#zone">Zone</a></div>
250
+
251
+ <div class="graphql-code-line ">defaultLanguageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
252
+
253
+ <div class="graphql-code-line ">availableLanguageCodes: [<a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!]</div>
254
+
255
+ <div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!</div>
256
+
257
+ <div class="graphql-code-line ">defaultCurrencyCode: <a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!</div>
258
+
259
+ <div class="graphql-code-line ">availableCurrencyCodes: [<a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!]!</div>
260
+
261
+ <div class="graphql-code-line comment">"""</div>
262
+ <div class="graphql-code-line comment">Not yet used - will be implemented in a future release.</div>
263
+ <div class="graphql-code-line comment">"""</div>
264
+ <div class="graphql-code-line ">trackInventory: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
265
+
266
+ <div class="graphql-code-line comment">"""</div>
267
+ <div class="graphql-code-line comment">Not yet used - will be implemented in a future release.</div>
268
+ <div class="graphql-code-line comment">"""</div>
269
+ <div class="graphql-code-line ">outOfStockThreshold: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
270
+
271
+ <div class="graphql-code-line ">pricesIncludeTax: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
272
+
273
+ <div class="graphql-code-line ">seller: <a href="/reference/graphql-api/shop/object-types#seller">Seller</a></div>
274
+
275
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
276
+
277
+
278
+ <div class="graphql-code-line top-level">&#125;</div>
279
+ </div>
280
+
281
+ ## Collection
282
+
283
+ <div class="graphql-code-block">
284
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Collection</span> &#123;</div>
285
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
286
+
287
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
288
+
289
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
290
+
291
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a></div>
292
+
293
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
294
+
295
+ <div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
296
+
297
+ <div class="graphql-code-line ">breadcrumbs: [<a href="/reference/graphql-api/shop/object-types#collectionbreadcrumb">CollectionBreadcrumb</a>!]!</div>
298
+
299
+ <div class="graphql-code-line ">position: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
300
+
301
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
302
+
303
+ <div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/shop/object-types#asset">Asset</a></div>
304
+
305
+ <div class="graphql-code-line ">assets: [<a href="/reference/graphql-api/shop/object-types#asset">Asset</a>!]!</div>
306
+
307
+ <div class="graphql-code-line ">parent: <a href="/reference/graphql-api/shop/object-types#collection">Collection</a></div>
308
+
309
+ <div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
310
+
311
+ <div class="graphql-code-line ">children: [<a href="/reference/graphql-api/shop/object-types#collection">Collection</a>!]</div>
312
+
313
+ <div class="graphql-code-line ">filters: [<a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!]!</div>
314
+
315
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#collectiontranslation">CollectionTranslation</a>!]!</div>
316
+
317
+ <div class="graphql-code-line ">productVariants(options: <a href="/reference/graphql-api/shop/input-types#productvariantlistoptions">ProductVariantListOptions</a>): <a href="/reference/graphql-api/shop/object-types#productvariantlist">ProductVariantList</a>!</div>
318
+
319
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
320
+
321
+
322
+ <div class="graphql-code-line top-level">&#125;</div>
323
+ </div>
324
+
325
+ ## CollectionBreadcrumb
326
+
327
+ <div class="graphql-code-block">
328
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionBreadcrumb</span> &#123;</div>
329
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
330
+
331
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
332
+
333
+ <div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
334
+
335
+
336
+ <div class="graphql-code-line top-level">&#125;</div>
337
+ </div>
338
+
339
+ ## CollectionList
340
+
341
+ <div class="graphql-code-block">
342
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionList</span> &#123;</div>
343
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#collection">Collection</a>!]!</div>
344
+
345
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
346
+
347
+
348
+ <div class="graphql-code-line top-level">&#125;</div>
349
+ </div>
350
+
351
+ ## CollectionResult
352
+
353
+ <div class="graphql-code-block">
354
+ <div class="graphql-code-line top-level comment">"""</div>
355
+ <div class="graphql-code-line top-level comment">Which Collections are present in the products returned</div>
356
+
357
+ <div class="graphql-code-line top-level comment">by the search, and in what quantity.</div>
358
+ <div class="graphql-code-line top-level comment">"""</div>
359
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionResult</span> &#123;</div>
360
+ <div class="graphql-code-line ">collection: <a href="/reference/graphql-api/shop/object-types#collection">Collection</a>!</div>
361
+
362
+ <div class="graphql-code-line ">count: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
363
+
364
+
365
+ <div class="graphql-code-line top-level">&#125;</div>
366
+ </div>
367
+
368
+ ## CollectionTranslation
369
+
370
+ <div class="graphql-code-block">
371
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CollectionTranslation</span> &#123;</div>
372
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
373
+
374
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
375
+
376
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
377
+
378
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
379
+
380
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
381
+
382
+ <div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
383
+
384
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
385
+
386
+
387
+ <div class="graphql-code-line top-level">&#125;</div>
388
+ </div>
389
+
390
+ ## ConfigArg
391
+
392
+ <div class="graphql-code-block">
393
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigArg</span> &#123;</div>
394
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
395
+
396
+ <div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
397
+
398
+
399
+ <div class="graphql-code-line top-level">&#125;</div>
400
+ </div>
401
+
402
+ ## ConfigArgDefinition
403
+
404
+ <div class="graphql-code-block">
405
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigArgDefinition</span> &#123;</div>
406
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
407
+
408
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
409
+
410
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
411
+
412
+ <div class="graphql-code-line ">required: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
413
+
414
+ <div class="graphql-code-line ">defaultValue: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
415
+
416
+ <div class="graphql-code-line ">label: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
417
+
418
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
419
+
420
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
421
+
422
+
423
+ <div class="graphql-code-line top-level">&#125;</div>
424
+ </div>
425
+
426
+ ## ConfigurableOperation
427
+
428
+ <div class="graphql-code-block">
429
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigurableOperation</span> &#123;</div>
430
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
431
+
432
+ <div class="graphql-code-line ">args: [<a href="/reference/graphql-api/shop/object-types#configarg">ConfigArg</a>!]!</div>
433
+
434
+
435
+ <div class="graphql-code-line top-level">&#125;</div>
436
+ </div>
437
+
438
+ ## ConfigurableOperationDefinition
439
+
440
+ <div class="graphql-code-block">
441
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ConfigurableOperationDefinition</span> &#123;</div>
442
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
443
+
444
+ <div class="graphql-code-line ">args: [<a href="/reference/graphql-api/shop/object-types#configargdefinition">ConfigArgDefinition</a>!]!</div>
445
+
446
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
447
+
448
+
449
+ <div class="graphql-code-line top-level">&#125;</div>
450
+ </div>
451
+
452
+ ## Coordinate
453
+
454
+ <div class="graphql-code-block">
455
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Coordinate</span> &#123;</div>
456
+ <div class="graphql-code-line ">x: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
457
+
458
+ <div class="graphql-code-line ">y: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
459
+
460
+
461
+ <div class="graphql-code-line top-level">&#125;</div>
462
+ </div>
463
+
464
+ ## Country
465
+
466
+ <div class="graphql-code-block">
467
+ <div class="graphql-code-line top-level comment">"""</div>
468
+ <div class="graphql-code-line top-level comment">A Country of the world which your shop operates in.</div>
469
+
470
+ <div class="graphql-code-line top-level comment"></div>
471
+
472
+ <div class="graphql-code-line top-level comment">The <code>code</code> field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as</div>
473
+
474
+ <div class="graphql-code-line top-level comment">`UpdateAddressInput` and <code>CreateAddressInput</code> to specify the country.</div>
475
+ <div class="graphql-code-line top-level comment">"""</div>
476
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Country</span> &#123;</div>
477
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
478
+
479
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
480
+
481
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
482
+
483
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
484
+
485
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
486
+
487
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
488
+
489
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
490
+
491
+ <div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
492
+
493
+ <div class="graphql-code-line ">parent: <a href="/reference/graphql-api/shop/object-types#region">Region</a></div>
494
+
495
+ <div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/shop/object-types#id">ID</a></div>
496
+
497
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#regiontranslation">RegionTranslation</a>!]!</div>
498
+
499
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
500
+
501
+
502
+ <div class="graphql-code-line top-level">&#125;</div>
503
+ </div>
504
+
505
+ ## CountryList
506
+
507
+ <div class="graphql-code-block">
508
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CountryList</span> &#123;</div>
509
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#country">Country</a>!]!</div>
510
+
511
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
512
+
513
+
514
+ <div class="graphql-code-line top-level">&#125;</div>
515
+ </div>
516
+
517
+ ## CouponCodeExpiredError
518
+
519
+ <div class="graphql-code-block">
520
+ <div class="graphql-code-line top-level comment">"""</div>
521
+ <div class="graphql-code-line top-level comment">Returned if the provided coupon code is invalid</div>
522
+ <div class="graphql-code-line top-level comment">"""</div>
523
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CouponCodeExpiredError</span> &#123;</div>
524
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
525
+
526
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
527
+
528
+ <div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
529
+
530
+
531
+ <div class="graphql-code-line top-level">&#125;</div>
532
+ </div>
533
+
534
+ ## CouponCodeInvalidError
535
+
536
+ <div class="graphql-code-block">
537
+ <div class="graphql-code-line top-level comment">"""</div>
538
+ <div class="graphql-code-line top-level comment">Returned if the provided coupon code is invalid</div>
539
+ <div class="graphql-code-line top-level comment">"""</div>
540
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CouponCodeInvalidError</span> &#123;</div>
541
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
542
+
543
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
544
+
545
+ <div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
546
+
547
+
548
+ <div class="graphql-code-line top-level">&#125;</div>
549
+ </div>
550
+
551
+ ## CouponCodeLimitError
552
+
553
+ <div class="graphql-code-block">
554
+ <div class="graphql-code-line top-level comment">"""</div>
555
+ <div class="graphql-code-line top-level comment">Returned if the provided coupon code is invalid</div>
556
+ <div class="graphql-code-line top-level comment">"""</div>
557
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CouponCodeLimitError</span> &#123;</div>
558
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
559
+
560
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
561
+
562
+ <div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
563
+
564
+ <div class="graphql-code-line ">limit: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
565
+
566
+
567
+ <div class="graphql-code-line top-level">&#125;</div>
568
+ </div>
569
+
570
+ ## CurrentUser
571
+
572
+ <div class="graphql-code-block">
573
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CurrentUser</span> &#123;</div>
574
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
575
+
576
+ <div class="graphql-code-line ">identifier: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
577
+
578
+ <div class="graphql-code-line ">channels: [<a href="/reference/graphql-api/shop/object-types#currentuserchannel">CurrentUserChannel</a>!]!</div>
579
+
580
+
581
+ <div class="graphql-code-line top-level">&#125;</div>
582
+ </div>
583
+
584
+ ## CurrentUserChannel
585
+
586
+ <div class="graphql-code-block">
587
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CurrentUserChannel</span> &#123;</div>
588
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
589
+
590
+ <div class="graphql-code-line ">token: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
591
+
592
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
593
+
594
+ <div class="graphql-code-line ">permissions: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]!</div>
595
+
596
+
597
+ <div class="graphql-code-line top-level">&#125;</div>
598
+ </div>
599
+
600
+ ## CustomFieldConfig
601
+
602
+ <div class="graphql-code-block">
603
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">CustomFieldConfig</span> =</div>
604
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#stringcustomfieldconfig">StringCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#localestringcustomfieldconfig">LocaleStringCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#intcustomfieldconfig">IntCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#floatcustomfieldconfig">FloatCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#booleancustomfieldconfig">BooleanCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#datetimecustomfieldconfig">DateTimeCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#relationcustomfieldconfig">RelationCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#textcustomfieldconfig">TextCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#localetextcustomfieldconfig">LocaleTextCustomFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#structcustomfieldconfig">StructCustomFieldConfig</a></div>
605
+ </div>
606
+
607
+ ## Customer
608
+
609
+ <div class="graphql-code-block">
610
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Customer</span> &#123;</div>
611
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
612
+
613
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
614
+
615
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
616
+
617
+ <div class="graphql-code-line ">title: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
618
+
619
+ <div class="graphql-code-line ">firstName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
620
+
621
+ <div class="graphql-code-line ">lastName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
622
+
623
+ <div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
624
+
625
+ <div class="graphql-code-line ">emailAddress: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
626
+
627
+ <div class="graphql-code-line ">addresses: [<a href="/reference/graphql-api/shop/object-types#address">Address</a>!]</div>
628
+
629
+ <div class="graphql-code-line ">orders(options: <a href="/reference/graphql-api/shop/input-types#orderlistoptions">OrderListOptions</a>): <a href="/reference/graphql-api/shop/object-types#orderlist">OrderList</a>!</div>
630
+
631
+ <div class="graphql-code-line ">user: <a href="/reference/graphql-api/shop/object-types#user">User</a></div>
632
+
633
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
634
+
635
+
636
+ <div class="graphql-code-line top-level">&#125;</div>
637
+ </div>
638
+
639
+ ## CustomerGroup
640
+
641
+ <div class="graphql-code-block">
642
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CustomerGroup</span> &#123;</div>
643
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
644
+
645
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
646
+
647
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
648
+
649
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
650
+
651
+ <div class="graphql-code-line ">customers(options: <a href="/reference/graphql-api/shop/input-types#customerlistoptions">CustomerListOptions</a>): <a href="/reference/graphql-api/shop/object-types#customerlist">CustomerList</a>!</div>
652
+
653
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
654
+
655
+
656
+ <div class="graphql-code-line top-level">&#125;</div>
657
+ </div>
658
+
659
+ ## CustomerList
660
+
661
+ <div class="graphql-code-block">
662
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">CustomerList</span> &#123;</div>
663
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#customer">Customer</a>!]!</div>
664
+
665
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
666
+
667
+
668
+ <div class="graphql-code-line top-level">&#125;</div>
669
+ </div>
670
+
671
+ ## DateTime
672
+
673
+ <div class="graphql-code-block">
674
+ <div class="graphql-code-line top-level comment">"""</div>
675
+ <div class="graphql-code-line top-level comment">A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the <code>date-time</code> format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.</div>
676
+ <div class="graphql-code-line top-level comment">"""</div>
677
+ <div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">DateTime</span></div>
678
+ </div>
679
+
680
+ ## DateTimeCustomFieldConfig
681
+
682
+ <div class="graphql-code-block">
683
+ <div class="graphql-code-line top-level comment">"""</div>
684
+ <div class="graphql-code-line top-level comment">Expects the same validation formats as the <code>&lt;input type="datetime-local"&gt;</code> HTML element.</div>
685
+
686
+ <div class="graphql-code-line top-level comment">See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes</div>
687
+ <div class="graphql-code-line top-level comment">"""</div>
688
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">DateTimeCustomFieldConfig</span> &#123;</div>
689
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
690
+
691
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
692
+
693
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
694
+
695
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
696
+
697
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
698
+
699
+ <div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
700
+
701
+ <div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
702
+
703
+ <div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
704
+
705
+ <div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
706
+
707
+ <div class="graphql-code-line ">deprecated: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
708
+
709
+ <div class="graphql-code-line ">deprecationReason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
710
+
711
+ <div class="graphql-code-line ">min: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
712
+
713
+ <div class="graphql-code-line ">max: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
714
+
715
+ <div class="graphql-code-line ">step: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
716
+
717
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
718
+
719
+
720
+ <div class="graphql-code-line top-level">&#125;</div>
721
+ </div>
722
+
723
+ ## DateTimeStructFieldConfig
724
+
725
+ <div class="graphql-code-block">
726
+ <div class="graphql-code-line top-level comment">"""</div>
727
+ <div class="graphql-code-line top-level comment">Expects the same validation formats as the <code>&lt;input type="datetime-local"&gt;</code> HTML element.</div>
728
+
729
+ <div class="graphql-code-line top-level comment">See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes</div>
730
+ <div class="graphql-code-line top-level comment">"""</div>
731
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">DateTimeStructFieldConfig</span> &#123;</div>
732
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
733
+
734
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
735
+
736
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
737
+
738
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
739
+
740
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
741
+
742
+ <div class="graphql-code-line ">min: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
743
+
744
+ <div class="graphql-code-line ">max: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
745
+
746
+ <div class="graphql-code-line ">step: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
747
+
748
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
749
+
750
+
751
+ <div class="graphql-code-line top-level">&#125;</div>
752
+ </div>
753
+
754
+ ## DeletionResponse
755
+
756
+ <div class="graphql-code-block">
757
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">DeletionResponse</span> &#123;</div>
758
+ <div class="graphql-code-line ">result: <a href="/reference/graphql-api/shop/enums#deletionresult">DeletionResult</a>!</div>
759
+
760
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
761
+
762
+
763
+ <div class="graphql-code-line top-level">&#125;</div>
764
+ </div>
765
+
766
+ ## Discount
767
+
768
+ <div class="graphql-code-block">
769
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Discount</span> &#123;</div>
770
+ <div class="graphql-code-line ">adjustmentSource: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
771
+
772
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/enums#adjustmenttype">AdjustmentType</a>!</div>
773
+
774
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
775
+
776
+ <div class="graphql-code-line ">amount: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
777
+
778
+ <div class="graphql-code-line ">amountWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
779
+
780
+
781
+ <div class="graphql-code-line top-level">&#125;</div>
782
+ </div>
783
+
784
+ ## EmailAddressConflictError
785
+
786
+ <div class="graphql-code-block">
787
+ <div class="graphql-code-line top-level comment">"""</div>
788
+ <div class="graphql-code-line top-level comment">Returned when attempting to create a Customer with an email address already registered to an existing User.</div>
789
+ <div class="graphql-code-line top-level comment">"""</div>
790
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">EmailAddressConflictError</span> &#123;</div>
791
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
792
+
793
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
794
+
795
+
796
+ <div class="graphql-code-line top-level">&#125;</div>
797
+ </div>
798
+
799
+ ## Facet
800
+
801
+ <div class="graphql-code-block">
802
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Facet</span> &#123;</div>
803
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
804
+
805
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
806
+
807
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
808
+
809
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
810
+
811
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
812
+
813
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
814
+
815
+ <div class="graphql-code-line ">values: [<a href="/reference/graphql-api/shop/object-types#facetvalue">FacetValue</a>!]!</div>
816
+
817
+ <div class="graphql-code-line comment">"""</div>
818
+ <div class="graphql-code-line comment">Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0.</div>
819
+ <div class="graphql-code-line comment">"""</div>
820
+ <div class="graphql-code-line ">valueList(options: <a href="/reference/graphql-api/shop/input-types#facetvaluelistoptions">FacetValueListOptions</a>): <a href="/reference/graphql-api/shop/object-types#facetvaluelist">FacetValueList</a>!</div>
821
+
822
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#facettranslation">FacetTranslation</a>!]!</div>
823
+
824
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
825
+
826
+
827
+ <div class="graphql-code-line top-level">&#125;</div>
828
+ </div>
829
+
830
+ ## FacetList
831
+
832
+ <div class="graphql-code-block">
833
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetList</span> &#123;</div>
834
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#facet">Facet</a>!]!</div>
835
+
836
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
837
+
838
+
839
+ <div class="graphql-code-line top-level">&#125;</div>
840
+ </div>
841
+
842
+ ## FacetTranslation
843
+
844
+ <div class="graphql-code-block">
845
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetTranslation</span> &#123;</div>
846
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
847
+
848
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
849
+
850
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
851
+
852
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
853
+
854
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
855
+
856
+
857
+ <div class="graphql-code-line top-level">&#125;</div>
858
+ </div>
859
+
860
+ ## FacetValue
861
+
862
+ <div class="graphql-code-block">
863
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValue</span> &#123;</div>
864
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
865
+
866
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
867
+
868
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
869
+
870
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
871
+
872
+ <div class="graphql-code-line ">facet: <a href="/reference/graphql-api/shop/object-types#facet">Facet</a>!</div>
873
+
874
+ <div class="graphql-code-line ">facetId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
875
+
876
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
877
+
878
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
879
+
880
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#facetvaluetranslation">FacetValueTranslation</a>!]!</div>
881
+
882
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
883
+
884
+
885
+ <div class="graphql-code-line top-level">&#125;</div>
886
+ </div>
887
+
888
+ ## FacetValueList
889
+
890
+ <div class="graphql-code-block">
891
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValueList</span> &#123;</div>
892
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#facetvalue">FacetValue</a>!]!</div>
893
+
894
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
895
+
896
+
897
+ <div class="graphql-code-line top-level">&#125;</div>
898
+ </div>
899
+
900
+ ## FacetValueResult
901
+
902
+ <div class="graphql-code-block">
903
+ <div class="graphql-code-line top-level comment">"""</div>
904
+ <div class="graphql-code-line top-level comment">Which FacetValues are present in the products returned</div>
905
+
906
+ <div class="graphql-code-line top-level comment">by the search, and in what quantity.</div>
907
+ <div class="graphql-code-line top-level comment">"""</div>
908
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValueResult</span> &#123;</div>
909
+ <div class="graphql-code-line ">facetValue: <a href="/reference/graphql-api/shop/object-types#facetvalue">FacetValue</a>!</div>
910
+
911
+ <div class="graphql-code-line ">count: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
912
+
913
+
914
+ <div class="graphql-code-line top-level">&#125;</div>
915
+ </div>
916
+
917
+ ## FacetValueTranslation
918
+
919
+ <div class="graphql-code-block">
920
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FacetValueTranslation</span> &#123;</div>
921
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
922
+
923
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
924
+
925
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
926
+
927
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
928
+
929
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
930
+
931
+
932
+ <div class="graphql-code-line top-level">&#125;</div>
933
+ </div>
934
+
935
+ ## Float
936
+
937
+ <div class="graphql-code-block">
938
+ <div class="graphql-code-line top-level comment">"""</div>
939
+ <div class="graphql-code-line top-level comment">The <code>Float</code> scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).</div>
940
+ <div class="graphql-code-line top-level comment">"""</div>
941
+ <div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Float</span></div>
942
+ </div>
943
+
944
+ ## FloatCustomFieldConfig
945
+
946
+ <div class="graphql-code-block">
947
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FloatCustomFieldConfig</span> &#123;</div>
948
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
949
+
950
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
951
+
952
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
953
+
954
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
955
+
956
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
957
+
958
+ <div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
959
+
960
+ <div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
961
+
962
+ <div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
963
+
964
+ <div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
965
+
966
+ <div class="graphql-code-line ">deprecated: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
967
+
968
+ <div class="graphql-code-line ">deprecationReason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
969
+
970
+ <div class="graphql-code-line ">min: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
971
+
972
+ <div class="graphql-code-line ">max: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
973
+
974
+ <div class="graphql-code-line ">step: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
975
+
976
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
977
+
978
+
979
+ <div class="graphql-code-line top-level">&#125;</div>
980
+ </div>
981
+
982
+ ## FloatStructFieldConfig
983
+
984
+ <div class="graphql-code-block">
985
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FloatStructFieldConfig</span> &#123;</div>
986
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
987
+
988
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
989
+
990
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
991
+
992
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
993
+
994
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
995
+
996
+ <div class="graphql-code-line ">min: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
997
+
998
+ <div class="graphql-code-line ">max: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
999
+
1000
+ <div class="graphql-code-line ">step: <a href="/reference/graphql-api/shop/object-types#float">Float</a></div>
1001
+
1002
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1003
+
1004
+
1005
+ <div class="graphql-code-line top-level">&#125;</div>
1006
+ </div>
1007
+
1008
+ ## Fulfillment
1009
+
1010
+ <div class="graphql-code-block">
1011
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Fulfillment</span> &#123;</div>
1012
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
1013
+
1014
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
1015
+
1016
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
1017
+
1018
+ <div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/shop/object-types#fulfillmentline">FulfillmentLine</a>!]!</div>
1019
+
1020
+ <div class="graphql-code-line ">summary: [<a href="/reference/graphql-api/shop/object-types#fulfillmentline">FulfillmentLine</a>!]!</div>
1021
+
1022
+ <div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1023
+
1024
+ <div class="graphql-code-line ">method: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1025
+
1026
+ <div class="graphql-code-line ">trackingCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1027
+
1028
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1029
+
1030
+
1031
+ <div class="graphql-code-line top-level">&#125;</div>
1032
+ </div>
1033
+
1034
+ ## FulfillmentLine
1035
+
1036
+ <div class="graphql-code-block">
1037
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">FulfillmentLine</span> &#123;</div>
1038
+ <div class="graphql-code-line ">orderLine: <a href="/reference/graphql-api/shop/object-types#orderline">OrderLine</a>!</div>
1039
+
1040
+ <div class="graphql-code-line ">orderLineId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
1041
+
1042
+ <div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
1043
+
1044
+ <div class="graphql-code-line ">fulfillment: <a href="/reference/graphql-api/shop/object-types#fulfillment">Fulfillment</a>!</div>
1045
+
1046
+ <div class="graphql-code-line ">fulfillmentId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
1047
+
1048
+
1049
+ <div class="graphql-code-line top-level">&#125;</div>
1050
+ </div>
1051
+
1052
+ ## GuestCheckoutError
1053
+
1054
+ <div class="graphql-code-block">
1055
+ <div class="graphql-code-line top-level comment">"""</div>
1056
+ <div class="graphql-code-line top-level comment">Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it.</div>
1057
+ <div class="graphql-code-line top-level comment">"""</div>
1058
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">GuestCheckoutError</span> &#123;</div>
1059
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1060
+
1061
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1062
+
1063
+ <div class="graphql-code-line ">errorDetail: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1064
+
1065
+
1066
+ <div class="graphql-code-line top-level">&#125;</div>
1067
+ </div>
1068
+
1069
+ ## HistoryEntry
1070
+
1071
+ <div class="graphql-code-block">
1072
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">HistoryEntry</span> &#123;</div>
1073
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
1074
+
1075
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
1076
+
1077
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
1078
+
1079
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/enums#historyentrytype">HistoryEntryType</a>!</div>
1080
+
1081
+ <div class="graphql-code-line ">data: <a href="/reference/graphql-api/shop/object-types#json">JSON</a>!</div>
1082
+
1083
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1084
+
1085
+
1086
+ <div class="graphql-code-line top-level">&#125;</div>
1087
+ </div>
1088
+
1089
+ ## HistoryEntryList
1090
+
1091
+ <div class="graphql-code-block">
1092
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">HistoryEntryList</span> &#123;</div>
1093
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#historyentry">HistoryEntry</a>!]!</div>
1094
+
1095
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
1096
+
1097
+
1098
+ <div class="graphql-code-line top-level">&#125;</div>
1099
+ </div>
1100
+
1101
+ ## ID
1102
+
1103
+ <div class="graphql-code-block">
1104
+ <div class="graphql-code-line top-level comment">"""</div>
1105
+ <div class="graphql-code-line top-level comment">The <code>ID</code> scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"4"`) or integer (such as `4`) input value will be accepted as an ID.</div>
1106
+ <div class="graphql-code-line top-level comment">"""</div>
1107
+ <div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">ID</span></div>
1108
+ </div>
1109
+
1110
+ ## IdentifierChangeTokenExpiredError
1111
+
1112
+ <div class="graphql-code-block">
1113
+ <div class="graphql-code-line top-level comment">"""</div>
1114
+ <div class="graphql-code-line top-level comment">Returned if the token used to change a Customer's email address is valid, but has</div>
1115
+
1116
+ <div class="graphql-code-line top-level comment">expired according to the <code>verificationTokenDuration</code> setting in the AuthOptions.</div>
1117
+ <div class="graphql-code-line top-level comment">"""</div>
1118
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IdentifierChangeTokenExpiredError</span> &#123;</div>
1119
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1120
+
1121
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1122
+
1123
+
1124
+ <div class="graphql-code-line top-level">&#125;</div>
1125
+ </div>
1126
+
1127
+ ## IdentifierChangeTokenInvalidError
1128
+
1129
+ <div class="graphql-code-block">
1130
+ <div class="graphql-code-line top-level comment">"""</div>
1131
+ <div class="graphql-code-line top-level comment">Returned if the token used to change a Customer's email address is either</div>
1132
+
1133
+ <div class="graphql-code-line top-level comment">invalid or does not match any expected tokens.</div>
1134
+ <div class="graphql-code-line top-level comment">"""</div>
1135
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IdentifierChangeTokenInvalidError</span> &#123;</div>
1136
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1137
+
1138
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1139
+
1140
+
1141
+ <div class="graphql-code-line top-level">&#125;</div>
1142
+ </div>
1143
+
1144
+ ## IneligiblePaymentMethodError
1145
+
1146
+ <div class="graphql-code-block">
1147
+ <div class="graphql-code-line top-level comment">"""</div>
1148
+ <div class="graphql-code-line top-level comment">Returned when attempting to add a Payment using a PaymentMethod for which the Order is not eligible.</div>
1149
+ <div class="graphql-code-line top-level comment">"""</div>
1150
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IneligiblePaymentMethodError</span> &#123;</div>
1151
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1152
+
1153
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1154
+
1155
+ <div class="graphql-code-line ">eligibilityCheckerMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1156
+
1157
+
1158
+ <div class="graphql-code-line top-level">&#125;</div>
1159
+ </div>
1160
+
1161
+ ## IneligibleShippingMethodError
1162
+
1163
+ <div class="graphql-code-block">
1164
+ <div class="graphql-code-line top-level comment">"""</div>
1165
+ <div class="graphql-code-line top-level comment">Returned when attempting to set a ShippingMethod for which the Order is not eligible</div>
1166
+ <div class="graphql-code-line top-level comment">"""</div>
1167
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IneligibleShippingMethodError</span> &#123;</div>
1168
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1169
+
1170
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1171
+
1172
+
1173
+ <div class="graphql-code-line top-level">&#125;</div>
1174
+ </div>
1175
+
1176
+ ## InsufficientStockError
1177
+
1178
+ <div class="graphql-code-block">
1179
+ <div class="graphql-code-line top-level comment">"""</div>
1180
+ <div class="graphql-code-line top-level comment">Returned when attempting to add more items to the Order than are available</div>
1181
+ <div class="graphql-code-line top-level comment">"""</div>
1182
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">InsufficientStockError</span> &#123;</div>
1183
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1184
+
1185
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1186
+
1187
+ <div class="graphql-code-line ">quantityAvailable: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
1188
+
1189
+ <div class="graphql-code-line ">order: <a href="/reference/graphql-api/shop/object-types#order">Order</a>!</div>
1190
+
1191
+
1192
+ <div class="graphql-code-line top-level">&#125;</div>
1193
+ </div>
1194
+
1195
+ ## Int
1196
+
1197
+ <div class="graphql-code-block">
1198
+ <div class="graphql-code-line top-level comment">"""</div>
1199
+ <div class="graphql-code-line top-level comment">The <code>Int</code> scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.</div>
1200
+ <div class="graphql-code-line top-level comment">"""</div>
1201
+ <div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Int</span></div>
1202
+ </div>
1203
+
1204
+ ## IntCustomFieldConfig
1205
+
1206
+ <div class="graphql-code-block">
1207
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IntCustomFieldConfig</span> &#123;</div>
1208
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1209
+
1210
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1211
+
1212
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
1213
+
1214
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
1215
+
1216
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
1217
+
1218
+ <div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1219
+
1220
+ <div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1221
+
1222
+ <div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1223
+
1224
+ <div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
1225
+
1226
+ <div class="graphql-code-line ">deprecated: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1227
+
1228
+ <div class="graphql-code-line ">deprecationReason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1229
+
1230
+ <div class="graphql-code-line ">min: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
1231
+
1232
+ <div class="graphql-code-line ">max: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
1233
+
1234
+ <div class="graphql-code-line ">step: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
1235
+
1236
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1237
+
1238
+
1239
+ <div class="graphql-code-line top-level">&#125;</div>
1240
+ </div>
1241
+
1242
+ ## IntStructFieldConfig
1243
+
1244
+ <div class="graphql-code-block">
1245
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">IntStructFieldConfig</span> &#123;</div>
1246
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1247
+
1248
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1249
+
1250
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
1251
+
1252
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
1253
+
1254
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
1255
+
1256
+ <div class="graphql-code-line ">min: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
1257
+
1258
+ <div class="graphql-code-line ">max: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
1259
+
1260
+ <div class="graphql-code-line ">step: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
1261
+
1262
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1263
+
1264
+
1265
+ <div class="graphql-code-line top-level">&#125;</div>
1266
+ </div>
1267
+
1268
+ ## InvalidCredentialsError
1269
+
1270
+ <div class="graphql-code-block">
1271
+ <div class="graphql-code-line top-level comment">"""</div>
1272
+ <div class="graphql-code-line top-level comment">Returned if the user authentication credentials are not valid</div>
1273
+ <div class="graphql-code-line top-level comment">"""</div>
1274
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">InvalidCredentialsError</span> &#123;</div>
1275
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1276
+
1277
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1278
+
1279
+ <div class="graphql-code-line ">authenticationError: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1280
+
1281
+
1282
+ <div class="graphql-code-line top-level">&#125;</div>
1283
+ </div>
1284
+
1285
+ ## JSON
1286
+
1287
+ <div class="graphql-code-block">
1288
+ <div class="graphql-code-line top-level comment">"""</div>
1289
+ <div class="graphql-code-line top-level comment">The <code>JSON</code> scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).</div>
1290
+ <div class="graphql-code-line top-level comment">"""</div>
1291
+ <div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">JSON</span></div>
1292
+ </div>
1293
+
1294
+ ## LocaleStringCustomFieldConfig
1295
+
1296
+ <div class="graphql-code-block">
1297
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">LocaleStringCustomFieldConfig</span> &#123;</div>
1298
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1299
+
1300
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1301
+
1302
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
1303
+
1304
+ <div class="graphql-code-line ">length: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
1305
+
1306
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
1307
+
1308
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
1309
+
1310
+ <div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1311
+
1312
+ <div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1313
+
1314
+ <div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1315
+
1316
+ <div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
1317
+
1318
+ <div class="graphql-code-line ">deprecated: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1319
+
1320
+ <div class="graphql-code-line ">deprecationReason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1321
+
1322
+ <div class="graphql-code-line ">pattern: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1323
+
1324
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1325
+
1326
+
1327
+ <div class="graphql-code-line top-level">&#125;</div>
1328
+ </div>
1329
+
1330
+ ## LocaleTextCustomFieldConfig
1331
+
1332
+ <div class="graphql-code-block">
1333
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">LocaleTextCustomFieldConfig</span> &#123;</div>
1334
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1335
+
1336
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1337
+
1338
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
1339
+
1340
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
1341
+
1342
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
1343
+
1344
+ <div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1345
+
1346
+ <div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1347
+
1348
+ <div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1349
+
1350
+ <div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
1351
+
1352
+ <div class="graphql-code-line ">deprecated: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
1353
+
1354
+ <div class="graphql-code-line ">deprecationReason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1355
+
1356
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1357
+
1358
+
1359
+ <div class="graphql-code-line top-level">&#125;</div>
1360
+ </div>
1361
+
1362
+ ## LocalizedString
1363
+
1364
+ <div class="graphql-code-block">
1365
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">LocalizedString</span> &#123;</div>
1366
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
1367
+
1368
+ <div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1369
+
1370
+
1371
+ <div class="graphql-code-line top-level">&#125;</div>
1372
+ </div>
1373
+
1374
+ ## MissingPasswordError
1375
+
1376
+ <div class="graphql-code-block">
1377
+ <div class="graphql-code-line top-level comment">"""</div>
1378
+ <div class="graphql-code-line top-level comment">Returned when attempting to register or verify a customer account without a password, when one is required.</div>
1379
+ <div class="graphql-code-line top-level comment">"""</div>
1380
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">MissingPasswordError</span> &#123;</div>
1381
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1382
+
1383
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1384
+
1385
+
1386
+ <div class="graphql-code-line top-level">&#125;</div>
1387
+ </div>
1388
+
1389
+ ## Money
1390
+
1391
+ <div class="graphql-code-block">
1392
+ <div class="graphql-code-line top-level comment">"""</div>
1393
+ <div class="graphql-code-line top-level comment">The <code>Money</code> scalar type represents monetary values and supports signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).</div>
1394
+ <div class="graphql-code-line top-level comment">"""</div>
1395
+ <div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Money</span></div>
1396
+ </div>
1397
+
1398
+ ## NativeAuthStrategyError
1399
+
1400
+ <div class="graphql-code-block">
1401
+ <div class="graphql-code-line top-level comment">"""</div>
1402
+ <div class="graphql-code-line top-level comment">Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured.</div>
1403
+ <div class="graphql-code-line top-level comment">"""</div>
1404
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NativeAuthStrategyError</span> &#123;</div>
1405
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1406
+
1407
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1408
+
1409
+
1410
+ <div class="graphql-code-line top-level">&#125;</div>
1411
+ </div>
1412
+
1413
+ ## NativeAuthenticationResult
1414
+
1415
+ <div class="graphql-code-block">
1416
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">NativeAuthenticationResult</span> =</div>
1417
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#currentuser">CurrentUser</a> | <a href="/reference/graphql-api/shop/object-types#invalidcredentialserror">InvalidCredentialsError</a> | <a href="/reference/graphql-api/shop/object-types#notverifiederror">NotVerifiedError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
1418
+ </div>
1419
+
1420
+ ## NegativeQuantityError
1421
+
1422
+ <div class="graphql-code-block">
1423
+ <div class="graphql-code-line top-level comment">"""</div>
1424
+ <div class="graphql-code-line top-level comment">Returned when attempting to set a negative OrderLine quantity.</div>
1425
+ <div class="graphql-code-line top-level comment">"""</div>
1426
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NegativeQuantityError</span> &#123;</div>
1427
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1428
+
1429
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1430
+
1431
+
1432
+ <div class="graphql-code-line top-level">&#125;</div>
1433
+ </div>
1434
+
1435
+ ## NoActiveOrderError
1436
+
1437
+ <div class="graphql-code-block">
1438
+ <div class="graphql-code-line top-level comment">"""</div>
1439
+ <div class="graphql-code-line top-level comment">Returned when invoking a mutation which depends on there being an active Order on the</div>
1440
+
1441
+ <div class="graphql-code-line top-level comment">current session.</div>
1442
+ <div class="graphql-code-line top-level comment">"""</div>
1443
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NoActiveOrderError</span> &#123;</div>
1444
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1445
+
1446
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1447
+
1448
+
1449
+ <div class="graphql-code-line top-level">&#125;</div>
1450
+ </div>
1451
+
1452
+ ## NotVerifiedError
1453
+
1454
+ <div class="graphql-code-block">
1455
+ <div class="graphql-code-line top-level comment">"""</div>
1456
+ <div class="graphql-code-line top-level comment">Returned if <code>authOptions.requireVerification</code> is set to <code>true</code> (which is the default)</div>
1457
+
1458
+ <div class="graphql-code-line top-level comment">and an unverified user attempts to authenticate.</div>
1459
+ <div class="graphql-code-line top-level comment">"""</div>
1460
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">NotVerifiedError</span> &#123;</div>
1461
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1462
+
1463
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1464
+
1465
+
1466
+ <div class="graphql-code-line top-level">&#125;</div>
1467
+ </div>
1468
+
1469
+ ## Order
1470
+
1471
+ <div class="graphql-code-block">
1472
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Order</span> &#123;</div>
1473
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
1474
+
1475
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
1476
+
1477
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
1478
+
1479
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/enums#ordertype">OrderType</a>!</div>
1480
+
1481
+ <div class="graphql-code-line comment">"""</div>
1482
+ <div class="graphql-code-line comment">The date & time that the Order was placed, i.e. the Customer</div>
1483
+
1484
+ <div class="graphql-code-line comment">completed the checkout and the Order is no longer "active"</div>
1485
+ <div class="graphql-code-line comment">"""</div>
1486
+ <div class="graphql-code-line ">orderPlacedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
1487
+
1488
+ <div class="graphql-code-line comment">"""</div>
1489
+ <div class="graphql-code-line comment">A unique code for the Order</div>
1490
+ <div class="graphql-code-line comment">"""</div>
1491
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1492
+
1493
+ <div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1494
+
1495
+ <div class="graphql-code-line comment">"""</div>
1496
+ <div class="graphql-code-line comment">An order is active as long as the payment process has not been completed</div>
1497
+ <div class="graphql-code-line comment">"""</div>
1498
+ <div class="graphql-code-line ">active: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
1499
+
1500
+ <div class="graphql-code-line ">customer: <a href="/reference/graphql-api/shop/object-types#customer">Customer</a></div>
1501
+
1502
+ <div class="graphql-code-line ">shippingAddress: <a href="/reference/graphql-api/shop/object-types#orderaddress">OrderAddress</a></div>
1503
+
1504
+ <div class="graphql-code-line ">billingAddress: <a href="/reference/graphql-api/shop/object-types#orderaddress">OrderAddress</a></div>
1505
+
1506
+ <div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/shop/object-types#orderline">OrderLine</a>!]!</div>
1507
+
1508
+ <div class="graphql-code-line comment">"""</div>
1509
+ <div class="graphql-code-line comment">Surcharges are arbitrary modifications to the Order total which are neither</div>
1510
+
1511
+ <div class="graphql-code-line comment">ProductVariants nor discounts resulting from applied Promotions. For example,</div>
1512
+
1513
+ <div class="graphql-code-line comment">one-off discounts based on customer interaction, or surcharges based on payment</div>
1514
+
1515
+ <div class="graphql-code-line comment">methods.</div>
1516
+ <div class="graphql-code-line comment">"""</div>
1517
+ <div class="graphql-code-line ">surcharges: [<a href="/reference/graphql-api/shop/object-types#surcharge">Surcharge</a>!]!</div>
1518
+
1519
+ <div class="graphql-code-line ">discounts: [<a href="/reference/graphql-api/shop/object-types#discount">Discount</a>!]!</div>
1520
+
1521
+ <div class="graphql-code-line comment">"""</div>
1522
+ <div class="graphql-code-line comment">An array of all coupon codes applied to the Order</div>
1523
+ <div class="graphql-code-line comment">"""</div>
1524
+ <div class="graphql-code-line ">couponCodes: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]!</div>
1525
+
1526
+ <div class="graphql-code-line comment">"""</div>
1527
+ <div class="graphql-code-line comment">Promotions applied to the order. Only gets populated after the payment process has completed.</div>
1528
+ <div class="graphql-code-line comment">"""</div>
1529
+ <div class="graphql-code-line ">promotions: [<a href="/reference/graphql-api/shop/object-types#promotion">Promotion</a>!]!</div>
1530
+
1531
+ <div class="graphql-code-line ">payments: [<a href="/reference/graphql-api/shop/object-types#payment">Payment</a>!]</div>
1532
+
1533
+ <div class="graphql-code-line ">fulfillments: [<a href="/reference/graphql-api/shop/object-types#fulfillment">Fulfillment</a>!]</div>
1534
+
1535
+ <div class="graphql-code-line ">totalQuantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
1536
+
1537
+ <div class="graphql-code-line comment">"""</div>
1538
+ <div class="graphql-code-line comment">The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level</div>
1539
+
1540
+ <div class="graphql-code-line comment">discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.</div>
1541
+
1542
+ <div class="graphql-code-line comment">To get a total of all OrderLines which does not account for prorated discounts, use the</div>
1543
+
1544
+ <div class="graphql-code-line comment">sum of <code>OrderLine.discountedLinePrice</code> values.</div>
1545
+ <div class="graphql-code-line comment">"""</div>
1546
+ <div class="graphql-code-line ">subTotal: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1547
+
1548
+ <div class="graphql-code-line comment">"""</div>
1549
+ <div class="graphql-code-line comment">Same as subTotal, but inclusive of tax</div>
1550
+ <div class="graphql-code-line comment">"""</div>
1551
+ <div class="graphql-code-line ">subTotalWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1552
+
1553
+ <div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!</div>
1554
+
1555
+ <div class="graphql-code-line ">shippingLines: [<a href="/reference/graphql-api/shop/object-types#shippingline">ShippingLine</a>!]!</div>
1556
+
1557
+ <div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1558
+
1559
+ <div class="graphql-code-line ">shippingWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1560
+
1561
+ <div class="graphql-code-line comment">"""</div>
1562
+ <div class="graphql-code-line comment">Equal to subTotal plus shipping</div>
1563
+ <div class="graphql-code-line comment">"""</div>
1564
+ <div class="graphql-code-line ">total: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1565
+
1566
+ <div class="graphql-code-line comment">"""</div>
1567
+ <div class="graphql-code-line comment">The final payable amount. Equal to subTotalWithTax plus shippingWithTax</div>
1568
+ <div class="graphql-code-line comment">"""</div>
1569
+ <div class="graphql-code-line ">totalWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1570
+
1571
+ <div class="graphql-code-line comment">"""</div>
1572
+ <div class="graphql-code-line comment">A summary of the taxes being applied to this Order</div>
1573
+ <div class="graphql-code-line comment">"""</div>
1574
+ <div class="graphql-code-line ">taxSummary: [<a href="/reference/graphql-api/shop/object-types#ordertaxsummary">OrderTaxSummary</a>!]!</div>
1575
+
1576
+ <div class="graphql-code-line ">history(options: <a href="/reference/graphql-api/shop/input-types#historyentrylistoptions">HistoryEntryListOptions</a>): <a href="/reference/graphql-api/shop/object-types#historyentrylist">HistoryEntryList</a>!</div>
1577
+
1578
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1579
+
1580
+
1581
+ <div class="graphql-code-line top-level">&#125;</div>
1582
+ </div>
1583
+
1584
+ ## OrderAddress
1585
+
1586
+ <div class="graphql-code-block">
1587
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderAddress</span> &#123;</div>
1588
+ <div class="graphql-code-line ">fullName: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1589
+
1590
+ <div class="graphql-code-line ">company: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1591
+
1592
+ <div class="graphql-code-line ">streetLine1: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1593
+
1594
+ <div class="graphql-code-line ">streetLine2: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1595
+
1596
+ <div class="graphql-code-line ">city: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1597
+
1598
+ <div class="graphql-code-line ">province: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1599
+
1600
+ <div class="graphql-code-line ">postalCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1601
+
1602
+ <div class="graphql-code-line ">country: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1603
+
1604
+ <div class="graphql-code-line ">countryCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1605
+
1606
+ <div class="graphql-code-line ">phoneNumber: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1607
+
1608
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1609
+
1610
+
1611
+ <div class="graphql-code-line top-level">&#125;</div>
1612
+ </div>
1613
+
1614
+ ## OrderInterceptorError
1615
+
1616
+ <div class="graphql-code-block">
1617
+ <div class="graphql-code-line top-level comment">"""</div>
1618
+ <div class="graphql-code-line top-level comment">Returned when an order operation is rejected by an OrderInterceptor method.</div>
1619
+ <div class="graphql-code-line top-level comment">"""</div>
1620
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderInterceptorError</span> &#123;</div>
1621
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1622
+
1623
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1624
+
1625
+ <div class="graphql-code-line ">interceptorError: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1626
+
1627
+
1628
+ <div class="graphql-code-line top-level">&#125;</div>
1629
+ </div>
1630
+
1631
+ ## OrderLimitError
1632
+
1633
+ <div class="graphql-code-block">
1634
+ <div class="graphql-code-line top-level comment">"""</div>
1635
+ <div class="graphql-code-line top-level comment">Returned when the maximum order size limit has been reached.</div>
1636
+ <div class="graphql-code-line top-level comment">"""</div>
1637
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderLimitError</span> &#123;</div>
1638
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1639
+
1640
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1641
+
1642
+ <div class="graphql-code-line ">maxItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
1643
+
1644
+
1645
+ <div class="graphql-code-line top-level">&#125;</div>
1646
+ </div>
1647
+
1648
+ ## OrderLine
1649
+
1650
+ <div class="graphql-code-block">
1651
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderLine</span> &#123;</div>
1652
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
1653
+
1654
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
1655
+
1656
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
1657
+
1658
+ <div class="graphql-code-line ">productVariant: <a href="/reference/graphql-api/shop/object-types#productvariant">ProductVariant</a>!</div>
1659
+
1660
+ <div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/shop/object-types#asset">Asset</a></div>
1661
+
1662
+ <div class="graphql-code-line comment">"""</div>
1663
+ <div class="graphql-code-line comment">The price of a single unit, excluding tax and discounts</div>
1664
+ <div class="graphql-code-line comment">"""</div>
1665
+ <div class="graphql-code-line ">unitPrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1666
+
1667
+ <div class="graphql-code-line comment">"""</div>
1668
+ <div class="graphql-code-line comment">The price of a single unit, including tax but excluding discounts</div>
1669
+ <div class="graphql-code-line comment">"""</div>
1670
+ <div class="graphql-code-line ">unitPriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1671
+
1672
+ <div class="graphql-code-line comment">"""</div>
1673
+ <div class="graphql-code-line comment">Non-zero if the unitPrice has changed since it was initially added to Order</div>
1674
+ <div class="graphql-code-line comment">"""</div>
1675
+ <div class="graphql-code-line ">unitPriceChangeSinceAdded: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1676
+
1677
+ <div class="graphql-code-line comment">"""</div>
1678
+ <div class="graphql-code-line comment">Non-zero if the unitPriceWithTax has changed since it was initially added to Order</div>
1679
+ <div class="graphql-code-line comment">"""</div>
1680
+ <div class="graphql-code-line ">unitPriceWithTaxChangeSinceAdded: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1681
+
1682
+ <div class="graphql-code-line comment">"""</div>
1683
+ <div class="graphql-code-line comment">The price of a single unit including discounts, excluding tax.</div>
1684
+
1685
+ <div class="graphql-code-line comment"></div>
1686
+
1687
+ <div class="graphql-code-line comment">If Order-level discounts have been applied, this will not be the</div>
1688
+
1689
+ <div class="graphql-code-line comment">actual taxable unit price (see `proratedUnitPrice`), but is generally the</div>
1690
+
1691
+ <div class="graphql-code-line comment">correct price to display to customers to avoid confusion</div>
1692
+
1693
+ <div class="graphql-code-line comment">about the internal handling of distributed Order-level discounts.</div>
1694
+ <div class="graphql-code-line comment">"""</div>
1695
+ <div class="graphql-code-line ">discountedUnitPrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1696
+
1697
+ <div class="graphql-code-line comment">"""</div>
1698
+ <div class="graphql-code-line comment">The price of a single unit including discounts and tax</div>
1699
+ <div class="graphql-code-line comment">"""</div>
1700
+ <div class="graphql-code-line ">discountedUnitPriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1701
+
1702
+ <div class="graphql-code-line comment">"""</div>
1703
+ <div class="graphql-code-line comment">The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)</div>
1704
+
1705
+ <div class="graphql-code-line comment">Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax</div>
1706
+
1707
+ <div class="graphql-code-line comment">and refund calculations.</div>
1708
+ <div class="graphql-code-line comment">"""</div>
1709
+ <div class="graphql-code-line ">proratedUnitPrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1710
+
1711
+ <div class="graphql-code-line comment">"""</div>
1712
+ <div class="graphql-code-line comment">The proratedUnitPrice including tax</div>
1713
+ <div class="graphql-code-line comment">"""</div>
1714
+ <div class="graphql-code-line ">proratedUnitPriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1715
+
1716
+ <div class="graphql-code-line comment">"""</div>
1717
+ <div class="graphql-code-line comment">The quantity of items purchased</div>
1718
+ <div class="graphql-code-line comment">"""</div>
1719
+ <div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
1720
+
1721
+ <div class="graphql-code-line comment">"""</div>
1722
+ <div class="graphql-code-line comment">The quantity at the time the Order was placed</div>
1723
+ <div class="graphql-code-line comment">"""</div>
1724
+ <div class="graphql-code-line ">orderPlacedQuantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
1725
+
1726
+ <div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
1727
+
1728
+ <div class="graphql-code-line comment">"""</div>
1729
+ <div class="graphql-code-line comment">The total price of the line excluding tax and discounts.</div>
1730
+ <div class="graphql-code-line comment">"""</div>
1731
+ <div class="graphql-code-line ">linePrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1732
+
1733
+ <div class="graphql-code-line comment">"""</div>
1734
+ <div class="graphql-code-line comment">The total price of the line including tax but excluding discounts.</div>
1735
+ <div class="graphql-code-line comment">"""</div>
1736
+ <div class="graphql-code-line ">linePriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1737
+
1738
+ <div class="graphql-code-line comment">"""</div>
1739
+ <div class="graphql-code-line comment">The price of the line including discounts, excluding tax</div>
1740
+ <div class="graphql-code-line comment">"""</div>
1741
+ <div class="graphql-code-line ">discountedLinePrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1742
+
1743
+ <div class="graphql-code-line comment">"""</div>
1744
+ <div class="graphql-code-line comment">The price of the line including discounts and tax</div>
1745
+ <div class="graphql-code-line comment">"""</div>
1746
+ <div class="graphql-code-line ">discountedLinePriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1747
+
1748
+ <div class="graphql-code-line comment">"""</div>
1749
+ <div class="graphql-code-line comment">The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)</div>
1750
+
1751
+ <div class="graphql-code-line comment">Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax</div>
1752
+
1753
+ <div class="graphql-code-line comment">and refund calculations.</div>
1754
+ <div class="graphql-code-line comment">"""</div>
1755
+ <div class="graphql-code-line ">proratedLinePrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1756
+
1757
+ <div class="graphql-code-line comment">"""</div>
1758
+ <div class="graphql-code-line comment">The proratedLinePrice including tax</div>
1759
+ <div class="graphql-code-line comment">"""</div>
1760
+ <div class="graphql-code-line ">proratedLinePriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1761
+
1762
+ <div class="graphql-code-line comment">"""</div>
1763
+ <div class="graphql-code-line comment">The total tax on this line</div>
1764
+ <div class="graphql-code-line comment">"""</div>
1765
+ <div class="graphql-code-line ">lineTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1766
+
1767
+ <div class="graphql-code-line ">discounts: [<a href="/reference/graphql-api/shop/object-types#discount">Discount</a>!]!</div>
1768
+
1769
+ <div class="graphql-code-line ">taxLines: [<a href="/reference/graphql-api/shop/object-types#taxline">TaxLine</a>!]!</div>
1770
+
1771
+ <div class="graphql-code-line ">order: <a href="/reference/graphql-api/shop/object-types#order">Order</a>!</div>
1772
+
1773
+ <div class="graphql-code-line ">fulfillmentLines: [<a href="/reference/graphql-api/shop/object-types#fulfillmentline">FulfillmentLine</a>!]</div>
1774
+
1775
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1776
+
1777
+
1778
+ <div class="graphql-code-line top-level">&#125;</div>
1779
+ </div>
1780
+
1781
+ ## OrderList
1782
+
1783
+ <div class="graphql-code-block">
1784
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderList</span> &#123;</div>
1785
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#order">Order</a>!]!</div>
1786
+
1787
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
1788
+
1789
+
1790
+ <div class="graphql-code-line top-level">&#125;</div>
1791
+ </div>
1792
+
1793
+ ## OrderModificationError
1794
+
1795
+ <div class="graphql-code-block">
1796
+ <div class="graphql-code-line top-level comment">"""</div>
1797
+ <div class="graphql-code-line top-level comment">Returned when attempting to modify the contents of an Order that is not in the <code>AddingItems</code> state.</div>
1798
+ <div class="graphql-code-line top-level comment">"""</div>
1799
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderModificationError</span> &#123;</div>
1800
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1801
+
1802
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1803
+
1804
+
1805
+ <div class="graphql-code-line top-level">&#125;</div>
1806
+ </div>
1807
+
1808
+ ## OrderPaymentStateError
1809
+
1810
+ <div class="graphql-code-block">
1811
+ <div class="graphql-code-line top-level comment">"""</div>
1812
+ <div class="graphql-code-line top-level comment">Returned when attempting to add a Payment to an Order that is not in the <code>ArrangingPayment</code> state.</div>
1813
+ <div class="graphql-code-line top-level comment">"""</div>
1814
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderPaymentStateError</span> &#123;</div>
1815
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1816
+
1817
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1818
+
1819
+
1820
+ <div class="graphql-code-line top-level">&#125;</div>
1821
+ </div>
1822
+
1823
+ ## OrderStateTransitionError
1824
+
1825
+ <div class="graphql-code-block">
1826
+ <div class="graphql-code-line top-level comment">"""</div>
1827
+ <div class="graphql-code-line top-level comment">Returned if there is an error in transitioning the Order state</div>
1828
+ <div class="graphql-code-line top-level comment">"""</div>
1829
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderStateTransitionError</span> &#123;</div>
1830
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1831
+
1832
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1833
+
1834
+ <div class="graphql-code-line ">transitionError: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1835
+
1836
+ <div class="graphql-code-line ">fromState: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1837
+
1838
+ <div class="graphql-code-line ">toState: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1839
+
1840
+
1841
+ <div class="graphql-code-line top-level">&#125;</div>
1842
+ </div>
1843
+
1844
+ ## OrderTaxSummary
1845
+
1846
+ <div class="graphql-code-block">
1847
+ <div class="graphql-code-line top-level comment">"""</div>
1848
+ <div class="graphql-code-line top-level comment">A summary of the taxes being applied to this order, grouped</div>
1849
+
1850
+ <div class="graphql-code-line top-level comment">by taxRate.</div>
1851
+ <div class="graphql-code-line top-level comment">"""</div>
1852
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">OrderTaxSummary</span> &#123;</div>
1853
+ <div class="graphql-code-line comment">"""</div>
1854
+ <div class="graphql-code-line comment">A description of this tax</div>
1855
+ <div class="graphql-code-line comment">"""</div>
1856
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1857
+
1858
+ <div class="graphql-code-line comment">"""</div>
1859
+ <div class="graphql-code-line comment">The taxRate as a percentage</div>
1860
+ <div class="graphql-code-line comment">"""</div>
1861
+ <div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
1862
+
1863
+ <div class="graphql-code-line comment">"""</div>
1864
+ <div class="graphql-code-line comment">The total net price of OrderLines to which this taxRate applies</div>
1865
+ <div class="graphql-code-line comment">"""</div>
1866
+ <div class="graphql-code-line ">taxBase: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1867
+
1868
+ <div class="graphql-code-line comment">"""</div>
1869
+ <div class="graphql-code-line comment">The total tax being applied to the Order at this taxRate</div>
1870
+ <div class="graphql-code-line comment">"""</div>
1871
+ <div class="graphql-code-line ">taxTotal: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1872
+
1873
+
1874
+ <div class="graphql-code-line top-level">&#125;</div>
1875
+ </div>
1876
+
1877
+ ## PasswordAlreadySetError
1878
+
1879
+ <div class="graphql-code-block">
1880
+ <div class="graphql-code-line top-level comment">"""</div>
1881
+ <div class="graphql-code-line top-level comment">Returned when attempting to verify a customer account with a password, when a password has already been set.</div>
1882
+ <div class="graphql-code-line top-level comment">"""</div>
1883
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PasswordAlreadySetError</span> &#123;</div>
1884
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1885
+
1886
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1887
+
1888
+
1889
+ <div class="graphql-code-line top-level">&#125;</div>
1890
+ </div>
1891
+
1892
+ ## PasswordResetTokenExpiredError
1893
+
1894
+ <div class="graphql-code-block">
1895
+ <div class="graphql-code-line top-level comment">"""</div>
1896
+ <div class="graphql-code-line top-level comment">Returned if the token used to reset a Customer's password is valid, but has</div>
1897
+
1898
+ <div class="graphql-code-line top-level comment">expired according to the <code>verificationTokenDuration</code> setting in the AuthOptions.</div>
1899
+ <div class="graphql-code-line top-level comment">"""</div>
1900
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PasswordResetTokenExpiredError</span> &#123;</div>
1901
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1902
+
1903
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1904
+
1905
+
1906
+ <div class="graphql-code-line top-level">&#125;</div>
1907
+ </div>
1908
+
1909
+ ## PasswordResetTokenInvalidError
1910
+
1911
+ <div class="graphql-code-block">
1912
+ <div class="graphql-code-line top-level comment">"""</div>
1913
+ <div class="graphql-code-line top-level comment">Returned if the token used to reset a Customer's password is either</div>
1914
+
1915
+ <div class="graphql-code-line top-level comment">invalid or does not match any expected tokens.</div>
1916
+ <div class="graphql-code-line top-level comment">"""</div>
1917
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PasswordResetTokenInvalidError</span> &#123;</div>
1918
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1919
+
1920
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1921
+
1922
+
1923
+ <div class="graphql-code-line top-level">&#125;</div>
1924
+ </div>
1925
+
1926
+ ## PasswordValidationError
1927
+
1928
+ <div class="graphql-code-block">
1929
+ <div class="graphql-code-line top-level comment">"""</div>
1930
+ <div class="graphql-code-line top-level comment">Returned when attempting to register or verify a customer account where the given password fails password validation.</div>
1931
+ <div class="graphql-code-line top-level comment">"""</div>
1932
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PasswordValidationError</span> &#123;</div>
1933
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1934
+
1935
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1936
+
1937
+ <div class="graphql-code-line ">validationErrorMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1938
+
1939
+
1940
+ <div class="graphql-code-line top-level">&#125;</div>
1941
+ </div>
1942
+
1943
+ ## Payment
1944
+
1945
+ <div class="graphql-code-block">
1946
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Payment</span> &#123;</div>
1947
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
1948
+
1949
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
1950
+
1951
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
1952
+
1953
+ <div class="graphql-code-line ">method: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1954
+
1955
+ <div class="graphql-code-line ">amount: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
1956
+
1957
+ <div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1958
+
1959
+ <div class="graphql-code-line ">transactionId: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1960
+
1961
+ <div class="graphql-code-line ">errorMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
1962
+
1963
+ <div class="graphql-code-line ">refunds: [<a href="/reference/graphql-api/shop/object-types#refund">Refund</a>!]!</div>
1964
+
1965
+ <div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1966
+
1967
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
1968
+
1969
+
1970
+ <div class="graphql-code-line top-level">&#125;</div>
1971
+ </div>
1972
+
1973
+ ## PaymentDeclinedError
1974
+
1975
+ <div class="graphql-code-block">
1976
+ <div class="graphql-code-line top-level comment">"""</div>
1977
+ <div class="graphql-code-line top-level comment">Returned when a Payment is declined by the payment provider.</div>
1978
+ <div class="graphql-code-line top-level comment">"""</div>
1979
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentDeclinedError</span> &#123;</div>
1980
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1981
+
1982
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1983
+
1984
+ <div class="graphql-code-line ">paymentErrorMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
1985
+
1986
+
1987
+ <div class="graphql-code-line top-level">&#125;</div>
1988
+ </div>
1989
+
1990
+ ## PaymentFailedError
1991
+
1992
+ <div class="graphql-code-block">
1993
+ <div class="graphql-code-line top-level comment">"""</div>
1994
+ <div class="graphql-code-line top-level comment">Returned when a Payment fails due to an error.</div>
1995
+ <div class="graphql-code-line top-level comment">"""</div>
1996
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentFailedError</span> &#123;</div>
1997
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
1998
+
1999
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2000
+
2001
+ <div class="graphql-code-line ">paymentErrorMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2002
+
2003
+
2004
+ <div class="graphql-code-line top-level">&#125;</div>
2005
+ </div>
2006
+
2007
+ ## PaymentMethod
2008
+
2009
+ <div class="graphql-code-block">
2010
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentMethod</span> &#123;</div>
2011
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2012
+
2013
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2014
+
2015
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2016
+
2017
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2018
+
2019
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2020
+
2021
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2022
+
2023
+ <div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
2024
+
2025
+ <div class="graphql-code-line ">checker: <a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a></div>
2026
+
2027
+ <div class="graphql-code-line ">handler: <a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!</div>
2028
+
2029
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#paymentmethodtranslation">PaymentMethodTranslation</a>!]!</div>
2030
+
2031
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2032
+
2033
+
2034
+ <div class="graphql-code-line top-level">&#125;</div>
2035
+ </div>
2036
+
2037
+ ## PaymentMethodQuote
2038
+
2039
+ <div class="graphql-code-block">
2040
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentMethodQuote</span> &#123;</div>
2041
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2042
+
2043
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2044
+
2045
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2046
+
2047
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2048
+
2049
+ <div class="graphql-code-line ">isEligible: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
2050
+
2051
+ <div class="graphql-code-line ">eligibilityMessage: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
2052
+
2053
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2054
+
2055
+
2056
+ <div class="graphql-code-line top-level">&#125;</div>
2057
+ </div>
2058
+
2059
+ ## PaymentMethodTranslation
2060
+
2061
+ <div class="graphql-code-block">
2062
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PaymentMethodTranslation</span> &#123;</div>
2063
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2064
+
2065
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2066
+
2067
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2068
+
2069
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2070
+
2071
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2072
+
2073
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2074
+
2075
+
2076
+ <div class="graphql-code-line top-level">&#125;</div>
2077
+ </div>
2078
+
2079
+ ## PriceRange
2080
+
2081
+ <div class="graphql-code-block">
2082
+ <div class="graphql-code-line top-level comment">"""</div>
2083
+ <div class="graphql-code-line top-level comment">The price range where the result has more than one price</div>
2084
+ <div class="graphql-code-line top-level comment">"""</div>
2085
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PriceRange</span> &#123;</div>
2086
+ <div class="graphql-code-line ">min: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2087
+
2088
+ <div class="graphql-code-line ">max: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2089
+
2090
+
2091
+ <div class="graphql-code-line top-level">&#125;</div>
2092
+ </div>
2093
+
2094
+ ## Product
2095
+
2096
+ <div class="graphql-code-block">
2097
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Product</span> &#123;</div>
2098
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2099
+
2100
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2101
+
2102
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2103
+
2104
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2105
+
2106
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2107
+
2108
+ <div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2109
+
2110
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2111
+
2112
+ <div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
2113
+
2114
+ <div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/shop/object-types#asset">Asset</a></div>
2115
+
2116
+ <div class="graphql-code-line ">assets: [<a href="/reference/graphql-api/shop/object-types#asset">Asset</a>!]!</div>
2117
+
2118
+ <div class="graphql-code-line comment">"""</div>
2119
+ <div class="graphql-code-line comment">Returns all ProductVariants</div>
2120
+ <div class="graphql-code-line comment">"""</div>
2121
+ <div class="graphql-code-line ">variants: [<a href="/reference/graphql-api/shop/object-types#productvariant">ProductVariant</a>!]!</div>
2122
+
2123
+ <div class="graphql-code-line comment">"""</div>
2124
+ <div class="graphql-code-line comment">Returns a paginated, sortable, filterable list of ProductVariants</div>
2125
+ <div class="graphql-code-line comment">"""</div>
2126
+ <div class="graphql-code-line ">variantList(options: <a href="/reference/graphql-api/shop/input-types#productvariantlistoptions">ProductVariantListOptions</a>): <a href="/reference/graphql-api/shop/object-types#productvariantlist">ProductVariantList</a>!</div>
2127
+
2128
+ <div class="graphql-code-line ">optionGroups: [<a href="/reference/graphql-api/shop/object-types#productoptiongroup">ProductOptionGroup</a>!]!</div>
2129
+
2130
+ <div class="graphql-code-line ">facetValues: [<a href="/reference/graphql-api/shop/object-types#facetvalue">FacetValue</a>!]!</div>
2131
+
2132
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#producttranslation">ProductTranslation</a>!]!</div>
2133
+
2134
+ <div class="graphql-code-line ">collections: [<a href="/reference/graphql-api/shop/object-types#collection">Collection</a>!]!</div>
2135
+
2136
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2137
+
2138
+
2139
+ <div class="graphql-code-line top-level">&#125;</div>
2140
+ </div>
2141
+
2142
+ ## ProductList
2143
+
2144
+ <div class="graphql-code-block">
2145
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductList</span> &#123;</div>
2146
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#product">Product</a>!]!</div>
2147
+
2148
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
2149
+
2150
+
2151
+ <div class="graphql-code-line top-level">&#125;</div>
2152
+ </div>
2153
+
2154
+ ## ProductOption
2155
+
2156
+ <div class="graphql-code-block">
2157
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOption</span> &#123;</div>
2158
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2159
+
2160
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2161
+
2162
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2163
+
2164
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2165
+
2166
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2167
+
2168
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2169
+
2170
+ <div class="graphql-code-line ">groupId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2171
+
2172
+ <div class="graphql-code-line ">group: <a href="/reference/graphql-api/shop/object-types#productoptiongroup">ProductOptionGroup</a>!</div>
2173
+
2174
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#productoptiontranslation">ProductOptionTranslation</a>!]!</div>
2175
+
2176
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2177
+
2178
+
2179
+ <div class="graphql-code-line top-level">&#125;</div>
2180
+ </div>
2181
+
2182
+ ## ProductOptionGroup
2183
+
2184
+ <div class="graphql-code-block">
2185
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOptionGroup</span> &#123;</div>
2186
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2187
+
2188
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2189
+
2190
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2191
+
2192
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2193
+
2194
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2195
+
2196
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2197
+
2198
+ <div class="graphql-code-line ">options: [<a href="/reference/graphql-api/shop/object-types#productoption">ProductOption</a>!]!</div>
2199
+
2200
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#productoptiongrouptranslation">ProductOptionGroupTranslation</a>!]!</div>
2201
+
2202
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2203
+
2204
+
2205
+ <div class="graphql-code-line top-level">&#125;</div>
2206
+ </div>
2207
+
2208
+ ## ProductOptionGroupTranslation
2209
+
2210
+ <div class="graphql-code-block">
2211
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOptionGroupTranslation</span> &#123;</div>
2212
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2213
+
2214
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2215
+
2216
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2217
+
2218
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2219
+
2220
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2221
+
2222
+
2223
+ <div class="graphql-code-line top-level">&#125;</div>
2224
+ </div>
2225
+
2226
+ ## ProductOptionTranslation
2227
+
2228
+ <div class="graphql-code-block">
2229
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductOptionTranslation</span> &#123;</div>
2230
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2231
+
2232
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2233
+
2234
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2235
+
2236
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2237
+
2238
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2239
+
2240
+
2241
+ <div class="graphql-code-line top-level">&#125;</div>
2242
+ </div>
2243
+
2244
+ ## ProductTranslation
2245
+
2246
+ <div class="graphql-code-block">
2247
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductTranslation</span> &#123;</div>
2248
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2249
+
2250
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2251
+
2252
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2253
+
2254
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2255
+
2256
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2257
+
2258
+ <div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2259
+
2260
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2261
+
2262
+
2263
+ <div class="graphql-code-line top-level">&#125;</div>
2264
+ </div>
2265
+
2266
+ ## ProductVariant
2267
+
2268
+ <div class="graphql-code-block">
2269
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductVariant</span> &#123;</div>
2270
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2271
+
2272
+ <div class="graphql-code-line ">product: <a href="/reference/graphql-api/shop/object-types#product">Product</a>!</div>
2273
+
2274
+ <div class="graphql-code-line ">productId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2275
+
2276
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2277
+
2278
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2279
+
2280
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2281
+
2282
+ <div class="graphql-code-line ">sku: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2283
+
2284
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2285
+
2286
+ <div class="graphql-code-line ">featuredAsset: <a href="/reference/graphql-api/shop/object-types#asset">Asset</a></div>
2287
+
2288
+ <div class="graphql-code-line ">assets: [<a href="/reference/graphql-api/shop/object-types#asset">Asset</a>!]!</div>
2289
+
2290
+ <div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2291
+
2292
+ <div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!</div>
2293
+
2294
+ <div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2295
+
2296
+ <div class="graphql-code-line ">stockLevel: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2297
+
2298
+ <div class="graphql-code-line ">taxRateApplied: <a href="/reference/graphql-api/shop/object-types#taxrate">TaxRate</a>!</div>
2299
+
2300
+ <div class="graphql-code-line ">taxCategory: <a href="/reference/graphql-api/shop/object-types#taxcategory">TaxCategory</a>!</div>
2301
+
2302
+ <div class="graphql-code-line ">options: [<a href="/reference/graphql-api/shop/object-types#productoption">ProductOption</a>!]!</div>
2303
+
2304
+ <div class="graphql-code-line ">facetValues: [<a href="/reference/graphql-api/shop/object-types#facetvalue">FacetValue</a>!]!</div>
2305
+
2306
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#productvarianttranslation">ProductVariantTranslation</a>!]!</div>
2307
+
2308
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2309
+
2310
+
2311
+ <div class="graphql-code-line top-level">&#125;</div>
2312
+ </div>
2313
+
2314
+ ## ProductVariantList
2315
+
2316
+ <div class="graphql-code-block">
2317
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductVariantList</span> &#123;</div>
2318
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#productvariant">ProductVariant</a>!]!</div>
2319
+
2320
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
2321
+
2322
+
2323
+ <div class="graphql-code-line top-level">&#125;</div>
2324
+ </div>
2325
+
2326
+ ## ProductVariantTranslation
2327
+
2328
+ <div class="graphql-code-block">
2329
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProductVariantTranslation</span> &#123;</div>
2330
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2331
+
2332
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2333
+
2334
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2335
+
2336
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2337
+
2338
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2339
+
2340
+
2341
+ <div class="graphql-code-line top-level">&#125;</div>
2342
+ </div>
2343
+
2344
+ ## Promotion
2345
+
2346
+ <div class="graphql-code-block">
2347
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Promotion</span> &#123;</div>
2348
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2349
+
2350
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2351
+
2352
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2353
+
2354
+ <div class="graphql-code-line ">startsAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
2355
+
2356
+ <div class="graphql-code-line ">endsAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
2357
+
2358
+ <div class="graphql-code-line ">couponCode: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
2359
+
2360
+ <div class="graphql-code-line ">perCustomerUsageLimit: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
2361
+
2362
+ <div class="graphql-code-line ">usageLimit: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
2363
+
2364
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2365
+
2366
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2367
+
2368
+ <div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
2369
+
2370
+ <div class="graphql-code-line ">conditions: [<a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!]!</div>
2371
+
2372
+ <div class="graphql-code-line ">actions: [<a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!]!</div>
2373
+
2374
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#promotiontranslation">PromotionTranslation</a>!]!</div>
2375
+
2376
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2377
+
2378
+
2379
+ <div class="graphql-code-line top-level">&#125;</div>
2380
+ </div>
2381
+
2382
+ ## PromotionList
2383
+
2384
+ <div class="graphql-code-block">
2385
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PromotionList</span> &#123;</div>
2386
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#promotion">Promotion</a>!]!</div>
2387
+
2388
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
2389
+
2390
+
2391
+ <div class="graphql-code-line top-level">&#125;</div>
2392
+ </div>
2393
+
2394
+ ## PromotionTranslation
2395
+
2396
+ <div class="graphql-code-block">
2397
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PromotionTranslation</span> &#123;</div>
2398
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2399
+
2400
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2401
+
2402
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2403
+
2404
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2405
+
2406
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2407
+
2408
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2409
+
2410
+
2411
+ <div class="graphql-code-line top-level">&#125;</div>
2412
+ </div>
2413
+
2414
+ ## Province
2415
+
2416
+ <div class="graphql-code-block">
2417
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Province</span> &#123;</div>
2418
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2419
+
2420
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2421
+
2422
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2423
+
2424
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2425
+
2426
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2427
+
2428
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2429
+
2430
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2431
+
2432
+ <div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
2433
+
2434
+ <div class="graphql-code-line ">parent: <a href="/reference/graphql-api/shop/object-types#region">Region</a></div>
2435
+
2436
+ <div class="graphql-code-line ">parentId: <a href="/reference/graphql-api/shop/object-types#id">ID</a></div>
2437
+
2438
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#regiontranslation">RegionTranslation</a>!]!</div>
2439
+
2440
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2441
+
2442
+
2443
+ <div class="graphql-code-line top-level">&#125;</div>
2444
+ </div>
2445
+
2446
+ ## ProvinceList
2447
+
2448
+ <div class="graphql-code-block">
2449
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ProvinceList</span> &#123;</div>
2450
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#province">Province</a>!]!</div>
2451
+
2452
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
2453
+
2454
+
2455
+ <div class="graphql-code-line top-level">&#125;</div>
2456
+ </div>
2457
+
2458
+ ## PublicPaymentMethod
2459
+
2460
+ <div class="graphql-code-block">
2461
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PublicPaymentMethod</span> &#123;</div>
2462
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2463
+
2464
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2465
+
2466
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2467
+
2468
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
2469
+
2470
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#paymentmethodtranslation">PaymentMethodTranslation</a>!]!</div>
2471
+
2472
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2473
+
2474
+
2475
+ <div class="graphql-code-line top-level">&#125;</div>
2476
+ </div>
2477
+
2478
+ ## PublicShippingMethod
2479
+
2480
+ <div class="graphql-code-block">
2481
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">PublicShippingMethod</span> &#123;</div>
2482
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2483
+
2484
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2485
+
2486
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2487
+
2488
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
2489
+
2490
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#shippingmethodtranslation">ShippingMethodTranslation</a>!]!</div>
2491
+
2492
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2493
+
2494
+
2495
+ <div class="graphql-code-line top-level">&#125;</div>
2496
+ </div>
2497
+
2498
+ ## RefreshCustomerVerificationResult
2499
+
2500
+ <div class="graphql-code-block">
2501
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RefreshCustomerVerificationResult</span> =</div>
2502
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
2503
+ </div>
2504
+
2505
+ ## Refund
2506
+
2507
+ <div class="graphql-code-block">
2508
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Refund</span> &#123;</div>
2509
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2510
+
2511
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2512
+
2513
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2514
+
2515
+ <div class="graphql-code-line ">items: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2516
+
2517
+ <div class="graphql-code-line ">shipping: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2518
+
2519
+ <div class="graphql-code-line ">adjustment: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2520
+
2521
+ <div class="graphql-code-line ">total: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2522
+
2523
+ <div class="graphql-code-line ">method: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
2524
+
2525
+ <div class="graphql-code-line ">state: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2526
+
2527
+ <div class="graphql-code-line ">transactionId: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
2528
+
2529
+ <div class="graphql-code-line ">reason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
2530
+
2531
+ <div class="graphql-code-line ">lines: [<a href="/reference/graphql-api/shop/object-types#refundline">RefundLine</a>!]!</div>
2532
+
2533
+ <div class="graphql-code-line ">paymentId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2534
+
2535
+ <div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2536
+
2537
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2538
+
2539
+
2540
+ <div class="graphql-code-line top-level">&#125;</div>
2541
+ </div>
2542
+
2543
+ ## RefundLine
2544
+
2545
+ <div class="graphql-code-block">
2546
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RefundLine</span> &#123;</div>
2547
+ <div class="graphql-code-line ">orderLine: <a href="/reference/graphql-api/shop/object-types#orderline">OrderLine</a>!</div>
2548
+
2549
+ <div class="graphql-code-line ">orderLineId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2550
+
2551
+ <div class="graphql-code-line ">quantity: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
2552
+
2553
+ <div class="graphql-code-line ">refund: <a href="/reference/graphql-api/shop/object-types#refund">Refund</a>!</div>
2554
+
2555
+ <div class="graphql-code-line ">refundId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2556
+
2557
+
2558
+ <div class="graphql-code-line top-level">&#125;</div>
2559
+ </div>
2560
+
2561
+ ## RegionTranslation
2562
+
2563
+ <div class="graphql-code-block">
2564
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RegionTranslation</span> &#123;</div>
2565
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2566
+
2567
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2568
+
2569
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2570
+
2571
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2572
+
2573
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2574
+
2575
+
2576
+ <div class="graphql-code-line top-level">&#125;</div>
2577
+ </div>
2578
+
2579
+ ## RegisterCustomerAccountResult
2580
+
2581
+ <div class="graphql-code-block">
2582
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RegisterCustomerAccountResult</span> =</div>
2583
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#missingpassworderror">MissingPasswordError</a> | <a href="/reference/graphql-api/shop/object-types#passwordvalidationerror">PasswordValidationError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
2584
+ </div>
2585
+
2586
+ ## RelationCustomFieldConfig
2587
+
2588
+ <div class="graphql-code-block">
2589
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RelationCustomFieldConfig</span> &#123;</div>
2590
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2591
+
2592
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2593
+
2594
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
2595
+
2596
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
2597
+
2598
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
2599
+
2600
+ <div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
2601
+
2602
+ <div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
2603
+
2604
+ <div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
2605
+
2606
+ <div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
2607
+
2608
+ <div class="graphql-code-line ">deprecated: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
2609
+
2610
+ <div class="graphql-code-line ">deprecationReason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
2611
+
2612
+ <div class="graphql-code-line ">entity: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2613
+
2614
+ <div class="graphql-code-line ">scalarFields: [<a href="/reference/graphql-api/shop/object-types#string">String</a>!]!</div>
2615
+
2616
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2617
+
2618
+
2619
+ <div class="graphql-code-line top-level">&#125;</div>
2620
+ </div>
2621
+
2622
+ ## RemoveOrderItemsResult
2623
+
2624
+ <div class="graphql-code-block">
2625
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RemoveOrderItemsResult</span> =</div>
2626
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#ordermodificationerror">OrderModificationError</a> | <a href="/reference/graphql-api/shop/object-types#orderinterceptorerror">OrderInterceptorError</a></div>
2627
+ </div>
2628
+
2629
+ ## RequestPasswordResetResult
2630
+
2631
+ <div class="graphql-code-block">
2632
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RequestPasswordResetResult</span> =</div>
2633
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
2634
+ </div>
2635
+
2636
+ ## RequestUpdateCustomerEmailAddressResult
2637
+
2638
+ <div class="graphql-code-block">
2639
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">RequestUpdateCustomerEmailAddressResult</span> =</div>
2640
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#invalidcredentialserror">InvalidCredentialsError</a> | <a href="/reference/graphql-api/shop/object-types#emailaddressconflicterror">EmailAddressConflictError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
2641
+ </div>
2642
+
2643
+ ## ResetPasswordResult
2644
+
2645
+ <div class="graphql-code-block">
2646
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">ResetPasswordResult</span> =</div>
2647
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#currentuser">CurrentUser</a> | <a href="/reference/graphql-api/shop/object-types#passwordresettokeninvaliderror">PasswordResetTokenInvalidError</a> | <a href="/reference/graphql-api/shop/object-types#passwordresettokenexpirederror">PasswordResetTokenExpiredError</a> | <a href="/reference/graphql-api/shop/object-types#passwordvalidationerror">PasswordValidationError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a> | <a href="/reference/graphql-api/shop/object-types#notverifiederror">NotVerifiedError</a></div>
2648
+ </div>
2649
+
2650
+ ## Role
2651
+
2652
+ <div class="graphql-code-block">
2653
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Role</span> &#123;</div>
2654
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2655
+
2656
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2657
+
2658
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2659
+
2660
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2661
+
2662
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2663
+
2664
+ <div class="graphql-code-line ">permissions: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]!</div>
2665
+
2666
+ <div class="graphql-code-line ">channels: [<a href="/reference/graphql-api/shop/object-types#channel">Channel</a>!]!</div>
2667
+
2668
+
2669
+ <div class="graphql-code-line top-level">&#125;</div>
2670
+ </div>
2671
+
2672
+ ## RoleList
2673
+
2674
+ <div class="graphql-code-block">
2675
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">RoleList</span> &#123;</div>
2676
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#role">Role</a>!]!</div>
2677
+
2678
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
2679
+
2680
+
2681
+ <div class="graphql-code-line top-level">&#125;</div>
2682
+ </div>
2683
+
2684
+ ## SearchReindexResponse
2685
+
2686
+ <div class="graphql-code-block">
2687
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchReindexResponse</span> &#123;</div>
2688
+ <div class="graphql-code-line ">success: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
2689
+
2690
+
2691
+ <div class="graphql-code-line top-level">&#125;</div>
2692
+ </div>
2693
+
2694
+ ## SearchResponse
2695
+
2696
+ <div class="graphql-code-block">
2697
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchResponse</span> &#123;</div>
2698
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#searchresult">SearchResult</a>!]!</div>
2699
+
2700
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
2701
+
2702
+ <div class="graphql-code-line ">facetValues: [<a href="/reference/graphql-api/shop/object-types#facetvalueresult">FacetValueResult</a>!]!</div>
2703
+
2704
+ <div class="graphql-code-line ">collections: [<a href="/reference/graphql-api/shop/object-types#collectionresult">CollectionResult</a>!]!</div>
2705
+
2706
+
2707
+ <div class="graphql-code-line top-level">&#125;</div>
2708
+ </div>
2709
+
2710
+ ## SearchResult
2711
+
2712
+ <div class="graphql-code-block">
2713
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchResult</span> &#123;</div>
2714
+ <div class="graphql-code-line ">sku: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2715
+
2716
+ <div class="graphql-code-line ">slug: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2717
+
2718
+ <div class="graphql-code-line ">productId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2719
+
2720
+ <div class="graphql-code-line ">productName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2721
+
2722
+ <div class="graphql-code-line ">productAsset: <a href="/reference/graphql-api/shop/object-types#searchresultasset">SearchResultAsset</a></div>
2723
+
2724
+ <div class="graphql-code-line ">productVariantId: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2725
+
2726
+ <div class="graphql-code-line ">productVariantName: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2727
+
2728
+ <div class="graphql-code-line ">productVariantAsset: <a href="/reference/graphql-api/shop/object-types#searchresultasset">SearchResultAsset</a></div>
2729
+
2730
+ <div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/object-types#searchresultprice">SearchResultPrice</a>!</div>
2731
+
2732
+ <div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/object-types#searchresultprice">SearchResultPrice</a>!</div>
2733
+
2734
+ <div class="graphql-code-line ">currencyCode: <a href="/reference/graphql-api/shop/enums#currencycode">CurrencyCode</a>!</div>
2735
+
2736
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2737
+
2738
+ <div class="graphql-code-line ">facetIds: [<a href="/reference/graphql-api/shop/object-types#id">ID</a>!]!</div>
2739
+
2740
+ <div class="graphql-code-line ">facetValueIds: [<a href="/reference/graphql-api/shop/object-types#id">ID</a>!]!</div>
2741
+
2742
+ <div class="graphql-code-line comment">"""</div>
2743
+ <div class="graphql-code-line comment">An array of ids of the Collections in which this result appears</div>
2744
+ <div class="graphql-code-line comment">"""</div>
2745
+ <div class="graphql-code-line ">collectionIds: [<a href="/reference/graphql-api/shop/object-types#id">ID</a>!]!</div>
2746
+
2747
+ <div class="graphql-code-line comment">"""</div>
2748
+ <div class="graphql-code-line comment">A relevance score for the result. Differs between database implementations</div>
2749
+ <div class="graphql-code-line comment">"""</div>
2750
+ <div class="graphql-code-line ">score: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
2751
+
2752
+
2753
+ <div class="graphql-code-line top-level">&#125;</div>
2754
+ </div>
2755
+
2756
+ ## SearchResultAsset
2757
+
2758
+ <div class="graphql-code-block">
2759
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SearchResultAsset</span> &#123;</div>
2760
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2761
+
2762
+ <div class="graphql-code-line ">preview: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2763
+
2764
+ <div class="graphql-code-line ">focalPoint: <a href="/reference/graphql-api/shop/object-types#coordinate">Coordinate</a></div>
2765
+
2766
+
2767
+ <div class="graphql-code-line top-level">&#125;</div>
2768
+ </div>
2769
+
2770
+ ## SearchResultPrice
2771
+
2772
+ <div class="graphql-code-block">
2773
+ <div class="graphql-code-line comment">"""</div>
2774
+ <div class="graphql-code-line comment">The price of a search result product, either as a range or as a single price</div>
2775
+ <div class="graphql-code-line comment">"""</div>
2776
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">SearchResultPrice</span> =</div>
2777
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#pricerange">PriceRange</a> | <a href="/reference/graphql-api/shop/object-types#singleprice">SinglePrice</a></div>
2778
+ </div>
2779
+
2780
+ ## Seller
2781
+
2782
+ <div class="graphql-code-block">
2783
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Seller</span> &#123;</div>
2784
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2785
+
2786
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2787
+
2788
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2789
+
2790
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2791
+
2792
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2793
+
2794
+
2795
+ <div class="graphql-code-line top-level">&#125;</div>
2796
+ </div>
2797
+
2798
+ ## SetCustomerForOrderResult
2799
+
2800
+ <div class="graphql-code-block">
2801
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">SetCustomerForOrderResult</span> =</div>
2802
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#alreadyloggedinerror">AlreadyLoggedInError</a> | <a href="/reference/graphql-api/shop/object-types#emailaddressconflicterror">EmailAddressConflictError</a> | <a href="/reference/graphql-api/shop/object-types#noactiveordererror">NoActiveOrderError</a> | <a href="/reference/graphql-api/shop/object-types#guestcheckouterror">GuestCheckoutError</a></div>
2803
+ </div>
2804
+
2805
+ ## SetOrderShippingMethodResult
2806
+
2807
+ <div class="graphql-code-block">
2808
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">SetOrderShippingMethodResult</span> =</div>
2809
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#ordermodificationerror">OrderModificationError</a> | <a href="/reference/graphql-api/shop/object-types#ineligibleshippingmethoderror">IneligibleShippingMethodError</a> | <a href="/reference/graphql-api/shop/object-types#noactiveordererror">NoActiveOrderError</a></div>
2810
+ </div>
2811
+
2812
+ ## ShippingLine
2813
+
2814
+ <div class="graphql-code-block">
2815
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingLine</span> &#123;</div>
2816
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2817
+
2818
+ <div class="graphql-code-line ">shippingMethod: <a href="/reference/graphql-api/shop/object-types#shippingmethod">ShippingMethod</a>!</div>
2819
+
2820
+ <div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2821
+
2822
+ <div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2823
+
2824
+ <div class="graphql-code-line ">discountedPrice: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2825
+
2826
+ <div class="graphql-code-line ">discountedPriceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2827
+
2828
+ <div class="graphql-code-line ">discounts: [<a href="/reference/graphql-api/shop/object-types#discount">Discount</a>!]!</div>
2829
+
2830
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2831
+
2832
+
2833
+ <div class="graphql-code-line top-level">&#125;</div>
2834
+ </div>
2835
+
2836
+ ## ShippingMethod
2837
+
2838
+ <div class="graphql-code-block">
2839
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethod</span> &#123;</div>
2840
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2841
+
2842
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2843
+
2844
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2845
+
2846
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2847
+
2848
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2849
+
2850
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2851
+
2852
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2853
+
2854
+ <div class="graphql-code-line ">fulfillmentHandlerCode: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2855
+
2856
+ <div class="graphql-code-line ">checker: <a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!</div>
2857
+
2858
+ <div class="graphql-code-line ">calculator: <a href="/reference/graphql-api/shop/object-types#configurableoperation">ConfigurableOperation</a>!</div>
2859
+
2860
+ <div class="graphql-code-line ">translations: [<a href="/reference/graphql-api/shop/object-types#shippingmethodtranslation">ShippingMethodTranslation</a>!]!</div>
2861
+
2862
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2863
+
2864
+
2865
+ <div class="graphql-code-line top-level">&#125;</div>
2866
+ </div>
2867
+
2868
+ ## ShippingMethodList
2869
+
2870
+ <div class="graphql-code-block">
2871
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethodList</span> &#123;</div>
2872
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#shippingmethod">ShippingMethod</a>!]!</div>
2873
+
2874
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
2875
+
2876
+
2877
+ <div class="graphql-code-line top-level">&#125;</div>
2878
+ </div>
2879
+
2880
+ ## ShippingMethodQuote
2881
+
2882
+ <div class="graphql-code-block">
2883
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethodQuote</span> &#123;</div>
2884
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2885
+
2886
+ <div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2887
+
2888
+ <div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2889
+
2890
+ <div class="graphql-code-line ">code: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2891
+
2892
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2893
+
2894
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2895
+
2896
+ <div class="graphql-code-line comment">"""</div>
2897
+ <div class="graphql-code-line comment">Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult</div>
2898
+ <div class="graphql-code-line comment">"""</div>
2899
+ <div class="graphql-code-line ">metadata: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2900
+
2901
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2902
+
2903
+
2904
+ <div class="graphql-code-line top-level">&#125;</div>
2905
+ </div>
2906
+
2907
+ ## ShippingMethodTranslation
2908
+
2909
+ <div class="graphql-code-block">
2910
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">ShippingMethodTranslation</span> &#123;</div>
2911
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
2912
+
2913
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2914
+
2915
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
2916
+
2917
+ <div class="graphql-code-line ">languageCode: <a href="/reference/graphql-api/shop/enums#languagecode">LanguageCode</a>!</div>
2918
+
2919
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2920
+
2921
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2922
+
2923
+
2924
+ <div class="graphql-code-line top-level">&#125;</div>
2925
+ </div>
2926
+
2927
+ ## SinglePrice
2928
+
2929
+ <div class="graphql-code-block">
2930
+ <div class="graphql-code-line top-level comment">"""</div>
2931
+ <div class="graphql-code-line top-level comment">The price value where the result has a single price</div>
2932
+ <div class="graphql-code-line top-level comment">"""</div>
2933
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">SinglePrice</span> &#123;</div>
2934
+ <div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
2935
+
2936
+
2937
+ <div class="graphql-code-line top-level">&#125;</div>
2938
+ </div>
2939
+
2940
+ ## String
2941
+
2942
+ <div class="graphql-code-block">
2943
+ <div class="graphql-code-line top-level comment">"""</div>
2944
+ <div class="graphql-code-line top-level comment">The <code>String</code> scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.</div>
2945
+ <div class="graphql-code-line top-level comment">"""</div>
2946
+ <div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">String</span></div>
2947
+ </div>
2948
+
2949
+ ## StringCustomFieldConfig
2950
+
2951
+ <div class="graphql-code-block">
2952
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StringCustomFieldConfig</span> &#123;</div>
2953
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2954
+
2955
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2956
+
2957
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
2958
+
2959
+ <div class="graphql-code-line ">length: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
2960
+
2961
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
2962
+
2963
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
2964
+
2965
+ <div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
2966
+
2967
+ <div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
2968
+
2969
+ <div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
2970
+
2971
+ <div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
2972
+
2973
+ <div class="graphql-code-line ">deprecated: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
2974
+
2975
+ <div class="graphql-code-line ">deprecationReason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
2976
+
2977
+ <div class="graphql-code-line ">pattern: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
2978
+
2979
+ <div class="graphql-code-line ">options: [<a href="/reference/graphql-api/shop/object-types#stringfieldoption">StringFieldOption</a>!]</div>
2980
+
2981
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
2982
+
2983
+
2984
+ <div class="graphql-code-line top-level">&#125;</div>
2985
+ </div>
2986
+
2987
+ ## StringFieldOption
2988
+
2989
+ <div class="graphql-code-block">
2990
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StringFieldOption</span> &#123;</div>
2991
+ <div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
2992
+
2993
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
2994
+
2995
+
2996
+ <div class="graphql-code-line top-level">&#125;</div>
2997
+ </div>
2998
+
2999
+ ## StringStructFieldConfig
3000
+
3001
+ <div class="graphql-code-block">
3002
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StringStructFieldConfig</span> &#123;</div>
3003
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3004
+
3005
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3006
+
3007
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
3008
+
3009
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
3010
+
3011
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
3012
+
3013
+ <div class="graphql-code-line ">length: <a href="/reference/graphql-api/shop/object-types#int">Int</a></div>
3014
+
3015
+ <div class="graphql-code-line ">pattern: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
3016
+
3017
+ <div class="graphql-code-line ">options: [<a href="/reference/graphql-api/shop/object-types#stringfieldoption">StringFieldOption</a>!]</div>
3018
+
3019
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
3020
+
3021
+
3022
+ <div class="graphql-code-line top-level">&#125;</div>
3023
+ </div>
3024
+
3025
+ ## StructCustomFieldConfig
3026
+
3027
+ <div class="graphql-code-block">
3028
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">StructCustomFieldConfig</span> &#123;</div>
3029
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3030
+
3031
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3032
+
3033
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
3034
+
3035
+ <div class="graphql-code-line ">fields: [<a href="/reference/graphql-api/shop/object-types#structfieldconfig">StructFieldConfig</a>!]!</div>
3036
+
3037
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
3038
+
3039
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
3040
+
3041
+ <div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
3042
+
3043
+ <div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
3044
+
3045
+ <div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
3046
+
3047
+ <div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
3048
+
3049
+ <div class="graphql-code-line ">deprecated: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
3050
+
3051
+ <div class="graphql-code-line ">deprecationReason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
3052
+
3053
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
3054
+
3055
+
3056
+ <div class="graphql-code-line top-level">&#125;</div>
3057
+ </div>
3058
+
3059
+ ## StructFieldConfig
3060
+
3061
+ <div class="graphql-code-block">
3062
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">StructFieldConfig</span> =</div>
3063
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#stringstructfieldconfig">StringStructFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#intstructfieldconfig">IntStructFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#floatstructfieldconfig">FloatStructFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#booleanstructfieldconfig">BooleanStructFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#datetimestructfieldconfig">DateTimeStructFieldConfig</a> | <a href="/reference/graphql-api/shop/object-types#textstructfieldconfig">TextStructFieldConfig</a></div>
3064
+ </div>
3065
+
3066
+ ## Success
3067
+
3068
+ <div class="graphql-code-block">
3069
+ <div class="graphql-code-line top-level comment">"""</div>
3070
+ <div class="graphql-code-line top-level comment">Indicates that an operation succeeded, where we do not want to return any more specific information.</div>
3071
+ <div class="graphql-code-line top-level comment">"""</div>
3072
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Success</span> &#123;</div>
3073
+ <div class="graphql-code-line ">success: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
3074
+
3075
+
3076
+ <div class="graphql-code-line top-level">&#125;</div>
3077
+ </div>
3078
+
3079
+ ## Surcharge
3080
+
3081
+ <div class="graphql-code-block">
3082
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Surcharge</span> &#123;</div>
3083
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
3084
+
3085
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3086
+
3087
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3088
+
3089
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3090
+
3091
+ <div class="graphql-code-line ">sku: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
3092
+
3093
+ <div class="graphql-code-line ">taxLines: [<a href="/reference/graphql-api/shop/object-types#taxline">TaxLine</a>!]!</div>
3094
+
3095
+ <div class="graphql-code-line ">price: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
3096
+
3097
+ <div class="graphql-code-line ">priceWithTax: <a href="/reference/graphql-api/shop/object-types#money">Money</a>!</div>
3098
+
3099
+ <div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
3100
+
3101
+
3102
+ <div class="graphql-code-line top-level">&#125;</div>
3103
+ </div>
3104
+
3105
+ ## Tag
3106
+
3107
+ <div class="graphql-code-block">
3108
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Tag</span> &#123;</div>
3109
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
3110
+
3111
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3112
+
3113
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3114
+
3115
+ <div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3116
+
3117
+
3118
+ <div class="graphql-code-line top-level">&#125;</div>
3119
+ </div>
3120
+
3121
+ ## TagList
3122
+
3123
+ <div class="graphql-code-block">
3124
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TagList</span> &#123;</div>
3125
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#tag">Tag</a>!]!</div>
3126
+
3127
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
3128
+
3129
+
3130
+ <div class="graphql-code-line top-level">&#125;</div>
3131
+ </div>
3132
+
3133
+ ## TaxCategory
3134
+
3135
+ <div class="graphql-code-block">
3136
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxCategory</span> &#123;</div>
3137
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
3138
+
3139
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3140
+
3141
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3142
+
3143
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3144
+
3145
+ <div class="graphql-code-line ">isDefault: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
3146
+
3147
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
3148
+
3149
+
3150
+ <div class="graphql-code-line top-level">&#125;</div>
3151
+ </div>
3152
+
3153
+ ## TaxLine
3154
+
3155
+ <div class="graphql-code-block">
3156
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxLine</span> &#123;</div>
3157
+ <div class="graphql-code-line ">description: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3158
+
3159
+ <div class="graphql-code-line ">taxRate: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
3160
+
3161
+
3162
+ <div class="graphql-code-line top-level">&#125;</div>
3163
+ </div>
3164
+
3165
+ ## TaxRate
3166
+
3167
+ <div class="graphql-code-block">
3168
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxRate</span> &#123;</div>
3169
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
3170
+
3171
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3172
+
3173
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3174
+
3175
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3176
+
3177
+ <div class="graphql-code-line ">enabled: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
3178
+
3179
+ <div class="graphql-code-line ">value: <a href="/reference/graphql-api/shop/object-types#float">Float</a>!</div>
3180
+
3181
+ <div class="graphql-code-line ">category: <a href="/reference/graphql-api/shop/object-types#taxcategory">TaxCategory</a>!</div>
3182
+
3183
+ <div class="graphql-code-line ">zone: <a href="/reference/graphql-api/shop/object-types#zone">Zone</a>!</div>
3184
+
3185
+ <div class="graphql-code-line ">customerGroup: <a href="/reference/graphql-api/shop/object-types#customergroup">CustomerGroup</a></div>
3186
+
3187
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
3188
+
3189
+
3190
+ <div class="graphql-code-line top-level">&#125;</div>
3191
+ </div>
3192
+
3193
+ ## TaxRateList
3194
+
3195
+ <div class="graphql-code-block">
3196
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TaxRateList</span> &#123;</div>
3197
+ <div class="graphql-code-line ">items: [<a href="/reference/graphql-api/shop/object-types#taxrate">TaxRate</a>!]!</div>
3198
+
3199
+ <div class="graphql-code-line ">totalItems: <a href="/reference/graphql-api/shop/object-types#int">Int</a>!</div>
3200
+
3201
+
3202
+ <div class="graphql-code-line top-level">&#125;</div>
3203
+ </div>
3204
+
3205
+ ## TextCustomFieldConfig
3206
+
3207
+ <div class="graphql-code-block">
3208
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TextCustomFieldConfig</span> &#123;</div>
3209
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3210
+
3211
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3212
+
3213
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
3214
+
3215
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
3216
+
3217
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
3218
+
3219
+ <div class="graphql-code-line ">readonly: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
3220
+
3221
+ <div class="graphql-code-line ">internal: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
3222
+
3223
+ <div class="graphql-code-line ">nullable: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
3224
+
3225
+ <div class="graphql-code-line ">requiresPermission: [<a href="/reference/graphql-api/shop/enums#permission">Permission</a>!]</div>
3226
+
3227
+ <div class="graphql-code-line ">deprecated: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a></div>
3228
+
3229
+ <div class="graphql-code-line ">deprecationReason: <a href="/reference/graphql-api/shop/object-types#string">String</a></div>
3230
+
3231
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
3232
+
3233
+
3234
+ <div class="graphql-code-line top-level">&#125;</div>
3235
+ </div>
3236
+
3237
+ ## TextStructFieldConfig
3238
+
3239
+ <div class="graphql-code-block">
3240
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">TextStructFieldConfig</span> &#123;</div>
3241
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3242
+
3243
+ <div class="graphql-code-line ">type: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3244
+
3245
+ <div class="graphql-code-line ">list: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
3246
+
3247
+ <div class="graphql-code-line ">label: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
3248
+
3249
+ <div class="graphql-code-line ">description: [<a href="/reference/graphql-api/shop/object-types#localizedstring">LocalizedString</a>!]</div>
3250
+
3251
+ <div class="graphql-code-line ">ui: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
3252
+
3253
+
3254
+ <div class="graphql-code-line top-level">&#125;</div>
3255
+ </div>
3256
+
3257
+ ## TransitionOrderToStateResult
3258
+
3259
+ <div class="graphql-code-block">
3260
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">TransitionOrderToStateResult</span> =</div>
3261
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#orderstatetransitionerror">OrderStateTransitionError</a></div>
3262
+ </div>
3263
+
3264
+ ## UpdateCustomerEmailAddressResult
3265
+
3266
+ <div class="graphql-code-block">
3267
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdateCustomerEmailAddressResult</span> =</div>
3268
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#identifierchangetokeninvaliderror">IdentifierChangeTokenInvalidError</a> | <a href="/reference/graphql-api/shop/object-types#identifierchangetokenexpirederror">IdentifierChangeTokenExpiredError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
3269
+ </div>
3270
+
3271
+ ## UpdateCustomerPasswordResult
3272
+
3273
+ <div class="graphql-code-block">
3274
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdateCustomerPasswordResult</span> =</div>
3275
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#success">Success</a> | <a href="/reference/graphql-api/shop/object-types#invalidcredentialserror">InvalidCredentialsError</a> | <a href="/reference/graphql-api/shop/object-types#passwordvalidationerror">PasswordValidationError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
3276
+ </div>
3277
+
3278
+ ## UpdateMultipleOrderItemsResult
3279
+
3280
+ <div class="graphql-code-block">
3281
+ <div class="graphql-code-line top-level comment">"""</div>
3282
+ <div class="graphql-code-line top-level comment">Returned when multiple items are added to an Order.</div>
3283
+
3284
+ <div class="graphql-code-line top-level comment">The errorResults array contains the errors that occurred for each item, if any.</div>
3285
+ <div class="graphql-code-line top-level comment">"""</div>
3286
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">UpdateMultipleOrderItemsResult</span> &#123;</div>
3287
+ <div class="graphql-code-line ">order: <a href="/reference/graphql-api/shop/object-types#order">Order</a>!</div>
3288
+
3289
+ <div class="graphql-code-line ">errorResults: [<a href="/reference/graphql-api/shop/object-types#updateorderitemerrorresult">UpdateOrderItemErrorResult</a>!]!</div>
3290
+
3291
+
3292
+ <div class="graphql-code-line top-level">&#125;</div>
3293
+ </div>
3294
+
3295
+ ## UpdateOrderItemErrorResult
3296
+
3297
+ <div class="graphql-code-block">
3298
+ <div class="graphql-code-line comment">"""</div>
3299
+ <div class="graphql-code-line comment">Union type of all possible errors that can occur when adding or removing items from an Order.</div>
3300
+ <div class="graphql-code-line comment">"""</div>
3301
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdateOrderItemErrorResult</span> =</div>
3302
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#ordermodificationerror">OrderModificationError</a> | <a href="/reference/graphql-api/shop/object-types#orderlimiterror">OrderLimitError</a> | <a href="/reference/graphql-api/shop/object-types#negativequantityerror">NegativeQuantityError</a> | <a href="/reference/graphql-api/shop/object-types#insufficientstockerror">InsufficientStockError</a> | <a href="/reference/graphql-api/shop/object-types#orderinterceptorerror">OrderInterceptorError</a></div>
3303
+ </div>
3304
+
3305
+ ## UpdateOrderItemsResult
3306
+
3307
+ <div class="graphql-code-block">
3308
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">UpdateOrderItemsResult</span> =</div>
3309
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#order">Order</a> | <a href="/reference/graphql-api/shop/object-types#ordermodificationerror">OrderModificationError</a> | <a href="/reference/graphql-api/shop/object-types#orderlimiterror">OrderLimitError</a> | <a href="/reference/graphql-api/shop/object-types#negativequantityerror">NegativeQuantityError</a> | <a href="/reference/graphql-api/shop/object-types#insufficientstockerror">InsufficientStockError</a> | <a href="/reference/graphql-api/shop/object-types#orderinterceptorerror">OrderInterceptorError</a></div>
3310
+ </div>
3311
+
3312
+ ## Upload
3313
+
3314
+ <div class="graphql-code-block">
3315
+ <div class="graphql-code-line top-level comment">"""</div>
3316
+ <div class="graphql-code-line top-level comment">The <code>Upload</code> scalar type represents a file upload.</div>
3317
+ <div class="graphql-code-line top-level comment">"""</div>
3318
+ <div class="graphql-code-line top-level">scalar <span class="graphql-code-identifier">Upload</span></div>
3319
+ </div>
3320
+
3321
+ ## User
3322
+
3323
+ <div class="graphql-code-block">
3324
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">User</span> &#123;</div>
3325
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
3326
+
3327
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3328
+
3329
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3330
+
3331
+ <div class="graphql-code-line ">identifier: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3332
+
3333
+ <div class="graphql-code-line ">verified: <a href="/reference/graphql-api/shop/object-types#boolean">Boolean</a>!</div>
3334
+
3335
+ <div class="graphql-code-line ">roles: [<a href="/reference/graphql-api/shop/object-types#role">Role</a>!]!</div>
3336
+
3337
+ <div class="graphql-code-line ">lastLogin: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a></div>
3338
+
3339
+ <div class="graphql-code-line ">authenticationMethods: [<a href="/reference/graphql-api/shop/object-types#authenticationmethod">AuthenticationMethod</a>!]!</div>
3340
+
3341
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
3342
+
3343
+
3344
+ <div class="graphql-code-line top-level">&#125;</div>
3345
+ </div>
3346
+
3347
+ ## VerificationTokenExpiredError
3348
+
3349
+ <div class="graphql-code-block">
3350
+ <div class="graphql-code-line top-level comment">"""</div>
3351
+ <div class="graphql-code-line top-level comment">Returned if the verification token (used to verify a Customer's email address) is valid, but has</div>
3352
+
3353
+ <div class="graphql-code-line top-level comment">expired according to the <code>verificationTokenDuration</code> setting in the AuthOptions.</div>
3354
+ <div class="graphql-code-line top-level comment">"""</div>
3355
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">VerificationTokenExpiredError</span> &#123;</div>
3356
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
3357
+
3358
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3359
+
3360
+
3361
+ <div class="graphql-code-line top-level">&#125;</div>
3362
+ </div>
3363
+
3364
+ ## VerificationTokenInvalidError
3365
+
3366
+ <div class="graphql-code-block">
3367
+ <div class="graphql-code-line top-level comment">"""</div>
3368
+ <div class="graphql-code-line top-level comment">Returned if the verification token (used to verify a Customer's email address) is either</div>
3369
+
3370
+ <div class="graphql-code-line top-level comment">invalid or does not match any expected tokens.</div>
3371
+ <div class="graphql-code-line top-level comment">"""</div>
3372
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">VerificationTokenInvalidError</span> &#123;</div>
3373
+ <div class="graphql-code-line ">errorCode: <a href="/reference/graphql-api/shop/enums#errorcode">ErrorCode</a>!</div>
3374
+
3375
+ <div class="graphql-code-line ">message: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3376
+
3377
+
3378
+ <div class="graphql-code-line top-level">&#125;</div>
3379
+ </div>
3380
+
3381
+ ## VerifyCustomerAccountResult
3382
+
3383
+ <div class="graphql-code-block">
3384
+ <div class="graphql-code-line top-level">union <span class="graphql-code-identifier">VerifyCustomerAccountResult</span> =</div>
3385
+ <div class="graphql-code-line "><a href="/reference/graphql-api/shop/object-types#currentuser">CurrentUser</a> | <a href="/reference/graphql-api/shop/object-types#verificationtokeninvaliderror">VerificationTokenInvalidError</a> | <a href="/reference/graphql-api/shop/object-types#verificationtokenexpirederror">VerificationTokenExpiredError</a> | <a href="/reference/graphql-api/shop/object-types#missingpassworderror">MissingPasswordError</a> | <a href="/reference/graphql-api/shop/object-types#passwordvalidationerror">PasswordValidationError</a> | <a href="/reference/graphql-api/shop/object-types#passwordalreadyseterror">PasswordAlreadySetError</a> | <a href="/reference/graphql-api/shop/object-types#nativeauthstrategyerror">NativeAuthStrategyError</a></div>
3386
+ </div>
3387
+
3388
+ ## Zone
3389
+
3390
+ <div class="graphql-code-block">
3391
+ <div class="graphql-code-line top-level">type <span class="graphql-code-identifier">Zone</span> &#123;</div>
3392
+ <div class="graphql-code-line ">id: <a href="/reference/graphql-api/shop/object-types#id">ID</a>!</div>
3393
+
3394
+ <div class="graphql-code-line ">createdAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3395
+
3396
+ <div class="graphql-code-line ">updatedAt: <a href="/reference/graphql-api/shop/object-types#datetime">DateTime</a>!</div>
3397
+
3398
+ <div class="graphql-code-line ">name: <a href="/reference/graphql-api/shop/object-types#string">String</a>!</div>
3399
+
3400
+ <div class="graphql-code-line ">members: [<a href="/reference/graphql-api/shop/object-types#region">Region</a>!]!</div>
3401
+
3402
+ <div class="graphql-code-line ">customFields: <a href="/reference/graphql-api/shop/object-types#json">JSON</a></div>
3403
+
3404
+
3405
+ <div class="graphql-code-line top-level">&#125;</div>
3406
+ </div>