Create Order with BaseLinker API on New Monitor Run Completed from Postman API

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

Trigger workflow on

New Monitor Run Completed from the Postman API

Next, do this

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

Select this integration
Configure the New Monitor Run Completed trigger
1. Connect your Postman account
2. Configure timer
3. Select a Monitor ID
Configure the Create Order action
1. Connect your BaseLinker account
2. Select a Order Status ID
3. Optional- Select a Inventory ID
4. Optional- Configure Currency
5. Optional- Configure Payment Method
6. Optional- Configure Payment Method COD
7. Optional- Configure Paid
8. Optional- Configure Buyer Comments
9. Optional- Configure Seller Comments
10. Optional- Configure Email
11. Optional- Configure Want Invoice
12. Configure Number Of Products
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 Monitor Run Completed on Postman

Description:Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)

Version:0.0.1

Key:postman-monitor-run-completed

View on GitHub

Postman Overview#

The Postman API enables you to automate tasks within your Postman collections, such as running collections, fetching and updating environments, and integrating your API development workflow into your CI/CD pipeline. Using Pipedream, you can harness this functionality to create custom workflows that trigger on various events, process data, and connect with other apps, extending the capabilities of your API testing and development processes.

Trigger Code#

import postman from "../../postman.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "postman-monitor-run-completed",
  name: "New Monitor Run Completed",
  description: "Emit new event when a monitor run is completed. [See the documentation](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    postman,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: 60,
      },
    },
    monitorId: {
      propDefinition: [
        postman,
        "monitorId",
      ],
    },
  },
  methods: {
    _getLastDate() {
      return this.db.get("lastDate") || new Date("1970-01-01");
    },
    _setLastDate(lastDate) {
      this.db.set("lastDate", lastDate);
    },
    async startEvent() {
      const lastDate = this._getLastDate();

      const { monitor } = await this.postman.getMonitor({
        monitorId: this.monitorId,
      });

      if (monitor.lastRun?.status === "success" && new Date(monitor.lastRun.startedAt) > new Date(lastDate)) {
        this._setLastDate(monitor.lastRun.startedAt);
        this.emitEvent(monitor);
      }
    },
    emitEvent(monitor) {
      this.$emit(monitor, {
        id: monitor.id + monitor.lastRun.startedAt,
        summary: `Monitor Run Completed: ${monitor.name}`,
        ts: Date.parse(monitor.lastRun.finishedAt),
      });
    },
  },
  async run() {
    await this.startEvent();
  },
  sampleEmit,
};

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
Postman	`postman`	`app`	This component uses the Postman app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Monitor ID	`monitorId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

To retrieve your API key,

Navigate to your Postman account and sign in
Go to your Integration Dashboard
Click "Generate API Key", and copy and paste it below.

About Postman#

Postman is the world's leading API platform.

Action#

Create Order on BaseLinker

Description:It allows adding a new order to the BaseLinker order manager. [See the Documentation](https://api.baselinker.com/index.php?method=addOrder).

Version:0.0.2

Key:baselinker-create-order

View on GitHub

BaseLinker Overview#

The BaseLinker API offers access to a suite of e-commerce management tools, enabling seamless integration of orders, products, and inventory across various online sales channels. With Pipedream's ability to connect APIs, you can automate tasks between BaseLinker and other apps to streamline your e-commerce operations, from syncing inventory to processing orders.

Action Code#

import app from "../../baselinker.app.mjs";
import constants from "../../common/constants.mjs";
import method from "../../common/method.mjs";

export default {
  key: "baselinker-create-order",
  name: "Create Order",
  description: "It allows adding a new order to the BaseLinker order manager. [See the Documentation](https://api.baselinker.com/index.php?method=addOrder).",
  type: "action",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    orderStatusId: {
      propDefinition: [
        app,
        "orderStatusId",
      ],
    },
    inventoryId: {
      optional: true,
      description: "The ID of the inventory in which the products are located. If the inventory ID is not provided, the products will be searched in the **default** inventory.",
      propDefinition: [
        app,
        "inventoryId",
      ],
    },
    currency: {
      optional: true,
      propDefinition: [
        app,
        "currency",
      ],
    },
    paymentMethod: {
      type: "string",
      label: "Payment Method",
      description: "The payment method of the order.",
      optional: true,
    },
    paymentMethodCOD: {
      type: "boolean",
      label: "Payment Method COD",
      description: "Flag indicating whether the type of payment is COD (cash on delivery)",
      optional: true,
    },
    paid: {
      type: "boolean",
      label: "Paid",
      description: "Information whether the order is already paid. The value `1` automatically adds a full payment to the order.",
      optional: true,
    },
    userComments: {
      type: "string",
      label: "Buyer Comments",
      description: "Comments added by the customer when placing the order.",
      optional: true,
    },
    adminComments: {
      type: "string",
      label: "Seller Comments",
      description: "Comments added by the seller to the order.",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email address of the customer who placed the order.",
      optional: true,
    },
    wantInvoice: {
      type: "boolean",
      label: "Want Invoice",
      description: "Flag indicating whether the customer wants to receive an invoice.",
      optional: true,
    },
    numberOfProducts: {
      type: "integer",
      label: "Number Of Products",
      description: "The number of products in the order.",
      default: 1,
      reloadProps: true,
    },
  },
  async additionalProps() {
    return Array.from({
      length: this.numberOfProducts,
    }).reduce((acc, _, index) => {
      const {
        prefix,
        description,
      } = this.getPrefixAndDesc(index);

      return {
        ...acc,
        [`${prefix}name`]: {
          type: "string",
          label: `${description} Name`,
          description: `${description} The name of the product.`,
          optional: true,
        },
        [`${prefix}sku`]: {
          type: "string",
          label: `${description} SKU`,
          description: `${description} The SKU of the product.`,
          optional: true,
        },
        [`${prefix}quantity`]: {
          type: "integer",
          label: `${description} Quantity`,
          description: `${description} The quantity of the product.`,
          optional: true,
        },
        [`${prefix}storage`]: {
          type: "string",
          label: `${description} Storage`,
          description: `${description} Type of magazine from which the product comes.`,
          options: Object.values(constants.STORAGE),
          optional: true,
        },
        [`${prefix}productId`]: {
          type: "string",
          label: `${description} Product ID`,
          description: `${description} The ID of the product.`,
          optional: true,
          options: async ({ page }) => {
            let inventoryId = this.inventoryId;

            if (!inventoryId) {
              const {
                inventories: [
                  inventory,
                ],
              } = await this.app.listInventories();
              inventoryId = inventory?.inventory_id;
            }

            const response = await this.app.listInventoryProducts({
              data: {
                parameters: {
                  page,
                  inventory_id: inventoryId,
                },
              },
            });
            return Object.entries(response.products)
              .map(([
                , {
                  id: value, name: label,
                },
              ]) => ({
                label,
                value,
              }));
          },
        },
      };
    }, {});
  },
  methods: {
    getPrefixAndDesc(index) {
      const productIdx = index + 1;
      return {
        prefix: `product${productIdx}${constants.SEP}`,
        description: `Product ${productIdx} -`,
      };
    },
    getProduct(index) {
      const { prefix } = this.getPrefixAndDesc(index);
      const {
        [`${prefix}name`]: name,
        [`${prefix}sku`]: sku,
        [`${prefix}quantity`]: quantity,
        [`${prefix}storage`]: storage,
        [`${prefix}productId`]: product_id,
      } = this;
      return {
        name,
        sku,
        quantity,
        storage,
        product_id,
      };
    },
    getProducts() {
      return Array.from({
        length: this.numberOfProducts,
      }).map((_, index) => this.getProduct(index));
    },
    createOrder(args = {}) {
      return this.app.connector({
        ...args,
        data: {
          method: method.ADD_ORDER,
          ...args.data,
        },
      });
    },
  },
  async run({ $: step }) {
    const {
      orderStatusId,
      currency,
      paymentMethod,
      paymentMethodCOD,
      paid,
      userComments,
      adminComments,
      email,
      wantInvoice,
    } = this;

    const response = await this.createOrder({
      data: {
        parameters: {
          order_status_id: orderStatusId,
          currency,
          payment_method: paymentMethod,
          payment_method_cod: paymentMethodCOD,
          paid,
          user_comments: userComments,
          admin_comments: adminComments,
          email,
          want_invoice: wantInvoice,
          products: this.getProducts(),
        },
      },
    });

    step.export("$summary", `Successfully created order ${response.order_id}.`);

    return response;
  },
};

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
BaseLinker	`app`	`app`	This component uses the BaseLinker app.
Order Status ID	`orderStatusId`	`string`	Select a value from the drop down menu.
Inventory ID	`inventoryId`	`string`	Select a value from the drop down menu.
Currency	`currency`	`string`	3-letter currency symbol (e.g. `EUR`, `PLN`)
Payment Method	`paymentMethod`	`string`	The payment method of the order.
Payment Method COD	`paymentMethodCOD`	`boolean`	Flag indicating whether the type of payment is COD (cash on delivery)
Paid	`paid`	`boolean`	Information whether the order is already paid. The value `1` automatically adds a full payment to the order.
Buyer Comments	`userComments`	`string`	Comments added by the customer when placing the order.
Seller Comments	`adminComments`	`string`	Comments added by the seller to the order.
Email	`email`	`string`	The email address of the customer who placed the order.
Want Invoice	`wantInvoice`	`boolean`	Flag indicating whether the customer wants to receive an invoice.
Number Of Products	`numberOfProducts`	`integer`	The number of products in the order.

Action Authentication#

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

To retrieve your API key,