@vendure/docs 0.0.0-202601201808 → 0.0.0-202601210957

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 (374) hide show
  1. package/docs/reference/admin-ui-api/action-bar/action-bar-context.mdx +1 -1
  2. package/docs/reference/admin-ui-api/action-bar/action-bar-dropdown-menu-item.mdx +2 -2
  3. package/docs/reference/admin-ui-api/action-bar/action-bar-item.mdx +3 -3
  4. package/docs/reference/admin-ui-api/alerts/alert-config.mdx +5 -5
  5. package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +6 -6
  6. package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +4 -4
  7. package/docs/reference/admin-ui-api/components/currency-input-component.mdx +4 -4
  8. package/docs/reference/admin-ui-api/components/data-table-component.mdx +5 -5
  9. package/docs/reference/admin-ui-api/components/data-table2component.mdx +7 -7
  10. package/docs/reference/admin-ui-api/components/datetime-picker-component.mdx +7 -7
  11. package/docs/reference/admin-ui-api/components/dropdown-component.mdx +1 -1
  12. package/docs/reference/admin-ui-api/components/facet-value-selector-component.mdx +6 -6
  13. package/docs/reference/admin-ui-api/components/object-tree-component.mdx +1 -1
  14. package/docs/reference/admin-ui-api/components/product-variant-selector-component.mdx +1 -1
  15. package/docs/reference/admin-ui-api/components/rich-text-editor-component.mdx +2 -2
  16. package/docs/reference/admin-ui-api/components/zone-selector-component.mdx +3 -3
  17. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component-config.mdx +1 -1
  18. package/docs/reference/admin-ui-api/custom-detail-components/custom-detail-component.mdx +1 -1
  19. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-component.mdx +4 -4
  20. package/docs/reference/admin-ui-api/custom-history-entry-components/history-entry-config.mdx +1 -1
  21. package/docs/reference/admin-ui-api/custom-input-components/default-inputs.mdx +22 -22
  22. package/docs/reference/admin-ui-api/custom-input-components/register-form-input-component.mdx +1 -1
  23. package/docs/reference/admin-ui-api/custom-table-components/data-table-component-config.mdx +1 -1
  24. package/docs/reference/admin-ui-api/dashboard-widgets/dashboard-widget-config.mdx +1 -1
  25. package/docs/reference/admin-ui-api/directives/if-multichannel-directive.mdx +2 -2
  26. package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +2 -2
  27. package/docs/reference/admin-ui-api/list-detail-views/base-detail-component.mdx +6 -6
  28. package/docs/reference/admin-ui-api/list-detail-views/base-entity-resolver.mdx +1 -1
  29. package/docs/reference/admin-ui-api/list-detail-views/base-list-component.mdx +8 -8
  30. package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
  31. package/docs/reference/admin-ui-api/list-detail-views/typed-base-detail-component.mdx +3 -3
  32. package/docs/reference/admin-ui-api/list-detail-views/typed-base-list-component.mdx +7 -7
  33. package/docs/reference/admin-ui-api/nav-menu/nav-menu-item.mdx +3 -3
  34. package/docs/reference/admin-ui-api/nav-menu/nav-menu-section.mdx +1 -1
  35. package/docs/reference/admin-ui-api/react-components/action-bar.mdx +1 -1
  36. package/docs/reference/admin-ui-api/react-components/card.mdx +1 -1
  37. package/docs/reference/admin-ui-api/react-components/cds-icon.mdx +1 -1
  38. package/docs/reference/admin-ui-api/react-components/form-field.mdx +1 -1
  39. package/docs/reference/admin-ui-api/react-components/link.mdx +1 -1
  40. package/docs/reference/admin-ui-api/react-components/page-detail-layout.mdx +1 -1
  41. package/docs/reference/admin-ui-api/react-extensions/react-custom-detail-component-config.mdx +1 -1
  42. package/docs/reference/admin-ui-api/react-extensions/react-data-table-component-config.mdx +1 -1
  43. package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
  44. package/docs/reference/admin-ui-api/react-hooks/use-injector.mdx +1 -1
  45. package/docs/reference/admin-ui-api/react-hooks/use-lazy-query.mdx +1 -1
  46. package/docs/reference/admin-ui-api/react-hooks/use-mutation.mdx +1 -1
  47. package/docs/reference/admin-ui-api/react-hooks/use-query.mdx +1 -1
  48. package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
  49. package/docs/reference/admin-ui-api/services/data-service.mdx +10 -10
  50. package/docs/reference/admin-ui-api/services/modal-service.mdx +5 -5
  51. package/docs/reference/admin-ui-api/tabs/page-tab-config.mdx +1 -1
  52. package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +2 -2
  53. package/docs/reference/core-plugins/admin-ui-plugin/admin-ui-plugin-options.mdx +1 -1
  54. package/docs/reference/core-plugins/admin-ui-plugin/index.mdx +1 -1
  55. package/docs/reference/core-plugins/asset-server-plugin/asset-server-options.mdx +2 -2
  56. package/docs/reference/core-plugins/asset-server-plugin/image-transform-strategy.mdx +1 -1
  57. package/docs/reference/core-plugins/asset-server-plugin/index.mdx +1 -1
  58. package/docs/reference/core-plugins/asset-server-plugin/local-asset-storage-strategy.mdx +8 -8
  59. package/docs/reference/core-plugins/asset-server-plugin/preset-only-strategy.mdx +1 -1
  60. package/docs/reference/core-plugins/asset-server-plugin/s3asset-storage-strategy.mdx +2 -2
  61. package/docs/reference/core-plugins/asset-server-plugin/sharp-asset-preview-strategy.mdx +1 -1
  62. package/docs/reference/core-plugins/dashboard-plugin/index.mdx +1 -1
  63. package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +8 -8
  64. package/docs/reference/core-plugins/elasticsearch-plugin/index.mdx +1 -1
  65. package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +2 -2
  66. package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
  67. package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
  68. package/docs/reference/core-plugins/email-plugin/email-generator.mdx +2 -2
  69. package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +3 -3
  70. package/docs/reference/core-plugins/email-plugin/email-plugin-types.mdx +1 -1
  71. package/docs/reference/core-plugins/email-plugin/email-sender.mdx +1 -1
  72. package/docs/reference/core-plugins/email-plugin/index.mdx +1 -1
  73. package/docs/reference/core-plugins/email-plugin/template-loader.mdx +4 -4
  74. package/docs/reference/core-plugins/email-plugin/transport-options.mdx +1 -1
  75. package/docs/reference/core-plugins/graphiql-plugin/index.mdx +2 -2
  76. package/docs/reference/core-plugins/harden-plugin/harden-plugin-options.mdx +1 -1
  77. package/docs/reference/core-plugins/job-queue-plugin/bull-mqjob-queue-strategy.mdx +9 -9
  78. package/docs/reference/core-plugins/job-queue-plugin/bull-mqplugin-options.mdx +5 -5
  79. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-job-queue-strategy.mdx +3 -3
  80. package/docs/reference/core-plugins/job-queue-plugin/pub-sub-plugin.mdx +1 -1
  81. package/docs/reference/core-plugins/payments-plugin/braintree-plugin.mdx +2 -2
  82. package/docs/reference/core-plugins/payments-plugin/mollie-plugin.mdx +1 -1
  83. package/docs/reference/core-plugins/payments-plugin/stripe-plugin.mdx +5 -5
  84. package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +4 -4
  85. package/docs/reference/core-plugins/stellate-plugin/stellate-service.mdx +1 -1
  86. package/docs/reference/core-plugins/telemetry-plugin/get-sdk-configuration.mdx +1 -1
  87. package/docs/reference/core-plugins/telemetry-plugin/register-method-hooks.mdx +2 -2
  88. package/docs/reference/core-plugins/telemetry-plugin/telemetry-plugin-options.mdx +1 -1
  89. package/docs/reference/dashboard/components/asset-gallery.mdx +3 -3
  90. package/docs/reference/dashboard/components/asset-picker-dialog.mdx +2 -2
  91. package/docs/reference/dashboard/components/channel-chip.mdx +1 -1
  92. package/docs/reference/dashboard/components/detail-page-button.mdx +1 -1
  93. package/docs/reference/dashboard/components/facet-value-selector.mdx +1 -1
  94. package/docs/reference/dashboard/components/permission-guard.mdx +1 -1
  95. package/docs/reference/dashboard/components/vendure-image.mdx +2 -2
  96. package/docs/reference/dashboard/detail-views/detail-page.mdx +3 -3
  97. package/docs/reference/dashboard/detail-views/use-detail-page.mdx +11 -11
  98. package/docs/reference/dashboard/detail-views/use-generated-form.mdx +3 -3
  99. package/docs/reference/dashboard/extensions-api/action-bar.mdx +1 -1
  100. package/docs/reference/dashboard/extensions-api/alerts.mdx +6 -6
  101. package/docs/reference/dashboard/extensions-api/data-tables.mdx +1 -1
  102. package/docs/reference/dashboard/extensions-api/detail-forms.mdx +1 -1
  103. package/docs/reference/dashboard/extensions-api/history-entries.mdx +2 -2
  104. package/docs/reference/dashboard/extensions-api/page-blocks.mdx +2 -2
  105. package/docs/reference/dashboard/extensions-api/routes.mdx +4 -4
  106. package/docs/reference/dashboard/extensions-api/widgets.mdx +1 -1
  107. package/docs/reference/dashboard/form-components/affixed-input.mdx +1 -1
  108. package/docs/reference/dashboard/form-components/boolean-input.mdx +1 -1
  109. package/docs/reference/dashboard/form-components/checkbox-input.mdx +1 -1
  110. package/docs/reference/dashboard/form-components/date-time-input.mdx +1 -1
  111. package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
  112. package/docs/reference/dashboard/form-components/money-input.mdx +1 -1
  113. package/docs/reference/dashboard/form-components/number-input.mdx +1 -1
  114. package/docs/reference/dashboard/form-components/password-input.mdx +1 -1
  115. package/docs/reference/dashboard/form-components/rich-text-input.mdx +1 -1
  116. package/docs/reference/dashboard/form-components/textarea-input.mdx +1 -1
  117. package/docs/reference/dashboard/hooks/use-alerts.mdx +1 -1
  118. package/docs/reference/dashboard/hooks/use-auth.mdx +5 -5
  119. package/docs/reference/dashboard/hooks/use-channel.mdx +2 -2
  120. package/docs/reference/dashboard/hooks/use-drag-and-drop.mdx +1 -1
  121. package/docs/reference/dashboard/list-views/bulk-actions.mdx +3 -3
  122. package/docs/reference/dashboard/list-views/data-table.mdx +10 -10
  123. package/docs/reference/dashboard/list-views/list-page.mdx +13 -13
  124. package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +17 -17
  125. package/docs/reference/dashboard/page-layout/index.mdx +1 -1
  126. package/docs/reference/dashboard/page-layout/page-action-bar.mdx +3 -3
  127. package/docs/reference/dashboard/page-layout/page-block.mdx +3 -3
  128. package/docs/reference/dashboard/page-layout/page-title.mdx +1 -1
  129. package/docs/reference/dashboard/page-layout/page.mdx +3 -3
  130. package/docs/reference/typescript-api/assets/asset-preview-strategy.mdx +1 -1
  131. package/docs/reference/typescript-api/assets/asset-storage-strategy.mdx +6 -6
  132. package/docs/reference/typescript-api/auth/auth-options.mdx +1 -1
  133. package/docs/reference/typescript-api/auth/authentication-strategy.mdx +2 -2
  134. package/docs/reference/typescript-api/auth/bcrypt-password-hashing-strategy.mdx +2 -2
  135. package/docs/reference/typescript-api/auth/default-session-cache-strategy.mdx +4 -4
  136. package/docs/reference/typescript-api/auth/external-authentication-service.mdx +5 -5
  137. package/docs/reference/typescript-api/auth/native-authentication-strategy.mdx +3 -3
  138. package/docs/reference/typescript-api/auth/password-hashing-strategy.mdx +2 -2
  139. package/docs/reference/typescript-api/auth/password-validation-strategy.mdx +1 -1
  140. package/docs/reference/typescript-api/auth/permission-definition.mdx +2 -2
  141. package/docs/reference/typescript-api/auth/session-cache-strategy.mdx +4 -4
  142. package/docs/reference/typescript-api/auth/verification-token-strategy.mdx +2 -2
  143. package/docs/reference/typescript-api/cache/cache-config.mdx +1 -1
  144. package/docs/reference/typescript-api/cache/cache-service.mdx +4 -4
  145. package/docs/reference/typescript-api/cache/cache-strategy.mdx +4 -4
  146. package/docs/reference/typescript-api/cache/index.mdx +3 -3
  147. package/docs/reference/typescript-api/cache/redis-cache-strategy.mdx +4 -4
  148. package/docs/reference/typescript-api/cache/request-context-cache-service.mdx +2 -2
  149. package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +6 -6
  150. package/docs/reference/typescript-api/cache/sql-cache-strategy.mdx +1 -1
  151. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-config.mdx +1 -1
  152. package/docs/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config.mdx +1 -1
  153. package/docs/reference/typescript-api/common/async-queue.mdx +1 -1
  154. package/docs/reference/typescript-api/common/bootstrap.mdx +2 -2
  155. package/docs/reference/typescript-api/common/injectable-strategy.mdx +2 -2
  156. package/docs/reference/typescript-api/common/injector.mdx +2 -2
  157. package/docs/reference/typescript-api/configurable-operation-def/config-args.mdx +1 -1
  158. package/docs/reference/typescript-api/configurable-operation-def/default-form-config-hash.mdx +11 -11
  159. package/docs/reference/typescript-api/configurable-operation-def/index.mdx +2 -2
  160. package/docs/reference/typescript-api/configuration/api-options.mdx +2 -2
  161. package/docs/reference/typescript-api/configuration/collection-filter.mdx +3 -3
  162. package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +6 -6
  163. package/docs/reference/typescript-api/configuration/entity-id-strategy.mdx +4 -4
  164. package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
  165. package/docs/reference/typescript-api/configuration/product-variant-price-selection-strategy.mdx +1 -1
  166. package/docs/reference/typescript-api/configuration/product-variant-price-update-strategy.mdx +3 -3
  167. package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +15 -15
  168. package/docs/reference/typescript-api/configuration/slug-strategy.mdx +1 -1
  169. package/docs/reference/typescript-api/configuration/vendure-config.mdx +2 -2
  170. package/docs/reference/typescript-api/data-access/calculated-property-subscriber.mdx +1 -1
  171. package/docs/reference/typescript-api/data-access/calculated.mdx +1 -1
  172. package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
  173. package/docs/reference/typescript-api/data-access/get-entity-or-throw-options.mdx +1 -1
  174. package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
  175. package/docs/reference/typescript-api/data-access/list-query-builder.mdx +4 -4
  176. package/docs/reference/typescript-api/data-access/transactional-connection.mdx +9 -9
  177. package/docs/reference/typescript-api/default-search-plugin/index.mdx +1 -1
  178. package/docs/reference/typescript-api/default-search-plugin/mysql-search-strategy.mdx +4 -4
  179. package/docs/reference/typescript-api/default-search-plugin/postgres-search-strategy.mdx +4 -4
  180. package/docs/reference/typescript-api/default-search-plugin/search-strategy.mdx +4 -4
  181. package/docs/reference/typescript-api/default-search-plugin/sqlite-search-strategy.mdx +4 -4
  182. package/docs/reference/typescript-api/entities/address.mdx +1 -1
  183. package/docs/reference/typescript-api/entities/administrator.mdx +1 -1
  184. package/docs/reference/typescript-api/entities/anonymous-session.mdx +1 -1
  185. package/docs/reference/typescript-api/entities/asset.mdx +1 -1
  186. package/docs/reference/typescript-api/entities/authenticated-session.mdx +1 -1
  187. package/docs/reference/typescript-api/entities/authentication-method.mdx +2 -2
  188. package/docs/reference/typescript-api/entities/channel.mdx +1 -1
  189. package/docs/reference/typescript-api/entities/collection.mdx +2 -2
  190. package/docs/reference/typescript-api/entities/country.mdx +1 -1
  191. package/docs/reference/typescript-api/entities/customer-group.mdx +1 -1
  192. package/docs/reference/typescript-api/entities/customer-history-entry.mdx +1 -1
  193. package/docs/reference/typescript-api/entities/customer.mdx +1 -1
  194. package/docs/reference/typescript-api/entities/facet-value.mdx +2 -2
  195. package/docs/reference/typescript-api/entities/facet.mdx +2 -2
  196. package/docs/reference/typescript-api/entities/fulfillment.mdx +1 -1
  197. package/docs/reference/typescript-api/entities/global-settings.mdx +1 -1
  198. package/docs/reference/typescript-api/entities/interfaces.mdx +1 -1
  199. package/docs/reference/typescript-api/entities/order-history-entry.mdx +1 -1
  200. package/docs/reference/typescript-api/entities/order-line-reference.mdx +3 -3
  201. package/docs/reference/typescript-api/entities/order-line.mdx +1 -1
  202. package/docs/reference/typescript-api/entities/order-modification.mdx +1 -1
  203. package/docs/reference/typescript-api/entities/order.mdx +1 -1
  204. package/docs/reference/typescript-api/entities/orderable-asset.mdx +1 -1
  205. package/docs/reference/typescript-api/entities/payment-method.mdx +2 -2
  206. package/docs/reference/typescript-api/entities/payment.mdx +1 -1
  207. package/docs/reference/typescript-api/entities/product-option-group.mdx +2 -2
  208. package/docs/reference/typescript-api/entities/product-option.mdx +2 -2
  209. package/docs/reference/typescript-api/entities/product-variant-price.mdx +1 -1
  210. package/docs/reference/typescript-api/entities/product-variant.mdx +2 -2
  211. package/docs/reference/typescript-api/entities/product.mdx +2 -2
  212. package/docs/reference/typescript-api/entities/promotion.mdx +4 -4
  213. package/docs/reference/typescript-api/entities/province.mdx +1 -1
  214. package/docs/reference/typescript-api/entities/refund.mdx +1 -1
  215. package/docs/reference/typescript-api/entities/region.mdx +1 -1
  216. package/docs/reference/typescript-api/entities/role.mdx +1 -1
  217. package/docs/reference/typescript-api/entities/seller.mdx +1 -1
  218. package/docs/reference/typescript-api/entities/settings-store-entry.mdx +1 -1
  219. package/docs/reference/typescript-api/entities/shipping-line.mdx +1 -1
  220. package/docs/reference/typescript-api/entities/shipping-method.mdx +4 -4
  221. package/docs/reference/typescript-api/entities/stock-level.mdx +1 -1
  222. package/docs/reference/typescript-api/entities/stock-location.mdx +1 -1
  223. package/docs/reference/typescript-api/entities/stock-movement.mdx +5 -5
  224. package/docs/reference/typescript-api/entities/surcharge.mdx +1 -1
  225. package/docs/reference/typescript-api/entities/tag.mdx +1 -1
  226. package/docs/reference/typescript-api/entities/tax-category.mdx +1 -1
  227. package/docs/reference/typescript-api/entities/tax-rate.mdx +1 -1
  228. package/docs/reference/typescript-api/entities/user.mdx +1 -1
  229. package/docs/reference/typescript-api/entities/vendure-entity.mdx +1 -1
  230. package/docs/reference/typescript-api/entities/zone.mdx +1 -1
  231. package/docs/reference/typescript-api/errors/error-handler-strategy.mdx +2 -2
  232. package/docs/reference/typescript-api/events/blocking-event-handler-options.mdx +2 -2
  233. package/docs/reference/typescript-api/events/event-bus.mdx +4 -4
  234. package/docs/reference/typescript-api/events/event-types.mdx +30 -30
  235. package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +5 -5
  236. package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
  237. package/docs/reference/typescript-api/import-export/asset-import-strategy.mdx +1 -1
  238. package/docs/reference/typescript-api/import-export/asset-importer.mdx +1 -1
  239. package/docs/reference/typescript-api/import-export/fast-importer-service.mdx +4 -4
  240. package/docs/reference/typescript-api/import-export/import-parser.mdx +5 -5
  241. package/docs/reference/typescript-api/import-export/importer.mdx +3 -3
  242. package/docs/reference/typescript-api/import-export/initial-data.mdx +3 -3
  243. package/docs/reference/typescript-api/import-export/populate.mdx +1 -1
  244. package/docs/reference/typescript-api/job-queue/default-job-queue-plugin.mdx +5 -5
  245. package/docs/reference/typescript-api/job-queue/in-memory-job-buffer-storage-strategy.mdx +3 -3
  246. package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +8 -8
  247. package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
  248. package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +5 -5
  249. package/docs/reference/typescript-api/job-queue/job-buffer-storage-strategy.mdx +3 -3
  250. package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
  251. package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +6 -6
  252. package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
  253. package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
  254. package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +8 -8
  255. package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +6 -6
  256. package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +3 -3
  257. package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
  258. package/docs/reference/typescript-api/migration/generate-migration.mdx +1 -1
  259. package/docs/reference/typescript-api/migration/revert-last-migration.mdx +1 -1
  260. package/docs/reference/typescript-api/migration/run-migrations.mdx +1 -1
  261. package/docs/reference/typescript-api/orders/active-order-service.mdx +6 -6
  262. package/docs/reference/typescript-api/orders/active-order-strategy.mdx +3 -3
  263. package/docs/reference/typescript-api/orders/changed-price-handling-strategy.mdx +1 -1
  264. package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
  265. package/docs/reference/typescript-api/orders/default-order-item-price-calculation-strategy.mdx +1 -1
  266. package/docs/reference/typescript-api/orders/default-stock-allocation-strategy.mdx +1 -1
  267. package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
  268. package/docs/reference/typescript-api/orders/order-by-code-access-strategy.mdx +1 -1
  269. package/docs/reference/typescript-api/orders/order-code-strategy.mdx +1 -1
  270. package/docs/reference/typescript-api/orders/order-interceptor.mdx +3 -3
  271. package/docs/reference/typescript-api/orders/order-item-price-calculation-strategy.mdx +1 -1
  272. package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
  273. package/docs/reference/typescript-api/orders/order-placed-strategy.mdx +1 -1
  274. package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
  275. package/docs/reference/typescript-api/orders/order-seller-strategy.mdx +3 -3
  276. package/docs/reference/typescript-api/orders/stock-allocation-strategy.mdx +1 -1
  277. package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +6 -6
  278. package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +4 -4
  279. package/docs/reference/typescript-api/payment/payment-method-handler.mdx +2 -2
  280. package/docs/reference/typescript-api/payment/payment-method-types.mdx +3 -3
  281. package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
  282. package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
  283. package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
  284. package/docs/reference/typescript-api/plugin/vendure-plugin-metadata.mdx +4 -4
  285. package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
  286. package/docs/reference/typescript-api/products-stock/default-product-variant-price-calculation-strategy.mdx +1 -1
  287. package/docs/reference/typescript-api/products-stock/default-stock-location-strategy.mdx +1 -1
  288. package/docs/reference/typescript-api/products-stock/multi-channel-stock-location-strategy.mdx +2 -2
  289. package/docs/reference/typescript-api/products-stock/product-variant-price-calculation-strategy.mdx +1 -1
  290. package/docs/reference/typescript-api/products-stock/stock-display-strategy.mdx +1 -1
  291. package/docs/reference/typescript-api/products-stock/stock-location-strategy.mdx +5 -5
  292. package/docs/reference/typescript-api/promotions/facet-value-checker.mdx +1 -1
  293. package/docs/reference/typescript-api/promotions/promotion-action.mdx +22 -22
  294. package/docs/reference/typescript-api/promotions/promotion-condition.mdx +5 -5
  295. package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
  296. package/docs/reference/typescript-api/request/request-context-service.mdx +2 -2
  297. package/docs/reference/typescript-api/scheduled-tasks/default-scheduler-strategy.mdx +4 -4
  298. package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +4 -4
  299. package/docs/reference/typescript-api/scheduled-tasks/scheduler-service.mdx +3 -3
  300. package/docs/reference/typescript-api/scheduled-tasks/scheduler-strategy.mdx +5 -5
  301. package/docs/reference/typescript-api/service-helpers/entity-duplicator-service.mdx +1 -1
  302. package/docs/reference/typescript-api/service-helpers/order-calculator.mdx +1 -1
  303. package/docs/reference/typescript-api/service-helpers/order-modifier.mdx +3 -3
  304. package/docs/reference/typescript-api/service-helpers/product-price-applicator.mdx +1 -1
  305. package/docs/reference/typescript-api/service-helpers/slug-validator.mdx +2 -2
  306. package/docs/reference/typescript-api/service-helpers/translatable-saver.mdx +2 -2
  307. package/docs/reference/typescript-api/service-helpers/translator-service.mdx +1 -1
  308. package/docs/reference/typescript-api/services/administrator-service.mdx +6 -6
  309. package/docs/reference/typescript-api/services/asset-service.mdx +13 -13
  310. package/docs/reference/typescript-api/services/auth-service.mdx +4 -4
  311. package/docs/reference/typescript-api/services/channel-service.mdx +12 -12
  312. package/docs/reference/typescript-api/services/collection-service.mdx +20 -20
  313. package/docs/reference/typescript-api/services/country-service.mdx +7 -7
  314. package/docs/reference/typescript-api/services/customer-group-service.mdx +8 -8
  315. package/docs/reference/typescript-api/services/customer-service.mdx +24 -24
  316. package/docs/reference/typescript-api/services/entity-slug-service.mdx +1 -1
  317. package/docs/reference/typescript-api/services/facet-service.mdx +11 -11
  318. package/docs/reference/typescript-api/services/facet-value-service.mdx +12 -12
  319. package/docs/reference/typescript-api/services/fulfillment-service.mdx +4 -4
  320. package/docs/reference/typescript-api/services/global-settings-service.mdx +2 -2
  321. package/docs/reference/typescript-api/services/history-service.mdx +8 -8
  322. package/docs/reference/typescript-api/services/order-service.mdx +52 -52
  323. package/docs/reference/typescript-api/services/order-testing-service.mdx +2 -2
  324. package/docs/reference/typescript-api/services/payment-method-service.mdx +10 -10
  325. package/docs/reference/typescript-api/services/payment-service.mdx +7 -7
  326. package/docs/reference/typescript-api/services/product-option-group-service.mdx +5 -5
  327. package/docs/reference/typescript-api/services/product-option-service.mdx +5 -5
  328. package/docs/reference/typescript-api/services/product-service.mdx +13 -13
  329. package/docs/reference/typescript-api/services/product-variant-service.mdx +22 -22
  330. package/docs/reference/typescript-api/services/promotion-service.mdx +9 -9
  331. package/docs/reference/typescript-api/services/province-service.mdx +5 -5
  332. package/docs/reference/typescript-api/services/role-service.mdx +11 -11
  333. package/docs/reference/typescript-api/services/search-service.mdx +2 -2
  334. package/docs/reference/typescript-api/services/seller-service.mdx +3 -3
  335. package/docs/reference/typescript-api/services/session-service.mdx +8 -8
  336. package/docs/reference/typescript-api/services/settings-store-service.mdx +15 -15
  337. package/docs/reference/typescript-api/services/shipping-method-service.mdx +8 -8
  338. package/docs/reference/typescript-api/services/slug-service.mdx +1 -1
  339. package/docs/reference/typescript-api/services/stock-level-service.mdx +3 -3
  340. package/docs/reference/typescript-api/services/stock-location-service.mdx +7 -7
  341. package/docs/reference/typescript-api/services/stock-movement-service.mdx +7 -7
  342. package/docs/reference/typescript-api/services/tag-service.mdx +5 -5
  343. package/docs/reference/typescript-api/services/tax-category-service.mdx +5 -5
  344. package/docs/reference/typescript-api/services/tax-rate-service.mdx +6 -6
  345. package/docs/reference/typescript-api/services/user-service.mdx +12 -12
  346. package/docs/reference/typescript-api/services/zone-service.mdx +8 -8
  347. package/docs/reference/typescript-api/settings-store/settings-store-field-config.mdx +2 -2
  348. package/docs/reference/typescript-api/shipping/default-shipping-line-assignment-strategy.mdx +1 -1
  349. package/docs/reference/typescript-api/shipping/shipping-calculator.mdx +3 -3
  350. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +3 -3
  351. package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +2 -2
  352. package/docs/reference/typescript-api/shipping/shipping-line-assignment-strategy.mdx +1 -1
  353. package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
  354. package/docs/reference/typescript-api/state-machine/fsm.mdx +2 -2
  355. package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
  356. package/docs/reference/typescript-api/tax/tax-line-calculation-strategy.mdx +1 -1
  357. package/docs/reference/typescript-api/tax/tax-zone-strategy.mdx +1 -1
  358. package/docs/reference/typescript-api/telemetry/wrapped-method-args.mdx +2 -2
  359. package/docs/reference/typescript-api/testing/create-error-result-guard.mdx +1 -1
  360. package/docs/reference/typescript-api/testing/create-test-environment.mdx +1 -1
  361. package/docs/reference/typescript-api/testing/error-result-guard.mdx +1 -1
  362. package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
  363. package/docs/reference/typescript-api/testing/simple-graph-qlclient.mdx +5 -5
  364. package/docs/reference/typescript-api/testing/test-db-initializer.mdx +3 -3
  365. package/docs/reference/typescript-api/testing/test-server.mdx +2 -2
  366. package/docs/reference/typescript-api/testing/testing-logger.mdx +1 -1
  367. package/docs/reference/typescript-api/worker/bootstrap-worker.mdx +2 -2
  368. package/docs/reference/typescript-api/worker/vendure-worker.mdx +2 -2
  369. package/package.json +1 -1
  370. package/docs/reference/admin-ui-api/index.mdx +0 -4
  371. package/docs/reference/dashboard/index.mdx +0 -4
  372. package/docs/reference/graphql-api/admin/_index.mdx +0 -4
  373. package/docs/reference/graphql-api/shop/_index.mdx +0 -4
  374. package/docs/reference/typescript-api/_index.mdx +0 -4
@@ -95,68 +95,68 @@ based on the default order process plus all configured <a href='/reference/types
95
95
  defined in the <a href='/reference/typescript-api/orders/order-options#orderoptions'>OrderOptions</a> `process` array.
96
96
  ### findAll
97
97
 
98
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: OrderListOptions, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
98
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: OrderListOptions, relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
99
99
 
100
100
 
101
101
  ### findOne
102
102
 
103
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined&#62;`} />
103
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`} />
104
104
 
105
105
 
106
106
  ### findOneByCode
107
107
 
108
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderCode: string, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined&#62;`} />
108
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderCode: string, relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`} />
109
109
 
110
110
 
111
111
  ### findOneByOrderLineId
112
112
 
113
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLineId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined&#62;`} />
113
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderLineId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`} />
114
114
 
115
115
 
116
116
  ### findByCustomerId
117
117
 
118
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, customerId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: ListQueryOptions&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
118
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, customerId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/order#order'>Order</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
119
119
 
120
120
 
121
121
  ### getOrderPayments
122
122
 
123
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/payment#payment'>Payment</a>[]&#62;`} />
123
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/payment#payment'>Payment</a>[]>`} />
124
124
 
125
125
  Returns all <a href='/reference/typescript-api/entities/payment#payment'>Payment</a> entities associated with the Order.
126
126
  ### getOrderModifications
127
127
 
128
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a>[]&#62;`} />
128
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a>[]>`} />
129
129
 
130
130
  Returns an array of any <a href='/reference/typescript-api/entities/order-modification#ordermodification'>OrderModification</a> entities associated with the Order.
131
131
  ### getPaymentRefunds
132
132
 
133
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/refund#refund'>Refund</a>[]&#62;`} />
133
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/refund#refund'>Refund</a>[]>`} />
134
134
 
135
135
  Returns any <a href='/reference/typescript-api/entities/refund#refund'>Refund</a>s associated with a <a href='/reference/typescript-api/entities/payment#payment'>Payment</a>.
136
136
  ### getSellerOrders
137
137
 
138
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>[]&#62;`} />
138
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>[]>`} />
139
139
 
140
140
 
141
141
  ### getAggregateOrder
142
142
 
143
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined&#62;`} />
143
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`} />
144
144
 
145
145
 
146
146
  ### getOrderChannels
147
147
 
148
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise&#60;<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>[]&#62;`} />
148
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/entities/channel#channel'>Channel</a>[]>`} />
149
149
 
150
150
 
151
151
  ### getActiveOrderForUser
152
152
 
153
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined&#62;`} />
153
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`} />
154
154
 
155
155
  Returns any Order associated with the specified User's Customer account
156
156
  that is still in the `active` state.
157
157
  ### create
158
158
 
159
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId?: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;`} />
159
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, userId?: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
160
160
 
161
161
  Creates a new, empty Order. If a `userId` is passed, the Order will get associated with that
162
162
  User's Customer account.
@@ -178,7 +178,7 @@ Updates the Customer which is assigned to a given Order. The target Customer mus
178
178
  Channels as the Order, otherwise an error will be thrown.
179
179
  ### addItemToOrder
180
180
 
181
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, quantity: number, customFields?: { [key: string]: any }, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;UpdateOrderItemsResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
181
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, quantity: number, customFields?: { [key: string]: any }, relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><UpdateOrderItemsResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
182
182
 
183
183
  Adds an item to the Order, either creating a new OrderLine or
184
184
  incrementing an existing one.
@@ -186,7 +186,7 @@ incrementing an existing one.
186
186
  If you need to add multiple items to an Order, use `addItemsToOrder()` instead.
187
187
  ### addItemsToOrder
188
188
 
189
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, items: Array&#60;{ productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>; quantity: number; customFields?: { [key: string]: any }; }&#62;, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;) => Promise&#60;{ order: <a href='/reference/typescript-api/entities/order#order'>Order</a>; errorResults: Array&#60;JustErrorResults&#60;UpdateOrderItemsResult&#62;&#62; }&#62;`} since="3.1.0" />
189
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, items: Array<{ productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>; quantity: number; customFields?: { [key: string]: any }; }>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<{ order: <a href='/reference/typescript-api/entities/order#order'>Order</a>; errorResults: Array<JustErrorResults<UpdateOrderItemsResult>> }>`} since="3.1.0" />
190
190
 
191
191
  Adds multiple items to an Order. This method is more efficient than calling `addItemToOrder`
192
192
  multiple times, as it only needs to fetch the entire Order once, and only performs
@@ -196,14 +196,14 @@ Since this method can return multiple error results, it is recommended to check
196
196
  array to determine if any errors occurred.
197
197
  ### adjustOrderLine
198
198
 
199
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, orderLineId: <a href='/reference/typescript-api/common/id#id'>ID</a>, quantity: number, customFields?: { [key: string]: any }, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;UpdateOrderItemsResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
199
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, orderLineId: <a href='/reference/typescript-api/common/id#id'>ID</a>, quantity: number, customFields?: { [key: string]: any }, relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><UpdateOrderItemsResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
200
200
 
201
201
  Adjusts the quantity and/or custom field values of an existing OrderLine.
202
202
 
203
203
  If you need to adjust multiple OrderLines, use `adjustOrderLines()` instead.
204
204
  ### adjustOrderLines
205
205
 
206
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, lines: Array&#60;{ orderLineId: <a href='/reference/typescript-api/common/id#id'>ID</a>; quantity: number; customFields?: { [key: string]: any } }&#62;, relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;) => Promise&#60;{ order: <a href='/reference/typescript-api/entities/order#order'>Order</a>; errorResults: Array&#60;JustErrorResults&#60;UpdateOrderItemsResult&#62;&#62; }&#62;`} since="3.1.0" />
206
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, lines: Array<{ orderLineId: <a href='/reference/typescript-api/common/id#id'>ID</a>; quantity: number; customFields?: { [key: string]: any } }>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<{ order: <a href='/reference/typescript-api/entities/order#order'>Order</a>; errorResults: Array<JustErrorResults<UpdateOrderItemsResult>> }>`} since="3.1.0" />
207
207
 
208
208
  Adjusts the quantity and/or custom field values of existing OrderLines.
209
209
  This method is more efficient than calling `adjustOrderLine` multiple times, as it only needs to fetch
@@ -212,36 +212,36 @@ Since this method can return multiple error results, it is recommended to check
212
212
  array to determine if any errors occurred.
213
213
  ### removeItemFromOrder
214
214
 
215
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, orderLineId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;RemoveOrderItemsResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
215
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, orderLineId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><RemoveOrderItemsResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
216
216
 
217
217
  Removes the specified OrderLine from the Order.
218
218
 
219
219
  If you need to remove multiple OrderLines, use `removeItemsFromOrder()` instead.
220
220
  ### removeItemsFromOrder
221
221
 
222
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, orderLineIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;RemoveOrderItemsResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} since="3.1.0" />
222
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, orderLineIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><RemoveOrderItemsResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} since="3.1.0" />
223
223
 
224
224
  Removes the specified OrderLines from the Order.
225
225
  This method is more efficient than calling `removeItemFromOrder` multiple times, as it only needs to fetch
226
226
  the entire Order once, and only performs price adjustments once at the end.
227
227
  ### removeAllItemsFromOrder
228
228
 
229
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;RemoveOrderItemsResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
229
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><RemoveOrderItemsResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
230
230
 
231
231
  Removes all OrderLines from the Order.
232
232
  ### addSurchargeToOrder
233
233
 
234
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, surchargeInput: Partial&#60;Omit&#60;<a href='/reference/typescript-api/entities/surcharge#surcharge'>Surcharge</a>, 'id' | 'createdAt' | 'updatedAt' | 'order'&#62;&#62;) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;`} />
234
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, surchargeInput: Partial<Omit<<a href='/reference/typescript-api/entities/surcharge#surcharge'>Surcharge</a>, 'id' | 'createdAt' | 'updatedAt' | 'order'>>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
235
235
 
236
236
  Adds a <a href='/reference/typescript-api/entities/surcharge#surcharge'>Surcharge</a> to the Order.
237
237
  ### removeSurchargeFromOrder
238
238
 
239
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, surchargeId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;`} />
239
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, surchargeId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
240
240
 
241
241
  Removes a <a href='/reference/typescript-api/entities/surcharge#surcharge'>Surcharge</a> from the Order.
242
242
  ### applyCouponCode
243
243
 
244
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, couponCode: string) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;ApplyCouponCodeResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
244
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, couponCode: string) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><ApplyCouponCodeResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
245
245
 
246
246
  Applies a coupon code to the Order, which should be a valid coupon code as specified in the configuration
247
247
  of an active <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>.
@@ -252,7 +252,7 @@ of an active <a href='/reference/typescript-api/entities/promotion#promotion'>Pr
252
252
  Removes a coupon code from the Order.
253
253
  ### getOrderPromotions
254
254
 
255
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>[]&#62;`} />
255
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>[]>`} />
256
256
 
257
257
  Returns all <a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>s associated with an Order.
258
258
  ### getNextOrderStates
@@ -262,27 +262,27 @@ Returns all <a href='/reference/typescript-api/entities/promotion#promotion'>Pro
262
262
  Returns the next possible states that the Order may transition to.
263
263
  ### setShippingAddress
264
264
 
265
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, input: CreateAddressInput) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;`} />
265
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, input: CreateAddressInput) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
266
266
 
267
267
  Sets the shipping address for the Order.
268
268
  ### setBillingAddress
269
269
 
270
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, input: CreateAddressInput) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;`} />
270
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, input: CreateAddressInput) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
271
271
 
272
272
  Sets the billing address for the Order.
273
273
  ### unsetShippingAddress
274
274
 
275
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;`} since="3.1.0" />
275
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} since="3.1.0" />
276
276
 
277
277
  Unsets the shipping address for the Order.
278
278
  ### unsetBillingAddress
279
279
 
280
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;`} since="3.1.0" />
280
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} since="3.1.0" />
281
281
 
282
282
  Unsets the billing address for the Order.
283
283
  ### getEligibleShippingMethods
284
284
 
285
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;ShippingMethodQuote[]&#62;`} />
285
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<ShippingMethodQuote[]>`} />
286
286
 
287
287
  Returns an array of quotes stating which <a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>s may be applied to this Order.
288
288
  This is determined by the configured <a href='/reference/typescript-api/shipping/shipping-eligibility-checker#shippingeligibilitychecker'>ShippingEligibilityChecker</a> of each ShippingMethod.
@@ -291,33 +291,33 @@ The quote also includes a price for each method, as determined by the configured
291
291
  <a href='/reference/typescript-api/shipping/shipping-calculator#shippingcalculator'>ShippingCalculator</a> of each eligible ShippingMethod.
292
292
  ### getEligiblePaymentMethods
293
293
 
294
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;PaymentMethodQuote[]&#62;`} />
294
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<PaymentMethodQuote[]>`} />
295
295
 
296
296
  Returns an array of quotes stating which <a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>s may be used on this Order.
297
297
  ### setShippingMethod
298
298
 
299
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, shippingMethodIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;SetOrderShippingMethodResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
299
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, shippingMethodIds: <a href='/reference/typescript-api/common/id#id'>ID</a>[]) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><SetOrderShippingMethodResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
300
300
 
301
301
  Sets the ShippingMethod to be used on this Order.
302
302
  ### transitionToState
303
303
 
304
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, state: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a> | OrderStateTransitionError&#62;`} />
304
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, state: <a href='/reference/typescript-api/orders/order-process#orderstate'>OrderState</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | OrderStateTransitionError>`} />
305
305
 
306
306
  Transitions the Order to the given state.
307
307
  ### transitionFulfillmentToState
308
308
 
309
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fulfillmentId: <a href='/reference/typescript-api/common/id#id'>ID</a>, state: <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>) => Promise&#60;<a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a> | FulfillmentStateTransitionError&#62;`} />
309
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, fulfillmentId: <a href='/reference/typescript-api/common/id#id'>ID</a>, state: <a href='/reference/typescript-api/fulfillment/fulfillment-state#fulfillmentstate'>FulfillmentState</a>) => Promise<<a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a> | FulfillmentStateTransitionError>`} />
310
310
 
311
311
  Transitions a Fulfillment to the given state and then transitions the Order state based on
312
312
  whether all Fulfillments of the Order are shipped or delivered.
313
313
  ### transitionRefundToState
314
314
 
315
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, refundId: <a href='/reference/typescript-api/common/id#id'>ID</a>, state: <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, transactionId?: string) => Promise&#60;<a href='/reference/typescript-api/entities/refund#refund'>Refund</a> | RefundStateTransitionError&#62;`} />
315
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, refundId: <a href='/reference/typescript-api/common/id#id'>ID</a>, state: <a href='/reference/typescript-api/payment/refund-state#refundstate'>RefundState</a>, transactionId?: string) => Promise<<a href='/reference/typescript-api/entities/refund#refund'>Refund</a> | RefundStateTransitionError>`} />
316
316
 
317
317
  Transitions a Refund to the given state
318
318
  ### modifyOrder
319
319
 
320
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: ModifyOrderInput) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;ModifyOrderResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
320
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: ModifyOrderInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><ModifyOrderResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
321
321
 
322
322
  Allows the Order to be modified, which allows several aspects of the Order to be changed:
323
323
 
@@ -332,18 +332,18 @@ Order, except history entry and additional payment actions.
332
332
  __Using dryRun option, you must wrap function call in transaction manually.__
333
333
  ### transitionPaymentToState
334
334
 
335
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>, state: <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;TransitionPaymentToStateResult, <a href='/reference/typescript-api/entities/payment#payment'>Payment</a>&#62;&#62;`} />
335
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>, state: <a href='/reference/typescript-api/payment/payment-state#paymentstate'>PaymentState</a>) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><TransitionPaymentToStateResult, <a href='/reference/typescript-api/entities/payment#payment'>Payment</a>>>`} />
336
336
 
337
337
  Transitions the given <a href='/reference/typescript-api/entities/payment#payment'>Payment</a> to a new state.
338
338
  ### addPaymentToOrder
339
339
 
340
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, input: PaymentInput) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;AddPaymentToOrderResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
340
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>, input: PaymentInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><AddPaymentToOrderResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
341
341
 
342
342
  Adds a new Payment to the Order. If the Order totalWithTax is covered by Payments, then the Order
343
343
  state will get automatically transitioned to the `PaymentSettled` or `PaymentAuthorized` state.
344
344
  ### addManualPaymentToOrder
345
345
 
346
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: ManualPaymentInput) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;AddManualPaymentToOrderResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
346
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: ManualPaymentInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><AddManualPaymentToOrderResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
347
347
 
348
348
  This method is used after modifying an existing completed order using the `modifyOrder()` method. If the modifications
349
349
  cause the order total to increase (such as when adding a new OrderLine), then there will be an outstanding charge to
@@ -353,66 +353,66 @@ This method allows you to add a new Payment and assumes the actual processing ha
353
353
  dashboard of your payment provider.
354
354
  ### settlePayment
355
355
 
356
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;<a href='/reference/typescript-api/payment/payment-method-types#settlepaymentresult'>SettlePaymentResult</a>, <a href='/reference/typescript-api/entities/payment#payment'>Payment</a>&#62;&#62;`} />
356
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><<a href='/reference/typescript-api/payment/payment-method-types#settlepaymentresult'>SettlePaymentResult</a>, <a href='/reference/typescript-api/entities/payment#payment'>Payment</a>>>`} />
357
357
 
358
358
  Settles a payment by invoking the <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a>'s `settlePayment()` method. Automatically
359
359
  transitions the Order state if all Payments are settled.
360
360
  ### cancelPayment
361
361
 
362
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;<a href='/reference/typescript-api/payment/payment-method-types#cancelpaymentresult'>CancelPaymentResult</a>, <a href='/reference/typescript-api/entities/payment#payment'>Payment</a>&#62;&#62;`} />
362
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><<a href='/reference/typescript-api/payment/payment-method-types#cancelpaymentresult'>CancelPaymentResult</a>, <a href='/reference/typescript-api/entities/payment#payment'>Payment</a>>>`} />
363
363
 
364
364
  Cancels a payment by invoking the <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a>'s `cancelPayment()` method (if defined), and transitions the Payment to
365
365
  the `Cancelled` state.
366
366
  ### createFulfillment
367
367
 
368
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: FulfillOrderInput) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;AddFulfillmentToOrderResult, <a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>&#62;&#62;`} />
368
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: FulfillOrderInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><AddFulfillmentToOrderResult, <a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>>>`} />
369
369
 
370
370
  Creates a new Fulfillment associated with the given Order and OrderItems.
371
371
  ### getOrderFulfillments
372
372
 
373
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise&#60;<a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>[]&#62;`} />
373
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/entities/fulfillment#fulfillment'>Fulfillment</a>[]>`} />
374
374
 
375
375
  Returns an array of all Fulfillments associated with the Order.
376
376
  ### getOrderSurcharges
377
377
 
378
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;<a href='/reference/typescript-api/entities/surcharge#surcharge'>Surcharge</a>[]&#62;`} />
378
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderId: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<<a href='/reference/typescript-api/entities/surcharge#surcharge'>Surcharge</a>[]>`} />
379
379
 
380
380
  Returns an array of all Surcharges associated with the Order.
381
381
  ### cancelOrder
382
382
 
383
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CancelOrderInput) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;CancelOrderResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;&#62;`} />
383
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CancelOrderInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><CancelOrderResult, <a href='/reference/typescript-api/entities/order#order'>Order</a>>>`} />
384
384
 
385
385
  Cancels an Order by transitioning it to the `Cancelled` state. If stock is being tracked for the ProductVariants
386
386
  in the Order, then new <a href='/reference/typescript-api/entities/stock-movement#stockmovement'>StockMovement</a>s will be created to correct the stock levels.
387
387
  ### refundOrder
388
388
 
389
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RefundOrderInput) => Promise&#60;<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>&#60;RefundOrderResult, <a href='/reference/typescript-api/entities/refund#refund'>Refund</a>&#62;&#62;`} />
389
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RefundOrderInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a><RefundOrderResult, <a href='/reference/typescript-api/entities/refund#refund'>Refund</a>>>`} />
390
390
 
391
391
  Creates a <a href='/reference/typescript-api/entities/refund#refund'>Refund</a> against the order and in doing so invokes the `createRefund()` method of the
392
392
  <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a>.
393
393
  ### settleRefund
394
394
 
395
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SettleRefundInput) => Promise&#60;<a href='/reference/typescript-api/entities/refund#refund'>Refund</a>&#62;`} />
395
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: SettleRefundInput) => Promise<<a href='/reference/typescript-api/entities/refund#refund'>Refund</a>>`} />
396
396
 
397
397
  Settles a Refund by transitioning it to the `Settled` state.
398
398
  ### addCustomerToOrder
399
399
 
400
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderIdOrOrder: <a href='/reference/typescript-api/common/id#id'>ID</a> | <a href='/reference/typescript-api/entities/order#order'>Order</a>, customer: <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;`} />
400
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, orderIdOrOrder: <a href='/reference/typescript-api/common/id#id'>ID</a> | <a href='/reference/typescript-api/entities/order#order'>Order</a>, customer: <a href='/reference/typescript-api/entities/customer#customer'>Customer</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
401
401
 
402
402
  Associates a Customer with the Order.
403
403
  ### addNoteToOrder
404
404
 
405
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AddNoteToOrderInput) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;`} />
405
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AddNoteToOrderInput) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
406
406
 
407
407
  Creates a new "ORDER_NOTE" type <a href='/reference/typescript-api/entities/order-history-entry#orderhistoryentry'>OrderHistoryEntry</a> in the Order's history timeline.
408
408
  ### updateOrderNote
409
409
 
410
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateOrderNoteInput) => Promise&#60;<a href='/reference/typescript-api/entities/history-entry#historyentry'>HistoryEntry</a>&#62;`} />
410
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdateOrderNoteInput) => Promise<<a href='/reference/typescript-api/entities/history-entry#historyentry'>HistoryEntry</a>>`} />
411
411
 
412
412
 
413
413
  ### deleteOrderNote
414
414
 
415
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise&#60;DeletionResponse&#62;`} />
415
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, id: <a href='/reference/typescript-api/common/id#id'>ID</a>) => Promise<DeletionResponse>`} />
416
416
 
417
417
 
418
418
  ### deleteOrder
@@ -422,7 +422,7 @@ Creates a new "ORDER_NOTE" type <a href='/reference/typescript-api/entities/orde
422
422
  Deletes an Order, ensuring that any Sessions that reference this Order are dereferenced before deletion.
423
423
  ### mergeOrders
424
424
 
425
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>, guestOrder?: <a href='/reference/typescript-api/entities/order#order'>Order</a>, existingOrder?: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined&#62;`} />
425
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, user: <a href='/reference/typescript-api/entities/user#user'>User</a>, guestOrder?: <a href='/reference/typescript-api/entities/order#order'>Order</a>, existingOrder?: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a> | undefined>`} />
426
426
 
427
427
  When a guest user with an anonymous Order signs in and has an existing Order associated with that Customer,
428
428
  we need to reconcile the contents of the two orders.
@@ -430,7 +430,7 @@ we need to reconcile the contents of the two orders.
430
430
  The logic used to do the merging is specified in the <a href='/reference/typescript-api/orders/order-options#orderoptions'>OrderOptions</a> `mergeStrategy` config setting.
431
431
  ### applyPriceAdjustments
432
432
 
433
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, updatedOrderLines?: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[], relations?: RelationPaths&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;) => Promise&#60;<a href='/reference/typescript-api/entities/order#order'>Order</a>&#62;`} />
433
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>, updatedOrderLines?: <a href='/reference/typescript-api/entities/order-line#orderline'>OrderLine</a>[], relations?: RelationPaths<<a href='/reference/typescript-api/entities/order#order'>Order</a>>) => Promise<<a href='/reference/typescript-api/entities/order#order'>Order</a>>`} />
434
434
 
435
435
  Applies promotions, taxes and shipping to the Order. If the `updatedOrderLines` argument is passed in,
436
436
  then all of those OrderLines will have their prices re-calculated using the configured <a href='/reference/typescript-api/orders/order-item-price-calculation-strategy#orderitempricecalculationstrategy'>OrderItemPriceCalculationStrategy</a>.
@@ -28,13 +28,13 @@ class OrderTestingService {
28
28
 
29
29
  ### testShippingMethod
30
30
 
31
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: TestShippingMethodInput) => Promise&#60;TestShippingMethodResult&#62;`} />
31
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: TestShippingMethodInput) => Promise<TestShippingMethodResult>`} />
32
32
 
33
33
  Runs a given ShippingMethod configuration against a mock Order to test for eligibility and resulting
34
34
  price.
35
35
  ### testEligibleShippingMethods
36
36
 
37
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: TestEligibleShippingMethodsInput) => Promise&#60;ShippingMethodQuote[]&#62;`} />
37
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: TestEligibleShippingMethodsInput) => Promise<ShippingMethodQuote[]>`} />
38
38
 
39
39
  Tests all available ShippingMethods against a mock Order and return those which are eligible. This
40
40
  is intended to simulate a call to the `eligibleShippingMethods` query of the Shop API.
@@ -41,37 +41,37 @@ class PaymentMethodService {
41
41
 
42
42
  ### findAll
43
43
 
44
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions&#60;<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>&#62;, relations: RelationPaths&#60;<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>&#62; = []) => Promise&#60;<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>&#60;<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>&#62;&#62;`} />
44
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a><<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>>>`} />
45
45
 
46
46
 
47
47
  ### findOne
48
48
 
49
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentMethodId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations: RelationPaths&#60;<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>&#62; = []) => Promise&#60;<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a> | undefined&#62;`} />
49
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentMethodId: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations: RelationPaths<<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>> = []) => Promise<<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a> | undefined>`} />
50
50
 
51
51
 
52
52
  ### create
53
53
 
54
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreatePaymentMethodInput) => Promise&#60;<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>&#62;`} />
54
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreatePaymentMethodInput) => Promise<<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>>`} />
55
55
 
56
56
 
57
57
  ### update
58
58
 
59
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdatePaymentMethodInput) => Promise&#60;<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>&#62;`} />
59
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdatePaymentMethodInput) => Promise<<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>>`} />
60
60
 
61
61
 
62
62
  ### delete
63
63
 
64
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentMethodId: <a href='/reference/typescript-api/common/id#id'>ID</a>, force: boolean = false) => Promise&#60;DeletionResponse&#62;`} />
64
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, paymentMethodId: <a href='/reference/typescript-api/common/id#id'>ID</a>, force: boolean = false) => Promise<DeletionResponse>`} />
65
65
 
66
66
 
67
67
  ### assignPaymentMethodsToChannel
68
68
 
69
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignPaymentMethodsToChannelInput) => Promise&#60;Array&#60;Translated&#60;<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>&#62;&#62;&#62;`} />
69
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: AssignPaymentMethodsToChannelInput) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>>>>`} />
70
70
 
71
71
 
72
72
  ### removePaymentMethodsFromChannel
73
73
 
74
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemovePaymentMethodsFromChannelInput) => Promise&#60;Array&#60;Translated&#60;<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>&#62;&#62;&#62;`} />
74
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: RemovePaymentMethodsFromChannelInput) => Promise<Array<Translated<<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>>>>`} />
75
75
 
76
76
 
77
77
  ### getPaymentMethodEligibilityCheckers
@@ -86,17 +86,17 @@ class PaymentMethodService {
86
86
 
87
87
  ### getEligiblePaymentMethods
88
88
 
89
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise&#60;PaymentMethodQuote[]&#62;`} />
89
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, order: <a href='/reference/typescript-api/entities/order#order'>Order</a>) => Promise<PaymentMethodQuote[]>`} />
90
90
 
91
91
 
92
92
  ### getMethodAndOperations
93
93
 
94
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, method: string) => Promise&#60;{ paymentMethod: <a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>; handler: <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a>; checker: <a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitychecker'>PaymentMethodEligibilityChecker</a> | null; }&#62;`} />
94
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, method: string) => Promise<{ paymentMethod: <a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>; handler: <a href='/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler'>PaymentMethodHandler</a>; checker: <a href='/reference/typescript-api/payment/payment-method-eligibility-checker#paymentmethodeligibilitychecker'>PaymentMethodEligibilityChecker</a> | null; }>`} />
95
95
 
96
96
 
97
97
  ### getActivePaymentMethods
98
98
 
99
- <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise&#60;<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>[]&#62;`} />
99
+ <MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<<a href='/reference/typescript-api/entities/payment-method#paymentmethod'>PaymentMethod</a>[]>`} />
100
100
 
101
101
 
102
102