Settings Fields Reference

Settings Fields Overview

A setting in the Venddor API has various properties represented by fields. This document provides a comprehensive list of all supported fields, along with their descriptions and supported data types.

Important: Mandatory fields are marked with a * symbol. Any field not listed in the table below will be ignored if included in an API request.

Settings Fields

The following table lists all available fields for setting objects:

Field Name Description Supported Values
name* Setting name string
description Setting description string
object_id Setting ID integer
section_id ID of the parent section Valid section ID
section_tab_id ID of the parent tab Valid tab ID
value Setting value Depends on the setting type
edition_type Edition type PRO:ROOT
ULT:ROOT
ULT:VENDOR
MVE:ROOT
MVE:VENDOR
ROOT
VENDOR
handler Name of the PHP function that generates setting variants string
is_global Flag, defines whether the setting is global Y
N
object_type Setting type —
position Setting position in the settings list integer
section_name Parent section name —
section_tab_name Parent tab name —
tooltip Tooltip string
type* Setting type I - input
T - textarea
R - radiogroup
S - selectbox
P - password
C - checkbox
M - multiple select
N - multiple checkboxes
X - countries list
W - states list
F - file
O - info
H - header
B - selectable box
E - template
Z - permanent template
D - hidden
variants Setting variants List of possible setting values

Example Setting Request

{
  "name": "items_per_page",
  "description": "Number of items to display per page",
  "type": "I",
  "value": "20",
  "section_id": 15,
  "position": 30,
  "tooltip": "Controls the number of items shown on catalog and search pages",
  "is_global": "Y"
}

API Endpoints for Settings

GET /settings

Retrieves a list of all settings.

GET /settings/{id}

Retrieves a specific setting by its ID.

PUT /settings/{id}

Updates a specific setting with the provided information.

Warning: Be careful when updating system settings as they can affect the core functionality of your store. Always test changes in a staging environment first.
Tip: Use the section_id parameter to organize related settings together in the admin interface.
Copyright © . Venddor Tecnologia S.A. All rights reserved.