Package com.commercetools.api.models.order
package com.commercetools.api.models.order
-
ClassDescriptionCustom Line Items contain generic user-defined items that are not linked to Products.CustomLineItemImportDraftBuilder Example to create an instance using the builder patternCustom Line Items contain generic user-defined items that are not linked to Products.CustomLineItemReturnItem Example to create an instance using the builder patternCustomLineItemReturnItemBuilder Example to create an instance using the builder patternCustomLineItemReturnItemContains information on how items are shipped to Customers, for example, a delivery note.DeliveryBuilder Example to create an instance using the builder patternDeliveryDraft Example to create an instance using the builder patternDeliveryDraftBuilder Example to create an instance using the builder patternDeliveryDraftContains information on how items are shipped to Customers, for example, a delivery note.DeliveryItem Example to create an instance using the builder patternDeliveryItemBuilder Example to create an instance using the builder patternDeliveryItemDiscountedLineItemPriceDraft Example to create an instance using the builder patternDiscountedLineItemPriceDraftBuilder Example to create an instance using the builder patternDiscountedLineItemPriceDraftHit Example to create an instance using the builder patternHitBuilder Example to create an instance using the builder patternHitItemState Example to create an instance using the builder patternItemStateBuilder Example to create an instance using the builder patternItemStateRepresents a snapshot of a Product Variant at the time it was imported with the Order.LineItemImportDraftBuilder Example to create an instance using the builder patternRepresents a snapshot of a Product Variant at the time it was imported with the Order.LineItemReturnItem Example to create an instance using the builder patternLineItemReturnItemBuilder Example to create an instance using the builder patternLineItemReturnItemOrder Example to create an instance using the builder patternA Delivery can only be added to an Order if its
shippingInfo
(forshippingMode
=Single
), or itsshipping
(forshippingMode
=Multiple
) exists.OrderAddDeliveryActionBuilder Example to create an instance using the builder patternA Delivery can only be added to an Order if itsshippingInfo
(forshippingMode
=Single
), or itsshipping
(forshippingMode
=Multiple
) exists.Adds an address to an Order when shipping to multiple addresses is desired.OrderAddItemShippingAddressActionBuilder Example to create an instance using the builder patternAdds an address to an Order when shipping to multiple addresses is desired.To add a Parcel, at least one Delivery must exist.OrderAddParcelToDeliveryActionBuilder Example to create an instance using the builder patternTo add a Parcel, at least one Delivery must exist.OrderAddPaymentAction Example to create an instance using the builder patternOrderAddPaymentActionBuilder Example to create an instance using the builder patternOrderAddPaymentActionProduces the Return Info Added Message.OrderAddReturnInfoActionBuilder Example to create an instance using the builder patternProduces the Return Info Added Message.OrderBuilder Example to create an instance using the builder patternProduces the Order State Changed Message.OrderChangeOrderStateActionBuilder Example to create an instance using the builder patternProduces the Order State Changed Message.Produces the Order Payment State Changed Message.OrderChangePaymentStateActionBuilder Example to create an instance using the builder patternProduces the Order Payment State Changed Message.Produces the Order Shipment State Changed Message.OrderChangeShipmentStateActionBuilder Example to create an instance using the builder patternProduces the Order Shipment State Changed Message.OrderFromCartDraft Example to create an instance using the builder patternOrderFromCartDraftBuilder Example to create an instance using the builder patternOrderFromCartDraftOrderFromQuoteDraft Example to create an instance using the builder patternOrderFromQuoteDraftBuilder Example to create an instance using the builder patternOrderFromQuoteDraftOrderThe import of States does not follow any predefined rules and should be only used if no transitions are defined.OrderImportCustomLineItemStateActionBuilder Example to create an instance using the builder patternThe import of States does not follow any predefined rules and should be only used if no transitions are defined.A snapshot of an Order at the time it was imported.OrderImportDraftBuilder Example to create an instance using the builder patternA snapshot of an Order at the time it was imported.The import of States does not follow any predefined rules and should be only used if no transitions are defined.OrderImportLineItemStateActionBuilder Example to create an instance using the builder patternThe import of States does not follow any predefined rules and should be only used if no transitions are defined.Interface to collect the common stuff between carts and orders.PagedQueryResult withresults
containing an array of Order.OrderPagedQueryResponseBuilder Example to create an instance using the builder patternPagedQueryResult withresults
containing an array of Order.OrderPagedSearchResponse Example to create an instance using the builder patternOrderPagedSearchResponseBuilder Example to create an instance using the builder patternOrderPagedSearchResponseReference to an Order.OrderReferenceBuilder Example to create an instance using the builder patternReference to an Order.Produces the DeliveryRemoved Message.OrderRemoveDeliveryActionBuilder Example to create an instance using the builder patternProduces the DeliveryRemoved Message.An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.OrderRemoveItemShippingAddressActionBuilder Example to create an instance using the builder patternAn address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.Produces the ParcelRemovedFromDelivery Message.OrderRemoveParcelFromDeliveryActionBuilder Example to create an instance using the builder patternProduces the ParcelRemovedFromDelivery Message.OrderRemovePaymentAction Example to create an instance using the builder patternOrderRemovePaymentActionBuilder Example to create an instance using the builder patternOrderRemovePaymentActionDeprecated.Deprecated.Deprecated.OrderSearchAndExpression Example to create an instance using the builder patternOrderSearchAndExpressionBuilder Example to create an instance using the builder patternOrderSearchAndExpressionOrderSearchAnyValue Example to create an instance using the builder patternOrderSearchAnyValueBuilder Example to create an instance using the builder patternOrderSearchAnyValueOrderSearchCompoundExpression Example to create an instance using the builder patternOrderSearchCompoundExpressionBuilder Example to create an instance using the builder patternOrderSearchCompoundExpressionOrderSearchDateRangeExpression Example to create an instance using the builder patternOrderSearchDateRangeExpressionBuilder Example to create an instance using the builder patternOrderSearchDateRangeExpressionOrderSearchDateRangeValue Example to create an instance using the builder patternOrderSearchDateRangeValueBuilder Example to create an instance using the builder patternOrderSearchDateRangeValueOrderSearchExactExpression Example to create an instance using the builder patternOrderSearchExactExpressionBuilder Example to create an instance using the builder patternOrderSearchExactExpressionOrderSearchExistsExpression Example to create an instance using the builder patternOrderSearchExistsExpressionBuilder Example to create an instance using the builder patternOrderSearchExistsExpressionOrderSearchFilterExpression Example to create an instance using the builder patternOrderSearchFilterExpressionBuilder Example to create an instance using the builder patternOrderSearchFilterExpressionOrderSearchFullTextExpression Example to create an instance using the builder patternOrderSearchFullTextExpressionBuilder Example to create an instance using the builder patternOrderSearchFullTextExpressionOrderSearchFullTextValue Example to create an instance using the builder patternOrderSearchFullTextValueBuilder Example to create an instance using the builder patternOrderSearchFullTextValueOrderSearchLongRangeExpression Example to create an instance using the builder patternOrderSearchLongRangeExpressionBuilder Example to create an instance using the builder patternOrderSearchLongRangeExpressionOrderSearchLongRangeValue Example to create an instance using the builder patternOrderSearchLongRangeValueBuilder Example to create an instance using the builder patternOrderSearchLongRangeValueOrderSearchMatchTypepossible values of OrderSearchMatchTypeOrderSearchNotExpression Example to create an instance using the builder patternOrderSearchNotExpressionBuilder Example to create an instance using the builder patternOrderSearchNotExpressionOrderSearchNumberRangeExpression Example to create an instance using the builder patternOrderSearchNumberRangeExpressionBuilder Example to create an instance using the builder patternOrderSearchNumberRangeExpressionOrderSearchNumberRangeValue Example to create an instance using the builder patternOrderSearchNumberRangeValueBuilder Example to create an instance using the builder patternOrderSearchNumberRangeValueOrderSearchOrExpression Example to create an instance using the builder patternOrderSearchOrExpressionBuilder Example to create an instance using the builder patternOrderSearchOrExpressionOrderSearchPrefixExpression Example to create an instance using the builder patternOrderSearchPrefixExpressionBuilder Example to create an instance using the builder patternOrderSearchPrefixExpressionOrderSearchQuery Example to create an instance using the builder patternOrderSearchQueryBuilder Example to create an instance using the builder patternOrderSearchQueryExpression Example to create an instance using the builder patternOrderSearchQueryExpressionBuilder Example to create an instance using the builder patternOrderSearchQueryExpressionOrderSearchQueryExpressionValue Example to create an instance using the builder patternOrderSearchQueryExpressionValueBuilder Example to create an instance using the builder patternOrderSearchQueryExpressionValueOrderSearchQueryOrderSearchRequest Example to create an instance using the builder patternOrderSearchRequestBuilder Example to create an instance using the builder patternOrderSearchRequestOrderSearchSorting Example to create an instance using the builder patternOrderSearchSortingBuilder Example to create an instance using the builder patternOrderSearchSortingOrderSearchSortModepossible values of OrderSearchSortModeOrderSearchSortOrderpossible values of OrderSearchSortOrderOrderSearchStringValue Example to create an instance using the builder patternOrderSearchStringValueBuilder Example to create an instance using the builder patternOrderSearchStringValueOrderSearchWildCardExpression Example to create an instance using the builder patternOrderSearchWildCardExpressionBuilder Example to create an instance using the builder patternOrderSearchWildCardExpressionThis action updates thebillingAddress
on the Order, but it does not change the billing address on the referenced Cart from which the Order is created.OrderSetBillingAddressActionBuilder Example to create an instance using the builder patternThis action updates thebillingAddress
on the Order, but it does not change the billing address on the referenced Cart from which the Order is created.OrderSetBillingAddressCustomFieldAction Example to create an instance using the builder patternOrderSetBillingAddressCustomFieldActionBuilder Example to create an instance using the builder patternOrderSetBillingAddressCustomFieldActionOrderSetBillingAddressCustomTypeAction Example to create an instance using the builder patternOrderSetBillingAddressCustomTypeActionBuilder Example to create an instance using the builder patternOrderSetBillingAddressCustomTypeActionThis action updates thecustomerEmail
on the Order, but it does not change the Customer email on the Cart the Order has been created from.OrderSetCustomerEmailActionBuilder Example to create an instance using the builder patternThis action updates thecustomerEmail
on the Order, but it does not change the Customer email on the Cart the Order has been created from.Setting the Order'scustomerId
does not recalculate prices or discounts on the Order.OrderSetCustomerIdActionBuilder Example to create an instance using the builder patternSetting the Order'scustomerId
does not recalculate prices or discounts on the Order.OrderSetCustomFieldAction Example to create an instance using the builder patternOrderSetCustomFieldActionBuilder Example to create an instance using the builder patternOrderSetCustomFieldActionOrderSetCustomLineItemCustomFieldAction Example to create an instance using the builder patternOrderSetCustomLineItemCustomFieldActionBuilder Example to create an instance using the builder patternOrderSetCustomLineItemCustomFieldActionOrderSetCustomLineItemCustomTypeAction Example to create an instance using the builder patternOrderSetCustomLineItemCustomTypeActionBuilder Example to create an instance using the builder patternOrderSetCustomLineItemCustomTypeActionOrderSetCustomLineItemShippingDetailsAction Example to create an instance using the builder patternOrderSetCustomLineItemShippingDetailsActionBuilder Example to create an instance using the builder patternOrderSetCustomLineItemShippingDetailsActionOrderSetCustomTypeAction Example to create an instance using the builder patternOrderSetCustomTypeActionBuilder Example to create an instance using the builder patternOrderSetCustomTypeActionProduces the DeliveryAddressSet Message.OrderSetDeliveryAddressActionBuilder Example to create an instance using the builder patternProduces the DeliveryAddressSet Message.OrderSetDeliveryAddressCustomFieldAction Example to create an instance using the builder patternOrderSetDeliveryAddressCustomFieldActionBuilder Example to create an instance using the builder patternOrderSetDeliveryAddressCustomFieldActionOrderSetDeliveryAddressCustomTypeAction Example to create an instance using the builder patternOrderSetDeliveryAddressCustomTypeActionBuilder Example to create an instance using the builder patternOrderSetDeliveryAddressCustomTypeActionOrderSetDeliveryCustomFieldAction Example to create an instance using the builder patternOrderSetDeliveryCustomFieldActionBuilder Example to create an instance using the builder patternOrderSetDeliveryCustomFieldActionOrderSetDeliveryCustomTypeAction Example to create an instance using the builder patternOrderSetDeliveryCustomTypeActionBuilder Example to create an instance using the builder patternOrderSetDeliveryCustomTypeActionProduces the Delivery Items Updated Message.OrderSetDeliveryItemsActionBuilder Example to create an instance using the builder patternProduces the Delivery Items Updated Message.OrderSetItemShippingAddressCustomFieldAction Example to create an instance using the builder patternOrderSetItemShippingAddressCustomFieldActionBuilder Example to create an instance using the builder patternOrderSetItemShippingAddressCustomFieldActionOrderSetItemShippingAddressCustomTypeAction Example to create an instance using the builder patternOrderSetItemShippingAddressCustomTypeActionBuilder Example to create an instance using the builder patternOrderSetItemShippingAddressCustomTypeActionOrderSetLineItemCustomFieldAction Example to create an instance using the builder patternOrderSetLineItemCustomFieldActionBuilder Example to create an instance using the builder patternOrderSetLineItemCustomFieldActionOrderSetLineItemCustomTypeAction Example to create an instance using the builder patternOrderSetLineItemCustomTypeActionBuilder Example to create an instance using the builder patternOrderSetLineItemCustomTypeActionOrderSetLineItemShippingDetailsAction Example to create an instance using the builder patternOrderSetLineItemShippingDetailsActionBuilder Example to create an instance using the builder patternOrderSetLineItemShippingDetailsActionOrderSetLocaleAction Example to create an instance using the builder patternOrderSetLocaleActionBuilder Example to create an instance using the builder patternOrderSetLocaleActionOrderSetOrderNumberAction Example to create an instance using the builder patternOrderSetOrderNumberActionBuilder Example to create an instance using the builder patternOrderSetOrderNumberActionOrderSetParcelCustomFieldAction Example to create an instance using the builder patternOrderSetParcelCustomFieldActionBuilder Example to create an instance using the builder patternOrderSetParcelCustomFieldActionOrderSetParcelCustomTypeAction Example to create an instance using the builder patternOrderSetParcelCustomTypeActionBuilder Example to create an instance using the builder patternOrderSetParcelCustomTypeActionProduces the ParcelItemsUpdated Message.OrderSetParcelItemsActionBuilder Example to create an instance using the builder patternProduces the ParcelItemsUpdated Message.Produces the ParcelMeasurementsUpdated Message.OrderSetParcelMeasurementsActionBuilder Example to create an instance using the builder patternProduces the ParcelMeasurementsUpdated Message.Produces the ParcelTrackingDataUpdated Message.OrderSetParcelTrackingDataActionBuilder Example to create an instance using the builder patternProduces the ParcelTrackingDataUpdated Message.Produces the PurchaseOrderNumberSet Message.OrderSetPurchaseOrderNumberActionBuilder Example to create an instance using the builder patternProduces the PurchaseOrderNumberSet Message.Produces the Return Info Set Message.OrderSetReturnInfoActionBuilder Example to create an instance using the builder patternProduces the Return Info Set Message.OrderSetReturnItemCustomFieldAction Example to create an instance using the builder patternOrderSetReturnItemCustomFieldActionBuilder Example to create an instance using the builder patternOrderSetReturnItemCustomFieldActionOrderSetReturnItemCustomTypeAction Example to create an instance using the builder patternOrderSetReturnItemCustomTypeActionBuilder Example to create an instance using the builder patternOrderSetReturnItemCustomTypeActionTo set a ReturnPaymentState, the OrderreturnInfo
must have at least one ReturnItem.OrderSetReturnPaymentStateActionBuilder Example to create an instance using the builder patternTo set a ReturnPaymentState, the OrderreturnInfo
must have at least one ReturnItem.To set aReturnShipmentState
, the OrderreturnInfo
must have at least one ReturnItem.OrderSetReturnShipmentStateActionBuilder Example to create an instance using the builder patternTo set aReturnShipmentState
, the OrderreturnInfo
must have at least one ReturnItem.This action updates theshippingAddress
on the Order, but it does not change the shipping address on the referenced Cart from which the Order is created.OrderSetShippingAddressActionBuilder Example to create an instance using the builder patternThis action updates theshippingAddress
on the Order, but it does not change the shipping address on the referenced Cart from which the Order is created.OrderSetShippingAddressCustomFieldAction Example to create an instance using the builder patternOrderSetShippingAddressCustomFieldActionBuilder Example to create an instance using the builder patternOrderSetShippingAddressCustomFieldActionOrderSetShippingAddressCustomTypeAction Example to create an instance using the builder patternOrderSetShippingAddressCustomTypeActionBuilder Example to create an instance using the builder patternOrderSetShippingAddressCustomTypeActionSets the Store the Order is assigned to.OrderSetStoreActionBuilder Example to create an instance using the builder patternSets the Store the Order is assigned to.Indicates the state of the Order.possible values of OrderStateProduces the Custom Line Item State Transition Message.OrderTransitionCustomLineItemStateActionBuilder Example to create an instance using the builder patternProduces the Custom Line Item State Transition Message.Produces the Line Item State Transition Message.OrderTransitionLineItemStateActionBuilder Example to create an instance using the builder patternProduces the Line Item State Transition Message.If the existing State has settransitions
, there must be a direct transition to the new State.OrderTransitionStateActionBuilder Example to create an instance using the builder patternIf the existing State has settransitions
, there must be a direct transition to the new State.OrderUpdate Example to create an instance using the builder patternOrderUpdateAction Example to create a subtype instance using the builder patternOrderUpdateActionBuilderOrderUpdateActionOrderUpdateBuilder Example to create an instance using the builder patternOrderUpdateUpdates an address initemShippingAddresses
by keeping the Addresskey
.OrderUpdateItemShippingAddressActionBuilder Example to create an instance using the builder patternUpdates an address initemShippingAddresses
by keeping the Addresskey
.OrderUpdateSyncInfoAction Example to create an instance using the builder patternOrderUpdateSyncInfoActionBuilder Example to create an instance using the builder patternOrderUpdateSyncInfoActionInformation regarding the appearance, content, and shipment of a Parcel.ParcelBuilder Example to create an instance using the builder patternParcelDraft Example to create an instance using the builder patternParcelDraftBuilder Example to create an instance using the builder patternParcelDraftInformation regarding the appearance, content, and shipment of a Parcel.ParcelMeasurements Example to create an instance using the builder patternParcelMeasurementsBuilder Example to create an instance using the builder patternParcelMeasurementsPaymentInfo Example to create an instance using the builder patternPaymentInfoBuilder Example to create an instance using the builder patternPaymentInfoIndicates the payment status for the Order.possible values of PaymentStateContains the Product Variant to be used in the LineItemImportDraft.ProductVariantImportDraftBuilder Example to create an instance using the builder patternContains the Product Variant to be used in the LineItemImportDraft.Stores information about returns connected to an Order.ReturnInfoBuilder Example to create an instance using the builder patternReturnInfoDraft Example to create an instance using the builder patternReturnInfoDraftBuilder Example to create an instance using the builder patternReturnInfoDraftStores information about returns connected to an Order.ReturnItem Example to create a subtype instance using the builder patternReturnItemBuilderReturnItemDraft Example to create an instance using the builder patternReturnItemDraftBuilder Example to create an instance using the builder patternReturnItemDraftReturnItemReturnPaymentStatepossible values of ReturnPaymentStateReturnShipmentStatepossible values of ReturnShipmentStateIndicates the shipment status of the Order.possible values of ShipmentStateBecomes theshippingInfo
of the imported Order.ShippingInfoImportDraftBuilder Example to create an instance using the builder patternBecomes theshippingInfo
of the imported Order.StagedOrderUpdateAction Example to create a subtype instance using the builder patternStagedOrderUpdateActionBuilderStagedOrderUpdateActionContains synchronization activity information of the Order (like export or import).SyncInfoBuilder Example to create an instance using the builder patternContains synchronization activity information of the Order (like export or import).TaxedItemPriceDraft Example to create an instance using the builder patternTaxedItemPriceDraftBuilder Example to create an instance using the builder patternTaxedItemPriceDraftInformation that helps track a Parcel.TrackingDataBuilder Example to create an instance using the builder patternInformation that helps track a Parcel.