Get Orders with PlentyONE API on New Shipment (Instant) from Shopify API

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

Trigger workflow on

New Shipment (Instant) from the Shopify API

Next, do this

Get Orders 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 Shopify 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 New Shipment (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Get Orders action
1. Connect your PlentyONE account
2. Optional- Select a Order Type ID
3. Optional- Select a Contact ID
4. Optional- Configure Contact Data
5. Optional- Configure Referrer ID
6. Optional- Configure Shipping Profile ID
7. Optional- Configure Shipping Service Provider ID
8. Optional- Configure Owner User ID
9. Optional- Configure Warehouse ID
10. Optional- Configure Is eBay Plus
11. Optional- Configure Included Variation
12. Optional- Configure Included Item
13. Optional- Select one or more Order IDs
14. Optional- Select a Country ID
15. Optional- Configure Order Item Name
16. Optional- Configure Variation Number
17. Optional- Configure Package Number
18. Optional- Configure External Order ID
19. Optional- Configure Client ID
20. Optional- Select a Payment Status
21. Optional- Configure Payment Method ID
22. Optional- Select one or more With
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 Shipment (Instant) on Shopify

Description:Emit new event for each new fulfillment event for a store.

Version:0.0.4

Key:shopify_developer_app-new-shipment

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-shipment",
  name: "New Shipment (Instant)",
  type: "source",
  description: "Emit new event for each new fulfillment event for a store.",
  version: "0.0.4",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.ORDERS_FULFILLED;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.updated_at);
      return {
        id: ts,
        summary: `New Shipped Order ${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.

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#

Get Orders on PlentyONE

Description:Retrieves a list of orders from PlentyONE. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/get_rest_orders)

Version:0.0.1

Key:plentyone-get-orders

View on GitHub

Action Code#

import {
  ORDER_TYPE_OPTIONS,
  ORDER_WITH_OPTIONS,
  PAYMENT_STATUS_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import plentyone from "../../plentyone.app.mjs";

export default {
  key: "plentyone-get-orders",
  name: "Get Orders",
  description: "Retrieves a list of orders from PlentyONE. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/get_rest_orders)",
  version: "0.0.1",
  type: "action",
  props: {
    plentyone,
    typeID: {
      type: "integer",
      label: "Order Type ID",
      description: "Type of order to retrieve. If not provided, all order types will be retrieved.",
      options: ORDER_TYPE_OPTIONS,
      optional: true,
    },
    contactId: {
      propDefinition: [
        plentyone,
        "contactId",
      ],
      optional: true,
    },
    contactData: {
      type: "string",
      label: "Contact Data",
      description: "Filter that restricts the search result to orders with a specific contact data.",
      optional: true,
    },
    referrerId: {
      type: "integer",
      label: "Referrer ID",
      description: "Filter that restricts the search result to orders of a specific order referrer. The ID of the order referrer must be specified.",
      optional: true,
    },
    shippingProfileId: {
      type: "integer",
      label: "Shipping Profile ID",
      description: "Filter that restricts the search result to orders with a specific shipping profile. The ID of shipping profile must be specified.",
      optional: true,
    },
    shippingServiceProviderId: {
      type: "integer",
      label: "Shipping Service Provider ID",
      description: "Filter that restricts the search result to orders with a specific shipping service provider (like DHL, UPS, etc.). The ID of shipping service provider must be specified.",
      optional: true,
    },
    ownerUserId: {
      type: "integer",
      label: "Owner User ID",
      description: "Filter that restricts the search result to orders with a specific owner. The user ID of the owner must be specified.",
      optional: true,
    },
    warehouseId: {
      type: "integer",
      label: "Warehouse ID",
      description: "Filter that restricts the search result to orders with a specific main warehouse. The ID of the warehouse must be specified.",
      optional: true,
    },
    isEbayPlus: {
      type: "boolean",
      label: "Is eBay Plus",
      description: "Filter that restricts the search result to orders with the referrer eBay PLUS.",
      optional: true,
    },
    includedVariation: {
      type: "integer",
      label: "Included Variation",
      description: "Filter that restricts the search result to orders including a specific variation. The ID of the variation must be specified.",
      optional: true,
    },
    includedItem: {
      type: "integer",
      label: "Included Item",
      description: "Filter that restricts the search result to orders including a specific item. The ID of the item must be specified.",
      optional: true,
    },
    orderIds: {
      propDefinition: [
        plentyone,
        "orderId",
      ],
      type: "string[]",
      label: "Order IDs",
      description: "Filter that restricts the search result to orders with a specific ID.",
      optional: true,
    },
    countryId: {
      propDefinition: [
        plentyone,
        "countryId",
      ],
      optional: true,
    },
    orderItemName: {
      type: "string",
      label: "Order Item Name",
      description: "Filter that restricts the search result to orders including a specific item name. The name of the item must be specified.",
      optional: true,
    },
    variationNumber: {
      type: "integer",
      label: "Variation Number",
      description: "Filter that restricts the search result to orders including a specific variation number. The number of the variation must be specified.",
      optional: true,
    },
    packageNumber: {
      type: "string",
      label: "Package Number",
      description: "Filter that restricts the search result to orders including a specific package number. The number of the package must be specified.",
      optional: true,
    },
    externalOrderId: {
      type: "string",
      label: "External Order ID",
      description: "Filter that restricts the search result to orders including a specific external order ID. The external order ID must be specified.",
      optional: true,
    },
    clientId: {
      type: "integer",
      label: "Client ID",
      description: "Filter that restricts the search result to orders belonging to a specific client. The ID of the client must be specified.",
      optional: true,
    },
    paymentStatus: {
      type: "string",
      label: "Payment Status",
      description: "Filter that restricts the search result to orders with a specific payment status.",
      options: PAYMENT_STATUS_OPTIONS,
      optional: true,
    },
    paymentMethodId: {
      type: "integer",
      label: "Payment Method ID",
      description: "Filter that restricts the search result to orders with a specific payment method. The ID of the payment method must be specified.",
      optional: true,
    },
    with: {
      type: "string[]",
      label: "With",
      description: "Load additional relations for an order.",
      options: ORDER_WITH_OPTIONS,
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const response = await this.plentyone.getOrders({
        $,
        params: {
          typeID: this.typeID,
          contactId: this.contactId,
          contactData: this.contactData,
          referrerId: this.referrerId,
          shippingProfileId: this.shippingProfileId,
          shippingServiceProviderId: this.shippingServiceProviderId,
          ownerUserId: this.ownerUserId,
          warehouseId: this.warehouseId,
          isEbayPlus: this.isEbayPlus,
          includedVariation: this.includedVariation,
          includedItem: this.includedItem,
          orderIds: parseObject(this.orderIds),
          countryId: this.countryId,
          orderItemName: this.orderItemName,
          variationNumber: this.variationNumber,
          packageNumber: this.packageNumber,
          externalOrderId: this.externalOrderId,
          clientId: this.clientId,
          paymentStatus: this.paymentStatus,
          paymentMethodId: this.paymentMethodId,
          with: parseObject(this.with),
        },
      });

      $.export("$summary", `Successfully retrieved ${response.data?.length || 0} orders`);
      return response;
    } catch (error) {
      $.export("$summary", "Successfully retrieved 0 orders");
      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
PlentyONE	`plentyone`	`app`	This component uses the PlentyONE app.
Order Type ID	`typeID`	`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 }`
Contact ID	`contactId`	`string`	Select a value from the drop down menu.
Contact Data	`contactData`	`string`	Filter that restricts the search result to orders with a specific contact data.
Referrer ID	`referrerId`	`integer`	Filter that restricts the search result to orders of a specific order referrer. The ID of the order referrer must be specified.
Shipping Profile ID	`shippingProfileId`	`integer`	Filter that restricts the search result to orders with a specific shipping profile. The ID of shipping profile must be specified.
Shipping Service Provider ID	`shippingServiceProviderId`	`integer`	Filter that restricts the search result to orders with a specific shipping service provider (like DHL, UPS, etc.). The ID of shipping service provider must be specified.
Owner User ID	`ownerUserId`	`integer`	Filter that restricts the search result to orders with a specific owner. The user ID of the owner must be specified.
Warehouse ID	`warehouseId`	`integer`	Filter that restricts the search result to orders with a specific main warehouse. The ID of the warehouse must be specified.
Is eBay Plus	`isEbayPlus`	`boolean`	Filter that restricts the search result to orders with the referrer eBay PLUS.
Included Variation	`includedVariation`	`integer`	Filter that restricts the search result to orders including a specific variation. The ID of the variation must be specified.
Included Item	`includedItem`	`integer`	Filter that restricts the search result to orders including a specific item. The ID of the item must be specified.
Order IDs	`orderIds`	`string[]`	Select a value from the drop down menu.
Country ID	`countryId`	`integer`	Select a value from the drop down menu.
Order Item Name	`orderItemName`	`string`	Filter that restricts the search result to orders including a specific item name. The name of the item must be specified.
Variation Number	`variationNumber`	`integer`	Filter that restricts the search result to orders including a specific variation number. The number of the variation must be specified.
Package Number	`packageNumber`	`string`	Filter that restricts the search result to orders including a specific package number. The number of the package must be specified.
External Order ID	`externalOrderId`	`string`	Filter that restricts the search result to orders including a specific external order ID. The external order ID must be specified.
Client ID	`clientId`	`integer`	Filter that restricts the search result to orders belonging to a specific client. The ID of the client must be specified.
Payment Status	`paymentStatus`	`string`	Select a value from the drop down menu:`{ "label": "Unpaid", "value": "unpaid" }{ "label": "Partly paid", "value": "partlyPaid" }{ "label": "Fully paid", "value": "fullyPaid" }{ "label": "Overpaid", "value": "overpaid" }`
Payment Method ID	`paymentMethodId`	`integer`	Filter that restricts the search result to orders with a specific payment method. The ID of the payment method must be specified.
With	`with`	`string[]`	Select a value from the drop down menu:`{ "label": "Addresses - The address objects that are associated with the order.", "value": "addresses" }{ "label": "Relations - The order relation reference instances that are associated with the order. These instances contain information such as the the reference type, the ID of the reference and the relation itself.", "value": "relations" }{ "label": "Comments - The order comments.", "value": "comments" }{ "label": "Location - The accounting location of the order.", "value": "location" }{ "label": "Payments - The payments that are associated with the order.", "value": "payments" }{ "label": "Documents - The documents that are associated with the order.", "value": "documents" }{ "label": "Contact Sender - The associated contact for the contact-sender relation.", "value": "contactSender" }{ "label": "Contact Receiver - The associated contact for the contact-receiver relation.", "value": "contactReceiver" }{ "label": "Warehouse Sender - The associated warehouse for the warehouse-sender relation.", "value": "warehouseSender" }{ "label": "Warehouse Receiver - The associated warehouse for the warehouse-receiver relation.", "value": "warehouseReceiver" }{ "label": "Order Items Variation - The variation that is associated with the order item.", "value": "orderItems.variation" }{ "label": "Order Items Variation Properties - The properties belonging to the variation.", "value": "orderItems.variation.propertiesV2" }{ "label": "Order Items Gift Card Codes - The gift card codes that are associated with the order item.", "value": "orderItems.giftCardCodes" }{ "label": "Order Items Transactions - The transactions that are associated with the order item.", "value": "orderItems.transactions" }{ "label": "Order Items Serial Numbers - The serial numbers that are associated with the order item.", "value": "orderItems.serialNumbers" }{ "label": "Order Items Variation Barcodes - The barcodes that are associated with variation of the order item.", "value": "orderItems.variationBarcodes" }{ "label": "Order Items Comments - The comments that are associated with the order item.", "value": "orderItems.comments" }{ "label": "Origin Order References - The references to other orders, e.g. returns or credit notes, associated with this order.", "value": "originOrderReferences" }{ "label": "Shipping Packages - The shipping packages that are associated with the order.", "value": "shippingPackages" }{ "label": "Shipping Packages Items - The orderPackageItems associated with the package.", "value": "shippingPackages.items" }{ "label": "Shipping Information - The shipping information for the order.", "value": "shippingInformation" }{ "label": "Payment Terms - The payment terms that are associated with the order.", "value": "paymentTerms" }{ "label": "Order Items Warehouse Locations - The warehouse locations that are associated with the order item.", "value": "orderItems.warehouseLocations" }`

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:

Get Orders with PlentyONE API on New Shipment (Instant) from Shopify API

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

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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