All Showroom Categories

Description: Retrieves a paginated list of all showroom categories in the e-commerce system. Supports filtering by keyword and sorting options to organize results. Requires authentication headers (apikey, apiconnection, secure-business-key). Returns a JSON object with category details and pagination metadata. Fetch a list of showroom categories 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`

Query Parameters

Key	Value	Description	Type
`keyword`	(empty)	Filter by search term. Optional	`string`
`view`	`list`	Show all data without pagination. Optional	`string`
`sort_order`	`parent__desc`	Sort by: `id__desc`, `id__asc`, `title__desc`, etc. Optional	`string`
`per_page`	`10`	Number of items per page. Optional	`string`
`page`	`2`	Page number for pagination. Optional	`string`

curl --location --request GET 'https://www.testecommerce.vodoerp.com/api/v1/showroom-categories?keyword=&view=list&sort_order=parent__desc&per_page=10&page=2' \ --header 'apikey: 5f28583f26a1a' \ --header 'apiconnection: appmobile' \ --header 'secure-business-key: 4765066450c0bd66325.48403130' \ --header 'Content-Type: application/json' \ --data-raw '{}'

{"status":true,"message":"Showroom Categories Data","data":{"current_page":1,"data":[{"id":7,"name":"الرياض العاشر"},{"id":6,"name":"الرياض السادس"},{"id":5,"name":"الرياض السادس"},{"id":1,"name":"الرياض الخامس"}],"first_page_url":"http://127.0.0.1:8000/api/v1/showroom-categories?page=1","from":1,"last_page":1,"last_page_url":"http://127.0.0.1:8000/api/v1/showroom-categories?page=1","links":[{"url":null,"label":"« Previous","active":false},{"url":"http://127.0.0.1:8000/api/v1/showroom-categories?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"next_page_url":null,"path":"http://127.0.0.1:8000/api/v1/showroom-categories","per_page":10,"prev_page_url":null,"to":4,"total":4}}

Request

Query Params

keyword

string

optional

Search by keyword

view

string

optional

Show all data without pagination

Example:

list

sort_order

string

optional

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

Example:

parent__desc

per_page

string

optional

Display the required number on one page

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

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

All Showroom Categories

Request

Responses