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.

GET

/api/v1/orders/{orderId}/lines

curl https://app.filmo.io/api/v1/orders/orde_8f2a1c/lines \
  --header "Authorization: Bearer $FILMO_API_KEY"

Node.jsfetch('https://app.filmo.io/api/v1/orders/orde_8f2a1c/lines', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get( "https://app.filmo.io/api/v1/orders/orde_8f2a1c/lines", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY" } )

{
  "data": [
    {
      "id": "order_line_9f3a2b",
      "orderId": "order_9f3a2b",
      "resourceType": "item",
      "transactionType": "rental",
      "status": "draft",
      "position": 1,
      "addedDuringDelivery": true,
      "itemId": "item_9f3a2b",
      "itemName": "Example item name",
      "variantId": "variant_9f3a2b",
      "spaceId": "space_9f3a2b",
      "quantity": 1,
      "serials": [
        {
          "id": "serial_9f3a2b",
          "code": "Example code",
          "serialNumber": "2026-0001"
        }
      ],
      "startDate": "2026-09-01T08:00:00.000Z",
      "endDate": "2026-09-01T08:00:00.000Z",
      "rentalDays": 1,
      "unitPrice": "120.00",
      "linePrice": "120.00",
      "free": true,
      "notes": "Example text."
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "orders:read"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

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.

Authorizations

Bearer API key with the scope below. orders:read

Path parameters

orderIdstringRequired

Order identifier.

Limits: min length 1

Query parameters

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.

Response

application/json

Successful response.

Response schema: OrderLineDto

Envelope: OrderLineList. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Show child attributes

data.idstring

Unique line identifier.

data.orderIdstring

Identifier of the order the line belongs to.

data.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

data.transactionTypestring

Nature of the line: rental or sale.

Available options: rental, sale

data.statusstring

Status of the line within the order flow.

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

data.positioninteger

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

data.addedDuringDeliveryboolean

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

data.itemIdstring | null

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

data.itemNamestring | null

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

data.variantIdstring | null

Identifier of the item variant; null if not applicable.

data.spaceIdstring | null

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

data.quantitynumber

Units of the line.

data.serialsobject[]

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

Show child attributes

data.serials.idstring

Unique identifier of the serialized item.

data.serials.codestring | null

Internal code of the unit; null if none.

data.serials.serialNumberstring | null

Manufacturer serial number; null if not recorded.

data.startDatestring<date-time> | null

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

data.endDatestring<date-time> | null

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

data.rentalDaysnumber | null

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

data.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}$

data.linePricestring | null

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

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

data.freeboolean

true if the line is explicitly billed at zero.

data.notesstring | null

Line notes; null if none.

paginationobject

Opaque-cursor pagination metadata.

Show child attributes

pagination.nextCursorstring | null

Opaque cursor of the next page; null when there are no more results. Pass it as cursor in the next request.

pagination.hasMoreboolean

Whether more results exist beyond this page.

pagination.totalinteger

Number of results matching the filters across all pages. Present only when the request sets includeTotal=true.

Limits: min 0

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

Status	Codes	Meaning
400	`validation_error`	Malformed query or body. `errors[]` lists every offending field with its stable code.
404	`not_found`	It does not exist or is outside the scope of the API key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Rentals
Order line
Order line: which resource it carries, how much, when and at what sale price.

Was this page helpful?

Request examples

Authorizations

Path parameters

Query parameters

Response

Errors

Deprecation

Related

Related pages

Order line