> For the complete documentation index, see [llms.txt](https://docs.spurtcommerce.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spurtcommerce.com/api-reference/vendor/settings/store-settings.md).

# Store Settings

Configure vendor store settings and payment terms.

## Retrieve Settings

> Get /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:\*\* 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.

```json
{"openapi":"3.0.3","info":{"title":"SpurtCommerce Vendor API","version":"6.0.0"},"tags":[{"name":"Store settings","description":"Configure vendor store settings and payment terms."}],"servers":[{"url":"https://api.example.com","description":"Replace with your SpurtCommerce API host. Paths include the /api prefix."}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paste the JWT access token returned by the corresponding login endpoint."}}},"paths":{"/api/vendor-settings":{"get":{"operationId":"getApiVendorSettings","summary":"Retrieve Settings","description":"Get /api/vendor-settings\n\n**Authentication:** Vendor bearer token required for protected operations; verify exact permission decorator in controller.\n\n**Feature area:** Store Settings\n\n**Implementation source:** `src/api/vendor/controllers/SettingController.ts`\n\n**Request example provenance:** Exact API comment example.\n\n**Response example provenance:** Exact API comment example.\n\n> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.","tags":["Store settings"],"responses":{"200":{"description":"Successful response. Exact API comment example.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"vendorId":{"type":"integer"},"storeCurrencyId":{"type":"integer"},"currencyCode":{"type":"string"},"symbolLeft":{"type":"string"},"symbolRight":{"type":"string"}},"additionalProperties":true}},"id":{"type":"integer"}},"additionalProperties":true}}}},"500":{"description":"Error response example. Exact API comment example.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"SpurtCommerce Vendor API","version":"6.0.0"},"tags":[{"name":"Store settings","description":"Configure vendor store settings and payment terms."}],"servers":[{"url":"https://api.example.com","description":"Replace with your SpurtCommerce API host. Paths include the /api prefix."}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paste the JWT access token returned by the corresponding login endpoint."}}},"paths":{"/api/vendor-settings":{"post":{"operationId":"postApiVendorSettings","summary":"Create or process Settings","description":"Post /api/vendor-settings\n\n**Authentication:** Vendor bearer token required for protected operations; verify exact permission decorator in controller.\n\n**Feature area:** Store Settings\n\n**Implementation source:** `src/api/vendor/controllers/SettingController.ts`\n\n**Request example provenance:** Field names are taken from SettingController API documentation; send only fields relevant to the selected setting section.\n\n**Response example provenance:** Exact API comment example.\n\n> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.","tags":["Store settings"],"responses":{"200":{"description":"Successful response. Exact API comment example.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"}},"additionalProperties":true}}}},"400":{"description":"Error response example. Exact API comment example.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"}},"additionalProperties":true}}}}},"requestBody":{"required":false,"description":"Sample request body. Field names are taken from SettingController API documentation; send only fields relevant to the selected setting section.","content":{"application/json":{"schema":{"type":"object","properties":{"settingSection":{"type":"string"},"siteUrl":{"type":"string"},"siteName":{"type":"string"},"businessName":{"type":"string"},"storeOwner":{"type":"string"},"storeEmail":{"type":"string"},"storeTelephone":{"type":"string"},"storeCurrencyId":{"type":"integer"},"storeLanguageId":{"type":"integer"},"maintenanceMode":{"type":"integer"}},"additionalProperties":true}}}}}}}}
```

## 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.

```json
{"openapi":"3.0.3","info":{"title":"SpurtCommerce Vendor API","version":"6.0.0"},"tags":[{"name":"Store settings","description":"Configure vendor store settings and payment terms."}],"servers":[{"url":"https://api.example.com","description":"Replace with your SpurtCommerce API host. Paths include the /api prefix."}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Paste the JWT access token returned by the corresponding login endpoint."}}},"paths":{"/api/vendor-settings/{id}":{"get":{"operationId":"getApiVendorSettingsId","summary":"Retrieve Settings","description":"Get /api/vendor-settings/:id\n\n**Authentication:** Vendor bearer token required for protected operations; verify exact permission decorator in controller.\n\n**Feature area:** Store Settings\n\n**Implementation source:** `src/api/vendor/controllers/SettingController.ts`\n\n**Request example provenance:** Exact API comment example.\n\n**Response example provenance:** Exact API comment example.\n\n> Example is based on the linked repository source. Replace example identifiers and credentials with values from your tenant.","tags":["Store settings"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Value for id."}],"responses":{"200":{"description":"Successful response. Exact API comment example.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"},"data":{"type":"object","properties":{"id":{"type":"integer"},"siteName":{"type":"string"},"storeEmail":{"type":"string"},"currencyCode":{"type":"string"},"symbolLeft":{"type":"string"},"vendor":{"type":"object","properties":{},"additionalProperties":true}},"additionalProperties":true}},"additionalProperties":true}}}},"400":{"description":"Error response example. Exact API comment example.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer"},"message":{"type":"string"}},"additionalProperties":true}}}}}}}}}
```