Managing Settings in Venddor IO

Introduction

Venddor IO offers an extensive system to manage settings for a tailored user experience. Through specific URLs, users can either access all settings or hone in on a particular one. Here's a comprehensive guide to aid you through the process.

Accessing Settings

1. General Settings

To view all the settings, the following endpoint should be accessed:

http://example.com/api/settings

2. Specific Settings

For details about a particular setting, use its unique ID:

http://example.com/api/settings/:id

Both GET and PUT requests are supported for this endpoint.

Pagination in Settings

Pagination parameters assist users in fetching a specific number of settings or a list from a particular page.

• page: Specifies which page of settings to display.
• items_per_page: Determines the number of settings displayed on one page.

Usage Examples

Displaying the 5th page of settings (default is 10 settings per page):

http://example.com/api/settings?page=5

Displaying 20 settings from the first page:

http://example.com/api/settings?items_per_page=20

Displaying 20 settings from the 5th page:

http://example.com/api/settings?page=5&items_per_page=20

Understanding Setting Properties

Each setting in Venddor IO is associated with various properties. Here are the significant fields:

• name*: Denotes the setting's name (string format).
• description: Describes the setting.
• object_id: Provides a unique identifier for the setting.
• section_id: Refers to the ID of the parent section.
• section_tab_id: Represents the ID of the parent tab.
• value: Specifies the value of the setting, which varies based on its type.
• edition_type: Indicates the type of edition the setting belongs to, with several possible values like PRO:ROOT, VENDOR, etc.
• handler: Refers to the PHP function generating setting variants.
• is_global: A flag indicating if the setting is global (Y/N).
• object_type: Represents the setting type.
• position: Specifies the setting's position in the list.
• section_name: Names the parent section.
• section_tab_name: Denotes the parent tab's name.
• tooltip: Provides a tooltip for additional information.
• type*: Describes the type of setting, with various possibilities like input (I), textarea (T), checkbox (C), etc.
• variants: Lists possible values for the setting.