Flavours API
IngredientHistory

List Ingredient Histories

GET
/api/v2/ingredients/{ingredientId}/histories

List the stock-movement history for an ingredient.

AuthorizationBearer <token>

You can retrieve your token by logging in.

In: header

Path Parameters

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

page?|

Must be at least 1.

per_page?|

Must be at least 1.

search?|
sort?|
key_by?|
includes*array<>
filter?

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.flavours.sa/dev/api/v2/ingredients/quo/histories" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{    "includes": [      "minus"    ]  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Histories retrieved successfully."
  },
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "ingredient_id": null,
        "qty": "24.48",
        "description_en": null,
        "description_ar": null,
        "created_at": 1787446694301,
        "updated_at": 1787446694301,
        "cost": 4.89,
        "notes": "Veniam dignissimos error laudantium occaecati et.",
        "branch_id": null,
        "ingredient_branch_id": "221d8f0e-4e64-41b5-97d1-b3e5c1df1384",
        "type": "INGREDIENT_INCREASE",
        "source_id": "aff5e098-0656-4a24-af8e-b28bdc8ff80b",
        "source_type": "INGREDIENT"
      }
    ],
    "first_page_url": "http://localhost:8000/api/v2/ingredients/aff5e098-0656-4a24-af8e-b28bdc8ff80b/histories?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://localhost:8000/api/v2/ingredients/aff5e098-0656-4a24-af8e-b28bdc8ff80b/histories?page=1",
    "links": [
      {
        "url": null,
        "label": "&laquo; Previous",
        "page": null,
        "active": false
      },
      {
        "url": "http://localhost:8000/api/v2/ingredients/aff5e098-0656-4a24-af8e-b28bdc8ff80b/histories?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/aff5e098-0656-4a24-af8e-b28bdc8ff80b/histories",
    "per_page": 20,
    "prev_page_url": null,
    "to": 1,
    "total": 1
  }
}
{
  "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
}