Get Channel Sync Explanation
GET/api/ledger/settings/channel-sync/:integrationInstance
The same explanation as List Channel Sync Explanations, for one sales channel only (channels holds a single entry). Returns 404 when the channel does not exist.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Outcomes (verdicts[].outcome): auto sent automatically · held sent once the order is paid · manual only sent with Sync Now · payout carried by the channel's payout documents · never not sent (left out, or not used in this mode) · blocked nothing can be sent (no or broken connection, or record generation paused).
Steps (verdicts[].steps[]) are the settings in the order they apply. state: pass lets it through · stop stops it, even Sync Now · manual turns automatic sending off (Sync Now still sends) · hold waits for payment · info context only. link is the app path of the screen that changes the setting (null when it is edited on Channel Accounting itself).
Kinds (verdicts[].kind): invoices, credits, paid_orders / unpaid_orders (Shopify and eBay in per-payout mode), payouts (Shopify and eBay), settlements (Amazon).
Conflicts list settings that currently do nothing because a stronger setting wins (winner).
The account-wide type_toggles cover invoices, credits and bills; batching is the account-wide default granularity (off, per_document, daily, monthly). connection is null when no accounting system is connected.
Request
Responses
- 200
- 401
- 403
- 404
- 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
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.