Products

Overview

The Products API allows you to manage the complete lifecycle of products in your Venddor store. You can create, retrieve, update, and delete products, as well as manage related entities such as variations, options, images, and features.

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

Core Product Operations

GET /api/2.0/products

Retrieves a list of products with support for filtering, sorting, and pagination.

GET /api/2.0/products/{product_id}

Retrieves detailed information about a specific product.

POST /api/2.0/products

Creates a new product in the system.

PUT /api/2.0/products/{product_id}

Updates an existing product's information.

DELETE /api/2.0/products/{product_id}

Deletes a product from the system.

Product Structure

Below is the basic structure of a product object:

{
  "product_id": "423",
  "product_code": "LAPTOP-PRO-15",
  "product": "Professional Laptop 15\"",
  "company_id": "1",
  "product_type": "P",  // P - physical, D - digital, S - service
  "status": "A",        // A - active, D - disabled, H - hidden
  "list_price": "1499.99",
  "price": "1299.99",
  "category_ids": ["42", "56"],
  "main_category": "42",
  "tax_ids": ["3"],
  "tracking": "B",      // B - track with options, O - track without options
  "amount": "100",
  "weight": "2.1",
  "length": "14.2",
  "width": "9.8",
  "height": "0.8",
  "shipping_freight": "0",
  "is_edp": "N",        // Y - downloadable product, N - not downloadable
  "edp_shipping": "N",   // Y - requires shipping, N - no shipping
  "unlimited_download": "N",
  "free_shipping": "N",
  "zero_price_action": "R",  // R - require selection, P - allow add to cart
  "product_features": {
    // Features array
  },
  "main_pair": {
    // Main image details
  },
  "image_pairs": {
    // Additional images
  },
  "short_description": "Powerful laptop for professional use",
  "full_description": "Detailed product description...",
  "meta_keywords": "laptop, professional, business",
  "meta_description": "High-performance laptop for business professionals",
  "search_words": "notebook computer laptop business",
  "page_title": "Professional Laptop 15\" - High Performance",
  "options": [
    // Product options array
  ],
  "product_options": [
    // Available options IDs
  ],
  "variation_features": [
    // Variation features
  ]
}

Related API Endpoints

Product Images

GET /api/2.0/products/{product_id}/images

Retrieves all images associated with a product.

POST /api/2.0/products/{product_id}/images

Adds a new image to a product.

Product Features

GET /api/2.0/products/{product_id}/features

Retrieves all features associated with a product.

POST /api/2.0/products/{product_id}/features

Adds a new feature to a product.

Product Options

GET /api/2.0/products/{product_id}/options

Retrieves all options associated with a product.

POST /api/2.0/products/{product_id}/options

Adds a new option to a product.

Note: When creating or updating products with multiple variations and options, consider using a batched approach for better performance. You can create the base product first, then add options, variations, and other elements in subsequent API calls.

Best Practices

Consistent Product Codes - Use a logical, consistent system for product codes
Complete Metadata - Always provide SEO-friendly titles, descriptions, and keywords
Accurate Categorization - Ensure products are properly categorized
Image Optimization - Upload images with appropriate dimensions and compression
Detailed Specifications - Use product features to provide detailed specifications
Inventory Management - Keep track of inventory using the appropriate tracking settings

Tip: Use the search_words field to include alternative terms that customers might use when searching for your product, even if those terms don't appear in the product name or description.