/v1/business/franchise/location

Overview

Fetches locations for the UAT franchise business (BID 49197) scoped to region 2. This endpoint is typically used to retrieve location metadata for a franchisor context, including optional non-API locations and churned locations.

Authentication

Requires a valid bearer token supplied via the TOKEN variable.

Ensure the Authorization header is set to something like:

Query Parameters

id_region (number, required)

Region identifier to filter locations.

Example: 2.

k_business (number, required)

Business ID (BID) for which to retrieve locations.

Example: 49197.

is_include_non_api (boolean, optional)

When true, includes locations that are not normally exposed via the public API.

When false or omitted, only standard API-exposed locations are returned.

is_include_churn (boolean, optional)

When true, includes churned / inactive locations in the response.

When false or omitted, only active locations are returned.

Responses

200 OK – Successful response. May contain either location data or an error payload.

Business not franchisor error (example in 200 body)

{
  "a_error": [
    {
      "html_message": "Business is not franchisor.",
      "id": null,
      "s_field": null,
      "s_message": "Business is not franchisor.",
      "sid": "business-not-franchisor"
    }
  ],
  "class": "Core\\Request\\Api\\DebugException",
  "code": null,
  "message": "Business is not franchisor.",
  "status": "business-not-franchisor"
}

This indicates the requested k_business is not configured as a franchisor, even though the HTTP status is 200.

Notes

This endpoint is targeted for UAT use for business 49197 and region 2.

Always inspect the status and a_error fields in the JSON body to detect logical errors, even when the HTTP status code is 200.

curl --location -g --request GET '/v1/business/franchise/location?id_region={{id_region}}&k_business={{k_business}}&is_include_non_api=true&is_include_churn=true' \ --header 'Content-Type: text/plain' \ --data-raw ''

Overview#

Authentication#

Query Parameters#

Responses#

Notes#

Request

Responses

Overview

Authentication

Query Parameters

Responses

Notes