Delete a store (soft delete)

Overview

Soft-delete a store and its paired location-account record. This 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. All in one DB transaction.

Prerequisites

• A bearer token. Callable with Partner tokens.
• The storeId of the record you are targeting.

Base URL

Endpoint

DELETE /api/v1/partner/store/{storeId}/delete

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.
• Who can call it: Partner tokens.
• Authentication is under the partner/ group (partner-admin scope).
• The endpoint validates the URL id by the form request. An ownership check resolves the store to its company_id and confirms it sits inside the caller's company hierarchy. So a partner can only delete its own stores.

Rate limit

• No rate limit.

Path parameters

Response

• data.status (string) — success.
• data.message (string) — Location has been deleted successfully!.
• data.storeId (integer) — the deleted store's id.

200 Success · 200

{
  "data": {
    "status": "success",
    "message": "Location has been deleted successfully!",
    "storeId": 26
  }
}

422 Out of scope · 422

{
  "message": "The selected store id does not belong to your company hierarchy.",
  "errors": { "store_id": ["The selected store id does not belong to your company hierarchy."] }
}

404 Store not found · 404

{
  "message": "Not Found",
  "status": "error",
  "errors": "Store not found."
}

Errors

Example request

curl --request DELETE \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/store/123/delete" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'