All Categories
Testing Env
https://www.testecommerce.vodoerp.com
Testing Env
https://www.testecommerce.vodoerp.com
GET
/{{categories}}
Last modified:2025-04-14 11:55:56
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. | string |
apiconnection | appmobile | Connection type; contact support to obtain. Required | string |
secure-business-key | 140356399db2b2c32f0.25237063 | Business-specific key; contact support for valid values. Required | string |
Key | Value | Description | Type |
---|---|---|---|
page | 3 | Page number for pagination. | string |
keyword | Category Name E | Search by category name or keyword. | string |
view | list | Show all data without pagination if set to list . | string |
sort_order | title__asc | Sort by: id__desc , id__asc , title__desc , etc. | string |
per_page | 10 | Number of categories per page. | string |
status | 0 | Filter by category status (0 or 1). | string |
has_product_ids | 22367,709,708,701 | Show categories containing these product IDs. | string |
list_category_titles_and_ids | (empty) | Display only category titles and IDs. | string |
category_ids | 78,6 | Filter by specific category IDs. (Get from api request {{APP_URL}}/api/v1/ecomm_categories ) | string |
catalog_type | service,purchases | Filter by catalog type. | string |
get_products | (empty) | Include products within each category with pagination. | string |
product_per_page | 10 | Number of products per page. | string |
product_page_39 | 2 | Navigate product pages for category ID 39. | string |
product_page_37 | 3 | Navigate product pages for category ID 37. | string |
not_empty | yes | Show only categories with products. | string |
has_no_service_products | yes | Show categories without service-type products. | string |
product_show_in_mobile | 1 | Show categories with mobile-visible products. | string |
has_product_type | service,manufacturing | Show categories with these product types. | string |
not_has_product_type | service | Exclude categories with these product types. | string |
product_status | 0 | Filter by product status (0 or 1). | string |
Response
{
"status": true,
"message": "",
"data": {
"current_page": 0,
"data": [
{
"id": 0,
"parent": "",
"sort": 0,
"top": 0,
"status": 0,
"type": "",
"image": "",
"title": "",
"descriptions": [
{
"title": ""
}
],
"products": {
"current_page": 0,
"data": [],
"first_page_url": "",
"from": null,
"last_page": 0,
"last_page_url": "",
"links": [
{
"url": null,
"label": "",
"active": true
}
],
"next_page_url": null,
"path": "",
"per_page": 0,
"prev_page_url": null,
"to": null,
"total": 0
}
}
],
"first_page_url": "",
"from": 0,
"last_page": 0,
"last_page_url": "",
"links": [
{
"url": null,
"label": "",
"active": true
}
],
"next_page_url": null,
"path": "",
"per_page": 0,
"prev_page_url": null,
"to": 0,
"total": 0
}
}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://www.testecommerce.vodoerp.com/{{categories}}?page=3&keyword=Category Name E&view=list&sort_order=title__asc&per_page=10&status=0&has_product_ids=22367,709,708,701&list_category_titles_and_ids=&category_ids=78,6&catalog_type=service,purchases&get_products=&product_per_page=10&product_page_39=2&product_page_37=3¬_empty=yes&has_no_service_products=yes&product_show_in_mobile=1&has_product_type=service,manufacturing¬_has_product_type=service&product_status=0' \
--header 'apikey: 5f28583f26a1a' \
--header 'lang: ar' \
--header 'apiconnection: appmobile' \
--header 'secure-business-key: 140356399db2b2c32f0.25237063' \
--header 'Content-Type: application/json' \
--data-raw '{}'
Response Response Example
{
"status": true,
"message": "Categories Data",
"data": {
"current_page": 1,
"data": [
{
"id": 78,
"parent": "",
"sort": 0,
"top": 1,
"status": 1,
"type": "Custom",
"image": "https://ecommerce.vodoglobal.com/data/47/category/1606468643181.jpg",
"title": "تصينع",
"descriptions": [
{
"title": "تصينع"
}
],
"products": {
"current_page": 1,
"data": [],
"first_page_url": "http://localhost:8000/api/v1/ecomm_categories?product_page_78=1",
"from": null,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/v1/ecomm_categories?product_page_78=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://localhost:8000/api/v1/ecomm_categories?product_page_78=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/api/v1/ecomm_categories",
"per_page": 10,
"prev_page_url": null,
"to": null,
"total": 0
}
}
],
"first_page_url": "http://localhost:8000/api/v1/ecomm_categories?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://localhost:8000/api/v1/ecomm_categories?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://localhost:8000/api/v1/ecomm_categories?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "http://localhost:8000/api/v1/ecomm_categories",
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1
}
}
Request
Query Params
page
string
optional
Example:
3
keyword
string
optional
Example:
Category Name E
view
string
optional
Example:
list
sort_order
string
optional
'id__desc',
'id__asc',
'title__desc',
'title__asc',
'sort__desc',
'sort__asc',
'parent__desc',
'parent__asc',
'status__desc',
'status__asc'
Example:
title__asc
per_page
string
optional
Example:
10
status
string
optional
Example:
0
has_product_ids
string
optional
Example:
22367,709,708,701
list_category_titles_and_ids
string
optional
category_ids
string
optional
Example:
78,6
catalog_type
string
optional
Example:
service,purchases
get_products
string
required
product_per_page
string
optional
Example:
10
product_page_39
string
optional
Example:
2
product_page_37
string
optional
Example:
3
not_empty
string
required
Example:
yes
has_no_service_products
string
optional
Example:
yes
product_show_in_mobile
string
required
Example:
1
has_product_type
string
required
Example:
service,manufacturing
not_has_product_type
string
optional
Example:
service
product_status
string
required
Example:
0
Header Params
apikey
string
required
Example:
5f28583f26a1a
lang
string
required
Example:
ar
apiconnection
string
required
Example:
appmobile
secure-business-key
string
required
728106399db2b289783.89154521
2680667168f2f8a68f6.12561200
140356399db2b2c32f0.25237063
96701678e330f31f768.22400604
14807664478836358b0.31329842
Example:
140356399db2b2c32f0.25237063
Body Params application/json