@gradientedge/commercetools-utils 5.27.2 → 5.28.0

package/dist/cjs/types/models/order.d.ts

@@ -0,0 +1,3187 @@
+/**
+ * Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
+ * Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
+ * For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
+ */
+import { BusinessUnitKeyReference, BusinessUnitResourceIdentifier } from './business-unit.js';
+import { CartOrigin, CartReference, CartResourceIdentifier, CustomLineItem, CustomLineItemPriceMode, DirectDiscount, DiscountCodeInfo, DiscountedLineItemPortionDraft, DiscountOnTotalPrice, InventoryMode, ItemShippingDetailsDraft, LineItem, RoundingMode, Shipping, ShippingInfo, ShippingMethodState, ShippingMode, ShippingRateInput, TaxCalculationMode, TaxedPrice, TaxedPriceDraft, TaxMode } from './cart.js';
+import { CartDiscountReference } from './cart-discount.js';
+import { ChannelReference, ChannelResourceIdentifier } from './channel.js';
+import { Address, AddressDraft, BaseAddress, BaseResource, CentPrecisionMoney, CreatedBy, Image, LastModifiedBy, LocalizedString, PriceDraft, _BaseAddress, _Money } from './common.js';
+import { CustomerGroupReference, CustomerGroupResourceIdentifier } from './customer-group.js';
+import { StagedOrder, StagedOrderAddCustomLineItemAction, StagedOrderAddDeliveryAction, StagedOrderAddDiscountCodeAction, StagedOrderAddItemShippingAddressAction, StagedOrderAddLineItemAction, StagedOrderAddParcelToDeliveryAction, StagedOrderAddPaymentAction, StagedOrderAddReturnInfoAction, StagedOrderAddShoppingListAction, StagedOrderChangeCustomLineItemMoneyAction, StagedOrderChangeCustomLineItemQuantityAction, StagedOrderChangeLineItemQuantityAction, StagedOrderChangeOrderStateAction, StagedOrderChangePaymentStateAction, StagedOrderChangeShipmentStateAction, StagedOrderChangeTaxCalculationModeAction, StagedOrderChangeTaxModeAction, StagedOrderChangeTaxRoundingModeAction, StagedOrderImportCustomLineItemStateAction, StagedOrderImportLineItemStateAction, StagedOrderRemoveCustomLineItemAction, StagedOrderRemoveDeliveryAction, StagedOrderRemoveDiscountCodeAction, StagedOrderRemoveItemShippingAddressAction, StagedOrderRemoveLineItemAction, StagedOrderRemoveParcelFromDeliveryAction, StagedOrderRemovePaymentAction, StagedOrderSetBillingAddressAction, StagedOrderSetBillingAddressCustomFieldAction, StagedOrderSetBillingAddressCustomTypeAction, StagedOrderSetCountryAction, StagedOrderSetCustomerEmailAction, StagedOrderSetCustomerGroupAction, StagedOrderSetCustomerIdAction, StagedOrderSetCustomFieldAction, StagedOrderSetCustomLineItemCustomFieldAction, StagedOrderSetCustomLineItemCustomTypeAction, StagedOrderSetCustomLineItemShippingDetailsAction, StagedOrderSetCustomLineItemTaxAmountAction, StagedOrderSetCustomLineItemTaxRateAction, StagedOrderSetCustomShippingMethodAction, StagedOrderSetCustomTypeAction, StagedOrderSetDeliveryAddressAction, StagedOrderSetDeliveryAddressCustomFieldAction, StagedOrderSetDeliveryAddressCustomTypeAction, StagedOrderSetDeliveryCustomFieldAction, StagedOrderSetDeliveryCustomTypeAction, StagedOrderSetDeliveryItemsAction, StagedOrderSetDirectDiscountsAction, StagedOrderSetItemShippingAddressCustomFieldAction, StagedOrderSetItemShippingAddressCustomTypeAction, StagedOrderSetLineItemCustomFieldAction, StagedOrderSetLineItemCustomTypeAction, StagedOrderSetLineItemDistributionChannelAction, StagedOrderSetLineItemPriceAction, StagedOrderSetLineItemShippingDetailsAction, StagedOrderSetLineItemTaxAmountAction, StagedOrderSetLineItemTaxRateAction, StagedOrderSetLineItemTotalPriceAction, StagedOrderSetLocaleAction, StagedOrderSetOrderNumberAction, StagedOrderSetOrderTotalTaxAction, StagedOrderSetParcelCustomFieldAction, StagedOrderSetParcelCustomTypeAction, StagedOrderSetParcelItemsAction, StagedOrderSetParcelMeasurementsAction, StagedOrderSetParcelTrackingDataAction, StagedOrderSetPurchaseOrderNumberAction, StagedOrderSetReturnInfoAction, StagedOrderSetReturnItemCustomFieldAction, StagedOrderSetReturnItemCustomTypeAction, StagedOrderSetReturnPaymentStateAction, StagedOrderSetReturnShipmentStateAction, StagedOrderSetShippingAddressAction, StagedOrderSetShippingAddressAndCustomShippingMethodAction, StagedOrderSetShippingAddressAndShippingMethodAction, StagedOrderSetShippingAddressCustomFieldAction, StagedOrderSetShippingAddressCustomTypeAction, StagedOrderSetShippingCustomFieldAction, StagedOrderSetShippingCustomTypeAction, StagedOrderSetShippingMethodAction, StagedOrderSetShippingMethodTaxAmountAction, StagedOrderSetShippingMethodTaxRateAction, StagedOrderSetShippingRateInputAction, StagedOrderSetStoreAction, StagedOrderTransitionCustomLineItemStateAction, StagedOrderTransitionLineItemStateAction, StagedOrderTransitionStateAction, StagedOrderUpdateItemShippingAddressAction, StagedOrderUpdateSyncInfoAction } from './order-edit.js';
+import { PaymentReference, PaymentResourceIdentifier } from './payment.js';
+import { Attribute } from './product.js';
+import { QuoteReference, QuoteResourceIdentifier } from './quote.js';
+import { ShippingMethodResourceIdentifier, ShippingRateDraft } from './shipping-method.js';
+import { StateReference, StateResourceIdentifier } from './state.js';
+import { StoreKeyReference, StoreResourceIdentifier } from './store.js';
+import { TaxCategoryResourceIdentifier, TaxRate } from './tax-category.js';
+import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
+export type StagedOrderUpdateAction = StagedOrderAddCustomLineItemAction | StagedOrderAddDeliveryAction | StagedOrderAddDiscountCodeAction | StagedOrderAddItemShippingAddressAction | StagedOrderAddLineItemAction | StagedOrderAddParcelToDeliveryAction | StagedOrderAddPaymentAction | StagedOrderAddReturnInfoAction | StagedOrderAddShoppingListAction | StagedOrderChangeCustomLineItemMoneyAction | StagedOrderChangeCustomLineItemQuantityAction | StagedOrderChangeLineItemQuantityAction | StagedOrderChangeOrderStateAction | StagedOrderChangePaymentStateAction | StagedOrderChangeShipmentStateAction | StagedOrderChangeTaxCalculationModeAction | StagedOrderChangeTaxModeAction | StagedOrderChangeTaxRoundingModeAction | StagedOrderImportCustomLineItemStateAction | StagedOrderImportLineItemStateAction | StagedOrderRemoveCustomLineItemAction | StagedOrderRemoveDeliveryAction | StagedOrderRemoveDiscountCodeAction | StagedOrderRemoveItemShippingAddressAction | StagedOrderRemoveLineItemAction | StagedOrderRemoveParcelFromDeliveryAction | StagedOrderRemovePaymentAction | StagedOrderSetBillingAddressAction | StagedOrderSetBillingAddressCustomFieldAction | StagedOrderSetBillingAddressCustomTypeAction | StagedOrderSetCountryAction | StagedOrderSetCustomFieldAction | StagedOrderSetCustomLineItemCustomFieldAction | StagedOrderSetCustomLineItemCustomTypeAction | StagedOrderSetCustomLineItemShippingDetailsAction | StagedOrderSetCustomLineItemTaxAmountAction | StagedOrderSetCustomLineItemTaxRateAction | StagedOrderSetCustomShippingMethodAction | StagedOrderSetCustomTypeAction | StagedOrderSetCustomerEmailAction | StagedOrderSetCustomerGroupAction | StagedOrderSetCustomerIdAction | StagedOrderSetDeliveryAddressAction | StagedOrderSetDeliveryAddressCustomFieldAction | StagedOrderSetDeliveryAddressCustomTypeAction | StagedOrderSetDeliveryCustomFieldAction | StagedOrderSetDeliveryCustomTypeAction | StagedOrderSetDeliveryItemsAction | StagedOrderSetDirectDiscountsAction | StagedOrderSetItemShippingAddressCustomFieldAction | StagedOrderSetItemShippingAddressCustomTypeAction | StagedOrderSetLineItemCustomFieldAction | StagedOrderSetLineItemCustomTypeAction | StagedOrderSetLineItemDistributionChannelAction | StagedOrderSetLineItemPriceAction | StagedOrderSetLineItemShippingDetailsAction | StagedOrderSetLineItemTaxAmountAction | StagedOrderSetLineItemTaxRateAction | StagedOrderSetLineItemTotalPriceAction | StagedOrderSetLocaleAction | StagedOrderSetOrderNumberAction | StagedOrderSetOrderTotalTaxAction | StagedOrderSetParcelCustomFieldAction | StagedOrderSetParcelCustomTypeAction | StagedOrderSetParcelItemsAction | StagedOrderSetParcelMeasurementsAction | StagedOrderSetParcelTrackingDataAction | StagedOrderSetPurchaseOrderNumberAction | StagedOrderSetReturnInfoAction | StagedOrderSetReturnItemCustomFieldAction | StagedOrderSetReturnItemCustomTypeAction | StagedOrderSetReturnPaymentStateAction | StagedOrderSetReturnShipmentStateAction | StagedOrderSetShippingAddressAction | StagedOrderSetShippingAddressAndCustomShippingMethodAction | StagedOrderSetShippingAddressAndShippingMethodAction | StagedOrderSetShippingAddressCustomFieldAction | StagedOrderSetShippingAddressCustomTypeAction | StagedOrderSetShippingCustomFieldAction | StagedOrderSetShippingCustomTypeAction | StagedOrderSetShippingMethodAction | StagedOrderSetShippingMethodTaxAmountAction | StagedOrderSetShippingMethodTaxRateAction | StagedOrderSetShippingRateInputAction | StagedOrderSetStoreAction | StagedOrderTransitionCustomLineItemStateAction | StagedOrderTransitionLineItemStateAction | StagedOrderTransitionStateAction | StagedOrderUpdateItemShippingAddressAction | StagedOrderUpdateSyncInfoAction;
+export interface Hit {
+    /**
+     *	Unique identifier of the Order.
+     *
+     */
+    readonly id: string;
+    /**
+     *	Current version of the Order.
+     *
+     */
+    readonly version: number;
+    /**
+     *	The higher the value is, the more relevant the hit is for the search request.
+     *
+     */
+    readonly relevance?: number;
+}
+export interface OrderPagedSearchResponse {
+    /**
+     *	Total number of results matching the query.
+     *
+     */
+    readonly total: number;
+    /**
+     *	Number of [elements skipped](/../api/general-concepts#offset).
+     *
+     *
+     */
+    readonly offset?: number;
+    /**
+     *	Number of [results requested](/../api/general-concepts#limit).
+     *
+     *
+     */
+    readonly limit?: number;
+    /**
+     *	Actual results.
+     *
+     */
+    readonly hits: Hit[];
+}
+/**
+ *	Possible values for the `customType` property on [query expressions](/../api/projects/order-search#query-expressions) indicating the data type of the `field`.
+ */
+export type OrderSearchCustomType = 'BooleanType' | 'DateTimeType' | 'DateType' | 'EnumType' | 'LocalizedEnumType' | 'LocalizedStringType' | 'NumberType' | 'SetType.DateTimeType' | 'SetType.DateType' | 'SetType.EnumType' | 'SetType.LocalizedEnumType' | 'SetType.LocalizedStringType' | 'SetType.NumberType' | 'SetType.StringType' | 'SetType.TimeType' | 'StringType' | 'TimeType' | string;
+export type OrderSearchMatchType = 'all' | 'any' | string;
+export interface OrderSearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly field: string;
+    /**
+     *
+     */
+    readonly boost?: number;
+    /**
+     *	Possible values for the `customType` property on [query expressions](/../api/projects/order-search#query-expressions) indicating the data type of the `field`.
+     *
+     */
+    readonly customType?: OrderSearchCustomType;
+}
+export type _OrderSearchQueryExpressionValue = OrderSearchQueryExpressionValue | OrderSearchAnyValue | OrderSearchDateRangeValue | OrderSearchFullTextValue | OrderSearchLongRangeValue | OrderSearchNumberRangeValue | OrderSearchStringValue;
+export interface OrderSearchAnyValue extends OrderSearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly value: any;
+    /**
+     *
+     */
+    readonly language?: string;
+    /**
+     *
+     */
+    readonly caseInsensitive?: boolean;
+}
+export interface OrderSearchDateRangeValue extends OrderSearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly gte?: string;
+    /**
+     *
+     */
+    readonly lte?: string;
+}
+export interface OrderSearchFullTextValue extends OrderSearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly value: string;
+    /**
+     *
+     */
+    readonly language?: string;
+    /**
+     *
+     */
+    readonly mustMatch?: OrderSearchMatchType;
+}
+export interface OrderSearchLongRangeValue extends OrderSearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly gte?: number;
+    /**
+     *
+     */
+    readonly lte?: number;
+}
+export interface OrderSearchNumberRangeValue extends OrderSearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly gte?: number;
+    /**
+     *
+     */
+    readonly lte?: number;
+}
+export type OrderSearchSortMode = 'avg' | 'max' | 'min' | 'sum' | string;
+export type OrderSearchSortOrder = 'asc' | 'desc' | string;
+export interface OrderSearchStringValue extends OrderSearchQueryExpressionValue {
+    /**
+     *
+     */
+    readonly value: string;
+    /**
+     *
+     */
+    readonly language?: string;
+    /**
+     *
+     */
+    readonly caseInsensitive?: boolean;
+}
+/**
+ *	Custom Line Items contain generic user-defined items that are not linked to Products.
+ *
+ */
+export interface CustomLineItemImportDraft {
+    /**
+     *	Name of the Custom Line Item.
+     *
+     *
+     */
+    readonly name: LocalizedString;
+    /**
+     *	User-defined unique identifier of the Custom Line Item.
+     *
+     */
+    readonly key?: string;
+    /**
+     *	User-defined identifier used in a deep-link URL for the Custom Line Item. This value should match the pattern `[a-zA-Z0-9_-]{2,256}`.
+     *
+     *
+     */
+    readonly slug: string;
+    /**
+     *	The number of items in the Custom Line Item. Can be a negative value.
+     *
+     *
+     */
+    readonly quantity: number;
+    /**
+     *	The cost of individual items in the Custom Line Item. The amount can be negative.
+     *
+     */
+    readonly money: _Money;
+    /**
+     *	The tax rate used to calculate the `taxedPrice` of the Order.
+     *
+     *
+     */
+    readonly taxRate?: TaxRate;
+    /**
+     *	Include a value to associate a Tax Category with the Custom Line Item.
+     *
+     *
+     */
+    readonly taxCategory?: TaxCategoryResourceIdentifier;
+    /**
+     *	- If `Standard`, Cart Discounts with a matching [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget)
+     *	are applied to the Custom Line Item.
+     *	- If `External`, Cart Discounts are not considered on the Custom Line Item.
+     *
+     *
+     */
+    readonly priceMode?: CustomLineItemPriceMode;
+    /**
+     *	Container for Custom Line Item-specific addresses.
+     *
+     *
+     */
+    readonly shippingDetails?: ItemShippingDetailsDraft;
+    /**
+     *	State of the Custom Line Items.
+     *
+     *
+     */
+    readonly state?: ItemState[];
+    /**
+     *	Custom Fields of the CustomLineItem.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+}
+/**
+ *	Contains information on how items are shipped to Customers, for example, a delivery note.
+ *
+ */
+export interface Delivery {
+    /**
+     *	Unique identifier of the Delivery.
+     *
+     */
+    readonly id: string;
+    /**
+     *	User-defined unique identifier of the Delivery.
+     *
+     */
+    readonly key?: string;
+    /**
+     *	Date and time (UTC) the Delivery was created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	Line Items or Custom Line Items that are delivered.
+     *
+     *
+     */
+    readonly items: DeliveryItem[];
+    /**
+     *	Information regarding the appearance, content, and shipment of a Parcel.
+     *
+     *
+     */
+    readonly parcels: Parcel[];
+    /**
+     *	Address to which Parcels are delivered.
+     *
+     *
+     */
+    readonly address?: Address;
+    /**
+     *	Custom Fields of the Delivery.
+     *
+     *
+     */
+    readonly custom?: CustomFields;
+}
+export interface DeliveryDraft {
+    /**
+     *	User-defined unique identifier of the Delivery.
+     *
+     */
+    readonly key?: string;
+    /**
+     *	Line Items or Custom Line Items to deliver.
+     *	It can also be specified individually for each [Parcel](ctp:api:type:Parcel).
+     *
+     *
+     */
+    readonly items?: DeliveryItem[];
+    /**
+     *	Information regarding the appearance, content, and shipment of a parcel.
+     *
+     *
+     */
+    readonly parcels?: ParcelDraft[];
+    /**
+     *	Address to which the Parcels are delivered.
+     *
+     *
+     */
+    readonly address?: AddressDraft;
+    /**
+     *	Custom Fields for the Delivery.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+}
+export interface DeliveryItem {
+    /**
+     *	`id` of the [LineItem](ctp:api:type:LineItem) or [CustomLineItem](ctp:api:type:CustomLineItem) delivered.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Number of Line Items or Custom Line Items delivered.
+     *
+     *
+     */
+    readonly quantity: number;
+}
+export interface DiscountedLineItemPriceDraft {
+    /**
+     *	Discounted money value.
+     *
+     *
+     */
+    readonly value: _Money;
+    /**
+     *	Discounts to be applied.
+     *
+     *
+     */
+    readonly includedDiscounts: DiscountedLineItemPortionDraft[];
+}
+export interface ItemState {
+    /**
+     *	Number of Line Items or Custom Line Items in this State.
+     *
+     *
+     */
+    readonly quantity: number;
+    /**
+     *	State of the Line Items or Custom Line Items in a custom workflow.
+     *
+     *
+     */
+    readonly state: StateReference;
+}
+/**
+ *	Represents a snapshot of a Product Variant at the time it was imported with the Order. The Product Variant can be specified by providing a `productId` and `variant.id`, or by providing a `variant.sku`.
+ *
+ */
+export interface LineItemImportDraft {
+    /**
+     *	Name of the Line Item.
+     *
+     *
+     */
+    readonly name: LocalizedString;
+    /**
+     *	User-defined unique identifier of the Line Item.
+     *
+     */
+    readonly key?: string;
+    /**
+     *	The Product Variant to use as a [Line Item](ctp:api:type:LineItem).
+     *
+     */
+    readonly variant: ProductVariantImportDraft;
+    /**
+     *	`id` of the [Product](ctp:api:type:Product) the Product Variant belongs to.
+     *
+     *	If provided, you must also set `variant.id`.
+     *
+     */
+    readonly productId?: string;
+    /**
+     *	The number of Product Variants in the LineItem. Can be a negative value.
+     *
+     *
+     */
+    readonly quantity: number;
+    /**
+     *	The Line Item price for `quantity` = `1`. The amount can be negative.
+     *
+     */
+    readonly price: PriceDraft;
+    /**
+     *	The tax rate used to calculate the `taxedPrice` of the Order.
+     *
+     */
+    readonly taxRate?: TaxRate;
+    /**
+     *	The Channel used to [select a Price](/../api/pricing-and-discounts-overview#line-item-price-selection).
+     *	This Channel must have the `ProductDistribution` role.
+     *
+     */
+    readonly distributionChannel?: ChannelResourceIdentifier;
+    /**
+     *	The Channel used to supply Line Items.
+     *	By providing supply Channel information, you can uniquely identify [Inventory entries](ctp:api:type:InventoryEntry) that should be reserved.
+     *	This Channel must have the `InventorySupply` role.
+     *
+     */
+    readonly supplyChannel?: ChannelResourceIdentifier;
+    /**
+     *	Inventory mode specific to the LineItem, valid for the entire `quantity` of the LineItem.
+     *	Set only if Inventory mode should be different from the `inventoryMode` specified on the [OrderImportDraft](ctp:api:type:OrderImportDraft).
+     *
+     */
+    readonly inventoryMode?: InventoryMode;
+    /**
+     *	Container for Line Item-specific addresses.
+     *
+     *
+     */
+    readonly shippingDetails?: ItemShippingDetailsDraft;
+    /**
+     *	States of the Line Item.
+     *
+     */
+    readonly state?: ItemState[];
+    /**
+     *	Custom Fields of the LineItem.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+}
+export interface Order extends BaseResource {
+    /**
+     *	Unique identifier of the Order.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Current version of the Order.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	User-defined identifier of the Order that is unique across a Project.
+     *
+     *
+     */
+    readonly orderNumber?: string;
+    /**
+     *	User-defined identifier of a purchase Order.
+     *
+     *	It is typically set by the [Buyer](ctp:api:type:Buyer) and can be used with [Quotes](/quotes-overview) to track the purchase Order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
+     *
+     */
+    readonly purchaseOrderNumber?: string;
+    /**
+     *	`id` of the [Customer](ctp:api:type:Customer) that the Order belongs to.
+     *
+     *
+     */
+    readonly customerId?: string;
+    /**
+     *	Email address of the Customer that the Order belongs to.
+     *
+     *
+     */
+    readonly customerEmail?: string;
+    /**
+     *	[Reference](ctp:api:type:Reference) to the Customer Group of the Customer that the Order belongs to.
+     *	Used for [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
+     *
+     */
+    readonly customerGroup?: CustomerGroupReference;
+    /**
+     *	[Anonymous session](ctp:api:type:AnonymousSession) associated with the Order.
+     *
+     *
+     */
+    readonly anonymousId?: string;
+    /**
+     *	[Reference](ctp:api:type:Reference) to a Business Unit the Order belongs to.
+     *
+     *
+     */
+    readonly businessUnit?: BusinessUnitKeyReference;
+    /**
+     *	[Reference](ctp:api:type:Reference) to a Store the Order belongs to.
+     *
+     *
+     */
+    readonly store?: StoreKeyReference;
+    /**
+     *	[Line Items](ctp:api:type:LineItems) that are part of the Order.
+     *
+     *
+     */
+    readonly lineItems: LineItem[];
+    /**
+     *	[Custom Line Items](ctp:api:type:CustomLineItems) that are part of the Order.
+     *
+     *
+     */
+    readonly customLineItems: CustomLineItem[];
+    /**
+     *	Sum of the `totalPrice` field of all [LineItems](ctp:api:type:LineItem) and [CustomLineItems](ctp:api:type:CustomLineItem), and if available, the `price` field of [ShippingInfo](ctp:api:type:ShippingInfo).
+     *	If a discount applies on `totalPrice`, this field holds the discounted value.
+     *
+     *	Taxes are included if [TaxRate](ctp:api:type:TaxRate) `includedInPrice` is `true` for each price.
+     *
+     *
+     */
+    readonly totalPrice: CentPrecisionMoney;
+    /**
+     *	- For `Platform` [TaxMode](ctp:api:type:TaxMode), it is automatically set when a [shipping address is set](ctp:api:type:OrderSetShippingAddressAction).
+     *	- For `External` [TaxMode](ctp:api:type:TaxMode), it is automatically set when `shippingAddress` and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.
+     *
+     *	If a discount applies on `totalPrice`, this field holds the discounted values.
+     *
+     *
+     */
+    readonly taxedPrice?: TaxedPrice;
+    /**
+     *	Sum of the `taxedPrice` field of [ShippingInfo](ctp:api:type:ShippingInfo) across all Shipping Methods.
+     *
+     *
+     */
+    readonly taxedShippingPrice?: TaxedPrice;
+    /**
+     *	Discounts that apply on the total price of the Order.
+     *
+     */
+    readonly discountOnTotalPrice?: DiscountOnTotalPrice;
+    /**
+     *	Indicates how Tax Rates are set.
+     *
+     *
+     */
+    readonly taxMode?: TaxMode;
+    /**
+     *	Indicates how monetary values are rounded when calculating taxes for `taxedPrice`.
+     *
+     */
+    readonly taxRoundingMode?: RoundingMode;
+    /**
+     *	Indicates how taxes are calculated when calculating taxes for `taxedPrice`.
+     *
+     *
+     */
+    readonly taxCalculationMode?: TaxCalculationMode;
+    /**
+     *	Indicates how stock quantities are tracked for Line Items in the Order.
+     *
+     *
+     */
+    readonly inventoryMode?: InventoryMode;
+    /**
+     *	Billing address associated with the Order.
+     *
+     *
+     */
+    readonly billingAddress?: Address;
+    /**
+     *	Shipping address associated with the Order.
+     *	Determines eligible [ShippingMethod](ctp:api:type:ShippingMethod) rates and Tax Rates of Line Items.
+     *
+     *
+     */
+    readonly shippingAddress?: Address;
+    /**
+     *	Indicates whether there can be one or multiple Shipping Methods.
+     *
+     *
+     */
+    readonly shippingMode: ShippingMode;
+    /**
+     *	`key` of the [ShippingMethod](ctp:api:type:ShippingMethod) for `Single` [ShippingMode](ctp:api:type:ShippingMode).
+     *
+     *
+     */
+    readonly shippingKey?: string;
+    /**
+     *	Shipping-related information for `Single` [ShippingMode](ctp:api:type:ShippingMode).
+     *	Automatically set when a [Shipping Method is set](ctp:api:type:StagedOrderSetShippingMethodAction).
+     *
+     *
+     */
+    readonly shippingInfo?: ShippingInfo;
+    /**
+     *	Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
+     *	The data type of this field depends on the `shippingRateInputType.type` configured in the [Project](ctp:api:type:Project):
+     *
+     *	- If `CartClassification`, it is [ClassificationShippingRateInput](ctp:api:type:ClassificationShippingRateInput).
+     *	- If `CartScore`, it is [ScoreShippingRateInput](ctp:api:type:ScoreShippingRateInput).
+     *	- If `CartValue`, it cannot be used.
+     *
+     *
+     */
+    readonly shippingRateInput?: ShippingRateInput;
+    /**
+     *	Custom Fields of the Shipping Method for `Single` [ShippingMode](ctp:api:type:ShippingMode).
+     *
+     *
+     */
+    readonly shippingCustomFields?: CustomFields;
+    /**
+     *	Shipping-related information for `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+     *	Updated automatically each time a new [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction).
+     *
+     *
+     */
+    readonly shipping: Shipping[];
+    /**
+     *	Additional shipping addresses of the Order as specified by [LineItems](ctp:api:type:LineItem) using the `shippingDetails` field.
+     *	Eligible Shipping Methods or applicable Tax Rates are determined by the address in `shippingAddress`, and not `itemShippingAddresses`.
+     *
+     *
+     */
+    readonly itemShippingAddresses?: Address[];
+    /**
+     *	Discount Codes added to the Order.
+     *	An Order that has `directDiscounts` cannot have `discountCodes`.
+     *
+     *
+     */
+    readonly discountCodes?: DiscountCodeInfo[];
+    /**
+     *	Direct Discounts added to the Order.
+     *	An Order that has `discountCodes` cannot have `directDiscounts`.
+     *
+     *
+     */
+    readonly directDiscounts?: DirectDiscount[];
+    /**
+     *	Automatically set when a Line Item with `GiftLineItem` [LineItemMode](ctp:api:type:LineItemMode) is [removed](ctp:api:type:StagedOrderRemoveLineItemAction) from the Order.
+     *
+     *
+     */
+    readonly refusedGifts: CartDiscountReference[];
+    /**
+     *	Payment information related to the Order.
+     *
+     *
+     */
+    readonly paymentInfo?: PaymentInfo;
+    /**
+     *	Used for [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
+     *
+     */
+    readonly country?: string;
+    /**
+     *	Languages of the Order.
+     *	Can only contain languages supported by the [Project](ctp:api:type:Project).
+     *
+     *
+     */
+    readonly locale?: string;
+    /**
+     *	Indicates the origin of the Cart from which the Order was created.
+     *
+     *
+     */
+    readonly origin: CartOrigin;
+    /**
+     *	[Reference](ctp:api:type:Reference) to the Cart for an [Order created from Cart](ctp:api:endpoint:/{projectKey}/orders:POST).
+     *	The referenced Cart will have the `Ordered` [CartState](ctp:api:type:CartState).
+     *
+     */
+    readonly cart?: CartReference;
+    /**
+     *	[Reference](ctp:api:type:Reference) to the Quote for an [Order created from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST).
+     *
+     *
+     */
+    readonly quote?: QuoteReference;
+    /**
+     *	Current status of the Order.
+     *
+     *
+     */
+    readonly orderState: OrderState;
+    /**
+     *	Shipment status of the Order.
+     *
+     *
+     */
+    readonly shipmentState?: ShipmentState;
+    /**
+     *	Payment status of the Order.
+     *
+     *
+     */
+    readonly paymentState?: PaymentState;
+    /**
+     *	[State](ctp:api:type:State) of the Order.
+     *	This reference can point to a State in a custom workflow.
+     *
+     *
+     */
+    readonly state?: StateReference;
+    /**
+     *	Contains synchronization activity information of the Order (like export or import).
+     *	Can only be set with [Update SyncInfo](ctp:api:type:OrderUpdateSyncInfoAction) update action.
+     *
+     *
+     */
+    readonly syncInfo: SyncInfo[];
+    /**
+     *	Contains information regarding the returns associated with the Order.
+     *
+     *
+     */
+    readonly returnInfo?: ReturnInfo[];
+    /**
+     *	Internal-only field.
+     *	@deprecated
+     */
+    readonly lastMessageSequenceNumber?: number;
+    /**
+     *	Custom Fields of the Order.
+     *
+     *
+     */
+    readonly custom?: CustomFields;
+    /**
+     *	User-defined date and time (UTC) of the Order.
+     *	Present only on an Order created using [Order Import](ctp:api:endpoint:/{projectKey}/orders/import:POST).
+     *
+     *
+     */
+    readonly completedAt?: string;
+    /**
+     *	Date and time (UTC) the Order was initially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	Date and time (UTC) the Order was last updated.
+     *
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	IDs and references that last modified the Order.
+     *
+     *
+     */
+    readonly lastModifiedBy?: LastModifiedBy;
+    /**
+     *	IDs and references that created the Order.
+     *
+     *
+     */
+    readonly createdBy?: CreatedBy;
+}
+export type _Order = Order | StagedOrder;
+export interface OrderFromCartDraft {
+    /**
+     *	`id` of the [Cart](ctp:api:type:Cart) used to create the Order.
+     *
+     *	@deprecated
+     */
+    readonly id?: string;
+    /**
+     *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Cart from which the Order is created.
+     *
+     *	This field is required, but is marked as optional for backwards compatibility reasons.
+     *
+     *
+     */
+    readonly cart?: CartResourceIdentifier;
+    /**
+     *	`version` of the [Cart](ctp:api:type:Cart) from which the Order is created.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	User-defined identifier for the Order that is unique across a Project.
+     *	Once set, the value cannot be changed.
+     *
+     *
+     */
+    readonly orderNumber?: string;
+    /**
+     *	User-defined identifier for a purchase Order.
+     *
+     *	It is typically set by the [Buyer](ctp:api:type:Buyer) and can be used with [Quotes](/quotes-overview) to track the purchase Order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
+     *
+     */
+    readonly purchaseOrderNumber?: string;
+    /**
+     *	Payment status for the Order.
+     *
+     *
+     */
+    readonly paymentState?: PaymentState;
+    /**
+     *	Shipment status for the Order.
+     *
+     *
+     */
+    readonly shipmentState?: ShipmentState;
+    /**
+     *	Current status for the Order.
+     *
+     *
+     */
+    readonly orderState?: OrderState;
+    /**
+     *	State for the Order in a custom workflow.
+     *
+     *
+     */
+    readonly state?: StateResourceIdentifier;
+    /**
+     *	Custom Fields for the Order.
+     *	The Custom Fields' type must match the Custom Fields' type in the referenced [Cart](ctp:api:type:Cart).
+     *
+     *	- If empty, the Custom Fields on the referenced [Cart](ctp:api:type:Cart) are added to the Order automatically.
+     *	- If specified, the Custom Fields are merged with the Custom Fields on the referenced [Cart](ctp:api:type:Cart) and added to the Order.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+}
+export interface OrderFromQuoteDraft {
+    /**
+     *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Quote from which the Order is created.
+     *	If the referenced [Quote](ctp:api:type:Quote) has expired (`validTo` check) or its `quoteState` is `Accepted`, `Declined`, or `Withdrawn`, the Order creation will fail.
+     *
+     *
+     */
+    readonly quote: QuoteResourceIdentifier;
+    /**
+     *	`version` of the [Quote](ctp:api:type:Quote) from which the Order is created.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	If `true`, the `quoteState` of the referenced [Quote](ctp:api:type:Quote) will be set to `Accepted`.
+     *
+     *
+     */
+    readonly quoteStateToAccepted?: boolean;
+    /**
+     *	User-defined identifier for the Order that is unique across a Project.
+     *	Once set, the value cannot be changed.
+     *
+     *
+     */
+    readonly orderNumber?: string;
+    /**
+     *	Payment status for the Order.
+     *
+     *
+     */
+    readonly paymentState?: PaymentState;
+    /**
+     *	Shipment status for the Order.
+     *
+     *
+     */
+    readonly shipmentState?: ShipmentState;
+    /**
+     *	Current status for the Order.
+     *
+     *
+     */
+    readonly orderState?: OrderState;
+    /**
+     *	State of the Order in a custom workflow.
+     *
+     *
+     */
+    readonly state?: StateResourceIdentifier;
+}
+/**
+ *	A snapshot of an Order at the time it was imported.
+ *
+ */
+export interface OrderImportDraft {
+    /**
+     *	User-defined identifier of the Order. Must be unique across a Project.
+     *	Once set, the value cannot be changed.
+     *
+     *
+     */
+    readonly orderNumber?: string;
+    /**
+     *	User-defined identifier for a purchase Order.
+     *
+     */
+    readonly purchaseOrderNumber?: string;
+    /**
+     *	The `id` of the [Customer](ctp:api:type:Customer) the Order belongs to.
+     *
+     *
+     */
+    readonly customerId?: string;
+    /**
+     *	The Email address of the Customer the Order belongs to. Can be used instead of `customerId` when no check against existing [Customers](ctp:api:type:Customer) is required.
+     *
+     *
+     */
+    readonly customerEmail?: string;
+    /**
+     *	The Customer Group of the Customer the Order belongs to.
+     *
+     *
+     */
+    readonly customerGroup?: CustomerGroupResourceIdentifier;
+    /**
+     *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Order should belong to.
+     *	When the `customerId` of the Order is also set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit.
+     *
+     *
+     */
+    readonly businessUnit?: BusinessUnitResourceIdentifier;
+    /**
+     *	The Store the Order belongs to.
+     *	Used for [filtering](#filtering).
+     *
+     *	If a [LineItemImportDraft](ctp:api:type:LineItemImportDraft) or a [CustomLineItemImportDraft](ctp:api:type:CustomLineItemImportDraft) specifies a `distributionChannel` or a `supplyChannel` that is not defined for the referenced Store, the Order Import gets rejected.
+     *	The same applies when the provided `country` is not defined for the referenced Store.
+     *
+     *
+     */
+    readonly store?: StoreResourceIdentifier;
+    /**
+     *	[Line Items](ctp:api:type:LineItems) to add to the Order.
+     *
+     *	If not specified, `customLineItems` must not be empty.
+     *
+     *
+     */
+    readonly lineItems?: LineItemImportDraft[];
+    /**
+     *	[Custom Line Items](ctp:api:type:CustomLineItems) to add to the Cart.
+     *
+     *	If not specified, `lineItems` must not be empty.
+     *
+     *
+     */
+    readonly customLineItems?: CustomLineItemImportDraft[];
+    /**
+     *	The total Price of the Order. The amount can be negative.
+     *
+     *
+     */
+    readonly totalPrice: _Money;
+    /**
+     *	Include TaxedPrice information for the Order. If not included, and if you have Tax Rates set for Line Items and Custom Line Items, the Order total will not be recalculated.
+     *
+     *
+     */
+    readonly taxedPrice?: TaxedPriceDraft;
+    /**
+     *	Determines how monetary values are rounded when calculating taxes for `taxedPrice`.
+     *
+     *
+     */
+    readonly taxRoundingMode?: RoundingMode;
+    /**
+     *	Determines how taxes are calculated for `taxedPrice`.
+     *
+     *
+     */
+    readonly taxCalculationMode?: TaxCalculationMode;
+    /**
+     *	Determines how stock quantities are tracked for Line Items in the Cart.
+     *
+     *
+     */
+    readonly inventoryMode?: InventoryMode;
+    /**
+     *	Billing address associated with the Order.
+     *
+     *
+     */
+    readonly billingAddress?: _BaseAddress;
+    /**
+     *	Shipping address associated with the Order.
+     *
+     *
+     */
+    readonly shippingAddress?: _BaseAddress;
+    /**
+     *	Addresses for Orders with multiple shipping addresses. Addresses must include a value for `key`.
+     *
+     *
+     */
+    readonly itemShippingAddresses?: BaseAddress[];
+    /**
+     *	Shipping-related information of the Order.
+     *
+     *
+     */
+    readonly shippingInfo?: ShippingInfoImportDraft;
+    /**
+     *	Payment information associated with the Order.
+     *
+     *
+     */
+    readonly paymentInfo?: PaymentInfo;
+    /**
+     *	Payment status of the Order.
+     *
+     *
+     */
+    readonly paymentState?: PaymentState;
+    /**
+     *	Shipment status of the Order.
+     *
+     *
+     */
+    readonly shipmentState?: ShipmentState;
+    /**
+     *	Current status of the Order.
+     *
+     *
+     */
+    readonly orderState?: OrderState;
+    /**
+     *	State of the Order in a custom workflow.
+     *
+     *
+     */
+    readonly state?: StateReference;
+    /**
+     *	Include a value to associate a country with the Order.
+     *
+     *
+     */
+    readonly country?: string;
+    /**
+     *	Indicates the origin of the Order.
+     *
+     *
+     */
+    readonly origin?: CartOrigin;
+    /**
+     *	User-defined date and time for the Order. This value does not influence the `createdAt` or `lastModifiedAt` values of the Order created by the Order Import.
+     *
+     *
+     */
+    readonly completedAt?: string;
+    /**
+     *	Custom Fields for the Order.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+}
+/**
+ *	[PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Order](ctp:api:type:Order).
+ *
+ */
+export interface OrderPagedQueryResponse {
+    /**
+     *	Number of [results requested](/../api/general-concepts#limit).
+     *
+     *
+     */
+    readonly limit: number;
+    /**
+     *	Number of [elements skipped](/../api/general-concepts#offset).
+     *
+     *
+     */
+    readonly offset: number;
+    /**
+     *	Actual number of results returned.
+     *
+     *
+     */
+    readonly count: number;
+    /**
+     *	Total number of results matching the query.
+     *	This number is an estimation that is not [strongly consistent](/../api/general-concepts#strong-consistency).
+     *	This field is returned by default.
+     *	For improved performance, calculating this field can be deactivated by using the query parameter `withTotal=false`.
+     *	When the results are filtered with a [Query Predicate](ctp:api:type:QueryPredicate), `total` is subject to a [limit](/../api/limits#queries).
+     *
+     *
+     */
+    readonly total?: number;
+    /**
+     *	[Orders](ctp:api:type:Order) matching the query.
+     *
+     *
+     */
+    readonly results: Order[];
+}
+/**
+ *	[Reference](ctp:api:type:Reference) to an [Order](ctp:api:type:Order).
+ *
+ */
+export interface OrderReference {
+    readonly typeId: 'order';
+    /**
+     *	Unique identifier of the referenced [Order](ctp:api:type:Order).
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	Contains the representation of the expanded Order. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for Orders.
+     *
+     *
+     */
+    readonly obj?: _Order;
+}
+export interface OrderSearchQuery {
+}
+export type _OrderSearchQuery = OrderSearchQuery | _OrderSearchCompoundExpression | _OrderSearchQueryExpression;
+export interface OrderSearchCompoundExpression extends OrderSearchQuery {
+}
+export type _OrderSearchCompoundExpression = OrderSearchCompoundExpression | OrderSearchAndExpression | OrderSearchFilterExpression | OrderSearchNotExpression | OrderSearchOrExpression;
+export interface OrderSearchAndExpression extends OrderSearchCompoundExpression {
+    /**
+     *
+     */
+    readonly and: OrderSearchQuery[];
+}
+export interface OrderSearchFilterExpression extends OrderSearchCompoundExpression {
+    /**
+     *
+     */
+    readonly filter: OrderSearchQueryExpression[];
+}
+export interface OrderSearchNotExpression extends OrderSearchCompoundExpression {
+    /**
+     *
+     */
+    readonly not: OrderSearchQuery[];
+}
+export interface OrderSearchOrExpression extends OrderSearchCompoundExpression {
+    /**
+     *
+     */
+    readonly or: OrderSearchQuery[];
+}
+export interface OrderSearchQueryExpression extends OrderSearchQuery {
+}
+export type _OrderSearchQueryExpression = OrderSearchQueryExpression | OrderSearchDateRangeExpression | OrderSearchExactExpression | OrderSearchExistsExpression | OrderSearchFullTextExpression | OrderSearchLongRangeExpression | OrderSearchNumberRangeExpression | OrderSearchPrefixExpression | OrderSearchWildCardExpression;
+export interface OrderSearchDateRangeExpression extends OrderSearchQueryExpression {
+    /**
+     *
+     */
+    readonly range: OrderSearchDateRangeValue;
+}
+export interface OrderSearchExactExpression extends OrderSearchQueryExpression {
+    /**
+     *
+     */
+    readonly exact: OrderSearchAnyValue;
+}
+export interface OrderSearchExistsExpression extends OrderSearchQueryExpression {
+    /**
+     *
+     */
+    readonly exists: _OrderSearchQueryExpressionValue;
+}
+export interface OrderSearchFullTextExpression extends OrderSearchQueryExpression {
+    /**
+     *
+     */
+    readonly fullText: OrderSearchFullTextValue;
+}
+export interface OrderSearchLongRangeExpression extends OrderSearchQueryExpression {
+    /**
+     *
+     */
+    readonly range: OrderSearchLongRangeValue;
+}
+export interface OrderSearchNumberRangeExpression extends OrderSearchQueryExpression {
+    /**
+     *
+     */
+    readonly range: OrderSearchNumberRangeValue;
+}
+export interface OrderSearchPrefixExpression extends OrderSearchQueryExpression {
+    /**
+     *
+     */
+    readonly prefix: OrderSearchStringValue;
+}
+export interface OrderSearchWildCardExpression extends OrderSearchQueryExpression {
+    /**
+     *
+     */
+    readonly wildcard: OrderSearchStringValue;
+}
+export interface OrderSearchRequest {
+    /**
+     *	The Order search query.
+     *
+     */
+    readonly query: _OrderSearchQuery;
+    /**
+     *	Controls how results to your query are sorted. If not provided, the results are sorted by relevance in descending order.
+     *
+     */
+    readonly sort?: OrderSearchSorting[];
+    /**
+     *	The maximum number of search results to be returned on one [page](#pagination).
+     *
+     */
+    readonly limit?: number;
+    /**
+     *	The number of search results to be skipped in the response for [pagination](#pagination).
+     *
+     */
+    readonly offset?: number;
+}
+export interface OrderSearchSorting {
+    /**
+     *
+     */
+    readonly field: string;
+    /**
+     *
+     */
+    readonly language?: string;
+    /**
+     *
+     */
+    readonly order?: OrderSearchSortOrder;
+    /**
+     *
+     */
+    readonly mode?: OrderSearchSortMode;
+    /**
+     *
+     */
+    readonly filter?: _OrderSearchQueryExpression;
+}
+/**
+ *	Indicates the state of the Order.
+ *
+ */
+export type OrderState = 'Cancelled' | 'Complete' | 'Confirmed' | 'Open' | string;
+export interface OrderUpdate {
+    /**
+     *	Expected version of the Order on which the changes should be applied.
+     *	If the expected version does not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
+     *
+     *
+     */
+    readonly version: number;
+    /**
+     *	Update actions to be performed on the Order.
+     *
+     *
+     */
+    readonly actions: OrderUpdateAction[];
+}
+export type OrderUpdateAction = OrderAddDeliveryAction | OrderAddItemShippingAddressAction | OrderAddParcelToDeliveryAction | OrderAddPaymentAction | OrderAddReturnInfoAction | OrderChangeOrderStateAction | OrderChangePaymentStateAction | OrderChangeShipmentStateAction | OrderImportCustomLineItemStateAction | OrderImportLineItemStateAction | OrderRemoveDeliveryAction | OrderRemoveItemShippingAddressAction | OrderRemoveParcelFromDeliveryAction | OrderRemovePaymentAction | OrderSetBillingAddressAction | OrderSetBillingAddressCustomFieldAction | OrderSetBillingAddressCustomTypeAction | OrderSetCustomFieldAction | OrderSetCustomLineItemCustomFieldAction | OrderSetCustomLineItemCustomTypeAction | OrderSetCustomLineItemShippingDetailsAction | OrderSetCustomTypeAction | OrderSetCustomerEmailAction | OrderSetCustomerIdAction | OrderSetDeliveryAddressAction | OrderSetDeliveryAddressCustomFieldAction | OrderSetDeliveryAddressCustomTypeAction | OrderSetDeliveryCustomFieldAction | OrderSetDeliveryCustomTypeAction | OrderSetDeliveryItemsAction | OrderSetItemShippingAddressCustomFieldAction | OrderSetItemShippingAddressCustomTypeAction | OrderSetLineItemCustomFieldAction | OrderSetLineItemCustomTypeAction | OrderSetLineItemShippingDetailsAction | OrderSetLocaleAction | OrderSetOrderNumberAction | OrderSetParcelCustomFieldAction | OrderSetParcelCustomTypeAction | OrderSetParcelItemsAction | OrderSetParcelMeasurementsAction | OrderSetParcelTrackingDataAction | OrderSetPurchaseOrderNumberAction | OrderSetReturnInfoAction | OrderSetReturnItemCustomFieldAction | OrderSetReturnItemCustomTypeAction | OrderSetReturnPaymentStateAction | OrderSetReturnShipmentStateAction | OrderSetShippingAddressAction | OrderSetShippingAddressCustomFieldAction | OrderSetShippingAddressCustomTypeAction | OrderSetShippingCustomFieldAction | OrderSetShippingCustomTypeAction | OrderSetStoreAction | OrderTransitionCustomLineItemStateAction | OrderTransitionLineItemStateAction | OrderTransitionStateAction | OrderUpdateItemShippingAddressAction | OrderUpdateSyncInfoAction;
+/**
+ *	Information regarding the appearance, content, and shipment of a Parcel.
+ *
+ */
+export interface Parcel {
+    /**
+     *	Unique identifier of the Parcel.
+     *
+     */
+    readonly id: string;
+    /**
+     *	User-defined unique identifier of the Parcel.
+     *
+     */
+    readonly key?: string;
+    /**
+     *	Date and time (UTC) the Parcel was created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	Information about the dimensions of the Parcel.
+     *
+     *
+     */
+    readonly measurements?: ParcelMeasurements;
+    /**
+     *	Shipment tracking information of the Parcel.
+     *
+     *
+     */
+    readonly trackingData?: TrackingData;
+    /**
+     *	Line Items or Custom Line Items delivered in this Parcel.
+     *
+     *
+     */
+    readonly items?: DeliveryItem[];
+    /**
+     *	Custom Fields of the Parcel.
+     *
+     *
+     */
+    readonly custom?: CustomFields;
+}
+export interface ParcelDraft {
+    /**
+     *	User-defined unique identifier of the Parcel.
+     *
+     */
+    readonly key?: string;
+    /**
+     *	Information about the dimensions for the Parcel.
+     *
+     *
+     */
+    readonly measurements?: ParcelMeasurements;
+    /**
+     *	Shipment tracking information for the Parcel.
+     *
+     *
+     */
+    readonly trackingData?: TrackingData;
+    /**
+     *	Line Items or Custom Line Items delivered in this Parcel.
+     *
+     *
+     */
+    readonly items?: DeliveryItem[];
+    /**
+     *	Custom Fields for the Parcel.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+}
+export interface ParcelMeasurements {
+    /**
+     *	Height of the Parcel.
+     *
+     *
+     */
+    readonly heightInMillimeter?: number;
+    /**
+     *	Length of the Parcel.
+     *
+     *
+     */
+    readonly lengthInMillimeter?: number;
+    /**
+     *	Width of the Parcel.
+     *
+     *
+     */
+    readonly widthInMillimeter?: number;
+    /**
+     *	Weight of the Parcel.
+     *
+     *
+     */
+    readonly weightInGram?: number;
+}
+export interface PaymentInfo {
+    /**
+     *	[References](ctp:api:type:Reference) to the Payments associated with the Order.
+     *
+     *
+     */
+    readonly payments: PaymentReference[];
+}
+/**
+ *	Indicates the payment status for the Order.
+ *
+ */
+export type PaymentState = 'BalanceDue' | 'CreditOwed' | 'Failed' | 'Paid' | 'Pending' | string;
+/**
+ *	Contains the Product Variant to be used in the [LineItemImportDraft](ctp:api:type:LineItemImportDraft).
+ *
+ */
+export interface ProductVariantImportDraft {
+    /**
+     *	The `id` of the [ProductVariant](ctp:api:type:ProductVariant). Required if you do not set a value for `sku`.
+     *	If set, you must specify a `productId` in the [LineItemImportDraft](ctp:api:type:LineItemImportDraft) also.
+     *
+     *
+     */
+    readonly id?: number;
+    /**
+     *	The `sku` of the [ProductVariant](ctp:api:type:ProductVariant). Required if you do not set a value for `id`.
+     *
+     *
+     */
+    readonly sku?: string;
+    /**
+     *	The [Prices](ctp:api:type:Price) of the Product Variant if you want to override the `prices` property in the referenced [ProductVariant](ctp:api:type:ProductVariant).
+     *	If not set, the `prices` from the referenced [ProductVariant](ctp:api:type:ProductVariant) are used in the resulting Order.
+     *	If set, each Price must have its unique price scope (same `value.currencyCode`, `country`, `customerGroup`, `channel`, `validFrom` and `validUntil`).
+     *
+     *
+     */
+    readonly prices?: PriceDraft[];
+    /**
+     *	The [Attributes](ctp:api:type:Attribute) of the Product Variant if you want to override the `attributes` property in the referenced [ProductVariant](ctp:api:type:ProductVariant).
+     *	If not set, the `attributes` from the referenced [ProductVariant](ctp:api:type:ProductVariant) are copied to the resulting Order.
+     *
+     *
+     */
+    readonly attributes?: Attribute[];
+    /**
+     *	The [Images](ctp:api:type:Image) of the Product Variant if you want to override the `images` property in the referenced [ProductVariant](ctp:api:type:ProductVariant).
+     *	If not set, the `images` from the referenced [ProductVariant](ctp:api:type:ProductVariant) are copied to the resulting Order.
+     *
+     *
+     */
+    readonly images?: Image[];
+}
+/**
+ *	Stores information about returns connected to an Order.
+ *
+ */
+export interface ReturnInfo {
+    /**
+     *	Information on the Line Items or Custom Line Items returned.
+     *
+     *
+     */
+    readonly items: ReturnItem[];
+    /**
+     *	User-defined identifier to track the return.
+     *
+     *
+     */
+    readonly returnTrackingId?: string;
+    /**
+     *	Date and time (UTC) the return is initiated.
+     *
+     *
+     */
+    readonly returnDate?: string;
+}
+export interface ReturnInfoDraft {
+    /**
+     *	Information on the Line Items or Custom Line Items returned.
+     *
+     *
+     */
+    readonly items: ReturnItemDraft[];
+    /**
+     *	User-defined identifier for tracking the return.
+     *
+     *
+     */
+    readonly returnTrackingId?: string;
+    /**
+     *	Date and time (UTC) the return is initiated.
+     *
+     *
+     */
+    readonly returnDate?: string;
+}
+export type ReturnItem = CustomLineItemReturnItem | LineItemReturnItem;
+export interface CustomLineItemReturnItem {
+    readonly type: 'CustomLineItemReturnItem';
+    /**
+     *	Unique identifier of the Return Item.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	User-defined unique identifier of the CustomLineItemReturnItem.
+     *
+     */
+    readonly key?: string;
+    /**
+     *	Number of Custom Line Items returned.
+     *
+     *
+     */
+    readonly quantity: number;
+    /**
+     *	User-defined description for the return.
+     *
+     *
+     */
+    readonly comment?: string;
+    /**
+     *	Shipment status of the Return Item.
+     *
+     *
+     */
+    readonly shipmentState: ReturnShipmentState;
+    /**
+     *	Payment status of the Return Item:
+     *
+     *	- `NonRefundable`, for items in the `Advised` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)
+     *	- `Initial`, for items in the `Returned` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)
+     *
+     *
+     */
+    readonly paymentState: ReturnPaymentState;
+    /**
+     *	Custom Fields of the Return Item.
+     *
+     *
+     */
+    readonly custom?: CustomFields;
+    /**
+     *	Date and time (UTC) the Return Item was last updated.
+     *
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	Date and time (UTC) the Return Item was intitially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	`id` of the returned [CustomLineItem](ctp:api:type:CustomLineItem).
+     *
+     *
+     */
+    readonly customLineItemId: string;
+}
+export interface LineItemReturnItem {
+    readonly type: 'LineItemReturnItem';
+    /**
+     *	Unique identifier of the Return Item.
+     *
+     *
+     */
+    readonly id: string;
+    /**
+     *	User-defined unique identifier of the LineItemReturnItem.
+     *
+     */
+    readonly key?: string;
+    /**
+     *	Number of Line Items returned.
+     *
+     *
+     */
+    readonly quantity: number;
+    /**
+     *	User-defined description for the return.
+     *
+     *
+     */
+    readonly comment?: string;
+    /**
+     *	Shipment status of the Return Item.
+     *
+     *
+     */
+    readonly shipmentState: ReturnShipmentState;
+    /**
+     *	Payment status of the Return Item:
+     *
+     *	- `NonRefundable`, for items in the `Advised` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)
+     *	- `Initial`, for items in the `Returned` [ReturnShipmentState](ctp:api:type:ReturnShipmentState)
+     *
+     *
+     */
+    readonly paymentState: ReturnPaymentState;
+    /**
+     *	Custom Fields of the Return Item.
+     *
+     *
+     */
+    readonly custom?: CustomFields;
+    /**
+     *	Date and time (UTC) the Return Item was last updated.
+     *
+     *
+     */
+    readonly lastModifiedAt: string;
+    /**
+     *	Date and time (UTC) the Return Item was intitially created.
+     *
+     *
+     */
+    readonly createdAt: string;
+    /**
+     *	`id` of the returned [LineItem](ctp:api:type:LineItem).
+     *
+     *
+     */
+    readonly lineItemId: string;
+}
+export interface ReturnItemDraft {
+    /**
+     *	User-defined unique identifier of the Return Item.
+     *
+     */
+    readonly key?: string;
+    /**
+     *	Number of Line Items or Custom Line Items to return.
+     *
+     *
+     */
+    readonly quantity: number;
+    /**
+     *	`id` of the [LineItem](ctp:api:type:LineItem) to return.
+     *
+     *	 Required if Line Items are returned, to create a [LineItemReturnItem](ctp:api:type:LineItemReturnItem).
+     *
+     *
+     */
+    readonly lineItemId?: string;
+    /**
+     *	`id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to return.
+     *
+     *	 Required if Custom Line Items are returned, to create a [CustomLineItemReturnItem](ctp:api:type:CustomLineItemReturnItem).
+     *
+     *
+     */
+    readonly customLineItemId?: string;
+    /**
+     *	User-defined description for the return.
+     *
+     *
+     */
+    readonly comment?: string;
+    /**
+     *	Shipment status of the item to be returned.
+     *	Can either be `Advised` or `Returned` only.
+     *
+     *
+     */
+    readonly shipmentState: ReturnShipmentState;
+    /**
+     *	Custom Fields for the Return Item.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+}
+export type ReturnPaymentState = 'Initial' | 'NonRefundable' | 'NotRefunded' | 'Refunded' | string;
+export type ReturnShipmentState = 'Advised' | 'BackInStock' | 'Returned' | 'Unusable' | string;
+/**
+ *	Indicates the shipment status of the Order.
+ *
+ */
+export type ShipmentState = 'Backorder' | 'Delayed' | 'Delivered' | 'Partial' | 'Pending' | 'Ready' | 'Shipped' | string;
+/**
+ *	Becomes the `shippingInfo` of the imported Order.
+ *
+ */
+export interface ShippingInfoImportDraft {
+    /**
+     *	Name of the Shipping Method.
+     *
+     *
+     */
+    readonly shippingMethodName: string;
+    /**
+     *	The base price for the Shipping Method.
+     *
+     *
+     */
+    readonly price: _Money;
+    /**
+     *	Shipping rate information for the Order.
+     *
+     *
+     */
+    readonly shippingRate: ShippingRateDraft;
+    /**
+     *	Include a Tax Rate for the Shipping Method.
+     *
+     *
+     */
+    readonly taxRate?: TaxRate;
+    /**
+     *	Include a value to associate a Tax Category with the shipping information.
+     *
+     *
+     */
+    readonly taxCategory?: TaxCategoryResourceIdentifier;
+    /**
+     *	Include a value to associate a Shipping Method with the Order.
+     *
+     *
+     */
+    readonly shippingMethod?: ShippingMethodResourceIdentifier;
+    /**
+     *	Information on how items are to be delivered to customers.
+     *
+     *
+     */
+    readonly deliveries?: DeliveryDraft[];
+    /**
+     *	Discounted Price of the Shipping Method.
+     *
+     *
+     */
+    readonly discountedPrice?: DiscountedLineItemPriceDraft;
+    /**
+     *	Indicates if the [ShippingMethod](ctp:api:type:ShippingMethod) referenced is allowed for the Order or not.
+     *
+     *
+     */
+    readonly shippingMethodState?: ShippingMethodState;
+}
+/**
+ *	Contains synchronization activity information of the Order (like export or import).
+ *
+ */
+export interface SyncInfo {
+    /**
+     *	Connection to a synchronization destination.
+     *
+     *
+     */
+    readonly channel: ChannelReference;
+    /**
+     *	Identifier of an external order instance, file, or other resource.
+     *
+     *
+     */
+    readonly externalId?: string;
+    /**
+     *	Date and time (UTC) the information was synced.
+     *
+     *
+     */
+    readonly syncedAt: string;
+}
+export interface TaxedItemPriceDraft {
+    /**
+     *	Draft object to store money in cent amounts for a specific currency.
+     *
+     */
+    readonly totalNet: _Money;
+    /**
+     *	Draft object to store money in cent amounts for a specific currency.
+     *
+     */
+    readonly totalGross: _Money;
+}
+/**
+ *	Information that helps track a Parcel.
+ *
+ */
+export interface TrackingData {
+    /**
+     *	Identifier to track the Parcel.
+     *
+     *
+     */
+    readonly trackingId?: string;
+    /**
+     *	Name of the carrier that delivers the Parcel.
+     *
+     *
+     */
+    readonly carrier?: string;
+    /**
+     *	Name of the provider that serves as facade to several carriers.
+     *
+     *
+     */
+    readonly provider?: string;
+    /**
+     *	Transaction identifier with the `provider`.
+     *
+     *
+     */
+    readonly providerTransaction?: string;
+    /**
+     *	- If `true`, the Parcel is being returned.
+     *	- If `false`, the Parcel is being delivered to the customer.
+     *
+     *
+     */
+    readonly isReturn?: boolean;
+}
+/**
+ *	A [Delivery](ctp:api:type:Delivery) can only be added to an [Order](ctp:api:type:Order) if
+ *	its `shippingInfo` (for `shippingMode` = `Single`), or its `shipping` (for `shippingMode` = `Multiple`) exists.
+ *
+ *	Produces the [Delivery Added](ctp:api:type:DeliveryAddedMessage) Message.
+ *
+ */
+export interface OrderAddDeliveryAction {
+    readonly action: 'addDelivery';
+    /**
+     *	`key` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *
+     */
+    readonly deliveryKey?: string;
+    /**
+     *	`key` of the [ShippingMethod](ctp:api:type:ShippingMethod), required for `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+     *
+     *
+     */
+    readonly shippingKey?: string;
+    /**
+     *	Line Items or Custom Line Items to be included in the Delivery.
+     *
+     *
+     */
+    readonly items?: DeliveryItem[];
+    /**
+     *	Address the `parcels` should be delivered to.
+     *
+     *
+     */
+    readonly address?: _BaseAddress;
+    /**
+     *	Parcels of the Delivery.
+     *
+     *	If provided, this update action produces the [Parcel Added To Delivery](ctp:api:type:ParcelAddedToDeliveryMessage) Message.
+     *
+     *
+     */
+    readonly parcels?: ParcelDraft[];
+    /**
+     *	Custom Fields for the Delivery.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+}
+/**
+ *	Adds an address to an Order when shipping to multiple addresses is desired.
+ *
+ */
+export interface OrderAddItemShippingAddressAction {
+    readonly action: 'addItemShippingAddress';
+    /**
+     *	Address to append to `itemShippingAddresses`.
+     *	The new Address must have a `key` that is unique across this Order.
+     *
+     *
+     */
+    readonly address: _BaseAddress;
+}
+/**
+ *	To add a Parcel, at least one [Delivery](ctp:api:type:Delivery) must exist.
+ *
+ *	Produces the [Parcel Added To Delivery](ctp:api:type:ParcelAddedToDeliveryMessage) Message.
+ *
+ */
+export interface OrderAddParcelToDeliveryAction {
+    readonly action: 'addParcelToDelivery';
+    /**
+     *	`id` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryId?: string;
+    /**
+     *	`key` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryKey?: string;
+    /**
+     *	`key` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *
+     */
+    readonly parcelKey?: string;
+    /**
+     *	Value to set.
+     *
+     *
+     */
+    readonly measurements?: ParcelMeasurements;
+    /**
+     *	Value to set.
+     *
+     *
+     */
+    readonly trackingData?: TrackingData;
+    /**
+     *	Value to set.
+     *
+     *
+     */
+    readonly items?: DeliveryItem[];
+    /**
+     *	Custom Fields for the Parcel.
+     *
+     *
+     */
+    readonly custom?: CustomFieldsDraft;
+}
+export interface OrderAddPaymentAction {
+    readonly action: 'addPayment';
+    /**
+     *	Payment to add to the [PaymentInfo](ctp:api:type:PaymentInfo).
+     *	Must not be assigned to another Order or active Cart already.
+     *
+     *
+     */
+    readonly payment: PaymentResourceIdentifier;
+}
+/**
+ *	Produces the [Return Info Added](ctp:api:type:ReturnInfoAddedMessage) Message.
+ *
+ */
+export interface OrderAddReturnInfoAction {
+    readonly action: 'addReturnInfo';
+    /**
+     *	Value to set.
+     *
+     *
+     */
+    readonly returnTrackingId?: string;
+    /**
+     *	Items to be returned.
+     *	Must not be empty.
+     *
+     *
+     */
+    readonly items: ReturnItemDraft[];
+    /**
+     *	Value to set.
+     *	If not set, it defaults to the current date and time.
+     *
+     *
+     */
+    readonly returnDate?: string;
+}
+/**
+ *	Produces the [Order State Changed](ctp:api:type:OrderStateChangedMessage) Message.
+ *
+ */
+export interface OrderChangeOrderStateAction {
+    readonly action: 'changeOrderState';
+    /**
+     *	New status of the Order.
+     *
+     *
+     */
+    readonly orderState: OrderState;
+}
+/**
+ *	Produces the [Order Payment State Changed](ctp:api:type:OrderPaymentStateChangedMessage) Message.
+ *
+ */
+export interface OrderChangePaymentStateAction {
+    readonly action: 'changePaymentState';
+    /**
+     *	New payment status of the Order.
+     *
+     *
+     */
+    readonly paymentState: PaymentState;
+}
+/**
+ *	Produces the [Order Shipment State Changed](ctp:api:type:OrderShipmentStateChangedMessage) Message.
+ *
+ */
+export interface OrderChangeShipmentStateAction {
+    readonly action: 'changeShipmentState';
+    /**
+     *	New shipment status of the Order.
+     *
+     *
+     */
+    readonly shipmentState: ShipmentState;
+}
+/**
+ *	The import of States does not follow any predefined rules and should be only used if no transitions are defined.
+ *	The `quantity` in the [ItemStates](ctp:api:type:ItemState) must match the sum of all Custom Line Item states' quantities.
+ *
+ */
+export interface OrderImportCustomLineItemStateAction {
+    readonly action: 'importCustomLineItemState';
+    /**
+     *	`id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
+     *
+     *
+     */
+    readonly customLineItemId?: string;
+    /**
+     *	`key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
+     *
+     *
+     */
+    readonly customLineItemKey?: string;
+    /**
+     *	New status of the Custom Line Items.
+     *
+     *
+     */
+    readonly state: ItemState[];
+}
+/**
+ *	The import of States does not follow any predefined rules and should be only used if no transitions are defined.
+ *	The `quantity` in the [ItemStates](ctp:api:type:ItemState) must match the sum of all Line Items states' quantities.
+ *
+ */
+export interface OrderImportLineItemStateAction {
+    readonly action: 'importLineItemState';
+    /**
+     *	`id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+     *
+     *
+     */
+    readonly lineItemId?: string;
+    /**
+     *	`key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+     *
+     *
+     */
+    readonly lineItemKey?: string;
+    /**
+     *	New status of the Line Items.
+     *
+     *
+     */
+    readonly state: ItemState[];
+}
+/**
+ *	Produces the [DeliveryRemoved](ctp:api:type:DeliveryRemovedMessage) Message.
+ *
+ */
+export interface OrderRemoveDeliveryAction {
+    readonly action: 'removeDelivery';
+    /**
+     *	`id` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryId?: string;
+    /**
+     *	`key` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryKey?: string;
+}
+/**
+ *	An address can only be removed if it is not referenced in any [ItemShippingTarget](ctp:api:type:ItemShippingTarget) of the Cart.
+ *	In such case, change the Line Item shipping address to a different `addressKey` first using the [Set LineItemShippingDetails](ctp:api:type:OrderSetLineItemShippingDetailsAction) update action, before you remove the obsolete address.
+ *
+ */
+export interface OrderRemoveItemShippingAddressAction {
+    readonly action: 'removeItemShippingAddress';
+    /**
+     *	`key` of the Address to remove from `itemShippingAddresses`.
+     *
+     *
+     */
+    readonly addressKey: string;
+}
+/**
+ *	Produces the [ParcelRemovedFromDelivery](ctp:api:type:ParcelRemovedFromDeliveryMessage) Message.
+ *
+ */
+export interface OrderRemoveParcelFromDeliveryAction {
+    readonly action: 'removeParcelFromDelivery';
+    /**
+     *	`id` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelId?: string;
+    /**
+     *	`key` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelKey?: string;
+}
+export interface OrderRemovePaymentAction {
+    readonly action: 'removePayment';
+    /**
+     *	Payment to remove from the [PaymentInfo](ctp:api:type:PaymentInfo).
+     *
+     *
+     */
+    readonly payment: PaymentResourceIdentifier;
+}
+/**
+ *	This action updates the `billingAddress` on the Order, but it does not change the billing address on the referenced [Cart](ctp:api:type:Cart) from which the Order is created.
+ *
+ *	Produces the [Order Billing Address Set](ctp:api:type:OrderBillingAddressSetMessage) Message.
+ *
+ */
+export interface OrderSetBillingAddressAction {
+    readonly action: 'setBillingAddress';
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly address?: _BaseAddress;
+}
+export interface OrderSetBillingAddressCustomFieldAction {
+    readonly action: 'setBillingAddressCustomField';
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface OrderSetBillingAddressCustomTypeAction {
+    readonly action: 'setBillingAddressCustomType';
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the `billingAddress` with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the `billingAddress`.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `billingAddress`.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+export interface OrderSetCustomFieldAction {
+    readonly action: 'setCustomField';
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface OrderSetCustomLineItemCustomFieldAction {
+    readonly action: 'setCustomLineItemCustomField';
+    /**
+     *	`id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
+     *
+     *
+     */
+    readonly customLineItemId?: string;
+    /**
+     *	`key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
+     *
+     *
+     */
+    readonly customLineItemKey?: string;
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface OrderSetCustomLineItemCustomTypeAction {
+    readonly action: 'setCustomLineItemCustomType';
+    /**
+     *	`id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
+     *
+     *
+     */
+    readonly customLineItemId?: string;
+    /**
+     *	`key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
+     *
+     *
+     */
+    readonly customLineItemKey?: string;
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the Custom Line Item with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the Custom Line Item.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Custom Line Item.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+export interface OrderSetCustomLineItemShippingDetailsAction {
+    readonly action: 'setCustomLineItemShippingDetails';
+    /**
+     *	`id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
+     *
+     *
+     */
+    readonly customLineItemId?: string;
+    /**
+     *	`key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
+     *
+     *
+     */
+    readonly customLineItemKey?: string;
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly shippingDetails?: ItemShippingDetailsDraft;
+}
+export interface OrderSetCustomTypeAction {
+    readonly action: 'setCustomType';
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the Order with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the Order.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Order.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+/**
+ *	This action updates the `customerEmail` on the Order, but it does not change the Customer email on the [Cart](ctp:api:type:Cart) the Order has been created from.
+ *
+ *	Produces the [Order Customer Email Set](ctp:api:type:OrderCustomerEmailSetMessage) Message.
+ *
+ */
+export interface OrderSetCustomerEmailAction {
+    readonly action: 'setCustomerEmail';
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly email?: string;
+}
+/**
+ *	Setting the Order's `customerId` does not recalculate prices or discounts on the Order.
+ *	If the Customer belongs to a Customer Group, `customerGroup` on the [Order](ctp:api:type:Order) is updated automatically.
+ *
+ *	Produces the [OrderCustomerSet](ctp:api:type:OrderCustomerSetMessage) Message.
+ *
+ */
+export interface OrderSetCustomerIdAction {
+    readonly action: 'setCustomerId';
+    /**
+     *	`id` of an existing [Customer](ctp:api:type:Customer).
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly customerId?: string;
+}
+/**
+ *	Produces the [DeliveryAddressSet](ctp:api:type:DeliveryAddressSetMessage) Message.
+ *
+ */
+export interface OrderSetDeliveryAddressAction {
+    readonly action: 'setDeliveryAddress';
+    /**
+     *	`id` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryId?: string;
+    /**
+     *	`key` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryKey?: string;
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly address?: _BaseAddress;
+}
+export interface OrderSetDeliveryAddressCustomFieldAction {
+    readonly action: 'setDeliveryAddressCustomField';
+    /**
+     *	`id` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryId?: string;
+    /**
+     *	`key` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryKey?: string;
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface OrderSetDeliveryAddressCustomTypeAction {
+    readonly action: 'setDeliveryAddressCustomType';
+    /**
+     *	`id` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryId?: string;
+    /**
+     *	`key` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryKey?: string;
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the [Delivery](ctp:api:type:Delivery) `address` with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the [Delivery](ctp:api:type:Delivery) `address`.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the [Delivery](ctp:api:type:Delivery) `address`.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+export interface OrderSetDeliveryCustomFieldAction {
+    readonly action: 'setDeliveryCustomField';
+    /**
+     *	`id` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryId?: string;
+    /**
+     *	`key` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryKey?: string;
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface OrderSetDeliveryCustomTypeAction {
+    readonly action: 'setDeliveryCustomType';
+    /**
+     *	`id` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryId?: string;
+    /**
+     *	`key` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryKey?: string;
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the Delivery with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the Delivery.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Delivery.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+/**
+ *	Produces the [Delivery Items Updated](ctp:api:type:DeliveryItemsUpdatedMessage) Message.
+ *
+ */
+export interface OrderSetDeliveryItemsAction {
+    readonly action: 'setDeliveryItems';
+    /**
+     *	`id` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryId?: string;
+    /**
+     *	`key` of an existing [Delivery](ctp:api:type:Delivery).
+     *
+     *	Either `deliveryId` or `deliveryKey` must be provided.
+     *
+     *
+     */
+    readonly deliveryKey?: string;
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly items: DeliveryItem[];
+}
+export interface OrderSetItemShippingAddressCustomFieldAction {
+    readonly action: 'setItemShippingAddressCustomField';
+    /**
+     *	`key` of the [Address](ctp:api:type:Address) in `itemShippingAddresses`.
+     *
+     *
+     */
+    readonly addressKey: string;
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface OrderSetItemShippingAddressCustomTypeAction {
+    readonly action: 'setItemShippingAddressCustomType';
+    /**
+     *	`key` of the [Address](ctp:api:type:Address) in `itemShippingAddresses`.
+     *
+     *
+     */
+    readonly addressKey: string;
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the `itemShippingAddress` with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the `itemShippingAddress`.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `itemShippingAddress`.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+export interface OrderSetLineItemCustomFieldAction {
+    readonly action: 'setLineItemCustomField';
+    /**
+     *	`id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+     *
+     *
+     */
+    readonly lineItemId?: string;
+    /**
+     *	`key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+     *
+     *
+     */
+    readonly lineItemKey?: string;
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface OrderSetLineItemCustomTypeAction {
+    readonly action: 'setLineItemCustomType';
+    /**
+     *	`id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+     *
+     *
+     */
+    readonly lineItemId?: string;
+    /**
+     *	`key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+     *
+     *
+     */
+    readonly lineItemKey?: string;
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the Line Item with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the Line Item.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Line Item.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+export interface OrderSetLineItemShippingDetailsAction {
+    readonly action: 'setLineItemShippingDetails';
+    /**
+     *	`id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+     *
+     *
+     */
+    readonly lineItemId?: string;
+    /**
+     *	`key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+     *
+     *
+     */
+    readonly lineItemKey?: string;
+    /**
+     *	Value to set.
+     *	If empty, the existing value is removed.
+     *
+     *
+     */
+    readonly shippingDetails?: ItemShippingDetailsDraft;
+}
+export interface OrderSetLocaleAction {
+    readonly action: 'setLocale';
+    /**
+     *	Value to set.
+     *	Must be one of the [Project](ctp:api:type:Project)'s languages.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly locale?: string;
+}
+export interface OrderSetOrderNumberAction {
+    readonly action: 'setOrderNumber';
+    /**
+     *	Value to set.
+     *	Must be unique across a Project.
+     *	Once set, the value cannot be changed.
+     *
+     *
+     */
+    readonly orderNumber?: string;
+}
+export interface OrderSetParcelCustomFieldAction {
+    readonly action: 'setParcelCustomField';
+    /**
+     *	`id` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelId?: string;
+    /**
+     *	`key` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelKey?: string;
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface OrderSetParcelCustomTypeAction {
+    readonly action: 'setParcelCustomType';
+    /**
+     *	`id` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelId?: string;
+    /**
+     *	`key` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelKey?: string;
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the Parcel with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the Parcel.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Parcel.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+/**
+ *	Produces the [ParcelItemsUpdated](ctp:api:type:ParcelItemsUpdatedMessage) Message.
+ *
+ */
+export interface OrderSetParcelItemsAction {
+    readonly action: 'setParcelItems';
+    /**
+     *	`id` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelId?: string;
+    /**
+     *	`key` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelKey?: string;
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly items: DeliveryItem[];
+}
+/**
+ *	Produces the [ParcelMeasurementsUpdated](ctp:api:type:ParcelMeasurementsUpdatedMessage) Message.
+ *
+ */
+export interface OrderSetParcelMeasurementsAction {
+    readonly action: 'setParcelMeasurements';
+    /**
+     *	`id` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelId?: string;
+    /**
+     *	`key` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelKey?: string;
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly measurements?: ParcelMeasurements;
+}
+/**
+ *	Produces the [ParcelTrackingDataUpdated](ctp:api:type:ParcelTrackingDataUpdatedMessage) Message.
+ *
+ */
+export interface OrderSetParcelTrackingDataAction {
+    readonly action: 'setParcelTrackingData';
+    /**
+     *	`id` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelId?: string;
+    /**
+     *	`key` of an existing [Parcel](ctp:api:type:Parcel).
+     *
+     *	Either `parcelId` or `parcelKey` must be provided.
+     *
+     *
+     */
+    readonly parcelKey?: string;
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly trackingData?: TrackingData;
+}
+/**
+ *	Produces the [PurchaseOrderNumberSet](ctp:api:type:OrderPurchaseOrderNumberSetMessage) Message.
+ *
+ */
+export interface OrderSetPurchaseOrderNumberAction {
+    readonly action: 'setPurchaseOrderNumber';
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly purchaseOrderNumber?: string;
+}
+/**
+ *	Produces the [Return Info Set](ctp:api:type:ReturnInfoSetMessage) Message.
+ *
+ */
+export interface OrderSetReturnInfoAction {
+    readonly action: 'setReturnInfo';
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly items?: ReturnInfoDraft[];
+}
+export interface OrderSetReturnItemCustomFieldAction {
+    readonly action: 'setReturnItemCustomField';
+    /**
+     *	`id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
+     *
+     *
+     */
+    readonly returnItemId?: string;
+    /**
+     *	`key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
+     *
+     *
+     */
+    readonly returnItemKey?: string;
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface OrderSetReturnItemCustomTypeAction {
+    readonly action: 'setReturnItemCustomType';
+    /**
+     *	`id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
+     *
+     *
+     */
+    readonly returnItemId?: string;
+    /**
+     *	`key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
+     *
+     *
+     */
+    readonly returnItemKey?: string;
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the Return Item with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the Return Item.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Return Item.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+/**
+ *	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).
+ *
+ */
+export interface OrderSetReturnPaymentStateAction {
+    readonly action: 'setReturnPaymentState';
+    /**
+     *	`id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
+     *
+     *
+     */
+    readonly returnItemId?: string;
+    /**
+     *	`key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
+     *
+     *
+     */
+    readonly returnItemKey?: string;
+    /**
+     *	New Payment status of the [ReturnItem](ctp:api:type:ReturnItem).
+     *
+     *
+     */
+    readonly paymentState: ReturnPaymentState;
+}
+/**
+ *	To set a `ReturnShipmentState`, the [Order](ctp:api:type:Order) `returnInfo` must have at least one [ReturnItem](ctp:api:type:ReturnItem).
+ *
+ *	Produces the [Order Return Shipment State Changed](ctp:api:type:OrderReturnShipmentStateChangedMessage) Message.
+ *
+ */
+export interface OrderSetReturnShipmentStateAction {
+    readonly action: 'setReturnShipmentState';
+    /**
+     *	`id` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
+     *
+     *
+     */
+    readonly returnItemId?: string;
+    /**
+     *	`key` of the [ReturnItem](ctp:api:type:ReturnItem) to update. Either `returnItemId` or `returnItemKey` is required.
+     *
+     *
+     */
+    readonly returnItemKey?: string;
+    /**
+     *	New shipment state of the [ReturnItem](ctp:api:type:ReturnItem).
+     *
+     *
+     */
+    readonly shipmentState: ReturnShipmentState;
+}
+/**
+ *	This action updates the `shippingAddress` on the Order, but it does not change the shipping address on the referenced [Cart](ctp:api:type:Cart) from which the Order is created.
+ *	Also, it does not recalculate the Cart as taxes may not fit to the shipping address anymore.
+ *
+ *	Produces the [Order Shipping Address Set](ctp:api:type:OrderShippingAddressSetMessage) Message.
+ *
+ */
+export interface OrderSetShippingAddressAction {
+    readonly action: 'setShippingAddress';
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *
+     */
+    readonly address?: _BaseAddress;
+}
+export interface OrderSetShippingAddressCustomFieldAction {
+    readonly action: 'setShippingAddressCustomField';
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+export interface OrderSetShippingAddressCustomTypeAction {
+    readonly action: 'setShippingAddressCustomType';
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the `shippingAddress` with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the `shippingAddress`.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `shippingAddress`.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+export interface OrderSetShippingCustomFieldAction {
+    readonly action: 'setShippingCustomField';
+    /**
+     *	The `shippingKey` of the [Shipping](ctp:api:type:Shipping) to customize. Used to specify which Shipping Method to customize
+     *	on a Order with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+     *	Leave this empty to customize the one and only ShippingMethod on a `Single` ShippingMode Order.
+     *
+     *
+     */
+    readonly shippingKey?: string;
+    /**
+     *	Name of the [Custom Field](/../api/projects/custom-fields).
+     *
+     *
+     */
+    readonly name: string;
+    /**
+     *	If `value` is absent or `null`, this field will be removed if it exists.
+     *	Trying to remove a field that does not exist will fail with an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
+     *	If `value` is provided, it is set for the field defined by `name`.
+     *
+     *
+     */
+    readonly value?: any;
+}
+/**
+ *	This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Order's `shippingMethod` or `shipping`.
+ *
+ */
+export interface OrderSetShippingCustomTypeAction {
+    readonly action: 'setShippingCustomType';
+    /**
+     *	The `shippingKey` of the [Shipping](ctp:api:type:Shipping) to customize. Used to specify which Shipping Method to customize
+     *	on a Order with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+     *	Leave this empty to customize the one and only ShippingMethod on a `Single` ShippingMode Order.
+     *
+     *
+     */
+    readonly shippingKey?: string;
+    /**
+     *	Defines the [Type](ctp:api:type:Type) that extends the specified ShippingMethod with [Custom Fields](/../api/projects/custom-fields).
+     *	If absent, any existing Type and Custom Fields are removed from the ShippingMethod.
+     *
+     *
+     */
+    readonly type?: TypeResourceIdentifier;
+    /**
+     *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `shippingMethod`.
+     *
+     *
+     */
+    readonly fields?: FieldContainer;
+}
+/**
+ *	Sets the [Store](ctp:api:type:Store) the Order is assigned to.
+ *	It should be used to migrate Orders to a new Store.
+ *	No validations are performed (such as that the Customer is allowed to create Orders in the Store).
+ *
+ *	Produces the [Order Store Set](ctp:api:type:OrderStoreSetMessage) Message.
+ *	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.
+ *
+ */
+export interface OrderSetStoreAction {
+    readonly action: 'setStore';
+    /**
+     *	Value to set.
+     *	If empty, any existing value is removed.
+     *
+     *	If `store` references the same Store the Order is currently assigned to or if you try to remove the value when no Store is currently assigned, a `400` error is returned.
+     *
+     *
+     */
+    readonly store?: StoreResourceIdentifier;
+}
+/**
+ *	Produces the [Custom Line Item State Transition](ctp:api:type:CustomLineItemStateTransitionMessage) Message.
+ *
+ */
+export interface OrderTransitionCustomLineItemStateAction {
+    readonly action: 'transitionCustomLineItemState';
+    /**
+     *	`id` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
+     *
+     *
+     */
+    readonly customLineItemId?: string;
+    /**
+     *	`key` of the [CustomLineItem](ctp:api:type:CustomLineItem) to update. Either `customLineItemId` or `customLineItemKey` is required.
+     *
+     *
+     */
+    readonly customLineItemKey?: string;
+    /**
+     *	Number of Custom Line Items that should transition [State](ctp:api:type:State).
+     *
+     *
+     */
+    readonly quantity: number;
+    /**
+     *	[State](ctp:api:type:State) the Custom Line Item should transition from.
+     *
+     *
+     */
+    readonly fromState: StateResourceIdentifier;
+    /**
+     *	[State](ctp:api:type:State) the Custom Line Item should transition to.
+     *
+     *
+     */
+    readonly toState: StateResourceIdentifier;
+    /**
+     *	Date and time (UTC) to perform the [State](ctp:api:type:State) transition.
+     *
+     *
+     */
+    readonly actualTransitionDate?: string;
+}
+/**
+ *	Produces the [Line Item State Transition](ctp:api:type:LineItemStateTransitionMessage) Message.
+ *
+ */
+export interface OrderTransitionLineItemStateAction {
+    readonly action: 'transitionLineItemState';
+    /**
+     *	`id` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+     *
+     *
+     */
+    readonly lineItemId?: string;
+    /**
+     *	`key` of the [LineItem](ctp:api:type:LineItem) to update. Either `lineItemId` or `lineItemKey` is required.
+     *
+     *
+     */
+    readonly lineItemKey?: string;
+    /**
+     *	Number of Line Items that should transition [State](ctp:api:type:State).
+     *
+     *
+     */
+    readonly quantity: number;
+    /**
+     *	[State](ctp:api:type:State) the Line Item should transition from.
+     *
+     *
+     */
+    readonly fromState: StateResourceIdentifier;
+    /**
+     *	[State](ctp:api:type:State) the Line Item should transition to.
+     *
+     *
+     */
+    readonly toState: StateResourceIdentifier;
+    /**
+     *	Date and time (UTC) to perform the [State](ctp:api:type:State) transition.
+     *
+     *
+     */
+    readonly actualTransitionDate?: string;
+}
+/**
+ *	If the existing [State](ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State.
+ *	If `transitions` is not set, no validation is performed.
+ *
+ *	This update action produces the [Order State Transition](ctp:api:type:OrderStateTransitionMessage) Message.
+ *
+ */
+export interface OrderTransitionStateAction {
+    readonly action: 'transitionState';
+    /**
+     *	Value to set.
+     *	If there is no State yet, the new State must be an initial State.
+     *
+     *
+     */
+    readonly state: StateResourceIdentifier;
+    /**
+     *	Set to `true` to turn off validation.
+     *
+     *
+     */
+    readonly force?: boolean;
+}
+/**
+ *	Updates an address in `itemShippingAddresses` by keeping the Address `key`.
+ *
+ */
+export interface OrderUpdateItemShippingAddressAction {
+    readonly action: 'updateItemShippingAddress';
+    /**
+     *	The new Address with the same `key` as the Address it will replace.
+     *
+     *
+     */
+    readonly address: _BaseAddress;
+}
+export interface OrderUpdateSyncInfoAction {
+    readonly action: 'updateSyncInfo';
+    /**
+     *	Set this to identify an external order instance, file, or other resource.
+     *
+     *
+     */
+    readonly externalId?: string;
+    /**
+     *	The synchronization destination to set. Must not be empty.
+     *	The referenced Channel must have the [Channel Role](ctp:api:type:ChannelRoleEnum) `OrderExport` or `OrderImport`.
+     *	Otherwise this update action returns an [InvalidInput](ctp:api:type:InvalidInputError) error.
+     *
+     *
+     */
+    readonly channel: ChannelResourceIdentifier;
+    /**
+     *	If not set, it defaults to the current date and time.
+     *
+     *
+     */
+    readonly syncedAt?: string;
+}
+//# sourceMappingURL=order.d.ts.map