/v1/shop/category

Overview

Retrieves the list of shop categories configured for a specific WellnessLiving business and region in the UAT environment. This endpoint is typically used early in the WellnessLiving shop flow to populate category selectors (e.g., Events, Products, Purchase Options, Gift Cards) before drilling down into specific items.

Request

Method: GET

URL: https://uat-api.wellnessliving.io/v1/shop/category

Auth: Handled via existing workspace variables/settings (e.g., shared auth headers or tokens). No additional auth configuration is required directly on this request.

Parameters

Query parameters:

id_region (required, integer)

Identifies the regional context for the shop (e.g., region or location grouping).

Example: 2.

k_business (required, string)

WellnessLiving business key that scopes the categories to a specific business account.

Example: 49197.

Response

On success, the endpoint returns HTTP 200 OK with a JSON body similar to:

{
  "a_shop_category": [
    {
      "i_order": "1",
      "is_default": false,
      "is_system": false,
      "k_shop_category": "1430532",
      "text_description": "",
      "text_title": "Events"
    }
  ],
  "status": "ok",
  "s_version": "<string>",
  "__a_message": ["<additional metadata strings>"]
}

Key fields:

a_shop_category (array)

List of shop categories for the given business and region.

Each object may include:

k_shop_category (string): Unique key for the shop category.

text_title (string): Display name of the category (e.g., "Events", "Products").

i_order (string or integer): Sort order for how categories should be displayed in the UI.

is_default (boolean): Indicates if this category is the default selection.

is_system (boolean): Indicates if this is a system-defined category.

status (string): Overall status of the call, typically "ok" on success.

s_version (string): Internal version identifier for the response schema or data.

__a_message (array): Additional informational or diagnostic messages returned by the service.

Overview#

Request#

Parameters#

Response#

Request

Responses

Overview

Request

Parameters

Response