Widget

Admin

Widget List

get

Get Widget List

Query parameters

keywordstringOptional

statusinteger · int32Optional

limitinteger · int32Optional

offsetinteger · int32Optional

countinteger · int32Optional

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got widget count"or"Successfully got Widget list

get

/widget

HTTPcURLJavaScriptPython

GET /widget HTTP/1.1
Authorization: text
Accept: */*

200

Success Response

{
  "status": 1,
  "message": "Successfully got widget count\"or\"Successfully got Widget list"
}

To Add Widget

post

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

titlestringOptional

contentstringOptional

widgetLinkTypeinteger · int32Optional

metaTagTitlestringOptional

metaTagDescriptionstringOptional

metaTagKeywordstringOptional

positioninteger · int32Optional

statusinteger · int32Optional

refIdinteger · int32[]Optional

ShowHomePageWidgetinteger · int32Optional

Responses

200

Success Response

application/json

statusintegerOptional

messagestringOptionalDefault: Successfully created a Widget.

400

Error Response

application/json

post

/widget

HTTPcURLJavaScriptPython

POST /widget HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 185

"title='text'&content='text'&widgetLinkType=1&metaTagTitle='text'&metaTagDescription='text'&metaTagKeyword='text'&position=1&status=1&refId=[1]&ShowHomePageWidget=1"

{
  "status": 1,
  "message": "Successfully created a Widget.",
  "data": {
    "createdBy": 1,
    "createdDate": "2026-05-14T08:08:04.030Z",
    "modifiedBy": 1,
    "modifiedDate": "2026-05-14T08:08:04.030Z",
    "id": 1,
    "widgetId": 1,
    "refId": 1
  }
}

To Update Widget

put

Path parameters

idinteger · int32Required

Header parameters

AuthorizationstringRequired

Body

application/x-www-form-urlencoded

titlestringOptional

contentstringOptional

widgetLinkTypeinteger · int32Optional

metaTagTitlestringOptional

metaTagDescriptionstringOptional

metaTagKeywordstringOptional

positioninteger · int32Optional

statusinteger · int32Optional

refIdinteger · int32[]Optional

ShowHomePageWidgetinteger · int32Optional

Responses

200

Success Response

application/json

statusintegerOptional

messagestringOptionalDefault: Successfully updated the widget.

400

Error Response

application/json

put

/widget/{id}

HTTPcURLJavaScriptPython

PUT /widget/{id} HTTP/1.1
Authorization: text
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 185

"title='text'&content='text'&widgetLinkType=1&metaTagTitle='text'&metaTagDescription='text'&metaTagKeyword='text'&position=1&status=1&refId=[1]&ShowHomePageWidget=1"

{
  "status": 1,
  "message": "Successfully updated the widget.",
  "data": {
    "createdBy": 1,
    "createdDate": "2026-05-14T08:08:04.030Z",
    "modifiedBy": 1,
    "modifiedDate": "2026-05-14T08:08:04.030Z",
    "id": 1,
    "widgetId": 1,
    "refId": 1
  }
}

To Delete Widget

delete

Path parameters

idinteger · int32Required

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully deleted.

400

Error Response

*/*

delete

/widget/{id}

HTTPcURLJavaScriptPython

DELETE /widget/{id} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully deleted."
}

Get Widget Count

get

Get Widget count

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got count

get

/widget/widget-count

HTTPcURLJavaScriptPython

GET /widget/widget-count HTTP/1.1
Authorization: text
Accept: */*

200

Success Response

{
  "status": 1,
  "message": "Successfully got count"
}

Get Widget detail

get

Get Widget detail

Query parameters

widgetIdinteger · int32Required

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got widget detail

400

Error Response

*/*

get

/widget/widget-detail

HTTPcURLJavaScriptPython

GET /widget/widget-detail?widgetId=1 HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got widget detail"
}

Get Widget Product List

get

Get All Widget Product List

Query parameters

keywordstringOptional

skustringOptional

priceinteger · int32Optional

statusstringOptional

limitinteger · int32Optional

offsetinteger · int32Optional

countinteger · int32Optional

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got count"or"Successfully got the complete product list.

get

/widget/productlist

HTTPcURLJavaScriptPython

GET /widget/productlist HTTP/1.1
Authorization: text
Accept: */*

200

Success Response

{
  "status": 1,
  "message": "Successfully got count\"or\"Successfully got the complete product list."
}

Store

Widget List

get

Get Widget List

Query parameters

limitinteger · int32Optional

offsetinteger · int32Optional

countinteger · int32Optional

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully get count"or"Successfully got widget list

get

/list/widget-list

HTTPcURLJavaScriptPython

GET /list/widget-list HTTP/1.1
Authorization: text
Accept: */*

200

Success Response

{
  "status": 1,
  "message": "Successfully get count\"or\"Successfully got widget list"
}

Get A Widget Detail

get

Get Widget Detail

Path parameters

widgetIdinteger · int32Required

Query parameters

limitinteger · int32Optional

offsetinteger · int32Optional

countinteger · int32Optional

Header parameters

AuthorizationstringRequired

Responses

200

Success Response

*/*

statusintegerOptional

messagestringOptionalDefault: Successfully got product count"or"Successfully got widget detail

400

Error Response

*/*

get

/list/widget-detail/{widgetId}

HTTPcURLJavaScriptPython

GET /list/widget-detail/{widgetId} HTTP/1.1
Authorization: text
Accept: */*

{
  "status": 1,
  "message": "Successfully got product count\"or\"Successfully got widget detail"
}