Appearance
data.commerce.sync-checkpoint.complete ​
Idempotently mark scoped/windowed synchronization complete
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-commerce |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
cloud_connection_uuid | uuid | Yes | — | — |
provider | string | Yes | — | — |
scope_ref | string | Yes | — | Provider partition such as merchant, store, account, or company reference. |
entity_type | string | Yes | — | — |
window_key | string | Yes | — | Stable caller-defined window identity such as 2026-08 or an ISO date range. |
cursor | json | No | — | — |
watermark_at | string | No | — | — |
items_synced_total | integer | No | — | — |
last_sync_workflow_uuid | string | No | — | — |
actor | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
sync_checkpoint_uuid | uuid | No | — | — |
exists | boolean | Yes | — | — |
created | boolean | No | — | — |
status | string | No | — | — |
cursor | json | No | — | — |
watermark_at | string | No | — | — |
items_synced_total | integer | No | — | — |
last_sync_workflow_uuid | string | No | — | — |
last_attempt_at | string | No | — | — |
last_error | string | No | — | — |
completed_at | string | No | — | — |
updated_at | string | No | — | — |
persisted_at | string | No | — | — |
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 | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
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.sync-checkpoint.complete",
"initial_data": {
"organization_uuid": "value",
"cloud_connection_uuid": "value",
"provider": "value",
"scope_ref": "value"
}
}