Create Order with PlentyONE API on Pass Updated from PassSlot API

Pipedream makes it easy to connect APIs for PlentyONE, PassSlot and 2,900+ other apps remarkably fast.

Trigger workflow on

Pass Updated from the PassSlot API

Next, do this

Create Order with the PlentyONE 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 PassSlot trigger and PlentyONE action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Pass Updated trigger
1. Connect your PassSlot account
2. Configure Polling interval
Configure the Create Order action
1. Connect your PlentyONE account
2. Select a Order Type ID
3. Configure Plenty ID
4. Optional- Select a Status ID
5. Optional- Configure Owner ID
6. Optional- Select a Lock Status
7. Optional- Configure Order Items
8. Optional- Configure Properties
9. Optional- Configure Address Relations
10. Optional- Configure Relations
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#

Pass Updated on PassSlot

Description:Emit new event when an existing pass is updated in PassSlot. [See the documentation](https://www.passslot.com/developer/api/resources/showPassValues)

Version:0.0.1

Key:passslot-pass-updated

View on GitHub

PassSlot Overview#

The PassSlot API enables you to create and manage passes for Apple Wallet, such as coupons, loyalty cards, and event tickets. Integrating PassSlot with Pipedream allows you to automate the distribution and update of passes based on various triggers and events. You can dynamically create passes based on user actions, update them when certain conditions are met, and track their usage without manual intervention. This simplifies the process of engaging with customers through their mobile wallets.

Trigger Code#

import common from "../common/base-polling.mjs";
import md5 from "md5";

export default {
  ...common,
  key: "passslot-pass-updated",
  name: "Pass Updated",
  description: "Emit new event when an existing pass is updated in PassSlot. [See the documentation](https://www.passslot.com/developer/api/resources/showPassValues)",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  hooks: {
    async deploy() {
      await this.processEvent();
    },
  },
  methods: {
    ...common.methods,
    _getPreviousValues() {
      return this.db.get("previousValues") || {};
    },
    _setPreviousValues(previousValues) {
      return this.db.set("previousValues", previousValues);
    },
    generateMeta({ pass }) {
      const ts = Date.now();
      return {
        id: `${pass.serialNumber}${ts}`,
        summary: `Pass Updated ${pass.serialNumber}`,
        ts,
      };
    },
    async processEvent() {
      const previousValues = this._getPreviousValues();
      const passes = await this.passslot.listPasses();
      for (const pass of passes) {
        const values = await this.passslot.getPassValues({
          passTypeIdentifier: pass.passType,
          passSerialNumber: pass.serialNumber,
        });
        const hash = md5(JSON.stringify(values));
        if (previousValues[pass.serialNumber] !== hash) {
          previousValues[pass.serialNumber] = hash;
          this.emitEvent({
            pass,
            values,
          });
        }
      }
      this._setPreviousValues(previousValues);
    },
  },
  async run() {
    await this.processEvent();
  },
};

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
PassSlot	`passslot`	`app`	This component uses the PassSlot app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the Trello API on this schedule

Trigger Authentication#

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

About PassSlot#

PassSlot is a Passbook service that makes Passbook usage easy for everybody. It helps you design and distribute mobile passes to all major mobile platforms.

Action#

Create Order on PlentyONE

Description:Creates a new order in PlentyONE. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders)

Version:0.0.2

Key:plentyone-create-order

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  LOCK_STATUS_OPTIONS,
  ORDER_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import plentyone from "../../plentyone.app.mjs";

export default {
  key: "plentyone-create-order",
  name: "Create Order",
  description: "Creates a new order in PlentyONE. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    plentyone,
    orderTypeId: {
      type: "integer",
      label: "Order Type ID",
      description: "The ID of the order type.",
      options: ORDER_TYPE_OPTIONS,
    },
    plentyId: {
      type: "integer",
      label: "Plenty ID",
      description: "The plenty ID of the client that the order belongs to.",
    },
    statusId: {
      propDefinition: [
        plentyone,
        "statusId",
      ],
      optional: true,
    },
    ownerId: {
      type: "integer",
      label: "Owner ID",
      description: "The user ID of the order's owner.",
      optional: true,
    },
    lockStatus: {
      type: "string",
      label: "Lock Status",
      description: "The lock status of the order.",
      options: LOCK_STATUS_OPTIONS,
      optional: true,
    },
    orderItems: {
      type: "string[]",
      label: "Order Items",
      description: "A list of objects of the order items. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders) for more details.",
      optional: true,
    },
    properties: {
      type: "string[]",
      label: "Properties",
      description: "A list of objects of the order properties. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders) for more details.",
      optional: true,
    },
    addressRelations: {
      type: "string[]",
      label: "Address Relations",
      description: "A list of objects of the order address relations. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders) for more details.",
      optional: true,
    },
    relations: {
      type: "string[]",
      label: "Relations",
      description: "A list of objects of the order relations. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/post_rest_orders) for more details.",
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const response = await this.plentyone.createOrder({
        $,
        data: {
          typeId: this.orderTypeId,
          plentyId: this.plentyId,
          statusId: this.statusId,
          ownerId: this.ownerId,
          lockStatus: this.lockStatus,
          orderItems: parseObject(this.orderItems),
          properties: parseObject(this.properties),
          addressRelations: parseObject(this.addressRelations),
          relations: parseObject(this.relations),
        },
      });

      $.export("$summary", `Successfully created order: ${response.id}`);
      return response;
    } catch (error) {
      $.export("$summary", "Failed to create order");
      throw new ConfigurationError(error);
    }
  },
};

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
PlentyONE	`plentyone`	`app`	This component uses the PlentyONE app.
Order Type ID	`orderTypeId`	`integer`	Select a value from the drop down menu:`{ "label": "Sales order", "value": 1 }{ "label": "Delivery", "value": 2 }{ "label": "Returns", "value": 3 }{ "label": "Credit note", "value": 4 }{ "label": "Warranty", "value": 5 }{ "label": "Repair", "value": 6 }{ "label": "Offer", "value": 7 }{ "label": "Advance order", "value": 8 }{ "label": "Multi-order", "value": 9 }{ "label": "Multi credit note", "value": 10 }{ "label": "Multi delivery", "value": 11 }{ "label": "Reorder", "value": 12 }{ "label": "Partial delivery", "value": 13 }{ "label": "Subscription", "value": 14 }{ "label": "Redistribution", "value": 15 }`
Plenty ID	`plentyId`	`integer`	The plenty ID of the client that the order belongs to.
Status ID	`statusId`	`integer`	Select a value from the drop down menu.
Owner ID	`ownerId`	`integer`	The user ID of the order's owner.
Lock Status	`lockStatus`	`string`	Select a value from the drop down menu:`{ "label": "Unlocked", "value": "unlocked" }{ "label": "Permanently locked", "value": "permanentlyLocked" }{ "label": "Reversible locked", "value": "reversibleLocked" }`
Order Items	`orderItems`	`string[]`	A list of objects of the order items. See the documentation for more details.
Properties	`properties`	`string[]`	A list of objects of the order properties. See the documentation for more details.
Address Relations	`addressRelations`	`string[]`	A list of objects of the order address relations. See the documentation for more details.
Relations	`relations`	`string[]`	A list of objects of the order relations. See the documentation for more details.

Action Authentication#

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

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