Octave icon

Octave

Interact with the Octave V2 API

Overview

This node interacts with the Octave V2 API to retrieve detailed information about a specific product identified by its unique OId. It is useful in scenarios where you need to fetch product data dynamically within an automation workflow, such as enriching customer records with product details, integrating product info into marketing campaigns, or syncing product data between systems.

For example, you might use this node to get the full details of a product when a new order is placed, enabling downstream nodes to process or analyze the product information further.

Properties

Name Meaning
Product OID The unique identifier (OId) of the product to retrieve

Output

The node outputs JSON data representing the retrieved product's details from the Octave API. This typically includes all relevant fields describing the product, such as name, description, pricing, attributes, and other metadata as provided by the API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Octave V2 API.
  • The node depends on the Octave API service being accessible and the provided product OId being valid.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Invalid or missing Product OId will cause the API call to fail.
    • Network connectivity problems can prevent successful API communication.
    • Expired or incorrect API credentials will result in authentication errors.
  • Error messages:

    • Errors returned from the API are captured and included in the output under an error field.
    • If the API response body cannot be parsed as JSON, a parse error message is added.
    • To resolve errors, verify the correctness of the Product OId, ensure valid API credentials, and check network connectivity.

Links and References

Discussion