All Favourites

Description: Retrieves a paginated list of favorite items (e.g., products) marked by an authenticated user. Requires authentication headers (apikey, apiconnection, secure-business-key, userToken). Supports extensive filtering (e.g., by keyword, category, catalog type) and sorting options. The Accept-Language header specifies the response language (en for English). Returns a JSON object with favorite items and pagination metadata, ideal for displaying a user’s saved items in an app or web interface. Fetch a list of user’s favorite items with optional filters.

Headers

Key	Value	Description	Type
`lang`	`en`	Language preference: `ar` for Arabic, `en` for English. Optional	`string`
`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`
`userToken`	`09119b2691afaa567bc1d46c829ebd41193c8545191146cc5df791681a792ad9`	User token from authentication API. `Required` (Get user token from `https://testaccounts.vodoerp.com/api/login` or `https://accounts.vodoerp.com/api/login`) `Required`	`string`

Query Parameters

Key	Value	Description	Type
`page`	`2`	Page number for pagination. Optional	`string`
`keyword`	`Category Name E`	Filter by search term. Optional	`string`
`view`	`list`	`list` for no pagination, empty for paginated. Optional	`string`
`sort_order`	`title__asc`	Sort by: `id__desc`, `title__asc`, etc. Optional	`string`
`per_page`	`10`	Number of items per page. Optional	`string`
`status`	`0`	Filter by item status (e.g., `0`, `1`). Optional	`string`
`not_empty`	`yes`	Exclude empty favorites if `yes`. Optional	`string`
`has_no_service_products`	`yes`	Exclude service-type products if `yes`. Optional	`string`
`has_product_ids`	`22367,709,708,701`	Filter by product IDs (comma-separated). Optional	`string`
`list_category_titles_and_ids`	(empty)	Include category titles and IDs if present. Optional	`string`
`category_ids`	`78,6`	Filter by category IDs (comma-separated). Optional	`string`
`catalog_type`	`service,purchases`	Filter by catalog type (e.g., `service`, `purchases`). Optional	`string`

curl --location -g --request GET 'https://www.testecommerce.vodoerp.com/{{favorites}}?page=&page=2&keyword=Category Name E&view=list&sort_order=title__asc&per_page=10&status=0&not_empty=yes&has_no_service_products=yes&has_product_ids=22367,709,708,701&list_category_titles_and_ids=&category_ids=78,6&catalog_type=service,purchases' \ --header 'Accept-Language: en' \ --header 'apikey: 5f28583f26a1a' \ --header 'apiconnection: appmobile' \ --header 'secure-business-key: 4765066450c0bd66325.48403130' \ --header 'userToken: 09119b2691afaa567bc1d46c829ebd41193c8545191146cc5df791681a792ad9' \ --header 'Content-Type: application/json' \ --data-raw '{}'

Request

Query Params

page

array[string]

optional

Example:

["","2"]

keyword

string

optional

Example:

Category Name E

view

string

optional

'list' or ''

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:

status

string

optional

Example:

not_empty

string

optional

Example:

yes

has_no_service_products

string

optional

Example:

yes

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

service,purchases

Example:

service,purchases

Header Params

Accept-Language

string

required

Example:

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

userToken

string

required

Get user token from
https://testaccounts.vodoerp.com/api/login
or
https://accounts.vodoerp.com/api/login

Example:

09119b2691afaa567bc1d46c829ebd41193c8545191146cc5df791681a792ad9

Body Params application/json

object {0}

Examples

Request

Responses