Purge Pre-Start Financial Event Groups
POST/api/amazon/unified/financial-event-groups/purge-pre-start
Queues a background job that deletes every Amazon financial event group (settlement transaction) whose settlement period starts BEFORE the account's inventory start date, along with its settlement data. These historical records predate inventory tracking and will never have matching settlement reports. Run GET .../purge-pre-start/preflight first to review exactly which groups will be removed.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
The deletion happens asynchronously after this request returns; the response only confirms that the background job was dispatched (no job id is returned).
Body fields:
confirmation(required, string) - must be exactlyPURGE.integration_instance_ids(optional, array of integers or comma-separated string) - scopes the purge to specific Amazon integration instances.
Request
Responses
- 200
- 401
- 403
- 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.
Unprocessable Entity
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.