Filtering - Venddor API

Filtering API Data

You can add URL parameters to your API requests to filter and refine the results returned by the API. This allows you to retrieve only the specific data you need.

Basic Filtering

You can specify filters by adding URL parameters that match object field names and their desired values.

Copycurl --user admin@example.com:APIkey -X GET 'https://www.venddor.com.br/api/products?free_shipping=N'

Combining Multiple Filters

You can combine multiple conditions by adding several URL parameters, separated by the & character.

Copycurl --user admin@example.com:APIkey -X GET 'https://www.venddor.com.br/api/products?is_edp=Y&company_id=1'

Response Format

The API response will contain:

• A JSON array of matching objects under the resource key (e.g., the products key)
• The search query under the search key
• If an error occurs, an error object will be returned instead

Copy{
  "products": {
    "15": {
      "product_id": "15",
      "product": "Product Name",
      "company_id": "1",
      "is_edp": "Y",
      "price": "29.99"
      // Other product fields...
    },
    "22": {
      // Another matching product...
    }
  },
  "search": {
    "is_edp": "Y",
    "company_id": "1"
  }
}