API reference / Locations

Delete Location

MD View as MarkdownPlain text version of this page

Open in ClaudeAsk questions about this page Open in ChatGPTAsk questions about this page

DEL /api/v1/locations/{id}

Token needs the delete ability. About tokens

Permanently deletes a Location and everything it holds: daily history, orders, shifts, scores, ratings, store audits, COGS and retention report records, competition standings, and any users assigned directly to it. Requires the delete ability.

Only a location whose is_deletable is true can be deleted: a pending location (never activated), a deactivated one that never loaded any sales, labor or custom-metric data (keyed in by mistake), or a deactivated one whose daily history has aged out of reporting retention. A closed store's sales count toward network totals and year-over-year benchmarks for two full calendar years after the year it closed, so a deactivated location becomes deletable on Jan 1 three years after its deactivation year (four for a Dec 31 deactivation, as that day is itself retained); deletable_on gives the date. Deactivating (is_active: false) is what takes a store off leaderboards; deletion is cleanup only.

Path parameters

id string (uuid) required

Resource UUID.

Responses

- message string
- message string
- message string
- message string

curl -X DELETE "https://app.franchisesee.com/api/v1/locations/9d3f6b2e-5a41-4c7e-9a0b-2f1c8e7d4a63" \
  -H "Authorization: Bearer $FRANCHISESEE_TOKEN" \
  -H "Accept: application/json"

use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('FRANCHISESEE_TOKEN'))
    ->acceptJson()
    ->delete('https://app.franchisesee.com/api/v1/locations/9d3f6b2e-5a41-4c7e-9a0b-2f1c8e7d4a63');

const response = await fetch('https://app.franchisesee.com/api/v1/locations/9d3f6b2e-5a41-4c7e-9a0b-2f1c8e7d4a63', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.FRANCHISESEE_TOKEN}`,
    Accept: 'application/json',
  },
});

const data = await response.json();

import os
import requests

response = requests.request(
    "DELETE",
    "https://app.franchisesee.com/api/v1/locations/9d3f6b2e-5a41-4c7e-9a0b-2f1c8e7d4a63",
    headers={"Authorization": f"Bearer {os.environ['FRANCHISESEE_TOKEN']}", "Accept": "application/json"},
)

data = response.json()

Response

{
    "message": "Unauthenticated."
}

{
    "message": "This API token does not have the 'create' ability."
}

{
    "message": "Record not found."
}

{
    "message": "Cannot delete an active location. Deactivate it first."
}