order.ts

/**
 * 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,
  CustomLineItemImportDraft,
  DiscountCodeInfo,
  DiscountedLineItemPortion,
  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,
  CreatedBy,
  Image,
  LastModifiedBy,
  LocalizedString,
  PriceDraft,
  TypedMoney,
  _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,
  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,
  StagedOrderSetShippingMethodAction,
  StagedOrderSetShippingMethodTaxAmountAction,
  StagedOrderSetShippingMethodTaxRateAction,
  StagedOrderSetShippingRateInputAction,
  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
  | 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
  | StagedOrderSetShippingMethodAction
  | StagedOrderSetShippingMethodTaxAmountAction
  | StagedOrderSetShippingMethodTaxRateAction
  | StagedOrderSetShippingRateInputAction
  | 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[]
}
export type OrderSearchMatchType = 'all' | 'any' | string
export interface OrderSearchQueryExpressionValue {
  /**
   *
   */
  readonly field: string
  /**
   *
   */
  readonly boost?: number
  /**
   *
   */
  readonly customType?: string
}
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
}
export interface Delivery {
  /**
   *	Unique identifier of the Delivery.
   *
   */
  readonly id: string
  /**
   *
   */
  readonly createdAt: string
  /**
   *	Items which are shipped in this delivery regardless their distribution over several parcels.
   *	Can also be specified individually for each Parcel.
   *
   */
  readonly items: DeliveryItem[]
  /**
   *
   */
  readonly parcels: Parcel[]
  /**
   *
   */
  readonly address?: Address
  /**
   *	Custom Fields for the Transaction.
   *
   */
  readonly custom?: CustomFields
}
export interface DeliveryDraft {
  /**
   *	Items which are shipped in this delivery regardless their distribution over several parcels.
   *	Can also be specified individually for each Parcel.
   *
   */
  readonly items?: DeliveryItem[]
  /**
   *
   */
  readonly parcels?: ParcelDraft[]
  /**
   *
   */
  readonly address?: AddressDraft
  /**
   *	Custom Fields for the Transaction.
   *
   */
  readonly custom?: CustomFieldsDraft
}
export interface DeliveryItem {
  /**
   *	Unique identifier of the DeliveryItem.
   *
   */
  readonly id: string
  /**
   *
   */
  readonly quantity: number
}
export interface DiscountedLineItemPriceDraft {
  /**
   *	Draft type that stores amounts only in cent precision for the specified currency.
   *
   *
   */
  readonly value: _Money
  /**
   *
   */
  readonly includedDiscounts: DiscountedLineItemPortion[]
}
export interface ItemState {
  /**
   *
   */
  readonly quantity: number
  /**
   *
   */
  readonly state: StateReference
}
export interface LineItemImportDraft {
  /**
   *	ID of the existing product.
   *	You also need to specify the ID of the variant if this property is set or alternatively you can just specify SKU of the product variant.
   *
   */
  readonly productId?: string
  /**
   *	The product name.
   *
   */
  readonly name: LocalizedString
  /**
   *
   */
  readonly variant: ProductVariantImportDraft
  /**
   *
   */
  readonly price: PriceDraft
  /**
   *
   */
  readonly quantity: number
  /**
   *
   */
  readonly state?: ItemState[]
  /**
   *	Connection to a particular supplier.
   *	By providing supply channel information, you can uniquely identify
   *	inventory entries that should be reserved.
   *	The provided channel should have the
   *	InventorySupply role.
   *
   */
  readonly supplyChannel?: ChannelResourceIdentifier
  /**
   *	The channel is used to select a ProductPrice.
   *	The provided channel should have the ProductDistribution role.
   *
   */
  readonly distributionChannel?: ChannelResourceIdentifier
  /**
   *
   */
  readonly taxRate?: TaxRate
  /**
   *	The custom fields.
   *
   */
  readonly custom?: CustomFieldsDraft
  /**
   *	Inventory mode specific to the line item only, valid for the entire `quantity` of the line item.
   *	Set only if inventory mode should be different from the `inventoryMode` specified on the [OrderImportDraft](ctp:api:type:OrderImportDraft).
   *
   */
  readonly inventoryMode?: InventoryMode
  /**
   *
   */
  readonly shippingDetails?: ItemShippingDetailsDraft
}
export interface Order extends BaseResource {
  /**
   *	Unique identifier of the Order.
   *
   */
  readonly id: string
  /**
   *	The current version of the order.
   *
   */
  readonly version: number
  /**
   *
   */
  readonly createdAt: string
  /**
   *
   */
  readonly lastModifiedAt: string
  /**
   *	Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked).
   *
   *
   */
  readonly lastModifiedBy?: LastModifiedBy
  /**
   *	Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked).
   *
   *
   */
  readonly createdBy?: CreatedBy
  /**
   *	This field will only be present if it was set for Order Import
   *
   */
  readonly completedAt?: string
  /**
   *	String that uniquely identifies an order.
   *	It can be used to create more human-readable (in contrast to ID) identifier for the order.
   *	It should be unique across a project.
   *	Once it's set it cannot be changed.
   *
   */
  readonly orderNumber?: string
  /**
   *
   */
  readonly customerId?: string
  /**
   *
   */
  readonly customerEmail?: string
  /**
   *	Identifies carts and orders belonging to an anonymous session (the customer has not signed up/in yet).
   *
   */
  readonly anonymousId?: string
  /**
   *	The Business Unit the Order belongs to.
   *
   *
   */
  readonly businessUnit?: BusinessUnitKeyReference
  /**
   *
   */
  readonly store?: StoreKeyReference
  /**
   *
   */
  readonly lineItems: LineItem[]
  /**
   *
   */
  readonly customLineItems: CustomLineItem[]
  /**
   *
   */
  readonly totalPrice: TypedMoney
  /**
   *	The taxes are calculated based on the shipping address.
   *
   */
  readonly taxedPrice?: TaxedPrice
  /**
   *	Sum of `taxedPrice` of [ShippingInfo](ctp:api:type:ShippingInfo) across all Shipping Methods.
   *	For `Platform` [TaxMode](ctp:api:type:TaxMode), it is set automatically only if [shipping address is set](ctp:api:type:CartSetShippingAddressAction) or [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction) to the Cart.
   *
   */
  readonly taxedShippingPrice?: TaxedPrice
  /**
   *	Holds all shipping-related information per Shipping Method.
   *
   *	For `Multi` [ShippingMode](ctp:api:typeShippingMode), it is updated automatically after the Shipping Methods are added.
   *
   *
   */
  readonly shippingAddress?: Address
  /**
   *
   */
  readonly billingAddress?: Address
  /**
   *	Indicates whether one or multiple Shipping Methods are added to the Cart.
   *
   *
   */
  readonly shippingMode: ShippingMode
  /**
   *	User-defined unique identifier of the Shipping Method with `Single` [ShippingMode](ctp:api:type:ShippingMode).
   *
   *
   */
  readonly shippingKey?: string
  /**
   *	Custom Fields of the Shipping Method for `Single` [ShippingMode](ctp:api:type:ShippingMode).
   *
   *
   */
  readonly shippingCustomFields?: CustomFields
  /**
   *	Holds all shipping-related information per Shipping Method for `Multi` [ShippingMode](ctp:api:typeShippingMode).
   *
   *	It is updated automatically after the [Shipping Method is added](ctp:api:type:CartAddShippingMethodAction).
   *
   *
   */
  readonly shipping: Shipping[]
  /**
   *
   */
  readonly taxMode?: TaxMode
  /**
   *	When calculating taxes for `taxedPrice`, the selected mode is used for rouding.
   *
   */
  readonly taxRoundingMode?: RoundingMode
  /**
   *	Set when the customer is set and the customer is a member of a customer group.
   *	Used for product variant price selection.
   *
   */
  readonly customerGroup?: CustomerGroupReference
  /**
   *	A two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
   *	Used for product variant price selection.
   *
   */
  readonly country?: string
  /**
   *	One of the four predefined OrderStates.
   *
   */
  readonly orderState: OrderState
  /**
   *	This reference can point to a state in a custom workflow.
   *
   */
  readonly state?: StateReference
  /**
   *
   */
  readonly shipmentState?: ShipmentState
  /**
   *
   */
  readonly paymentState?: PaymentState
  /**
   *	Set if the ShippingMethod is set.
   *
   */
  readonly shippingInfo?: ShippingInfo
  /**
   *
   */
  readonly syncInfo: SyncInfo[]
  /**
   *
   */
  readonly returnInfo?: ReturnInfo[]
  /**
   *	The Purchase Order Number is typically set by the [Buyer](/quotes-overview#buyer) on a [QuoteRequest](ctp:api:type:QuoteRequest) to
   *	track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow).
   *
   */
  readonly purchaseOrderNumber?: string
  /**
   *
   */
  readonly discountCodes?: DiscountCodeInfo[]
  /**
   *	Internal-only field.
   *	@deprecated
   */
  readonly lastMessageSequenceNumber?: number
  /**
   *	Set when this order was created from a cart.
   *	The cart will have the state `Ordered`.
   *
   */
  readonly cart?: CartReference
  /**
   *	Set when this order was created from a quote.
   *
   */
  readonly quote?: QuoteReference
  /**
   *
   */
  readonly custom?: CustomFields
  /**
   *
   */
  readonly paymentInfo?: PaymentInfo
  /**
   *
   */
  readonly locale?: string
  /**
   *
   */
  readonly inventoryMode?: InventoryMode
  /**
   *
   */
  readonly origin: CartOrigin
  /**
   *	When calculating taxes for `taxedPrice`, the selected mode is used for calculating the price with LineItemLevel (horizontally) or UnitPriceLevel (vertically) calculation mode.
   *
   */
  readonly taxCalculationMode?: TaxCalculationMode
  /**
   *	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
  /**
   *	Contains addresses for orders with multiple shipping addresses.
   *
   */
  readonly itemShippingAddresses?: Address[]
  /**
   *	Automatically filled when a line item with LineItemMode `GiftLineItem` is removed from this order.
   *
   */
  readonly refusedGifts: CartDiscountReference[]
}
export type _Order = Order | StagedOrder
export interface OrderFromCartDraft {
  /**
   *	Unique identifier of the Cart from which you can create an Order.
   *	@deprecated
   */
  readonly id?: string
  /**
   *	ResourceIdentifier of the Cart from which the Order is created.
   *
   */
  readonly cart?: CartResourceIdentifier
  /**
   *	Expected version of the Cart from which the Order is created.
   *	If the expected version does not match the actual version, a [409 Conflict](/../api/errors#409-conflict) error will be returned.
   *
   *
   */
  readonly version: number
  /**
   *	String that uniquely identifies an order.
   *	It can be used to create more human-readable (in contrast to ID) identifier for the order.
   *	It should be unique across a project.
   *	Once it's set it cannot be changed.
   *	For easier use on Get, Update and Delete actions we suggest assigning order numbers that match the regular expression `[a-z0-9_\-]{2,36}`.
   *
   */
  readonly orderNumber?: string
  /**
   *	Identifier for a purchase order, usually in a B2B context.
   *	The Purchase Order Number is typically entered by the [Buyer](/quotes-overview#buyer) and can also be used with [Quotes](/quotes-overview).
   *
   */
  readonly purchaseOrderNumber?: string
  /**
   *	Payment state for the Order.
   *
   *
   */
  readonly paymentState?: PaymentState
  /**
   *	Shipment state for the Order.
   *
   *
   */
  readonly shipmentState?: ShipmentState
  /**
   *	Order will be created with `Open` status by default.
   *
   */
  readonly orderState?: OrderState
  /**
   *	[Reference](ctp:api:type:Reference) to a [State](ctp:api:type:State) indicating the Order's state.
   *
   *
   */
  readonly state?: StateResourceIdentifier
  /**
   *	[Custom Fields](/../api/projects/custom-fields) for the Order. The Custom Field type must match the type of the Custom Fields in the referenced [Cart](/../api/projects/carts#cart).
   *	If specified, the Custom Fields are merged with the Custom Fields on the referenced [Cart](/../api/projects/carts#cart) and added to the Order.
   *	If empty, the Custom Fields on the referenced [Cart](/../api/projects/carts#cart) are added to the Order automatically.
   *
   *
   */
  readonly custom?: CustomFieldsDraft
}
export interface OrderFromQuoteDraft {
  /**
   *	ResourceIdentifier of the Quote from which this Order is created. If the Quote has `QuoteState` in `Accepted`, `Declined` or `Withdrawn` then the order creation will fail. The creation will also fail if the `Quote` has expired (`validTo` check).
   *
   */
  readonly quote: QuoteResourceIdentifier
  /**
   *	`version` of the [Quote](ctp:api:type:Quote) from which an 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
  /**
   *	String that uniquely identifies an order.
   *	It can be used to create more human-readable (in contrast to ID) identifier for the order.
   *	It should be unique across a project.
   *	Once it's set it cannot be changed.
   *	For easier use on Get, Update and Delete actions we suggest assigning order numbers that match the regular expression `[a-z0-9_\-]{2,36}`.
   *
   */
  readonly orderNumber?: string
  /**
   *	Payment state of the Order.
   *
   *
   */
  readonly paymentState?: PaymentState
  /**
   *	Shipment state of the Order.
   *
   */
  readonly shipmentState?: ShipmentState
  /**
   *	Order will be created with `Open` status by default.
   *
   */
  readonly orderState?: OrderState
  /**
   *	[Reference](ctp:api:type:Reference) to a [State](ctp:api:type:State) indicating the Order's state.
   *
   *
   */
  readonly state?: StateResourceIdentifier
}
export interface OrderImportDraft {
  /**
   *	String that unique identifies an order.
   *	It can be used to create more human-readable (in contrast to ID) identifier for the order.
   *	It should be unique within a project.
   *
   */
  readonly orderNumber?: string
  /**
   *	If given the customer with that ID must exist in the project.
   *
   */
  readonly customerId?: string
  /**
   *	The customer email can be used when no check against existing Customers is desired during order import.
   *
   */
  readonly customerEmail?: string
  /**
   *	If not given `customLineItems` must not be empty.
   *
   */
  readonly lineItems?: LineItemImportDraft[]
  /**
   *	If not given `lineItems` must not be empty.
   *
   */
  readonly customLineItems?: CustomLineItemImportDraft[]
  /**
   *
   */
  readonly totalPrice: _Money
  /**
   *	Order Import does not support calculation of taxes.
   *	When setting the draft the taxedPrice is to be provided.
   *
   */
  readonly taxedPrice?: TaxedPriceDraft
  /**
   *
   */
  readonly shippingAddress?: _BaseAddress
  /**
   *
   */
  readonly billingAddress?: _BaseAddress
  /**
   *	Set when the customer is set and the customer is a member of a customer group.
   *	Used for product variant price selection.
   *
   */
  readonly customerGroup?: CustomerGroupResourceIdentifier
  /**
   *	A two-digit country code as per [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
   *	Used for product variant price selection.
   *
   */
  readonly country?: string
  /**
   *	If not given the `Open` state will be assigned by default.
   *
   */
  readonly orderState?: OrderState
  /**
   *	This reference can point to a state in a custom workflow.
   *
   */
  readonly state?: StateReference
  /**
   *
   */
  readonly shipmentState?: ShipmentState
  /**
   *
   */
  readonly paymentState?: PaymentState
  /**
   *	Set if the ShippingMethod is set.
   *
   */
  readonly shippingInfo?: ShippingInfoImportDraft
  /**
   *
   */
  readonly paymentInfo?: PaymentInfo
  /**
   *
   */
  readonly completedAt?: string
  /**
   *	The custom fields.
   *
   */
  readonly custom?: CustomFieldsDraft
  /**
   *	If not given the mode `None` will be assigned by default.
   *
   */
  readonly inventoryMode?: InventoryMode
  /**
   *	If not given the tax rounding mode `HalfEven` will be assigned by default.
   *
   */
  readonly taxRoundingMode?: RoundingMode
  /**
   *	Contains addresses for orders with multiple shipping addresses.
   *
   */
  readonly itemShippingAddresses?: BaseAddress[]
  /**
   *	The Business Unit the Cart belongs to.
   *
   *
   */
  readonly businessUnit?: BusinessUnitResourceIdentifier
  /**
   *
   */
  readonly store?: StoreResourceIdentifier
  /**
   *	The default origin is `Customer`.
   *
   */
  readonly origin?: CartOrigin
}
export interface OrderPagedQueryResponse {
  /**
   *	Number of [results requested](/../api/general-concepts#limit).
   *
   *
   */
  readonly limit: number
  /**
   *
   */
  readonly count: number
  /**
   *
   */
  readonly total?: number
  /**
   *	Number of [elements skipped](/../api/general-concepts#offset).
   *
   *
   */
  readonly offset: number
  /**
   *
   */
  readonly results: Order[]
}
export interface OrderReference {
  readonly typeId: 'order'
  /**
   *	Unique ID of the referenced resource.
   *
   *
   */
  readonly id: string
  /**
   *
   */
  readonly obj?: _Order
}
export interface OrderResourceIdentifier {
  readonly typeId: 'order'
  /**
   *	Unique identifier of the referenced resource. Required if `key` is absent.
   *
   *
   */
  readonly id?: string
  /**
   *	User-defined unique identifier of the referenced resource. Required if `id` is absent.
   *
   *
   */
  readonly key?: string
}
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.
   *
   */
  readonly limit?: number
  /**
   *	The number of search results to be skipped in the response for pagination.
   *
   */
  readonly offset?: number
}
export interface OrderSearchSorting {
  /**
   *
   */
  readonly field: string
  /**
   *
   */
  readonly language?: string
  /**
   *
   */
  readonly order?: OrderSearchSortOrder
  /**
   *
   */
  readonly mode?: OrderSearchSortMode
  /**
   *
   */
  readonly filter?: _OrderSearchQueryExpression
}
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 [409 Conflict](/../api/errors#409-conflict) 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
  | OrderSetStoreAction
  | OrderTransitionCustomLineItemStateAction
  | OrderTransitionLineItemStateAction
  | OrderTransitionStateAction
  | OrderUpdateItemShippingAddressAction
  | OrderUpdateSyncInfoAction
export interface Parcel {
  /**
   *	Unique identifier of the Parcel.
   *
   */
  readonly id: string
  /**
   *
   */
  readonly createdAt: string
  /**
   *
   */
  readonly measurements?: ParcelMeasurements
  /**
   *
   */
  readonly trackingData?: TrackingData
  /**
   *	The delivery items contained in this parcel.
   *
   */
  readonly items?: DeliveryItem[]
  /**
   *	Custom Fields of this parcel.
   *
   */
  readonly custom?: CustomFields
}
export interface ParcelDraft {
  /**
   *
   */
  readonly measurements?: ParcelMeasurements
  /**
   *
   */
  readonly trackingData?: TrackingData
  /**
   *	The delivery items contained in this parcel.
   *
   */
  readonly items?: DeliveryItem[]
  /**
   *	Custom Fields of this parcel.
   *
   */
  readonly custom?: CustomFieldsDraft
}
export interface ParcelMeasurements {
  /**
   *
   */
  readonly heightInMillimeter?: number
  /**
   *
   */
  readonly lengthInMillimeter?: number
  /**
   *
   */
  readonly widthInMillimeter?: number
  /**
   *
   */
  readonly weightInGram?: number
}
export interface PaymentInfo {
  /**
   *
   */
  readonly payments: PaymentReference[]
}
export type PaymentState = 'BalanceDue' | 'CreditOwed' | 'Failed' | 'Paid' | 'Pending' | string
export interface ProductVariantImportDraft {
  /**
   *	The sequential ID of the variant within the product.
   *	The variant with provided ID should exist in some existing product, so you also need to specify the productId if this property is set,
   *	or alternatively you can just specify SKU of the product variant.
   *
   */
  readonly id?: number
  /**
   *	The SKU of the existing variant.
   *
   */
  readonly sku?: string
  /**
   *	The [Embedded Prices](ctp:api:type:Price) of the variant.
   *	The prices should not contain two prices for the same price scope (same currency, country, customer group, channel, valid from and valid until).
   *	If this property is defined, then it will override the `prices` property from the original product variant, otherwise `prices` property from the original product variant would be copied in the resulting order.
   *
   */
  readonly prices?: PriceDraft[]
  /**
   *	If this property is defined, then it will override the `attributes` property from the original
   *	product variant, otherwise `attributes` property from the original product variant would be copied in the resulting order.
   *
   */
  readonly attributes?: Attribute[]
  /**
   *	If this property is defined, then it will override the `images` property from the original
   *	product variant, otherwise `images` property from the original product variant would be copied in the resulting order.
   *
   */
  readonly images?: Image[]
}
export interface ReturnInfo {
  /**
   *
   */
  readonly items: ReturnItem[]
  /**
   *	Identifies, which return tracking ID is connected to this particular return.
   *
   */
  readonly returnTrackingId?: string
  /**
   *
   */
  readonly returnDate?: string
}
export interface ReturnInfoDraft {
  /**
   *
   */
  readonly items: ReturnItemDraft[]
  /**
   *	Identifies, which return tracking ID is connected to this particular return.
   *
   */
  readonly returnTrackingId?: string
  /**
   *
   */
  readonly returnDate?: string
}
export type ReturnItem = CustomLineItemReturnItem | LineItemReturnItem
export interface CustomLineItemReturnItem {
  readonly type: 'CustomLineItemReturnItem'
  /**
   *	Unique identifier of the ReturnItem.
   *
   */
  readonly id: string
  /**
   *
   */
  readonly quantity: number
  /**
   *
   */
  readonly comment?: string
  /**
   *
   */
  readonly shipmentState: ReturnShipmentState
  /**
   *
   */
  readonly paymentState: ReturnPaymentState
  /**
   *	Custom Fields of this return item.
   *
   */
  readonly custom?: CustomFields
  /**
   *
   */
  readonly lastModifiedAt: string
  /**
   *
   */
  readonly createdAt: string
  /**
   *
   */
  readonly customLineItemId: string
}
export interface LineItemReturnItem {
  readonly type: 'LineItemReturnItem'
  /**
   *	Unique identifier of the ReturnItem.
   *
   */
  readonly id: string
  /**
   *
   */
  readonly quantity: number
  /**
   *
   */
  readonly comment?: string
  /**
   *
   */
  readonly shipmentState: ReturnShipmentState
  /**
   *
   */
  readonly paymentState: ReturnPaymentState
  /**
   *	Custom Fields of this return item.
   *
   */
  readonly custom?: CustomFields
  /**
   *
   */
  readonly lastModifiedAt: string
  /**
   *
   */
  readonly createdAt: string
  /**
   *
   */
  readonly lineItemId: string
}
export interface ReturnItemDraft {
  /**
   *
   */
  readonly quantity: number
  /**
   *
   */
  readonly lineItemId?: string
  /**
   *
   */
  readonly customLineItemId?: string
  /**
   *
   */
  readonly comment?: string
  /**
   *
   */
  readonly shipmentState: ReturnShipmentState
  /**
   *	Custom Fields of this return item.
   *
   */
  readonly custom?: CustomFieldsDraft
}
export type ReturnPaymentState = 'Initial' | 'NonRefundable' | 'NotRefunded' | 'Refunded' | string
export type ReturnShipmentState = 'Advised' | 'BackInStock' | 'Returned' | 'Unusable' | string
export type ShipmentState = 'Backorder' | 'Delayed' | 'Delivered' | 'Partial' | 'Pending' | 'Ready' | 'Shipped' | string
export interface ShippingInfoImportDraft {
  /**
   *
   */
  readonly shippingMethodName: string
  /**
   *
   */
  readonly price: _Money
  /**
   *	The shipping rate used to determine the price.
   *
   */
  readonly shippingRate: ShippingRateDraft
  /**
   *
   */
  readonly taxRate?: TaxRate
  /**
   *
   */
  readonly taxCategory?: TaxCategoryResourceIdentifier
  /**
   *	Not set if custom shipping method is used.
   *
   */
  readonly shippingMethod?: ShippingMethodResourceIdentifier
  /**
   *	Deliveries are compilations of information on how the articles are being delivered to the customers.
   *
   */
  readonly deliveries?: DeliveryDraft[]
  /**
   *
   */
  readonly discountedPrice?: DiscountedLineItemPriceDraft
  /**
   *	Indicates whether the ShippingMethod referenced is allowed for the cart or not.
   *
   */
  readonly shippingMethodState?: ShippingMethodState
}
export interface SyncInfo {
  /**
   *	Connection to a particular synchronization destination.
   *
   */
  readonly channel: ChannelReference
  /**
   *	Can be used to reference an external order instance, file etc.
   *
   */
  readonly externalId?: string
  /**
   *
   */
  readonly syncedAt: string
}
export interface TaxedItemPriceDraft {
  /**
   *	Draft type that stores amounts only in cent precision for the specified currency.
   *
   *
   */
  readonly totalNet: _Money
  /**
   *	Draft type that stores amounts only in cent precision for the specified currency.
   *
   *
   */
  readonly totalGross: _Money
}
export interface TrackingData {
  /**
   *	The ID to track one parcel.
   *
   */
  readonly trackingId?: string
  /**
   *	The carrier that delivers the parcel.
   *
   */
  readonly carrier?: string
  /**
   *
   */
  readonly provider?: string
  /**
   *
   */
  readonly providerTransaction?: string
  /**
   *	Flag to distinguish if the parcel is on the way to the customer (false) or on the way back (true).
   *
   */
  readonly isReturn?: boolean
}
export interface OrderAddDeliveryAction {
  readonly action: 'addDelivery'
  /**
   *
   */
  readonly items?: DeliveryItem[]
  /**
   *	User-defined unique identifier of the Shipping Method in a Cart with `Multi` [ShippingMode](ctp:api:type:ShippingMode).
   *
   *
   */
  readonly shippingKey?: string
  /**
   *	Polymorphic base type that represents a postal address and contact details.
   *	Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
   *	only differ in the data type for the optional `custom` field.
   *
   *
   */
  readonly address?: _BaseAddress
  /**
   *
   */
  readonly parcels?: ParcelDraft[]
  /**
   *	Custom Fields for the Transaction.
   *
   */
  readonly custom?: CustomFieldsDraft
}
export interface OrderAddItemShippingAddressAction {
  readonly action: 'addItemShippingAddress'
  /**
   *	Polymorphic base type that represents a postal address and contact details.
   *	Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
   *	only differ in the data type for the optional `custom` field.
   *
   *
   */
  readonly address: _BaseAddress
}
export interface OrderAddParcelToDeliveryAction {
  readonly action: 'addParcelToDelivery'
  /**
   *
   */
  readonly deliveryId: string
  /**
   *
   */
  readonly measurements?: ParcelMeasurements
  /**
   *
   */
  readonly trackingData?: TrackingData
  /**
   *
   */
  readonly items?: DeliveryItem[]
}
export interface OrderAddPaymentAction {
  readonly action: 'addPayment'
  /**
   *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment).
   *
   *
   */
  readonly payment: PaymentResourceIdentifier
}
export interface OrderAddReturnInfoAction {
  readonly action: 'addReturnInfo'
  /**
   *
   */
  readonly returnTrackingId?: string
  /**
   *
   */
  readonly items: ReturnItemDraft[]
  /**
   *
   */
  readonly returnDate?: string
}
export interface OrderChangeOrderStateAction {
  readonly action: 'changeOrderState'
  /**
   *
   */
  readonly orderState: OrderState
}
export interface OrderChangePaymentStateAction {
  readonly action: 'changePaymentState'
  /**
   *
   */
  readonly paymentState?: PaymentState
}
export interface OrderChangeShipmentStateAction {
  readonly action: 'changeShipmentState'
  /**
   *
   */
  readonly shipmentState?: ShipmentState
}
export interface OrderImportCustomLineItemStateAction {
  readonly action: 'importCustomLineItemState'
  /**
   *
   */
  readonly customLineItemId: string
  /**
   *
   */
  readonly state: ItemState[]
}
export interface OrderImportLineItemStateAction {
  readonly action: 'importLineItemState'
  /**
   *
   */
  readonly lineItemId: string
  /**
   *
   */
  readonly state: ItemState[]
}
export interface OrderRemoveDeliveryAction {
  readonly action: 'removeDelivery'
  /**
   *
   */
  readonly deliveryId: string
}
export interface OrderRemoveItemShippingAddressAction {
  readonly action: 'removeItemShippingAddress'
  /**
   *
   */
  readonly addressKey: string
}
export interface OrderRemoveParcelFromDeliveryAction {
  readonly action: 'removeParcelFromDelivery'
  /**
   *
   */
  readonly parcelId: string
}
export interface OrderRemovePaymentAction {
  readonly action: 'removePayment'
  /**
   *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment).
   *
   *
   */
  readonly payment: PaymentResourceIdentifier
}
export interface OrderSetBillingAddressAction {
  readonly action: 'setBillingAddress'
  /**
   *	Polymorphic base type that represents a postal address and contact details.
   *	Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
   *	only differ in the data type for the optional `custom` field.
   *
   *
   */
  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'
  /**
   *
   */
  readonly customLineItemId: 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'
  /**
   *
   */
  readonly customLineItemId: string
  /**
   *	Defines the [Type](ctp:api:type:Type) that extends the CustomLineItem with [Custom Fields](/../api/projects/custom-fields).
   *	If absent, any existing Type and Custom Fields are removed from the CustomLineItem.
   *
   *
   */
  readonly type?: TypeResourceIdentifier
  /**
   *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the CustomLineItem.
   *
   *
   */
  readonly fields?: FieldContainer
}
export interface OrderSetCustomLineItemShippingDetailsAction {
  readonly action: 'setCustomLineItemShippingDetails'
  /**
   *
   */
  readonly customLineItemId: string
  /**
   *	For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items.
   *
   *
   */
  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
}
export interface OrderSetCustomerEmailAction {
  readonly action: 'setCustomerEmail'
  /**
   *
   */
  readonly email?: string
}
export interface OrderSetCustomerIdAction {
  readonly action: 'setCustomerId'
  /**
   *
   */
  readonly customerId?: string
}
export interface OrderSetDeliveryAddressAction {
  readonly action: 'setDeliveryAddress'
  /**
   *
   */
  readonly deliveryId: string
  /**
   *	Polymorphic base type that represents a postal address and contact details.
   *	Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
   *	only differ in the data type for the optional `custom` field.
   *
   *
   */
  readonly address?: _BaseAddress
}
export interface OrderSetDeliveryAddressCustomFieldAction {
  readonly action: 'setDeliveryAddressCustomField'
  /**
   *
   */
  readonly deliveryId: 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'
  /**
   *
   */
  readonly deliveryId: string
  /**
   *	Defines the [Type](ctp:api:type:Type) that extends the `address` in a Delivery with [Custom Fields](/../api/projects/custom-fields).
   *	If absent, any existing Type and Custom Fields are removed from the `address` in a Delivery.
   *
   *
   */
  readonly type?: TypeResourceIdentifier
  /**
   *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `address` in a Delivery.
   *
   *
   */
  readonly fields?: FieldContainer
}
export interface OrderSetDeliveryCustomFieldAction {
  readonly action: 'setDeliveryCustomField'
  /**
   *
   */
  readonly deliveryId: 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'
  /**
   *
   */
  readonly deliveryId: 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
}
export interface OrderSetDeliveryItemsAction {
  readonly action: 'setDeliveryItems'
  /**
   *
   */
  readonly deliveryId: string
  /**
   *
   */
  readonly items: DeliveryItem[]
}
export interface OrderSetItemShippingAddressCustomFieldAction {
  readonly action: 'setItemShippingAddressCustomField'
  /**
   *
   */
  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'
  /**
   *
   */
  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'
  /**
   *
   */
  readonly lineItemId: 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'
  /**
   *
   */
  readonly lineItemId: string
  /**
   *	Defines the [Type](ctp:api:type:Type) that extends the LineItem with [Custom Fields](/../api/projects/custom-fields).
   *	If absent, any existing Type and Custom Fields are removed from the LineItem.
   *
   *
   */
  readonly type?: TypeResourceIdentifier
  /**
   *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the LineItem.
   *
   *
   */
  readonly fields?: FieldContainer
}
export interface OrderSetLineItemShippingDetailsAction {
  readonly action: 'setLineItemShippingDetails'
  /**
   *
   */
  readonly lineItemId: string
  /**
   *	For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items.
   *
   *
   */
  readonly shippingDetails?: ItemShippingDetailsDraft
}
export interface OrderSetLocaleAction {
  readonly action: 'setLocale'
  /**
   *
   */
  readonly locale?: string
}
export interface OrderSetOrderNumberAction {
  readonly action: 'setOrderNumber'
  /**
   *
   */
  readonly orderNumber?: string
}
export interface OrderSetParcelCustomFieldAction {
  readonly action: 'setParcelCustomField'
  /**
   *
   */
  readonly parcelId: 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'
  /**
   *
   */
  readonly parcelId: 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
}
export interface OrderSetParcelItemsAction {
  readonly action: 'setParcelItems'
  /**
   *
   */
  readonly parcelId: string
  /**
   *
   */
  readonly items: DeliveryItem[]
}
export interface OrderSetParcelMeasurementsAction {
  readonly action: 'setParcelMeasurements'
  /**
   *
   */
  readonly parcelId: string
  /**
   *
   */
  readonly measurements?: ParcelMeasurements
}
export interface OrderSetParcelTrackingDataAction {
  readonly action: 'setParcelTrackingData'
  /**
   *
   */
  readonly parcelId: string
  /**
   *
   */
  readonly trackingData?: TrackingData
}
export interface OrderSetPurchaseOrderNumberAction {
  readonly action: 'setPurchaseOrderNumber'
  /**
   *	Identifier for a purchase order, usually in a B2B context.
   *	The Purchase Order Number is typically entered by the [Buyer](/quotes-overview#buyer) and can also be used with [Quotes](/quotes-overview).
   *
   */
  readonly purchaseOrderNumber?: string
}
export interface OrderSetReturnInfoAction {
  readonly action: 'setReturnInfo'
  /**
   *
   */
  readonly items?: ReturnInfoDraft[]
}
export interface OrderSetReturnItemCustomFieldAction {
  readonly action: 'setReturnItemCustomField'
  /**
   *
   */
  readonly returnItemId: 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'
  /**
   *
   */
  readonly returnItemId: string
  /**
   *	Defines the [Type](ctp:api:type:Type) that extends the ReturnItem with [Custom Fields](/../api/projects/custom-fields).
   *	If absent, any existing Type and Custom Fields are removed from the ReturnItem.
   *
   *
   */
  readonly type?: TypeResourceIdentifier
  /**
   *	Sets the [Custom Fields](/../api/projects/custom-fields) fields for the ReturnItem.
   *
   *
   */
  readonly fields?: FieldContainer
}
export interface OrderSetReturnPaymentStateAction {
  readonly action: 'setReturnPaymentState'
  /**
   *
   */
  readonly returnItemId: string
  /**
   *
   */
  readonly paymentState: ReturnPaymentState
}
export interface OrderSetReturnShipmentStateAction {
  readonly action: 'setReturnShipmentState'
  /**
   *
   */
  readonly returnItemId: string
  /**
   *
   */
  readonly shipmentState: ReturnShipmentState
}
export interface OrderSetShippingAddressAction {
  readonly action: 'setShippingAddress'
  /**
   *	Polymorphic base type that represents a postal address and contact details.
   *	Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
   *	only differ in the data type for the optional `custom` field.
   *
   *
   */
  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 OrderSetStoreAction {
  readonly action: 'setStore'
  /**
   *	[ResourceIdentifier](/../api/types#resourceidentifier) to a [Store](ctp:api:type:Store).
   *
   *
   */
  readonly store?: StoreResourceIdentifier
}
export interface OrderTransitionCustomLineItemStateAction {
  readonly action: 'transitionCustomLineItemState'
  /**
   *
   */
  readonly customLineItemId: string
  /**
   *
   */
  readonly quantity: number
  /**
   *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
   *
   *
   */
  readonly fromState: StateResourceIdentifier
  /**
   *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
   *
   *
   */
  readonly toState: StateResourceIdentifier
  /**
   *
   */
  readonly actualTransitionDate?: string
}
export interface OrderTransitionLineItemStateAction {
  readonly action: 'transitionLineItemState'
  /**
   *
   */
  readonly lineItemId: string
  /**
   *
   */
  readonly quantity: number
  /**
   *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
   *
   *
   */
  readonly fromState: StateResourceIdentifier
  /**
   *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
   *
   *
   */
  readonly toState: StateResourceIdentifier
  /**
   *
   */
  readonly actualTransitionDate?: string
}
export interface OrderTransitionStateAction {
  readonly action: 'transitionState'
  /**
   *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
   *
   *
   */
  readonly state: StateResourceIdentifier
  /**
   *
   */
  readonly force?: boolean
}
export interface OrderUpdateItemShippingAddressAction {
  readonly action: 'updateItemShippingAddress'
  /**
   *	Polymorphic base type that represents a postal address and contact details.
   *	Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
   *	only differ in the data type for the optional `custom` field.
   *
   *
   */
  readonly address: _BaseAddress
}
export interface OrderUpdateSyncInfoAction {
  readonly action: 'updateSyncInfo'
  /**
   *	[ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel).
   *
   *
   */
  readonly channel: ChannelResourceIdentifier
  /**
   *
   */
  readonly externalId?: string
  /**
   *
   */
  readonly syncedAt?: string
}