Skip to main content

Section

The Sections API provides access to platform, which allows you to list sections on e-commerce websites. Sections are essentially customizable blocks of content that can be added to a store's homepage.

  • Endpoint: api/customer/home/sections

  • Http Method: GET

info

the configuration of the product_type key impacts the returned results. If the configuration key is set to "main", the API will return the main products available in the home section. If a key is set to "variant", the API will return product variants instead.

If set to main the API shows product grouping with their variants as options under each product card, if set to variant it retrieves products as variants without additional variants.

  • Success Response:
Section Resource

You can check more details about Section Resource.

200 OK - If the sections is successful
{
    "code": 200,
    "data": [
        {
            "id": 44,
            "name_en": "Hot Offers",
            "name_ar": "عروض مميزة",
            "show_title": 1,
            "images": [],
            "image_type": 1,
            "order": 2,
            "type": 5,
            "item_id": 113,
            "products": [
                {
                    "id": 91004,
                    "sku": "110230",
                    "name": "Molped Maxi Thick & Long 6 Pads + 1 Free"
                }
            ]
        },
        {
            "id": 42,
            "name_en": "New Arrivals",
            "name_ar": "أصناف جديدة",
            "show_title": 1,
            "images": [],
            "image_type": 1,
            "order": 4,
            "type": 5,
            "item_id": 83,
            "products": []
        }
    ]
}
info

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