Skip to main content

Sync Storefront Payouts

POST 

/api/storefront/:integrationInstance/payouts/sync

Starts a background sync of one store's payouts. For every processor the store books by payouts, new and changed payouts are read from the last sync point, with their lines, and matched to sales orders; payouts still pending or in transit are re-read until they settle. Returns a tracked job ID; follow its progress with the tracked job endpoints.

Required scope: accounting:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Payouts also sync automatically every hour for stores booked per payout. A processor whose permission is missing is skipped and reported as payout_sync_error on Get Storefront Accounting Settings, so its payouts are picked up once the permission is granted.

Authentication: Requires Bearer token and the integrations.sync permission. Open to API tokens with the accounting:write scope.

tracked_job_id and tracked_job_log_id carry the same value.

Request​

Responses​

OK

Response Headers
    Content-Type