Appearance
data.commerce.entity.query
Read rows from commerce_entity in the finance DB. Supports filtering by connection/provider/entity_type/external_ref/status, JSONB raw->>key filters, and incremental-sync since-cursor. UUID-only surface.
Read-only query over commerce_entity with paging + soft filters.
Overview
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-commerce |
| Version | 1.0 |
Input Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | No | — | — |
organization_uuid | uuid | Yes | — | — |
provider | string | No | — | — |
entity_type | string | No | — | — |
external_ref | string | No | — | — |
commerce_entity_uuid | uuid | No | — | — |
status | string | No | — | — |
provider_updated_since | string | No | — | ISO-8601 — provider_updated_at > this |
include_deleted | boolean | No | — | — |
raw_filters | json | No | — | dict of raw->>key = value JSONB equality filters |
limit | integer | No | — | — |
offset | integer | No | — | — |
actor | string | No | — | — |
Output Schema
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cloud_connection_uuid | uuid | No | — | — |
organization_uuid | uuid | Yes | — | — |
provider | string | No | — | — |
entity_type | string | No | — | — |
external_ref | string | No | — | — |
commerce_entity_uuid | uuid | No | — | — |
status | string | No | — | — |
provider_updated_since | string | No | — | ISO-8601 — provider_updated_at > this |
include_deleted | boolean | No | — | — |
raw_filters | json | No | — | dict of raw->>key = value JSONB equality filters |
limit | integer | No | — | — |
offset | integer | No | — | — |
actor | string | No | — | — |
items | json | Yes | — | List of commerce_entity rows (UUID-keyed) |
item_count | integer | Yes | — | — |
total_count | integer | No | — | Total matching rows ignoring limit/offset |
has_more | boolean | Yes | — | — |
queried_at | string | Yes | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | json | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
States
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | complete | Query commerce_entity rows |
completed | No | Yes | Yes | — | Query succeeded |
failed | No | Yes | No | — | Query failed |
State Diagram
Transitions
| From | Action | To | Description |
|---|---|---|---|
pending | complete | completed | — |
pending | fail | failed | — |
API Usage
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "data.commerce.entity.query",
"initial_data": {
"organization_uuid": "value"
}
}