Sync Payouts
POST/api/ebay/:integrationInstance/payouts/sync
Queues a background sync that imports eBay Managed Payments payouts and their transaction lines from eBay for the integration instance. Returns a tracked_job_log_id that can be used to monitor the progress of the sync.
The request body is optional. With no body, the sync runs the default incremental (cursor-based) window. Supply mode to control the range: latest (incremental, default), from_start_date (from the instance start date to now), date_range (bounded by date_from/date_to), or all (full backfill). date_from and date_to are Y-m-d dates and apply when mode is date_range (date_to must be on or after date_from).
Authentication: Requires Bearer token.
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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.