Update order

PATCH/api/unstable/orders/{id}

Applies an order mutation and returns the resulting revision payload.

Request Body

application/json

id*string

Order identifier to update.

Example"ord_123"

customerId?|

customerMembershipId?|

items?array<|||||>

Complete replacement list of order items.

Example

[
  {
    "id": "item_123",
    "type": "custom",
    "name": "Installation service",
    "quantity": 1,
    "price": 35000,
    "taxes": [],
    "baseUnit": {
      "type": "base",
      "code": "service",
      "name": "Service",
      "dimension": "count",
      "step": 1
    }
  }
]

newItems?array<|||||>

New items to append to the order.

Example

[
  {
    "id": "item_456",
    "type": "adjustment",
    "name": "Discount",
    "amount": -10,
    "kind": "percentage",
    "taxes": []
  }
]

removedItems?array<>

Order item ids to remove from the order.

Example

[
  "item_456"
]

updatedItems?array<>

Partial item updates to apply to existing order items.

Example

[
  {
    "id": "item_123",
    "quantity": 3,
    "price": 13990
  }
]

status?string

Replacement lifecycle status for the order.

Value in"draft" | "in review" | "ready" | "accepted" | "cancelled"

Example"ready"

customFields?

Replacement custom field values for the order.

Example

{
  "requested_delivery_date": "2026-03-22"
}

currency?string

Replacement order currency code.

Length1 <= length

Example"USD"

invoiceFooterText?string

Replacement footer text shown in invoice-style documents.

Example"Thank you for your business."

invoicePaymentTerms?string

Replacement payment terms shown in invoice-style documents.

Example"Net 30"

data?

Additional order metadata updates.

Example

{
  "quoteVisibility": "private"
}

ownerId?|

priceListId?string

Replacement selected price list identifier for the order.

Example"pl_wholesale"

actions?

Derived actions to execute as part of the update.

Example

{
  "changeCurrency": {
    "currentCurrency": "CLP",
    "targetCurrency": "USD"
  }
}

requirementUpdates?array<>

Requirement status changes to apply.

Example

[
  {
    "id": "req_123",
    "status": "approved",
    "reason": "Customer sent the signed PO."
  }
]

reorderedItems?array<>

Parent reassignment instructions for reordered items.

Example

[
  {
    "id": "item_123",
    "parentId": "item_section_1"
  }
]

sessionId*string

Client session identifier used to correlate collaborative updates.

Example"sess_abc123"

[key: string]?never

Response Body

`application/json`

curl -X PATCH "https://loading/api/unstable/orders/{id}" \  -H "Content-Type: application/json" \  -d '{    "id": "ord_123",    "sessionId": "sess_abc123"  }'

{
  "id": "string",
  "number": "string",
  "workspaceId": "string",
  "customerId": "string",
  "customerMembershipId": "string",
  "customerInfo": {
    "id": "string",
    "name": "string",
    "email": "string"
  },
  "customerMembershipInfo": {
    "id": "string",
    "personId": "string",
    "name": "string",
    "email": "string"
  },
  "currency": "string",
  "status": "draft",
  "items": [
    {
      "id": "item_123",
      "type": "product",
      "name": "Industrial Pump",
      "productId": "prod_123",
      "product": {
        "id": "prod_123",
        "title": "Industrial Pump",
        "sku": "PUMP-001"
      },
      "quantity": 2,
      "price": 12990,
      "originalPrice": {
        "priceListId": "pl_retail",
        "price": 12990,
        "currency": "CLP",
        "timestamp": "2026-03-11T10:15:00.000Z"
      },
      "taxes": [
        {
          "name": "VAT",
          "rate": 19,
          "type": "VAT",
          "calculation": "exclusive"
        }
      ],
      "baseUnit": {
        "type": "base",
        "code": "unit",
        "name": "Unit",
        "dimension": "count",
        "step": 1,
        "rounding": "nearest"
      },
      "alternativeUnit": {
        "type": "alternative",
        "code": "box",
        "name": "Box",
        "factor": 12,
        "dimension": "count",
        "rounding": "nearest"
      },
      "parentId": "item_bundle_1",
      "index": 0,
      "note": "Keep this line grouped with installation.",
      "mainImageSrc": "https://cdn.recerc.com/products/pump-001.png",
      "description": "Includes installation kit and calibration.",
      "customFields": {
        "installation_required": true
      },
      "calculatedFields": {
        "line_margin": 18.5
      },
      "tags": [
        {
          "name": "featured",
          "label": "Featured"
        }
      ],
      "priceReferenceUnit": 6495,
      "quantityReferenceUnit": 4,
      "referenceConversion": "1 box = 12 units",
      "referenceUnit": {
        "type": "alternative",
        "code": "box",
        "name": "Box",
        "factor": 12,
        "dimension": "count",
        "rounding": "nearest"
      },
      "pricingScope": "self"
    }
  ],
  "requirements": [
    {
      "id": "string",
      "key": "string",
      "title": "string",
      "description": "string",
      "status": "pending",
      "reason": "string",
      "decidedBy": "string",
      "decidedAt": "string"
    }
  ],
  "ownerId": "string",
  "selectedPriceListId": "string",
  "ownerInfo": {
    "id": "string",
    "name": "string",
    "email": "string"
  },
  "customFields": {
    "delivery_date": "2026-03-20",
    "approved": true
  },
  "totals": {
    "subtotal": 0,
    "tax": 0,
    "total": 0,
    "subtotalBeforeAdjustments": 0,
    "adjustmentsTotal": 0,
    "totalExcludingTax": 0
  },
  "invoiceFooterText": "string",
  "invoicePaymentTerms": "string",
  "customFieldsSchema": [
    {
      "id": "string",
      "name": "string",
      "type": "text",
      "required": true,
      "initialValue": "string",
      "objectHandle": "string",
      "options": [
        "string"
      ],
      "nCols": 0,
      "defaultToToday": true,
      "inputVariant": "input",
      "rows": 0,
      "visibleIf": {
        "fieldId": "string",
        "equals": "string"
      },
      "allowCreate": true,
      "readOnly": true,
      "confirmOnChange": {
        "title": "string",
        "description": "string",
        "confirmText": "string",
        "cancelText": "string"
      }
    }
  ],
  "pdfConfig": {
    "includeProductImages": true,
    "includePageNumbers": true,
    "priceDisplayMode": "taxIncluded",
    "separatePagesAfterSubtotals": false,
    "headerOnlyFirstPage": false,
    "includeLineNumbers": true,
    "includeProductDocumentLinks": false,
    "productImagePlacement": "column",
    "pictureSize": "normal",
    "includeImagesInDetailRows": false,
    "showSubtotals": true,
    "excludeTaxes": false,
    "pageSize": "A4",
    "showCurrencyCode": true
  },
  "quoteVisibility": "private",
  "layoutConfig": {
    "layout": "string",
    "configs": {
      "productSelection": {
        "stockVariable": "string",
        "productStatusVariable": "string"
      },
      "customItemFields": [
        {
          "id": "string",
          "name": "string",
          "type": "text",
          "required": true,
          "multiline": true,
          "currency": true,
          "options": [
            "string"
          ],
          "defaultToToday": true,
          "validation": {
            "min": 0,
            "max": 0,
            "pattern": "string"
          }
        }
      ],
      "itemCustomFields": [
        {
          "id": "string",
          "name": "string",
          "type": "text",
          "required": true,
          "multiline": true,
          "currency": true,
          "options": [
            "string"
          ],
          "defaultToToday": true,
          "validation": {
            "min": 0,
            "max": 0,
            "pattern": "string"
          }
        }
      ],
      "sections": {
        "metrics": true
      }
    }
  },
  "formulaResult": "string",
  "revision": 0,
  "calculatedFields": {
    "editMode": true,
    "previewPdfMode": "none",
    "changeCustomerIdDisabled": true,
    "customItemsDisabled": true,
    "feesAdjustmentsDisabled": true
  },
  "showCompareAtPrices": true,
  "createdAt": "string",
  "updatedAt": "string"
}

{
  "issues": [
    {
      "_tag": "Pointer",
      "path": [
        "string"
      ],
      "message": "string"
    }
  ],
  "message": "string",
  "_tag": "HttpApiDecodeError"
}

Empty

{
  "message": "string",
  "_tag": "ApiForbiddenError"
}

{
  "message": "string",
  "_tag": "ApiNotFoundError"
}

{
  "message": "string",
  "_tag": "ApiConflictError"
}

{
  "message": "string",
  "_tag": "ApiUnprocessableEntityError"
}

Empty

{
  "message": "string",
  "_tag": "ApiTimeoutError"
}

Update order

Request Body

Response Body

200application/json

400application/json

401

403application/json

404application/json

409application/json

422application/json

503

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`