Active Venues - VODO ERP

Description: Retrieves a paginated list of active venues in the e-commerce system. Supports filtering by keyword or venue IDs. Requires authentication headers (apikey, apiconnection, secure-business-key). The optional Accept-Language header specifies the response language. Returns a JSON object with active venue details and pagination metadata. Fetch a list of active venues with optional filters.

Headers

Key	Value	Description	Type
`apikey`	`5f28583f26a1a`	API key for authentication; contact support to obtain. `Required`	`string`
`apiconnection`	`appmobile`	Connection type; contact support to obtain. `Required`	`string`
`secure-business-key`	`4765066450c0bd66325.48403130`	Business-specific key; contact support for valid values. `Required`	`string`
`lang`	`ar`	Language preference: `ar` for Arabic, `en` for English. Optional	`string`

Query Parameters

Key	Value	Description	Type
`list`	(empty)	Show all data without pagination. Optional	`string`
`per_page`	`10`	Number of items per page. Optional	`string`
`page`	`2`	Page number for pagination. Optional	`string`
`keyword`	(empty)	Search by keyword. Optional	`string`
`venues_ids`	`52`	Filter by venue IDs. Optional	`string`

curl --location --request GET 'https://www.testecommerce.vodoerp.com/api/venues/active_venues?list=&per_page=10&page=2&keyword=&venues_ids=52' \ --header 'apikey: 5f28583f26a1a' \ --header 'apiconnection: appmobile' \ --header 'secure-business-key: 4765066450c0bd66325.48403130' \ --header 'Accept-Language: ar' \ --header 'Content-Type: application/json' \ --data-raw '{}'

{ "status": true, "message": "Venues Data", "data": { "current_page": 1, "data": [ { "id": 39, "name": "لييب V2" } ], "first_page_url": "http://localhost:8000/api/venues/active_venues?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost:8000/api/venues/active_venues?page=1", "links": [ { "url": null, "label": "« Previous", "active": false }, { "url": "http://localhost:8000/api/venues/active_venues?page=1", "label": "1", "active": true }, { "url": null, "label": "Next »", "active": false } ], "next_page_url": null, "path": "http://localhost:8000/api/venues/active_venues", "per_page": 10, "prev_page_url": null, "to": 1, "total": 1 } }

Request

Query Params

list

string

optional

Show all data without pagination

per_page

string

optional

Display the required number on one page

Example:

page

string

optional

The page number you want to go to

Example:

keyword

string

optional

search by keyword

venues_ids

string

optional

search by venues_ids

Example:

Header Params

apikey

string

required

You must contact support to get the apikey.

Example:

5f28583f26a1a

apiconnection

string

required

You must contact support to get the apiconnection.

Example:

appmobile

secure-business-key

string

required

You must contact support to get the secure-business-key like: 4765066450c0bd66325.48403130
728106399db2b289783.89154521
2680667168f2f8a68f6.12561200
140356399db2b2c32f0.25237063
96701678e330f31f768.22400604
14807664478836358b0.31329842

Example:

4765066450c0bd66325.48403130

Accept-Language

string

required

ar => Arabic or en => English

Example:

Body Params application/json

object {0}

Examples

Responses

🟢200Active Venues

application/json

Body

status

boolean

required

message

string

required

data

object

required

current_page

integer

required

data

array [object {2}]

required

first_page_url

string

required

from

integer

required

last_page

integer

required

last_page_url

string

required

links

array [object {3}]

required

next_page_url

null

required

path

string

required

per_page

integer

required

prev_page_url

null

required

integer

required

total

integer

required