# Home Screen ## Home Page API The Home Screen API is a country-specific endpoint that provides essential data to create a personalized and relevant home screen experience for users in a particular country. It has critical endpoint that provides essential data for the e-commerce application's home or landing page. This API offers information about product categories, product listings, and banner layouts to create an engaging and personalized user experience.

Home page layout

### Endpoint * #### `{{baseurl}}/api/v1/homepage-layout` **Method** * **GET** ### **Request Parameters** * `lang_code` (optional): A two-letter language code (e.g., "en" for English, "es" for Spanish, etc.) to support language-based localization. If provided, the API returns content in the specified language. ### **Request Body** * None ### **Response Format** The API responds with a JSON object containing data related to categories, products, and banners. The data is structured as follows: ```json { "success": true, "data": [ { "id": 144, "order": 1, "type": "Banner", "title": "", "description": "", "layout": 1, "layout_data": [ { "keyword": "saree", "details": [ { "id": 531, "user_id": 3, "original_name": "Artboard 14 copy 3", "name": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/Artboard%2014%20copy%203.png", "extension": "png", "file_type": "image", "file_size": 22862, "status": 1, "created_at": "2023-07-21T07:21:13.000000Z", "updated_at": "2023-07-21T07:21:13.000000Z", "deleted_at": null } ], "is_clickable": true } ] }, { "id": 155, "order": 2, "type": "Category", "title": "Featured category", "description": "click to view", "layout": 1, "layout_data": [ { "id": 60, "parent_id": null, "name": "DESIGN STICKER'S", "banner": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/504-C.jpg", "icon": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/503-A.jpg", "status": 1, "deleted_at": null, "created_at": "2023-07-21T06:52:42.000000Z", "updated_at": "2023-08-04T05:22:07.000000Z", "children_recursive": [ { "id": 49, "parent_id": 60, "name": "BABY", "banner": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/504-C.jpg", "icon": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/505-C.jpg", "status": 1, "deleted_at": null, "created_at": "2023-07-11T19:49:15.000000Z", "updated_at": "2023-08-04T05:22:40.000000Z", "children_recursive": [ { "id": 55, "parent_id": 49, "name": "Cartoons", "banner": 398, "icon": 398, "status": 1, "deleted_at": null, "created_at": "2023-07-11T20:02:19.000000Z", "updated_at": "2023-07-11T20:02:19.000000Z", "children_recursive": [] } ] }, { "id": 76, "parent_id": 60, "name": "LARGE", "banner": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/504-C.jpg", "icon": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/503-A.jpg", "status": 1, "deleted_at": null, "created_at": "2023-08-02T17:44:55.000000Z", "updated_at": "2023-08-04T05:22:52.000000Z", "children_recursive": [] } ] }, { "id": 76, "parent_id": 60, "name": "LARGE", "banner": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/504-C.jpg", "icon": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/503-A.jpg", "status": 1, "deleted_at": null, "created_at": "2023-08-02T17:44:55.000000Z", "updated_at": "2023-08-04T05:22:52.000000Z", "children_recursive": [] } ] }, { "id": 157, "order": 3, "type": "Product", "title": "Featured product", "description": "click to view", "layout": 1, "layout_data": [ { "id": 71, "product_name": "Sticker Lover's Assortment Bundle:", "description": "

Calling all sticker enthusiasts! Our Sticker Lover's Assortment Bundle is a must-have for anyone who adores stickers. This bundle features a curated selection of sticker packs, including nature-themed stickers, cute animals, inspirational quotes, and more. With a variety of styles and designs, you'll have an abundant supply of stickers to decorate your belongings and unleash your creativity.

", "unit": "Pk", "thumbnail": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/617fBzrxFyL._SL1500_.jpg", "gallery": [ "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/81l0I%2BhI1VL._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/61AsAA26ThL._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/61hjRTfHuML._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/71GRLetB7rL._SL1200_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/production_id_5198164%20%282160p%29.mp4" ], "size_chart_upload": null, "min_qty": 3, "max_qty": 0, "is_variant": 0, "discount_start_date": "2023-08-01 00:00:00", "discount_end_date": "2023-08-24 23:59:00", "discount_percentage": 20, "offer_label": "20% off", "single_sku": "bundle-4", "single_mrp_price": 100, "single_offer_price": 50, "in_stock_status": 0, "avg_rating": 0, "total_ratings": 0, "is_bundle": 1, "is_wishlisted": 1 } ] }, { "id": 146, "order": 4, "type": "Banner", "title": "", "description": "", "layout": 2, "layout_data": [ { "keyword": "shoe", "details": [ { "id": 523, "user_id": 3, "original_name": "Artboard 1 copy 2", "name": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/Artboard%201%20copy%202.png", "extension": "png", "file_type": "image", "file_size": 9991, "status": 1, "created_at": "2023-07-21T07:19:40.000000Z", "updated_at": "2023-07-21T07:19:40.000000Z", "deleted_at": null } ], "is_clickable": true } ] }, { "id": 158, "order": 5, "type": "Product", "title": "Featured product", "description": "click to view", "layout": 2, "layout_data": [ { "id": 71, "product_name": "Sticker Lover's Assortment Bundle:", "description": "

Calling all sticker enthusiasts! Our Sticker Lover's Assortment Bundle is a must-have for anyone who adores stickers. This bundle features a curated selection of sticker packs, including nature-themed stickers, cute animals, inspirational quotes, and more. With a variety of styles and designs, you'll have an abundant supply of stickers to decorate your belongings and unleash your creativity.

", "unit": "Pk", "thumbnail": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/617fBzrxFyL._SL1500_.jpg", "gallery": [ "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/81l0I%2BhI1VL._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/61AsAA26ThL._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/61hjRTfHuML._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/71GRLetB7rL._SL1200_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/production_id_5198164%20%282160p%29.mp4" ], "size_chart_upload": null, "min_qty": 3, "max_qty": 0, "is_variant": 0, "discount_start_date": "2023-08-01 00:00:00", "discount_end_date": "2023-08-24 23:59:00", "discount_percentage": 20, "offer_label": "20% off", "single_sku": "bundle-4", "single_mrp_price": 100, "single_offer_price": 50, "in_stock_status": 0, "avg_rating": 0, "total_ratings": 0, "is_bundle": 1, "is_wishlisted": 1 } ] }, { "id": 148, "order": 6, "type": "Banner", "title": "", "description": "", "layout": 3, "layout_data": [ { "keyword": null, "details": [ { "id": 523, "user_id": 3, "original_name": "Artboard 1 copy 2", "name": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/Artboard%201%20copy%202.png", "extension": "png", "file_type": "image", "file_size": 9991, "status": 1, "created_at": "2023-07-21T07:19:40.000000Z", "updated_at": "2023-07-21T07:19:40.000000Z", "deleted_at": null } ], "is_clickable": false } ] }, { "id": 159, "order": 7, "type": "Product", "title": null, "description": null, "layout": 3, "layout_data": [ { "id": 71, "product_name": "Sticker Lover's Assortment Bundle:", "description": "

Calling all sticker enthusiasts! Our Sticker Lover's Assortment Bundle is a must-have for anyone who adores stickers. This bundle features a curated selection of sticker packs, including nature-themed stickers, cute animals, inspirational quotes, and more. With a variety of styles and designs, you'll have an abundant supply of stickers to decorate your belongings and unleash your creativity.

", "unit": "Pk", "thumbnail": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/617fBzrxFyL._SL1500_.jpg", "gallery": [ "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/81l0I%2BhI1VL._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/61AsAA26ThL._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/61hjRTfHuML._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/71GRLetB7rL._SL1200_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/production_id_5198164%20%282160p%29.mp4" ], "size_chart_upload": null, "min_qty": 3, "max_qty": 0, "is_variant": 0, "discount_start_date": "2023-08-01 00:00:00", "discount_end_date": "2023-08-24 23:59:00", "discount_percentage": 20, "offer_label": "20% off", "single_sku": "bundle-4", "single_mrp_price": 100, "single_offer_price": 50, "in_stock_status": 0, "avg_rating": 0, "total_ratings": 0, "is_bundle": 1, "is_wishlisted": 1 } ] }, { "id": 151, "order": 8, "type": "Banner", "title": "", "description": "", "layout": 4, "layout_data": [ { "keyword": null, "details": [ { "id": 530, "user_id": 3, "original_name": "Artboard 14 copy", "name": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/Artboard%2014%20copy.png", "extension": "png", "file_type": "image", "file_size": 11767, "status": 1, "created_at": "2023-07-21T07:21:13.000000Z", "updated_at": "2023-07-21T07:21:13.000000Z", "deleted_at": null } ], "is_clickable": false } ] }, { "id": 160, "order": 9, "type": "Product", "title": null, "description": null, "layout": 4, "layout_data": [ { "id": 71, "product_name": "Sticker Lover's Assortment Bundle:", "description": "

Calling all sticker enthusiasts! Our Sticker Lover's Assortment Bundle is a must-have for anyone who adores stickers. This bundle features a curated selection of sticker packs, including nature-themed stickers, cute animals, inspirational quotes, and more. With a variety of styles and designs, you'll have an abundant supply of stickers to decorate your belongings and unleash your creativity.

", "unit": "Pk", "thumbnail": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/617fBzrxFyL._SL1500_.jpg", "gallery": [ "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/81l0I%2BhI1VL._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/61AsAA26ThL._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/61hjRTfHuML._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/71GRLetB7rL._SL1200_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/production_id_5198164%20%282160p%29.mp4" ], "size_chart_upload": null, "min_qty": 3, "max_qty": 0, "is_variant": 0, "discount_start_date": "2023-08-01 00:00:00", "discount_end_date": "2023-08-24 23:59:00", "discount_percentage": 20, "offer_label": "20% off", "single_sku": "bundle-4", "single_mrp_price": 100, "single_offer_price": 50, "in_stock_status": 0, "avg_rating": 0, "total_ratings": 0, "is_bundle": 1, "is_wishlisted": 1 } ] }, { "id": 161, "order": 10, "type": "Product", "title": null, "description": null, "layout": 5, "layout_data": [ { "id": 71, "product_name": "Sticker Lover's Assortment Bundle:", "description": "

Calling all sticker enthusiasts! Our Sticker Lover's Assortment Bundle is a must-have for anyone who adores stickers. This bundle features a curated selection of sticker packs, including nature-themed stickers, cute animals, inspirational quotes, and more. With a variety of styles and designs, you'll have an abundant supply of stickers to decorate your belongings and unleash your creativity.

", "unit": "Pk", "thumbnail": "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/617fBzrxFyL._SL1500_.jpg", "gallery": [ "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/81l0I%2BhI1VL._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/61AsAA26ThL._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/61hjRTfHuML._SL1500_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/71GRLetB7rL._SL1200_.jpg", "https://majarat-developemt.s3.ap-southeast-1.wasabisys.com/uploads/all/production_id_5198164%20%282160p%29.mp4" ], "size_chart_upload": null, "min_qty": 3, "max_qty": 0, "is_variant": 0, "discount_start_date": "2023-08-01 00:00:00", "discount_end_date": "2023-08-24 23:59:00", "discount_percentage": 20, "offer_label": "20% off", "single_sku": "bundle-4", "single_mrp_price": 100, "single_offer_price": 50, "in_stock_status": 0, "avg_rating": 0, "total_ratings": 0, "is_bundle": 1, "is_wishlisted": 1 } ] } ], "message": "Success", "status_code": 200 } ``` ### **Authorization** The API requires a valid Bearer token in the request headers to authorize the user. ### **Features** * The API provides a list of product categories with their respective names and images. * It offers a variety of product listings in different layouts to showcase products effectively. * The API includes banner layouts to display promotional offers and seasonal sales. * The Home Screen API allows the platform to deliver a country-specific and localized home screen experience to users. ### Usage The Home Page API is used when users visit the home or landing page of the e-commerce application. It fetches the necessary data for rendering the page content dynamically.