Flavours Partner API
Branch

List Branches

GET
/api/v2/branches

List all branches with pagination and filtering options.

Authorization

API-TOKEN
API-TOKEN<token>

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

In: header

Query Parameters

page?|

Page number for pagination. Must be at least 1.

per_page?|

Number of items per page. Must be at least 1.

search?|

Search term for filtering branches.

sort?|

Sort column (e.g. created_at, name_en).

key_by?|

Key response by column.

includes*array<>
filter?object
filter.market_id?|

Filter by market ID. Must match an existing stored value.

filter.branches_ids*array<>

Must match an existing stored value.

filter.is_active?|

Filter by active status.

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"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.flavours.sa/dev/api/v2/branches?page=1&per_page=20&search=Downtown&sort=created_at&key_by=id&includes=eum&filter.market_id=uuid&filter.branches_ids=soluta&filter.is_active=true" \  -H "X-API-Version: 2.3.0"
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Branches retrieved successfully."
  },
  "data": {
    "current_page": 1,
    "current_page_url": "https://localhost:8000/api/v2/branches?page=1",
    "data": [
      {
        "id": "716ba96a-6dc2-4fe9-93a4-fbba01d9f1fc",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Schumm Group",
        "name_ar": "Schumm Group",
        "address": "92436 Hahn Loop Suite 070\nNew Kaylabury, MN 39810-1806",
        "latitude": -84.094158,
        "longitude": 54.574491,
        "is_active": true,
        "created_at": 1792593332209,
        "updated_at": 1792593332209,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-808909"
      },
      {
        "id": "bd6c5af9-dc6c-4047-8414-e63b595c59d1",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Rau Ltd",
        "name_ar": "Rau Ltd",
        "address": "6618 Kathleen Gardens Suite 641\nSouth Keara, WY 73497",
        "latitude": -28.240593,
        "longitude": -127.23717,
        "is_active": true,
        "created_at": 1792593332209,
        "updated_at": 1792593332209,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-714254"
      },
      {
        "id": "4d59afc1-267b-4c5b-81bb-1abbfb290913",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Maggio LLC",
        "name_ar": "Maggio LLC",
        "address": "457 Parker Junctions Apt. 893\nCorkeryport, HI 51500",
        "latitude": -19.413174,
        "longitude": -32.289776,
        "is_active": true,
        "created_at": 1792593332209,
        "updated_at": 1792593332209,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-710705"
      },
      {
        "id": "643bc290-c82f-443c-b15a-8a8effd064d1",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Beer, McKenzie and Schaden",
        "name_ar": "Beer, McKenzie and Schaden",
        "address": "67729 Eudora Plain\nShaniaton, CO 21266-7200",
        "latitude": -30.391154,
        "longitude": 162.706934,
        "is_active": true,
        "created_at": 1792593331500,
        "updated_at": 1792593331500,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-596090"
      },
      {
        "id": "0dc2af53-6b00-497e-99c0-c5a37fe40a68",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Thompson, Gleichner and Hyatt",
        "name_ar": "Thompson, Gleichner and Hyatt",
        "address": "444 Hoppe Haven Apt. 692\nEast Daphneyview, CT 41865-9841",
        "latitude": 70.937596,
        "longitude": 34.195083,
        "is_active": true,
        "created_at": 1792593331394,
        "updated_at": 1792593331394,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-493902"
      },
      {
        "id": "64bde393-cc69-498c-86e6-488ac9b3125a",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Kuhn-Funk",
        "name_ar": "Kuhn-Funk",
        "address": "8979 Hilpert Highway\nNew Johnson, IN 36794-8656",
        "latitude": 19.588207,
        "longitude": -11.317346,
        "is_active": true,
        "created_at": 1792593331322,
        "updated_at": 1792593331322,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-318377"
      },
      {
        "id": "bfac8c0e-51d4-4ae3-975a-312368492b47",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Hackett LLC",
        "name_ar": "Hackett LLC",
        "address": "85545 Nichole Unions\nNorth Chettown, NE 70517-4406",
        "latitude": -78.377448,
        "longitude": 15.079275,
        "is_active": true,
        "created_at": 1792593331216,
        "updated_at": 1792593331216,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-890537"
      },
      {
        "id": "5b193bb7-92a5-4ea2-b123-e2d581bf4ce2",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Jacobi-Kuhn",
        "name_ar": "Jacobi-Kuhn",
        "address": "43605 Price Burg\nCreminfort, PA 82158-1222",
        "latitude": -3.535009,
        "longitude": -87.234511,
        "is_active": true,
        "created_at": 1792593331164,
        "updated_at": 1792593331164,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-823129"
      },
      {
        "id": "14f1c2b5-dfb7-4f80-bfb1-746e9b9f2cf3",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Nicolas, Smith and Kling",
        "name_ar": "Nicolas, Smith and Kling",
        "address": "181 Sanford Views\nNew Kaleighchester, CT 85109",
        "latitude": 22.260501,
        "longitude": 161.635167,
        "is_active": true,
        "created_at": 1792593331082,
        "updated_at": 1792593331082,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-307627"
      },
      {
        "id": "fe6156c0-b5b0-4541-8046-c49ba27516f7",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Gaylord-Hill",
        "name_ar": "Gaylord-Hill",
        "address": "90546 Block Road Apt. 141\nSatterfieldmouth, HI 93057-6352",
        "latitude": -53.648381,
        "longitude": 46.460698,
        "is_active": true,
        "created_at": 1792593331082,
        "updated_at": 1792593331082,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-394879"
      },
      {
        "id": "e02e4981-a7de-4899-bf96-44f0e0b7e02b",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Krajcik-Runte",
        "name_ar": "Krajcik-Runte",
        "address": "40155 Bradtke Isle\nJosianemouth, DC 49654",
        "latitude": 56.773195,
        "longitude": 152.099495,
        "is_active": true,
        "created_at": 1792593330712,
        "updated_at": 1792593330712,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-212318"
      },
      {
        "id": "2438ea30-370a-4ca0-9423-f635f83f1bec",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Ritchie Group",
        "name_ar": "Ritchie Group",
        "address": "97804 Tyra Road Suite 960\nMacejkovicmouth, MA 80054",
        "latitude": -71.349526,
        "longitude": -85.755632,
        "is_active": true,
        "created_at": 1792593329466,
        "updated_at": 1792593329466,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-704037"
      },
      {
        "id": "c69c3345-e27a-4e28-8962-ed7face37fc1",
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "name_en": "Bradtke, Wolff and Grant",
        "name_ar": "Bradtke, Wolff and Grant",
        "address": "3292 Ola Falls\nBlockmouth, MI 23335-8620",
        "latitude": -20.604323,
        "longitude": 100.924016,
        "is_active": true,
        "created_at": 1792593329466,
        "updated_at": 1792593329466,
        "deleted_at": null,
        "expired_at": null,
        "is_online": false,
        "code": "BR-116622"
      }
    ],
    "first_page_url": "https://localhost:8000/api/v2/branches?page=1",
    "from": 1,
    "next_page_url": null,
    "path": "https://localhost:8000/api/v2/branches",
    "per_page": 20,
    "prev_page_url": null,
    "to": 13
  }
}
{
  "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
}

Detail Branch GET

Get details of a specific branch by its ID.

Update Branch POST

Update an existing branch.