List orders
Returns a paginated list of orders with optional filters by creation/updated windows, phase, status, and JSONB properties.
Property Filtering: Use propertyPath, propertyValue, and propertyExists to filter orders by integration-specific metadata stored in the properties JSONB field.
propertyPath: Dot-notation path to the property (e.g., “sage200Evo.salesOrderNo”)propertyValue: Value to match exactly (mutually exclusive withpropertyExists)propertyExists: Boolean to check existence (true) or non-existence (false) of the property path (mutually exclusive withpropertyValue)
Examples:
- Find all orders synced to Sage 200:
?propertyPath=sage200Evo.salesOrderNo&propertyExists=true - Find orders NOT synced to Sage 200:
?propertyPath=sage200Evo.salesOrderNo&propertyExists=false - Find specific Sage 200 order:
?propertyPath=sage200Evo.salesOrderNo&propertyValue=12345 - Find ACTIVE+ACCEPTED orders without Sage sync:
?phase=ACTIVE&status=ACCEPTED&propertyPath=sage200Evo.salesOrderNo&propertyExists=false
Headers
Business identifier for external auth. Find in Polinate app → Business Settings → Integrations.
"{{businessId}}"
Per-business API key for external auth. Find in Polinate app → Business Settings → Integrations.
"{{apiKey}}"
Query Parameters
x > 01
x > 020
"2024-01-01T00:00:00Z"
"2024-01-15T00:00:00Z"
"2024-02-01T00:00:00Z"
DRAFT, PENDING, DELETED, ACTIVE, ARCHIVED, REJECTED, CANCELLED "ACTIVE"
UNASSIGNED, ACCEPTED, PACKED, IN_TRANSIT, DELIVERED, RETURNED, NOT_APPLICABLE "ACCEPTED"
Dot-notation path to filter by JSONB property (e.g., "sage200Evo.salesOrderNo", "unleashed.unleashedSalesOrderGuid")
"sage200Evo.salesOrderNo"
Value to match exactly for the property path (mutually exclusive with propertyExists)
"12345"
Boolean to check existence (true) or non-existence (false) of the property path (mutually exclusive with propertyValue)
false