v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB

CallOffOrder

Perform Action

post/commerce/callofforders/{callOffOrderId}/actions

Path parameters

callOffOrderIdstring required

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Request body

actionNamestring nullable

Name of the action to execute. Must be present in the call-off order's current AvailableActions list.

itemIdsstring[] nullable

Optional list of item IDs to target. When null or empty, the action applies to every item on the order.

Response

availableActionsstring[] nullable

Actions valid for the current status. Computed on read; not persisted.

blanketOrderIdstring nullable

Identifier of the parent Blanket Order if this call-off draws from one; null for standalone call-offs.

cancelledBystring nullable

User who cancelled the call-off order.

cancelledDatestring date-time nullable

Cancellation timestamp.

channelCodestring nullable

Channel origin (e.g. "wholesale", "ecommerce", "EDI").

completedAtstring date-time nullable

Timestamp when all lines reached terminal status.

currencyCodestring nullable

Currency code (ISO 4217). Must match the parent Blanket Order currency when one is referenced.

customerAccountIdinteger nullable

B2B Account identifier. Must reference an active B2B account.

dataobject nullable

Vendor / extension custom data, free-form JSON.

externalIdstring nullable

Buyer's own reference number / idempotency key (e.g. release number from an ERP). Unique per tenant when supplied.

idstring nullable

System-generated unique identifier (MozuObjectId).

numberinteger nullable

Human-readable sequential number, auto-generated per tenant.

reservationIdstring nullable

Inventory reservation identifier. Set when inventory is reserved for this call-off order.

siteIdinteger

Site identifier. Populated from the API context on read.

statusstring nullable

Current call-off order status. One of: Hold, PartiallyReserved, PartiallyReleased, Completed, Cancelled.

tenantIdinteger

Tenant identifier. Populated from the API context on read.

totalAmountnumber double

Denormalized header total — sum of non-cancelled line LineTotal values. System-maintained; not client-settable.

versionstring nullable

Optimistic locking version. Initialized to "1" and incremented as a string on each update.