Settings

Manage global system configuration and store settings. Control behavior, preferences, and operational parameters across your e-commerce platform.

Basic CRUD Actions

Get Settings listing

View on Postman

Get a list of all configuration settings.

JavaScript

let settings = await Client.API.Core.Settings.all();

TypeScript

import { Response, Settings } from "@tscommerce/sdk-typescript"

Client.API.Core.Settings.all().then((response:Response<Settings>) => {
    response.resource.forEach((setting) => {
        console.log(setting.key, setting.value);
    });
});

PHP

$settings = $client->API->Core->Settings->all();

Get Setting

View on Postman

Get a specific setting value by key.

JavaScript

const settingKey = 'site.name';
let setting = await Client.API.Core.Settings.read(settingKey);

TypeScript

import { Response, Setting } from "@tscommerce/sdk-typescript"

const settingKey:string = 'site.name';
Client.API.Core.Settings.read(settingKey).then((response:Response<Setting>) => {
    console.log('Setting:', response.resource);
});

PHP

$settingKey = 'site.name';
$setting = $client->API->Core->Settings->read($settingKey);

Update Setting

View on Postman

Update a single configuration setting.

JavaScript

const settingKey = 'site.name';
const payload = {
    value: 'My Store'
};
let setting = await Client.API.Core.Settings.update(settingKey, payload);

TypeScript

import { Response, Setting } from "@tscommerce/sdk-typescript"

const settingKey:string = 'site.name';
const payload = {
    value: 'My Store'
};

Client.API.Core.Settings.update(settingKey, payload).then((response:Response<Setting>) => {
    console.log('Updated setting:', response.resource);
});

PHP

$settingKey = 'site.name';
$payload = ['value' => 'My Store'];
$setting = $client->API->Core->Settings->update($settingKey, $payload);

Delete Setting

View on Postman

Delete a configuration setting.

JavaScript

const settingKey = 'custom.setting';
Client.API.Core.Settings.delete(settingKey);

TypeScript

import { Response } from "@tscommerce/sdk-typescript"

const settingKey:string = 'custom.setting';
Client.API.Core.Settings.delete(settingKey).then((response:Response) => {
    console.log('Setting deleted successfully');
});

PHP

$settingKey = 'custom.setting';
$client->API->Core->Settings->delete($settingKey);

Bulk Actions

Bulk update Settings

View on Postman

Update multiple settings at once.

JavaScript

const payload = {
    'site.name': 'My Store',
    'site.email': 'info@mystore.com',
    'site.currency': 'EUR'
};
let settings = await Client.API.Core.Settings.bulkUpdate(payload);

TypeScript

import { Response, Setting, SettingsBulkUpdatePayload } from "@tscommerce/sdk-typescript"

const payload:SettingsBulkUpdatePayload = {
    'site.name': 'My Store',
    'site.email': 'info@mystore.com',
    'site.currency': 'EUR'
};

Client.API.Core.Settings.bulkUpdate(payload).then((response:Response<Setting[]>) => {
    console.log('Settings updated:', response.resource);
});

PHP

$payload = [
    'site.name' => 'My Store',
    'site.email' => 'info@mystore.com',
    'site.currency' => 'EUR'
];
$settings = $client->API->Core->Settings->bulkUpdate($payload);