avanta icon

avanta

Consume avanta API

Actions57

Company → Delete

AI-generated

Overview

This node operation deletes a company resource in the Avanta API. It is useful for scenarios where you need to remove company records from the system, such as cleaning up outdated or incorrect company data.

Use Case Examples

  1. Deleting a company by specifying its ID or external IDs to maintain data accuracy.
  2. Removing companies associated with a specific store group to manage organizational changes.

Properties

Name Meaning
Request Options Options to customize the API request behavior, including debug mode, SSL certificate validation, and request timeout settings.
Store Group Name or ID The ID of the store group associated with the company to be deleted. Can be selected from a list or specified via expression.
External IDs Comma-separated or JSON array of external IDs identifying the companies to delete.

Output

JSON

  • success - Indicates whether the delete operation was successful.
  • deletedIds - List of IDs of the companies that were deleted.
  • debugInfo - Optional debug information about the API request if debug mode is enabled.

Dependencies

  • Avanta API with appropriate authentication credentials

Troubleshooting

  • Ensure the provided store group ID or external IDs are correct and exist in the system to avoid deletion failures.
  • If SSL issues occur, consider enabling the option to ignore SSL certificate validation, but be aware of security risks.
  • Timeout errors may occur if the server is slow to respond; increase the timeout value if necessary.
  • Debug mode can help identify request issues by providing detailed API request information in the response.

Discussion