avanta icon

avanta

Consume avanta API

Actions57

Company - Group → Create or Update

AI-generated

Overview

This node handles the creation or updating of a company group within the Avanta API. It is useful for managing organizational structures by grouping companies under a common entity. Typical use cases include automating the setup of company groups in bulk or individually, integrating company group data into workflows, and maintaining consistent company group information across systems.

Use Case Examples

  1. Creating a new company group with a specified name and linking it to a store group.
  2. Updating an existing company group by providing an external ID and modifying its attributes.

Properties

Name Meaning
Request Options Options to customize the API request behavior, including debug mode, SSL certificate validation, and request timeout.
Return to Webhook Whether to return the response directly to a webhook, requiring a subsequent 'Respond to Webhook' node.
Use Bulk API Whether to use the bulk API for processing multiple items in one request.
Dataflow ID Optional override for the dataflow ID, automatically read from webhook input if not set.
Name Name of the company group to create or update.
Store Group Name or ID Select or specify the store group associated with the company group.
External ID External identifier for the company group, used for updates or reference.

Output

JSON

  • id - Unique identifier of the created or updated company group.
  • name - Name of the company group.
  • store_group_id - Identifier of the associated store group.
  • external_id - External ID of the company group, if provided.
  • status - Status of the operation, e.g., success or failure.
  • debugInfo - Optional debug information including API request details if debug mode is enabled.

Dependencies

  • Requires an API key credential for the Avanta API to authenticate requests.

Troubleshooting

  • Ensure the API key credential is correctly configured and has necessary permissions.
  • If using bulk API, verify that the input data format matches the expected structure for bulk operations.
  • Check SSL settings if connection issues occur, especially if 'Ignore SSL Issues' is disabled.
  • Timeout errors may occur if the server is slow to respond; adjust the timeout setting accordingly.

Discussion