Skip to main content
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": {
    "name": "<string>",
    "productCode": "<string>"
  },
  "quantity": 123,
  "remainingQuantity": 123,
  "status": "<string>",
  "unitPrice": 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

OK

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.

​
auditInfo
object
​
consumedQuantity
integer<int32>

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

​
id
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. Contains the minimum fields needed to identify and display the product.

​
quantity
integer<int32>

Total committed quantity for this product line.

​
remainingQuantity
integer<int32>

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

​
status
string | null

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

​
unitPrice
number<double>

Agreed unit price for this product line.