Create A New Product Media File with Akeneo API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Create A New Product Media File with the Akeneo API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

Create a workflow to Create A New Product Media File with the Akeneo API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Create A New Product Media File action
1. Connect your Akeneo account
2. Optional- Select a Product Identifier
3. Optional- Select a Product Model Code
4. Select a Attribute Code
5. Configure File
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Create A New Product Media File with Akeneo API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Akeneo

Try it

Create A New Product Media File with Akeneo API on New Submission from Typeform API

Typeform + Akeneo

Try it

Create A New Product Media File with Akeneo API on Custom Events from Zoom API

Zoom + Akeneo

Try it

Create A New Product Media File with Akeneo API on New Submission (Instant) from Jotform API

Jotform + Akeneo

Try it

Create A New Product Media File with Akeneo API on New Custom Webhook Events from Stripe API

Stripe + 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.

Create A New Product Media File on Akeneo

Description: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](https://api.akeneo.com/api-reference.html#post_media_files)

Version:0.0.1

Key:akeneo-create-a-new-product-media-file

View on GitHub

Code#

import app from "../../akeneo.app.mjs";
import utils from "../../common/utils.mjs";
import { ConfigurationError } from "@pipedream/platform";
import FormData from "form-data";
import fs from "fs";

export default {
  type: "action",
  key: "akeneo-create-a-new-product-media-file",
  version: "0.0.1",
  name: "Create A New Product Media File",
  description: "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](https://api.akeneo.com/api-reference.html#post_media_files)",
  props: {
    app,
    productId: {
      propDefinition: [
        app,
        "productId",
      ],
    },
    productModelCode: {
      propDefinition: [
        app,
        "productModelCode",
      ],
    },
    mediaFileAttributeCode: {
      propDefinition: [
        app,
        "mediaFileAttributeCode",
      ],
    },
    filename: {
      type: "string",
      label: "File",
      description: "The file to be uploaded, please provide a file from `/tmp`. To upload a file to `/tmp` folder, please follow the doc [here](https://pipedream.com/docs/code/nodejs/working-with-files/#writing-a-file-to-tmp)",
    },
  },
  async run ({ $ }) {
    if (!this.productId && !this.productModelCode) {
      throw new ConfigurationError("Either `Product Identifier` or `Product Model Code` should be set!");
    }
    const path = utils.checkTmp(this.filename);
    if (!fs.existsSync(path)) {
      throw new ConfigurationError("File does not exist!");
    }
    const payload = {
      attribute: this.mediaFileAttributeCode,
      scope: null,
      locale: null,
    };
    const data = new FormData();
    if (this.productId) {
      payload.identifier = this.productId;
      data.append("product", JSON.stringify(payload));
    } else {
      payload.code = this.productModelCode;
      data.append("product_model", JSON.stringify(payload));
    }
    const file = fs.readFileSync(path);
    const fileParts = path.split("/");
    data.append("file", file, fileParts[fileParts.length - 1]);
    const contentLength = data.getLengthSync();
    await this.app.createProductMediaFile({
      $,
      headers: {
        "Content-Length": contentLength,
        ...data.getHeaders(),
      },
      data,
    });
    $.export("$summary", "The product media file has been created.");
    return;
  },
};

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.

Label	Prop	Type	Description
Akeneo	`app`	`app`	This component uses the Akeneo app.
Product Identifier	`productId`	`string`	Select a value from the drop down menu.
Product Model Code	`productModelCode`	`string`	Select a value from the drop down menu.
Attribute Code	`mediaFileAttributeCode`	`string`	Select a value from the drop down menu.
File	`filename`	`string`	The file to be uploaded, please provide a file from `/tmp`. To upload a file to `/tmp` folder, please follow the doc here

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: