Flavours API
Market

List Markets

GET
/api/v2/markets

List all markets with pagination and filtering options.

Authorization

default
AuthorizationBearer <token>

You can retrieve your token by logging in.

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 in name_en or name_ar.

sort?|

Sort field and direction (e.g., name_en, -created_at).

key_by?|

Key the results by this field.

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

Must match an existing stored value.

filter.markets_ids*array<>

Must match an existing stored value.

filter.merchant_id?|

Must match an existing stored value.

filter.reseller_id?|

Must match an existing stored value.

filter.sector_id?|

Must match an existing stored value.

filter.created_by?|

Must match an existing stored value.

filter.created_at_min?|

Must be 13 digits.

filter.created_at_max?|

Must be 13 digits.

filter.last_active_at_min?|

Must be 13 digits.

filter.last_active_at_max?|

Must be 13 digits.

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/markets?page=1&per_page=20&search=market&sort=-created_at&key_by=id&includes=sunt&filter.plan_key=saepe&filter.markets_ids=enim&filter.merchant_id=cum&filter.reseller_id=et&filter.sector_id=3&filter.created_by=quis&filter.created_at_min=2972900803293&filter.created_at_max=9488239289291&filter.last_active_at_min=9955421952739&filter.last_active_at_max=9546450284938" \  -H "X-API-Version: 2.3.0"
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Business list retrieved successfully."
  },
  "data": {
    "current_page": 1,
    "current_page_url": "http://localhost:8000/api/v2/markets?page=1",
    "data": [
      {
        "id": "b92fee9e-14a6-4641-bb93-3eda7908cf14",
        "sector_id": 6,
        "name_en": "Prohaska-Murphy",
        "name_ar": "Prohaska-Murphy",
        "description_en": null,
        "description_ar": null,
        "logo_img": "https://via.placeholder.com/200x200.png/005522?text=business+logo+rerum",
        "cover_img": "https://via.placeholder.com/200x200.png/006677?text=business+cover+reprehenderit",
        "email": "[email protected]",
        "phone_prefix": "90",
        "phone_number": "3585663743",
        "crn": "734-189-1167",
        "tax_number": "05225917659",
        "created_by": null,
        "email_verified_at": 1787446691599,
        "phone_verified_at": 1787446691599,
        "created_at": 1787446691567,
        "updated_at": 1787446691567,
        "deleted_at": null,
        "is_active": true,
        "merchant_id": null,
        "reseller_id": null,
        "slug": "prohaska-murphy",
        "code": "ENT-0000000009",
        "links": {
          "website": null,
          "instagram": null,
          "youtube": null,
          "x": null,
          "call_center": null
        },
        "phone": "3585663743"
      },
      {
        "id": "7dd75337-6c30-44a0-9739-6c4a4d462ce1",
        "sector_id": 14,
        "name_en": "Schmeler, Dicki and Schneider",
        "name_ar": "Schmeler, Dicki and Schneider",
        "description_en": null,
        "description_ar": null,
        "logo_img": "https://via.placeholder.com/200x200.png/004400?text=business+logo+nobis",
        "cover_img": "https://via.placeholder.com/200x200.png/004411?text=business+cover+ea",
        "email": "[email protected]",
        "phone_prefix": "212",
        "phone_number": "5347552554",
        "crn": "004-996-7581",
        "tax_number": "73967999936",
        "created_by": null,
        "email_verified_at": 1787446690487,
        "phone_verified_at": 1787446690487,
        "created_at": 1787446690474,
        "updated_at": 1787446690474,
        "deleted_at": null,
        "is_active": true,
        "merchant_id": null,
        "reseller_id": null,
        "slug": "schmeler-dicki-and-schneider",
        "code": "ENT-0000000008",
        "links": {
          "website": null,
          "instagram": null,
          "youtube": null,
          "x": null,
          "call_center": null
        },
        "phone": "5347552554"
      },
      {
        "id": "9ec5efd0-b7db-4c85-bc08-93dfb54614e7",
        "sector_id": 1,
        "name_en": "Abernathy, Reichel and Brakus",
        "name_ar": "Abernathy, Reichel and Brakus",
        "description_en": null,
        "description_ar": null,
        "logo_img": "https://via.placeholder.com/200x200.png/00ee88?text=business+logo+maiores",
        "cover_img": "https://via.placeholder.com/200x200.png/00eedd?text=business+cover+molestiae",
        "email": "[email protected]",
        "phone_prefix": "971",
        "phone_number": "8888006152",
        "crn": "800-534-8132",
        "tax_number": "17710069239",
        "created_by": null,
        "email_verified_at": 1787446689351,
        "phone_verified_at": 1787446689351,
        "created_at": 1787446689332,
        "updated_at": 1787446689332,
        "deleted_at": null,
        "is_active": true,
        "merchant_id": null,
        "reseller_id": null,
        "slug": "abernathy-reichel-and-brakus",
        "code": "ENT-0000000007",
        "links": {
          "website": null,
          "instagram": null,
          "youtube": null,
          "x": null,
          "call_center": null
        },
        "phone": "8888006152"
      },
      {
        "id": "74e28a92-8d86-48e6-b7d7-455be2379d19",
        "sector_id": 2,
        "name_en": "Johns, Yundt and Ritchie",
        "name_ar": "Johns, Yundt and Ritchie",
        "description_en": null,
        "description_ar": null,
        "logo_img": "https://via.placeholder.com/200x200.png/00ddbb?text=business+logo+deserunt",
        "cover_img": "https://via.placeholder.com/200x200.png/00aa55?text=business+cover+iste",
        "email": "[email protected]",
        "phone_prefix": "964",
        "phone_number": "9671072067",
        "crn": "594-390-8724",
        "tax_number": "56709470705",
        "created_by": null,
        "email_verified_at": 1787446688240,
        "phone_verified_at": 1787446688240,
        "created_at": 1787446688224,
        "updated_at": 1787446688224,
        "deleted_at": null,
        "is_active": true,
        "merchant_id": null,
        "reseller_id": null,
        "slug": "johns-yundt-and-ritchie",
        "code": "ENT-0000000006",
        "links": {
          "website": null,
          "instagram": null,
          "youtube": null,
          "x": null,
          "call_center": null
        },
        "phone": "9671072067"
      },
      {
        "id": "9361148f-cc25-48c8-8e6f-1230d926b254",
        "sector_id": 10,
        "name_en": "Pfannerstill Ltd",
        "name_ar": "Pfannerstill Ltd",
        "description_en": null,
        "description_ar": null,
        "logo_img": "https://via.placeholder.com/200x200.png/0088dd?text=business+logo+et",
        "cover_img": "https://via.placeholder.com/200x200.png/0066ff?text=business+cover+et",
        "email": "[email protected]",
        "phone_prefix": "965",
        "phone_number": "3907472163",
        "crn": "836-892-6359",
        "tax_number": "84434504546",
        "created_by": null,
        "email_verified_at": 1787446687937,
        "phone_verified_at": 1787446687937,
        "created_at": 1787446687918,
        "updated_at": 1787446687918,
        "deleted_at": null,
        "is_active": true,
        "merchant_id": null,
        "reseller_id": null,
        "slug": "pfannerstill-ltd",
        "code": "ENT-0000000005",
        "links": {
          "website": null,
          "instagram": null,
          "youtube": null,
          "x": null,
          "call_center": null
        },
        "phone": "3907472163"
      },
      {
        "id": "6de2d125-b44e-4af6-9a55-46885b99decd",
        "sector_id": 9,
        "name_en": "Turcotte-Barton",
        "name_ar": "Turcotte-Barton",
        "description_en": null,
        "description_ar": null,
        "logo_img": "https://via.placeholder.com/200x200.png/005500?text=business+logo+dolores",
        "cover_img": "https://via.placeholder.com/200x200.png/00bb88?text=business+cover+deleniti",
        "email": "[email protected]",
        "phone_prefix": "974",
        "phone_number": "5253560983",
        "crn": "112-452-5031",
        "tax_number": "96801310815",
        "created_by": null,
        "email_verified_at": 1787446687599,
        "phone_verified_at": 1787446687599,
        "created_at": 1787446687583,
        "updated_at": 1787446687583,
        "deleted_at": null,
        "is_active": true,
        "merchant_id": null,
        "reseller_id": null,
        "slug": "turcotte-barton",
        "code": "ENT-0000000004",
        "links": {
          "website": null,
          "instagram": null,
          "youtube": null,
          "x": null,
          "call_center": null
        },
        "phone": "5253560983"
      },
      {
        "id": "25c59776-06a5-43ab-8e16-e84a164c8558",
        "sector_id": 6,
        "name_en": "Quitzon Ltd",
        "name_ar": "Quitzon Ltd",
        "description_en": null,
        "description_ar": null,
        "logo_img": "https://via.placeholder.com/200x200.png/00aa33?text=business+logo+consequatur",
        "cover_img": "https://via.placeholder.com/200x200.png/0022dd?text=business+cover+ut",
        "email": "[email protected]",
        "phone_prefix": "971",
        "phone_number": "1721943261",
        "crn": "206-108-3444",
        "tax_number": "25775711034",
        "created_by": null,
        "email_verified_at": 1787446687312,
        "phone_verified_at": 1787446687312,
        "created_at": 1787446687290,
        "updated_at": 1787446687290,
        "deleted_at": null,
        "is_active": true,
        "merchant_id": null,
        "reseller_id": null,
        "slug": "quitzon-ltd",
        "code": "ENT-0000000003",
        "links": {
          "website": null,
          "instagram": null,
          "youtube": null,
          "x": null,
          "call_center": null
        },
        "phone": "1721943261"
      },
      {
        "id": "d33a5f53-b105-41f6-b19e-e4040ed31292",
        "sector_id": 2,
        "name_en": "Glover, Waelchi and Marks",
        "name_ar": "Glover, Waelchi and Marks",
        "description_en": null,
        "description_ar": null,
        "logo_img": "https://via.placeholder.com/200x200.png/0022dd?text=business+logo+consequatur",
        "cover_img": "https://via.placeholder.com/200x200.png/006633?text=business+cover+ratione",
        "email": "[email protected]",
        "phone_prefix": "974",
        "phone_number": "5377244925",
        "crn": "677-694-6966",
        "tax_number": "28396889691",
        "created_by": null,
        "email_verified_at": 1787446686936,
        "phone_verified_at": 1787446686936,
        "created_at": 1787446686923,
        "updated_at": 1787446686923,
        "deleted_at": null,
        "is_active": true,
        "merchant_id": null,
        "reseller_id": null,
        "slug": "glover-waelchi-and-marks",
        "code": "ENT-0000000002",
        "links": {
          "website": null,
          "instagram": null,
          "youtube": null,
          "x": null,
          "call_center": null
        },
        "phone": "5377244925"
      },
      {
        "id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
        "sector_id": 10,
        "name_en": "Kunde Ltd",
        "name_ar": "Kunde Ltd",
        "description_en": null,
        "description_ar": null,
        "logo_img": "https://via.placeholder.com/200x200.png/006655?text=business+logo+quidem",
        "cover_img": "https://via.placeholder.com/200x200.png/00cc77?text=business+cover+dolorem",
        "email": "[email protected]",
        "phone_prefix": "973",
        "phone_number": "7148591204",
        "crn": "030-077-7963",
        "tax_number": "90476326386",
        "created_by": null,
        "email_verified_at": 1787446674909,
        "phone_verified_at": 1787446674909,
        "created_at": 1787446674760,
        "updated_at": 1787446674760,
        "deleted_at": null,
        "is_active": true,
        "merchant_id": null,
        "reseller_id": null,
        "slug": "kunde-ltd",
        "code": "ENT-0000000001",
        "links": {
          "website": null,
          "instagram": null,
          "youtube": null,
          "x": null,
          "call_center": null
        },
        "phone": "7148591204"
      }
    ],
    "first_page_url": "http://localhost:8000/api/v2/markets?page=1",
    "from": 1,
    "next_page_url": null,
    "path": "http://localhost:8000/api/v2/markets",
    "per_page": 20,
    "prev_page_url": null,
    "to": 9
  }
}
{
  "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 Market GET

Get details of a specific market by its ID.

Update Market POST

Update an existing market.