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

{
  "settingSection": "websites-details",
  "siteUrl": "https://shop.example.com",
  "siteName": "Example Store",
  "businessName": "Example Retail Pvt Ltd",
  "storeOwner": "Store Owner",
  "storeEmail": "support@example.com",
  "storeTelephone": "9876543210",
  "storeCurrencyId": 1,
  "storeLanguageId": 1,
  "maintenanceMode": 0
}

{
  "status": 1,
  "message": "Website details updated successfully."
}

{
  "status": 0,
  "message": "Invalid setting ID."
}

Store settings

Create or process Settings

Post /api/vendor-settings

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

Feature area: Store Settings

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

Request example provenance: Field names are taken from SettingController API documentation; send only fields relevant to the selected setting section.

Response example provenance: Exact API comment example.

Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.

POST

api

vendor-settings

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

{
  "settingSection": "websites-details",
  "siteUrl": "https://shop.example.com",
  "siteName": "Example Store",
  "businessName": "Example Retail Pvt Ltd",
  "storeOwner": "Store Owner",
  "storeEmail": "support@example.com",
  "storeTelephone": "9876543210",
  "storeCurrencyId": 1,
  "storeLanguageId": 1,
  "maintenanceMode": 0
}

{
  "status": 1,
  "message": "Website details updated successfully."
}

{
  "status": 0,
  "message": "Invalid setting ID."
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Sample request body. Field names are taken from SettingController API documentation; send only fields relevant to the selected setting section.

settingSection

string

siteUrl

string

siteName

string

businessName

string

storeOwner

string

storeEmail

string

storeTelephone

string

storeCurrencyId

integer

storeLanguageId

integer

maintenanceMode

integer

Response

Successful response. Exact API comment example.

status

integer

message

string

Store API

Vendor API

Create or process Settings

Authorizations

Body

Response