Settings (admin API)
Admin routes of the settings module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.
GET /v1/admin/settings
Section titled “GET /v1/admin/settings”Get all settings grouped by section
Responses:
200: no description. Body: object.
PATCH /v1/admin/settings
Section titled “PATCH /v1/admin/settings”Update one or more settings
Request body: UpdateSettingsDto.
Responses:
200: no description. Body: object.
GET /v1/admin/settings/locales
Section titled “GET /v1/admin/settings/locales”Get supported locales and default locale
Responses:
200: no description.
PATCH /v1/admin/settings/locales
Section titled “PATCH /v1/admin/settings/locales”Update supported locales and default locale
Request body: UpdateLocalesDto.
Responses:
200: no description.
Schemas
Section titled “Schemas”BaseColorsDto
Section titled “BaseColorsDto”primary(string, required).secondary(string, nullable, required).accent(string, nullable, required).
CurrencyConfigDto
Section titled “CurrencyConfigDto”code(string, pattern^[A-Z]{3}$, required).symbol(string, max length 8, optional).decimalPlaces(number, min 0, max 3, optional).
SettingsTranslatableDto
Section titled “SettingsTranslatableDto”fr(string, optional).en(string, optional).ar(string, optional).default(string, max length 500, required).
UpdateLocalesDto
Section titled “UpdateLocalesDto”supportedLocales(array of string, required).defaultLocale(string, required).rtlLocales(array of string, optional).
UpdateSettingsDto
Section titled “UpdateSettingsDto”storeName(SettingsTranslatableDto, optional).contactEmail(string, optional).phone(string, optional).address(object, optional).socialLinks(object, optional).supportedLocales(array of string, optional).defaultLocale(string, optional).timezone(string, optional).rtlLocales(array of string, optional).brandName(string, pattern^[a-z0-9][a-z0-9-]{0,39}$, optional).description(SettingsTranslatableDto, optional).baseColors(BaseColorsDto, optional).fontKit("arabic-latin","latin-rounded", optional).logoAssetId(string, uuid, nullable, optional).faviconAssetId(string, uuid, nullable, optional).symbolPosition("after","before", optional).decimalSeparator(string, min length 1, max length 1, optional).thousandsSeparator(string, min length 1, max length 1, optional).taxDisplay("HT","TTC","none", optional).vatRate(number, min 0, max 1, optional).storefront(string, optional).admin(string, optional).api(string, optional).currencyConfig(CurrencyConfigDto, optional).guestCheckoutEnabled(boolean, optional).minimumOrderAmount(number, min 0, optional).defaultLowStockThreshold(number, optional).reservationSettings(object, optional).numberPrefix(string, optional).numberFormat(string, optional).cancellationPolicy(object, optional).windowDays(number, optional).requirePhotos(boolean, optional).autoApprove(boolean, optional).defaultHandlingTime(string, optional).cutOffTime(string, optional).pauseAll(boolean, optional).taxRegistrationNumber(string, max length 64, optional).legalName(SettingsTranslatableDto, optional).tradingName(SettingsTranslatableDto, optional).streetAddress(SettingsTranslatableDto, optional).addressLocality(string, max length 120, optional).addressRegion(string, max length 120, optional).postalCode(string, max length 20, optional).addressCountry(string, optional).logoUrl(string, max length 2048, optional).faviconUrl(string, max length 2048, optional).
