Filmo Docs
Español

Orders

Get an order

Returns the detail of an order.

GET
/api/v1/orders/{orderId}

Request examples

curl https://app.filmo.io/api/v1/orders/orde_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": {
    "id": "order_9f3a2b",
    "orderNumber": "2026-0001",
    "externalReference": "2026-0001",
    "status": "draft",
    "startDate": "2026-09-01T08:00:00.000Z",
    "endDate": "2026-09-01T08:00:00.000Z",
    "rentalDays": 1,
    "projectId": "project_9f3a2b",
    "projectName": "Example project name",
    "contact": {
      "id": "contact_9f3a2b",
      "name": "Example contact"
    },
    "itemsCount": 1,
    "subTotalPrice": "120.00",
    "discountTotal": "120.00",
    "insuranceTotal": "120.00",
    "depositTotal": "120.00",
    "taxesPrice": "120.00",
    "netPrice": "120.00",
    "grossPrice": "120.00",
    "tags": [
      {
        "id": "tag_9f3a2b",
        "name": "Example tag"
      }
    ],
    "customFields": {
      "example": "example"
    },
    "source": "Example source",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z",
    "billingAddress": {
      "label": "Main",
      "addressLine1": "Calle de Ejemplo 12",
      "addressLine2": "Calle de Ejemplo 12",
      "city": "Madrid",
      "province": "Madrid",
      "postcode": "28001",
      "country": "ES"
    },
    "shippingAddress": {
      "label": "Main",
      "addressLine1": "Calle de Ejemplo 12",
      "addressLine2": "Calle de Ejemplo 12",
      "city": "Madrid",
      "province": "Madrid",
      "postcode": "28001",
      "country": "ES"
    },
    "contactPerson": {
      "id": "contact_person_9f3a2b",
      "name": "Example contact person"
    },
    "quotes": [
      {
        "id": "quote_9f3a2b",
        "number": "2026-0001",
        "status": "Example status"
      }
    ],
    "invoices": [
      {
        "id": "invoice_9f3a2b",
        "number": "2026-0001",
        "status": "Example status"
      }
    ],
    "proformas": [
      {
        "id": "proforma_9f3a2b",
        "number": "2026-0001",
        "status": "Example status"
      }
    ]
  }
}

Generated from the schema

The status field emits the raw status (12 database values).

Authorizations

Bearer API key with the scope below. orders:read

Headers

If-None-Matchstring

Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

orderIdstringRequired

Order identifier.

Limits: min length 1

Response

application/json

Successful response.

Response schema: OrderDetailDto

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

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

dataobject

The order in full, as returned by the API.

Show child attributes
data.idstring

Unique order identifier.

data.orderNumberstring

Human-readable order number.

data.externalReferencestring | null

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

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

data.startDatestring<date-time>

Start of the rental period in ISO 8601 with offset.

data.endDatestring<date-time>

End of the rental period in ISO 8601 with offset.

data.rentalDaysnumber | null

Number of billable rental days; null if not calculated.

data.projectIdstring | null

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

data.projectNamestring | null

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

data.contactobject | null

Compact reference to the order contact; null if none.

Show child attributes
data.contact.idstring

Unique contact identifier.

data.contact.namestring

Contact name.

data.itemsCountinteger

Number of items in the order.

data.subTotalPricestring

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

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

data.discountTotalstring | null

Total discounts as a decimal string "1234.50" (ROUND_HALF_UP); null if there is no discount.

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

data.insuranceTotalstring

Insurance total as a decimal string "1234.50" (ROUND_HALF_UP).

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

data.depositTotalstring

Deposit total as a decimal string "1234.50" (ROUND_HALF_UP).

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

data.taxesPricestring

Tax total as a decimal string "1234.50" (ROUND_HALF_UP).

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

data.netPricestring

Taxable base (net before taxes) as a decimal string "1234.50" (ROUND_HALF_UP).

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

data.grossPricestring

Total including taxes, as a decimal string "1234.50" (ROUND_HALF_UP).

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

data.tagsobject[]

Tags attached to the order, with their identifier and name.

Show child attributes
data.tags.idstring

Unique identifier of the tag.

data.tags.namestring

Tag name.

data.customFieldsobject<string, any>

Custom field values by custom field identifier; the definitions are in /api/v1/custom-fields.

data.sourcestring | null

Source the order was created from (for example web, mobile, admin); null if not recorded.

data.createdAtstring<date-time>

Creation date in ISO 8601 with offset.

data.updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

data.billingAddressobject | null

Billing address of the order; null if none.

Show child attributes
data.billingAddress.labelstring | null

Descriptive label of the address; null if not recorded.

data.billingAddress.addressLine1string | null

First address line; null if not recorded.

data.billingAddress.addressLine2string | null

Second address line; null if not recorded.

data.billingAddress.citystring | null

City; null if not recorded.

data.billingAddress.provincestring | null

Province or region; null if not recorded.

data.billingAddress.postcodestring | null

Postal code; null if not recorded.

data.billingAddress.countrystring | null

Country; null if not recorded.

data.shippingAddressobject | null

Shipping address of the order; null if none.

Show child attributes
data.shippingAddress.labelstring | null

Descriptive label of the address; null if not recorded.

data.shippingAddress.addressLine1string | null

First address line; null if not recorded.

data.shippingAddress.addressLine2string | null

Second address line; null if not recorded.

data.shippingAddress.citystring | null

City; null if not recorded.

data.shippingAddress.provincestring | null

Province or region; null if not recorded.

data.shippingAddress.postcodestring | null

Postal code; null if not recorded.

data.shippingAddress.countrystring | null

Country; null if not recorded.

data.contactPersonobject | null

Contact person linked to the order; null if none.

Show child attributes
data.contactPerson.idstring

Unique contact identifier.

data.contactPerson.namestring

Contact name.

data.quotesobject[]

Informational references to quotes generated from the order.

Show child attributes
data.quotes.idstring

Unique identifier of the referenced document.

data.quotes.numberstring | null

Document number; null until it is numbered.

data.quotes.statusstring | null

Document status at the time the reference was written; null if not recorded. Informational: it may be out of date.

data.invoicesobject[]

Informational references to invoices generated from the order.

Show child attributes
data.invoices.idstring

Unique identifier of the referenced document.

data.invoices.numberstring | null

Document number; null until it is numbered.

data.invoices.statusstring | null

Document status at the time the reference was written; null if not recorded. Informational: it may be out of date.

data.proformasobject[]

Informational references to proformas generated from the order.

Show child attributes
data.proformas.idstring

Unique identifier of the referenced document.

data.proformas.numberstring | null

Document number; null until it is numbered.

data.proformas.statusstring | null

Document status at the time the reference was written; null if not recorded. Informational: it may be out of date.

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

StatusCodesMeaning
404not_foundIt 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

Related

Related pages

Link to this section: Related pages

  • Rentals

    Order

    The order, as returned by the API.

Was this page helpful?

Cookies

If you accept, we use Google cookies to measure visits and show you ads. Privacy policy

More information

With your consent we use Google Ads and Google Analytics cookies to measure which campaigns bring visitors and requests, and to show you Filmo ads on other sites. Without acceptance, Google receives cookieless measurement signals, including your IP address, browser information and a cleaned page URL. Your choice is shared with the Filmo app.