avanta icon

avanta

Consume avanta API

Actions8

Overview

This node integrates with the Avanta API to create or update company address records. It is designed to manage addresses associated with companies, such as billing or shipping addresses, within a business context. Typical use cases include automating the addition of new company addresses or updating existing ones in bulk or individually, which is useful for CRM systems, ERP integrations, or e-commerce platforms managing multiple company locations.

For example, you might use this node to:

  • Add a new shipping address for a customer company.
  • Update the billing address details for an existing company.
  • Bulk upload multiple company addresses to keep your database synchronized with external systems.

Properties

Name Meaning
Return to Webhook Boolean flag indicating whether the node should return its response directly to a webhook. Requires a subsequent 'Respond to Webhook' node to handle the response.
Use Bulk API Boolean option (only for Create operation) to choose whether to use the bulk API endpoint for creating multiple addresses at once.
Company Customer ID String identifier for the customer company to which the address belongs.
Company Store Group ID Selectable option representing the store group associated with the company address. Options are dynamically loaded from available store groups.
External Address ID String identifier for the address used externally, allowing synchronization with other systems.
Additional Fields A collection of optional fields to provide more detailed address information:
- Address Type Option to specify if the address is for Billing (1) or Shipping (2).
- City City name as a string.
- Company Company name as a string.
- Country Name or ID Selectable country by name or ID, dynamically loaded from available countries.
- Default Option to mark the address as default (Yes/No).
- Read Only Option to mark the address as read-only (Yes/No).
- Postcode Postal code as a string.
- Region Region or state identifier as a string.
- Street Street address as a string.
- Telephone Telephone number as a string.
- Vat ID VAT identification number as a string.
- Extension Attributes A fixed collection allowing multiple extension attributes to be added, each consisting of an attribute code (dynamically loaded options) and a corresponding value string.

Output

The node outputs JSON data representing the result of the create or update operation on the company address resource. This typically includes the newly created or updated address details as returned by the Avanta API.

If binary data were involved (not indicated here), it would represent files or attachments related to the address, but this node focuses on JSON structured data only.

Dependencies

  • Requires an API key credential for authenticating with the Avanta API.
  • The node depends on dynamic loading methods to populate options for store groups, countries, and extension attributes.
  • Proper configuration of these credentials and access permissions is necessary for successful API communication.

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Incorrect or missing required fields like company_customer_id may lead to API errors.
    • Using the bulk API option without proper data formatting can cause request failures.
    • Dynamic option loading may fail if the API endpoints for store groups, countries, or extension attributes are unreachable.

  • Error Messages:

    • Authentication errors usually indicate invalid or expired API keys; verify and update credentials.
    • Validation errors from the API often point to missing mandatory fields or incorrect field formats; ensure all required properties are correctly set.
    • Network or timeout errors suggest connectivity issues; check network settings and API availability.

Links and References

Discussion