Carts and Orders APIs overview

Ask about this Page
Copy for AI
View as Markdown

How to work with the APIs for Carts and Orders.

This page describes rules that apply across the Carts and Orders APIs. For what Carts and Orders are and how they behave, see the Carts and Orders overview.

APIs in this topic

ResourcePurposeReference
CartsRepresent a shopping cart containing items that a customer intends to purchase.Carts
OrdersCapture a purchase, usually created from a Cart after a checkout process has been completed.Orders
Payment MethodsStore payment method details in a reusable and structured model.Payment Methods
PaymentsTrack a series of logically connected financial transactions, such as reserving, charging, or refunding money.Payments
Shopping ListsImplement a "save-for-later" feature, a shareable wishlist, or a public collection of Products.Shopping Lists
Order EditsMake financial changes to the purchase agreement after the Order has been placed.Order Edits
Order ImportImport existing Orders from a different system or a different Project.Order Import
Order SearchSearch a large number of Orders in a Project, for back-office use cases.Order Search

Data model

Line Items

When a Product Variant is added to a Cart, a Line Item is created as a snapshot of the Product Variant from the ProductProjection as follows:
  • The current projection is used.
  • Product Attributes are merged with Variant Attributes. Attributes whose AttributeDefinition has savedToLineItem set to false are excluded.
  • If the Cart is bound to a Store, the following additional checks and projections are performed:
    • For Stores with active Product Selections, the selected Product Variant must be included in at least one of the active Product Selections.
    • The selected Product Variant must be available in a Store.
    • All LocalizedStrings are filtered by the locales defined in the Store. If the API cannot find a matching locale in the Store languages, the first locale found in the Project settings is used as a fallback.
    • All Prices are filtered according to the Product distribution Channels defined in the Store. Prices without a Channel are also included.
    • All ProductVariantAvailabilities are filtered according to the Inventory supply Channel defined in the Store. Inventory entries without a Channel are also included.
If the Product Variant changes, the relation to the current ProductProjection is kept, but the Line Item is not updated automatically. The same applies when the savedToLineItem value of an AttributeDefinition changes.
The Product data of existing Line Items is updated, and the Product Variant data is copied to the variant field of the LineItem, in the following cases:
  • A Recalculate update action is performed with updateProductData set to true.
  • A Cart update triggers an API Extension.
  • A Customer signs in or Carts are merged with updateProductData set to true.
A replicated Cart always contains the current Product data.

Custom Line Items

The InventoryMode of a Cart has no effect on Custom Line Items.

Payment references

An Order or a Cart can reference a set of Payments using the PaymentInfo object. A Payment can also reference a Customer, or an anonymous session.

Shopping Lists

Shopping Lists typically have Line Items: ShoppingListLineItems that contain Products and/or TextLineItems that use text values to represent any other item.

Working with the APIs

Guest checkout

When you create a Cart, Shopping List, or Payment, you can set an anonymousId on the resource to link it to the anonymous session.
It is good practice to create an anonymous session only once the visitor begins interacting with the Cart, for example, by adding an item to it. This avoids creating a large number of unused sessions. For more information, see Manage token requests.
Carts with an anonymousId are known as anonymous Carts. If you create an Order from an anonymous Cart, the Order is automatically assigned the same anonymousId.

Anonymous Carts

For how long an anonymous Cart persists, see Carts and Orders overview.
The merge of an anonymous Cart with a customer's Cart happens automatically upon customer sign-in or sign-up. For the merge methods and when each applies, see Merge a Cart.
To keep an anonymous Cart accessible, store the Cart id on the client side (for example, in the browser's local storage). Retrieve the Cart with Get Cart by ID.

Customer Carts

For how long a customer's Cart persists, see Carts and Orders overview.

You can retrieve a customer's Cart through the following methods:

Active Carts

The status of a Cart is defined by its CartState.
For the REST endpoints that retrieve active Carts, see Get Cart and Query Carts.

Update a Cart

For the REST endpoints that update a Cart, see Update Cart.

After all update actions are performed, the Cart:

  • removes any Line Items that are invalid due to deleted Products, Product Variants, or Prices.

  • removes any Line Items that are invalid due to an inactive StandalonePrice.

    When a Product is unpublished, any associated Line Items already present in a Cart remain unaffected and can still be ordered. To prevent this, do the following:

    • If the Product uses Embedded Prices, remove them from the unpublished Product.
    • If the Product uses Standalone Prices, deactivate or delete the Standalone Prices.
  • removes any Line Items with quantities that are outside the limits specified in their associated InventoryEntries.
  • updates any LineItem price field if the result of the Line Item price selection has changed because of a Product update.
  • updates the ShippingInfo, in particular, the price and shippingMethodState fields.
  • updates the discounts, which may affect the LineItem or CustomLineItem totalPrice fields and ShippingInfo discountedPrice field:
    • if a Cart Discount becomes invalid due to deactivation, expiration, or the predicate no longer matches the Cart's content, the discount is removed.
    • if a Cart Discount becomes active and applicable (since the last update), the discount is added.
    • if a Discount Code becomes invalid due to usage limits, deactivation, expiration, or the predicate no longer matches the Cart's content, the discount is removed.
  • updates the Cart totalPrice field.
  • updates the Tax Rates, in particular, the taxedPrice field.
  • updates the LineItem productKey.
To perform the above-mentioned updates without additional update actions, send a request with only the Recalculate update action.
To update the Product data saved in the Line Items, use the Recalculate update action with updateProductData set to true.
For best practices on optimizing the performance of large or complex Carts, see Large Cart performance tips.

Freeze a Cart

When freezing a Cart, you specify a FreezeStrategy: SoftFreeze or HardFreeze.
The following behavior applies to frozen Carts with the SoftFreeze strategy:
  • Prices remain as they were when the Cart was frozen. However, if a Price that a Line Item depends on is deleted entirely, the affected Line Item is removed from the frozen Cart.
  • Update actions as well as background services modifying prices on the Cart are deactivated for frozen Carts.
  • Inventory is not reserved for Line Items in frozen Carts.
  • Frozen Carts can be ordered or unfrozen. When unfrozen, a Cart continues to accept new updates.
The HardFreeze strategy includes all the SoftFreeze behavior listed above, plus the following additional restrictions:
  • Discounts and Discount Codes remain as they were when the Cart was frozen.
  • Shipping method updates are not allowed.

Impact of changes on frozen Carts

ResourceChangeSoftFreeze behaviorHardFreeze behavior
PricesUpdatedIgnored. The frozen Cart retains the price at the time of freezing.Same as SoftFreeze
ExpiredIgnored. The frozen Cart retains the price at the time of freezing.Same as SoftFreeze
DeletedThe Line Item that uses the deleted price is removed from the frozen Cart.Same as SoftFreeze
Cart DiscountsCreatedIgnored. New Cart Discounts are not applied.Same as SoftFreeze
ActivatedIgnored. Cart Discounts that become active are not applied.Same as SoftFreeze
ExpiredRemain applied as they were at the time of freezing.Same as SoftFreeze
InactivatedRemoved from the frozen Cart.Remain applied as they were at the time of freezing.
DeletedRemoved from the frozen Cart.Remain applied as they were at the time of freezing.
Invalidated (due to Cart predicates not matching)Removed from the frozen Cart.Remain applied as they were at the time of freezing.
Product DiscountsCreatedIgnored. New product discounts are not applied.Same as SoftFreeze
ExpiredRemain applied as they were at the time of freezing.Same as SoftFreeze
InactivatedRemain applied as they were at the time of freezing.Same as SoftFreeze
DeletedRemain applied as they were at the time of freezing.Same as SoftFreeze
Discount CodesCreatedCan be added. If the Discount Code predicate does not match the Cart, the state changes to DoesNotMatchCart and doesn't change the Cart total.Cannot be added.
Removed (from Cart)Can be removed, and the Cart total is updated.Cannot be removed.
Invalidated (due to Cart predicates not matching)Discount Code remains in the Cart, the state changes to DoesNotMatchCart, and the Cart total is updated. If later, the Discount Code becomes valid, it will not automatically re-apply.Remain applied as they were at the time of freezing (predicate is not re-evaluated).
InactivatedDiscount Code remains in the Cart, the state changes to NotActive and the discount is removed, updating the Cart total.Remain applied as they were at the time of freezing.
Deleted (from Project)Discount Code remains in the Cart with the last known status (for example: NotActive), but no longer affects the Cart total.Remain applied as they were at the time of freezing.
Direct DiscountsSet (on Cart)Added to the cart, but not applied.Cannot be set.
Removed (from Cart)Can be removed, and the Cart total is updated.Cannot be removed.
OtherUpdates that affect the price of Cart itemsNot accepted. Maintains price stability of the Line Items and Custom Line Items. To view the list of price-related updated actions that are not allowed, see the frozen CartState.Same as SoftFreeze
Updates that do not affect the price of Cart itemsAccepted, and the Cart total is updated accordingly. Setting shipping methods is permitted even though it can affect the price.Setting shipping methods is not allowed.
Inventory quantity limit updatesDuring order creation: if line item quantities fall outside the new limits, order creation will fail.
When unfrozen: line items violating the new limits will be removed.
Same as SoftFreeze
Anonymous user signs in or signs upThe frozen Cart is not merged.Same as SoftFreeze
The Shipping Method on the Cart is not activeOrder creation is rejected.Same as SoftFreeze
A global Shipping Method on the Cart is replaced with a Store-scoped Shipping MethodStore validations for the Shipping Method are bypassed, and the Order is created.Same as SoftFreeze
A Store-scoped Shipping Method on the Cart is associated with a different StoreStore validations for the Shipping Method are bypassed, and the Order is created.Same as SoftFreeze
When applying update actions, the API still performs validations on the Cart to ensure that it is convertible to an Order, and reports errors if such a validation fails.

Creating an Order will fail if the frozen Cart contains a Discount that must be removed (according to the previously mentioned restrictions), or if a Tax Rate for one or more items has changed.

Lock a Cart

The Cart's lock field is set when the Cart is locked. A CartLock records which API Client locked the Cart and when.
Only API Clients with the manage_locked_carts OAuth 2.0 Scope can do the following:
  • Lock a Cart.
  • Update a locked Cart.
  • Unlock a Cart.

Merge a Cart

To be eligible for a Cart merge, the anonymous Cart and the Customer's active Cart must use the same currency (identified through totalPrice.currency). Furthermore, if a Store or Business Unit is assigned to either Cart, it must match across both Carts. If the anonymous Cart has Direct Discounts, its directDiscountsIgnoreCartDiscounts value must match that of the Customer's active Cart as well.
Merge methodUse forAPIEndpoints
Automatic Cart merge during sign-up or sign-inCustomers authenticating through the Internal OAuth.Customers APIAll sign-up and sign-in endpoints.

See the Customers APIs overview page for more information.
Manual Cart mergeCustomers authenticating through the Internal OAuth or an external OAuth server.Carts APIMerge Cart, Merge Cart in Store

Merge modes

The merge mode determines how an anonymous Cart and a Customer's active Cart are combined during a merge operation:

Both types have identical enum values and merging behavior.

When multiple active Carts are associated with a Customer, the most recently modified active Cart is selected for the merge operation.

MergeWithExistingCustomerCart

The following behavior describes the MergeWithExistingCustomerCart merge mode:
ScenarioWhat happensTax recalculation
Customer has no active CartAnonymous Cart becomes the active CartYes, normal tax/price recalculation when the new Cart becomes active
Customer has an active Cart without a shipping addressItems from anonymous Cart are merged into the existing active Cart according to the merge rules.No
Customer has an active Cart with a shipping addressItems from anonymous Cart are merged into the existing active Cart according to the merge rules.Yes, tax rates are recalculated based on the active Cart’s shipping address, even if the anonymous Cart doesn't have one

UseAsNewActiveCustomerCart

The following behavior describes the UseAsNewActiveCustomerCart merge mode.
ScenarioWhat happensTax recalculation
Customer has no active CartAnonymous Cart becomes the active CartYes, price/tax recalculation occurs when it becomes the active Cart
Customer has an active Cart without a shipping addressAnonymous Cart becomes the active CartNo
Customer has an active Cart with a shipping addressAnonymous Cart becomes the active CartYes, but only if the anonymous Cart does not have its own shipping address

Merge rules

When merging an anonymous Cart and a Customer’s active Cart, the system follows specific rules to determine how to combine the items. The goal is to ensure that the resulting Cart accurately reflects the Customer's intended purchases without duplicating items unnecessarily.

The merge process follows these steps:

  1. Key conflict check: The system checks whether any Line Items and Custom Line Items in the anonymous Cart share the same key as items in the Customer’s Cart but refer to different products or variants. If a key conflict is detected, the conflicting items from the anonymous Cart are skipped and not considered further. These items are not added to the merge result and remain only in the anonymous Cart.
  2. Property-based matching: For all remaining Line Items and Custom Line Items, the system determines whether items from the anonymous Cart match items in the Customer’s Cart. To do this, it compares specific properties of the items, as detailed in the table below. All properties listed for each item type must match exactly for the items to be considered identical.

    Keys are not considered in the property-based matching logic. Two items are considered identical if the following properties match, even if their keys differ or if one item has no key.

    Item typeProperties compared
    Line ItemsproductId, variantId, supplyChannel, distributionChannel, custom, priceMode
    Custom Line Itemsname, slug, money, taxCategory, custom
  3. Merging behavior: The system processes each item from the anonymous Cart based on the results of the property-based matching.
    • If an anonymous Cart item matches an existing Customer Cart item:

      • The items are merged. The resulting item uses the higher of the two quantities.
      • The itemShippingAddresses from both items are merged into the Customer Cart.
    • If an anonymous Cart item does not match an existing Customer Cart item, it is added as a separate item with its original quantity.
For Carts with Multiple ShippingMode, the shipping arrays from both Carts are merged. A Shipping entry is only retained if its shippingKey is still referenced by an item.
After the merge is complete, the anonymous Cart retains its original content, and its cartState is updated to Merged. Although this CartState prevents any further modifications to the Cart, you can use the Cart to check for any items that could not be merged.

Lifetime

The lifetime of a Cart is controlled by the deleteDaysAfterLastModification property and can be adjusted according to your requirements. If unspecified, during Cart creation, the deleteDaysAfterLastModification property is copied from the Project's Carts configuration. Changing the Project's Carts configuration does not affect existing Carts. For details about automatic cleanup behavior and defaults, see Cleanup of old data.

Any read method on a Cart alone will not lead to a representation with up-to-date prices and so on, only Cart updates will trigger this.

Price precision

  • Prices with TypedMoney can be cent-precision or high-precision.
  • When calculating net and gross prices, prices with decimals are rounded. If the fraction of centAmount is exactly 0.5, the RoundingMode defined by taxRoundingMode is applied. If the tax is included in the price (includedInPrice=true on the TaxRate), the rounding mode is applied to the amount named by the Tax Rate's taxRoundingTarget, which defaults to the net price. The other amount is then the exact remainder. If the tax is not included in the price, the rounding mode is applied to the gross price.
  • If the tax is not included in the price (includedInPrice=false on the TaxRate), the tax portions are derived from the net prices. If the tax is included in the price (includedInPrice=true on the TaxRate), then the tax portions are derived from the gross prices.
  • If tax is included in the Line Item price (includedInPrice=true on the TaxRate), the (discounted) price multiplied by the quantity applies to the gross price of a Line Item. If includedInPrice=false, the (discounted) price multiplied by the quantity applies to the net price of a Line Item. If a Line Item's prices are of HighPrecisionMoney, priceRoundingMode is used for rounding the calculations.
  • When prices are discounted with relative discounts, they are always rounded in favor of the customer with half-down rounding.

Tax rounding target

When includedInPrice is true on a TaxRate, both the net price and the tax amount are derived from the gross price. Only one can be rounded; the other is the exact remainder, so totalNet plus totalTax on TaxedPrice always equals totalGross. The taxRoundingTarget field on the Tax Rate selects which amount is rounded:
  • Net (default) rounds the net price. The tax amount is the exact remainder.
  • Tax rounds the tax amount. The net price is the exact remainder. Use this where the tax authority expresses the calculation as a fraction of the gross price. UK VAT at 20%, defined by HM Revenue & Customs (HMRC), is one example.
For a rate of 20% included in a gross price of 1.23 with taxRoundingMode: HalfEven:
  • taxRoundingTarget: Net gives a net price of 1.02 and a tax amount of 0.21.
  • taxRoundingTarget: Tax gives a tax amount of 0.20 and a net price of 1.03.
The field has no effect when includedInPrice is false. The supplied price is the exact net in that case, so rounding the gross and rounding the tax give the same result.
Set the field on a Tax Category with the Add TaxRate or Replace TaxRate update action. To override it for a single Line Item, Custom Line Item, or Shipping Method, use an ExternalTaxRateDraft.

Cash or denomination rounding

Cash rounding is not the same as the RoundingMode set by priceRoundingMode and taxRoundingMode on a Cart. Those control how decimal midpoints in calculated values are resolved; cash rounding rounds to the nearest currency denomination.
When enabled, cash rounding is applied to the Cart taxedPrice.totalGross, or to totalPrice if the price does not include taxes. If a price is affected by a Product Discount, the rounding is also reflected in the discounted field of prices.

Taxes

Tax rate selection

The shippingAddress.country and shippingAddress.state properties affect the selection criteria. These are compared to the TaxRate's country and state fields. A Tax Rate is only eligible if the country and state properties are an exact match.
Since the state field is optional on both TaxRate and shippingAddress, this means the following:
  • If shippingAddress.country and TaxRate.country are an exact match, and no state properties are present, the TaxRate applies to the Cart.
  • If shippingAddress.country and TaxRate.country are an exact match, but only one of shippingAddress.state or TaxRate.state is present, the Tax Rate does not apply to the Cart.
  • If shippingAddress.country and TaxRate.country are an exact match, and shippingAddress.state and TaxRate.state are an exact match, the Tax Rate applies to the Cart.
  • If shippingAddress.country and TaxRate.country are present, and shippingAddress.state and TaxRate.state are present, but there is a mismatch of either country or state, the Tax Rate does not apply to the Cart.
If you need to include a state or country sub-unit for shipping purposes, use shippingAddress.region to avoid Tax Rate conflicts.

Tax modes

By default, newly created Carts use the Platform TaxMode. With this tax mode, the taxedPrice of a Cart is calculated automatically based on the Tax Rate that applies for the country (and optionally, state) of the Cart's shippingAddress. The Tax Rate is taken from the TaxCategory assigned to Products and Shipping Methods.
If you prefer to have more control over how taxes are calculated in your Project, including the use of an external tax calculation service, you can use one of the following TaxModes:
  • External: you are responsible for explicitly setting the Tax Rates for Line Items and Custom Line Items. With this tax mode, you must specify whether tax is included in the price for Line Items or Custom Line Items. This mode is suitable when you want commercetools API to handle the tax calculations based on the provided Tax Rates.
  • ExternalAmount: you are responsible for providing the exact tax amounts for Line Items and Custom Line Items, and explicitly setting the taxedPrice of the Cart using Set Cart Total Tax. This mode is suitable when you want full control over the tax calculation. For more information about how to set tax amounts, see ExternalAmount TaxMode.
When includedInPrice: true, the tax is calculated in a top-down manner, and when includedInPrice: false, the tax is calculated in a bottom-up manner.
The following example shows the impact of includedInPrice in the Cart calculation with taxRoundingMode: HalfEven and taxCalculationMode: LineItemLevel.
Line ItemProduct Variant AProduct Variant BShipping
Line Item: Price$15$25$5
Quantity105---
External Tax Rate: includedInPricefalsetruefalse
External Tax Rate: amount0.190.150.15
Taxed Item Price: totalNet$150$108.70$5
Taxed Item Price: totalGross$178.5$125$5.75
Calculation formula15 x 10 (1 + 0.19)25 x 5 / (1 + 0.15)5 x (1 + 0.15)

Tax calculation mode

Due to the principle of rounding on every calculation step, this slight difference in when to apply tax can have a considerable effect on the Cart total.

Two tax calculation modes are available to support different use cases:

  • The LineItemLevel TaxCalculationMode enforces tax calculation after multiplying the individual item price by the quantity.
  • The UnitPriceLevel mode calculates the taxed price before multiplying by the quantity.

The following example demonstrates the differences in the Cart total depending on the different tax calculation modes. Let's assume:

Line Item #QuantityUnit PriceLine Item Total, Net
(LineItemLevel)
Line Item Total, Net
(UnitPriceLevel)
Line Item Total, Gross
11$1.00$0.84$0.84$1.00
210$1.08$9.08$9.10$10.80
310$108.08$908.24$908.20$1080.80
41$2.00$1.68$1.68$2.00
550$0.01$0.42$0.50$0.50
61$4.90$4.12$4.12$4.90
Cart Total, Net
(LineItemLevel)
Cart Total, Net
(UnitPriceLevel)
Cart Total, Gross
$924.38$924.44$1100.00

As seen from the example, if a Line Item has a quantity of 1, the two modes have no impact on the total net value of a Line Item (see Line Item #1, 4, and 6). However, if the quantity is more than 1, the two modes calculate the total net value of a Line Item with a difference of several cents (see Line Item #2, 3, and 5).

Depending on the specific Line Item values, the chosen mode can give a greater or lesser net value (see Line Item #2 compared to #3). A difference of 6 cents is accumulated in the Cart total. The connection to rounding is especially clear with Line Item #5.

Due to rounding after applying tax to 0.01 and multiplying by quantity 50 upon that, the net value when using UnitPriceLevel ends up being equal to the gross value. With LineItemLevel, where quantity multiplication is performed as a first calculation step, the rounding occurs to a greater value, and the net value ends up being $0.42.

Create an Order

To create an Order from a Cart, see the Create Order from Cart, Create Order in Store from Cart, and Create Order from Cart in Business Unit B2B B2X endpoints.
When an Order is created from a Cart, the Direct Discount coexistence setting (directDiscountsIgnoreCartDiscounts) is copied to the Order.
To create an Order from a Quote, see the Quotes overview and the Create Order from Quote, Create Order in Store from Quote, and Create Order from Quote in Business Unit B2B B2X endpoints.
To import an Order, see the Create Order by Import endpoint.

Order Edits

The Order Edits API does not support tracking or reserving inventory. You can only create an Order Edit if the InventoryMode of the Order and its LineItems is None.

Intended flow

The basic flow for an Order Edit:

  1. Create an OrderEdit: Upon creation, the OrderEdit contains a reference to the target Order within the resource field; however, no data is copied between the entities. At this point, you can consider the OrderEdit to be a staging area to collect the proposed changes.
  2. Add the proposed changes: Immediately upon adding the update actions to the OrderEdit, the stagedActions are run against the Order; a so-called dry run. As a response, the Order is returned as if the Order actions had been applied. This allows you to preview the changes and understand the impact on the total price of the Order. The response will also contain Messages which capture the changes applied to the Order. Dry runs are always performed against the latest version of the Order.
    If the Order endpoint contains API Extensions, they are also called during the dry run.
  3. Review the preview: ensure a careful review of the preview takes place, as the Order always respects the current product catalog, price configuration, and promotions. For example, if an OrderEdit is made soon after Order placement, changes will likely be minimal. However, if more time has passed, price adjustments and expired promotions may significantly impact the Order.
    We recommend that you review the Messages within the preview to understand the proposed changes. For example, the OrderEditApplied Message details the before and after values of the net total, gross total, and tax portion.
  4. Apply the changes: When you apply an Order Edit, the Order is recalculated using the same criteria listed under Update a Cart. During recalculation, Discounts that have become invalid or are otherwise no longer applicable are removed. Only Discounts that are valid at the time of the Order Edit application are applied to the updated Order.
    The Order (not the OrderEdit) triggers the OrderEditApplied Message, which contains both the original and the newly applied values. At this point, you can delete the Order Edit (if desired). Deleting an Order Edit does not affect the related Order.
For the REST endpoints used in this flow, see Create OrderEdit, Update OrderEdit by ID, and Apply OrderEdit.

State

To check the state of an Order Edit, use the result field.
StateDescription
NotProcessedThe changes have not been applied to the Order. This status shows on results returned from the Query OrderEdits endpoint.
PreviewSuccessA preview of the modified Order, including any available Messages, is available for evaluation. This status can show after OrderEdit creation and when an OrderEdit is fetched or updated via key or ID.
PreviewFailureA preview could not be generated due to one or more invalid changes specified in the errors field. This status can show after OrderEdit creation and when an OrderEdit is fetched or updated via key or ID.
AppliedThe changes have been applied to the Order. This state contains information detailing the state before (excerptBeforeEdit) and after (excerptAfterEdit) the OrderEdit was applied. Once applied, any additional changes must be done in a new OrderEdit.

Overview of update actions for Cart, Order, and Order Edit

The following tables group update actions by the resource they affect and show their availability for Carts, Orders, and Order Edits.

Identifiers and Custom Fields

Update actionCartOrderOrder Edit
Set Key✓-✓
Set Order Number-✓✓
Set Purchase Order Number✓✓✓
Set Custom Type✓✓✓
Set CustomField✓✓✓

Customer and Business Unit

Update actionCartOrderOrder Edit
Set Customer ID✓✓✓
Set Customer Email✓✓✓
Set Customer Group✓-✓
Set Anonymous ID✓--
Set Business Unit B2B B2X✓✓✓

Payments

Update actionCartOrderOrder Edit
Add Payment✓✓✓
Remove Payment✓✓✓
Change PaymentState-✓✓

Locale and Store

Update actionCartOrderOrder Edit
Set Locale✓✓✓
Set Country✓-✓
Set Store-✓✓

Lifecycle and workflow

Update actionCartOrderOrder Edit
Set DeleteDaysAfterLastModification✓--
Freeze Cart✓--
Unfreeze Cart✓--
Lock Cart✓--
Unlock Cart✓--
Recalculate✓--
Change OrderState-✓✓
Transition State-✓✓
Update SyncInfo-✓✓

on ShoppingList

Update actionCartOrderOrder Edit
Add Shopping List✓-✓

on Tax

Update actionCartOrderOrder Edit
Set Cart Total Tax✓--
Set Order Total Tax--✓
Change TaxMode✓-✓
Change Price RoundingMode✓-✓
Change Tax RoundingMode✓-✓
Change Tax CalculationMode✓-✓

on DiscountCode

Update actionCartOrderOrder Edit
Add DiscountCode✓-✓
Remove DiscountCode✓-✓

on DirectDiscount

Update actionCartOrderOrder Edit
Set DirectDiscounts✓-✓
Set DirectDiscountsIgnoreCartDiscounts✓-✓

on LineItem

Update actionCartOrderOrder Edit
Add LineItem✓-✓
Remove LineItem✓-✓
Change LineItem Quantity✓-✓
Change LineItems Order✓--
Set LineItem TaxRate✓-✓
Set LineItem TaxAmount✓-✓
Set LineItem Price✓-✓
Set LineItem TotalPrice✓-✓
Set LineItem DistributionChannel✓-✓
Set LineItem ShippingDetails✓✓✓
Set LineItemRecurrenceInfo✓--
Apply DeltaToLineItemShippingDetailTargets✓--
Set LineItem Custom Type✓✓✓
Set LineItem CustomField✓✓✓
Set LineItem InventoryMode✓--
Set LineItem SupplyChannel✓--
Transition LineItem State-✓✓
Import LineItem State-✓✓

on CustomLineItem

Update actionCartOrderOrder Edit
Add CustomLineItem✓-✓
Remove CustomLineItem✓-✓
Change CustomLineItem Quantity✓-✓
Set CustomLineItem TaxRate✓-✓
Set CustomLineItem TaxAmount✓-✓
Change CustomLineItem Money✓-✓
Change CustomLineItem Price Mode✓--
Set CustomLineItem ShippingDetails✓✓✓
Set CustomLineItemRecurrenceInfo✓--
Apply DeltaToCustomLineItemShippingDetailsTargets✓--
Set CustomLineItem Custom Type✓✓✓
Set CustomLineItem CustomField✓✓✓
Transition CustomLineItem State-✓✓
Import CustomLineItem State-✓✓

on Billing Address

Update actionCartOrderOrder Edit
Set Billing Address✓✓✓
Set Billing Address Custom Type✓✓✓
Set Billing Address CustomField✓✓✓

on Shipping Address

Update actionCartOrderOrder Edit
Set Shipping Address✓✓✓
Set Shipping Address Custom Type✓✓✓
Set Shipping Address CustomField✓✓✓

on ItemShipping Address

Update actionCartOrderOrder Edit
Add ItemShippingAddress✓✓✓
Remove ItemShippingAddress✓✓✓
Update ItemShippingAddress✓✓✓
Set ItemShipping Address Custom Type✓✓✓
Set ItemShipping Address CustomField✓✓✓

on ShippingMethod

Update actionCartOrderOrder Edit
Add ShippingMethod✓--
Add Custom ShippingMethod✓--
Remove Shipping Method✓--
Set ShippingMethod✓-✓
Set ShippingAddress and ShippingMethod--✓
Set ShippingAddress and Custom ShippingMethod--✓
Set Custom ShippingMethod✓-✓
Set ShippingRateInput✓-✓
Set ShippingMethod TaxAmount✓-✓
Set ShippingMethod TaxRate✓-✓

on Shipping

Update actionCartOrderOrder Edit
Set Shipping Custom Type✓✓✓
Set Shipping CustomField✓✓✓

on Delivery

Update actionCartOrderOrder Edit
Add Delivery-✓✓
Remove Delivery-✓✓
Change ShipmentState-✓✓
Set Delivery Address-✓✓
Add Parcel to Delivery-✓✓
Remove Parcel from Delivery-✓✓
Set Delivery Items-✓✓
Set Delivery Custom Type-✓✓
Set Delivery CustomField-✓✓

on Delivery Address

Update actionCartOrderOrder Edit
Set Delivery Address Custom Type-✓✓
Set Delivery Address CustomField-✓✓

on Parcel

Update actionCartOrderOrder Edit
Set Parcel Measurements-✓✓
Set Parcel Tracking Data-✓✓
Set Parcel Items-✓✓
Set Parcel Custom Type-✓✓
Set Parcel CustomField-✓✓

on ReturnItem

Update actionCartOrderOrder Edit
Add ReturnInfo-✓✓
Set ReturnInfo-✓✓
Set ReturnShipmentState-✓✓
Set ReturnPaymentState-✓✓
Set ReturnItem Custom Type-✓✓
Set ReturnItem CustomField-✓✓

Limits

A maximum of 10 000 000 Carts can be added to a Project. After this limit is reached, the automatic cleanup task deletes Carts based on their retention period. This is a soft limit that can be increased per Project after a performance impact review. See Limit increase guidance.
A Shopping List can contain up to 250 Line Items and up to 100 Text Line Items. The maximum number of Shopping Lists that can be added to a Project is 10 000 000. After this limit is reached, the automatic cleanup task deletes Shopping Lists based on their retention period. This is a soft limit that can be increased per Project after a performance impact review. See Limit increase guidance.
A Customer or Associate can have up to 50 active and 100 inactive PaymentMethods. A Project can contain up to 1 000 000 PaymentMethods that are not assigned to a Customer or Associate.
A maximum of 100 000 OrderEdits can exist per Project. This is a soft limit that can be increased per Project after a performance impact review. See Limit increase guidance.
Only Orders from the last 3 months are indexed for Order Search and can be retrieved.