ADVBOX icon

ADVBOX

Consume Advbox API

Actions14

Overview

This node integrates with the Advbox API to manage customer data. Specifically, the "Customer - Get many" operation allows users to retrieve multiple customer records from the Advbox system based on various filter criteria. This is useful for scenarios where you want to fetch a list of customers matching certain attributes such as name, phone number, location, or creation date range.

Practical examples include:

  • Retrieving all customers created within a specific date range.
  • Filtering customers by city or state for targeted marketing campaigns.
  • Getting customers who have birthdays in the current month for sending greetings or promotions.
  • Paginating through large customer datasets using limit and offset parameters.

Properties

Name Meaning
Name Customer name or part of it. You can use a full name or a partial search term (e.g., a first name or last name).
Phone Customer phone number (e.g., 4899123456 or (48)99123-4567).
Cellphone Customer cellphone number (e.g., 48991234567 or (48)99123-4567).
Identification Customer identification number (CPF/CNPJ).
Document Customer document number.
Email Customer email address.
City Customer city.
State Customer state.
Occupation Customer occupation or profession.
Birthdays Boolean flag to filter customers who have birthdays in the current month.
Created Start Start date for filtering customers by creation date (format: YYYY-MM-DD).
Created End End date for filtering customers by creation date (format: YYYY-MM-DD).
Limit Number of items to return in the response, between 1 and 1000.
Offset Number of items to skip before starting the response (used for pagination).

Output

The output is an array of JSON objects representing customer records that match the specified filters. Each item contains customer details as returned by the Advbox API. The exact fields depend on the API response but typically include identifiers, contact information, and other customer attributes.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Advbox API.
  • The node expects the Advbox API base URL and token to be configured in the credentials.
  • Network access to the Advbox API endpoint is necessary.

Troubleshooting

  • Missing or invalid API token: The node will throw an error if the API token is not provided or invalid. Ensure your credentials are correctly set up with a valid API key.
  • Invalid API URL: If the API base URL is missing or incorrect, requests will fail. Verify the URL in your credentials.
  • Incorrect date formats: Date filters must be in YYYY-MM-DD format. Using other formats may cause the API to reject the request.
  • Pagination issues: Setting limit too high or negative values may cause errors. Use values between 1 and 1000.
  • Empty results: If no customers match the filters, the node returns an empty array. Adjust filters accordingly.
  • API rate limits or downtime: Network or API service issues can cause request failures. Check API status and retry later.

Links and References

Discussion