Settings

System Settings Management

This section allows you to manage system-wide settings through the API. You can retrieve, update, and manage configuration settings that affect the behavior of your store.

GET /api/settings/

Retrieve a list of all available system settings. This endpoint supports filtering and pagination to help you find specific settings.

Usage Examples

GET /api/settings/

GET /api/settings/company_name

Note: Some settings may require administrative privileges to access. Make sure your API key has the appropriate permissions.

PUT /api/settings/{setting_name}/

Update the value of a specific setting.

Request Example

{
  "value": "Venddor Store"
}

Important: Modifying system settings can have wide-ranging effects on your store. Always test changes in a development environment first.

Common Settings

Here are some commonly used settings that can be managed through the API:

Setting Name	Description	Type
`company_name`	Name of your store/company	String
`site_admin_email`	Administrator email address	String
`default_currency`	Default currency code	String
`enable_inventory_tracking`	Enable or disable inventory tracking	Boolean (Y/N)
`mailer_send_method`	Email sending method	String