Pimberly Related Product Tool

The Pimberly Related Product Tool lets you quickly discover products that are related to a specific product in your Pimberly catalog. Just enter the product reference number, choose the attribute that holds the related products, and the tool will fetch the details you need.

How it Works

When you run the tool, it talks to the Pimberly API. It sends the product reference number you provided and asks the API for any products that are linked through the chosen attribute. The API returns a list of related products, and the tool packages each one into a Data object that you can use elsewhere in your workflow. If you need the tool itself to be reused in other parts of your automation, the component also builds a BaseTool that can be called by other tools or agents.

Credential

This component requires a Pimberly API credential.

Go to the Credentials section of Nappai and create a new credential of type Pimberly API.
Enter your Pimberly API Key.
In the component, select the credential you just created from the Credential dropdown.

Inputs

Product Reference Nr.: The unique reference number of the product you want to find related items for.
Related Product Attribute in Pimberly: The name of the attribute in Pimberly that stores the related products (default is “Related products”).
Related Product Attribute Details in Pimberly: A comma‑separated list of the product fields you want returned for each related item.
Example default value:
```
Primary ID,Title,Serie,Amount,Currency,Compatibility,Series Compatibility
```

Outputs

Data: A list of Data objects, each containing the details of one related product.
Tool: A reusable BaseTool that can be invoked by other components or agents to perform the same lookup.

Usage Example

Add the component to your dashboard.
Select the Pimberly API credential you created earlier.
Enter the product reference number (e.g., 12345).
Leave the other fields at their defaults unless you need a different attribute or set of details.
Run the component.
The Data output will contain all related products, which you can feed into a table, send to another tool, or use in a report.

Pimberly Product Search Tool – Search for products by keyword or ID.
Pimberly Product Update Tool – Update product information in Pimberly.
Pimberly Inventory Check Tool – Retrieve current stock levels for a product.

Tips and Best Practices

Double‑check the product reference number; a typo will return no results.
Use the default attribute “Related products” unless your Pimberly setup uses a custom field.
Keep the attribute details list concise to avoid long API responses.
Store the credential securely; never expose the API key in public workflows.

Security Considerations

The Pimberly API key is stored as a secret credential.
Ensure that only trusted users have access to the credential in Nappai.
The tool does not log or expose the API key during execution.