avanta icon

avanta

Consume avanta API

Actions57

Company - Restrict → Create or Update

AI-generated

Overview

This node handles the creation or updating of company restrictions within the Avanta API. It is useful for managing access or restrictions related to specific companies, products, or store groups in a business context. For example, it can be used to restrict a product SKU for a particular company customer ID within a store group, optionally locking the restriction from editing.

Use Case Examples

  1. Creating a restriction for a product SKU for a specific company customer ID and store group.
  2. Updating an existing restriction to lock editing for compliance purposes.

Properties

Name Meaning
Request Options Options to customize the API request such as enabling debug mode, ignoring SSL issues, and setting a timeout.
Return to Webhook Whether to return the response to a webhook, requiring a 'Respond to Webhook' node after this node.
Use Bulk API Whether to use the bulk API for processing multiple items.
Dataflow ID Optional override for the dataflow ID, automatically read from webhook input if not set.
Company Customer ID The company customer ID for the restriction.
Store Group ID The store group ID to identify the correct company.
Product SKU The product SKU to restrict.
Edit Lock Whether to lock editing of this restriction.

Output

JSON

  • response - The API response data from creating or updating the company restriction.
  • debugInfo - Optional debug information including API request details if debug mode is enabled.

Dependencies

  • Avanta API with appropriate credentials

Troubleshooting

  • Ensure the company customer ID, store group ID, and product SKU are correctly provided as they are required fields.
  • If using the bulk API, verify that the dataflow ID is correctly set or available in the webhook input data.
  • 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 setting if needed.

Discussion