Skip to main content
POST
/
commerce
/
callofforders
/
{callOffOrderId}
/
items
/
{itemId}
/
cancel
Error
A valid request URL is required to generate request examples
{
  "attributes": [
    {
      "attributeDefinitionId": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "fullyQualifiedName": "<string>",
      "values": [
        "<unknown>"
      ]
    }
  ],
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "availableActions": [
    "<string>"
  ],
  "blanketOrderId": "<string>",
  "cancelledBy": "<string>",
  "cancelledDate": "2023-11-07T05:31:56Z",
  "cancelledReason": {
    "description": "<string>",
    "moreInfo": "<string>",
    "reasonCode": "<string>"
  },
  "changeMessages": [
    {
      "body": "<string>",
      "callOffOrderId": "<string>",
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "identifier": "<string>",
      "newValue": "<string>",
      "oldValue": "<string>",
      "siteId": 123,
      "subject": "<string>",
      "tenantId": 123
    }
  ],
  "channelCode": "<string>",
  "completedAt": "2023-11-07T05:31:56Z",
  "creditHold": {
    "onHold": true,
    "reason": {
      "description": "<string>",
      "moreInfo": "<string>",
      "reasonCode": "<string>"
    }
  },
  "currencyCode": "<string>",
  "customerAccountId": 123,
  "data": {},
  "destinations": [
    {
      "data": {},
      "destinationContact": {
        "address": {
          "address1": "<string>",
          "address2": "<string>",
          "address3": "<string>",
          "address4": "<string>",
          "addressType": "<string>",
          "cityOrTown": "<string>",
          "countryCode": "<string>",
          "isValidated": true,
          "postalOrZipCode": "<string>",
          "stateOrProvince": "<string>"
        },
        "companyOrOrganization": "<string>",
        "email": "jsmith@example.com",
        "firstName": "<string>",
        "id": 123,
        "lastNameOrSurname": "<string>",
        "middleNameOrInitial": "<string>",
        "phoneNumbers": {
          "home": "<string>",
          "mobile": "<string>",
          "work": "<string>"
        }
      },
      "id": "<string>",
      "isDestinationCommercial": true
    }
  ],
  "externalId": "<string>",
  "id": "<string>",
  "items": [
    {
      "actualDeliveryDate": "2023-11-07T05:31:56Z",
      "attributes": [
        {
          "attributeDefinitionId": 123,
          "auditInfo": {
            "createBy": "<string>",
            "createDate": "2023-11-07T05:31:56Z",
            "updateBy": "<string>",
            "updateDate": "2023-11-07T05:31:56Z"
          },
          "fullyQualifiedName": "<string>",
          "values": [
            "<unknown>"
          ]
        }
      ],
      "blanketOrderItemId": "<string>",
      "cancelledBy": "<string>",
      "cancelledDate": "2023-11-07T05:31:56Z",
      "cancelledReason": {
        "description": "<string>",
        "moreInfo": "<string>",
        "reasonCode": "<string>"
      },
      "destinationId": "<string>",
      "expectedDeliveryDate": "2023-11-07T05:31:56Z",
      "fillRate": 123,
      "fulfillmentLocationCode": "<string>",
      "fulfillmentType": "<string>",
      "id": "<string>",
      "inventoryTags": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "lineId": 123,
      "lineTotal": 123,
      "product": {
        "name": "<string>",
        "productCode": "<string>"
      },
      "releasedDate": "2023-11-07T05:31:56Z",
      "releasedQty": 123,
      "requestedDeliveryDate": "2023-11-07T05:31:56Z",
      "requestedQty": 123,
      "requestedShipDate": "2023-11-07T05:31:56Z",
      "reservedQty": 123,
      "salesOrderId": "<string>",
      "status": "<string>",
      "unitPrice": 123
    }
  ],
  "notes": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "id": "<string>",
      "text": "<string>"
    }
  ],
  "number": 123,
  "reservationId": "<string>",
  "siteId": 123,
  "status": "<string>",
  "tenantId": 123,
  "totalAmount": 123,
  "version": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
callOffOrderId
string
required
​
itemId
string
required

Query Parameters

​
responseFields
string

limits which fields are returned in the response body

Body

application/json

Request payload for executing a lifecycle action on a Call-Off Order (e.g. cancel, release).

​
actionName
string | null

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

​
itemIds
string[] | null

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

​
reason
object

Response

OK

A buyer's delivery request, either linked to a Blanket Order or standalone.

​
attributes
object[] | null

Custom attributes extending AbstractAttribute. Flows downstream to Sales Orders and Shipments in later phases.

​
auditInfo
object
​
availableActions
string[] | null

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

​
blanketOrderId
string | null

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

​
cancelledBy
string | null

User who cancelled the call-off order.

​
cancelledDate
string<date-time> | null

Cancellation timestamp.

​
cancelledReason
object
​
changeMessages
object[] | null

Change messages describing mutations to this call-off order. Hydrated from a separate collection on read; not embedded on the document.

​
channelCode
string | null

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

​
completedAt
string<date-time> | null

Timestamp when all lines reached terminal status.

​
creditHold
object

Header-level credit-hold state for a CallOffOrder. Replaces the per-item CreditHold + CreditHoldReason fields that lived on CallOffOrderItem prior to this change — credit-hold is a header concern (one decision per order) not a per-line concern.

​
currencyCode
string | null

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

​
customerAccountId
integer<int32> | null

B2B Account identifier. Must reference an active B2B account.

​
data
object | null

Vendor / extension custom data, free-form JSON.

​
destinations
object[] | null

Shipping destinations. Items reference these by DestinationId (IDestinationContainer pattern).

​
externalId
string | null

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

​
id
string | null

System-generated unique identifier (MozuObjectId).

​
items
object[] | null

Requested product line items.

​
notes
object[] | null

Structured notes attached to the call-off order.

​
number
integer<int32> | null

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

​
reservationId
string | null

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

​
siteId
integer<int32>

Site identifier. Populated from the API context on read.

​
status
string | null

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

​
tenantId
integer<int32>

Tenant identifier. Populated from the API context on read.

​
totalAmount
number<double>

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

​
version
string | null

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