Check Order Sync
GET/api/ledger/settings/channel-sync/order-check
Where each of one sales order's revenue documents (its invoices and credits) stands with the accounting system, and why — the same verdict the sync uses.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Verdicts (documents[].verdict): in_provider already sent · will_send goes on the next sync · failed the accounting system refused it · payout booked by its channel payout · left_out no payout carries it and the store leaves such orders out · batched sent inside a daily or monthly summary · held waiting until the order is paid · manual only sent with Sync Now · blocked nothing can send it · not_generated no accounting record yet.
reasons carry the eligibility reason codes with labels (e.g. type_disabled, channel_disabled, payment_sync_blocked, payout_mode_suppressed, granularity_off, connection_inactive). payout_settlement is how the order's revenue is booked on a per-payout channel (payout, outside_payout, left_out, pending, pending_left_out), null otherwise.
Returns 422 when order is missing and 404 when no order matches.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.