Create A New Product Media File with Akeneo API on New Cancelled Order (Instant) from Shopify API

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

Trigger workflow on

New Cancelled Order (Instant) from the Shopify API

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#

This integration creates a workflow with a Shopify trigger and Akeneo action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Cancelled Order (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
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
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Cancelled Order (Instant) on Shopify

Description:Emit new event each time a new order is cancelled.

Version:0.0.5

Key:shopify_developer_app-new-cancelled-order

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Trigger Code#

import constants from "../common/constants.mjs";
import common from "../common/webhook-metafields.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-cancelled-order",
  name: "New Cancelled Order (Instant)",
  type: "source",
  description: "Emit new event each time a new order is cancelled.",
  version: "0.0.5",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.ORDERS_CANCELLED;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.updated_at);
      return {
        id: ts,
        summary: `Order Cancelled ${resource.id}.`,
        ts,
      };
    },
  },
};

Trigger 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
Shopify	`app`	`app`	This component uses the Shopify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Metafield Namespaces	`metafieldNamespaces`	`string[]`	Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.

Trigger Authentication#

Shopify uses API keys for authentication. When you connect your Shopify account, Pipedream securely stores the keys so you can easily authenticate to Shopify APIs in both code and no-code steps.

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About 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.

Action#

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

Akeneo Overview#

The Akeneo API empowers users to streamline product information management by automating data exchange between Akeneo and other systems. By leveraging Pipedream, you can construct workflows that trigger actions based on events in Akeneo, sync product data across platforms, enhance product information with data from external sources, and keep sales channels up-to-date with the latest catalog details.

Action 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;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

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

Action 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 Connect Akeneo + Shopify#

Other Popular Integrations#

Create A New Product Media File with Akeneo API on New Abandoned Cart from Shopify (Developer App) API

Shopify + Akeneo

Create A New Product Media File with Akeneo API on New Cancelled Order (Instant) from Shopify API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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