Skip to main content

Favorite

The My Favorites API allows users to manage their favorite items within your application. This endpoint enables users to add, remove, or retrieve their favorite items. By utilizing this API, users can easily track and manage the items they enjoy the most.

Get My Favorite Products​

Retrieve My Favorite API allows users to retrieve their favorite items.

  • Endpoint: api/customer/products/favourites

  • Http Method: GET

  • Success Response:

Products Resource

You can check more details about Products Resource.

{
    "code": 200,
    "message": "Success",
    "data": [
        {
            "id": 90396,
            "parent_id": 90395,
            "sku": "OF 2004_Brown",
            "name": "Omknee 2 Brown",
            "name_en": "Omknee 2 Brown",
            "name_ar": "أومني 2 بني",
            // ...
        }
    ]
}
info

Check the following section to learn more about the Get My Favorite Products API Reference

Add Product to My Favorite​

Add My Favorite API allows users to add their favorite items.

  • Endpoint: api/customer/products/favourite/{product_id}

  • Http Method: POST

  • Url Parameters:

    • product_id (required): The unique identifier of the product.

  • Success Response:

Products Resource

You can check more details about Products Resource.

{
    "code": 200,
    "message": "Success",
    "data": [
        {
            "id": 90396,
            "parent_id": 90395,
            "sku": "OF 2004_Brown",
            "name": "Omknee 2 Brown",
            "name_en": "Omknee 2 Brown",
            "name_ar": "أومني 2 بني",
            // ...
        }
    ]
}
info

Check the following section to learn more about the Add item to Favorite API Reference

Add Bulk Product to Favorite​

The "Add Multiple Items to Favorites" API allows users to efficiently add a collection of items to their favorites list.

  • Endpoint: api/customer/products/add_products_favourite

  • Http Method: POST

  • Request Body:

    • product_ids: An array of product ids.
{
    "product_ids": [90396, 90397, 90398]
}
  • Success Response:
Products Resource

You can check more details about Products Resource.

{
    "code": 200,
    "message": "Success",
    "data": [
        {
            "id": 90396,
            "parent_id": 90395,
            "sku": "OF 2004_Brown",
            "name": "Omknee 2 Brown",
            "name_en": "Omknee 2 Brown",
            "name_ar": "أومني 2 بني",
            // ...
        }
    ]
}
info

Check the following section to learn more about the Add Bulk Product to Favorite API Reference

Remove Product from My Favorite​

This endpoint enables users to unfavorite or remove specific items from their favorites list.

  • Endpoint: api/customer/products/unfavourite/{product_id}

  • Http Method: POST

  • Url Parameters:

    • product_id (required): The unique identifier of the product.

  • Success Response:

Products Resource

You can check more details about Products Resource.

{
    "code": 200,
    "message": "Success",
    "data": [
        {
            "id": 90396,
            "parent_id": 90395,
            "sku": "OF 2004_Brown",
            "name": "Omknee 2 Brown",
            "name_en": "Omknee 2 Brown",
            "name_ar": "أومني 2 بني",
            // ...
        }
    ]
}
info

Check the following section to learn more about the Remove Item from My Favorite API Reference

Remove bulk Product from favorite list​

This endpoint enables users to unfavorite or remove all items from their favorites list.

  • Endpoint: api/customer/products/remove_favourites

  • Http Method: POST

  • Success Response:

{
    "code": 200,
    "message": "Success",
    "data": [],
    "meta": []
}
info

Check the following section to learn more about the Remove bulk Product from favorite API Reference