Re-read Storefront Payout Lines
POST/api/storefront/payouts/:storefrontPayout/refresh-lines
Reads one payout and its lines again from the store, now, and returns the payout as Get Storefront Payout does. Use it when a payout's lines were not available at the last sync or look incomplete. The payout's accounting status is re-evaluated; a payout already posted keeps its posted documents.
accounting:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token and the integrations.sync permission. Open to API tokens with the accounting:write scope.
Errors (422):
- The store's processor connection lacks a permission it needs (for Stripe, a restricted key without Balance: Read or Payouts: Read):
error.codeisprocessor_permission_missing, with theproviderand thepermissionto grant. - The store could not be reached or returned an error:
messagestarts with "Could not read the payout from the store".
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.
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.