Flavours Partner API
ProductCategory

Set Product Category Status

POST
/api/v2/product-categories/{categoryId}/status

Activate or deactivate a category for the caller's market by writing the caller's per-market is_active override (adopting/creating the config if the market has none yet for a visible global). Tenant-scoped: only the caller's own or in-sector categories, never another market's. Never mints a duplicate canonical.

Authorization

API-TOKEN
API-TOKEN<token>

Your partner API key. Send it in the API-TOKEN header on every request.

In: header

Path Parameters

categoryId*string

Header Parameters

X-API-Version*string

API contract version to target. See the Changelog for what changed in each version.

Default"2.0.0"
Value in"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"

Request Body

application/json

is_active*boolean

Whether the category is active for the caller's market. Writes the caller's per-market override, adopting/creating the config if none exists yet for a visible global.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.flavours.sa/dev/api/v2/product-categories/176791/status" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{    "is_active": false  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Product category status updated successfully."
  },
  "data": {
    "id": 6,
    "icon": "🍩",
    "name_en": "Toggle Category",
    "name_ar": "تصنيف قابل للتبديل",
    "deleted_at": null,
    "created_at": 1792593344566,
    "updated_at": 1792593344566,
    "image_url": "https://cdn.example.com/img/uploads/product-categories/sample.png",
    "owned_by": null,
    "products_count": "0",
    "is_active": false,
    "sort": 0,
    "sectors": []
  }
}
{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}
{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "Unauthorized."
  },
  "data": null
}
{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}

Promote Product Category POST

Promote a private tenant category into a curated global category, discoverable and adoptable by other markets. Admin or merchant only. Optionally attach it to one or more sectors via sector_ids.

Similar Product Categories GET

Advisory lookup that returns up to 10 existing categories whose canonical name or the caller market's override name equals or contains the given name_en/name_ar, so the client can warn about a near-duplicate before creating one. At least one of name_en/name_ar is required. Tenant-scoped: never returns another market's private categories or overrides. Exact matches are ordered first, then contains, then by name.