Orders

List the lines of an order

Returns which resources the order carries (items, spaces, services and custom elements) with their quantities, their specific serialized units, their period and their sale price.

Tool

filmo_orders_lines_list

Readorders:read

orders:read
120/min
Server annotation: Read-only
Server annotation: Idempotent

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

{
  "structuredContent": {
    "data": [
      {
        "id": "id_8f2a1c",
        "orderId": "orde_8f2a1c",
        "resourceType": "item",
        "transactionType": "rental",
        "status": "draft",
        "position": 1,
        "addedDuringDelivery": true,
        "itemId": "item_8f2a1c",
        "itemName": "Example",
        "variantId": "vari_8f2a1c",
        "spaceId": "spac_8f2a1c",
        "quantity": 1,
        "serials": [
          {
            "id": "id_8f2a1c",
            "code": "<code>",
            "serialNumber": "<serialNumber>"
          }
        ],
        "startDate": "2026-09-01T08:00:00Z",
        "endDate": "2026-09-01T08:00:00Z",
        "rentalDays": 1,
        "unitPrice": "1234.50",
        "linePrice": "1234.50",
        "free": true,
        "notes": "<notes>"
      }
    ],
    "pagination": {
      "nextCursor": "eyJvIjo1MH0",
      "hasMore": true,
      "total": 1
    },
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      },
      "etag": "\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""
    }
  }
}

generated from the schema

It is the usual query after getting an order. Lines added during delivery are left out unless requested with includeDelivery=true. It emits no cost or margin data. Lines belong to the order and are only obtained through it: there is no independent collection of lines. Lines come in document order.

Arguments

orderIdstringRequired

Order identifier.

Limits: min length 1

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

sortstring

Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: position, itemName, quantity, startDate, endDate, rentalDays, unitPrice, linePrice, status, resourceType, transactionType. Defaults to "position". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.

Limits: max length 200

resourceTypestring

Filter by line resource type: item, space, service, custom, section or type_group.

Available options: item, kit, space, vehicle, personnel, service, custom, section, type_group

transactionTypestring

Filter by line nature: rental or sale.

Available options: rental, sale

includeDeliverybooleandefault:false

If "true", also includes the lines added during the delivery process. By default only the lines of the original order are returned.

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

Result

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

Show the attributes of data

idstring

Unique line identifier.

orderIdstring

Identifier of the order the line belongs to.

resourceTypestring

Resource type of the line. Lines of type section and type_group are presentation groupings with no associated resource.

Available options: item, kit, space, vehicle, personnel, service, custom, section, type_group

transactionTypestring

Nature of the line: rental or sale.

Available options: rental, sale

statusstring

Status of the line within the order flow.

Available options: draft, reserved, prepared, picked_up, sold, returned, checked_in, cancelled, lost

positioninteger

Display position of the line within the order, starting at 0.

addedDuringDeliveryboolean

true if the line was added during the delivery process rather than in the original order.

itemIdstring | null

Catalog item identifier; null if the line is not of type item.

itemNamestring | null

Name of the item, space, service or custom element of the line.

variantIdstring | null

Identifier of the item variant; null if not applicable.

spaceIdstring | null

Space identifier; null if the line is not of type space.

quantitynumber

Units of the line.

serialsobject[]

Specific physical units assigned. Empty for non-serialized items or when not yet assigned.

Show child attributes

serials.idstring

Unique identifier of the serialized item.

serials.codestring | null

Internal code of the unit; null if none.

serials.serialNumberstring | null

Manufacturer serial number; null if not recorded.

startDatestring<date-time> | null

Start of the line period in ISO 8601 UTC; null if it inherits the order period.

endDatestring<date-time> | null

End of the line period in ISO 8601 UTC; null if it inherits the order period.

rentalDaysnumber | null

Billable rental days of the line; null if not calculated.

unitPricestring | null

Net unit price as a decimal string "1234.50"; null if the line has no price of its own.

Limits: pattern ^-?\d+\.\d{2}$

linePricestring | null

Total net amount of the line as a decimal string "1234.50"; null if not calculated.

Limits: pattern ^-?\d+\.\d{2}$

freeboolean

true if the line is explicitly billed at zero.

notesstring | null

Line notes; null if none.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/orders/{orderId}/lines.

Orders
List the lines of an order
Returns which resources the order carries (items, spaces, services and custom elements) with their quantities, their specific serialized units, their period and their sale price.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

List the lines of an order

Safe writes

Errors