Conta Azul API icon

Conta Azul API

Allows making requests to the Conta Azul API

Search Products By Filter

AI-generated

Overview

This node operation allows users to search for products in the Conta Azul system using various filters and sorting options. It is useful for scenarios where you need to retrieve a list of products based on criteria such as product name or code, status, pagination, and sorting preferences. For example, you can search for active products sorted by name in ascending order, or retrieve a specific page of product results with a defined page size.

Use Case Examples

  1. Retrieve a list of active products with names containing 'laptop', sorted by sale value in descending order.
  2. Get the second page of products with 20 items per page, filtering only inactive products.

Properties

Name Meaning
Page Page number of the product results to retrieve.
Page Size Number of product items to return per page.
Search (Product) Search term to filter products by name or code.
Sort Direction Direction to sort the product results, either ascending or descending.
Sort Field Field by which to order the product results.
Status Filter products by their status, active or inactive.

Output

JSON

  • id - Unique identifier of the product.
  • name - Name of the product.
  • code - Product code.
  • status - Current status of the product (e.g., active or inactive).
  • saleValue - Sale value or price of the product.
  • description - Description of the product.

Dependencies

  • Conta Azul API with OAuth2 authentication

Troubleshooting

  • Ensure the Conta Azul OAuth2 API credentials are correctly configured and valid to avoid authentication errors.
  • Verify that the filter parameters such as page number, page size, and status are within valid ranges and formats to prevent request errors.
  • If no products are returned, check that the search term and filters match existing products in the Conta Azul system.

Discussion