Flavours Partner API
ProductCategory

Create Product Category

POST
/api/v2/product-categories

Create a product category with localized names and at least one of an emoji icon or an image URL (either alone is accepted; neither is rejected).

Authorization

API-TOKEN
API-TOKEN<token>

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

In: header

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

market_id?|

Must match an existing stored value.

icon?|

This field is required when image_url is not present. Must not be greater than 64 characters.

image_url?|

This field is required when icon is not present. Must be a valid URL.

name_en*string

Must not be greater than 191 characters.

name_ar*string

Must not be greater than 191 characters.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.flavours.sa/dev/api/v2/product-categories" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{    "name_en": "tuipbzyfinsjdijrhhdko",    "name_ar": "cbpclzbxyqvaq"  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Create Success"
  },
  "data": {
    "id": 8,
    "icon": "🥤",
    "name_en": "Cold Drinks",
    "name_ar": "مشروبات باردة",
    "deleted_at": null,
    "created_at": 1792593344650,
    "updated_at": 1792593344650,
    "market_id": null,
    "image_url": "https://cdn.example.com/img/uploads/product-categories/sample.png",
    "products_count": "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": 422,
    "status": "error",
    "message": "The image url must be a valid URL. (and 2 more errors)"
  },
  "data": [
    {
      "code": 0,
      "message": "The image url must be a valid URL.",
      "field": "image_url"
    },
    {
      "code": 0,
      "message": "Category name is required in both English and Arabic.",
      "field": "name_en"
    },
    {
      "code": 0,
      "message": "Category name is required in both English and Arabic.",
      "field": "name_ar"
    }
  ]
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}