@vendure/docs 0.0.0-202601211535 → 0.0.0-202601211551
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.
- package/docs/guides/extending-the-dashboard/migration/index.mdx +1 -1
- package/docs/reference/admin-ui-api/bulk-actions/bulk-action.mdx +3 -3
- package/docs/reference/admin-ui-api/components/asset-picker-dialog-component.mdx +1 -1
- package/docs/reference/admin-ui-api/directives/if-permissions-directive.mdx +1 -1
- package/docs/reference/admin-ui-api/list-detail-views/detail-component-with-resolver.mdx +1 -1
- package/docs/reference/admin-ui-api/react-extensions/register-react-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/routes/register-route-component.mdx +1 -1
- package/docs/reference/admin-ui-api/services/data-service.mdx +3 -3
- package/docs/reference/admin-ui-api/services/modal-service.mdx +2 -2
- package/docs/reference/admin-ui-api/ui-devkit/admin-ui-extension.mdx +1 -1
- package/docs/reference/core-plugins/elasticsearch-plugin/elasticsearch-options.mdx +2 -2
- package/docs/reference/core-plugins/email-plugin/email-event-handler-with-async-data.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-event-handler.mdx +13 -13
- package/docs/reference/core-plugins/email-plugin/email-event-listener.mdx +1 -1
- package/docs/reference/core-plugins/email-plugin/email-plugin-options.mdx +2 -2
- package/docs/reference/core-plugins/stellate-plugin/purge-rule.mdx +1 -1
- package/docs/reference/dashboard/detail-views/detail-page.mdx +1 -1
- package/docs/reference/dashboard/detail-views/use-detail-page.mdx +1 -1
- package/docs/reference/dashboard/detail-views/use-generated-form.mdx +1 -1
- package/docs/reference/dashboard/form-components/form-field-wrapper.mdx +1 -1
- package/docs/reference/dashboard/list-views/data-table.mdx +1 -1
- package/docs/reference/dashboard/list-views/list-page.mdx +1 -1
- package/docs/reference/dashboard/list-views/paginated-list-data-table.mdx +1 -1
- package/docs/reference/typescript-api/cache/self-refreshing-cache.mdx +1 -1
- package/docs/reference/typescript-api/configurable-operation-def/index.mdx +1 -1
- package/docs/reference/typescript-api/configuration/entity-duplicator.mdx +2 -2
- package/docs/reference/typescript-api/configuration/entity-options.mdx +2 -2
- package/docs/reference/typescript-api/configuration/runtime-vendure-config.mdx +1 -1
- package/docs/reference/typescript-api/configuration/vendure-config.mdx +1 -1
- package/docs/reference/typescript-api/data-access/entity-hydrator.mdx +1 -1
- package/docs/reference/typescript-api/data-access/hydrate-options.mdx +1 -1
- package/docs/reference/typescript-api/data-access/list-query-builder.mdx +1 -1
- package/docs/reference/typescript-api/data-access/transactional-connection.mdx +1 -1
- package/docs/reference/typescript-api/entities/promotion.mdx +1 -1
- package/docs/reference/typescript-api/events/event-bus.mdx +1 -1
- package/docs/reference/typescript-api/events/event-types.mdx +29 -29
- package/docs/reference/typescript-api/fulfillment/fulfillment-handler.mdx +3 -3
- package/docs/reference/typescript-api/fulfillment/fulfillment-process.mdx +4 -4
- package/docs/reference/typescript-api/import-export/import-parser.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/in-memory-job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/index.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/inspectable-job-queue-strategy.mdx +1 -1
- package/docs/reference/typescript-api/job-queue/job-buffer.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/job-queue-service.mdx +5 -5
- package/docs/reference/typescript-api/job-queue/job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/job.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/polling-job-queue-strategy.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/sql-job-queue-strategy.mdx +3 -3
- package/docs/reference/typescript-api/job-queue/subscribable-job.mdx +2 -2
- package/docs/reference/typescript-api/job-queue/types.mdx +1 -1
- package/docs/reference/typescript-api/orders/default-guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/guest-checkout-strategy.mdx +1 -1
- package/docs/reference/typescript-api/orders/order-options.mdx +2 -2
- package/docs/reference/typescript-api/orders/order-process.mdx +4 -4
- package/docs/reference/typescript-api/payment/payment-method-config-options.mdx +5 -5
- package/docs/reference/typescript-api/payment/payment-method-eligibility-checker.mdx +2 -2
- package/docs/reference/typescript-api/payment/payment-method-handler.mdx +1 -1
- package/docs/reference/typescript-api/payment/payment-options.mdx +3 -3
- package/docs/reference/typescript-api/payment/payment-process.mdx +4 -4
- package/docs/reference/typescript-api/payment/refund-process.mdx +4 -4
- package/docs/reference/typescript-api/products-stock/catalog-options.mdx +1 -1
- package/docs/reference/typescript-api/promotions/promotion-action.mdx +11 -11
- package/docs/reference/typescript-api/promotions/promotion-condition.mdx +2 -2
- package/docs/reference/typescript-api/promotions/promotion-options.mdx +2 -2
- package/docs/reference/typescript-api/scheduled-tasks/scheduled-task.mdx +3 -3
- package/docs/reference/typescript-api/services/administrator-service.mdx +1 -1
- package/docs/reference/typescript-api/services/asset-service.mdx +1 -1
- package/docs/reference/typescript-api/services/channel-service.mdx +3 -3
- package/docs/reference/typescript-api/services/collection-service.mdx +2 -2
- package/docs/reference/typescript-api/services/country-service.mdx +1 -1
- package/docs/reference/typescript-api/services/customer-group-service.mdx +2 -2
- package/docs/reference/typescript-api/services/customer-service.mdx +5 -5
- package/docs/reference/typescript-api/services/facet-service.mdx +2 -2
- package/docs/reference/typescript-api/services/facet-value-service.mdx +2 -2
- package/docs/reference/typescript-api/services/history-service.mdx +2 -2
- package/docs/reference/typescript-api/services/order-service.mdx +18 -18
- package/docs/reference/typescript-api/services/payment-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-option-service.mdx +1 -1
- package/docs/reference/typescript-api/services/product-service.mdx +2 -2
- package/docs/reference/typescript-api/services/product-variant-service.mdx +3 -3
- package/docs/reference/typescript-api/services/promotion-service.mdx +3 -3
- package/docs/reference/typescript-api/services/province-service.mdx +1 -1
- package/docs/reference/typescript-api/services/role-service.mdx +1 -1
- package/docs/reference/typescript-api/services/seller-service.mdx +1 -1
- package/docs/reference/typescript-api/services/settings-store-service.mdx +6 -6
- package/docs/reference/typescript-api/services/shipping-method-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-location-service.mdx +1 -1
- package/docs/reference/typescript-api/services/stock-movement-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tag-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-category-service.mdx +1 -1
- package/docs/reference/typescript-api/services/tax-rate-service.mdx +1 -1
- package/docs/reference/typescript-api/services/user-service.mdx +1 -1
- package/docs/reference/typescript-api/services/zone-service.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker-config.mdx +2 -2
- package/docs/reference/typescript-api/shipping/shipping-eligibility-checker.mdx +1 -1
- package/docs/reference/typescript-api/shipping/shipping-options.mdx +5 -5
- package/docs/reference/typescript-api/state-machine/fsm.mdx +1 -1
- package/docs/reference/typescript-api/state-machine/state-machine-config.mdx +4 -4
- package/docs/reference/typescript-api/testing/register-initializer.mdx +1 -1
- package/package.json +1 -1
|
@@ -48,7 +48,7 @@ class FacetValueService {
|
|
|
48
48
|
|
|
49
49
|
### findAllList
|
|
50
50
|
|
|
51
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
51
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>`FacetValue</a>>>>`} />
|
|
52
52
|
|
|
53
53
|
Returns a PaginatedList of FacetValues.
|
|
54
54
|
|
|
@@ -71,7 +71,7 @@ A separate method was created just to avoid a breaking change in v1.9.
|
|
|
71
71
|
Returns all FacetValues belonging to the Facet with the given id.
|
|
72
72
|
### findByFacetIdList
|
|
73
73
|
|
|
74
|
-
<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>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
74
|
+
<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>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>FacetValue</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<<a href='/reference/typescript-api/entities/facet-value#facetvalue'>`FacetValue</a>>>>`} />
|
|
75
75
|
|
|
76
76
|
Returns all FacetValues belonging to the Facet with the given id.
|
|
77
77
|
### create
|
|
@@ -124,7 +124,7 @@ class HistoryService {
|
|
|
124
124
|
|
|
125
125
|
### getHistoryForOrder
|
|
126
126
|
|
|
127
|
-
<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>, publicOnly: boolean, options?: HistoryEntryListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
127
|
+
<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>, publicOnly: boolean, options?: HistoryEntryListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/order-history-entry#orderhistoryentry'>`OrderHistoryEntry</a>>>`} />
|
|
128
128
|
|
|
129
129
|
|
|
130
130
|
### createHistoryEntryForOrder
|
|
@@ -134,7 +134,7 @@ class HistoryService {
|
|
|
134
134
|
|
|
135
135
|
### getHistoryForCustomer
|
|
136
136
|
|
|
137
|
-
<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>, publicOnly: boolean, options?: HistoryEntryListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
137
|
+
<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>, publicOnly: boolean, options?: HistoryEntryListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/customer-history-entry#customerhistoryentry'>`CustomerHistoryEntry</a>>>`} />
|
|
138
138
|
|
|
139
139
|
|
|
140
140
|
### createHistoryEntryForCustomer
|
|
@@ -91,7 +91,7 @@ based on the default order process plus all configured <DocsLink href="/referenc
|
|
|
91
91
|
defined in the <DocsLink href="/reference/typescript-api/orders/order-options#orderoptions">OrderOptions</DocsLink> `process` array.
|
|
92
92
|
### findAll
|
|
93
93
|
|
|
94
|
-
<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
|
|
94
|
+
<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>>>`} />
|
|
95
95
|
|
|
96
96
|
|
|
97
97
|
### findOne
|
|
@@ -111,7 +111,7 @@ defined in the <DocsLink href="/reference/typescript-api/orders/order-options#or
|
|
|
111
111
|
|
|
112
112
|
### findByCustomerId
|
|
113
113
|
|
|
114
|
-
<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
|
|
114
|
+
<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>>>`} />
|
|
115
115
|
|
|
116
116
|
|
|
117
117
|
### getOrderPayments
|
|
@@ -174,7 +174,7 @@ Updates the Customer which is assigned to a given Order. The target Customer mus
|
|
|
174
174
|
Channels as the Order, otherwise an error will be thrown.
|
|
175
175
|
### addItemToOrder
|
|
176
176
|
|
|
177
|
-
<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
|
|
177
|
+
<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>>>`} />
|
|
178
178
|
|
|
179
179
|
Adds an item to the Order, either creating a new OrderLine or
|
|
180
180
|
incrementing an existing one.
|
|
@@ -192,7 +192,7 @@ Since this method can return multiple error results, it is recommended to check
|
|
|
192
192
|
array to determine if any errors occurred.
|
|
193
193
|
### adjustOrderLine
|
|
194
194
|
|
|
195
|
-
<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
|
|
195
|
+
<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>>>`} />
|
|
196
196
|
|
|
197
197
|
Adjusts the quantity and/or custom field values of an existing OrderLine.
|
|
198
198
|
|
|
@@ -208,21 +208,21 @@ Since this method can return multiple error results, it is recommended to check
|
|
|
208
208
|
array to determine if any errors occurred.
|
|
209
209
|
### removeItemFromOrder
|
|
210
210
|
|
|
211
|
-
<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
|
|
211
|
+
<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>>>`} />
|
|
212
212
|
|
|
213
213
|
Removes the specified OrderLine from the Order.
|
|
214
214
|
|
|
215
215
|
If you need to remove multiple OrderLines, use `removeItemsFromOrder()` instead.
|
|
216
216
|
### removeItemsFromOrder
|
|
217
217
|
|
|
218
|
-
<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
|
|
218
|
+
<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" />
|
|
219
219
|
|
|
220
220
|
Removes the specified OrderLines from the Order.
|
|
221
221
|
This method is more efficient than calling `removeItemFromOrder` multiple times, as it only needs to fetch
|
|
222
222
|
the entire Order once, and only performs price adjustments once at the end.
|
|
223
223
|
### removeAllItemsFromOrder
|
|
224
224
|
|
|
225
|
-
<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
|
|
225
|
+
<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>>>`} />
|
|
226
226
|
|
|
227
227
|
Removes all OrderLines from the Order.
|
|
228
228
|
### addSurchargeToOrder
|
|
@@ -237,7 +237,7 @@ Adds a <DocsLink href="/reference/typescript-api/entities/surcharge#surcharge">S
|
|
|
237
237
|
Removes a <DocsLink href="/reference/typescript-api/entities/surcharge#surcharge">Surcharge</DocsLink> from the Order.
|
|
238
238
|
### applyCouponCode
|
|
239
239
|
|
|
240
|
-
<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
|
|
240
|
+
<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>>>`} />
|
|
241
241
|
|
|
242
242
|
Applies a coupon code to the Order, which should be a valid coupon code as specified in the configuration
|
|
243
243
|
of an active <DocsLink href="/reference/typescript-api/entities/promotion#promotion">Promotion</DocsLink>.
|
|
@@ -292,7 +292,7 @@ The quote also includes a price for each method, as determined by the configured
|
|
|
292
292
|
Returns an array of quotes stating which <DocsLink href="/reference/typescript-api/entities/payment-method#paymentmethod">PaymentMethod</DocsLink>s may be used on this Order.
|
|
293
293
|
### setShippingMethod
|
|
294
294
|
|
|
295
|
-
<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
|
|
295
|
+
<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>>>`} />
|
|
296
296
|
|
|
297
297
|
Sets the ShippingMethod to be used on this Order.
|
|
298
298
|
### transitionToState
|
|
@@ -313,7 +313,7 @@ whether all Fulfillments of the Order are shipped or delivered.
|
|
|
313
313
|
Transitions a Refund to the given state
|
|
314
314
|
### modifyOrder
|
|
315
315
|
|
|
316
|
-
<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
|
|
316
|
+
<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>>>`} />
|
|
317
317
|
|
|
318
318
|
Allows the Order to be modified, which allows several aspects of the Order to be changed:
|
|
319
319
|
|
|
@@ -328,18 +328,18 @@ Order, except history entry and additional payment actions.
|
|
|
328
328
|
__Using dryRun option, you must wrap function call in transaction manually.__
|
|
329
329
|
### transitionPaymentToState
|
|
330
330
|
|
|
331
|
-
<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
|
|
331
|
+
<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>>>`} />
|
|
332
332
|
|
|
333
333
|
Transitions the given <DocsLink href="/reference/typescript-api/entities/payment#payment">Payment</DocsLink> to a new state.
|
|
334
334
|
### addPaymentToOrder
|
|
335
335
|
|
|
336
|
-
<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
|
|
336
|
+
<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>>>`} />
|
|
337
337
|
|
|
338
338
|
Adds a new Payment to the Order. If the Order totalWithTax is covered by Payments, then the Order
|
|
339
339
|
state will get automatically transitioned to the `PaymentSettled` or `PaymentAuthorized` state.
|
|
340
340
|
### addManualPaymentToOrder
|
|
341
341
|
|
|
342
|
-
<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
|
|
342
|
+
<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>>>`} />
|
|
343
343
|
|
|
344
344
|
This method is used after modifying an existing completed order using the `modifyOrder()` method. If the modifications
|
|
345
345
|
cause the order total to increase (such as when adding a new OrderLine), then there will be an outstanding charge to
|
|
@@ -349,19 +349,19 @@ This method allows you to add a new Payment and assumes the actual processing ha
|
|
|
349
349
|
dashboard of your payment provider.
|
|
350
350
|
### settlePayment
|
|
351
351
|
|
|
352
|
-
<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
|
|
352
|
+
<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>>>`} />
|
|
353
353
|
|
|
354
354
|
Settles a payment by invoking the <DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink>'s `settlePayment()` method. Automatically
|
|
355
355
|
transitions the Order state if all Payments are settled.
|
|
356
356
|
### cancelPayment
|
|
357
357
|
|
|
358
|
-
<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
|
|
358
|
+
<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>>>`} />
|
|
359
359
|
|
|
360
360
|
Cancels a payment by invoking the <DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink>'s `cancelPayment()` method (if defined), and transitions the Payment to
|
|
361
361
|
the `Cancelled` state.
|
|
362
362
|
### createFulfillment
|
|
363
363
|
|
|
364
|
-
<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
|
|
364
|
+
<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>>>`} />
|
|
365
365
|
|
|
366
366
|
Creates a new Fulfillment associated with the given Order and OrderItems.
|
|
367
367
|
### getOrderFulfillments
|
|
@@ -376,13 +376,13 @@ Returns an array of all Fulfillments associated with the Order.
|
|
|
376
376
|
Returns an array of all Surcharges associated with the Order.
|
|
377
377
|
### cancelOrder
|
|
378
378
|
|
|
379
|
-
<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
|
|
379
|
+
<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>>>`} />
|
|
380
380
|
|
|
381
381
|
Cancels an Order by transitioning it to the `Cancelled` state. If stock is being tracked for the ProductVariants
|
|
382
382
|
in the Order, then new <DocsLink href="/reference/typescript-api/entities/stock-movement#stockmovement">StockMovement</DocsLink>s will be created to correct the stock levels.
|
|
383
383
|
### refundOrder
|
|
384
384
|
|
|
385
|
-
<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
|
|
385
|
+
<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>>>`} />
|
|
386
386
|
|
|
387
387
|
Creates a <DocsLink href="/reference/typescript-api/entities/refund#refund">Refund</DocsLink> against the order and in doing so invokes the `createRefund()` method of the
|
|
388
388
|
<DocsLink href="/reference/typescript-api/payment/payment-method-handler#paymentmethodhandler">PaymentMethodHandler</DocsLink>.
|
|
@@ -37,7 +37,7 @@ class PaymentMethodService {
|
|
|
37
37
|
|
|
38
38
|
### findAll
|
|
39
39
|
|
|
40
|
-
<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
|
|
40
|
+
<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>>>`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### findOne
|
|
@@ -26,7 +26,7 @@ class ProductOptionService {
|
|
|
26
26
|
|
|
27
27
|
### findAll
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>>, groupId?: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
29
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>>, groupId?: <a href='/reference/typescript-api/common/id#id'>ID</a>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/product-option#productoption'>ProductOption</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<<a href='/reference/typescript-api/entities/product-option#productoption'>`ProductOption</a>>>>`} />
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
### findOne
|
|
@@ -34,7 +34,7 @@ class ProductService {
|
|
|
34
34
|
|
|
35
35
|
### findAll
|
|
36
36
|
|
|
37
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/product#product'>Product</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/product#product'>Product</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
37
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/product#product'>Product</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/product#product'>Product</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<<a href='/reference/typescript-api/entities/product#product'>`Product</a>>>>`} />
|
|
38
38
|
|
|
39
39
|
|
|
40
40
|
### findOne
|
|
@@ -98,7 +98,7 @@ each of the Product's variants, and will assign the Product's Assets to the Chan
|
|
|
98
98
|
|
|
99
99
|
### removeOptionGroupFromProduct
|
|
100
100
|
|
|
101
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productId: <a href='/reference/typescript-api/common/id#id'>ID</a>, optionGroupId: <a href='/reference/typescript-api/common/id#id'>ID</a>, force?: boolean) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a
|
|
101
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productId: <a href='/reference/typescript-api/common/id#id'>ID</a>, optionGroupId: <a href='/reference/typescript-api/common/id#id'>ID</a>, force?: boolean) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<RemoveOptionGroupFromProductResult, Translated<<a href='/reference/typescript-api/entities/product#product'>`Product</a>>>>`} />
|
|
102
102
|
|
|
103
103
|
|
|
104
104
|
|
|
@@ -44,7 +44,7 @@ class ProductVariantService {
|
|
|
44
44
|
|
|
45
45
|
### findAll
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
47
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<<a href='/reference/typescript-api/entities/product-variant#productvariant'>`ProductVariant</a>>>>`} />
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### findOne
|
|
@@ -59,12 +59,12 @@ class ProductVariantService {
|
|
|
59
59
|
|
|
60
60
|
### getVariantsByProductId
|
|
61
61
|
|
|
62
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: ListQueryOptions<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>> = {}, relations?: RelationPaths<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
62
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: ListQueryOptions<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>> = {}, relations?: RelationPaths<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<<a href='/reference/typescript-api/entities/product-variant#productvariant'>`ProductVariant</a>>>>`} />
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
### getVariantsByCollectionId
|
|
66
66
|
|
|
67
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: ListQueryOptions<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
67
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, collectionId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options: ListQueryOptions<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/product-variant#productvariant'>ProductVariant</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<<a href='/reference/typescript-api/entities/product-variant#productvariant'>`ProductVariant</a>>>>`} />
|
|
68
68
|
|
|
69
69
|
Returns a <DocsLink href="/reference/typescript-api/common/paginated-list#paginatedlist">PaginatedList</DocsLink> of all ProductVariants associated with the given Collection.
|
|
70
70
|
### getProductVariantChannels
|
|
@@ -47,7 +47,7 @@ class PromotionService {
|
|
|
47
47
|
|
|
48
48
|
### findAll
|
|
49
49
|
|
|
50
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
50
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/promotion#promotion'>Promotion</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/promotion#promotion'>`Promotion</a>>>`} />
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
### findOne
|
|
@@ -67,12 +67,12 @@ class PromotionService {
|
|
|
67
67
|
|
|
68
68
|
### createPromotion
|
|
69
69
|
|
|
70
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreatePromotionInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a
|
|
70
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: CreatePromotionInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<CreatePromotionResult, <a href='/reference/typescript-api/entities/promotion#promotion'>`Promotion</a>>>`} />
|
|
71
71
|
|
|
72
72
|
|
|
73
73
|
### updatePromotion
|
|
74
74
|
|
|
75
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdatePromotionInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a
|
|
75
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, input: UpdatePromotionInput) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<UpdatePromotionResult, <a href='/reference/typescript-api/entities/promotion#promotion'>`Promotion</a>>>`} />
|
|
76
76
|
|
|
77
77
|
|
|
78
78
|
### softDeletePromotion
|
|
@@ -26,7 +26,7 @@ class ProvinceService {
|
|
|
26
26
|
|
|
27
27
|
### findAll
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/province#province'>Province</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/province#province'>Province</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
29
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/province#province'>Province</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/province#province'>Province</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<<a href='/reference/typescript-api/entities/province#province'>`Province</a>>>>`} />
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
### findOne
|
|
@@ -40,7 +40,7 @@ class RoleService {
|
|
|
40
40
|
|
|
41
41
|
### findAll
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/role#role'>Role</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/role#role'>Role</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
43
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/role#role'>Role</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/role#role'>Role</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/role#role'>`Role</a>>>`} />
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
### findOne
|
|
@@ -32,7 +32,7 @@ class SellerService {
|
|
|
32
32
|
|
|
33
33
|
### findAll
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
35
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/seller#seller'>Seller</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/seller#seller'>`Seller</a>>>`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
### findOne
|
|
@@ -93,18 +93,18 @@ according to the field's scope configuration.
|
|
|
93
93
|
|
|
94
94
|
### getMany
|
|
95
95
|
|
|
96
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, keys: string[]) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
96
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, keys: string[]) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>>`} />
|
|
97
97
|
|
|
98
98
|
Get multiple values efficiently. Each key is scoped according to
|
|
99
99
|
its individual field configuration.
|
|
100
100
|
### getMany
|
|
101
101
|
|
|
102
|
-
<MemberInfo kind="method" type={`(keys: string[], ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
102
|
+
<MemberInfo kind="method" type={`(keys: string[], ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>>`} />
|
|
103
103
|
|
|
104
104
|
|
|
105
105
|
### getMany
|
|
106
106
|
|
|
107
|
-
<MemberInfo kind="method" type={`(keysOrCtx: string[] | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrKeys: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | string[]) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
107
|
+
<MemberInfo kind="method" type={`(keysOrCtx: string[] | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrKeys: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | string[]) => Promise<Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>>`} />
|
|
108
108
|
|
|
109
109
|
|
|
110
110
|
### set
|
|
@@ -126,19 +126,19 @@ of the operation instead of throwing errors.
|
|
|
126
126
|
|
|
127
127
|
### setMany
|
|
128
128
|
|
|
129
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, values: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
129
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, values: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]>`} />
|
|
130
130
|
|
|
131
131
|
Set multiple values with structured result feedback for each operation.
|
|
132
132
|
This method will not throw errors but will return
|
|
133
133
|
detailed results for each key-value pair.
|
|
134
134
|
### setMany
|
|
135
135
|
|
|
136
|
-
<MemberInfo kind="method" type={`(values: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
136
|
+
<MemberInfo kind="method" type={`(values: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>, ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]>`} />
|
|
137
137
|
|
|
138
138
|
|
|
139
139
|
### setMany
|
|
140
140
|
|
|
141
|
-
<MemberInfo kind="method" type={`(valuesOrCtx: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a
|
|
141
|
+
<MemberInfo kind="method" type={`(valuesOrCtx: Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`> | <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, ctxOrValues: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a> | Record<string, <a href='/reference/typescript-api/common/json-compatible#jsoncompatible'>JsonCompatible</a>`<any>`>) => Promise<<a href='/reference/typescript-api/settings-store/set-settings-store-value-result#setsettingsstorevalueresult'>SetSettingsStoreValueResult</a>[]>`} />
|
|
142
142
|
|
|
143
143
|
|
|
144
144
|
### getFieldDefinition
|
|
@@ -32,7 +32,7 @@ class ShippingMethodService {
|
|
|
32
32
|
|
|
33
33
|
### findAll
|
|
34
34
|
|
|
35
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
35
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>>, relations: RelationPaths<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>ShippingMethod</a>> = []) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<Translated<<a href='/reference/typescript-api/entities/shipping-method#shippingmethod'>`ShippingMethod</a>>>>`} />
|
|
36
36
|
|
|
37
37
|
|
|
38
38
|
### findOne
|
|
@@ -44,7 +44,7 @@ class StockLocationService {
|
|
|
44
44
|
|
|
45
45
|
### findAll
|
|
46
46
|
|
|
47
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
47
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>StockLocation</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/stock-location#stocklocation'>`StockLocation</a>>>`} />
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### create
|
|
@@ -40,7 +40,7 @@ class StockMovementService {
|
|
|
40
40
|
|
|
41
41
|
### getStockMovementsByProductVariantId
|
|
42
42
|
|
|
43
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: StockMovementListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
43
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, productVariantId: <a href='/reference/typescript-api/common/id#id'>ID</a>, options?: StockMovementListOptions) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/stock-movement#stockmovement'>`StockMovement</a>>>`} />
|
|
44
44
|
|
|
45
45
|
Returns a <DocsLink href="/reference/typescript-api/common/paginated-list#paginatedlist">PaginatedList</DocsLink> of all StockMovements associated with the specified ProductVariant.
|
|
46
46
|
### adjustProductVariantStock
|
|
@@ -28,7 +28,7 @@ class TagService {
|
|
|
28
28
|
|
|
29
29
|
### findAll
|
|
30
30
|
|
|
31
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
31
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tag#tag'>Tag</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/tag#tag'>`Tag</a>>>`} />
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
### findOne
|
|
@@ -26,7 +26,7 @@ class TaxCategoryService {
|
|
|
26
26
|
|
|
27
27
|
### findAll
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
29
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tax-category#taxcategory'>TaxCategory</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/tax-category#taxcategory'>`TaxCategory</a>>>`} />
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
### findOne
|
|
@@ -27,7 +27,7 @@ class TaxRateService {
|
|
|
27
27
|
|
|
28
28
|
### findAll
|
|
29
29
|
|
|
30
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
30
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>, relations?: RelationPaths<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>TaxRate</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/tax-rate#taxrate'>`TaxRate</a>>>`} />
|
|
31
31
|
|
|
32
32
|
|
|
33
33
|
### findOne
|
|
@@ -79,7 +79,7 @@ Sets the <DocsLink href="/reference/typescript-api/entities/authentication-metho
|
|
|
79
79
|
flow.
|
|
80
80
|
### verifyUserByToken
|
|
81
81
|
|
|
82
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, verificationToken: string, password?: string) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a
|
|
82
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, verificationToken: string, password?: string) => Promise<<a href='/reference/typescript-api/errors/error-result-union#errorresultunion'>ErrorResultUnion</a>`<VerifyCustomerAccountResult, <a href='/reference/typescript-api/entities/user#user'>`User</a>>>`} />
|
|
83
83
|
|
|
84
84
|
Verifies a verificationToken by looking for a User which has previously had it set using the
|
|
85
85
|
`setVerificationToken()` method, and checks that the token is valid and has not expired.
|
|
@@ -29,7 +29,7 @@ class ZoneService {
|
|
|
29
29
|
|
|
30
30
|
### findAll
|
|
31
31
|
|
|
32
|
-
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a
|
|
32
|
+
<MemberInfo kind="method" type={`(ctx: <a href='/reference/typescript-api/request/request-context#requestcontext'>RequestContext</a>, options?: ListQueryOptions<<a href='/reference/typescript-api/entities/zone#zone'>Zone</a>>) => Promise<<a href='/reference/typescript-api/common/paginated-list#paginatedlist'>PaginatedList</a>`<<a href='/reference/typescript-api/entities/zone#zone'>`Zone</a>>>`} />
|
|
33
33
|
|
|
34
34
|
|
|
35
35
|
### findOne
|
|
@@ -21,12 +21,12 @@ interface ShippingEligibilityCheckerConfig<T extends ConfigArgs> extends Configu
|
|
|
21
21
|
|
|
22
22
|
### check
|
|
23
23
|
|
|
24
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn#checkshippingeligibilitycheckerfn'>CheckShippingEligibilityCheckerFn</a
|
|
24
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/check-shipping-eligibility-checker-fn#checkshippingeligibilitycheckerfn'>CheckShippingEligibilityCheckerFn</a>`<T>``} />
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
### shouldRunCheck
|
|
28
28
|
|
|
29
|
-
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/should-run-check-fn#shouldruncheckfn'>ShouldRunCheckFn</a
|
|
29
|
+
<MemberInfo kind="property" type={`<a href='/reference/typescript-api/shipping/should-run-check-fn#shouldruncheckfn'>ShouldRunCheckFn</a>`<T>``} />
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
|
|
@@ -37,7 +37,7 @@ class ShippingEligibilityChecker<T extends ConfigArgs = ConfigArgs> extends Conf
|
|
|
37
37
|
|
|
38
38
|
### constructor
|
|
39
39
|
|
|
40
|
-
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/shipping/shipping-eligibility-checker-config#shippingeligibilitycheckerconfig'>ShippingEligibilityCheckerConfig</a
|
|
40
|
+
<MemberInfo kind="method" type={`(config: <a href='/reference/typescript-api/shipping/shipping-eligibility-checker-config#shippingeligibilitycheckerconfig'>ShippingEligibilityCheckerConfig</a>`<T>`) => ShippingEligibilityChecker`} />
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
### init
|