avanta icon

avanta

Consume avanta API

Actions57

Company → Deactivate

AI-generated

Overview

This node operation deactivates companies within a specified store group in the Avanta system. It allows users to specify a store group by its ID and optionally whitelist certain external company IDs to remain active while deactivating all others. This is useful for managing company statuses in bulk, such as deactivating companies that are no longer active or relevant within a particular store group.

Use Case Examples

  1. Deactivate all companies in a specific store group except for a few identified by their external IDs.
  2. Use debug mode to troubleshoot API requests during the deactivation process.

Properties

Name Meaning
Request Options Options to customize the API request behavior, including debug mode, SSL certificate validation, and request timeout.
Store Group Name or ID The store group ID to associate with the deactivation. This is required and can be selected from a list or specified dynamically via expressions.
External IDs A whitelist of external company IDs to remain active during the deactivation. Accepts comma-separated values or JSON arrays. Leaving empty skips this filter.

Output

JSON

  • success - Indicates whether the deactivation operation was successful.
  • deactivatedCompanies - List of companies that were deactivated.
  • activeCompanies - List of companies that remained active due to being whitelisted.

Dependencies

  • Avanta API with appropriate credentials

Troubleshooting

  • Ensure the store group ID is valid and accessible; invalid IDs may cause the operation to fail.
  • If using the External IDs whitelist, ensure the format is correct (comma-separated or JSON array). Incorrect formatting may lead to unexpected deactivation results.
  • If SSL issues occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
  • Timeout errors may occur if the server is slow to respond; increase the timeout value if needed.

Discussion