Skip to content
Nappai Documentation

Pimberly Product Tool

The Pimberly Product Tool lets you look up detailed information about a product in the Pimberly catalog.
Just give it a product reference number and choose which product attributes you want to retrieve, and it will return the data you need.

How it Works

When you run the component, it talks to the Pimberly API.

  1. It takes the Product Reference Nr. you entered.
  2. It sends a request to the Pimberly service asking for that product’s details.
  3. You can tell the tool which attributes to include (like title, price, dimensions, etc.) by listing them in the Related Product Attribute Details in Pimberly field.
  4. The tool returns the requested data as a Data object that can be used by other components in your workflow.
  5. It also builds a Tool object that can be passed to language‑model components if you want the model to call the API directly.

The component uses a credential you set up in Nappai, so your API key stays safe and never appears in the workflow.

Inputs

This component requires a Pimberly API credential.

  1. First, create the credential in Nappai’s Credentials section.
  2. Then, in the component’s Credential field, select the credential you just created.

Input Fields

  • Product Reference Nr.: The unique reference number of the product you want to look up.
  • Related Product Attribute Details in Pimberly: A comma‑separated list of the product attributes you want returned.
    • Default value (example): 
      Primary ID,Categorisation,Title,Serie,Series Compatibility,Special Amount,Short Description,Amount,Currency,Base Quantity Condition,Measure Unit Condition,Origin Country,ST Length,ST Width,ST Height,ST Volume,ST Net Weight,ST Gross Weight,ST Weight Unit,ZCE Length,ZCE Width,ZCE Height,ZCE Unit,ZCE Volume,ZCE Volume Unit,ZCE Net Weight,ZCE Gross Weight,ZCE Weight Unit,Operating environment,Remarks,Cable section admitted (mm),Connector type,Electricity metre,Frequency (Hz),Intensity (A),IP Rating,Operating temperature range (ºC),Product parameter adjustment / display,Sales lines,SEO description,URL Website

Outputs

  • Data: The product information returned from the Pimberly API.
  • Tool: A reusable tool object that can be passed to language‑model components for dynamic API calls.

Usage Example

  1. Add the component to your workflow.
  2. Select the Pimberly API credential in the Credential field.
  3. Enter a product reference number (e.g., 12345).
  4. Leave the attribute list as the default or modify it to include only the fields you need.
  5. Run the workflow.
  6. The Data output will contain a JSON object with the requested product details, which you can feed into a display component or further processing steps.
  • Pimberly Search Tool – Search for products by keyword instead of reference number.
  • Pimberly Inventory Tool – Check stock levels for a product.

Tips and Best Practices

  • Use the default attribute list if you’re unsure; it covers most common fields.
  • Keep the credential in the Credentials section and never share the API key directly in the workflow.
  • If you only need a few attributes, list them explicitly to reduce response size.
  • Combine the Data output with a Table component to display results in a user‑friendly grid.

Security Considerations

  • The API key is stored securely in Nappai’s credential store and is never exposed in the workflow.
  • Ensure that only trusted users have access to the credential to prevent unauthorized API usage.
  • Monitor API usage logs in Pimberly to detect any unusual activity.