Remove a location

Overview

Remove a location and everything attached to it: its reviews, responses, flags, and review site connections. Any active plan on it is closed.

Use this when a location closes for good.

You'll need the store_id.

Review collection and posting stop for that location, and billing for it ends.

Prerequisites

• A Partner or Account token. See Authentication.
• The location's id (storeId).

Base URL

Endpoint

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

Authentication

Partner or Account token

• An Account token reaches only its own locations.
• The location must exist and be inside your account tree; otherwise 422.

Rate limit

This endpoint has no rate limit.

Request parameters

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Response payload

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

Examples

Success payload

See Response payload.

Error payload

404 Store not found

The location was already removed.

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

422 Location doesn't exist

{
  "message": "The selected store id is invalid. (and 1 more error)",
  "errors": {
    "store_id": [
      "The selected store id is invalid.",
      "The selected store id does not belong to your company hierarchy."
    ]
  }
}

422 Location outside your tree

{
  "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."]
  }
}

Example request

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