Nuvem Solution icon

Nuvem Solution

Interact with Nuvem Solution API

Actions120

Cliente → Get Unidades

AI-generated

Overview

The "Get Unidades" operation under the "Cliente" resource in this node allows users to retrieve a paginated list of measurement units related to customers from the Nuvem Solution API. This operation is useful when you need to fetch standardized units of measure used within customer-related data, such as for inventory, sales, or reporting purposes.

Typical scenarios include:

  • Integrating customer data with external systems that require unit information.
  • Automating reports or dashboards that display customer-related metrics with proper units.
  • Synchronizing measurement units across different platforms or databases.

For example, a user might want to get all measurement units to map them to their internal system's units or to validate incoming data against allowed units.

Properties

Name Meaning
Page Page number for pagination (default: 1)
Page Size Number of items per page (default: 20)

These properties control the pagination of the results returned by the API.

Output

The output is a JSON array containing the list of measurement units retrieved from the API. Each item in the array represents a measurement unit object as defined by the Nuvem Solution API.

The structure typically includes fields describing each unit, such as its identifier, name, abbreviation, and possibly other metadata relevant to measurement units.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authentication with the Nuvem Solution API.
  • The node uses the base URL and credentials (software key, secret, user ID, user key) configured in the node's credentials section.
  • The API endpoint called is /erp/crm/clientes/unidades with query parameters for pagination.

Troubleshooting

  • Authentication errors: If the node fails due to authentication issues, verify that the API key credential is correctly configured and valid.
  • Pagination parameters: Providing invalid values for "Page" or "Page Size" (e.g., negative numbers) may cause errors or unexpected results.
  • API connectivity: Network issues or incorrect base URL configuration can lead to request failures.
  • Unsupported operations: Using this node with a different operation or resource than "getUnidades" under "cliente" will result in errors.

Common error messages:

  • "Authentication failed: Invalid response from server" indicates problems with credentials.
  • "The operation \"getUnidades\" is not supported!" if the operation parameter is incorrect.
  • HTTP errors from the API (e.g., 400, 401, 404) should be checked against API documentation and credentials.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion