Update order field

PATCH/api/unstable/orders/{orderId}/field

Updates one supported order field.

Request Body

application/json

orderId*string

Order identifier being updated.

Example"ord_123"

field*string

Top-level order field name to update.

Example"status"

value*string

Replacement value serialized as a string.

Example"ready"

[key: string]?never

Response Body

`application/json`

curl -X PATCH "https://loading/api/unstable/orders/{orderId}/field" \  -H "Content-Type: application/json" \  -d '{    "orderId": "ord_123",    "field": "status",    "value": "ready"  }'

{
  "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 field

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`