v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB
CallOffOrder

Add Item

Add Item

post/commerce/callofforders/{callOffOrderId}/items

Path parameters

callOffOrderIdstring required

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Request body

actualDeliveryDatestring date-time nullable

Actual delivery date, recorded once the line has been physically delivered.

blanketOrderItemIdstring nullable

Identifier of the Blanket Order item this item draws from. Required when the parent call-off references a Blanket Order.

cancelledBystring nullable

User who cancelled this line.

cancelledDatestring date-time nullable

Line cancellation timestamp.

destinationIdstring nullable

Identifier of the Destination in the parent call-off's Destinations collection that this line ships to.

expectedDeliveryDatestring date-time nullable

Expected delivery date, typically provided by the supplier or fulfillment system.

fillRatenumber double nullable

Computed fill ratio (ReservedQty / RequestedQty). Phase 2+.

fulfillmentLocationCodestring nullable

Pickup location code. Meaningful only when FulfillmentType == "Pickup"; ignored for Ship / Digital / Curbside / Delivery (downstream Order Routing handles those). Carried into the SalesOrder created by the Release Rules Engine (spec 005 FR-021).

fulfillmentTypestring nullable

Per-line fulfillment method. One of: Ship, Pickup, Digital, Curbside, Delivery. In a future release, CallOffOrderItem may extend FulfillableCommerceItem.

idstring nullable

System-generated item identifier.

lineIdinteger nullable

Sequential line identifier within the call-off, auto-assigned.

lineTotalnumber double nullable

Total amount for this line. Client-supplied in Mode 1; computed in Mode 2.

releasedDatestring date-time nullable

Timestamp when this line was released to a Sales Order (Phase 3).

releasedQtyinteger

Quantity released to a Sales Order. Written in Phase 3; zero in Phases 1–2.

requestedDeliveryDatestring date-time nullable

Buyer-requested delivery date for this line.

requestedQtyinteger

Buyer-requested quantity.

requestedShipDatestring date-time nullable

Buyer-requested ship date. Must fall within the parent Blanket Order's validity period when a Blanket Order is referenced.

reservedQtyinteger

Quantity reserved by the inventory reservation engine. Written in Phase 2; zero in Phase 1.

salesOrderIdstring nullable

The SalesOrder id this line was released into. Null until the line transitions to Released by the Release Rules Engine (spec 005). Immutable thereafter.

statusstring nullable

Current line status. One of: Hold, PartiallyReserved, Released, Converted, Cancelled.

unitPricenumber double nullable

Per-line unit price. Overridable — may come from the Blanket Order, be client-supplied, or be buyer-negotiated.

Response

OK

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.