Export locations to Excel

Generate an Excel export of all locations under the authenticated account, stores it to S3, and returns the public download URL.

Auth: Account — authentication (route is inside the authenticated group). Requires the user's company bundle_id === 3 (ACCOUNT); a non-account user gets 403. Scope is the caller's own company tree: store ids are validated against it.

Rate limit: No rate limit.

Request

  • No path/query/body params.

Response{ data. } envelope.

  • data.path (string) — public S3 URL of the generated .xlsx, keyed download/excel/<Y-m>/<timestamp>-<SafeBrandName>-Locations.xlsx.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json