All Categories - VODO ERP

Description: Retrieves a paginated list of all venue categories in the e-commerce system. Supports filtering by keyword or status, and sorting options to organize results. Requires authentication headers (apikey, apiconnection, secure-business-key). The optional lang header specifies the response language (ar for Arabic, en for English). Returns a JSON object with category details and pagination metadata. Fetch a list of venue categories with optional filters.

Headers

Key	Value	Description	Type
`apikey`	`5f28583f26a1a`	API key for authentication; contact support to obtain. `Required`	`string`
`lang`	`ar`	Language preference: `ar` for Arabic, `en` for English. Optional	`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`

Query Parameters

Key	Value	Description	Type
`keyword`	`Category Name Ertyjrrj`	Filter by search term. Optional	`string`
`view`	`list`	Show all data without pagination. Optional	`string`
`sort_order`	`status__desc`	Sort by: `id__desc`, `id__asc`, `title__desc`, etc. Optional	`string`
`per_page`	`10`	Number of items per page. Optional	`string`
`status`	`0`	Filter by status: `0` (inactive), `1` (active). Optional	`string`
`page`	`2`	Page number for pagination. Optional	`string`

curl --location -g --request GET 'https://www.testecommerce.vodoerp.com/{{venue categories}}?keyword=Category Name Ertyjrrj&view=list&sort_order=status__desc&per_page=10&status=0&page=2' \ --header 'apikey: 5f28583f26a1a' \ --header 'lang: ar' \ --header 'apiconnection: appmobile' \ --header 'secure-business-key: 4765066450c0bd66325.48403130' \ --header 'Content-Type: application/json' \ --data-raw '{}'

{ "status": true, "message": "Categories Data", "data": { "current_page": 1, "data": [ { "id": 112, "image": null, "title": "Test Name EN", "parent": "", "top": 0, "status": 1, "sort": 10, "type": "Custom", "descriptions": [ { "title": "Test Name EN" } ] }, { "id": 111, "image": null, "title": "Test Name EN", "parent": "", "top": 0, "status": 0, "sort": 10, "type": "Custom", "descriptions": [ { "title": "Test Name EN" } ] }, { "id": 110, "image": null, "title": "Category Name EN", "parent": "", "top": 0, "status": 1, "sort": 10, "type": "Custom", "descriptions": [ { "title": "Category Name EN" } ] } ], "first_page_url": "http://localhost:8000/api/v1/venue_categories?page=1", "from": 1, "last_page": 1, "last_page_url": "http://localhost:8000/api/v1/venue_categories?page=1", "links": [ { "url": null, "label": "« Previous", "active": false }, { "url": "http://localhost:8000/api/v1/venue_categories?page=1", "label": "1", "active": true }, { "url": null, "label": "Next »", "active": false } ], "next_page_url": null, "path": "http://localhost:8000/api/v1/venue_categories", "per_page": 10, "prev_page_url": null, "to": 3, "total": 3 } }

Request

Query Params

keyword

string

optional

Search by keyword

Example:

Category Name Ertyjrrj

view

string

optional

Show all data without pagination

Example:

list

sort_order

string

optional

Sort data by:
'id__desc',
'id__asc',
'title__desc',
'title__asc',
'sort__desc',
'sort__asc',
'parent__desc',
'parent__asc',
'status__desc',
'status__asc'

Example:

status__desc

per_page

string

optional

Display the required number on one page

Example:

status

string

optional

0 or 1

Example:

page

string

optional

The page number you want to go to

Example:

Header Params

apikey

string

required

You must contact support to get the apikey.

Example:

5f28583f26a1a

lang

string

required

ar => Arabic or en => English

Example:

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

Body Params application/json

object {0}

Examples

Responses

🟢200All Categories

application/json

Body

status

boolean

required

message

string

required

data

object

required

current_page

integer

required

data

array [object {9}]

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