Orders
List orders
Return a paginated list of orders for the authenticated organisation. Supports optional filtering by clientReference, status, and date range.
query Parameters
pageIndexZero-based page number (default: 0)
pageSizeNumber of orders per page, max 100 (default: 10)
clientReferenceFilter by exact client-defined reference
statusFilter by order status
dateFrom^(?:(?:\d\d[2468][04…Filter orders with orderDate >= dateFrom (ISO 8601)
dateTo^(?:(?:\d\d[2468][04…Filter orders with orderDate <= dateTo (ISO 8601)
includeResourcesWhether to include resource details in the response
List orders › Responses
Default Response
pageIndexpageSizesuccesstotalOrder a property document
Create an order for a property document. If the order completes within the specified timeout, the response will include the order data. Otherwise, the response will indicate that the order is being processed asynchronously. You can then wait for a webhook notification (if configured) or poll the order status using GET /api/v0/orders/:orderId.
Headers
Content-Typeidempotency-keyOptional key used to safely retry order creation without creating duplicates. Reuse the same value for retries of the same request. UUIDs are recommended but not required.
x-order-timeout-msOptional maximum milliseconds to wait for order data synchronously. If data is ready before the timeout concludes, measured from request processing start, a 200 response with data is returned instead. Otherwise a 202 response is returned, and the client can poll for completion or wait for a webhook notification if configured.
Order a property document › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: product, titleId |
producttitleIdObtained from GET /api/v0/titles.
clientReferenceOptional client-defined identifier for this order. Must be unique per organisation. Use it when you want a client-owned reference that helps reduce accidental duplicate orders and lets you later find the order via GET /api/v0/orders without persisting Fynd's generated orderId.
Order a property document › Responses
Order completed synchronously within the timeout requested by the x-order-timeout-ms header. Contains the extracted title data.
success