Skip to content
Nappai Documentation

Pimberly API

The Pimberly API component lets you pull a list of products from your Pimberly account directly into your Nappai workflow.
You only need to set a date to filter products that have been updated since then and choose how many results you want to see.

How it Works

When you run the component, it connects to the Pimberly service using the API key you selected in the Credential field.
It then asks Pimberly for all products that were updated after the date you provide (or all products if you leave the date blank).
You can limit the number of products returned with the Max Results setting.
The component returns the data as a list of Data objects that can be used by other components in your workflow.

Inputs

  • Since Date: The date to filter products updated since (e.g., 2023-01-01).
    Leave this blank to retrieve all products.

  • Max Results: The maximum number of results to return.
    Default is 10. Set this higher if you need more products, but be aware that larger numbers may take longer to fetch.

Important: Before using the component, you must first create a Pimberly API credential in the Nappai credentials section and then select that credential in the component’s Credential field.

Outputs

  • Data: A list of Data objects, each representing a product from Pimberly.
    This output can be fed into other components such as filters, transformers, or storage actions.

Usage Example

  1. Create a Pimberly API credential

    • Go to Settings → Credentials and add a new Pimberly API credential.
    • Enter your Pimberly API Key.

  2. Add the Pimberly API component to your workflow

    • Drag the component onto the canvas.
    • In the Credential dropdown, choose the credential you just created.
    • Set Since Date to 2023-01-01.
    • Set Max Results to 20.

  3. Run the workflow

    • The component will fetch up to 20 products updated since January 1, 2023.
    • The resulting Data can be passed to a Table component to display the products, or to a Save to DB component to store them.
  • Pimberly Update Product – Update product details in Pimberly.
  • Pimberly Delete Product – Remove products from Pimberly.
  • Pimberly Create Product – Add new products to Pimberly.

Tips and Best Practices

  • Use the Since Date field to keep the data set small and the workflow fast.
  • If you need all products, leave Since Date empty but consider increasing Max Results carefully to avoid timeouts.
  • Store the API key in a credential rather than typing it directly into the component.
  • Combine this component with a Filter component to narrow results by category or price.

Security Considerations

  • The API key is stored securely in Nappai’s credential store.
  • Never expose the key in logs or output data.
  • Use the credential feature to keep sensitive information out of the workflow design.