Add the locations that belong to an account, and manage them over time.
Add the locations that belong to an account, and manage them over time.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | Add a location | Create a new store location under an account in one transaction: a location-account record + its company options, the store row, and a store_options row (inheriting who_will_pay). |
GET | List all locations under your partner | Get a paginated list of all store locations under the authenticated partner (aggregated across every account the partner owns), each row joined to its account name, address, and active-plan name + dates. |
POST | List an account's locations | Returns a paginated list of stores accessible to the authenticated user, each joined to full location, account, and geo detail plus the active store_plan (with plan features) and a generated connect_page_url. |
GET | List locations for a menu | Get a flat label/value list of the stores the authenticated user can access, for dropdowns. |
GET | Get one location | Get a single store with its account name, location detail, and active subscription. |
POST | Edit a location | Update a store and its paired location-account record together (name, storeid, client_location_id, address, zip, city, site_url, phone, company_phone). |
DELETE | Remove a location | Soft-delete a store and its paired location-account record, closes any active/expired store plans (sets status close, plan_end + cancel_subscription_at = now), and cascade-soft-deletes the store's reviews, response_reviews, review_flag, and store_review_sites. |
GET | Download the locations spreadsheet template | Get a download URL for the sample spreadsheet used by the bulk location upload. |
POST | Upload locations for review | Accepts an Excel file of locations and an account_id (Account), validates the header row and every data row, stores the file to S3, and emails the admin team to verify before any locations are created. |
POST | Update existing locations from a spreadsheet | Upload an Excel file (first sheet only) and updates existing locations belonging to the authenticated account — matching each row by location_id against the location's code, then writing the store name/storeid plus the location-account company's name/address/city/zip. |