Products API - Venddor API

Products Endpoints

The Products API allows you to manage product listings 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 /products

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

Supported Methods

Method	Description	Usage
GET	Retrieve all products	Use pagination parameters to limit results. See Pagination section for details.
POST	Create a new product	Requires a JSON body with product details.

Create Example

List Response

{
  "product": "Premium Wireless Headphones",
  "category_ids": [16, 42],
  "price": 199.99,
  "list_price": 249.99,
  "status": "A",
  "description": "High-quality wireless headphones with noise cancellation and premium sound",
  "short_description": "Premium Bluetooth headphones",
  "meta_keywords": "headphones, wireless, bluetooth, premium, audio",
  "meta_description": "Experience crystal-clear sound with our premium wireless headphones",
  "quantity": 100,
  "weight": 0.35,
  "dimensions": {
    "length": 8.5,
    "width": 7.2,
    "height": 3.8
  },
  "tax_ids": [1],
  "shipping_freight": 0,
  "low_stock_alert": 10
}

{
  "products": [
    {
      "product_id": 143,
      "product": "Premium Wireless Headphones",
      "price": 199.99,
      "list_price": 249.99,
      "status": "A",
      "category_ids": [16, 42],
      "quantity": 98,
      "average_rating": 4.7
    },
    {
      "product_id": 144,
      "product": "Ultra HD Smart TV",
      "price": 899.99,
      "list_price": 1099.99,
      "status": "A",
      "category_ids": [16],
      "quantity": 25,
      "average_rating": 4.5
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 248
  }
}

GET PUT DELETE /products/:id

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

Path Parameters

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

Supported Methods

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

Tip: When updating a product, you only need to include the fields you want to change. Other fields will retain their current values.

GET /categories/:id/products

This endpoint allows you to retrieve all products assigned to a specific category.

Path Parameters

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

Note: You can filter products by additional parameters such as status, price_from, price_to, and q (search term) using query parameters.

GET /categories/:id/products/:id

This endpoint allows you to retrieve details about a specific product within a specific category.

Path Parameters

Parameter	Type	Description
category_id*	integer	The unique identifier of the category
product_id*	integer	The unique identifier of the product

Important: This endpoint will return a 404 error if the product exists but is not assigned to the specified category.

Product Status Codes

Status Code	Description
`A`	Active - Product is visible and available for purchase
`H`	Hidden - Product exists but is not visible to customers
`D`	Disabled - Product is temporarily disabled
`O`	Out of Stock - Product is visible but cannot be purchased

Performance Tip: When retrieving products, use the fields parameter to specify only the fields you need. This can significantly improve API response times for large product catalogs.