Pimberly API
Pimberly API queries your catalogue in Pimberly, the product information management platform, and returns the products updated since the date you set, with every attribute you have defined in Pimberly for each one.
Use it to keep other systems in sync with your catalogue or to work with the products that have just changed.
When to use it
- Review the changed products every day and notify the marketing team.
- Update in your online store the product pages that changed in Pimberly.
- Have an agent write descriptions or translations for new products.
- Check that updated products have all their mandatory fields filled in.
Configuration
You need a Pimberly API credential with your Pimberly account’s access key. See Credentials.
| Field | What it does |
|---|---|
| Credential (required) | The Pimberly API credential. |
| Since Date | Returns the products updated since this date, for example 2026-01-01. If you leave it empty, it returns those updated in the last week. |
Advanced options
| Field | What it does |
|---|---|
| Max Results | The maximum number of products returned. Default: 10. |
Output
The Data output returns one item per product, with all its attributes as they are in Pimberly. You can connect it to an agent, to a component that writes to another system or to components that transform data.
Example
A cosmetics brand wants to translate, every Monday, the product pages changed during the previous week.
- Add Pimberly API and choose the Pimberly API credential.
- Leave Since Date empty to receive the changes from the last week.
- In the advanced options, raise Max Results to the number of products you usually change in a week.
- Connect the Data output to an agent that translates each product’s description.
- Schedule the flow to run every Monday. See Scheduler.
Related components
- Pimberly Document Loader: to prepare products and their documents as texts for a knowledge base.
- Pimberly Product Tool: to let an agent look up a specific product.