Flavours Partner API
IngredientUnit

List Ingredient Units

GET
/api/v2/ingredients/units

List the distinct source and target units used across a market's ingredients.

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

page?|

Must be at least 1.

per_page?|

Must be at least 1.

search?|
sort?|
Value in"type" | "-type" | "unit" | "-unit"
filter?

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.flavours.sa/dev/api/v2/ingredients/units" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{}'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Units retrieved successfully."
  },
  "data": {
    "current_page": 1,
    "data": [
      {
        "type": "SOURCE",
        "unit": "kg"
      },
      {
        "type": "TARGET",
        "unit": "gram"
      }
    ],
    "first_page_url": "http://localhost:8000/api/v2/ingredients/units?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://localhost:8000/api/v2/ingredients/units?page=1",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "page": null,
        "active": false
      },
      {
        "url": "http://localhost:8000/api/v2/ingredients/units?page=1",
        "label": "1",
        "page": 1,
        "active": true
      },
      {
        "url": null,
        "label": "Next &raquo;",
        "page": null,
        "active": false
      }
    ],
    "next_page_url": null,
    "path": "http://localhost:8000/api/v2/ingredients/units",
    "per_page": 20,
    "prev_page_url": null,
    "to": 2,
    "total": 2
  }
}
{
  "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
}

List Ingredient Histories GET

List the stock-movement history for an ingredient.

Current user GET

The authenticated user with the relations of their role. For a **subscriber** `userable.branch` is the pinned branch, with `setting` (`setting.timezone`: the branch IANA zone every workday time is computed in) and `shift`. `shift` keeps its legacy keys (`day`, `min`, `max`, `open_at`, `lock_at`) and adds `timezone`, `is_workday` (the branch switch is ON), `workday`, `overtime_end_at`, `auto_close_at` (when the auto-close job will close the open shift) and `next_opening_at` (additive, at every `X-API-Version`); from `X-API-Version` 2.10.0 `shift` is always an object, below it a branch outside every shift keeps `null`. Clients that need the phase and the allowed actions read `GET /v2/attendances/state` instead of deriving them from `shift`.