# GET /v1/orders

**Service:** Orders  
**Operation:** `OrderService_ListOrders`

A flat, company-scoped list of orders. Confirmed orders only: quotes are read through QuoteService, and work-in-progress documents that have not yet become a quote or an order never appear here. Orders are returned most recently updated first; because that order shifts as orders change, use QueryOrders for a stable ordering suitable for incremental sync. Paginated via `pageSize` / `pageToken`.

Orders carry three independent status dimensions, each filterable here:

* Workflow status (`statusId` or `statusName`) — the order's position on    your company's kanban board. Statuses are company-configured: discover    yours with GET /v1/company/order-statuses, then filter by id or exact    name. Filter by one, not both.  * Payment status (`paymentStatus`) — whether the order is unpaid, partially    paid, or paid. A fixed enum.  * Received status (`receivedStatus`) — whether the order has been    delivered, picked up, installed, or not yet received. A fixed enum.

Additional filters: `customerId`, reference (substring), `isSubmitted` (draft/submitted), `labelIds`, `fulfilmentMethod`, `requiredAfter`/`requiredBefore` (required-by window), and archived (live vs archived view).

## Parameters

| Parameter | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `pageSize` | query | integer | no | Maximum number of orders to return per page. 0 uses the server default; the server may cap the value. |
| `pageToken` | query | string | no | Opaque page token from a previous response, used to fetch the next page. |
| `customerId` | query | string | no | Optional: only return orders for this customer id. |
| `reference` | query | string | no | Optional: only return orders whose external reference contains this text, compared case-insensitively (a substring match, not exact-equals) — e.g. to find a previously submitted order by part of its reference. |
| `isSubmitted` | query | boolean | no | Optional: filter by whether the order has been submitted. Leave unset to return all orders; set to false to return only drafts; set to true to return only submitted orders. |
| `archived` | query | boolean | no | Optional: return the archived set instead of the live one. False (the default) lists live orders, as always; true lists ONLY archived orders — a separate view, not a superset. Each returned order carries `isArchived`: true. Changing this flag mid-pagination invalidates the page token. |
| `labelIds` | query | array | no | Optional: only return orders carrying at least one of these labels (by id — discover your labels with GET /v1/company/labels). An id not in your label set matches no orders. Combines with the other filters. Changing the label filter mid-pagination invalidates the page token. Duplicate ids are rejected. |
| `statusId` | query | string | no | Optional: only return orders whose current workflow status matches this id. Workflow statuses are company-configured kanban columns — every company has different statuses. Call GET /v1/company/order-statuses to discover your company's statuses and their ids. Use either `statusId` or `statusName` to filter, not both. |
| `statusName` | query | string | no | Optional: only return orders whose current workflow status has this exact name (case-sensitive). An alternative to `statusId` when you know the name but not the id — for example `statusName=Submitted`. Call GET /v1/company/order-statuses to see available names. |
| `paymentStatus` | query | string | no | Optional: only return orders with this payment status. Unlike workflow status, payment status is a fixed set: UNPAID, PARTIALLY_PAID, or PAID. Leave unset to include all. One of: PAYMENT_STATUS_UNSPECIFIED, PAYMENT_STATUS_UNPAID, PAYMENT_STATUS_PARTIALLY_PAID, PAYMENT_STATUS_PAID. |
| `receivedStatus` | query | string | no | Optional: only return orders with this received status. Unlike workflow status, received status is a fixed set: DELIVERED, PICKED_UP, NOT_RECEIVED, or INSTALLED. Leave unset to include all. One of: RECEIVED_STATUS_UNSPECIFIED, RECEIVED_STATUS_DELIVERED, RECEIVED_STATUS_PICKED_UP, RECEIVED_STATUS_NOT_RECEIVED, RECEIVED_STATUS_INSTALLED. |
| `fulfilmentMethod` | query | string | no | Optional: only return orders with this fulfilment method. A fixed set: DELIVER, PICK_UP, or INSTALL. Leave unset to include all. One of: FULFILMENT_METHOD_UNSPECIFIED, FULFILMENT_METHOD_PICKUP, FULFILMENT_METHOD_DELIVERY, FULFILMENT_METHOD_INSTALL. |
| `requiredAfter` | query | string | no | Only orders required at or after this time. Optional; filters on the order's required-by date, independent of the other filters. |
| `requiredBefore` | query | string | no | Only orders required strictly before this time. Optional; combine with `requiredAfter` to bound a required-by window. |
| `fields` | query | string | no | Comma-separated response fields to include, using camelCase JSON names (e.g. `orderId,total.amountMicros`). Dot paths reach into nested objects and map transparently across arrays. Paths are relative to the resource, not the response envelope; envelope keys like `nextPageToken` are always preserved. Only 2xx JSON responses are filtered; error bodies pass through unmodified. Unknown names are silently ignored. Takes precedence over `excludeFields` when both are provided. |
| `excludeFields` | query | string | no | Comma-separated response fields to exclude, using camelCase JSON names. Dot paths and array-transparency work the same as `fields`. Paths are relative to the resource, not the response envelope. Only 2xx JSON responses are filtered; error bodies pass through unmodified. Ignored when `fields` is also provided. |

## Responses

| Status | Schema | Description |
| --- | --- | --- |
| 200 | `ListOrdersResponse` | A successful response. |
| 400 | `Error` | The request was rejected because it was malformed — for example an unusable page token or an invalid filter value. The body is a validation-failure envelope: an overall type and message and one entry per problem (each with a stable code, a message, and a param pointing at the offending parameter). |
| 401 | `Error` | The request is missing a valid bearer token, or the token is invalid or expired. |
| 403 | `Error` | The token is valid but does not permit this action, or the resource belongs to a company the token cannot act for. The error type is permission_denied. |
| 429 | `Error` | The request was throttled (rate_limited) or exceeded a size limit (resource_exhausted). When throttled, the Retry-After header says how many seconds to wait before retrying; a resource_exhausted request will fail the same way if retried unchanged. |
| default | `Error` | Any other error. The body is the same error envelope every error uses: a short stable type identifying the kind of failure (for example "rate_limited" or "internal"), a human-readable message, and the request's idempotency key echoed back when one was supplied. |

## Returns

`ListOrdersResponse`

| Field | Type | Description |
| --- | --- | --- |
| `orders` | Order[] | The orders in this page. |
| `orders.orderId` | string | The order's unique id. Read-only. |
| `orders.isSubmitted` | boolean | Whether the order has been submitted (true) or is still a draft (false). |
| `orders.customerId` | string | The id of the customer this order belongs to. Always present. Read-only. |
| `orders.customerCompanyName` | string | The customer's company name. Read-only. |
| `orders.statusId` | string | The id of the order's workflow status. Defaults to a "Submitted" status when the order is submitted without one set. |
| `orders.statusName` | string | The display name of the order's workflow status. Read-only. |
| `orders.subtotal` | Money | Order subtotal — the sum of line totals before tax. Derived by the server from the line items; read-only. |
| `orders.subtotal.amountMicros` | string | Amount in micros — millionths of the currency's major unit. 1.00 = 1_000_000 micros, so $12.34 is 12_340_000 — sent and returned over JSON as the string "12340000" (64-bit integers serialize as JSON strings). A whole number of cents (or pence, etc.) is a multiple of 10_000 micros. |
| `orders.subtotal.currency` | string | ISO 4217 currency code (3 letters, e.g. "AUD"). |
| `orders.taxAmount` | Money | Total tax for the order, as an absolute money amount (the tax `amount`, not a rate). Derived by the server from your account's tax settings; read-only. See `tax` for the rate, code, and jurisdiction that produced it. |
| `orders.taxAmount.amountMicros` | string | Amount in micros — millionths of the currency's major unit. 1.00 = 1_000_000 micros, so $12.34 is 12_340_000 — sent and returned over JSON as the string "12340000" (64-bit integers serialize as JSON strings). A whole number of cents (or pence, etc.) is a multiple of 10_000 micros. |
| `orders.taxAmount.currency` | string | ISO 4217 currency code (3 letters, e.g. "AUD"). |
| `orders.total` | Money | Order grand total. Derived by the server; read-only. |
| `orders.total.amountMicros` | string | Amount in micros — millionths of the currency's major unit. 1.00 = 1_000_000 micros, so $12.34 is 12_340_000 — sent and returned over JSON as the string "12340000" (64-bit integers serialize as JSON strings). A whole number of cents (or pence, etc.) is a multiple of 10_000 micros. |
| `orders.total.currency` | string | ISO 4217 currency code (3 letters, e.g. "AUD"). |
| `orders.margin` | Money | Order margin, computed by the server from the line items. Read-only. |
| `orders.margin.amountMicros` | string | Amount in micros — millionths of the currency's major unit. 1.00 = 1_000_000 micros, so $12.34 is 12_340_000 — sent and returned over JSON as the string "12340000" (64-bit integers serialize as JSON strings). A whole number of cents (or pence, etc.) is a multiple of 10_000 micros. |
| `orders.margin.currency` | string | ISO 4217 currency code (3 letters, e.g. "AUD"). |
| `orders.totalCost` | Money | Total cost of the order, computed by the server from the line items. Read-only. |
| `orders.totalCost.amountMicros` | string | Amount in micros — millionths of the currency's major unit. 1.00 = 1_000_000 micros, so $12.34 is 12_340_000 — sent and returned over JSON as the string "12340000" (64-bit integers serialize as JSON strings). A whole number of cents (or pence, etc.) is a multiple of 10_000 micros. |
| `orders.totalCost.currency` | string | ISO 4217 currency code (3 letters, e.g. "AUD"). |
| `orders.lines` | SalesLine[] | The order's line items. |
| `orders.lines.onTheFly` | OnTheFlyLine | A free-form line not tied to a catalogue product. Set exactly one of the six line-type fields. |
| `orders.lines.catalogue` | CatalogueLine | A line for a product from your catalogue. Set exactly one of the six line-type fields. |
| `orders.lines.labour` | LabourLine | A line charging for labour. Set exactly one of the six line-type fields. |
| `orders.lines.notes` | NotesLine | A note line, with no pricing. Set exactly one of the six line-type fields. |
| `orders.lines.flashing` | FlashingLine | A flashing line, with its drawing and geometry. Set exactly one of the six line-type fields. A sheet-metal flashing line item: the flashing material, its specification, pricing, and its drawings.  A flashing line is created with its document (CreateQuote, CreateOrder) or added whole to a quote (AddQuoteLineItem); it cannot yet be added to an existing order, updated, or removed individually — those calls answer HTTP 501 (not_implemented). Its specification (`bends`, `totalGirth`, `totalLength`, `subitems`) and its prices are stored exactly as you send them: the API never derives, prices, or cross-checks a flashing, so compute them yourself from the drawing and cut list as described on each field. Lengths and girths are always millimetres (metres for `totalLength`), whatever the account's measurement system. |
| `orders.lines.flashing.templateId` | string | The id of the flashing material or template. Required when the order or quote is submitted. |
| `orders.lines.flashing.productName` | string | The display name of the flashing material. |
| `orders.lines.flashing.priceLevel` | string | The name of the price level applied to this line (for example "A"), not a price level id. Required when the order or quote is submitted; an empty value is stored as "A". |
| `orders.lines.flashing.colour` | string | The flashing colour. Required when the order or quote is submitted, and validated against the colours available for the template when `templateId` is set; without a template it is stored unchecked. |
| `orders.lines.flashing.thickness` | string | The material thickness, as a decimal string in millimetres (for example "0.55"). Required when the order or quote is submitted. Send the thickness of the selected template (`templateId`) — each thickness is a distinct template. It is stored as sent and not compared with the template, so a mismatch is saved silently. |
| `orders.lines.flashing.bends` | string | The number of bends in the flashing, as a decimal string. Count one bend for each point that joins two edges, plus the bends each finish adds (crush fold 2, open hook 2, feather 1, drip edge 1; the account's `crushFoldBendCount` setting, when set, replaces the crush-fold count). With `otherSides`, take the count from the side with the largest girth. Required when the order or quote is submitted, and must then be greater than zero. Stored as sent; not checked against the drawing. |
| `orders.lines.flashing.totalGirth` | string | The total girth of the flashing in millimetres, as a decimal string: the sum of every edge size in the drawing's `lines.values` (hidden edges excluded) plus the `size` of every finish. Edges of 110, 320 and 10 with a 10 mm crush fold give "450". With `otherSides`, use the side with the largest girth. Required when the order or quote is submitted, and must then be greater than zero. Stored as sent; not checked against the drawing. |
| `orders.lines.flashing.totalLength` | string | The total length of the flashing in metres, as a decimal string: the sum over `subitems` of amount × length ÷ 1000. Three pieces at 1200 plus two at 925 give "5.45". Stored as sent; not checked against `subitems`. |
| `orders.lines.flashing.unitPrice` | Money | The price per metre of the flashing. Required when the order or quote is submitted. |
| `orders.lines.flashing.totalPrice` | Money | The total price for this line. Stored as sent and never derived or checked. Factory prices a flashing as `unitPrice` × the priced length, where each piece shorter than the account's `minimumFlashingLengthMm` is charged at that minimum, rounded to the cent. |
| `orders.lines.flashing.customPrice` | Money | A custom total price for the line. When set, the document's subtotal uses it in place of `totalPrice`; `unitPrice` and `customPricePerLength` never enter the subtotal directly. |
| `orders.lines.flashing.customPricePerLength` | Money | A custom price per metre. Factory uses it in place of `unitPrice` when computing `totalPrice`; send the resulting `totalPrice` yourself, as the API does not recompute it. |
| `orders.lines.flashing.subitems` | object[] | The cut list: one entry per piece length, each an object with `amount` (the number of pieces) and `length` (the piece length in millimetres), both JSON numbers — for example `[{"amount": 3, "length": 1200}, {"amount": 2, "length": 925}]`. Stored as sent and not validated; a flashing with no lengths cannot be completed in Factory. Unlike `measurements` on other line kinds, lengths here are millimetre numbers, not metre strings. |
| `orders.lines.flashing.isTaxFree` | boolean | Whether this line is exempt from tax. |
| `orders.lines.flashing.drawing` | FlashingDrawing | The main drawing for the flashing: the folded profile whose edge sizes give `totalGirth` and `bends`. Required — a flashing line without a drawing is rejected with HTTP 400 (validation_failure). Its `side` defaults to the far side. A flashing drawing: its identity, metadata, geometry, and the URL of its rendered SVG image. Carried only by flashing lines (`drawing` / `otherSides` on FlashingLine) — drawings describe a flashing's folded profile and are not a general-purpose image or attachment type. Geometry is sent in the same shape the drawing tool holds it: `points` are the vertices, joined by the edges listed in each point's `vectors` and `connect`; `lines.values` gives each edge's real size in millimetres; `angles.values` gives the angle at each vertex. Point coordinates only lay out the sketch — the sizes in `lines` are the dimensions. A drawing whose `points`, `lines` or `angles` exceeds about 15,000 characters of JSON is rejected with HTTP 400 (validation_failure). |
| `orders.lines.flashing.drawing.drawingId` | string | Server-assigned unique id of the drawing. Read-only output. |
| `orders.lines.flashing.drawing.tempId` | string | A client-assigned correlation id supplied when creating the drawing. The write that creates the drawing returns it paired with the assigned `drawingId` in the response's `drawings` mapping (CreateQuote, CreateOrder, AddQuoteLineItem) — use that to address UploadDrawingSvg. It must be unique across every drawing in the request, other sides included; a repeated id is rejected with HTTP 400 (validation_failure). Omit it and the server assigns unique ids for you. It is not stored, so reads do not return it. |
| `orders.lines.flashing.drawing.drawingNumber` | integer | The drawing's display number within the order or quote. Not assigned by the server: it is stored as sent (0 when omitted), and reads and printed documents order drawings by it, so number them 0, 1, 2… in line order. |
| `orders.lines.flashing.drawing.side` | DrawingSide | Which face of the flashing this drawing represents. When not specified, a line's main `drawing` is the far side and each of its `otherSides` is the near side. Which face of the flashing a drawing represents. When not specified, a flashing line's main `drawing` is the far side and each of its `otherSides` is the near side.   - DRAWING_SIDE_UNSPECIFIED: Default, unset value.  - DRAWING_SIDE_FAR: The far side of the flashing.  - DRAWING_SIDE_NEAR: The near side of the flashing. One of: DRAWING_SIDE_UNSPECIFIED, DRAWING_SIDE_FAR, DRAWING_SIDE_NEAR. |
| `orders.lines.flashing.drawing.isFreeDrawing` | boolean | Whether the edge sizes in `lines.values` are the drawing's dimensions. Send `true`: when false, Factory measures each edge from the points' canvas coordinates instead, so girth, bends and the displayed sizes come from the sketch rather than from the sizes you supplied. |
| `orders.lines.flashing.drawing.isLargeBoxSize` | boolean | Whether the drawing uses the large box size. |
| `orders.lines.flashing.drawing.isDeleted` | boolean | Whether the drawing has been deleted. |
| `orders.lines.flashing.drawing.points` | map<Point> | The vertices of the drawing, keyed by point id. Record each edge at both ends: `p1.vectors` lists `p2` exactly when `p2.connect` lists `p1`. Required when the order or quote is submitted. A vertex in the drawing. Points are connected by edges to form the flashing profile. |
| `orders.lines.flashing.drawing.points.*.id` | string | The unique id of this point within the drawing. |
| `orders.lines.flashing.drawing.points.*.x` | number | The x coordinate of the point, in canvas space. |
| `orders.lines.flashing.drawing.points.*.y` | number | The y coordinate of the point, in canvas space. |
| `orders.lines.flashing.drawing.points.*.vectors` | string[] | The ids of points reached by edges leaving this point. Every edge must also appear in the target point's `connect`. |
| `orders.lines.flashing.drawing.points.*.connect` | string[] | The ids of points connected to this point by incoming edges. Every edge must also appear in the source point's `vectors`. |
| `orders.lines.flashing.drawing.points.*.finish` | Finish | Optional end treatment at this point. An end treatment applied to a point on a flashing edge (for example a hook or fold). Optional on a point. |
| `orders.lines.flashing.drawing.points.*.finish.type` | FinishType | The kind of end treatment. The end-treatment applied to a flashing edge. Each type has a short code used in the finish's `label`, adds its `size` to the flashing's total girth, and counts a fixed number of bends.   - FINISH_TYPE_UNSPECIFIED: Unspecified end treatment.  - FINISH_TYPE_CRUSH_FOLD: A crush fold. Code "cf"; counts 2 bends (or the account's `crushFoldBendCount` when set).  - FINISH_TYPE_OPEN_HOOK: An open hook. Code "oh"; counts 2 bends.  - FINISH_TYPE_FEATHER: A feathered edge. Code "fe"; counts 1 bend.  - FINISH_TYPE_DRIP_EDGE: A drip edge. Code "de"; counts 1 bend. One of: FINISH_TYPE_UNSPECIFIED, FINISH_TYPE_CRUSH_FOLD, FINISH_TYPE_OPEN_HOOK, FINISH_TYPE_FEATHER, FINISH_TYPE_DRIP_EDGE. |
| `orders.lines.flashing.drawing.points.*.finish.size` | number | The size of the end treatment in millimetres. It counts toward the flashing's `totalGirth`. |
| `orders.lines.flashing.drawing.points.*.finish.label` | string | The display label for this finish: the type's code followed by the size, e.g. "cf10" for a 10 mm crush fold or "oh25" for a 25 mm open hook. |
| `orders.lines.flashing.drawing.points.*.finish.flip` | boolean | Which side of the edge the finish folds to. Looking from the finished end along its edge (screen coordinates, y pointing down), `false` puts the fold on the right-hand side and `true` on the left. A feathered edge is drawn mirrored relative to the other types. |
| `orders.lines.flashing.drawing.points.*.finish.position` | LabelPosition | Optional bounding box for this finish's label. A label's bounding box in canvas (SVG) coordinate space. Used for line labels, angle labels, and finish labels. |
| `orders.lines.flashing.drawing.points.*.finish.position.x` | number | The x coordinate of the label box, in canvas space. |
| `orders.lines.flashing.drawing.points.*.finish.position.y` | number | The y coordinate of the label box, in canvas space. |
| `orders.lines.flashing.drawing.points.*.finish.position.width` | number | The width of the label box, in canvas space. |
| `orders.lines.flashing.drawing.points.*.finish.position.height` | number | The height of the label box, in canvas space. |
| `orders.lines.flashing.drawing.lines` | LineSet | The edge sizes between points in millimetres, with their optional label positions. Give every edge a size — Factory counts the girth of a drawing with a missing size as 0. When omitted, the drawing is stored with an empty set and reads return `lines` with empty `values` and `positions`. The collection of edge lengths and their label positions for a drawing. |
| `orders.lines.flashing.drawing.lines.values` | map<LineCell> | The size entry for each edge, keyed by the ids of the two points it connects joined with a hyphen, source first: the edge from `p1` to `p2` is `"p1-p2"`. The length entry for a single edge between two points. |
| `orders.lines.flashing.drawing.lines.values.*.size` | number | The size of the edge in millimetres. Omitted when a size has not yet been entered — but give every edge a size, or Factory counts the girth as 0. |
| `orders.lines.flashing.drawing.lines.values.*.hidden` | boolean | Whether this edge's length label is hidden. |
| `orders.lines.flashing.drawing.lines.positions` | map<LabelPosition> | The label box for each edge's size label, keyed like `values`. Optional: Factory places any label without a box itself. A label's bounding box in canvas (SVG) coordinate space. Used for line labels, angle labels, and finish labels. |
| `orders.lines.flashing.drawing.lines.positions.*.x` | number | The x coordinate of the label box, in canvas space. |
| `orders.lines.flashing.drawing.lines.positions.*.y` | number | The y coordinate of the label box, in canvas space. |
| `orders.lines.flashing.drawing.lines.positions.*.width` | number | The width of the label box, in canvas space. |
| `orders.lines.flashing.drawing.lines.positions.*.height` | number | The height of the label box, in canvas space. |
| `orders.lines.flashing.drawing.angles` | AngleSet | The vertex angles in degrees, with their optional label positions. When omitted, the drawing is stored with an empty set and reads return `angles` with empty `values` and `positions`. The collection of vertex angles and their label positions for a drawing. |
| `orders.lines.flashing.drawing.angles.values` | map<AngleCell> | The angle entry for each vertex, keyed by point id. The angle entry for a single point (vertex) in the drawing. |
| `orders.lines.flashing.drawing.angles.values.*.angle` | number | The angle at this vertex, in degrees. Omitted when no angle is set. |
| `orders.lines.flashing.drawing.angles.values.*.hidden` | boolean | Whether this vertex's angle label is hidden. Omitted when not set. |
| `orders.lines.flashing.drawing.angles.positions` | map<LabelPosition> | The label box for each vertex's angle label, keyed by point id. Optional: Factory places any label without a box itself. A label's bounding box in canvas (SVG) coordinate space. Used for line labels, angle labels, and finish labels. |
| `orders.lines.flashing.drawing.angles.positions.*.x` | number | The x coordinate of the label box, in canvas space. |
| `orders.lines.flashing.drawing.angles.positions.*.y` | number | The y coordinate of the label box, in canvas space. |
| `orders.lines.flashing.drawing.angles.positions.*.width` | number | The width of the label box, in canvas space. |
| `orders.lines.flashing.drawing.angles.positions.*.height` | number | The height of the label box, in canvas space. |
| `orders.lines.flashing.drawing.annotations` | map<TextBox> | Free-text annotations on the drawing, keyed by annotation id. A free-text annotation placed on the drawing. |
| `orders.lines.flashing.drawing.annotations.*.x` | number | The x coordinate of the annotation, in canvas space. Omitted until placed. |
| `orders.lines.flashing.drawing.annotations.*.y` | number | The y coordinate of the annotation, in canvas space. Omitted until placed. |
| `orders.lines.flashing.drawing.annotations.*.width` | number | The width of the annotation box, in canvas space. |
| `orders.lines.flashing.drawing.annotations.*.height` | number | The height of the annotation box, in canvas space. |
| `orders.lines.flashing.drawing.annotations.*.value` | string | The annotation text as a flat string. May be present alongside the structured `text` form. |
| `orders.lines.flashing.drawing.annotations.*.text` | TextRow[] | The annotation text in structured rows. May be present alongside `value`. One row of text within a text annotation. |
| `orders.lines.flashing.drawing.annotations.*.text.id` | integer | The 0-based index of this row within the text annotation. |
| `orders.lines.flashing.drawing.annotations.*.text.indent` | integer | The indentation level of this row. |
| `orders.lines.flashing.drawing.annotations.*.text.value` | string[] | The text segments that make up this row, in order. |
| `orders.lines.flashing.drawing.annotations.*.rotateDeg` | number | Optional rotation of the annotation, in degrees. |
| `orders.lines.flashing.drawing.frontArrow` | Arrow | The arrow marking the front face of the flashing. Optional. The arrow that indicates the front-facing direction of the flashing. |
| `orders.lines.flashing.drawing.frontArrow.x` | number | The x coordinate of the arrow, in canvas space. Omitted until placed. |
| `orders.lines.flashing.drawing.frontArrow.y` | number | The y coordinate of the arrow, in canvas space. Omitted until placed. |
| `orders.lines.flashing.drawing.frontArrow.angle` | number | The direction the arrow points, in degrees, turning clockwise on screen from 0 = left: 90 points up, 180 right, 270 down. |
| `orders.lines.flashing.drawing.squareAngle` | SquareAngle | The right-angle (90°) marker placed on the drawing. |
| `orders.lines.flashing.drawing.squareAngle.x` | number | The x coordinate of the marker, in canvas space. Omitted until placed. |
| `orders.lines.flashing.drawing.squareAngle.y` | number | The y coordinate of the marker, in canvas space. Omitted until placed. |
| `orders.lines.flashing.drawing.svgUrl` | string | A presigned URL to the rendered SVG image of the drawing. Read-only output; populated after the SVG is uploaded via UploadDrawingSvg on OrderService or QuoteService. |
| `orders.lines.flashing.otherSides` | FlashingDrawing[] | Additional side drawings of the same flashing, used when the profile tapers: Factory compares each side's edge sizes with the main drawing's, edge by edge, and counts every differing edge as a taper. Their `side` defaults to the near side. When present, `totalGirth` and `bends` come from whichever side has the largest girth. A flashing drawing: its identity, metadata, geometry, and the URL of its rendered SVG image. Carried only by flashing lines (`drawing` / `otherSides` on FlashingLine) — drawings describe a flashing's folded profile and are not a general-purpose image or attachment type. Geometry is sent in the same shape the drawing tool holds it: `points` are the vertices, joined by the edges listed in each point's `vectors` and `connect`; `lines.values` gives each edge's real size in millimetres; `angles.values` gives the angle at each vertex. Point coordinates only lay out the sketch — the sizes in `lines` are the dimensions. A drawing whose `points`, `lines` or `angles` exceeds about 15,000 characters of JSON is rejected with HTTP 400 (validation_failure). |
| `orders.lines.flashing.otherSides.drawingId` | string | Server-assigned unique id of the drawing. Read-only output. |
| `orders.lines.flashing.otherSides.tempId` | string | A client-assigned correlation id supplied when creating the drawing. The write that creates the drawing returns it paired with the assigned `drawingId` in the response's `drawings` mapping (CreateQuote, CreateOrder, AddQuoteLineItem) — use that to address UploadDrawingSvg. It must be unique across every drawing in the request, other sides included; a repeated id is rejected with HTTP 400 (validation_failure). Omit it and the server assigns unique ids for you. It is not stored, so reads do not return it. |
| `orders.lines.flashing.otherSides.drawingNumber` | integer | The drawing's display number within the order or quote. Not assigned by the server: it is stored as sent (0 when omitted), and reads and printed documents order drawings by it, so number them 0, 1, 2… in line order. |
| `orders.lines.flashing.otherSides.side` | DrawingSide | Which face of the flashing this drawing represents. When not specified, a line's main `drawing` is the far side and each of its `otherSides` is the near side. Which face of the flashing a drawing represents. When not specified, a flashing line's main `drawing` is the far side and each of its `otherSides` is the near side.   - DRAWING_SIDE_UNSPECIFIED: Default, unset value.  - DRAWING_SIDE_FAR: The far side of the flashing.  - DRAWING_SIDE_NEAR: The near side of the flashing. One of: DRAWING_SIDE_UNSPECIFIED, DRAWING_SIDE_FAR, DRAWING_SIDE_NEAR. |
| `orders.lines.flashing.otherSides.isFreeDrawing` | boolean | Whether the edge sizes in `lines.values` are the drawing's dimensions. Send `true`: when false, Factory measures each edge from the points' canvas coordinates instead, so girth, bends and the displayed sizes come from the sketch rather than from the sizes you supplied. |
| `orders.lines.flashing.otherSides.isLargeBoxSize` | boolean | Whether the drawing uses the large box size. |
| `orders.lines.flashing.otherSides.isDeleted` | boolean | Whether the drawing has been deleted. |
| `orders.lines.flashing.otherSides.points` | map<Point> | The vertices of the drawing, keyed by point id. Record each edge at both ends: `p1.vectors` lists `p2` exactly when `p2.connect` lists `p1`. Required when the order or quote is submitted. A vertex in the drawing. Points are connected by edges to form the flashing profile. |
| `orders.lines.flashing.otherSides.points.*.id` | string | The unique id of this point within the drawing. |
| `orders.lines.flashing.otherSides.points.*.x` | number | The x coordinate of the point, in canvas space. |
| `orders.lines.flashing.otherSides.points.*.y` | number | The y coordinate of the point, in canvas space. |
| `orders.lines.flashing.otherSides.points.*.vectors` | string[] | The ids of points reached by edges leaving this point. Every edge must also appear in the target point's `connect`. |
| `orders.lines.flashing.otherSides.points.*.connect` | string[] | The ids of points connected to this point by incoming edges. Every edge must also appear in the source point's `vectors`. |
| `orders.lines.flashing.otherSides.points.*.finish` | Finish | Optional end treatment at this point. An end treatment applied to a point on a flashing edge (for example a hook or fold). Optional on a point. |
| `orders.lines.flashing.otherSides.points.*.finish.type` | FinishType | The kind of end treatment. The end-treatment applied to a flashing edge. Each type has a short code used in the finish's `label`, adds its `size` to the flashing's total girth, and counts a fixed number of bends.   - FINISH_TYPE_UNSPECIFIED: Unspecified end treatment.  - FINISH_TYPE_CRUSH_FOLD: A crush fold. Code "cf"; counts 2 bends (or the account's `crushFoldBendCount` when set).  - FINISH_TYPE_OPEN_HOOK: An open hook. Code "oh"; counts 2 bends.  - FINISH_TYPE_FEATHER: A feathered edge. Code "fe"; counts 1 bend.  - FINISH_TYPE_DRIP_EDGE: A drip edge. Code "de"; counts 1 bend. One of: FINISH_TYPE_UNSPECIFIED, FINISH_TYPE_CRUSH_FOLD, FINISH_TYPE_OPEN_HOOK, FINISH_TYPE_FEATHER, FINISH_TYPE_DRIP_EDGE. |
| `orders.lines.flashing.otherSides.points.*.finish.size` | number | The size of the end treatment in millimetres. It counts toward the flashing's `totalGirth`. |
| `orders.lines.flashing.otherSides.points.*.finish.label` | string | The display label for this finish: the type's code followed by the size, e.g. "cf10" for a 10 mm crush fold or "oh25" for a 25 mm open hook. |
| `orders.lines.flashing.otherSides.points.*.finish.flip` | boolean | Which side of the edge the finish folds to. Looking from the finished end along its edge (screen coordinates, y pointing down), `false` puts the fold on the right-hand side and `true` on the left. A feathered edge is drawn mirrored relative to the other types. |
| `orders.lines.flashing.otherSides.points.*.finish.position` | LabelPosition | Optional bounding box for this finish's label. A label's bounding box in canvas (SVG) coordinate space. Used for line labels, angle labels, and finish labels. |
| `orders.lines.flashing.otherSides.points.*.finish.position.x` | number | The x coordinate of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.points.*.finish.position.y` | number | The y coordinate of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.points.*.finish.position.width` | number | The width of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.points.*.finish.position.height` | number | The height of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.lines` | LineSet | The edge sizes between points in millimetres, with their optional label positions. Give every edge a size — Factory counts the girth of a drawing with a missing size as 0. When omitted, the drawing is stored with an empty set and reads return `lines` with empty `values` and `positions`. The collection of edge lengths and their label positions for a drawing. |
| `orders.lines.flashing.otherSides.lines.values` | map<LineCell> | The size entry for each edge, keyed by the ids of the two points it connects joined with a hyphen, source first: the edge from `p1` to `p2` is `"p1-p2"`. The length entry for a single edge between two points. |
| `orders.lines.flashing.otherSides.lines.values.*.size` | number | The size of the edge in millimetres. Omitted when a size has not yet been entered — but give every edge a size, or Factory counts the girth as 0. |
| `orders.lines.flashing.otherSides.lines.values.*.hidden` | boolean | Whether this edge's length label is hidden. |
| `orders.lines.flashing.otherSides.lines.positions` | map<LabelPosition> | The label box for each edge's size label, keyed like `values`. Optional: Factory places any label without a box itself. A label's bounding box in canvas (SVG) coordinate space. Used for line labels, angle labels, and finish labels. |
| `orders.lines.flashing.otherSides.lines.positions.*.x` | number | The x coordinate of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.lines.positions.*.y` | number | The y coordinate of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.lines.positions.*.width` | number | The width of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.lines.positions.*.height` | number | The height of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.angles` | AngleSet | The vertex angles in degrees, with their optional label positions. When omitted, the drawing is stored with an empty set and reads return `angles` with empty `values` and `positions`. The collection of vertex angles and their label positions for a drawing. |
| `orders.lines.flashing.otherSides.angles.values` | map<AngleCell> | The angle entry for each vertex, keyed by point id. The angle entry for a single point (vertex) in the drawing. |
| `orders.lines.flashing.otherSides.angles.values.*.angle` | number | The angle at this vertex, in degrees. Omitted when no angle is set. |
| `orders.lines.flashing.otherSides.angles.values.*.hidden` | boolean | Whether this vertex's angle label is hidden. Omitted when not set. |
| `orders.lines.flashing.otherSides.angles.positions` | map<LabelPosition> | The label box for each vertex's angle label, keyed by point id. Optional: Factory places any label without a box itself. A label's bounding box in canvas (SVG) coordinate space. Used for line labels, angle labels, and finish labels. |
| `orders.lines.flashing.otherSides.angles.positions.*.x` | number | The x coordinate of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.angles.positions.*.y` | number | The y coordinate of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.angles.positions.*.width` | number | The width of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.angles.positions.*.height` | number | The height of the label box, in canvas space. |
| `orders.lines.flashing.otherSides.annotations` | map<TextBox> | Free-text annotations on the drawing, keyed by annotation id. A free-text annotation placed on the drawing. |
| `orders.lines.flashing.otherSides.annotations.*.x` | number | The x coordinate of the annotation, in canvas space. Omitted until placed. |
| `orders.lines.flashing.otherSides.annotations.*.y` | number | The y coordinate of the annotation, in canvas space. Omitted until placed. |
| `orders.lines.flashing.otherSides.annotations.*.width` | number | The width of the annotation box, in canvas space. |
| `orders.lines.flashing.otherSides.annotations.*.height` | number | The height of the annotation box, in canvas space. |
| `orders.lines.flashing.otherSides.annotations.*.value` | string | The annotation text as a flat string. May be present alongside the structured `text` form. |
| `orders.lines.flashing.otherSides.annotations.*.text` | TextRow[] | The annotation text in structured rows. May be present alongside `value`. One row of text within a text annotation. |
| `orders.lines.flashing.otherSides.annotations.*.text.id` | integer | The 0-based index of this row within the text annotation. |
| `orders.lines.flashing.otherSides.annotations.*.text.indent` | integer | The indentation level of this row. |
| `orders.lines.flashing.otherSides.annotations.*.text.value` | string[] | The text segments that make up this row, in order. |
| `orders.lines.flashing.otherSides.annotations.*.rotateDeg` | number | Optional rotation of the annotation, in degrees. |
| `orders.lines.flashing.otherSides.frontArrow` | Arrow | The arrow marking the front face of the flashing. Optional. The arrow that indicates the front-facing direction of the flashing. |
| `orders.lines.flashing.otherSides.frontArrow.x` | number | The x coordinate of the arrow, in canvas space. Omitted until placed. |
| `orders.lines.flashing.otherSides.frontArrow.y` | number | The y coordinate of the arrow, in canvas space. Omitted until placed. |
| `orders.lines.flashing.otherSides.frontArrow.angle` | number | The direction the arrow points, in degrees, turning clockwise on screen from 0 = left: 90 points up, 180 right, 270 down. |
| `orders.lines.flashing.otherSides.squareAngle` | SquareAngle | The right-angle (90°) marker placed on the drawing. |
| `orders.lines.flashing.otherSides.squareAngle.x` | number | The x coordinate of the marker, in canvas space. Omitted until placed. |
| `orders.lines.flashing.otherSides.squareAngle.y` | number | The y coordinate of the marker, in canvas space. Omitted until placed. |
| `orders.lines.flashing.otherSides.svgUrl` | string | A presigned URL to the rendered SVG image of the drawing. Read-only output; populated after the SVG is uploaded via UploadDrawingSvg on OrderService or QuoteService. |
| `orders.lines.flashing.tax` | TaxDetail | The tax applied to this line: rate, code, and jurisdiction. Complements the `isTaxFree` flag. In v1 the server applies your account's tax settings to taxable lines; this object reserves the shape for richer per-line tax later. |
| `orders.lines.productKit` | ProductKitLine | A line for a predefined product kit. Set exactly one of the six line-type fields. |
| `orders.lines.id` | string | The server-assigned id of this line — unique and stable for the life of the line. Returned when a quote is read; pass it to update or remove the line. Not set when creating a line (the server assigns it). This id has a different form from the quote id. |
| `orders.adjustments` | Adjustment[] | Order-level fees, discounts, and markups. At most one fee per order is allowed. |
| `orders.adjustments.type` | AdjustmentType | The kind of adjustment: a fee, discount, or markup. Required. The kind of order- or quote-level adjustment: a fee, a discount, or a markup. Only fees and discounts change the document's totals.   - ADJUSTMENT_TYPE_UNSPECIFIED: Default, unset value. Not a valid choice when setting an adjustment.  - ADJUSTMENT_TYPE_FEE: A fee added to the order or quote after any discounts, and taxed at the account's rate. It must be a fixed `amount`, not a `percent`, and at most one fee is allowed per order or quote.  - ADJUSTMENT_TYPE_DISCOUNT: A discount subtracted from the lines' subtotal before tax and before any fee. A `percent` discount is taken of the lines' subtotal as it stands when the discount is applied; with several discounts, each applies to the subtotal left by the earlier ones, in the order they were added.  - ADJUSTMENT_TYPE_MARKUP: A markup recorded against the order or quote. It is stored and returned on reads but changes no total: to mark up a document, raise its line prices. Any number of markups may be recorded. One of: ADJUSTMENT_TYPE_UNSPECIFIED, ADJUSTMENT_TYPE_FEE, ADJUSTMENT_TYPE_DISCOUNT, ADJUSTMENT_TYPE_MARKUP. |
| `orders.adjustments.title` | string | A label describing the adjustment. |
| `orders.adjustments.amount` | Money | The adjustment as a fixed money amount. Exactly one of `amount` or `percent` must be set. A fee must use this form. |
| `orders.adjustments.percent` | string | The adjustment as a percentage (for example, "10.00"). Exactly one of `amount` or `percent` must be set. For a discount, the percentage is taken of the lines' subtotal (see AdjustmentType); a fee given as a percent is rejected with HTTP 400 (validation_failure). |
| `orders.fulfilmentMethod` | FulfilmentMethod | How the customer receives the order: pickup, delivery, or installation. How the customer receives the goods on an order or quote. Determines which address is used: delivery uses the delivery address, installation uses the install address.   - FULFILMENT_METHOD_UNSPECIFIED: Default, unset value.  - FULFILMENT_METHOD_PICKUP: The customer collects the goods themselves.  - FULFILMENT_METHOD_DELIVERY: The goods are delivered to the delivery address.  - FULFILMENT_METHOD_INSTALL: The goods are installed at the install address. One of: FULFILMENT_METHOD_UNSPECIFIED, FULFILMENT_METHOD_PICKUP, FULFILMENT_METHOD_DELIVERY, FULFILMENT_METHOD_INSTALL. |
| `orders.billingAddress` | Address | Billing address for the order. |
| `orders.billingAddress.address1` | string | First address line (street number and name). |
| `orders.billingAddress.address2` | string | Second address line (unit, suite, or similar). |
| `orders.billingAddress.city` | string | City or suburb. |
| `orders.billingAddress.state` | string | State, province, or region. |
| `orders.billingAddress.postalCode` | string | Postal code (ZIP code, postcode). |
| `orders.billingAddress.countryCode` | string | Country, as an uppercase ISO 3166-1 alpha-2 code (e.g. "AU"). Optional; when supplied, any other form is rejected. |
| `orders.deliveryAddress` | Address | Delivery address. Applies when `fulfilmentMethod` is DELIVERY. |
| `orders.deliveryAddress.address1` | string | First address line (street number and name). |
| `orders.deliveryAddress.address2` | string | Second address line (unit, suite, or similar). |
| `orders.deliveryAddress.city` | string | City or suburb. |
| `orders.deliveryAddress.state` | string | State, province, or region. |
| `orders.deliveryAddress.postalCode` | string | Postal code (ZIP code, postcode). |
| `orders.deliveryAddress.countryCode` | string | Country, as an uppercase ISO 3166-1 alpha-2 code (e.g. "AU"). Optional; when supplied, any other form is rejected. |
| `orders.installAddress` | Address | Installation address. Applies when `fulfilmentMethod` is INSTALL. |
| `orders.installAddress.address1` | string | First address line (street number and name). |
| `orders.installAddress.address2` | string | Second address line (unit, suite, or similar). |
| `orders.installAddress.city` | string | City or suburb. |
| `orders.installAddress.state` | string | State, province, or region. |
| `orders.installAddress.postalCode` | string | Postal code (ZIP code, postcode). |
| `orders.installAddress.countryCode` | string | Country, as an uppercase ISO 3166-1 alpha-2 code (e.g. "AU"). Optional; when supplied, any other form is rejected. |
| `orders.reference` | string | Free-text external reference, e.g. the order id or purchase order (PO) number from your own system. Shown as "PO #" in the Factory app and as "PO" on the order documents. |
| `orders.orderNumber` | string | Factory's number for this order. Assigned by the server when the document was created (a quote keeps its number when it becomes an order), sequential within your company, and never changed. Shown as "Order #" in the Factory app (order list, order page, workflow board) and on the order confirmation, invoice, work order, and delivery docket, and used as the document reference in the accounting integrations. Read-only. |
| `orders.receivedStatus` | ReceivedStatus | Whether the order has been received. Read-only. Whether and how the order has reached the customer. Read-only.   - RECEIVED_STATUS_UNSPECIFIED: Default, unset value.  - RECEIVED_STATUS_DELIVERED: The order was delivered.  - RECEIVED_STATUS_PICKED_UP: The order was picked up by the customer.  - RECEIVED_STATUS_NOT_RECEIVED: The order has not yet reached the customer.  - RECEIVED_STATUS_INSTALLED: The order was installed. One of: RECEIVED_STATUS_UNSPECIFIED, RECEIVED_STATUS_DELIVERED, RECEIVED_STATUS_PICKED_UP, RECEIVED_STATUS_NOT_RECEIVED, RECEIVED_STATUS_INSTALLED. |
| `orders.paymentStatus` | PaymentStatus | The order's payment status. Read-only. Whether the order has been paid for. Read-only.   - PAYMENT_STATUS_UNSPECIFIED: Default, unset value.  - PAYMENT_STATUS_UNPAID: No payment has been received.  - PAYMENT_STATUS_PARTIALLY_PAID: Part of the order total has been paid.  - PAYMENT_STATUS_PAID: The order has been paid in full. One of: PAYMENT_STATUS_UNSPECIFIED, PAYMENT_STATUS_UNPAID, PAYMENT_STATUS_PARTIALLY_PAID, PAYMENT_STATUS_PAID. |
| `orders.customFields` | object | The document's custom-field values, keyed by each field's configured key. |
| `orders.createdAt` | string | When the order was created. Read-only. |
| `orders.submittedAt` | string | When the order was submitted. Read-only. |
| `orders.lastUpdatedAt` | string | When the order was last updated. Read-only. |
| `orders.requiredAt` | string | The date the order is required or needed by. |
| `orders.contact` | Contact | The order's point-of-contact person. |
| `orders.contact.name` | string | The contact person's name. |
| `orders.contact.email` | string | The contact's email address. Optional; when provided, it must be a valid email address. |
| `orders.contact.phone` | string | The contact's landline phone number. |
| `orders.contact.mobile` | string | The contact's mobile number, normalized to E.164 format (e.g. +61400000000). |
| `orders.notes` | string | Free-text notes about the order. |
| `orders.pickupNotes` | string | Free-text notes shown when the order is picked up. |
| `orders.deliveryFee` | Money | The delivery fee charged on the order. Read-only. |
| `orders.deliveryFee.amountMicros` | string | Amount in micros — millionths of the currency's major unit. 1.00 = 1_000_000 micros, so $12.34 is 12_340_000 — sent and returned over JSON as the string "12340000" (64-bit integers serialize as JSON strings). A whole number of cents (or pence, etc.) is a multiple of 10_000 micros. |
| `orders.deliveryFee.currency` | string | ISO 4217 currency code (3 letters, e.g. "AUD"). |
| `orders.createdByUserId` | string | The id of the user who created the order, empty when unset. Resolve the user via the Users API (which can return users who have since left). Read-only. |
| `orders.submittedByUserId` | string | The id of the user who submitted the order, empty when unset. Resolve the user via the Users API (which can return users who have since left). Read-only. |
| `orders.discountAmount` | Money | The order-level discount total, rolled up from the per-line discounts and the discount entries in `adjustments`. Read-only. |
| `orders.discountAmount.amountMicros` | string | Amount in micros — millionths of the currency's major unit. 1.00 = 1_000_000 micros, so $12.34 is 12_340_000 — sent and returned over JSON as the string "12340000" (64-bit integers serialize as JSON strings). A whole number of cents (or pence, etc.) is a multiple of 10_000 micros. |
| `orders.discountAmount.currency` | string | ISO 4217 currency code (3 letters, e.g. "AUD"). |
| `orders.invoiceNumber` | string | The order's invoice number as displayed: the order's own number, or the linked accounting system's number when synced. Empty until the order is invoiced. Read-only. |
| `orders.invoicedAt` | string | When the order was invoiced. Unset until the order is invoiced. Read-only. |
| `orders.statusColour` | string | The colour of the order's workflow status, for display (defaults to "transparent"). The display companion to `statusName`. Read-only. |
| `orders.tax` | TaxDetail | The tax applied to the order: rate, code, and jurisdiction. Reflects your account's tax settings — the values actually applied — and is the companion descriptor to the `taxAmount` amount. Read-only. |
| `orders.tax.rate` | string | The tax rate applied, as a decimal fraction (e.g. "0.10" means 10%). |
| `orders.tax.code` | string | The tax code, e.g. "GST", "VAT", or "SALES_TAX". Open-ended — not a fixed set. |
| `orders.tax.jurisdiction` | string | The tax jurisdiction, e.g. "AU", "GB", or "US-CA-LOS_ANGELES". Open-ended. |
| `orders.labels` | Label[] | The labels attached to this order, oldest attachment first. Present on create responses when `labelIds` are supplied; absent from line-write responses. |
| `orders.labels.labelId` | string | The label's id. |
| `orders.labels.name` | string | Display name of the label. Unique within your company. |
| `orders.labels.colour` | string | Display colour of the label, as a hex string (for example "#FF69B4"). |
| `orders.isArchived` | boolean | Whether the order is archived. Archived orders are hidden from every read by default: reach them with GetOrder's `includeArchived`, ListOrders' archived, or QueryOrders' `includeArchived`. Always false on default reads. Read-only. |
| `orders.labourTotal` | Money | The total charged for labour on the order: the sum of the labour line totals, including labour components inside product kits. Derived by the server from the line items on every write; read-only. |
| `orders.labourTotal.amountMicros` | string | Amount in micros — millionths of the currency's major unit. 1.00 = 1_000_000 micros, so $12.34 is 12_340_000 — sent and returned over JSON as the string "12340000" (64-bit integers serialize as JSON strings). A whole number of cents (or pence, etc.) is a multiple of 10_000 micros. |
| `orders.labourTotal.currency` | string | ISO 4217 currency code (3 letters, e.g. "AUD"). |
| `nextPageToken` | string | Token to pass as `pageToken` to fetch the next page; empty when there are no more results. |

---

Source: https://developer.factory.app/reference/orders/list-orders · Factory Sales API v1