GET /api/store-list/banner/position/example HTTP/1.1
Host: <API_HOST>
Accept: application/json

{
  "status": "1",
  "message": "Successfully got banner detail.",
  "data": {
    "bannerId": 1,
    "title": "Summer Sale",
    "link": "/offers/summer",
    "content": "Seasonal offers",
    "position": "home-top",
    "image": "summer-sale.jpg",
    "imagePath": "/media/summer-sale.jpg",
    "isActive": 1,
    "linkType": 1
  }
}

{
  "status": 0,
  "message": "Invalid / Inactive banner position."
}

Navigation and widgets

Get the active Store banner for a named placement.

Authentication: Public; tenant validation applies.

Feature area: Store content

Implementation source: src/api/store/controllers/CommonListController.ts

Request example provenance: Response keys and success/error messages follow the source handler; values are illustrative.

Response example provenance: Response keys and success/error messages follow the source handler; values are illustrative.

Example status: Illustrative. The example is included to demonstrate request/response shape in the reference UI; verify the owning controller and request DTO before using it as a contract.

GET

api

store-list

banner

position

{position}

GET /api/store-list/banner/position/example HTTP/1.1
Host: <API_HOST>
Accept: application/json

{
  "status": "1",
  "message": "Successfully got banner detail.",
  "data": {
    "bannerId": 1,
    "title": "Summer Sale",
    "link": "/offers/summer",
    "content": "Seasonal offers",
    "position": "home-top",
    "image": "summer-sale.jpg",
    "imagePath": "/media/summer-sale.jpg",
    "isActive": 1,
    "linkType": 1
  }
}

{
  "status": 0,
  "message": "Invalid / Inactive banner position."
}

Path Parameters

position

string

required

Value for position.

Response

Successful response. Response keys and success/error messages follow the source handler; values are illustrative. Example is illustrative and does not guarantee a stable response contract.

status

string

message

string

data

object

Show child attributes

Store API

Vendor API

Get the active Store banner for a named placement.

Path Parameters

Response