--- title: "Update an existing Blanket Order" method: PUT path: "/commerce/blanketorders/{blanketOrderId}" tags: ["BlanketOrder"] --- # Update an existing Blanket Order `PUT /commerce/blanketorders/{blanketOrderId}` Update an existing Blanket Order. ## Path parameters - `blanketOrderId` string, required ## Query parameters - `responseFields` string ## Request body - BlanketOrder — Represents a contractual commitment between the seller and a B2B Account to supply goods at predetermined prices and quantities over a specified period. - `attributes` BlanketOrderAttribute[], nullable — Custom attributes at the header level. - `attributeDefinitionId` integer, nullable - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `fullyQualifiedName` string, nullable - `values` unknown[], nullable - unknown - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `availableActions` string[], nullable — Available lifecycle actions from the current status. Populated on read. - `buyerContact` AlternateContact - `emailAddress` string, email — Email Address of alternate contact during order process - `firstName` string — First Name of alternate contact during order process - `lastNameOrSurname` string — Last Name of alternate contact during order process - `phoneNumber` string, nullable — Phone Number of alternate contact during order process - `canceledReason` CommerceRuntimeCanceledReason - `description` string, nullable - `moreInfo` string, nullable - `reasonCode` string, nullable - `cancelledDate` string, date-time, nullable — Date when the order was cancelled. System-supplied, read-only. - `changeMessages` CommerceRuntimeChangeMessage[], nullable — Change messages associated with this Blanket Order. Hydrated from a separate collection. - `amount` number, double, nullable — Monetary amount that pertains to the change if applicable - `appId` string, nullable — App Id that identifies the user that performed the related change - `appKey` string, nullable — App Key - `appName` string, nullable — App Name - `attributes` object, nullable — Additional Data. This property will be a Dictionary of objects. - `correlationId` string, nullable — Correlation Id - `createDate` string, date-time, nullable — When the message was created. System-supplied. Read-only. - `id` string, nullable — Unique identifier of the message. System-supplied. Read-only. - `identifier` string, nullable — Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only. - `message` string, nullable — Human readable message. System-supplied. Read-only. - `metadata` unknown - `newValue` string, nullable — Current price of the item. System-supplied. Read-only. - `oldValue` string, nullable — Original price of the item. System-supplied. Read-only. - `subject` string, nullable — Text on the subject line of the message, for example, the product name. System-supplied. Read-only. - `subjectType` string, nullable — Subject of the message, for example, "Product." System-supplied. Read-only. - `success` boolean, nullable — Indicates if the message is related to a success or failure. - `userFirstName` string, nullable — User First Name - `userId` string, nullable — User Id that identifies the user that performed the related change - `userLastName` string, nullable — User Last Name - `userScopeType` string, nullable — User Type (e.g. Shopper, Admin, etc.) - `verb` string, nullable — Action applicable to the message. This can be "Increased," when the product price has increased, "Decreased," when the product price has decreased, and "Invalidated," when the product is no longer available. System-supplied. Read-only. - `channelCode` string, nullable — Channel code for multi-channel context. - `currencyCode` string, nullable — Currency code (default "USD"). - `customerAccountId` integer, nullable - `data` object, nullable — Extensibility data bag for tenant-specific custom data. - `externalId` string, nullable — External reference identifier for integration with external systems. - `id` string, nullable - `items` BlanketOrderItem[], nullable — Product commitment Items for this Blanket Order. - `attributes` BlanketOrderItemAttribute[], nullable — Line-level extensible attributes. Use Mozu.CommerceRuntime.Contracts.BlanketOrders.BlanketOrderAttribute on `BlanketOrder.Attributes` for header-level attributes. - `attributeDefinitionId` integer, nullable - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `fullyQualifiedName` string, nullable - `values` unknown[], nullable - unknown - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `consumedQuantity` integer — Total quantity consumed by call-off orders. System-managed. - `id` string, nullable — Unique identifier for this line. System-supplied. - `lineId` integer, nullable — Auto-assigned sequential line number within the order. - `product` BlanketOrderProductReference — Lightweight product identity for Blanket Order Items. Contains the minimum fields needed to identify and display the product. - `name` string, nullable — Product display name. - `productCode` string, nullable — Product code used for identification. - `quantity` integer — Total committed quantity for this product line. - `remainingQuantity` integer — Remaining available quantity (Quantity - ConsumedQuantity). System-managed. - `status` string, nullable — Current line status managed by the line-level transition table. - `unitPrice` number, double — Agreed unit price for this product line. - `notes` CommerceRuntimeOrderNote[], nullable — Internal notes for merchant use. - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `id` string, nullable — Unique identifier of the note. System-supplied and read-only. - `text` string, nullable — Text of the note. Maximum 250 characters. - `number` integer, nullable — Auto-generated sequential Blanket Order number. System-supplied, read-only. - `priceListCode` string, nullable — Price list code for pricing context. - `sellerContact` AlternateContact - `emailAddress` string, email — Email Address of alternate contact during order process - `firstName` string — First Name of alternate contact during order process - `lastNameOrSurname` string — Last Name of alternate contact during order process - `phoneNumber` string, nullable — Phone Number of alternate contact during order process - `siteId` integer - `status` string, nullable — Current status managed by the StatusEngine transition table. - `tenantId` integer - `userId` string, nullable - `validityPeriod` ValidityPeriod — Represents the validity window for a Blanket Order. Call-off orders can only be placed while the current date is within this period. - `endDate` string, date-time — End date of the validity period. Must be after StartDate. - `startDate` string, date-time — Start date of the validity period. Must be today or in the future on creation. - `version` string, nullable — Optimistic concurrency token. System-supplied. ## Response `200` OK - BlanketOrder — Represents a contractual commitment between the seller and a B2B Account to supply goods at predetermined prices and quantities over a specified period. - `attributes` BlanketOrderAttribute[], nullable — Custom attributes at the header level. - `attributeDefinitionId` integer, nullable - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `fullyQualifiedName` string, nullable - `values` unknown[], nullable - unknown - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `availableActions` string[], nullable — Available lifecycle actions from the current status. Populated on read. - `buyerContact` AlternateContact - `emailAddress` string, email — Email Address of alternate contact during order process - `firstName` string — First Name of alternate contact during order process - `lastNameOrSurname` string — Last Name of alternate contact during order process - `phoneNumber` string, nullable — Phone Number of alternate contact during order process - `canceledReason` CommerceRuntimeCanceledReason - `description` string, nullable - `moreInfo` string, nullable - `reasonCode` string, nullable - `cancelledDate` string, date-time, nullable — Date when the order was cancelled. System-supplied, read-only. - `changeMessages` CommerceRuntimeChangeMessage[], nullable — Change messages associated with this Blanket Order. Hydrated from a separate collection. - `amount` number, double, nullable — Monetary amount that pertains to the change if applicable - `appId` string, nullable — App Id that identifies the user that performed the related change - `appKey` string, nullable — App Key - `appName` string, nullable — App Name - `attributes` object, nullable — Additional Data. This property will be a Dictionary of objects. - `correlationId` string, nullable — Correlation Id - `createDate` string, date-time, nullable — When the message was created. System-supplied. Read-only. - `id` string, nullable — Unique identifier of the message. System-supplied. Read-only. - `identifier` string, nullable — Unique identifier to what the message pertains, which can be a cart item, cart or another generic entity. System-supplied. Read-only. - `message` string, nullable — Human readable message. System-supplied. Read-only. - `metadata` unknown - `newValue` string, nullable — Current price of the item. System-supplied. Read-only. - `oldValue` string, nullable — Original price of the item. System-supplied. Read-only. - `subject` string, nullable — Text on the subject line of the message, for example, the product name. System-supplied. Read-only. - `subjectType` string, nullable — Subject of the message, for example, "Product." System-supplied. Read-only. - `success` boolean, nullable — Indicates if the message is related to a success or failure. - `userFirstName` string, nullable — User First Name - `userId` string, nullable — User Id that identifies the user that performed the related change - `userLastName` string, nullable — User Last Name - `userScopeType` string, nullable — User Type (e.g. Shopper, Admin, etc.) - `verb` string, nullable — Action applicable to the message. This can be "Increased," when the product price has increased, "Decreased," when the product price has decreased, and "Invalidated," when the product is no longer available. System-supplied. Read-only. - `channelCode` string, nullable — Channel code for multi-channel context. - `currencyCode` string, nullable — Currency code (default "USD"). - `customerAccountId` integer, nullable - `data` object, nullable — Extensibility data bag for tenant-specific custom data. - `externalId` string, nullable — External reference identifier for integration with external systems. - `id` string, nullable - `items` BlanketOrderItem[], nullable — Product commitment Items for this Blanket Order. - `attributes` BlanketOrderItemAttribute[], nullable — Line-level extensible attributes. Use Mozu.CommerceRuntime.Contracts.BlanketOrders.BlanketOrderAttribute on `BlanketOrder.Attributes` for header-level attributes. - `attributeDefinitionId` integer, nullable - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `fullyQualifiedName` string, nullable - `values` unknown[], nullable - unknown - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `consumedQuantity` integer — Total quantity consumed by call-off orders. System-managed. - `id` string, nullable — Unique identifier for this line. System-supplied. - `lineId` integer, nullable — Auto-assigned sequential line number within the order. - `product` BlanketOrderProductReference — Lightweight product identity for Blanket Order Items. Contains the minimum fields needed to identify and display the product. - `name` string, nullable — Product display name. - `productCode` string, nullable — Product code used for identification. - `quantity` integer — Total committed quantity for this product line. - `remainingQuantity` integer — Remaining available quantity (Quantity - ConsumedQuantity). System-managed. - `status` string, nullable — Current line status managed by the line-level transition table. - `unitPrice` number, double — Agreed unit price for this product line. - `notes` CommerceRuntimeOrderNote[], nullable — Internal notes for merchant use. - `auditInfo` CoreApiContractsAuditInfo - `createBy` string, nullable - `createDate` string, date-time, nullable - `updateBy` string, nullable - `updateDate` string, date-time, nullable - `id` string, nullable — Unique identifier of the note. System-supplied and read-only. - `text` string, nullable — Text of the note. Maximum 250 characters. - `number` integer, nullable — Auto-generated sequential Blanket Order number. System-supplied, read-only. - `priceListCode` string, nullable — Price list code for pricing context. - `sellerContact` AlternateContact - `emailAddress` string, email — Email Address of alternate contact during order process - `firstName` string — First Name of alternate contact during order process - `lastNameOrSurname` string — Last Name of alternate contact during order process - `phoneNumber` string, nullable — Phone Number of alternate contact during order process - `siteId` integer - `status` string, nullable — Current status managed by the StatusEngine transition table. - `tenantId` integer - `userId` string, nullable - `validityPeriod` ValidityPeriod — Represents the validity window for a Blanket Order. Call-off orders can only be placed while the current date is within this period. - `endDate` string, date-time — End date of the validity period. Must be after StartDate. - `startDate` string, date-time — Start date of the validity period. Must be today or in the future on creation. - `version` string, nullable — Optimistic concurrency token. System-supplied. --- [API](https://skmtc.net/kibocommerce/apis/customer.md) · [All operations](https://skmtc.net/kibocommerce/apis/customer/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kibocommerce/customer/versions/47c0cf7b75ab/schema)