انتقل إلى المحتوى الرئيسي

Brands

Get Brands​

The Get Brands API provides a list of brands that are available on an e-commerce website. This list allowing users to quickly navigate to specific brands.

  • Endpoint: api/customer/brands

  • Http Method: GET

  • Query Parameters:

    • page: The page number of the current page.
معلومات

The API provides a paginated list of items and the total count. If you add the "page" query parameter, it sends paginated items. Otherwise, it returns all featured brands, offering flexible data management as needed.

  • Success Response:
KeyTypeDescription
totalIntegerThe total count of items available.
itemsArrayAn array containing brand objects. For more details, refer to the Brand Resource.
200 OK - If the brands is successful
{
    "code": 200,
    "data": {
        "total": 52,
        "items": [
            {
                "id": 8633,
                "name_en": "Xiaomi",
                "name_ar": "شاوميي",
                "image": "https://docapi.supercommerce.io",
                "images": [
                    "https://docapi.supercommerce.io",
                    // ...
                ],
                "has_images": true
            },
            //...
        ]
    }
}
معلومات

Check the following section to learn more about the Brand API Reference

The Get Featured Brands API provides a list of featured brands that are available to displayed on the homepage of the website.

  • Endpoint: api/customer/home/brands

  • Http Method: GET

  • Success Response:

Brands Resource

You can check more details about Brands Resource.

200 OK - If the brands is successful
{
    "code": 200,
    "data": [
        {
            "id": 8633,
            "name_en": "Xiaomi",
            "name_ar": "شاوميي",
            "image": "https://docapi.supercommerce.io",
            "has_images": true
        },
        //...
    ]
}
معلومات

Check the following section to learn more about the Featured Brand API Reference