Flavours API
Ingredient

Preview Ingredient

POST
/api/v2/ingredients/preview

Check whether an ingredient already exists for a market by name.

AuthorizationBearer <token>

You can retrieve your token by logging in.

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*string

The id of an existing record in the markets table.

name_en*string

Must not be greater than 191 characters.

name_ar?|

Must not be greater than 191 characters.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:8000/api/v2/ingredients/preview" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{    "market_id": "debitis",    "name_en": "pbwmoplekcr"  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Ingredients preview successfully."
  },
  "data": {
    "exists": true,
    "ingredient": {
      "id": "d5e361b2-55ca-4bb5-a1d3-f3306a9176d1",
      "name_en": "Aut est",
      "name_ar": "qui",
      "deleted_at": null,
      "market_id": "07928d80-350c-46eb-8786-91a40ca509a0",
      "source_unit": "pcs",
      "target_unit": "pcs",
      "source_rate": "90.82",
      "target_rate": "11.61",
      "minimum": "44.06",
      "created_at": 1782824836563,
      "updated_at": 1782824836563,
      "maximum": "413.35"
    }
  }
}
{
  "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
}