Orders

Update the header of an order

Changes the header of an order: customer, project and rental dates (send only the fields to change; the rest stay as they were).

Tool

filmo_orders_update

Writeorders:write

orders:write
120/min
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_orders_update",
    "arguments": {
      "orderId": "orde_8f2a1c"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "id": "id_8f2a1c",
      "orderNumber": "<orderNumber>",
      "externalReference": "<externalReference>",
      "status": "draft",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "rentalDays": 1,
      "projectId": "proj_8f2a1c",
      "projectName": "Example",
      "contact": {
        "id": "id_8f2a1c",
        "name": "Example"
      },
      "itemsCount": 1,
      "subTotalPrice": "1234.50",
      "discountTotal": "1234.50",
      "insuranceTotal": "1234.50",
      "depositTotal": "1234.50",
      "taxesPrice": "1234.50",
      "netPrice": "1234.50",
      "grossPrice": "1234.50",
      "tags": [
        {
          "id": "id_8f2a1c",
          "name": "Example"
        }
      ],
      "customFields": {
        "key": "<key>"
      },
      "source": "<source>",
      "createdAt": "2026-09-01T08:00:00Z",
      "updatedAt": "2026-09-01T08:00:00Z",
      "billingAddress": {
        "label": "Example",
        "addressLine1": "<addressLine1>",
        "addressLine2": "<addressLine2>",
        "city": "<city>",
        "province": "<province>",
        "postcode": "<postcode>",
        "country": "ES"
      },
      "shippingAddress": {
        "label": "Example",
        "addressLine1": "<addressLine1>",
        "addressLine2": "<addressLine2>",
        "city": "<city>",
        "province": "<province>",
        "postcode": "<postcode>",
        "country": "ES"
      },
      "contactPerson": {
        "id": "id_8f2a1c",
        "name": "Example"
      },
      "quotes": [
        {
          "id": "id_8f2a1c",
          "number": "<number>",
          "status": "<status>"
        }
      ],
      "invoices": [
        {
          "id": "id_8f2a1c",
          "number": "<number>",
          "status": "<status>"
        }
      ],
      "proformas": [
        {
          "id": "id_8f2a1c",
          "number": "<number>",
          "status": "<status>"
        }
      ]
    },
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

Changing startDate or endDate moves the WHOLE order: every line that inherits the order period moves with it (sections, type groups and lines already checked in keep theirs), together with its stock reservations and its delivery and return tasks; prices are not recalculated. If the stock does not fit the new period, or the order is cancelled or returned, it responds 409 conflict and nothing is written; sending the dates it already has changes nothing. It does NOT add, remove or edit lines: that goes through the editor. It does not accept amounts or status either, just like creation. The customer and the project are checked against the account of the API key before writing anything. Returns the full order, the same projection as its GET.

Arguments

orderIdstringRequired

Order identifier.

Limits: min length 1

contactIdstring

Identifier of the order customer. It must belong to the account of the API key.

Limits: min length 1, max length 100

projectIdstring | null

Project the order is assigned to; null unlinks it (standalone order).

Limits: min length 1, max length 100

startDatestring<date-time>

Rental start (ISO 8601 with offset).

endDatestring<date-time>

Rental end (ISO 8601 with offset); it must be later than startDate.

idempotencyKeystring

Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.

Limits: min length 1, max length 255

ifMatchstring

Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.

Limits: min length 1

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Unique order identifier.

orderNumberstring

Human-readable order number.

externalReferencestring | null

External reference of the order (for example, from the customer system); null if not recorded.

statusstring

Raw order status as stored in the database (12 values): draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived or cancelled. archived is part of the stored set but an archived order is not visible to the API, so you will not observe it.

Available options: draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived, cancelled

startDatestring<date-time>

Start of the rental period in ISO 8601 with offset.

endDatestring<date-time>

End of the rental period in ISO 8601 with offset.

rentalDaysnumber | null

Number of billable rental days; null if not calculated.

projectIdstring | null

Identifier of the project the order belongs to; null if not linked.

projectNamestring | null

Name of the project the order belongs to; null if not linked.

contactobject | null

Compact reference to the order contact; null if none.

Show child attributes

contact.idstring

Unique contact identifier.

contact.namestring

Contact name.

itemsCountinteger

Number of items in the order.

subTotalPricestring

Subtotal before discounts and taxes, as a decimal string "1234.50" (ROUND_HALF_UP).