Refresh Transactions
POST/api/magento2/integration-instances/:magento2IntegrationInstance/transactions/refresh
Dispatch the tracked job that refreshes invoices + credit memos for the instance. Returns the tracked_job_log_id so the frontend can pivot the global JobProgressTray to it. Job name prefix is Refresh Magento 2 Transactions: — the page's lastCompletedJob watcher matches on this prefix.
Phase 2C scope: dispatch harness only — the actual /V1/invoices + /V1/creditmemo walking lands in Phase 2D.
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.