POST /api/banner HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "title": "Summer Sale",
  "name": "Summer Sale",
  "widgetTitle": "Featured Products",
  "widgetSlugName": "featured-products",
  "link": "/offers/summer",
  "sortOrder": 1,
  "status": 1,
  "image": "<IMAGE_REFERENCE>"
}

{
  "status": 1,
  "message": "Resource created successfully",
  "data": {
    "bannerId": 1,
    "title": "Summer Sale",
    "image": "/images/banner.jpg",
    "status": 1
  }
}

{
  "status": 0,
  "message": "Invalid request or resource."
}

Banners and widgets

Create or process Banner

Post /api/banner

Authentication: Vendor bearer token required for protected operations; verify exact permission decorator in controller.

Feature area: Banners

Implementation source: src/api/vendor/controllers/BannerController.ts

Request example provenance: Illustrative body using common Banner/Widget fields; confirm the route-specific request DTO.

Response example provenance: Illustrative response envelope only. This route inventory does not include its route-specific @apiSuccessExample; response fields and messages must be verified in the matching controller/service. The example is intended to show the common response-wrapper style, not to define a guaranteed response schema.

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.

POST

api

banner

POST /api/banner HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>
Content-Type: application/json

{
  "title": "Summer Sale",
  "name": "Summer Sale",
  "widgetTitle": "Featured Products",
  "widgetSlugName": "featured-products",
  "link": "/offers/summer",
  "sortOrder": 1,
  "status": 1,
  "image": "<IMAGE_REFERENCE>"
}

{
  "status": 1,
  "message": "Resource created successfully",
  "data": {
    "bannerId": 1,
    "title": "Summer Sale",
    "image": "/images/banner.jpg",
    "status": 1
  }
}

{
  "status": 0,
  "message": "Invalid request or resource."
}

Authorizations

Authorization

string

header

required

Paste the JWT access token returned by the corresponding login endpoint.

Body

application/json

Sample request body. Illustrative body using common Banner/Widget fields; confirm the route-specific request DTO. Treat this as an illustrative example, not a complete DTO contract.

title

string

name

string

link

string

sortOrder

integer

status

integer

image

string

Response

Successful response. Illustrative response envelope only. This route inventory does not include its route-specific @apiSuccessExample; response fields and messages must be verified in the matching controller/service. The example is intended to show the common response-wrapper style, not to define a guaranteed response schema. Example is illustrative and does not guarantee a stable response contract.

status

integer

message

string

data

object

Show child attributes

Store API

Vendor API

Create or process Banner

Authorizations

Body

Response