Update order

PATCH/api/orders/{id}

Applies an order mutation and returns the resulting revision payload.

Path Parameters

id*string

Resource identifier.

Example"ord_123"

Request Body

application/json

Request payload for Update order.

id*string

Order identifier to update.

Example"ord_123"

customerId?||

Customer identifier.

customerMembershipId?||

Customer membership identifier.

items?array<|||||>|

Complete replacement list of order items.

newItems?array<|||||>|

New items to append to the order.

removedItems?array<>|

Order item ids to remove from the order.

updatedItems?array<>|

Partial item updates to apply to existing order items.

fileIds?array<>|

Replacement list of file identifiers attached to the order.

status?|

Replacement lifecycle status for the order.

customFields?|

Replacement custom field values for the order.

currency?|

Currency code.

invoiceFooterText?|

Replacement footer text shown in invoice-style documents.

invoicePaymentTerms?|

Replacement payment terms shown in invoice-style documents.

data?|

Arbitrary JSON payload stored for the resource.

ownerId?||

Owner identifier.

priceListId?|

Replacement selected price list identifier for the order.

actions?|

actions.

requirementUpdates?array<>|

Requirement status changes to apply.

reorderedItems?array<>|

Parent reassignment instructions for reordered items.

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/orders/ord_123" \  -H "Content-Type: application/json" \  -d '{    "id": "ord_123",    "sessionId": "sess_abc123"  }'

{
  "id": "ord_123",
  "number": "Q-1024",
  "workspaceId": "ws_123",
  "customerId": "cust_123",
  "customerMembershipId": "cm_123",
  "customerInfo": {
    "id": "cust_123",
    "name": "Acme Ltd.",
    "email": "buyer@acme.test"
  },
  "customerMembershipInfo": {
    "id": "cm_123",
    "personId": "person_123",
    "name": "Ana Torres",
    "email": "ana@example.com"
  },
  "currency": "CLP",
  "status": "draft",
  "items": [
    {
      "id": "item_123",
      "type": "product",
      "name": "Industrial Pump",
      "productId": "prod_123",
      "product": {
        "id": "prod_123",
        "title": "Industrial Pump",
        "sku": "PUMP-001",
        "vendor": "Acme Supplies",
        "category": "Pumps",
        "description": "High-pressure industrial pump for water transfer.",
        "mainImageSrc": "https://cdn.recerc.com/products/pump-001.png",
        "alternativeUnits": [
          {
            "type": "alternative",
            "code": "box",
            "name": "Box",
            "factor": 12,
            "dimension": "count",
            "rounding": "nearest"
          }
        ],
        "referenceUnits": [
          {
            "type": "reference",
            "code": "kg",
            "name": "Kilogram",
            "factor": 0.5,
            "dimension": "weight"
          }
        ],
        "baseUnit": {
          "type": "base",
          "code": "unit",
          "name": "Unit",
          "dimension": "count",
          "step": 0,
          "rounding": "nearest"
        },
        "defaultUnitCode": "unit",
        "basePrice": {
          "amount": 0,
          "currencyCode": "CLP"
        },
        "baseCost": {
          "amount": 0,
          "currencyCode": "CLP"
        },
        "customFields": {
          "voltage": "220V"
        },
        "calculatedFields": {
          "marginPercent": 26.8
        },
        "data": {
          "barcode": "7801234567890"
        },
        "files": [
          {
            "id": "file_123",
            "name": "spec-sheet.pdf"
          }
        ],
        "documents": [
          {
            "id": "doc_123",
            "title": "Product Manual"
          }
        ],
        "isFavorite": true
      },
      "quantity": 0,
      "price": 0,
      "originalPrice": {
        "priceListId": "pl_retail",
        "price": 0,
        "currency": "CLP",
        "timestamp": "2026-03-11T10:15:00.000Z",
        "comparedAt": 0,
        "fallbackPriceListId": "pl_default",
        "customerId": "cust_123"
      },
      "taxes": [
        {
          "name": "VAT",
          "rate": 19,
          "type": "VAT",
          "calculation": "exclusive"
        }
      ],
      "baseUnit": {
        "type": "base",
        "code": "unit",
        "name": "Unit",
        "dimension": "count",
        "step": 0,
        "rounding": "nearest"
      },
      "alternativeUnit": {
        "type": "alternative",
        "code": "box",
        "name": "Box",
        "factor": 0,
        "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": 0,
      "quantityReferenceUnit": 0,
      "referenceConversion": "1 box = 12 units",
      "referenceUnit": {
        "type": "alternative",
        "code": "box",
        "name": "Box",
        "factor": 0,
        "dimension": "count",
        "rounding": "nearest"
      },
      "pricingScope": "self"
    }
  ],
  "fileIds": [
    "file_123",
    "file_456"
  ],
  "requirements": [
    {
      "id": "req_123",
      "key": "credit_approval",
      "title": "Credit approval",
      "description": "Finance must approve payment terms before sending the quote.",
      "status": "pending",
      "reason": "Customer has not submitted signed documents yet.",
      "decidedBy": "wu_123",
      "decidedAt": "string"
    }
  ],
  "ownerId": "wu_123",
  "selectedPriceListId": "pl_123",
  "ownerInfo": {
    "id": "wu_123",
    "name": "Ana Torres",
    "email": "ana@example.com"
  },
  "customFields": {
    "delivery_date": "2026-03-20",
    "approved": true
  },
  "totals": {
    "subtotal": 0,
    "tax": 0,
    "total": 0,
    "subtotalBeforeAdjustments": 0,
    "adjustmentsTotal": 0,
    "totalExcludingTax": 0
  },
  "invoiceFooterText": "Thank you for your business.",
  "invoicePaymentTerms": "Net 30 days",
  "customFieldsSchema": [
    {
      "id": "requested_delivery_date",
      "name": "Requested delivery date",
      "type": "date",
      "required": false,
      "initialValue": "2026-03-20",
      "objectHandle": "customers",
      "options": [
        "string"
      ],
      "nCols": 0,
      "defaultToToday": true,
      "inputVariant": "textarea",
      "rows": 0,
      "visibleIf": {
        "fieldId": "delivery_type",
        "equals": "pickup"
      },
      "allowCreate": false,
      "readOnly": false,
      "confirmOnChange": {
        "title": "Change customer?",
        "description": "Changing the customer will recalculate pricing and clear dependent fields.",
        "confirmText": "Change customer",
        "cancelText": "Keep current customer"
      }
    }
  ],
  "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": "default",
    "configs": {
      "productSelection": {
        "stockVariable": "available_stock",
        "productStatusVariable": "lifecycle_status"
      },
      "customItemFields": [
        {
          "id": "installation_date",
          "name": "Installation date",
          "type": "date",
          "required": false,
          "multiline": false,
          "currency": false,
          "options": [
            "string"
          ],
          "defaultToToday": true,
          "validation": {
            "min": 0,
            "max": 0,
            "pattern": "^[A-Z0-9-]+$"
          }
        }
      ],
      "itemCustomFields": [
        {
          "id": "installation_date",
          "name": "Installation date",
          "type": "date",
          "required": false,
          "multiline": false,
          "currency": false,
          "options": [
            "string"
          ],
          "defaultToToday": true,
          "validation": {
            "min": 0,
            "max": 0,
            "pattern": "^[A-Z0-9-]+$"
          }
        }
      ],
      "sections": {
        "metrics": true
      }
    }
  },
  "formulaResult": "string",
  "revision": 0,
  "calculatedFields": {
    "editMode": true,
    "previewPdfMode": "watermark",
    "changeCustomerIdDisabled": false,
    "customItemsDisabled": false,
    "feesAdjustmentsDisabled": false
  },
  "showCompareAtPrices": false,
  "createdAt": "string",
  "updatedAt": "string"
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Update order

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`