GET /api/vendor-settings/1 HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>

{
  "status": 1,
  "message": "Successfully get vendor settings",
  "data": {
    "id": 1,
    "siteName": "My Store",
    "storeEmail": "vendor@example.com",
    "currencyCode": "USD",
    "symbolLeft": "$",
    "vendor": {}
  }
}

{
  "status": 0,
  "message": "Invalid Setting Id"
}

Store settings

Retrieve Settings

Get /api/vendor-settings/:id

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: Exact API comment example.

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.

GET

api

vendor-settings

{id}

GET /api/vendor-settings/1 HTTP/1.1
Host: <API_HOST>
Accept: application/json
Authorization: Bearer <ACCESS_TOKEN>

{
  "status": 1,
  "message": "Successfully get vendor settings",
  "data": {
    "id": 1,
    "siteName": "My Store",
    "storeEmail": "vendor@example.com",
    "currencyCode": "USD",
    "symbolLeft": "$",
    "vendor": {}
  }
}

{
  "status": 0,
  "message": "Invalid Setting Id"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Value for id.

Response

Successful response. Exact API comment example.

status

integer

message

string

data

object

Show child attributes

Store API

Vendor API

Retrieve Settings

Authorizations

Path Parameters

Response