ConnectWise Manage icon

ConnectWise Manage

Consume ConnectWise Manage API

Overview

The node integrates with the ConnectWise Manage API to interact with various resources, including the Product Catalog. Specifically, for the Product Catalog - Search operation, it allows users to search and retrieve product catalog items based on a search query and optional ordering criteria.

This node is beneficial in scenarios where you want to automate workflows involving product data retrieval from ConnectWise Manage, such as syncing product information into other systems, filtering products dynamically based on user input, or generating reports on available products.

Example use cases:

  • Searching the product catalog for items matching specific keywords or criteria.
  • Ordering search results by fields like product ID or name.
  • Integrating product data into inventory management or e-commerce platforms.

Properties

Name Meaning
Search Query The search string used to filter product catalog items. This is required for the search.
Order By Field to order the search results by. For example, "id" or "ID desc" to sort descending.

Note: The property "Order By" appears twice in the provided definitions but serves the same purpose — specifying the field and direction to order the results.

Output

The output consists of JSON objects representing product catalog items returned by the ConnectWise Manage API that match the search query and ordering criteria.

Each output item corresponds to one product catalog entry with its associated fields as provided by the API (e.g., productId, name, description, etc.).

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the ConnectWise Manage API via an API key credential configured in n8n.
  • The node uses the base URL from the credential configuration to make authenticated REST API calls.
  • No additional external dependencies are needed beyond the ConnectWise Manage API access.

Troubleshooting

  • Missing or invalid credentials: Ensure the API key credential for ConnectWise Manage is correctly set up and has sufficient permissions to access the product catalog.
  • Invalid search query: The search query parameter is required; omitting it will cause errors.
  • Unsupported operations or resources: Using operations or resources not supported by the node will throw errors indicating unsupported operation/resource.
  • API request failures: Network issues or API rate limits may cause request failures. Check error messages for details and verify connectivity and API usage limits.
  • Ordering field errors: Specifying an invalid field in "Order By" may result in no sorting or API errors. Use valid field names as per ConnectWise Manage API documentation.

Links and References

Discussion