Product Features API - Venddor API

Product Features Endpoints

The Product Features API allows you to manage product characteristics and specifications in the Venddor platform. This documentation outlines the available endpoints and their supported HTTP methods.

Base URL: https://www.venddor.com.br/api

Available Endpoints

GET POST /features

This endpoint allows you to retrieve all product features or create a new feature.

Supported Methods

Method	Description	Usage
GET	Retrieve all product features	Returns a list of all available product features
POST	Create a new product feature	Requires a JSON body with feature details

Create Example

List Response

{
  "feature_name": "Storage Capacity",
  "description": "Available storage space on the device",
  "feature_type": "S",
  "categories_ids": [16, 18],
  "display_on_product": true,
  "display_on_catalog": true,
  "display_on_header": false,
  "position": 10,
  "prefix": "",
  "suffix": "GB",
  "variants": [
    "64",
    "128",
    "256",
    "512",
    "1024"
  ],
  "status": "A"
}

{
  "features": [
    {
      "feature_id": 21,
      "feature_name": "Storage Capacity",
      "description": "Available storage space on the device",
      "feature_type": "S",
      "position": 10,
      "suffix": "GB",
      "status": "A"
    },
    {
      "feature_id": 22,
      "feature_name": "Color",
      "description": "Product color options",
      "feature_type": "M",
      "position": 20,
      "status": "A"
    },
    {
      "feature_id": 23,
      "feature_name": "Waterproof",
      "description": "Water resistance capability",
      "feature_type": "C",
      "position": 30,
      "status": "A"
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 3
  }
}

GET PUT DELETE /features/:id

This endpoint allows you to work with a specific product feature identified by its ID.

Path Parameters

Parameter	Type	Description
id*	integer	The unique identifier of the product feature

Supported Methods

Method	Description	Usage
GET	Retrieve a specific product feature	Returns detailed information about the specified feature
PUT	Update a product feature	Requires a JSON body with fields to update
DELETE	Delete a product feature	Permanently removes the feature from the system

Important: Deleting a product feature will also remove all associated product-feature values. This action cannot be undone.

Detail Response

Update Example

{
  "feature_id": 21,
  "feature_name": "Storage Capacity",
  "description": "Available storage space on the device",
  "feature_type": "S",
  "categories_ids": [16, 18],
  "display_on_product": true,
  "display_on_catalog": true,
  "display_on_header": false,
  "position": 10,
  "prefix": "",
  "suffix": "GB",
  "variants": [
    "64",
    "128",
    "256",
    "512",
    "1024"
  ],
  "status": "A",
  "timestamp": "2025-04-15T10:15:30Z"
}

{
  "variants": [
    "64",
    "128",
    "256",
    "512",
    "1024",
    "2048"
  ],
  "display_on_header": true,
  "position": 5
}

GET /products/:id/features

This endpoint allows you to retrieve all features associated with a specific product.

Path Parameters

Parameter	Type	Description
id*	integer	The unique identifier of the product

{
  "product_id": 143,
  "product": "Premium Wireless Headphones",
  "features": [
    {
      "feature_id": 22,
      "feature_name": "Color",
      "value": "Black",
      "variant_id": 0
    },
    {
      "feature_id": 24,
      "feature_name": "Battery Life",
      "value": "24",
      "variant_id": 0,
      "suffix": "hours"
    },
    {
      "feature_id": 23,
      "feature_name": "Waterproof",
      "value": "Y",
      "variant_id": 0
    }
  ]
}

Tip: You can filter product features by using the type query parameter to retrieve features of a specific type. For example, /products/143/features?type=S will return only selectable features.

Feature Types

Type Code	Description
`S`	Selectable - Feature with predefined variants that the user can select from (e.g., storage capacity)
`M`	Multiple Select - Feature that allows selecting multiple values (e.g., compatible devices)
`C`	Checkbox - Feature with a yes/no (true/false) value (e.g., waterproof, wireless)
`T`	Text - Feature with free-form text value (e.g., description, model number)
`N`	Number - Feature with a numeric value that may have a prefix or suffix (e.g., weight, dimensions)
`D`	Date - Feature with a date value (e.g., release date, warranty expiration)

Display Options

Product features have multiple display options that control where and how they appear on your store:

Display Option	Description
`display_on_product`	Feature is displayed on the product details page
`display_on_catalog`	Feature is displayed in product listings and catalog views
`display_on_header`	Feature is highlighted in the product header section
`filter_in_search`	Feature can be used as a filter in product search results

Note: When creating selectable features with the type S, you must include the variants array with all possible values. These values will be available for selection when assigning the feature to products.