@gradientedge/commercetools-utils 5.30.0 → 5.32.0
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/dist/cjs/api/CommercetoolsApi.d.ts +3 -4
- package/dist/cjs/api/CommercetoolsApi.d.ts.map +1 -1
- package/dist/cjs/api/CommercetoolsApi.js +2 -7
- package/dist/cjs/api/CommercetoolsApi.js.map +1 -1
- package/dist/cjs/tsconfig-cjs.tsbuildinfo +1 -1
- package/dist/cjs/types/models/approval-flow.d.ts +15 -4
- package/dist/cjs/types/models/approval-flow.d.ts.map +1 -1
- package/dist/cjs/types/models/approval-flow.js +11 -0
- package/dist/cjs/types/models/approval-flow.js.map +1 -1
- package/dist/cjs/types/models/approval-rule.d.ts +19 -9
- package/dist/cjs/types/models/approval-rule.d.ts.map +1 -1
- package/dist/cjs/types/models/approval-rule.js +10 -0
- package/dist/cjs/types/models/approval-rule.js.map +1 -1
- package/dist/cjs/types/models/associate-role.d.ts +58 -11
- package/dist/cjs/types/models/associate-role.d.ts.map +1 -1
- package/dist/cjs/types/models/associate-role.js +47 -0
- package/dist/cjs/types/models/associate-role.js.map +1 -1
- package/dist/cjs/types/models/attribute-group.d.ts +15 -9
- package/dist/cjs/types/models/attribute-group.d.ts.map +1 -1
- package/dist/cjs/types/models/business-unit-search.d.ts +114 -0
- package/dist/cjs/types/models/business-unit-search.d.ts.map +1 -0
- package/dist/cjs/types/models/business-unit-search.js +8 -0
- package/dist/cjs/types/models/business-unit-search.js.map +1 -0
- package/dist/cjs/types/models/business-unit.d.ts +349 -35
- package/dist/cjs/types/models/business-unit.d.ts.map +1 -1
- package/dist/cjs/types/models/business-unit.js +55 -0
- package/dist/cjs/types/models/business-unit.js.map +1 -1
- package/dist/cjs/types/models/cart-discount.d.ts +218 -36
- package/dist/cjs/types/models/cart-discount.d.ts.map +1 -1
- package/dist/cjs/types/models/cart-discount.js +29 -0
- package/dist/cjs/types/models/cart-discount.js.map +1 -1
- package/dist/cjs/types/models/cart.d.ts +178 -88
- package/dist/cjs/types/models/cart.d.ts.map +1 -1
- package/dist/cjs/types/models/cart.js +127 -0
- package/dist/cjs/types/models/cart.js.map +1 -1
- package/dist/cjs/types/models/category.d.ts +32 -26
- package/dist/cjs/types/models/category.d.ts.map +1 -1
- package/dist/cjs/types/models/channel.d.ts +28 -15
- package/dist/cjs/types/models/channel.d.ts.map +1 -1
- package/dist/cjs/types/models/channel.js +13 -0
- package/dist/cjs/types/models/channel.js.map +1 -1
- package/dist/cjs/types/models/common.d.ts +167 -5
- package/dist/cjs/types/models/common.d.ts.map +1 -1
- package/dist/cjs/types/models/common.js +61 -0
- package/dist/cjs/types/models/common.js.map +1 -1
- package/dist/cjs/types/models/custom-object.d.ts +2 -2
- package/dist/cjs/types/models/custom-object.d.ts.map +1 -1
- package/dist/cjs/types/models/customer-group.d.ts +13 -7
- package/dist/cjs/types/models/customer-group.d.ts.map +1 -1
- package/dist/cjs/types/models/customer.d.ts +53 -39
- package/dist/cjs/types/models/customer.d.ts.map +1 -1
- package/dist/cjs/types/models/customer.js +11 -0
- package/dist/cjs/types/models/customer.js.map +1 -1
- package/dist/cjs/types/models/discount-code.d.ts +24 -18
- package/dist/cjs/types/models/discount-code.d.ts.map +1 -1
- package/dist/cjs/types/models/error.d.ts +193 -167
- package/dist/cjs/types/models/error.d.ts.map +1 -1
- package/dist/cjs/types/models/extension.d.ts +43 -9
- package/dist/cjs/types/models/extension.d.ts.map +1 -1
- package/dist/cjs/types/models/extension.js +27 -0
- package/dist/cjs/types/models/extension.js.map +1 -1
- package/dist/cjs/types/models/index.d.ts +1 -0
- package/dist/cjs/types/models/index.d.ts.map +1 -1
- package/dist/cjs/types/models/index.js +1 -0
- package/dist/cjs/types/models/index.js.map +1 -1
- package/dist/cjs/types/models/inventory.d.ts +19 -13
- package/dist/cjs/types/models/inventory.d.ts.map +1 -1
- package/dist/cjs/types/models/me.d.ts +210 -100
- package/dist/cjs/types/models/me.d.ts.map +1 -1
- package/dist/cjs/types/models/me.js +10 -0
- package/dist/cjs/types/models/me.js.map +1 -1
- package/dist/cjs/types/models/message.d.ts +871 -489
- package/dist/cjs/types/models/message.d.ts.map +1 -1
- package/dist/cjs/types/models/order-edit.d.ts +131 -108
- package/dist/cjs/types/models/order-edit.d.ts.map +1 -1
- package/dist/cjs/types/models/order.d.ts +211 -69
- package/dist/cjs/types/models/order.d.ts.map +1 -1
- package/dist/cjs/types/models/order.js +93 -0
- package/dist/cjs/types/models/order.js.map +1 -1
- package/dist/cjs/types/models/payment.d.ts +42 -23
- package/dist/cjs/types/models/payment.d.ts.map +1 -1
- package/dist/cjs/types/models/payment.js +20 -0
- package/dist/cjs/types/models/payment.js.map +1 -1
- package/dist/cjs/types/models/product-discount.d.ts +37 -19
- package/dist/cjs/types/models/product-discount.d.ts.map +1 -1
- package/dist/cjs/types/models/product-search.d.ts +43 -14
- package/dist/cjs/types/models/product-search.d.ts.map +1 -1
- package/dist/cjs/types/models/product-search.js +16 -0
- package/dist/cjs/types/models/product-search.js.map +1 -1
- package/dist/cjs/types/models/product-selection.d.ts +42 -16
- package/dist/cjs/types/models/product-selection.d.ts.map +1 -1
- package/dist/cjs/types/models/product-selection.js +17 -0
- package/dist/cjs/types/models/product-selection.js.map +1 -1
- package/dist/cjs/types/models/product-tailoring.d.ts +42 -33
- package/dist/cjs/types/models/product-tailoring.d.ts.map +1 -1
- package/dist/cjs/types/models/product-type.d.ts +83 -40
- package/dist/cjs/types/models/product-type.d.ts.map +1 -1
- package/dist/cjs/types/models/product-type.js +48 -0
- package/dist/cjs/types/models/product-type.js.map +1 -1
- package/dist/cjs/types/models/product.d.ts +97 -59
- package/dist/cjs/types/models/product.d.ts.map +1 -1
- package/dist/cjs/types/models/product.js +26 -0
- package/dist/cjs/types/models/product.js.map +1 -1
- package/dist/cjs/types/models/project.d.ts +94 -20
- package/dist/cjs/types/models/project.d.ts.map +1 -1
- package/dist/cjs/types/models/project.js +73 -0
- package/dist/cjs/types/models/project.js.map +1 -1
- package/dist/cjs/types/models/quote-request.d.ts +21 -8
- package/dist/cjs/types/models/quote-request.d.ts.map +1 -1
- package/dist/cjs/types/models/quote-request.js +13 -0
- package/dist/cjs/types/models/quote-request.js.map +1 -1
- package/dist/cjs/types/models/quote.d.ts +25 -11
- package/dist/cjs/types/models/quote.d.ts.map +1 -1
- package/dist/cjs/types/models/quote.js +14 -0
- package/dist/cjs/types/models/quote.js.map +1 -1
- package/dist/cjs/types/models/review.d.ts +20 -14
- package/dist/cjs/types/models/review.d.ts.map +1 -1
- package/dist/cjs/types/models/search.d.ts +62 -4
- package/dist/cjs/types/models/search.d.ts.map +1 -1
- package/dist/cjs/types/models/search.js +51 -0
- package/dist/cjs/types/models/search.js.map +1 -1
- package/dist/cjs/types/models/shipping-method.d.ts +38 -21
- package/dist/cjs/types/models/shipping-method.d.ts.map +1 -1
- package/dist/cjs/types/models/shipping-method.js +7 -0
- package/dist/cjs/types/models/shipping-method.js.map +1 -1
- package/dist/cjs/types/models/shopping-list.d.ts +66 -28
- package/dist/cjs/types/models/shopping-list.d.ts.map +1 -1
- package/dist/cjs/types/models/staged-quote.d.ts +21 -10
- package/dist/cjs/types/models/staged-quote.d.ts.map +1 -1
- package/dist/cjs/types/models/staged-quote.js +11 -0
- package/dist/cjs/types/models/staged-quote.js.map +1 -1
- package/dist/cjs/types/models/standalone-price.d.ts +23 -17
- package/dist/cjs/types/models/standalone-price.d.ts.map +1 -1
- package/dist/cjs/types/models/state.d.ts +33 -13
- package/dist/cjs/types/models/state.d.ts.map +1 -1
- package/dist/cjs/types/models/state.js +25 -0
- package/dist/cjs/types/models/state.js.map +1 -1
- package/dist/cjs/types/models/store.d.ts +29 -23
- package/dist/cjs/types/models/store.d.ts.map +1 -1
- package/dist/cjs/types/models/subscription.d.ts +138 -18
- package/dist/cjs/types/models/subscription.d.ts.map +1 -1
- package/dist/cjs/types/models/subscription.js +95 -0
- package/dist/cjs/types/models/subscription.js.map +1 -1
- package/dist/cjs/types/models/tax-category.d.ts +15 -9
- package/dist/cjs/types/models/tax-category.d.ts.map +1 -1
- package/dist/cjs/types/models/type.d.ts +101 -29
- package/dist/cjs/types/models/type.d.ts.map +1 -1
- package/dist/cjs/types/models/type.js +76 -0
- package/dist/cjs/types/models/type.js.map +1 -1
- package/dist/cjs/types/models/warning.d.ts +15 -1
- package/dist/cjs/types/models/warning.d.ts.map +1 -1
- package/dist/cjs/types/models/zone.d.ts +14 -8
- package/dist/cjs/types/models/zone.d.ts.map +1 -1
- package/dist/mjs/api/CommercetoolsApi.d.ts +3 -4
- package/dist/mjs/api/CommercetoolsApi.d.ts.map +1 -1
- package/dist/mjs/api/CommercetoolsApi.js +2 -7
- package/dist/mjs/api/CommercetoolsApi.js.map +1 -1
- package/dist/mjs/tsconfig.tsbuildinfo +1 -1
- package/dist/mjs/types/models/approval-flow.d.ts +15 -4
- package/dist/mjs/types/models/approval-flow.d.ts.map +1 -1
- package/dist/mjs/types/models/approval-flow.js +10 -1
- package/dist/mjs/types/models/approval-flow.js.map +1 -1
- package/dist/mjs/types/models/approval-rule.d.ts +19 -9
- package/dist/mjs/types/models/approval-rule.d.ts.map +1 -1
- package/dist/mjs/types/models/approval-rule.js +9 -1
- package/dist/mjs/types/models/approval-rule.js.map +1 -1
- package/dist/mjs/types/models/associate-role.d.ts +58 -11
- package/dist/mjs/types/models/associate-role.d.ts.map +1 -1
- package/dist/mjs/types/models/associate-role.js +46 -1
- package/dist/mjs/types/models/associate-role.js.map +1 -1
- package/dist/mjs/types/models/attribute-group.d.ts +15 -9
- package/dist/mjs/types/models/attribute-group.d.ts.map +1 -1
- package/dist/mjs/types/models/business-unit-search.d.ts +114 -0
- package/dist/mjs/types/models/business-unit-search.d.ts.map +1 -0
- package/dist/mjs/types/models/business-unit-search.js +7 -0
- package/dist/mjs/types/models/business-unit-search.js.map +1 -0
- package/dist/mjs/types/models/business-unit.d.ts +349 -35
- package/dist/mjs/types/models/business-unit.d.ts.map +1 -1
- package/dist/mjs/types/models/business-unit.js +54 -1
- package/dist/mjs/types/models/business-unit.js.map +1 -1
- package/dist/mjs/types/models/cart-discount.d.ts +218 -36
- package/dist/mjs/types/models/cart-discount.d.ts.map +1 -1
- package/dist/mjs/types/models/cart-discount.js +28 -1
- package/dist/mjs/types/models/cart-discount.js.map +1 -1
- package/dist/mjs/types/models/cart.d.ts +178 -88
- package/dist/mjs/types/models/cart.d.ts.map +1 -1
- package/dist/mjs/types/models/cart.js +126 -1
- package/dist/mjs/types/models/cart.js.map +1 -1
- package/dist/mjs/types/models/category.d.ts +32 -26
- package/dist/mjs/types/models/category.d.ts.map +1 -1
- package/dist/mjs/types/models/channel.d.ts +28 -15
- package/dist/mjs/types/models/channel.d.ts.map +1 -1
- package/dist/mjs/types/models/channel.js +12 -1
- package/dist/mjs/types/models/channel.js.map +1 -1
- package/dist/mjs/types/models/common.d.ts +167 -5
- package/dist/mjs/types/models/common.d.ts.map +1 -1
- package/dist/mjs/types/models/common.js +60 -1
- package/dist/mjs/types/models/common.js.map +1 -1
- package/dist/mjs/types/models/custom-object.d.ts +2 -2
- package/dist/mjs/types/models/custom-object.d.ts.map +1 -1
- package/dist/mjs/types/models/customer-group.d.ts +13 -7
- package/dist/mjs/types/models/customer-group.d.ts.map +1 -1
- package/dist/mjs/types/models/customer.d.ts +53 -39
- package/dist/mjs/types/models/customer.d.ts.map +1 -1
- package/dist/mjs/types/models/customer.js +10 -1
- package/dist/mjs/types/models/customer.js.map +1 -1
- package/dist/mjs/types/models/discount-code.d.ts +24 -18
- package/dist/mjs/types/models/discount-code.d.ts.map +1 -1
- package/dist/mjs/types/models/error.d.ts +193 -167
- package/dist/mjs/types/models/error.d.ts.map +1 -1
- package/dist/mjs/types/models/extension.d.ts +43 -9
- package/dist/mjs/types/models/extension.d.ts.map +1 -1
- package/dist/mjs/types/models/extension.js +26 -1
- package/dist/mjs/types/models/extension.js.map +1 -1
- package/dist/mjs/types/models/index.d.ts +1 -0
- package/dist/mjs/types/models/index.d.ts.map +1 -1
- package/dist/mjs/types/models/index.js +1 -0
- package/dist/mjs/types/models/index.js.map +1 -1
- package/dist/mjs/types/models/inventory.d.ts +19 -13
- package/dist/mjs/types/models/inventory.d.ts.map +1 -1
- package/dist/mjs/types/models/me.d.ts +210 -100
- package/dist/mjs/types/models/me.d.ts.map +1 -1
- package/dist/mjs/types/models/me.js +9 -1
- package/dist/mjs/types/models/me.js.map +1 -1
- package/dist/mjs/types/models/message.d.ts +871 -489
- package/dist/mjs/types/models/message.d.ts.map +1 -1
- package/dist/mjs/types/models/order-edit.d.ts +131 -108
- package/dist/mjs/types/models/order-edit.d.ts.map +1 -1
- package/dist/mjs/types/models/order.d.ts +211 -69
- package/dist/mjs/types/models/order.d.ts.map +1 -1
- package/dist/mjs/types/models/order.js +92 -1
- package/dist/mjs/types/models/order.js.map +1 -1
- package/dist/mjs/types/models/payment.d.ts +42 -23
- package/dist/mjs/types/models/payment.d.ts.map +1 -1
- package/dist/mjs/types/models/payment.js +19 -1
- package/dist/mjs/types/models/payment.js.map +1 -1
- package/dist/mjs/types/models/product-discount.d.ts +37 -19
- package/dist/mjs/types/models/product-discount.d.ts.map +1 -1
- package/dist/mjs/types/models/product-search.d.ts +43 -14
- package/dist/mjs/types/models/product-search.d.ts.map +1 -1
- package/dist/mjs/types/models/product-search.js +15 -1
- package/dist/mjs/types/models/product-search.js.map +1 -1
- package/dist/mjs/types/models/product-selection.d.ts +42 -16
- package/dist/mjs/types/models/product-selection.d.ts.map +1 -1
- package/dist/mjs/types/models/product-selection.js +16 -1
- package/dist/mjs/types/models/product-selection.js.map +1 -1
- package/dist/mjs/types/models/product-tailoring.d.ts +42 -33
- package/dist/mjs/types/models/product-tailoring.d.ts.map +1 -1
- package/dist/mjs/types/models/product-type.d.ts +83 -40
- package/dist/mjs/types/models/product-type.d.ts.map +1 -1
- package/dist/mjs/types/models/product-type.js +47 -1
- package/dist/mjs/types/models/product-type.js.map +1 -1
- package/dist/mjs/types/models/product.d.ts +97 -59
- package/dist/mjs/types/models/product.d.ts.map +1 -1
- package/dist/mjs/types/models/product.js +25 -1
- package/dist/mjs/types/models/product.js.map +1 -1
- package/dist/mjs/types/models/project.d.ts +94 -20
- package/dist/mjs/types/models/project.d.ts.map +1 -1
- package/dist/mjs/types/models/project.js +72 -1
- package/dist/mjs/types/models/project.js.map +1 -1
- package/dist/mjs/types/models/quote-request.d.ts +21 -8
- package/dist/mjs/types/models/quote-request.d.ts.map +1 -1
- package/dist/mjs/types/models/quote-request.js +12 -1
- package/dist/mjs/types/models/quote-request.js.map +1 -1
- package/dist/mjs/types/models/quote.d.ts +25 -11
- package/dist/mjs/types/models/quote.d.ts.map +1 -1
- package/dist/mjs/types/models/quote.js +13 -1
- package/dist/mjs/types/models/quote.js.map +1 -1
- package/dist/mjs/types/models/review.d.ts +20 -14
- package/dist/mjs/types/models/review.d.ts.map +1 -1
- package/dist/mjs/types/models/search.d.ts +62 -4
- package/dist/mjs/types/models/search.d.ts.map +1 -1
- package/dist/mjs/types/models/search.js +50 -1
- package/dist/mjs/types/models/search.js.map +1 -1
- package/dist/mjs/types/models/shipping-method.d.ts +38 -21
- package/dist/mjs/types/models/shipping-method.d.ts.map +1 -1
- package/dist/mjs/types/models/shipping-method.js +6 -1
- package/dist/mjs/types/models/shipping-method.js.map +1 -1
- package/dist/mjs/types/models/shopping-list.d.ts +66 -28
- package/dist/mjs/types/models/shopping-list.d.ts.map +1 -1
- package/dist/mjs/types/models/staged-quote.d.ts +21 -10
- package/dist/mjs/types/models/staged-quote.d.ts.map +1 -1
- package/dist/mjs/types/models/staged-quote.js +10 -1
- package/dist/mjs/types/models/staged-quote.js.map +1 -1
- package/dist/mjs/types/models/standalone-price.d.ts +23 -17
- package/dist/mjs/types/models/standalone-price.d.ts.map +1 -1
- package/dist/mjs/types/models/state.d.ts +33 -13
- package/dist/mjs/types/models/state.d.ts.map +1 -1
- package/dist/mjs/types/models/state.js +24 -1
- package/dist/mjs/types/models/state.js.map +1 -1
- package/dist/mjs/types/models/store.d.ts +29 -23
- package/dist/mjs/types/models/store.d.ts.map +1 -1
- package/dist/mjs/types/models/subscription.d.ts +138 -18
- package/dist/mjs/types/models/subscription.d.ts.map +1 -1
- package/dist/mjs/types/models/subscription.js +94 -1
- package/dist/mjs/types/models/subscription.js.map +1 -1
- package/dist/mjs/types/models/tax-category.d.ts +15 -9
- package/dist/mjs/types/models/tax-category.d.ts.map +1 -1
- package/dist/mjs/types/models/type.d.ts +101 -29
- package/dist/mjs/types/models/type.d.ts.map +1 -1
- package/dist/mjs/types/models/type.js +75 -1
- package/dist/mjs/types/models/type.js.map +1 -1
- package/dist/mjs/types/models/warning.d.ts +15 -1
- package/dist/mjs/types/models/warning.d.ts.map +1 -1
- package/dist/mjs/types/models/zone.d.ts +14 -8
- package/dist/mjs/types/models/zone.d.ts.map +1 -1
- package/package.json +2 -2
|
@@ -5,12 +5,12 @@
|
|
|
5
5
|
*/
|
|
6
6
|
import { CustomLineItemPriceMode, DirectDiscountDraft, ExternalLineItemTotalPrice, ExternalTaxAmountDraft, ExternalTaxRateDraft, InventoryMode, ItemShippingDetailsDraft, RoundingMode, ShippingRateInputDraft, TaxCalculationMode, TaxedPrice, TaxMode, TaxPortionDraft } from './cart.js';
|
|
7
7
|
import { ChannelResourceIdentifier } from './channel.js';
|
|
8
|
-
import { BaseResource, CreatedBy, LastModifiedBy, LocalizedString, TypedMoney, _BaseAddress, _Money } from './common.js';
|
|
8
|
+
import { BaseResource, CreatedBy, IReference, IResourceIdentifier, LastModifiedBy, LocalizedString, TypedMoney, _BaseAddress, _Money } from './common.js';
|
|
9
9
|
import { CustomerGroupResourceIdentifier } from './customer-group.js';
|
|
10
10
|
import { DiscountCodeReference } from './discount-code.js';
|
|
11
11
|
import { ErrorObject } from './error.js';
|
|
12
12
|
import { MessagePayload } from './message.js';
|
|
13
|
-
import { DeliveryItem, ItemState, Order, OrderReference, OrderState, ParcelDraft, ParcelMeasurements, PaymentState, ReturnInfoDraft, ReturnItemDraft, ReturnPaymentState, ReturnShipmentState, ShipmentState, StagedOrderUpdateAction, TrackingData } from './order.js';
|
|
13
|
+
import { DeliveryItem, IStagedOrderUpdateAction, ItemState, Order, OrderReference, OrderState, ParcelDraft, ParcelMeasurements, PaymentState, ReturnInfoDraft, ReturnItemDraft, ReturnPaymentState, ReturnShipmentState, ShipmentState, StagedOrderUpdateAction, TrackingData } from './order.js';
|
|
14
14
|
import { PaymentResourceIdentifier } from './payment.js';
|
|
15
15
|
import { ShippingMethodResourceIdentifier, ShippingRateDraft } from './shipping-method.js';
|
|
16
16
|
import { ShoppingListResourceIdentifier } from './shopping-list.js';
|
|
@@ -197,7 +197,7 @@ export interface OrderEditPagedQueryResponse {
|
|
|
197
197
|
* [Reference](ctp:api:type:Reference) to an [OrderEdit](ctp:api:type:OrderEdit).
|
|
198
198
|
*
|
|
199
199
|
*/
|
|
200
|
-
export interface OrderEditReference {
|
|
200
|
+
export interface OrderEditReference extends IReference {
|
|
201
201
|
readonly typeId: 'order-edit';
|
|
202
202
|
/**
|
|
203
203
|
* Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit).
|
|
@@ -216,7 +216,7 @@ export interface OrderEditReference {
|
|
|
216
216
|
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [OrderEdit](ctp:api:type:OrderEdit). Either `id` or `key` is required. If both are set, an [InvalidJsonInput](/../api/errors#invalidjsoninput) error is returned.
|
|
217
217
|
*
|
|
218
218
|
*/
|
|
219
|
-
export interface OrderEditResourceIdentifier {
|
|
219
|
+
export interface OrderEditResourceIdentifier extends IResourceIdentifier {
|
|
220
220
|
readonly typeId: 'order-edit';
|
|
221
221
|
/**
|
|
222
222
|
* Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). Required if `key` is absent.
|
|
@@ -232,11 +232,17 @@ export interface OrderEditResourceIdentifier {
|
|
|
232
232
|
readonly key?: string;
|
|
233
233
|
}
|
|
234
234
|
export type OrderEditResult = OrderEditApplied | OrderEditNotProcessed | OrderEditPreviewFailure | OrderEditPreviewSuccess;
|
|
235
|
+
export interface IOrderEditResult {
|
|
236
|
+
/**
|
|
237
|
+
*
|
|
238
|
+
*/
|
|
239
|
+
readonly type: string;
|
|
240
|
+
}
|
|
235
241
|
/**
|
|
236
|
-
* Result of a
|
|
242
|
+
* Result of a successful application of `stagedActions` to the Order.
|
|
237
243
|
*
|
|
238
244
|
*/
|
|
239
|
-
export interface OrderEditApplied {
|
|
245
|
+
export interface OrderEditApplied extends IOrderEditResult {
|
|
240
246
|
readonly type: 'Applied';
|
|
241
247
|
/**
|
|
242
248
|
* Date and time (UTC) the Order was edited.
|
|
@@ -261,14 +267,14 @@ export interface OrderEditApplied {
|
|
|
261
267
|
* Indicates that the edit has not been applied or processed in any way.
|
|
262
268
|
*
|
|
263
269
|
*/
|
|
264
|
-
export interface OrderEditNotProcessed {
|
|
270
|
+
export interface OrderEditNotProcessed extends IOrderEditResult {
|
|
265
271
|
readonly type: 'NotProcessed';
|
|
266
272
|
}
|
|
267
273
|
/**
|
|
268
274
|
* Result of a failed application of `stagedActions` to the Order. The data is calculated on the fly and is not queryable.
|
|
269
275
|
*
|
|
270
276
|
*/
|
|
271
|
-
export interface OrderEditPreviewFailure {
|
|
277
|
+
export interface OrderEditPreviewFailure extends IOrderEditResult {
|
|
272
278
|
readonly type: 'PreviewFailure';
|
|
273
279
|
/**
|
|
274
280
|
* Errors returned.
|
|
@@ -281,7 +287,7 @@ export interface OrderEditPreviewFailure {
|
|
|
281
287
|
* The data is not persisted but is dynamically pulled by dry-running the update actions from `stagedActions` on the current version of the related [Order](ctp:api:type:Order), not from the Order version at the time the OrderEdit was created. Therefore, it cannot be queried.
|
|
282
288
|
*
|
|
283
289
|
*/
|
|
284
|
-
export interface OrderEditPreviewSuccess {
|
|
290
|
+
export interface OrderEditPreviewSuccess extends IOrderEditResult {
|
|
285
291
|
readonly type: 'PreviewSuccess';
|
|
286
292
|
/**
|
|
287
293
|
* A preview of the edited [Order](ctp:api:type:Order) as it will be after all `stagedActions` (incl. optional Order [API Extensions](/../api/projects/api-extensions)) are applied.
|
|
@@ -318,6 +324,12 @@ export interface OrderEditUpdate {
|
|
|
318
324
|
readonly dryRun?: boolean;
|
|
319
325
|
}
|
|
320
326
|
export type OrderEditUpdateAction = OrderEditAddStagedActionAction | OrderEditSetCommentAction | OrderEditSetCustomFieldAction | OrderEditSetCustomTypeAction | OrderEditSetKeyAction | OrderEditSetStagedActionsAction;
|
|
327
|
+
export interface IOrderEditUpdateAction {
|
|
328
|
+
/**
|
|
329
|
+
*
|
|
330
|
+
*/
|
|
331
|
+
readonly action: string;
|
|
332
|
+
}
|
|
321
333
|
/**
|
|
322
334
|
* Excerpt of the Order extracting the total and the taxed price.
|
|
323
335
|
*
|
|
@@ -348,7 +360,7 @@ export interface StagedOrder extends Order {
|
|
|
348
360
|
* The `stagedActions` field cannot be updated if the Order Edit `result` is [OrderEdit Applied](/projects/order-edits#orderedit-applied).
|
|
349
361
|
*
|
|
350
362
|
*/
|
|
351
|
-
export interface OrderEditAddStagedActionAction {
|
|
363
|
+
export interface OrderEditAddStagedActionAction extends IOrderEditUpdateAction {
|
|
352
364
|
readonly action: 'addStagedAction';
|
|
353
365
|
/**
|
|
354
366
|
* Order update action to append to the `stagedActions` array.
|
|
@@ -357,7 +369,7 @@ export interface OrderEditAddStagedActionAction {
|
|
|
357
369
|
*/
|
|
358
370
|
readonly stagedAction: StagedOrderUpdateAction;
|
|
359
371
|
}
|
|
360
|
-
export interface OrderEditSetCommentAction {
|
|
372
|
+
export interface OrderEditSetCommentAction extends IOrderEditUpdateAction {
|
|
361
373
|
readonly action: 'setComment';
|
|
362
374
|
/**
|
|
363
375
|
* Value to set.
|
|
@@ -367,7 +379,7 @@ export interface OrderEditSetCommentAction {
|
|
|
367
379
|
*/
|
|
368
380
|
readonly comment?: string;
|
|
369
381
|
}
|
|
370
|
-
export interface OrderEditSetCustomFieldAction {
|
|
382
|
+
export interface OrderEditSetCustomFieldAction extends IOrderEditUpdateAction {
|
|
371
383
|
readonly action: 'setCustomField';
|
|
372
384
|
/**
|
|
373
385
|
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
@@ -384,7 +396,7 @@ export interface OrderEditSetCustomFieldAction {
|
|
|
384
396
|
*/
|
|
385
397
|
readonly value?: any;
|
|
386
398
|
}
|
|
387
|
-
export interface OrderEditSetCustomTypeAction {
|
|
399
|
+
export interface OrderEditSetCustomTypeAction extends IOrderEditUpdateAction {
|
|
388
400
|
readonly action: 'setCustomType';
|
|
389
401
|
/**
|
|
390
402
|
* Defines the [Type](ctp:api:type:Type) that extends the Order Edit with [Custom Fields](/../api/projects/custom-fields).
|
|
@@ -400,7 +412,7 @@ export interface OrderEditSetCustomTypeAction {
|
|
|
400
412
|
*/
|
|
401
413
|
readonly fields?: FieldContainer;
|
|
402
414
|
}
|
|
403
|
-
export interface OrderEditSetKeyAction {
|
|
415
|
+
export interface OrderEditSetKeyAction extends IOrderEditUpdateAction {
|
|
404
416
|
readonly action: 'setKey';
|
|
405
417
|
/**
|
|
406
418
|
* Value to set.
|
|
@@ -414,7 +426,7 @@ export interface OrderEditSetKeyAction {
|
|
|
414
426
|
* The `stagedActions` field cannot be updated if the Order Edit `result` is [OrderEdit Applied](/projects/order-edits#orderedit-applied).
|
|
415
427
|
*
|
|
416
428
|
*/
|
|
417
|
-
export interface OrderEditSetStagedActionsAction {
|
|
429
|
+
export interface OrderEditSetStagedActionsAction extends IOrderEditUpdateAction {
|
|
418
430
|
readonly action: 'setStagedActions';
|
|
419
431
|
/**
|
|
420
432
|
* Value to replace the `stagedActions` of the Order Edit.
|
|
@@ -435,7 +447,7 @@ export interface OrderEditSetStagedActionsAction {
|
|
|
435
447
|
* If the Tax Rate is not set, a [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError) error is returned.
|
|
436
448
|
*
|
|
437
449
|
*/
|
|
438
|
-
export interface StagedOrderAddCustomLineItemAction {
|
|
450
|
+
export interface StagedOrderAddCustomLineItemAction extends IStagedOrderUpdateAction {
|
|
439
451
|
readonly action: 'addCustomLineItem';
|
|
440
452
|
/**
|
|
441
453
|
* Money value of the Custom Line Item. The value can be negative.
|
|
@@ -487,8 +499,7 @@ export interface StagedOrderAddCustomLineItemAction {
|
|
|
487
499
|
*/
|
|
488
500
|
readonly shippingDetails?: ItemShippingDetailsDraft;
|
|
489
501
|
/**
|
|
490
|
-
* - If `Standard`, Cart Discounts with a matching [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget)
|
|
491
|
-
* are applied to the Custom Line Item.
|
|
502
|
+
* - If `Standard`, Cart Discounts with a matching [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget), [MultiBuyCustomLineItemsTarget](ctp:api:type:MultiBuyCustomLineItemsTarget), or [CartDiscountPatternTarget](ctp:api:type:CartDiscountPatternTarget) are applied to the Custom Line Item.
|
|
492
503
|
* - If `External`, Cart Discounts are not considered on the Custom Line Item.
|
|
493
504
|
*
|
|
494
505
|
*
|
|
@@ -508,7 +519,7 @@ export interface StagedOrderAddCustomLineItemAction {
|
|
|
508
519
|
* Produces the [Delivery Added](ctp:api:type:DeliveryAddedMessage) Message.
|
|
509
520
|
*
|
|
510
521
|
*/
|
|
511
|
-
export interface StagedOrderAddDeliveryAction {
|
|
522
|
+
export interface StagedOrderAddDeliveryAction extends IStagedOrderUpdateAction {
|
|
512
523
|
readonly action: 'addDelivery';
|
|
513
524
|
/**
|
|
514
525
|
* `key` of an existing [Delivery](ctp:api:type:Delivery).
|
|
@@ -558,7 +569,7 @@ export interface StagedOrderAddDeliveryAction {
|
|
|
558
569
|
* Specific Error Code: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError)
|
|
559
570
|
*
|
|
560
571
|
*/
|
|
561
|
-
export interface StagedOrderAddDiscountCodeAction {
|
|
572
|
+
export interface StagedOrderAddDiscountCodeAction extends IStagedOrderUpdateAction {
|
|
562
573
|
readonly action: 'addDiscountCode';
|
|
563
574
|
/**
|
|
564
575
|
* `code` of a [DiscountCode](ctp:api:type:DiscountCode).
|
|
@@ -571,7 +582,7 @@ export interface StagedOrderAddDiscountCodeAction {
|
|
|
571
582
|
* Adds an address to an Order when shipping to multiple addresses is desired.
|
|
572
583
|
*
|
|
573
584
|
*/
|
|
574
|
-
export interface StagedOrderAddItemShippingAddressAction {
|
|
585
|
+
export interface StagedOrderAddItemShippingAddressAction extends IStagedOrderUpdateAction {
|
|
575
586
|
readonly action: 'addItemShippingAddress';
|
|
576
587
|
/**
|
|
577
588
|
* Address to append to `itemShippingAddresses`.
|
|
@@ -592,7 +603,7 @@ export interface StagedOrderAddItemShippingAddressAction {
|
|
|
592
603
|
* If the Line Items do not have a Price according to the [Product](ctp:api:type:Product) `priceMode` value for a selected currency and/or country, Customer Group, or Channel, a [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) error is returned.
|
|
593
604
|
*
|
|
594
605
|
*/
|
|
595
|
-
export interface StagedOrderAddLineItemAction {
|
|
606
|
+
export interface StagedOrderAddLineItemAction extends IStagedOrderUpdateAction {
|
|
596
607
|
readonly action: 'addLineItem';
|
|
597
608
|
/**
|
|
598
609
|
* User-defined unique identifier of the LineItem.
|
|
@@ -699,7 +710,7 @@ export interface StagedOrderAddLineItemAction {
|
|
|
699
710
|
* Produces the [Parcel Added To Delivery](ctp:api:type:ParcelAddedToDeliveryMessage) Message.
|
|
700
711
|
*
|
|
701
712
|
*/
|
|
702
|
-
export interface StagedOrderAddParcelToDeliveryAction {
|
|
713
|
+
export interface StagedOrderAddParcelToDeliveryAction extends IStagedOrderUpdateAction {
|
|
703
714
|
readonly action: 'addParcelToDelivery';
|
|
704
715
|
/**
|
|
705
716
|
* `id` of an existing [Delivery](ctp:api:type:Delivery).
|
|
@@ -748,7 +759,7 @@ export interface StagedOrderAddParcelToDeliveryAction {
|
|
|
748
759
|
*/
|
|
749
760
|
readonly custom?: CustomFieldsDraft;
|
|
750
761
|
}
|
|
751
|
-
export interface StagedOrderAddPaymentAction {
|
|
762
|
+
export interface StagedOrderAddPaymentAction extends IStagedOrderUpdateAction {
|
|
752
763
|
readonly action: 'addPayment';
|
|
753
764
|
/**
|
|
754
765
|
* Payment to add to the [PaymentInfo](ctp:api:type:PaymentInfo).
|
|
@@ -762,7 +773,7 @@ export interface StagedOrderAddPaymentAction {
|
|
|
762
773
|
* Produces the [Return Info Added](ctp:api:type:ReturnInfoAddedMessage) Message.
|
|
763
774
|
*
|
|
764
775
|
*/
|
|
765
|
-
export interface StagedOrderAddReturnInfoAction {
|
|
776
|
+
export interface StagedOrderAddReturnInfoAction extends IStagedOrderUpdateAction {
|
|
766
777
|
readonly action: 'addReturnInfo';
|
|
767
778
|
/**
|
|
768
779
|
* Value to set.
|
|
@@ -789,7 +800,7 @@ export interface StagedOrderAddReturnInfoAction {
|
|
|
789
800
|
* Adds all [LineItems](ctp:api:type:LineItem) of a [ShoppingList](ctp:api:type:ShoppingList) to the Cart.
|
|
790
801
|
*
|
|
791
802
|
*/
|
|
792
|
-
export interface StagedOrderAddShoppingListAction {
|
|
803
|
+
export interface StagedOrderAddShoppingListAction extends IStagedOrderUpdateAction {
|
|
793
804
|
readonly action: 'addShoppingList';
|
|
794
805
|
/**
|
|
795
806
|
* Shopping List that contains the Line Items to be added.
|
|
@@ -812,7 +823,7 @@ export interface StagedOrderAddShoppingListAction {
|
|
|
812
823
|
*/
|
|
813
824
|
readonly supplyChannel?: ChannelResourceIdentifier;
|
|
814
825
|
}
|
|
815
|
-
export interface StagedOrderChangeCustomLineItemMoneyAction {
|
|
826
|
+
export interface StagedOrderChangeCustomLineItemMoneyAction extends IStagedOrderUpdateAction {
|
|
816
827
|
readonly action: 'changeCustomLineItemMoney';
|
|
817
828
|
/**
|
|
818
829
|
* `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
|
|
@@ -841,7 +852,7 @@ export interface StagedOrderChangeCustomLineItemMoneyAction {
|
|
|
841
852
|
* To change the Custom Line Item quantity and shipping details together, use this update action in combination with the [Set CustomLineItem ShippingDetails](ctp:api:type:StagedOrderSetCustomLineItemShippingDetailsAction) update action in a single Order update command.
|
|
842
853
|
*
|
|
843
854
|
*/
|
|
844
|
-
export interface StagedOrderChangeCustomLineItemQuantityAction {
|
|
855
|
+
export interface StagedOrderChangeCustomLineItemQuantityAction extends IStagedOrderUpdateAction {
|
|
845
856
|
readonly action: 'changeCustomLineItemQuantity';
|
|
846
857
|
/**
|
|
847
858
|
* `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
|
|
@@ -871,7 +882,7 @@ export interface StagedOrderChangeCustomLineItemQuantityAction {
|
|
|
871
882
|
* The [LineItem](ctp:api:type:LineItem) price is updated as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
|
|
872
883
|
*
|
|
873
884
|
*/
|
|
874
|
-
export interface StagedOrderChangeLineItemQuantityAction {
|
|
885
|
+
export interface StagedOrderChangeLineItemQuantityAction extends IStagedOrderUpdateAction {
|
|
875
886
|
readonly action: 'changeLineItemQuantity';
|
|
876
887
|
/**
|
|
877
888
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -913,7 +924,7 @@ export interface StagedOrderChangeLineItemQuantityAction {
|
|
|
913
924
|
* Produces the [Order State Changed](ctp:api:type:OrderStateChangedMessage) Message.
|
|
914
925
|
*
|
|
915
926
|
*/
|
|
916
|
-
export interface StagedOrderChangeOrderStateAction {
|
|
927
|
+
export interface StagedOrderChangeOrderStateAction extends IStagedOrderUpdateAction {
|
|
917
928
|
readonly action: 'changeOrderState';
|
|
918
929
|
/**
|
|
919
930
|
* New status of the Order.
|
|
@@ -926,7 +937,7 @@ export interface StagedOrderChangeOrderStateAction {
|
|
|
926
937
|
* Produces the [Order Payment State Changed](ctp:api:type:OrderPaymentStateChangedMessage) Message.
|
|
927
938
|
*
|
|
928
939
|
*/
|
|
929
|
-
export interface StagedOrderChangePaymentStateAction {
|
|
940
|
+
export interface StagedOrderChangePaymentStateAction extends IStagedOrderUpdateAction {
|
|
930
941
|
readonly action: 'changePaymentState';
|
|
931
942
|
/**
|
|
932
943
|
* New payment status of the Order.
|
|
@@ -939,7 +950,7 @@ export interface StagedOrderChangePaymentStateAction {
|
|
|
939
950
|
* Produces the [Order Shipment State Changed](ctp:api:type:OrderShipmentStateChangedMessage) Message.
|
|
940
951
|
*
|
|
941
952
|
*/
|
|
942
|
-
export interface StagedOrderChangeShipmentStateAction {
|
|
953
|
+
export interface StagedOrderChangeShipmentStateAction extends IStagedOrderUpdateAction {
|
|
943
954
|
readonly action: 'changeShipmentState';
|
|
944
955
|
/**
|
|
945
956
|
* New shipment status of the Order.
|
|
@@ -952,7 +963,7 @@ export interface StagedOrderChangeShipmentStateAction {
|
|
|
952
963
|
* Changing the tax calculation mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation).
|
|
953
964
|
*
|
|
954
965
|
*/
|
|
955
|
-
export interface StagedOrderChangeTaxCalculationModeAction {
|
|
966
|
+
export interface StagedOrderChangeTaxCalculationModeAction extends IStagedOrderUpdateAction {
|
|
956
967
|
readonly action: 'changeTaxCalculationMode';
|
|
957
968
|
/**
|
|
958
969
|
* New value to set.
|
|
@@ -966,7 +977,7 @@ export interface StagedOrderChangeTaxCalculationModeAction {
|
|
|
966
977
|
* - When set to `Platform`, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's `shippingAddress`.
|
|
967
978
|
*
|
|
968
979
|
*/
|
|
969
|
-
export interface StagedOrderChangeTaxModeAction {
|
|
980
|
+
export interface StagedOrderChangeTaxModeAction extends IStagedOrderUpdateAction {
|
|
970
981
|
readonly action: 'changeTaxMode';
|
|
971
982
|
/**
|
|
972
983
|
* The new TaxMode.
|
|
@@ -979,7 +990,7 @@ export interface StagedOrderChangeTaxModeAction {
|
|
|
979
990
|
* Changing the tax rounding mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation).
|
|
980
991
|
*
|
|
981
992
|
*/
|
|
982
|
-
export interface StagedOrderChangeTaxRoundingModeAction {
|
|
993
|
+
export interface StagedOrderChangeTaxRoundingModeAction extends IStagedOrderUpdateAction {
|
|
983
994
|
readonly action: 'changeTaxRoundingMode';
|
|
984
995
|
/**
|
|
985
996
|
* New value to set.
|
|
@@ -993,7 +1004,7 @@ export interface StagedOrderChangeTaxRoundingModeAction {
|
|
|
993
1004
|
* The `quantity` of the [ItemStates](ctp:api:type:ItemState) must match the sum of all Custom Line Item states' quantities.
|
|
994
1005
|
*
|
|
995
1006
|
*/
|
|
996
|
-
export interface StagedOrderImportCustomLineItemStateAction {
|
|
1007
|
+
export interface StagedOrderImportCustomLineItemStateAction extends IStagedOrderUpdateAction {
|
|
997
1008
|
readonly action: 'importCustomLineItemState';
|
|
998
1009
|
/**
|
|
999
1010
|
* `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
|
|
@@ -1019,7 +1030,7 @@ export interface StagedOrderImportCustomLineItemStateAction {
|
|
|
1019
1030
|
* The `quantity` in the [ItemStates](ctp:api:type:ItemState) must match the sum of all Line Item states' quantities.
|
|
1020
1031
|
*
|
|
1021
1032
|
*/
|
|
1022
|
-
export interface StagedOrderImportLineItemStateAction {
|
|
1033
|
+
export interface StagedOrderImportLineItemStateAction extends IStagedOrderUpdateAction {
|
|
1023
1034
|
readonly action: 'importLineItemState';
|
|
1024
1035
|
/**
|
|
1025
1036
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -1046,7 +1057,7 @@ export interface StagedOrderImportLineItemStateAction {
|
|
|
1046
1057
|
* If `shippingDetails` must be partially removed, use the [Change CustomLineItem Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action.
|
|
1047
1058
|
*
|
|
1048
1059
|
*/
|
|
1049
|
-
export interface StagedOrderRemoveCustomLineItemAction {
|
|
1060
|
+
export interface StagedOrderRemoveCustomLineItemAction extends IStagedOrderUpdateAction {
|
|
1050
1061
|
readonly action: 'removeCustomLineItem';
|
|
1051
1062
|
/**
|
|
1052
1063
|
* `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
|
|
@@ -1065,7 +1076,7 @@ export interface StagedOrderRemoveCustomLineItemAction {
|
|
|
1065
1076
|
* Produces the [DeliveryRemoved](ctp:api:type:DeliveryRemovedMessage) Message.
|
|
1066
1077
|
*
|
|
1067
1078
|
*/
|
|
1068
|
-
export interface StagedOrderRemoveDeliveryAction {
|
|
1079
|
+
export interface StagedOrderRemoveDeliveryAction extends IStagedOrderUpdateAction {
|
|
1069
1080
|
readonly action: 'removeDelivery';
|
|
1070
1081
|
/**
|
|
1071
1082
|
* `id` of an existing [Delivery](ctp:api:type:Delivery).
|
|
@@ -1084,7 +1095,7 @@ export interface StagedOrderRemoveDeliveryAction {
|
|
|
1084
1095
|
*/
|
|
1085
1096
|
readonly deliveryKey?: string;
|
|
1086
1097
|
}
|
|
1087
|
-
export interface StagedOrderRemoveDiscountCodeAction {
|
|
1098
|
+
export interface StagedOrderRemoveDiscountCodeAction extends IStagedOrderUpdateAction {
|
|
1088
1099
|
readonly action: 'removeDiscountCode';
|
|
1089
1100
|
/**
|
|
1090
1101
|
* Discount Code to remove from the Cart.
|
|
@@ -1097,7 +1108,7 @@ export interface StagedOrderRemoveDiscountCodeAction {
|
|
|
1097
1108
|
* An address can only be removed if it is not referenced in any [ItemShippingTarget](ctp:api:type:ItemShippingTarget) of the Cart.
|
|
1098
1109
|
*
|
|
1099
1110
|
*/
|
|
1100
|
-
export interface StagedOrderRemoveItemShippingAddressAction {
|
|
1111
|
+
export interface StagedOrderRemoveItemShippingAddressAction extends IStagedOrderUpdateAction {
|
|
1101
1112
|
readonly action: 'removeItemShippingAddress';
|
|
1102
1113
|
/**
|
|
1103
1114
|
* `key` of the Address to remove from `itemShippingAddresses`.
|
|
@@ -1110,7 +1121,7 @@ export interface StagedOrderRemoveItemShippingAddressAction {
|
|
|
1110
1121
|
* The [LineItem](ctp:api:type:LineItem) price is updated as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
|
|
1111
1122
|
*
|
|
1112
1123
|
*/
|
|
1113
|
-
export interface StagedOrderRemoveLineItemAction {
|
|
1124
|
+
export interface StagedOrderRemoveLineItemAction extends IStagedOrderUpdateAction {
|
|
1114
1125
|
readonly action: 'removeLineItem';
|
|
1115
1126
|
/**
|
|
1116
1127
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -1154,7 +1165,7 @@ export interface StagedOrderRemoveLineItemAction {
|
|
|
1154
1165
|
* Produces the [ParcelRemovedFromDelivery](ctp:api:type:ParcelRemovedFromDeliveryMessage) Message.
|
|
1155
1166
|
*
|
|
1156
1167
|
*/
|
|
1157
|
-
export interface StagedOrderRemoveParcelFromDeliveryAction {
|
|
1168
|
+
export interface StagedOrderRemoveParcelFromDeliveryAction extends IStagedOrderUpdateAction {
|
|
1158
1169
|
readonly action: 'removeParcelFromDelivery';
|
|
1159
1170
|
/**
|
|
1160
1171
|
* `id` of an existing [Parcel](ctp:api:type:Parcel).
|
|
@@ -1173,7 +1184,7 @@ export interface StagedOrderRemoveParcelFromDeliveryAction {
|
|
|
1173
1184
|
*/
|
|
1174
1185
|
readonly parcelKey?: string;
|
|
1175
1186
|
}
|
|
1176
|
-
export interface StagedOrderRemovePaymentAction {
|
|
1187
|
+
export interface StagedOrderRemovePaymentAction extends IStagedOrderUpdateAction {
|
|
1177
1188
|
readonly action: 'removePayment';
|
|
1178
1189
|
/**
|
|
1179
1190
|
* Payment to remove from the [PaymentInfo](ctp:api:type:PaymentInfo).
|
|
@@ -1188,7 +1199,7 @@ export interface StagedOrderRemovePaymentAction {
|
|
|
1188
1199
|
* Produces the [Order Billing Address Set](ctp:api:type:OrderBillingAddressSetMessage) Message.
|
|
1189
1200
|
*
|
|
1190
1201
|
*/
|
|
1191
|
-
export interface StagedOrderSetBillingAddressAction {
|
|
1202
|
+
export interface StagedOrderSetBillingAddressAction extends IStagedOrderUpdateAction {
|
|
1192
1203
|
readonly action: 'setBillingAddress';
|
|
1193
1204
|
/**
|
|
1194
1205
|
* Value to set.
|
|
@@ -1198,7 +1209,7 @@ export interface StagedOrderSetBillingAddressAction {
|
|
|
1198
1209
|
*/
|
|
1199
1210
|
readonly address?: _BaseAddress;
|
|
1200
1211
|
}
|
|
1201
|
-
export interface StagedOrderSetBillingAddressCustomFieldAction {
|
|
1212
|
+
export interface StagedOrderSetBillingAddressCustomFieldAction extends IStagedOrderUpdateAction {
|
|
1202
1213
|
readonly action: 'setBillingAddressCustomField';
|
|
1203
1214
|
/**
|
|
1204
1215
|
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
@@ -1215,7 +1226,7 @@ export interface StagedOrderSetBillingAddressCustomFieldAction {
|
|
|
1215
1226
|
*/
|
|
1216
1227
|
readonly value?: any;
|
|
1217
1228
|
}
|
|
1218
|
-
export interface StagedOrderSetBillingAddressCustomTypeAction {
|
|
1229
|
+
export interface StagedOrderSetBillingAddressCustomTypeAction extends IStagedOrderUpdateAction {
|
|
1219
1230
|
readonly action: 'setBillingAddressCustomType';
|
|
1220
1231
|
/**
|
|
1221
1232
|
* Defines the [Type](ctp:api:type:Type) that extends the `billingAddress` with [Custom Fields](/../api/projects/custom-fields).
|
|
@@ -1235,7 +1246,7 @@ export interface StagedOrderSetBillingAddressCustomTypeAction {
|
|
|
1235
1246
|
* Setting the country can lead to changes in the [LineItem](ctp:api:type:LineItem) prices.
|
|
1236
1247
|
*
|
|
1237
1248
|
*/
|
|
1238
|
-
export interface StagedOrderSetCountryAction {
|
|
1249
|
+
export interface StagedOrderSetCountryAction extends IStagedOrderUpdateAction {
|
|
1239
1250
|
readonly action: 'setCountry';
|
|
1240
1251
|
/**
|
|
1241
1252
|
* Value to set.
|
|
@@ -1248,7 +1259,7 @@ export interface StagedOrderSetCountryAction {
|
|
|
1248
1259
|
*/
|
|
1249
1260
|
readonly country?: string;
|
|
1250
1261
|
}
|
|
1251
|
-
export interface StagedOrderSetCustomFieldAction {
|
|
1262
|
+
export interface StagedOrderSetCustomFieldAction extends IStagedOrderUpdateAction {
|
|
1252
1263
|
readonly action: 'setCustomField';
|
|
1253
1264
|
/**
|
|
1254
1265
|
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
@@ -1265,7 +1276,7 @@ export interface StagedOrderSetCustomFieldAction {
|
|
|
1265
1276
|
*/
|
|
1266
1277
|
readonly value?: any;
|
|
1267
1278
|
}
|
|
1268
|
-
export interface StagedOrderSetCustomLineItemCustomFieldAction {
|
|
1279
|
+
export interface StagedOrderSetCustomLineItemCustomFieldAction extends IStagedOrderUpdateAction {
|
|
1269
1280
|
readonly action: 'setCustomLineItemCustomField';
|
|
1270
1281
|
/**
|
|
1271
1282
|
* `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
|
|
@@ -1294,7 +1305,7 @@ export interface StagedOrderSetCustomLineItemCustomFieldAction {
|
|
|
1294
1305
|
*/
|
|
1295
1306
|
readonly value?: any;
|
|
1296
1307
|
}
|
|
1297
|
-
export interface StagedOrderSetCustomLineItemCustomTypeAction {
|
|
1308
|
+
export interface StagedOrderSetCustomLineItemCustomTypeAction extends IStagedOrderUpdateAction {
|
|
1298
1309
|
readonly action: 'setCustomLineItemCustomType';
|
|
1299
1310
|
/**
|
|
1300
1311
|
* `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
|
|
@@ -1322,7 +1333,7 @@ export interface StagedOrderSetCustomLineItemCustomTypeAction {
|
|
|
1322
1333
|
*/
|
|
1323
1334
|
readonly fields?: FieldContainer;
|
|
1324
1335
|
}
|
|
1325
|
-
export interface StagedOrderSetCustomLineItemShippingDetailsAction {
|
|
1336
|
+
export interface StagedOrderSetCustomLineItemShippingDetailsAction extends IStagedOrderUpdateAction {
|
|
1326
1337
|
readonly action: 'setCustomLineItemShippingDetails';
|
|
1327
1338
|
/**
|
|
1328
1339
|
* `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
|
|
@@ -1348,7 +1359,7 @@ export interface StagedOrderSetCustomLineItemShippingDetailsAction {
|
|
|
1348
1359
|
* Can be used if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode).
|
|
1349
1360
|
*
|
|
1350
1361
|
*/
|
|
1351
|
-
export interface StagedOrderSetCustomLineItemTaxAmountAction {
|
|
1362
|
+
export interface StagedOrderSetCustomLineItemTaxAmountAction extends IStagedOrderUpdateAction {
|
|
1352
1363
|
readonly action: 'setCustomLineItemTaxAmount';
|
|
1353
1364
|
/**
|
|
1354
1365
|
* `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
|
|
@@ -1381,7 +1392,7 @@ export interface StagedOrderSetCustomLineItemTaxAmountAction {
|
|
|
1381
1392
|
* Can be used if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
|
|
1382
1393
|
*
|
|
1383
1394
|
*/
|
|
1384
|
-
export interface StagedOrderSetCustomLineItemTaxRateAction {
|
|
1395
|
+
export interface StagedOrderSetCustomLineItemTaxRateAction extends IStagedOrderUpdateAction {
|
|
1385
1396
|
readonly action: 'setCustomLineItemTaxRate';
|
|
1386
1397
|
/**
|
|
1387
1398
|
* `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
|
|
@@ -1416,7 +1427,7 @@ export interface StagedOrderSetCustomLineItemTaxRateAction {
|
|
|
1416
1427
|
* To unset a custom Shipping Method on a Cart, use the [Set ShippingMethod](ctp:api:type:StagedOrderSetShippingMethodAction) update action without the `shippingMethod` field instead.
|
|
1417
1428
|
*
|
|
1418
1429
|
*/
|
|
1419
|
-
export interface StagedOrderSetCustomShippingMethodAction {
|
|
1430
|
+
export interface StagedOrderSetCustomShippingMethodAction extends IStagedOrderUpdateAction {
|
|
1420
1431
|
readonly action: 'setCustomShippingMethod';
|
|
1421
1432
|
/**
|
|
1422
1433
|
* Name of the custom Shipping Method.
|
|
@@ -1442,8 +1453,14 @@ export interface StagedOrderSetCustomShippingMethodAction {
|
|
|
1442
1453
|
*
|
|
1443
1454
|
*/
|
|
1444
1455
|
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
1456
|
+
/**
|
|
1457
|
+
* Custom Fields for the custom Shipping Method.
|
|
1458
|
+
*
|
|
1459
|
+
*
|
|
1460
|
+
*/
|
|
1461
|
+
readonly custom?: CustomFieldsDraft;
|
|
1445
1462
|
}
|
|
1446
|
-
export interface StagedOrderSetCustomTypeAction {
|
|
1463
|
+
export interface StagedOrderSetCustomTypeAction extends IStagedOrderUpdateAction {
|
|
1447
1464
|
readonly action: 'setCustomType';
|
|
1448
1465
|
/**
|
|
1449
1466
|
* Defines the [Type](ctp:api:type:Type) that extends the Order Edit with [Custom Fields](/../api/projects/custom-fields).
|
|
@@ -1465,7 +1482,7 @@ export interface StagedOrderSetCustomTypeAction {
|
|
|
1465
1482
|
* Produces the [Order Customer Email Set](ctp:api:type:OrderCustomerEmailSetMessage) Message.
|
|
1466
1483
|
*
|
|
1467
1484
|
*/
|
|
1468
|
-
export interface StagedOrderSetCustomerEmailAction {
|
|
1485
|
+
export interface StagedOrderSetCustomerEmailAction extends IStagedOrderUpdateAction {
|
|
1469
1486
|
readonly action: 'setCustomerEmail';
|
|
1470
1487
|
/**
|
|
1471
1488
|
* Value to set.
|
|
@@ -1479,10 +1496,10 @@ export interface StagedOrderSetCustomerEmailAction {
|
|
|
1479
1496
|
* This update action can only be used if a Customer is not assigned to a Cart.
|
|
1480
1497
|
* If a Customer is already assigned, the Cart uses the Customer Group of the assigned Customer.
|
|
1481
1498
|
*
|
|
1482
|
-
* To reflect the new Customer Group, this update action can result in [updates to the Cart](/../carts-orders-overview#cart-updates). When this occurs, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
|
|
1499
|
+
* To reflect the new Customer Group, this update action can result in [updates to the Cart](/../api/carts-orders-overview#cart-updates). When this occurs, the following errors can be returned: [MatchingPriceNotFound](ctp:api:type:MatchingPriceNotFoundError) and [MissingTaxRateForCountry](ctp:api:type:MissingTaxRateForCountryError).
|
|
1483
1500
|
*
|
|
1484
1501
|
*/
|
|
1485
|
-
export interface StagedOrderSetCustomerGroupAction {
|
|
1502
|
+
export interface StagedOrderSetCustomerGroupAction extends IStagedOrderUpdateAction {
|
|
1486
1503
|
readonly action: 'setCustomerGroup';
|
|
1487
1504
|
/**
|
|
1488
1505
|
* Value to set.
|
|
@@ -1499,7 +1516,7 @@ export interface StagedOrderSetCustomerGroupAction {
|
|
|
1499
1516
|
* Produces the [OrderCustomerSet](ctp:api:type:OrderCustomerSetMessage) Message.
|
|
1500
1517
|
*
|
|
1501
1518
|
*/
|
|
1502
|
-
export interface StagedOrderSetCustomerIdAction {
|
|
1519
|
+
export interface StagedOrderSetCustomerIdAction extends IStagedOrderUpdateAction {
|
|
1503
1520
|
readonly action: 'setCustomerId';
|
|
1504
1521
|
/**
|
|
1505
1522
|
* `id` of an existing [Customer](ctp:api:type:Customer).
|
|
@@ -1513,7 +1530,7 @@ export interface StagedOrderSetCustomerIdAction {
|
|
|
1513
1530
|
* Produces the [DeliveryAddressSet](ctp:api:type:DeliveryAddressSetMessage) Message.
|
|
1514
1531
|
*
|
|
1515
1532
|
*/
|
|
1516
|
-
export interface StagedOrderSetDeliveryAddressAction {
|
|
1533
|
+
export interface StagedOrderSetDeliveryAddressAction extends IStagedOrderUpdateAction {
|
|
1517
1534
|
readonly action: 'setDeliveryAddress';
|
|
1518
1535
|
/**
|
|
1519
1536
|
* `id` of an existing [Delivery](ctp:api:type:Delivery).
|
|
@@ -1539,7 +1556,7 @@ export interface StagedOrderSetDeliveryAddressAction {
|
|
|
1539
1556
|
*/
|
|
1540
1557
|
readonly address?: _BaseAddress;
|
|
1541
1558
|
}
|
|
1542
|
-
export interface StagedOrderSetDeliveryAddressCustomFieldAction {
|
|
1559
|
+
export interface StagedOrderSetDeliveryAddressCustomFieldAction extends IStagedOrderUpdateAction {
|
|
1543
1560
|
readonly action: 'setDeliveryAddressCustomField';
|
|
1544
1561
|
/**
|
|
1545
1562
|
* `id` of an existing [Delivery](ctp:api:type:Delivery).
|
|
@@ -1572,7 +1589,7 @@ export interface StagedOrderSetDeliveryAddressCustomFieldAction {
|
|
|
1572
1589
|
*/
|
|
1573
1590
|
readonly value?: any;
|
|
1574
1591
|
}
|
|
1575
|
-
export interface StagedOrderSetDeliveryAddressCustomTypeAction {
|
|
1592
|
+
export interface StagedOrderSetDeliveryAddressCustomTypeAction extends IStagedOrderUpdateAction {
|
|
1576
1593
|
readonly action: 'setDeliveryAddressCustomType';
|
|
1577
1594
|
/**
|
|
1578
1595
|
* `id` of an existing [Delivery](ctp:api:type:Delivery).
|
|
@@ -1604,7 +1621,7 @@ export interface StagedOrderSetDeliveryAddressCustomTypeAction {
|
|
|
1604
1621
|
*/
|
|
1605
1622
|
readonly fields?: FieldContainer;
|
|
1606
1623
|
}
|
|
1607
|
-
export interface StagedOrderSetDeliveryCustomFieldAction {
|
|
1624
|
+
export interface StagedOrderSetDeliveryCustomFieldAction extends IStagedOrderUpdateAction {
|
|
1608
1625
|
readonly action: 'setDeliveryCustomField';
|
|
1609
1626
|
/**
|
|
1610
1627
|
* `id` of an existing [Delivery](ctp:api:type:Delivery).
|
|
@@ -1637,7 +1654,7 @@ export interface StagedOrderSetDeliveryCustomFieldAction {
|
|
|
1637
1654
|
*/
|
|
1638
1655
|
readonly value?: any;
|
|
1639
1656
|
}
|
|
1640
|
-
export interface StagedOrderSetDeliveryCustomTypeAction {
|
|
1657
|
+
export interface StagedOrderSetDeliveryCustomTypeAction extends IStagedOrderUpdateAction {
|
|
1641
1658
|
readonly action: 'setDeliveryCustomType';
|
|
1642
1659
|
/**
|
|
1643
1660
|
* `id` of an existing [Delivery](ctp:api:type:Delivery).
|
|
@@ -1673,7 +1690,7 @@ export interface StagedOrderSetDeliveryCustomTypeAction {
|
|
|
1673
1690
|
* Produces the [Delivery Items Updated](ctp:api:type:DeliveryItemsUpdatedMessage) Message.
|
|
1674
1691
|
*
|
|
1675
1692
|
*/
|
|
1676
|
-
export interface StagedOrderSetDeliveryItemsAction {
|
|
1693
|
+
export interface StagedOrderSetDeliveryItemsAction extends IStagedOrderUpdateAction {
|
|
1677
1694
|
readonly action: 'setDeliveryItems';
|
|
1678
1695
|
/**
|
|
1679
1696
|
* `id` of an existing [Delivery](ctp:api:type:Delivery).
|
|
@@ -1704,7 +1721,7 @@ export interface StagedOrderSetDeliveryItemsAction {
|
|
|
1704
1721
|
* Either a Discount Code or a Direct Discount can exist on a Order at the same time.
|
|
1705
1722
|
*
|
|
1706
1723
|
*/
|
|
1707
|
-
export interface StagedOrderSetDirectDiscountsAction {
|
|
1724
|
+
export interface StagedOrderSetDirectDiscountsAction extends IStagedOrderUpdateAction {
|
|
1708
1725
|
readonly action: 'setDirectDiscounts';
|
|
1709
1726
|
/**
|
|
1710
1727
|
* - If set, all existing Direct Discounts are replaced.
|
|
@@ -1715,7 +1732,7 @@ export interface StagedOrderSetDirectDiscountsAction {
|
|
|
1715
1732
|
*/
|
|
1716
1733
|
readonly discounts: DirectDiscountDraft[];
|
|
1717
1734
|
}
|
|
1718
|
-
export interface StagedOrderSetItemShippingAddressCustomFieldAction {
|
|
1735
|
+
export interface StagedOrderSetItemShippingAddressCustomFieldAction extends IStagedOrderUpdateAction {
|
|
1719
1736
|
readonly action: 'setItemShippingAddressCustomField';
|
|
1720
1737
|
/**
|
|
1721
1738
|
* `key` of the [Address](ctp:api:type:Address) in `itemShippingAddresses`.
|
|
@@ -1738,7 +1755,7 @@ export interface StagedOrderSetItemShippingAddressCustomFieldAction {
|
|
|
1738
1755
|
*/
|
|
1739
1756
|
readonly value?: any;
|
|
1740
1757
|
}
|
|
1741
|
-
export interface StagedOrderSetItemShippingAddressCustomTypeAction {
|
|
1758
|
+
export interface StagedOrderSetItemShippingAddressCustomTypeAction extends IStagedOrderUpdateAction {
|
|
1742
1759
|
readonly action: 'setItemShippingAddressCustomType';
|
|
1743
1760
|
/**
|
|
1744
1761
|
* `key` of the [Address](ctp:api:type:Address) in `itemShippingAddresses`.
|
|
@@ -1760,7 +1777,7 @@ export interface StagedOrderSetItemShippingAddressCustomTypeAction {
|
|
|
1760
1777
|
*/
|
|
1761
1778
|
readonly fields?: FieldContainer;
|
|
1762
1779
|
}
|
|
1763
|
-
export interface StagedOrderSetLineItemCustomFieldAction {
|
|
1780
|
+
export interface StagedOrderSetLineItemCustomFieldAction extends IStagedOrderUpdateAction {
|
|
1764
1781
|
readonly action: 'setLineItemCustomField';
|
|
1765
1782
|
/**
|
|
1766
1783
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -1789,7 +1806,7 @@ export interface StagedOrderSetLineItemCustomFieldAction {
|
|
|
1789
1806
|
*/
|
|
1790
1807
|
readonly value?: any;
|
|
1791
1808
|
}
|
|
1792
|
-
export interface StagedOrderSetLineItemCustomTypeAction {
|
|
1809
|
+
export interface StagedOrderSetLineItemCustomTypeAction extends IStagedOrderUpdateAction {
|
|
1793
1810
|
readonly action: 'setLineItemCustomType';
|
|
1794
1811
|
/**
|
|
1795
1812
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -1823,7 +1840,7 @@ export interface StagedOrderSetLineItemCustomTypeAction {
|
|
|
1823
1840
|
* Produces the [OrderLineItemDistributionChannelSet](ctp:api:type:OrderLineItemDistributionChannelSetMessage) Message.
|
|
1824
1841
|
*
|
|
1825
1842
|
*/
|
|
1826
|
-
export interface StagedOrderSetLineItemDistributionChannelAction {
|
|
1843
|
+
export interface StagedOrderSetLineItemDistributionChannelAction extends IStagedOrderUpdateAction {
|
|
1827
1844
|
readonly action: 'setLineItemDistributionChannel';
|
|
1828
1845
|
/**
|
|
1829
1846
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -1850,7 +1867,7 @@ export interface StagedOrderSetLineItemDistributionChannelAction {
|
|
|
1850
1867
|
* Sets the [LineItem](ctp:api:type:LineItem) `price` and changes the `priceMode` to `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
|
|
1851
1868
|
*
|
|
1852
1869
|
*/
|
|
1853
|
-
export interface StagedOrderSetLineItemPriceAction {
|
|
1870
|
+
export interface StagedOrderSetLineItemPriceAction extends IStagedOrderUpdateAction {
|
|
1854
1871
|
readonly action: 'setLineItemPrice';
|
|
1855
1872
|
/**
|
|
1856
1873
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -1872,7 +1889,7 @@ export interface StagedOrderSetLineItemPriceAction {
|
|
|
1872
1889
|
*/
|
|
1873
1890
|
readonly externalPrice?: _Money;
|
|
1874
1891
|
}
|
|
1875
|
-
export interface StagedOrderSetLineItemShippingDetailsAction {
|
|
1892
|
+
export interface StagedOrderSetLineItemShippingDetailsAction extends IStagedOrderUpdateAction {
|
|
1876
1893
|
readonly action: 'setLineItemShippingDetails';
|
|
1877
1894
|
/**
|
|
1878
1895
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -1898,7 +1915,7 @@ export interface StagedOrderSetLineItemShippingDetailsAction {
|
|
|
1898
1915
|
* Can be used if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode). This update action sets the `taxedPrice` and `taxRate` on a Line Item and must be used after any price-affecting change occurs.
|
|
1899
1916
|
*
|
|
1900
1917
|
*/
|
|
1901
|
-
export interface StagedOrderSetLineItemTaxAmountAction {
|
|
1918
|
+
export interface StagedOrderSetLineItemTaxAmountAction extends IStagedOrderUpdateAction {
|
|
1902
1919
|
readonly action: 'setLineItemTaxAmount';
|
|
1903
1920
|
/**
|
|
1904
1921
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -1931,7 +1948,7 @@ export interface StagedOrderSetLineItemTaxAmountAction {
|
|
|
1931
1948
|
* Can be used if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
|
|
1932
1949
|
*
|
|
1933
1950
|
*/
|
|
1934
|
-
export interface StagedOrderSetLineItemTaxRateAction {
|
|
1951
|
+
export interface StagedOrderSetLineItemTaxRateAction extends IStagedOrderUpdateAction {
|
|
1935
1952
|
readonly action: 'setLineItemTaxRate';
|
|
1936
1953
|
/**
|
|
1937
1954
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -1964,7 +1981,7 @@ export interface StagedOrderSetLineItemTaxRateAction {
|
|
|
1964
1981
|
* Sets the [LineItem](ctp:api:type:LineItem) `totalPrice` and `price`, and changes the `priceMode` to `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
|
|
1965
1982
|
*
|
|
1966
1983
|
*/
|
|
1967
|
-
export interface StagedOrderSetLineItemTotalPriceAction {
|
|
1984
|
+
export interface StagedOrderSetLineItemTotalPriceAction extends IStagedOrderUpdateAction {
|
|
1968
1985
|
readonly action: 'setLineItemTotalPrice';
|
|
1969
1986
|
/**
|
|
1970
1987
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -1986,7 +2003,7 @@ export interface StagedOrderSetLineItemTotalPriceAction {
|
|
|
1986
2003
|
*/
|
|
1987
2004
|
readonly externalTotalPrice?: ExternalLineItemTotalPrice;
|
|
1988
2005
|
}
|
|
1989
|
-
export interface StagedOrderSetLocaleAction {
|
|
2006
|
+
export interface StagedOrderSetLocaleAction extends IStagedOrderUpdateAction {
|
|
1990
2007
|
readonly action: 'setLocale';
|
|
1991
2008
|
/**
|
|
1992
2009
|
* Value to set.
|
|
@@ -1997,7 +2014,7 @@ export interface StagedOrderSetLocaleAction {
|
|
|
1997
2014
|
*/
|
|
1998
2015
|
readonly locale?: string;
|
|
1999
2016
|
}
|
|
2000
|
-
export interface StagedOrderSetOrderNumberAction {
|
|
2017
|
+
export interface StagedOrderSetOrderNumberAction extends IStagedOrderUpdateAction {
|
|
2001
2018
|
readonly action: 'setOrderNumber';
|
|
2002
2019
|
/**
|
|
2003
2020
|
* Value to set. Must be unique across a Project.
|
|
@@ -2011,7 +2028,7 @@ export interface StagedOrderSetOrderNumberAction {
|
|
|
2011
2028
|
* Updates the total tax amount of the Order if it has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode).
|
|
2012
2029
|
*
|
|
2013
2030
|
*/
|
|
2014
|
-
export interface StagedOrderSetOrderTotalTaxAction {
|
|
2031
|
+
export interface StagedOrderSetOrderTotalTaxAction extends IStagedOrderUpdateAction {
|
|
2015
2032
|
readonly action: 'setOrderTotalTax';
|
|
2016
2033
|
/**
|
|
2017
2034
|
* Total gross amount of the Order (totalNet + taxes).
|
|
@@ -2026,7 +2043,7 @@ export interface StagedOrderSetOrderTotalTaxAction {
|
|
|
2026
2043
|
*/
|
|
2027
2044
|
readonly externalTaxPortions?: TaxPortionDraft[];
|
|
2028
2045
|
}
|
|
2029
|
-
export interface StagedOrderSetParcelCustomFieldAction {
|
|
2046
|
+
export interface StagedOrderSetParcelCustomFieldAction extends IStagedOrderUpdateAction {
|
|
2030
2047
|
readonly action: 'setParcelCustomField';
|
|
2031
2048
|
/**
|
|
2032
2049
|
* `id` of an existing [Parcel](ctp:api:type:Parcel).
|
|
@@ -2059,7 +2076,7 @@ export interface StagedOrderSetParcelCustomFieldAction {
|
|
|
2059
2076
|
*/
|
|
2060
2077
|
readonly value?: any;
|
|
2061
2078
|
}
|
|
2062
|
-
export interface StagedOrderSetParcelCustomTypeAction {
|
|
2079
|
+
export interface StagedOrderSetParcelCustomTypeAction extends IStagedOrderUpdateAction {
|
|
2063
2080
|
readonly action: 'setParcelCustomType';
|
|
2064
2081
|
/**
|
|
2065
2082
|
* `id` of an existing [Parcel](ctp:api:type:Parcel).
|
|
@@ -2095,7 +2112,7 @@ export interface StagedOrderSetParcelCustomTypeAction {
|
|
|
2095
2112
|
* Produces the [ParcelItemsUpdated](ctp:api:type:ParcelItemsUpdatedMessage) Message.
|
|
2096
2113
|
*
|
|
2097
2114
|
*/
|
|
2098
|
-
export interface StagedOrderSetParcelItemsAction {
|
|
2115
|
+
export interface StagedOrderSetParcelItemsAction extends IStagedOrderUpdateAction {
|
|
2099
2116
|
readonly action: 'setParcelItems';
|
|
2100
2117
|
/**
|
|
2101
2118
|
* `id` of an existing [Parcel](ctp:api:type:Parcel).
|
|
@@ -2125,7 +2142,7 @@ export interface StagedOrderSetParcelItemsAction {
|
|
|
2125
2142
|
* Produces the [ParcelMeasurementsUpdated](ctp:api:type:ParcelMeasurementsUpdatedMessage) Message.
|
|
2126
2143
|
*
|
|
2127
2144
|
*/
|
|
2128
|
-
export interface StagedOrderSetParcelMeasurementsAction {
|
|
2145
|
+
export interface StagedOrderSetParcelMeasurementsAction extends IStagedOrderUpdateAction {
|
|
2129
2146
|
readonly action: 'setParcelMeasurements';
|
|
2130
2147
|
/**
|
|
2131
2148
|
* `id` of an existing [Parcel](ctp:api:type:Parcel).
|
|
@@ -2155,7 +2172,7 @@ export interface StagedOrderSetParcelMeasurementsAction {
|
|
|
2155
2172
|
* Produces the [ParcelTrackingDataUpdated](ctp:api:type:ParcelTrackingDataUpdatedMessage) Message.
|
|
2156
2173
|
*
|
|
2157
2174
|
*/
|
|
2158
|
-
export interface StagedOrderSetParcelTrackingDataAction {
|
|
2175
|
+
export interface StagedOrderSetParcelTrackingDataAction extends IStagedOrderUpdateAction {
|
|
2159
2176
|
readonly action: 'setParcelTrackingData';
|
|
2160
2177
|
/**
|
|
2161
2178
|
* `id` of an existing [Parcel](ctp:api:type:Parcel).
|
|
@@ -2185,7 +2202,7 @@ export interface StagedOrderSetParcelTrackingDataAction {
|
|
|
2185
2202
|
* Produces the [PurchaseOrderNumberSet](ctp:api:type:OrderPurchaseOrderNumberSetMessage) Message.
|
|
2186
2203
|
*
|
|
2187
2204
|
*/
|
|
2188
|
-
export interface StagedOrderSetPurchaseOrderNumberAction {
|
|
2205
|
+
export interface StagedOrderSetPurchaseOrderNumberAction extends IStagedOrderUpdateAction {
|
|
2189
2206
|
readonly action: 'setPurchaseOrderNumber';
|
|
2190
2207
|
/**
|
|
2191
2208
|
* Value to set.
|
|
@@ -2198,7 +2215,7 @@ export interface StagedOrderSetPurchaseOrderNumberAction {
|
|
|
2198
2215
|
* Produces the [Return Info Set](ctp:api:type:ReturnInfoSetMessage) Message.
|
|
2199
2216
|
*
|
|
2200
2217
|
*/
|
|
2201
|
-
export interface StagedOrderSetReturnInfoAction {
|
|
2218
|
+
export interface StagedOrderSetReturnInfoAction extends IStagedOrderUpdateAction {
|
|
2202
2219
|
readonly action: 'setReturnInfo';
|
|
2203
2220
|
/**
|
|
2204
2221
|
* Value to set.
|
|
@@ -2208,7 +2225,7 @@ export interface StagedOrderSetReturnInfoAction {
|
|
|
2208
2225
|
*/
|
|
2209
2226
|
readonly items?: ReturnInfoDraft[];
|
|
2210
2227
|
}
|
|
2211
|
-
export interface StagedOrderSetReturnItemCustomFieldAction {
|
|
2228
|
+
export interface StagedOrderSetReturnItemCustomFieldAction extends IStagedOrderUpdateAction {
|
|
2212
2229
|
readonly action: 'setReturnItemCustomField';
|
|
2213
2230
|
/**
|
|
2214
2231
|
* `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
|
|
@@ -2237,7 +2254,7 @@ export interface StagedOrderSetReturnItemCustomFieldAction {
|
|
|
2237
2254
|
*/
|
|
2238
2255
|
readonly value?: any;
|
|
2239
2256
|
}
|
|
2240
|
-
export interface StagedOrderSetReturnItemCustomTypeAction {
|
|
2257
|
+
export interface StagedOrderSetReturnItemCustomTypeAction extends IStagedOrderUpdateAction {
|
|
2241
2258
|
readonly action: 'setReturnItemCustomType';
|
|
2242
2259
|
/**
|
|
2243
2260
|
* `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
|
|
@@ -2269,7 +2286,7 @@ export interface StagedOrderSetReturnItemCustomTypeAction {
|
|
|
2269
2286
|
* To set a [ReturnPaymentState](ctp:api:type:ReturnPaymentState), the [Order](ctp:api:type:Order) `returnInfo` must have at least one [ReturnItem](ctp:api:type:ReturnItem).
|
|
2270
2287
|
*
|
|
2271
2288
|
*/
|
|
2272
|
-
export interface StagedOrderSetReturnPaymentStateAction {
|
|
2289
|
+
export interface StagedOrderSetReturnPaymentStateAction extends IStagedOrderUpdateAction {
|
|
2273
2290
|
readonly action: 'setReturnPaymentState';
|
|
2274
2291
|
/**
|
|
2275
2292
|
* `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
|
|
@@ -2296,7 +2313,7 @@ export interface StagedOrderSetReturnPaymentStateAction {
|
|
|
2296
2313
|
* Produces the [Order Return Shipment State Changed](ctp:api:type:OrderReturnShipmentStateChangedMessage) Message.
|
|
2297
2314
|
*
|
|
2298
2315
|
*/
|
|
2299
|
-
export interface StagedOrderSetReturnShipmentStateAction {
|
|
2316
|
+
export interface StagedOrderSetReturnShipmentStateAction extends IStagedOrderUpdateAction {
|
|
2300
2317
|
readonly action: 'setReturnShipmentState';
|
|
2301
2318
|
/**
|
|
2302
2319
|
* `id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
|
|
@@ -2324,7 +2341,7 @@ export interface StagedOrderSetReturnShipmentStateAction {
|
|
|
2324
2341
|
* Produces the [Order Shipping Address Set](ctp:api:type:OrderShippingAddressSetMessage) Message.
|
|
2325
2342
|
*
|
|
2326
2343
|
*/
|
|
2327
|
-
export interface StagedOrderSetShippingAddressAction {
|
|
2344
|
+
export interface StagedOrderSetShippingAddressAction extends IStagedOrderUpdateAction {
|
|
2328
2345
|
readonly action: 'setShippingAddress';
|
|
2329
2346
|
/**
|
|
2330
2347
|
* Value to set.
|
|
@@ -2338,7 +2355,7 @@ export interface StagedOrderSetShippingAddressAction {
|
|
|
2338
2355
|
* Sets the shipping address and a custom Shipping Method together to prevent an inconsistent state.
|
|
2339
2356
|
*
|
|
2340
2357
|
*/
|
|
2341
|
-
export interface StagedOrderSetShippingAddressAndCustomShippingMethodAction {
|
|
2358
|
+
export interface StagedOrderSetShippingAddressAndCustomShippingMethodAction extends IStagedOrderUpdateAction {
|
|
2342
2359
|
readonly action: 'setShippingAddressAndCustomShippingMethod';
|
|
2343
2360
|
/**
|
|
2344
2361
|
* Value to set for `shippingAddress`.
|
|
@@ -2370,12 +2387,18 @@ export interface StagedOrderSetShippingAddressAndCustomShippingMethodAction {
|
|
|
2370
2387
|
*
|
|
2371
2388
|
*/
|
|
2372
2389
|
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
2390
|
+
/**
|
|
2391
|
+
* Custom Fields for the custom Shipping Method.
|
|
2392
|
+
*
|
|
2393
|
+
*
|
|
2394
|
+
*/
|
|
2395
|
+
readonly custom?: CustomFieldsDraft;
|
|
2373
2396
|
}
|
|
2374
2397
|
/**
|
|
2375
2398
|
* Sets the shipping address and Shipping Method together to prevent an inconsistent state.
|
|
2376
2399
|
*
|
|
2377
2400
|
*/
|
|
2378
|
-
export interface StagedOrderSetShippingAddressAndShippingMethodAction {
|
|
2401
|
+
export interface StagedOrderSetShippingAddressAndShippingMethodAction extends IStagedOrderUpdateAction {
|
|
2379
2402
|
readonly action: 'setShippingAddressAndShippingMethod';
|
|
2380
2403
|
/**
|
|
2381
2404
|
* Value to set for `shippingAddress`.
|
|
@@ -2396,7 +2419,7 @@ export interface StagedOrderSetShippingAddressAndShippingMethodAction {
|
|
|
2396
2419
|
*/
|
|
2397
2420
|
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
2398
2421
|
}
|
|
2399
|
-
export interface StagedOrderSetShippingAddressCustomFieldAction {
|
|
2422
|
+
export interface StagedOrderSetShippingAddressCustomFieldAction extends IStagedOrderUpdateAction {
|
|
2400
2423
|
readonly action: 'setShippingAddressCustomField';
|
|
2401
2424
|
/**
|
|
2402
2425
|
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
@@ -2413,7 +2436,7 @@ export interface StagedOrderSetShippingAddressCustomFieldAction {
|
|
|
2413
2436
|
*/
|
|
2414
2437
|
readonly value?: any;
|
|
2415
2438
|
}
|
|
2416
|
-
export interface StagedOrderSetShippingAddressCustomTypeAction {
|
|
2439
|
+
export interface StagedOrderSetShippingAddressCustomTypeAction extends IStagedOrderUpdateAction {
|
|
2417
2440
|
readonly action: 'setShippingAddressCustomType';
|
|
2418
2441
|
/**
|
|
2419
2442
|
* Defines the [Type](ctp:api:type:Type) that extends the `shippingAddress` with [Custom Fields](/../api/projects/custom-fields).
|
|
@@ -2429,7 +2452,7 @@ export interface StagedOrderSetShippingAddressCustomTypeAction {
|
|
|
2429
2452
|
*/
|
|
2430
2453
|
readonly fields?: FieldContainer;
|
|
2431
2454
|
}
|
|
2432
|
-
export interface StagedOrderSetShippingCustomFieldAction {
|
|
2455
|
+
export interface StagedOrderSetShippingCustomFieldAction extends IStagedOrderUpdateAction {
|
|
2433
2456
|
readonly action: 'setShippingCustomField';
|
|
2434
2457
|
/**
|
|
2435
2458
|
* The `shippingKey` of the [Shipping](ctp:api:type:Shipping) to customize. Used to specify which Shipping Method to customize
|
|
@@ -2458,7 +2481,7 @@ export interface StagedOrderSetShippingCustomFieldAction {
|
|
|
2458
2481
|
* This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Order's `shippingMethod` or `shipping`.
|
|
2459
2482
|
*
|
|
2460
2483
|
*/
|
|
2461
|
-
export interface StagedOrderSetShippingCustomTypeAction {
|
|
2484
|
+
export interface StagedOrderSetShippingCustomTypeAction extends IStagedOrderUpdateAction {
|
|
2462
2485
|
readonly action: 'setShippingCustomType';
|
|
2463
2486
|
/**
|
|
2464
2487
|
* The `shippingKey` of the [Shipping](ctp:api:type:Shipping) to customize. Used to specify which Shipping Method to customize
|
|
@@ -2486,7 +2509,7 @@ export interface StagedOrderSetShippingCustomTypeAction {
|
|
|
2486
2509
|
* To set the Cart's Shipping Method, the Cart must have the `Single` [ShippingMode](ctp:api:type:ShippingMode) and a `shippingAddress`.
|
|
2487
2510
|
*
|
|
2488
2511
|
*/
|
|
2489
|
-
export interface StagedOrderSetShippingMethodAction {
|
|
2512
|
+
export interface StagedOrderSetShippingMethodAction extends IStagedOrderUpdateAction {
|
|
2490
2513
|
readonly action: 'setShippingMethod';
|
|
2491
2514
|
/**
|
|
2492
2515
|
* Value to set. If empty, any existing value will be removed.
|
|
@@ -2506,7 +2529,7 @@ export interface StagedOrderSetShippingMethodAction {
|
|
|
2506
2529
|
* A Shipping Method tax amount can be set if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode).
|
|
2507
2530
|
*
|
|
2508
2531
|
*/
|
|
2509
|
-
export interface StagedOrderSetShippingMethodTaxAmountAction {
|
|
2532
|
+
export interface StagedOrderSetShippingMethodTaxAmountAction extends IStagedOrderUpdateAction {
|
|
2510
2533
|
readonly action: 'setShippingMethodTaxAmount';
|
|
2511
2534
|
/**
|
|
2512
2535
|
* `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) to update. This is required for Orders with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
|
|
@@ -2525,7 +2548,7 @@ export interface StagedOrderSetShippingMethodTaxAmountAction {
|
|
|
2525
2548
|
* A Shipping Method Tax Rate can be set if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
|
|
2526
2549
|
*
|
|
2527
2550
|
*/
|
|
2528
|
-
export interface StagedOrderSetShippingMethodTaxRateAction {
|
|
2551
|
+
export interface StagedOrderSetShippingMethodTaxRateAction extends IStagedOrderUpdateAction {
|
|
2529
2552
|
readonly action: 'setShippingMethodTaxRate';
|
|
2530
2553
|
/**
|
|
2531
2554
|
* `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) to update. This is required for Orders with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
|
|
@@ -2545,7 +2568,7 @@ export interface StagedOrderSetShippingMethodTaxRateAction {
|
|
|
2545
2568
|
* Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier). If no matching tier can be found, or the input is not set, the default price for the shipping rate is used.
|
|
2546
2569
|
*
|
|
2547
2570
|
*/
|
|
2548
|
-
export interface StagedOrderSetShippingRateInputAction {
|
|
2571
|
+
export interface StagedOrderSetShippingRateInputAction extends IStagedOrderUpdateAction {
|
|
2549
2572
|
readonly action: 'setShippingRateInput';
|
|
2550
2573
|
/**
|
|
2551
2574
|
* The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
|
|
@@ -2567,7 +2590,7 @@ export interface StagedOrderSetShippingRateInputAction {
|
|
|
2567
2590
|
* Returns a `400` error if `store` references the same Store the Order is currently assigned to, including if you try to remove the value when no Store is currently assigned.
|
|
2568
2591
|
*
|
|
2569
2592
|
*/
|
|
2570
|
-
export interface StagedOrderSetStoreAction {
|
|
2593
|
+
export interface StagedOrderSetStoreAction extends IStagedOrderUpdateAction {
|
|
2571
2594
|
readonly action: 'setStore';
|
|
2572
2595
|
/**
|
|
2573
2596
|
* Value to set. If empty, any existing value will be removed.
|
|
@@ -2582,7 +2605,7 @@ export interface StagedOrderSetStoreAction {
|
|
|
2582
2605
|
* Produces the [Custom Line Item State Transition](ctp:api:type:CustomLineItemStateTransitionMessage) Message.
|
|
2583
2606
|
*
|
|
2584
2607
|
*/
|
|
2585
|
-
export interface StagedOrderTransitionCustomLineItemStateAction {
|
|
2608
|
+
export interface StagedOrderTransitionCustomLineItemStateAction extends IStagedOrderUpdateAction {
|
|
2586
2609
|
readonly action: 'transitionCustomLineItemState';
|
|
2587
2610
|
/**
|
|
2588
2611
|
* `id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
|
|
@@ -2625,7 +2648,7 @@ export interface StagedOrderTransitionCustomLineItemStateAction {
|
|
|
2625
2648
|
* Produces the [Line Item State Transition](ctp:api:type:LineItemStateTransitionMessage) Message.
|
|
2626
2649
|
*
|
|
2627
2650
|
*/
|
|
2628
|
-
export interface StagedOrderTransitionLineItemStateAction {
|
|
2651
|
+
export interface StagedOrderTransitionLineItemStateAction extends IStagedOrderUpdateAction {
|
|
2629
2652
|
readonly action: 'transitionLineItemState';
|
|
2630
2653
|
/**
|
|
2631
2654
|
* `id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
|
|
@@ -2670,7 +2693,7 @@ export interface StagedOrderTransitionLineItemStateAction {
|
|
|
2670
2693
|
* This update action produces the [Order State Transition](ctp:api:type:OrderStateTransitionMessage) Message.
|
|
2671
2694
|
*
|
|
2672
2695
|
*/
|
|
2673
|
-
export interface StagedOrderTransitionStateAction {
|
|
2696
|
+
export interface StagedOrderTransitionStateAction extends IStagedOrderUpdateAction {
|
|
2674
2697
|
readonly action: 'transitionState';
|
|
2675
2698
|
/**
|
|
2676
2699
|
* Value to set.
|
|
@@ -2690,7 +2713,7 @@ export interface StagedOrderTransitionStateAction {
|
|
|
2690
2713
|
* Updates an address in `itemShippingAddresses` by keeping the Address `key`.
|
|
2691
2714
|
*
|
|
2692
2715
|
*/
|
|
2693
|
-
export interface StagedOrderUpdateItemShippingAddressAction {
|
|
2716
|
+
export interface StagedOrderUpdateItemShippingAddressAction extends IStagedOrderUpdateAction {
|
|
2694
2717
|
readonly action: 'updateItemShippingAddress';
|
|
2695
2718
|
/**
|
|
2696
2719
|
* The new Address with the same `key` as the Address it will replace.
|
|
@@ -2699,7 +2722,7 @@ export interface StagedOrderUpdateItemShippingAddressAction {
|
|
|
2699
2722
|
*/
|
|
2700
2723
|
readonly address: _BaseAddress;
|
|
2701
2724
|
}
|
|
2702
|
-
export interface StagedOrderUpdateSyncInfoAction {
|
|
2725
|
+
export interface StagedOrderUpdateSyncInfoAction extends IStagedOrderUpdateAction {
|
|
2703
2726
|
readonly action: 'updateSyncInfo';
|
|
2704
2727
|
/**
|
|
2705
2728
|
* Set this to identify an external order instance, file, or other resource.
|