Cancel an item on a Blanket Order

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"
  },
  "consumedQuantity": 123,
  "id": "<string>",
  "lineId": 123,
  "product": {
    "bundledProducts": [
      {
        "allocationExpiration": "2023-11-07T05:31:56Z",
        "allocationId": 123,
        "creditValue": 123,
        "deltaPrice": 123,
        "description": "<string>",
        "fulfillmentStatus": "<string>",
        "goodsType": "<string>",
        "imageUrl": "<string>",
        "isPackagedStandAlone": true,
        "measurements": {
          "height": {
            "unit": "<string>",
            "value": 123
          },
          "length": {
            "unit": "<string>",
            "value": 123
          },
          "weight": {
            "unit": "<string>",
            "value": 123
          },
          "width": {
            "unit": "<string>",
            "value": 123
          }
        },
        "name": "<string>",
        "optionAttributeFQN": "<string>",
        "optionValue": "<unknown>",
        "productCode": "<string>",
        "productReservationId": 123,
        "quantity": 123,
        "stock": {
          "aggregateInventory": 123,
          "availableDate": "2023-11-07T05:31:56Z",
          "availableFutureInventories": 123,
          "futureInventories": [
            {
              "allocated": 123,
              "available": 123,
              "createDate": "2023-11-07T05:31:56Z",
              "deliveryDate": "2023-11-07T05:31:56Z",
              "futureInventoryID": 123,
              "onhand": 123,
              "pending": 123
            }
          ],
          "isOnBackOrder": true,
          "isSubstitutable": true,
          "manageStock": true,
          "stockAvailable": 123,
          "totalAvailableStock": 123
        }
      }
    ],
    "combinedProductCode": "<string>",
    "fulfillmentTypesSupported": [
      "<string>"
    ],
    "goodsType": "<string>",
    "isBundle": true,
    "name": "<string>",
    "options": [
      {
        "attributeFQN": "<string>",
        "dataType": "<string>",
        "name": "<string>",
        "shopperEnteredValue": "<unknown>",
        "stringValue": "<string>",
        "value": "<unknown>"
      }
    ],
    "productCode": "<string>",
    "productUsage": "<string>",
    "variationProductCode": "<string>"
  },
  "quantity": 123,
  "remainingQuantity": 123,
  "reservedQuantity": 123,
  "status": "<string>",
  "unitPrice": 123,
  "unreservedQuantity": 123
}

POST

commerce

blanketorders

{blanketOrderId}

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"
  },
  "consumedQuantity": 123,
  "id": "<string>",
  "lineId": 123,
  "product": {
    "bundledProducts": [
      {
        "allocationExpiration": "2023-11-07T05:31:56Z",
        "allocationId": 123,
        "creditValue": 123,
        "deltaPrice": 123,
        "description": "<string>",
        "fulfillmentStatus": "<string>",
        "goodsType": "<string>",
        "imageUrl": "<string>",
        "isPackagedStandAlone": true,
        "measurements": {
          "height": {
            "unit": "<string>",
            "value": 123
          },
          "length": {
            "unit": "<string>",
            "value": 123
          },
          "weight": {
            "unit": "<string>",
            "value": 123
          },
          "width": {
            "unit": "<string>",
            "value": 123
          }
        },
        "name": "<string>",
        "optionAttributeFQN": "<string>",
        "optionValue": "<unknown>",
        "productCode": "<string>",
        "productReservationId": 123,
        "quantity": 123,
        "stock": {
          "aggregateInventory": 123,
          "availableDate": "2023-11-07T05:31:56Z",
          "availableFutureInventories": 123,
          "futureInventories": [
            {
              "allocated": 123,
              "available": 123,
              "createDate": "2023-11-07T05:31:56Z",
              "deliveryDate": "2023-11-07T05:31:56Z",
              "futureInventoryID": 123,
              "onhand": 123,
              "pending": 123
            }
          ],
          "isOnBackOrder": true,
          "isSubstitutable": true,
          "manageStock": true,
          "stockAvailable": 123,
          "totalAvailableStock": 123
        }
      }
    ],
    "combinedProductCode": "<string>",
    "fulfillmentTypesSupported": [
      "<string>"
    ],
    "goodsType": "<string>",
    "isBundle": true,
    "name": "<string>",
    "options": [
      {
        "attributeFQN": "<string>",
        "dataType": "<string>",
        "name": "<string>",
        "shopperEnteredValue": "<unknown>",
        "stringValue": "<string>",
        "value": "<unknown>"
      }
    ],
    "productCode": "<string>",
    "productUsage": "<string>",
    "variationProductCode": "<string>"
  },
  "quantity": 123,
  "remainingQuantity": 123,
  "reservedQuantity": 123,
  "status": "<string>",
  "unitPrice": 123,
  "unreservedQuantity": 123
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme.

Path Parameters

blanketOrderId

string

required

itemId

string

required

Query Parameters

responseFields

string

limits which fields are returned in the response body

Body

application/json

description

string | null

moreInfo

string | null

reasonCode

string | null

Response

A single product commitment within a Blanket Order. Each line tracks its own lifecycle independently.

attributes

object[] | null

Line-level extensible attributes. Use Mozu.CommerceRuntime.Contracts.BlanketOrders.BlanketOrderAttribute on BlanketOrder.Attributes for header-level attributes.

Show child attributes

auditInfo

object

Show child attributes

consumedQuantity

integer<int32>

Total quantity consumed by call-off orders. System-managed.

string | null

Unique identifier for this line. System-supplied.

lineId

integer<int32> | null

Auto-assigned sequential line number within the order.

product

object

Lightweight product identity for Blanket Order Items. Extended fields are stamped from the catalog at blanket creation and carried through to consumption tracking and call-off integration.

Show child attributes

quantity

integer<int32>

Total committed quantity for this product line.

remainingQuantity

integer<int32>

Remaining available quantity (Quantity - ConsumedQuantity). System-managed.

reservedQuantity

integer<int32>

Quantity currently reserved by active call-off allocations against this blanket item. System-managed; not client-settable. Updated only via the internal consumption/ restoration ledger (BlanketOrderHandler.ConsumeAsync/RestoreAsync).

status

string | null

Current line status managed by the line-level transition table.

unitPrice

number<double>

Agreed unit price for this product line.

unreservedQuantity

integer<int32>

read-only

Computed: Quantity - ReservedQuantity. The blanket's balance not yet reserved by call-off allocations. Not persisted.

Developers

API reference

AI Tools

Cancel an item on a Blanket Order

Authorizations

Path Parameters

Query Parameters

Body

Response