Update Order

Updates an existing order. The fields that can be modified depend on the current state of the order and the updateMode used.

Update Modes

Mode	Value	Description
`ApplyToOriginal`	(default)	Applies changes directly to the order. For accepted orders, the order must pass editability checks or the call will be rejected (except for `ExternalId` on partial orders).
`ApplyToDraft`	`ApplyToDraft`	Applies changes to a draft copy of the order. The original order is not modified. A draft is automatically created if one does not exist. The draft has `Status=Pending` and passes editability checks, so all editable fields can be set on the draft.
`ApplyAndCommit`	`ApplyAndCommit`	Applies changes to the draft and then commits the draft back to the original order. For accepted orders, this creates new shipments from the draft order items.

Editability Rules

An order is considered not editable when any of the following are true:

The order has been accepted (AcceptedDate is set, meaning shipments have been created).
The order status is not one of: Pending, PendingReview, or PendingShipment.
The order is a partial/split order in a non-Pending/non-PendingShipment status.

When the order is not editable and updateMode=ApplyToOriginal, the API will return a 403 Forbidden error, except for the ExternalId field on partial orders (see below).

When updateMode=ApplyToDraft, the changes are applied to the draft copy which is always in Pending status, so the editability restriction does not block the update.

Fields Updated by UpdateOrder

Always Updated (Regardless of Order Status)

These fields are copied from the request body to the order on every call, whether the order is pre-acceptance or post-acceptance (when using draft mode):

Field	Notes
`Email`	Overwrites the existing value.
`SourceDevice`	Overwrites the existing value.
`AcceptsMarketing`	Only updated if the incoming value is non-null; otherwise the existing value is preserved.
`VisitId`	Overwrites the existing value.
`WebSessionId`	Overwrites the existing value.
`CustomerInteractionType`	Overwrites the existing value.
`ShopperNotes`	Overwrites the existing value.
`AlternateContact`	Overwrites the existing value.
`ShipmentCreationOffset`	Validated: must be `-1` or a positive integer from `1` to `7200`.
`ParentOrderId`	Validated: cannot be set to the order’s own ID; the referenced parent order must exist.
`ExternalId`	Can be set or changed, but cannot be cleared once set. If the incoming value is null or empty, the existing value is preserved.
`FulfillmentInfo`	Updated via `SetFulfillmentInfoAsync` if a non-null value is provided.

Conditionally Updated

Field	Condition	Notes
`UserId`	Only if `CustomerAccountId` is null and `UserId` is currently blank on the order.	Once set, `UserId` cannot be changed via this API.
`CustomerAccountId`	Only if `CustomerAccountId` is currently null on the order.	Once set, `CustomerAccountId` cannot be changed via this API. If not yet set and the caller is not an anonymous shopper, a customer account is created or looked up automatically.
`DutyAmount`	Only if the order is in a modifiable status (not `Completed`, `Cancelled`, `Null`, or `Abandoned`).	If the order is in a terminal status and the incoming `DutyAmount` differs from the existing value, a `cannotUpdateDutyAmount` validation error is thrown. If the duty total changes, the pricing pipeline is re-executed.
`BillingInfo`	Only if the order has not been accepted (`HasBeenAccepted = false`).	Ignored on accepted orders. Use the dedicated Set Billing Info API instead.
`IPAddress`	Only for offline orders (`Type = Offline`).	For online orders, the IP address is set from the client request automatically (pre-submission only).
`OriginalCartId`	Only for offline orders, and only if a non-empty value is provided.	Used for cart takeover scenarios.

Post-Acceptance Discount Exclusions

When the order has been accepted, the API supports updating discount exclusions on existing order-level and shipping-level discounts:

OrderDiscounts — each discount’s exclusion flag can be toggled via UpdateDiscountExclusion.
ShippingDiscounts — each discount’s exclusion flag can be toggled via UpdateDiscountExclusion.

If any discount exclusion is changed, the pricing pipeline is re-executed to recalculate totals.

This is the only pricing-related modification available on accepted orders through this endpoint (outside of draft mode).

ExternalId on Non-Editable Partial Orders

As a special case, if the order fails editability checks (e.g., it is a partial/split order that has been accepted) but the request body includes a non-empty ExternalId, the ExternalId is updated and the order is saved immediately. No other fields are modified and no pricing pipeline is executed. This is the only field that bypasses the editability restriction outside of draft mode.

Draft Mode Behavior (ApplyToDraft / ApplyAndCommit)

When updateMode=ApplyToDraft:

The system retrieves or creates a draft copy of the order. The draft is a separate embedded document with Status=Pending and IsDraft=true.
All field updates listed above are applied to the draft, not the original order.
The draft is persisted. The original order is unchanged.
The draft is returned in the response.

When updateMode=ApplyAndCommit:

The same field updates are applied to the draft.
After updates, the system calls CreateShipmentsFromDraftOrder, which:
- Validates the order is in draft mode and has items.
- Splits the draft order into shipments via the fulfillment routing engine.
- Evaluates and updates the rollup status on the original order.
- Adds a PostSubmitItemsAdded change message to the original order.
- Clears the draft from the original order.
The updated original order (with new shipments) is returned.

Pricing Pipeline

The update order pricing pipeline is re-executed when:

DutyAmount changes (and the order is in a modifiable status).
A discount exclusion is toggled on an accepted order.

When the pipeline runs, it recalculates order totals, taxes, and applied discounts.

Summary: What Can You Update on an Accepted Order with Shipments?

Directly (updateMode=ApplyToOriginal)

Updatable	Field
Yes	`Email`
Yes	`SourceDevice`
Yes	`AcceptsMarketing`
Yes	`VisitId`
Yes	`WebSessionId`
Yes	`CustomerInteractionType`
Yes	`ShopperNotes`
Yes	`AlternateContact`
Yes	`ShipmentCreationOffset`
Yes	`ParentOrderId`
Yes	`ExternalId` (set/change only, not clear)
Yes	`FulfillmentInfo`
Yes	`DutyAmount` (if order is not in terminal status)
Yes	`OrderDiscounts` / `ShippingDiscounts` (exclusion flag only)
No	`BillingInfo` (ignored after acceptance; use Set Billing Info)
No	`UserId` (locked once set)
No	`CustomerAccountId` (locked once set)
No	`IPAddress` (online orders only, pre-submission only)
No	`Items` (use draft mode or the dedicated Order Items API)

Via Draft Mode (updateMode=ApplyToDraft then ApplyAndCommit)

All of the above fields, plus the ability to modify items on the draft and commit them as new shipments on the original order.

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme.

Path Parameters

orderId

string

required

The order ID to update.

Query Parameters

updateMode

string

Determines the update strategy for this update (ApplyAndCommit, ApplyToOriginal, ApplyToDraft).

version

string

Determines whether or not to check versioning of items for concurrency purposes.

responseFields

string

limits which fields are returned in the response body

Body

application/json

All properties of the order to place.

Order form.

auditInfo

object

Show child attributes

changeMessages

object[] | null

List of messages displayed by the system based on the last cart action, for example, when a product price has changed or is out-of-stock. System-supplied and read-only.

Show child attributes

channelCode

string | null

Unique identifier of the channel for this item.

currencyCode

string | null

ISO Currency Code. Currently, only USD is supported.

customerInteractionType

string | null

Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown

data

object

Custom data for a given vendor set within the commerce process.

discountThresholdMessages

object[] | null

List of Mozu.CommerceRuntime.Contracts.Commerce.ThresholdMessage objects that are valid for the current value of the cart/order.

Show child attributes

discountTotal

number<double> | null

Amount of the discounts applied to all items in the cart. This is a negative number. This also includes the order level discounts.

discountedSubtotal

number<double> | null

Combined price for all cart items, including all selected options as well as any discounts.

discountedTotal

number<double> | null

Subtotal minus the discounted total

expirationDate

string<date-time> | null

When the order will no longer be active. That is, the order is considered abandoned. Orders of anonymous shoppers expire after 14 days of inactivity. An order never expires for shoppers who are logged into their account. Date in UTC Date/Time.

extendedProperties

object[] | null

Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values.

Show child attributes

feeTotal

number<double> | null

Not implemented. Total cost of fees for all items in the cart.

fulfillmentInfo

object

Shipment information, which includes the shipping address, price, estimated delivery date, tracking information, method (for example, Ground, Overnight, or Pick-up), carrier (for example, USPS, UPS, FedEx), and current status (for example, Not Shipped, In Transit, Delayed, or Returned To Sender).

Show child attributes

handlingTaxTotal

number<double> | null

Total tax on handling

string | null

Unique identifier of the CommerceAggregate object (e.g. order, cart, wishlist, etc.).

itemTaxTotal

number<double> | null

Not implemented. Tax does not appear on cart.

lastValidationDate

string<date-time> | null

Occasionally the commerce runtime may validate that item/product names, descriptions, and prices have not changed. If changed, it updates LastValidationDate.

lineItemSubtotalWithOrderAdjustments

number<double> | null

Line Item Subtotals with Order Adjustments

orderDiscounts

object[] | null

The discount that has been applied to the cart itself. If multiple discounts exist, this is the discount that the system applies because it offers the best savings for the shopper. This is a negative number.

Show child attributes

rejectedDiscounts

object[] | null

Show child attributes

shippingAmountBeforeDiscountsAndAdjustments

number<double> | null

Shipping Amount before discount and adjustments

shippingSubTotal

number<double> | null

Shipping total without discounts applied.

shippingTaxTotal

number<double> | null

Not implemented. Tax does not appear on cart.

shippingTotal

number<double> | null

Shipping does not appear on cart.

siteId

integer<int32> | null

Unique identifier of the Site.

subtotal

number<double> | null

Combined price for all cart items, including all selected options but excluding any discounts.

suggestedDiscounts

object[] | null

Show child attributes

taxData

object

Storage for any additional/custom tax data.

taxTotal

number<double> | null

Tax does not appear on cart.

tenantId

integer<int32> | null

Unique identifier of the Tenant.

total

number<double> | null

Final total amount of the order including all discounts, shipping, and tax.

userId

string | null

Unique identifier of the shopper who created the cart.

visitId

string | null

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

webSessionId

string | null

Identifies the web session used to place the order or last update the cart.

acceptedDate

string<date-time> | null

When the order was accepted by the merchant

acceptsMarketing

boolean | null

Does the customer accept marketing

adjustment

object

Show child attributes

alternateContact

object

Show child attributes

amountAvailableForRefund

number<double>

This property represents AmountCaptured - AmountRefunded via returns. It is read only.

amountRefunded

number<double>

A counter for how much money has been issued in refunds. This calculated field does NOT include refunds issued in returns.

amountRemainingForPayment

number<double>

A counter for how much of the order total has not been claimed by payments. This is computed by Order.Total-(sum of Order.Payments where State is not voided/declined)

attributes

object[] | null

Show child attributes

availableActions

string[] | null

Actions available to the payment

billingInfo

object

Customer's payment details such as payment type (credit card, check by mail, or PayPal) and cardholder information if payment is by credit card.

Show child attributes

canceledItems

object[] | null

Items canceled on the Order due to Rule violation

Show child attributes

cancelledDate

string<date-time> | null

Date the order was cancelled.

closedDate

string<date-time> | null

Date the order was closed. A closed order means that the order has been processed and items shipped.

continuityOrderOrdinal

integer<int32>

The ordinal to track the Continuity order.

couponCodes

string[] | null

Coupon codes associated with this order. Only set on order import.

credits

object[] | null

Show child attributes

customerAccountId

integer<int32> | null

Unique identifier of the customer account.

customerTaxId

string | null

The customers tax ID. If Customer Account ID exists in the system, will set this.

digitalPackages

object[] | null

Fulfillment digital packages associated with this order.

Show child attributes

dutyAmount

number<double> | null

Order level duty or tariff amount. Does not take into account duties or tariffs specifically on items on the order

dutyTotal

number<double> | null

Duties or tariffs for the Order as well as OrderItems (e.g. if the Order has a $5 duty or tariff for any reason and an OrderItem has a $2 duty or tariff then the value in this property would be $7)

string | null

Email address of the customer at the time the order is placed.

externalId

string | null

An order number to link this order to an external system

forceDeliveryConsolidationOnSplitShipments

boolean | null

Overrides the Fulfillment SiteSetting value for ForceDeliveryConsolidationOnSplitShipments. TODO autogen instead of manual addition

forceSTHConsolidationOnSplitShipments

boolean | null

Overrides the Fulfillment SiteSetting value for ForceSTHConsolidationOnSplitShipments. TODO autogen instead of manual addition

fulfillmentStatus

string | null

Current fulfillment status, which can be "NotFulfilled,", "PartiallyFulfilled", or "Fufilled." System-supplied and read-only. Values are available in FulfillmentStatusConst of this class.

handlingAdjustment

object

Show child attributes

handlingAmount

number<double> | null

Order level handling fees excluding any discounts.

handlingDiscounts

object[] | null

The list of historically-applied handling discounts. The active one will have IsExcluded == false

Show child attributes

handlingSubTotal

number<double> | null

Handling fees for the Order as well as OrderItems (e.g. if the Order has a $5 handling fee and an OrderItem has a $2 handling fee per item quantity and the quantity of items is 2 then the value in this property would be $9)

handlingTotal

number<double> | null

Handling fees including any discounts.

hasDraft

boolean | null

Does this order have a draft version.

importDate

string<date-time> | null

Date this item was imported

invalidCoupons

object[] | null

A list of invalid coupons that were attempted on the order

Show child attributes

ipAddress

string | null

IP address of the user placing the order. (User or customer?)

isContinuityOrder

boolean

Flag to check if the order is continuityOrder.

isDraft

boolean | null

Is this order a draft version

isEligibleForReturns

boolean

Marker for determining if the order is a) complete or b) has some items that are shipped and not part of any other return

isFulfillable

boolean

Flag to indicate whether it is safe to proceed with fulfillment on shipments on the order.

isHistoricalImport

boolean | null

Indicates this was an order in a terminal state (completed/canceled) that was imported into the system for historical purposes.

isImport

boolean | null

Was this order initiated from an external system

isOptInForSms

boolean

Whether the shopper opts in to curbside text notifications.

isPartialOrder

boolean

Returns {true} if this order originated from a checkout and has sibling partial orders, otherwise {false}.

isTaxExempt

boolean | null

Unique identifier of the customer account.

isUnified

boolean

Was this order created by the Unified platform.

items

object[] | null

List of items in the order.

Show child attributes

locationCode

string | null

Identifies the location at which the order was placed if the order was placed externally.

notes

object[] | null

Internal notes that a merchant may add to the order. Maximum 250 characters.

Show child attributes

orderNumber

integer<int32> | null

Order Number. This is an integer that is only assigned after an order is placed and enters the open state.

originalCartId

string | null

Unique identifier for the cart that was converted to order.

originalQuoteId

string | null

If this order originated from a quote, this is the identifier of the originating quote.

originalQuoteNumber

integer<int32> | null

If this order originated from a quote, this is the number of the originating quote.

packages

object[] | null

Shipping package associated with this order.

Show child attributes

parentCheckoutId

string | null

If this order originated from a multi-ship enabled site, this is the identifier of the originating checkout.

parentCheckoutNumber

integer<int32> | null

If this order originated from a multi-ship enabled site, this is the number of the originating checkout.

parentOrderId

string | null

If this Order has a parent order, this should be the parent's ID.

parentOrderNumber

integer<int32> | null

If this order has a parent order, this should be the parent's Mozu.CommerceRuntime.Contracts.Orders.Order.OrderNumber.

parentReturnId

string | null

If this order was created as part of a return, this should be the return's ID.

parentReturnNumber

integer<int32> | null

If this order was created as part of a return, this should be the return's ReturnNumber.

partialOrderCount

integer<int32> | null

If this order originated from a checkout, this is the total number of orders created from that checkout.

partialOrderNumber

integer<int32> | null

If this order originated from a checkout, this is a sequence number out of the total orders created from that checkout.

paymentStatus

string | null

Current status of payment, which can be "Null," "AwaitingCheck," "AwaitingPayment," "Paid," "Authorized," or "Void." System-supplied and read-only.

payments

object[] | null

Payment transaction associated with this order. It is the entire payment interchange between the merchant who is forwarding the customer's payment information and the payment service who is authorizing and capturing payment. Payment can be either by credit card, check, or PayPal.

Show child attributes

pickups

object[] | null

Fulfillment pickups associated with this order.

Show child attributes

priceListCode

string | null

Pricelist code for the order

readyToCapture

boolean

refunds

object[] | null

Refunds associated with this order. A refund is a single exchange of money from merchant to customer that either encapsulates a refund to a credit card or an issuance of a store credit. Refunds does not reduce the 'amount collected' on an order and it is possible for refunds to exceed the total order amount.

Show child attributes

releaseShipmentDate

string<date-time> | null

reservationId

string | null

Inventory Reservation id for order.

restrictCancellation

boolean | null

Settings this flag on the order will restrict user from Cancelling the order

restrictEdit

boolean | null

Setting this flag on the order will restrict user from editing the order

returnStatus

string | null

System-supplied and read-only.

shipmentCreationOffset

integer<int32> | null

Release Shipment After(in minutes) (Order Submitted Date).

shipments

object[] | null

Package shipments associated with this order.

Show child attributes

shippingAdjustment

object

Show child attributes

shippingDiscounts

object[] | null

Show child attributes

shippingGroups

object[] | null

List of order grouping.

Show child attributes

shopperNotes

object

Notes that the shopper has added to this order, for example, a gift message or other comments.

Show child attributes

sourceDevice

string | null

Source device of the user placing the order. (User or customer?)

status

string | null

Current status of the order, which can be viewed in OrderStatusConst. System-supplied and read-only.

submittedDate

string<date-time> | null

When the customer placed (submitted) the order.

subscriptionIds

string[] | null

All the subscriptions associated with the current order.

totalCollected

number<double>

Total amount of money collected on the order via payments.

type

string | null

Is this Order Online or Offline? Online means shopper entered at checkout, offline means a phone order.

validationResults

object[] | null

Validation results for the order when processes against validation capabilities.

Show child attributes

version

string | null

Version for concurrency purposes

Response

Success

Order form.

auditInfo

object

Show child attributes

changeMessages

object[] | null

List of messages displayed by the system based on the last cart action, for example, when a product price has changed or is out-of-stock. System-supplied and read-only.

Show child attributes

channelCode

string | null

Unique identifier of the channel for this item.

currencyCode

string | null

ISO Currency Code. Currently, only USD is supported.

customerInteractionType

string | null

Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown

data

object

Custom data for a given vendor set within the commerce process.

discountThresholdMessages

object[] | null

List of Mozu.CommerceRuntime.Contracts.Commerce.ThresholdMessage objects that are valid for the current value of the cart/order.

Show child attributes

discountTotal

number<double> | null

Amount of the discounts applied to all items in the cart. This is a negative number. This also includes the order level discounts.

discountedSubtotal

number<double> | null

Combined price for all cart items, including all selected options as well as any discounts.

discountedTotal

number<double> | null

Subtotal minus the discounted total

expirationDate

string<date-time> | null

extendedProperties

object[] | null

Extra properties (key-value pairs) that extend the primary object. Think of this as a property bag of string keys and string values.

Show child attributes

feeTotal

number<double> | null

Not implemented. Total cost of fees for all items in the cart.

fulfillmentInfo

object

Show child attributes

handlingTaxTotal

number<double> | null

Total tax on handling

string | null

Unique identifier of the CommerceAggregate object (e.g. order, cart, wishlist, etc.).

itemTaxTotal

number<double> | null

Not implemented. Tax does not appear on cart.

lastValidationDate

string<date-time> | null

Occasionally the commerce runtime may validate that item/product names, descriptions, and prices have not changed. If changed, it updates LastValidationDate.

lineItemSubtotalWithOrderAdjustments

number<double> | null

Line Item Subtotals with Order Adjustments

orderDiscounts

object[] | null

Show child attributes

rejectedDiscounts

object[] | null

Show child attributes

shippingAmountBeforeDiscountsAndAdjustments

number<double> | null

Shipping Amount before discount and adjustments

shippingSubTotal

number<double> | null

Shipping total without discounts applied.

shippingTaxTotal

number<double> | null

Not implemented. Tax does not appear on cart.

shippingTotal

number<double> | null

Shipping does not appear on cart.

siteId

integer<int32> | null

Unique identifier of the Site.

subtotal

number<double> | null

Combined price for all cart items, including all selected options but excluding any discounts.

suggestedDiscounts

object[] | null

Show child attributes

taxData

object

Storage for any additional/custom tax data.

taxTotal

number<double> | null

Tax does not appear on cart.

tenantId

integer<int32> | null

Unique identifier of the Tenant.

total

number<double> | null

Final total amount of the order including all discounts, shipping, and tax.

userId

string | null

Unique identifier of the shopper who created the cart.

visitId

string | null

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

webSessionId

string | null

Identifies the web session used to place the order or last update the cart.

acceptedDate

string<date-time> | null

When the order was accepted by the merchant

acceptsMarketing

boolean | null

Does the customer accept marketing

adjustment

object

Show child attributes

alternateContact

object

Show child attributes

amountAvailableForRefund

number<double>

This property represents AmountCaptured - AmountRefunded via returns. It is read only.

amountRefunded

number<double>

A counter for how much money has been issued in refunds. This calculated field does NOT include refunds issued in returns.

amountRemainingForPayment

number<double>

A counter for how much of the order total has not been claimed by payments. This is computed by Order.Total-(sum of Order.Payments where State is not voided/declined)

attributes

object[] | null

Show child attributes

availableActions

string[] | null

Actions available to the payment

billingInfo

object

Customer's payment details such as payment type (credit card, check by mail, or PayPal) and cardholder information if payment is by credit card.

Show child attributes

canceledItems

object[] | null

Items canceled on the Order due to Rule violation

Show child attributes

cancelledDate

string<date-time> | null

Date the order was cancelled.

closedDate

string<date-time> | null

Date the order was closed. A closed order means that the order has been processed and items shipped.

continuityOrderOrdinal

integer<int32>

The ordinal to track the Continuity order.

couponCodes

string[] | null

Coupon codes associated with this order. Only set on order import.

credits

object[] | null

Show child attributes

customerAccountId

integer<int32> | null

Unique identifier of the customer account.

customerTaxId

string | null

The customers tax ID. If Customer Account ID exists in the system, will set this.

digitalPackages

object[] | null

Fulfillment digital packages associated with this order.

Show child attributes

dutyAmount

number<double> | null

Order level duty or tariff amount. Does not take into account duties or tariffs specifically on items on the order

dutyTotal

number<double> | null

Duties or tariffs for the Order as well as OrderItems (e.g. if the Order has a $5 duty or tariff for any reason and an OrderItem has a $2 duty or tariff then the value in this property would be $7)

string | null

Email address of the customer at the time the order is placed.

externalId

string | null

An order number to link this order to an external system

forceDeliveryConsolidationOnSplitShipments

boolean | null

Overrides the Fulfillment SiteSetting value for ForceDeliveryConsolidationOnSplitShipments. TODO autogen instead of manual addition

forceSTHConsolidationOnSplitShipments

boolean | null

Overrides the Fulfillment SiteSetting value for ForceSTHConsolidationOnSplitShipments. TODO autogen instead of manual addition

fulfillmentStatus

string | null

Current fulfillment status, which can be "NotFulfilled,", "PartiallyFulfilled", or "Fufilled." System-supplied and read-only. Values are available in FulfillmentStatusConst of this class.

handlingAdjustment

object

Show child attributes

handlingAmount

number<double> | null

Order level handling fees excluding any discounts.

handlingDiscounts

object[] | null

The list of historically-applied handling discounts. The active one will have IsExcluded == false

Show child attributes

handlingSubTotal

number<double> | null

handlingTotal

number<double> | null

Handling fees including any discounts.

hasDraft

boolean | null

Does this order have a draft version.

importDate

string<date-time> | null

Date this item was imported

invalidCoupons

object[] | null

A list of invalid coupons that were attempted on the order

Show child attributes

ipAddress

string | null

IP address of the user placing the order. (User or customer?)

isContinuityOrder

boolean

Flag to check if the order is continuityOrder.

isDraft

boolean | null

Is this order a draft version

isEligibleForReturns

boolean

Marker for determining if the order is a) complete or b) has some items that are shipped and not part of any other return

isFulfillable

boolean

Flag to indicate whether it is safe to proceed with fulfillment on shipments on the order.

isHistoricalImport

boolean | null

Indicates this was an order in a terminal state (completed/canceled) that was imported into the system for historical purposes.

isImport

boolean | null

Was this order initiated from an external system

isOptInForSms

boolean

Whether the shopper opts in to curbside text notifications.

isPartialOrder

boolean

Returns {true} if this order originated from a checkout and has sibling partial orders, otherwise {false}.

isTaxExempt

boolean | null

Unique identifier of the customer account.

isUnified

boolean

Was this order created by the Unified platform.

items

object[] | null

List of items in the order.

Show child attributes

locationCode

string | null

Identifies the location at which the order was placed if the order was placed externally.

notes

object[] | null

Internal notes that a merchant may add to the order. Maximum 250 characters.

Show child attributes

orderNumber

integer<int32> | null

Order Number. This is an integer that is only assigned after an order is placed and enters the open state.

originalCartId

string | null

Unique identifier for the cart that was converted to order.

originalQuoteId

string | null

If this order originated from a quote, this is the identifier of the originating quote.

originalQuoteNumber

integer<int32> | null

If this order originated from a quote, this is the number of the originating quote.

packages

object[] | null

Shipping package associated with this order.

Show child attributes

parentCheckoutId

string | null

If this order originated from a multi-ship enabled site, this is the identifier of the originating checkout.

parentCheckoutNumber

integer<int32> | null

If this order originated from a multi-ship enabled site, this is the number of the originating checkout.

parentOrderId

string | null

If this Order has a parent order, this should be the parent's ID.

parentOrderNumber

integer<int32> | null

If this order has a parent order, this should be the parent's Mozu.CommerceRuntime.Contracts.Orders.Order.OrderNumber.

parentReturnId

string | null

If this order was created as part of a return, this should be the return's ID.

parentReturnNumber

integer<int32> | null

If this order was created as part of a return, this should be the return's ReturnNumber.

partialOrderCount

integer<int32> | null

If this order originated from a checkout, this is the total number of orders created from that checkout.

partialOrderNumber

integer<int32> | null

If this order originated from a checkout, this is a sequence number out of the total orders created from that checkout.

paymentStatus

string | null

Current status of payment, which can be "Null," "AwaitingCheck," "AwaitingPayment," "Paid," "Authorized," or "Void." System-supplied and read-only.

payments

object[] | null

Show child attributes

pickups

object[] | null

Fulfillment pickups associated with this order.

Show child attributes

priceListCode

string | null

Pricelist code for the order

readyToCapture

boolean

refunds

object[] | null

Show child attributes

releaseShipmentDate

string<date-time> | null

reservationId

string | null

Inventory Reservation id for order.

restrictCancellation

boolean | null

Settings this flag on the order will restrict user from Cancelling the order

restrictEdit

boolean | null

Setting this flag on the order will restrict user from editing the order

returnStatus

string | null

System-supplied and read-only.

shipmentCreationOffset

integer<int32> | null

Release Shipment After(in minutes) (Order Submitted Date).

shipments

object[] | null

Package shipments associated with this order.

Show child attributes

shippingAdjustment

object

Show child attributes

shippingDiscounts

object[] | null

Show child attributes

shippingGroups

object[] | null

List of order grouping.

Show child attributes

shopperNotes

object

Notes that the shopper has added to this order, for example, a gift message or other comments.

Show child attributes

sourceDevice

string | null

Source device of the user placing the order. (User or customer?)

status

string | null

Current status of the order, which can be viewed in OrderStatusConst. System-supplied and read-only.

submittedDate

string<date-time> | null

When the customer placed (submitted) the order.

subscriptionIds

string[] | null

All the subscriptions associated with the current order.

totalCollected

number<double>

Total amount of money collected on the order via payments.

type

string | null

Is this Order Online or Offline? Online means shopper entered at checkout, offline means a phone order.

validationResults

object[] | null

Validation results for the order when processes against validation capabilities.

Show child attributes

version

string | null

Version for concurrency purposes

Developers

API reference

AI Tools

Update Modes

Editability Rules

Fields Updated by UpdateOrder

Always Updated (Regardless of Order Status)

Conditionally Updated

Post-Acceptance Discount Exclusions

ExternalId on Non-Editable Partial Orders

Draft Mode Behavior (ApplyToDraft / ApplyAndCommit)

Pricing Pipeline

Summary: What Can You Update on an Accepted Order with Shipments?

Directly (updateMode=ApplyToOriginal)

Via Draft Mode (updateMode=ApplyToDraft then ApplyAndCommit)

Authorizations

Path Parameters

Query Parameters

Body

Response