--- title: Update Order slug: update-order createdAt: 2026-08-25T19:28:59.170Z --- { "id": "SaqOftFuJCkFZ2Z2ZrxGk", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.nue.io/cpq/orders/{orderId}:update", "servers": [ { "url": "https://api.nue.io/cpq/orders/{orderId}:update", "description": "Nue Production API Endpoint" }, { "url": "https://api.sandbox.nue.io/cpq/orders/{orderId}:update", "description": "Nue Sandbox API Endpoint" } ], "name": "Update Order", "description": "

Applies one or more actions to an existing order, then re-runs the same pricing and tax cascade the Nue Line Editor runs internally.

\n

Action-oriented, not payload-oriented. You do not send the order you want; you send an ordered list of actions naming what to do. Fields you omit are untouched, and lines you omit are untouched — a line is deleted only when you name it in a deleteLineItems action. This is what separates this endpoint from PATCH /api/objects/Order/{id}, which writes the field you send and recalculates nothing, with one exception: a body that carries partnerPayoutPercentage or partnerPayoutAmount is re-priced.

\n

The six actions: updateHeaderFields, updateLineItems, deleteLineItems, addLineItems, replacePriceTags, removePriceTags.

\n

Key behaviors:

\n\n

Activated orders and live subscriptions are out of scope — use the Change Order endpoint instead.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "orderId", "type": "string", "description": "The id of the order to update." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "

Action-oriented update request. You send an ordered list of actions describing what to do, not the desired order document. Fields and lines you do not name are left untouched.

", "customType": "UpdateOrderRequest", "schema": [ { "name": "isCommit", "kind": "optional", "type": "boolean", "description": "

true (or omitted) persists the result. false runs the full pricing and tax cascade in memory and persists nothing. Must be a boolean.

", "example": true, "default": true }, { "name": "recalc", "kind": "optional", "type": "string", "description": "

Recalculation mode. Case-sensitive. AUTO derives what to recompute from which fields changed.

", "example": "AUTO", "default": "AUTO", "enum": [ "AUTO", "PRICING_ONLY", "TAX_ONLY", "NONE" ] }, { "name": "expectedLastModified", "kind": "optional", "type": "string", "description": "

Optimistic-concurrency guard. When set, the update fails with ORDER_MODIFIED unless it matches the record's current last-modified timestamp.

", "format": "date-time" }, { "name": "actions", "kind": "required", "type": "array", "description": "

Ordered list of actions. The server re-orders them into canonical stages (header fields, deletes, price-tag actions, line updates, adds) before executing. The sort is stable within a stage, so same-stage actions keep your submitted order — which matters only for removePriceTags/replacePriceTags, the one pair that shares a stage and is not covered by the per-line conflict check.

", "modelRef": "#/components/schemas/UpdateAction", "customType": "UpdateAction[]", "schema": [ { "name": "action", "kind": "required", "type": "string", "description": "The operation to perform.", "enum": [ "updateHeaderFields", "updateLineItems", "deleteLineItems", "addLineItems", "replacePriceTags", "removePriceTags" ] }, { "name": "payload", "kind": "optional", "type": "map", "description": "

Action-specific payload.

\n
    \n
  • updateHeaderFields -> { fieldValues: { <nueFieldName>: value } }
    • \n
  • updateLineItems -> { lineItems: [ { lineItemId, fieldValues } ] }
    • \n
  • deleteLineItems -> { lineItemIds: [ id ] }
    • \n
  • addLineItems -> { products: [ AddQuoteProductRequest ] }
    • \n
  • replacePriceTags -> { priceTags: [ { <oldIdOrCode>: <newIdOrCode> } ], target?, includeChildren? }
    • \n
  • removePriceTags -> { priceTags: [ <idOrCode> ], target?, includeChildren? }
    • \n
", "example": "", "customType": "map", "schema": [] } ] } ], "modelRef": "#/components/schemas/UpdateOrderRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "ApiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

The order was updated (or, with isCommit=false, previewed) successfully.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "The recalculated order after the update.", "customType": "UpdateOrderResponse", "schema": [ { "name": "order", "kind": "optional", "type": "map", "description": "

The order header with recalculated pricing, metrics, and tax.

", "example": "", "customType": "map", "schema": [] }, { "name": "orderProducts", "kind": "optional", "type": "array", "description": "

Every order product after the update, with hierarchy.

", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" }, { "name": "warnings", "kind": "optional", "type": "array", "description": "

Non-blocking advisories returned alongside a successful update.

", "modelRef": "#/components/schemas/Message", "customType": "Message[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "description": "

Severity level: Error, Warning, or FATAL.

" }, { "name": "errorType", "kind": "optional", "type": "string", "description": "

Specific error or warning code (e.g., PRODUCT_SKU_OR_NAME_REQUIRED, DUPLICATE_PRICE_TAG).

" }, { "name": "message", "kind": "optional", "type": "string", "description": "

Human-readable description.

" } ] } ], "modelRef": "#/components/schemas/UpdateOrderResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "

Invalid request — unknown action, conflicting actions, invalid or non-updatable field, non-editable line, failed business rule, or a stale expectedLastModified.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Error envelope returned by the CPQ REST endpoints, including Update Quote, Update Order, and PATCH /api/objects/{Quote,Order}/{id}. errorDetails is omitted when empty.

", "customType": "ApiErrorResponse", "schema": [ { "name": "status", "kind": "optional", "type": "integer", "description": "HTTP status code.", "example": 400 }, { "name": "error", "kind": "optional", "type": "string", "description": "Short error title.", "example": "Failed to update quote" }, { "name": "message", "kind": "optional", "type": "string", "description": "

Human-readable message. For a single failure it matches the first errorDetails entry.

" }, { "name": "errorDetails", "kind": "optional", "type": "array", "description": "

One entry per failure, each with a semantic errorCode.

", "modelRef": "#/components/schemas/ErrorDetail", "customType": "ErrorDetail[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "description": "Semantic error code.", "example": "QUOTE_NOT_FOUND" }, { "name": "message", "kind": "optional", "type": "string", "description": "

Human-readable error message.

" }, { "name": "path", "kind": "optional", "type": "string", "description": "

Where in the request the error is about, when it is about one place, for example body.buckets[2]. Absent when the error is about the call as a whole.

", "example": "body.buckets[2].allocations[0]" } ] } ], "modelRef": "#/components/schemas/ApiErrorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error. Nothing was committed.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Error envelope returned by the CPQ REST endpoints, including Update Quote, Update Order, and PATCH /api/objects/{Quote,Order}/{id}. errorDetails is omitted when empty.

", "customType": "ApiErrorResponse", "schema": [ { "name": "status", "kind": "optional", "type": "integer", "description": "HTTP status code.", "example": 400 }, { "name": "error", "kind": "optional", "type": "string", "description": "Short error title.", "example": "Failed to update quote" }, { "name": "message", "kind": "optional", "type": "string", "description": "

Human-readable message. For a single failure it matches the first errorDetails entry.

" }, { "name": "errorDetails", "kind": "optional", "type": "array", "description": "

One entry per failure, each with a semantic errorCode.

", "modelRef": "#/components/schemas/ErrorDetail", "customType": "ErrorDetail[]", "schema": [ { "name": "errorCode", "kind": "optional", "type": "string", "description": "Semantic error code.", "example": "QUOTE_NOT_FOUND" }, { "name": "message", "kind": "optional", "type": "string", "description": "

Human-readable error message.

" }, { "name": "path", "kind": "optional", "type": "string", "description": "

Where in the request the error is about, when it is about one place, for example body.buckets[2]. Absent when the error is about the call as a whole.

", "example": "body.buckets[2].allocations[0]" } ] } ], "modelRef": "#/components/schemas/ApiErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "example-0-curl", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/cpq/orders/{orderId}:update \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"isCommit\": true,\n \"recalc\": \"AUTO\",\n \"actions\": [\n {\n \"action\": \"\"\n }\n ]\n }'" }, { "id": "example-1-javascript", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"isCommit\": true,\n \"recalc\": \"AUTO\",\n \"actions\": [\n {\n \"action\": \"\"\n }\n ]\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/cpq/orders/{orderId}:update\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "example-2-ruby", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/cpq/orders/{orderId}:update\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"isCommit\": true,\n \"recalc\": \"AUTO\",\n \"actions\": [\n {\n \"action\": \"\"\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "example-3-python", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/cpq/orders/{orderId}:update\"\n\npayload = json.dumps({\n \"isCommit\": True,\n \"recalc\": \"AUTO\",\n \"actions\": [\n {\n \"action\": \"\"\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "example-0-curl" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// The order was updated (or, with isCommit=false, previewed) successfully.\n{\n \"order\": \"\",\n \"orderProducts\": [\n {}\n ],\n \"warnings\": [\n {\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\"\n }\n ]\n}" }, { "id": "response-1-400", "language": "400", "code": "// Invalid request — unknown action, conflicting actions, invalid or non-updatable field, non-editable line, failed business rule, or a stale expectedLastModified.\n{\n \"status\": 400,\n \"error\": \"Failed to update quote\",\n \"message\": \"\",\n \"errorDetails\": [\n {\n \"errorCode\": \"QUOTE_NOT_FOUND\",\n \"message\": \"\",\n \"path\": \"body.buckets[2].allocations[0]\"\n }\n ]\n}" }, { "id": "response-2-500", "language": "500", "code": "// Internal server error. Nothing was committed.\n{\n \"status\": 400,\n \"error\": \"Failed to update quote\",\n \"message\": \"\",\n \"errorDetails\": [\n {\n \"errorCode\": \"QUOTE_NOT_FOUND\",\n \"message\": \"\",\n \"path\": \"body.buckets[2].allocations[0]\"\n }\n ]\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }