← Akeneo

Search Products with Akeneo API

Pipedream makes it easy to connect APIs for Akeneo and 2,800+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Search Products with the Akeneo API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Search Products with the Akeneo API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Search Products action
    1. Connect your Akeneo account
    2. Optional- Configure Search
    3. Optional- Select a Scope
    4. Optional- Select a Locale
    5. Optional- Select a Attributes
    6. Optional- Configure Convert Measurements
    7. Optional- Configure With Count
    8. Optional- Configure With Attribute Options
    9. Optional- Configure With Asset Share Links
    10. Optional- Configure With Quality Scores
    11. Optional- Configure With Completeness
    12. Optional- Configure Page
    13. Optional- Configure Limit
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Search Products with Akeneo API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Akeneo
 
Try it
Search Products with Akeneo API on New Submission from Typeform API
Typeform + Akeneo
 
Try it
Search Products with Akeneo API on New Submission (Instant) from Jotform API
Jotform + Akeneo
 
Try it
Search Products with Akeneo API on New Scheduled Tasks from Pipedream API
Pipedream + Akeneo
 
Try it
Search Products with Akeneo API on New Download Counts from npm API
npm + Akeneo
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Search Products on Akeneo
Description:Search products from Akeneo. [See the documentation](https://api.akeneo.com/api-reference.html#get_products)
Version:0.0.1
Key:akeneo-search-products

Code

import akeneo from "../../akeneo.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "akeneo-search-products",
  name: "Search Products",
  description: "Search products from Akeneo. [See the documentation](https://api.akeneo.com/api-reference.html#get_products)",
  version: "0.0.1",
  type: "action",
  props: {
    akeneo,
    search: {
      type: "string",
      label: "Search",
      description: "Filter products, for more details see the [Filters](https://api.akeneo.com/documentation/filter.html) section",
      optional: true,
    },
    scope: {
      propDefinition: [
        akeneo,
        "channelCode",
      ],
      label: "Scope",
      description: "Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the [Filter product values via channel](https://api.akeneo.com/documentation/filter.html#via-channel) section",
      optional: true,
    },
    locales: {
      propDefinition: [
        akeneo,
        "locale",
      ],
      description: "Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the [Filter product values via locale](https://api.akeneo.com/documentation/filter.html#via-locale) section",
      optional: true,
    },
    attributes: {
      propDefinition: [
        akeneo,
        "attribute",
      ],
      label: "Attributes",
      description: "Filter product values to only return those concerning the given attributes, for more details see the [Filter on product values](https://api.akeneo.com/documentation/filter.html#filter-product-values) section",
      optional: true,
    },
    convertMeasurements: {
      type: "boolean",
      label: "Convert Measurements",
      description: "Convert values of measurement attributes to the unit configured in the channel provided by the parameter \"scope\". Therefore, this parameter requires the \"scope\" parameter to be provided.",
      optional: true,
    },
    withCount: {
      type: "boolean",
      label: "With Count",
      description: "Return the count of items in the response. Be careful: on large catalogs, enabling counts can significantly impact performance.",
      optional: true,
    },
    withAttributeOptions: {
      propDefinition: [
        akeneo,
        "withAttributeOptions",
      ],
    },
    withAssetShareLinks: {
      propDefinition: [
        akeneo,
        "withAssetShareLinks",
      ],
    },
    withQualityScores: {
      propDefinition: [
        akeneo,
        "withQualityScores",
      ],
    },
    withCompletenesses: {
      propDefinition: [
        akeneo,
        "withCompletenesses",
      ],
    },
    page: {
      type: "integer",
      label: "Page",
      description: "The page number to return",
      optional: true,
    },
    limit: {
      type: "integer",
      label: "Limit",
      description: "The number of items to return per page",
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.convertMeasurements && !this.scope) {
      throw new ConfigurationError("The `convertMeasurements` parameter requires the `scope` parameter to be provided");
    }

    const response = await this.akeneo.getProducts({
      $,
      params: {
        search: this.search,
        scope: this.scope,
        locales: this.locales,
        attributes: this.attributes,
        convert_measurements: this.convertMeasurements,
        with_count: this.withCount,
        with_attribute_options: this.withAttributeOptions,
        with_asset_share_links: this.withAssetShareLinks,
        with_quality_scores: this.withQualityScores,
        with_completenesses: this.withCompletenesses,
        page: this.page,
        limit: this.limit,
      },
    });

    $.export("$summary", `Found ${response._embedded.items.length} products`);
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
AkeneoakeneoappThis component uses the Akeneo app.
Searchsearchstring

Filter products, for more details see the Filters section

ScopescopestringSelect a value from the drop down menu.
LocalelocalesstringSelect a value from the drop down menu.
AttributesattributesstringSelect a value from the drop down menu.
Convert MeasurementsconvertMeasurementsboolean

Convert values of measurement attributes to the unit configured in the channel provided by the parameter "scope". Therefore, this parameter requires the "scope" parameter to be provided.

With CountwithCountboolean

Return the count of items in the response. Be careful: on large catalogs, enabling counts can significantly impact performance.

With Attribute OptionswithAttributeOptionsboolean

Return labels of attribute options in the response. See thelinked_data format section for more details.

With Asset Share LinkswithAssetShareLinksboolean

Return asset collection share link urls in the response. See the linked_data format section for more details.

With Quality ScoreswithQualityScoresboolean

Return product quality scores in the response

With CompletenesswithCompletenessesboolean

Return product completenesses in the response

Pagepageinteger

The page number to return

Limitlimitinteger

The number of items to return per page

Authentication

Akeneo uses OAuth authentication. When you connect your Akeneo account, Pipedream will open a popup window where you can sign into Akeneo and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Akeneo API.

Pipedream requests the following authorization scopes when you connect your account:

About Akeneo

Product information management and data intelligence software

More Ways to Use Akeneo

Actions

Create A New Product Media File with the Akeneo API

Allows you to create a new media file and associate it to an attribute value of a given product or product model. See the docs

 
Try it
Delete Product with the Akeneo API

Delete a product from Akeneo. See the documentation

 
Try it
Get Draft with the Akeneo API

Get a product draft from Akeneo. See the documentation

 
Try it
Get Product with the Akeneo API

Get a product from Akeneo. See the documentation

 
Try it
Submit Product For Approval with the Akeneo API

Submit a product for approval. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,800+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Anthropic (Claude)
Anthropic (Claude)
AI research and products that put safety at the frontier. Introducing Claude, a next-generation AI assistant for your tasks, no matter the scale.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Telegram
Telegram
Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.