Query IP address with IP2Location API on New Cancelled Order (Instant) from Shopify Developer App API

Pipedream makes it easy to connect APIs for IP2Location, Shopify Developer App and 2,000+ other apps remarkably fast.

Trigger workflow on

New Cancelled Order (Instant) from the Shopify Developer App API

Next, do this

Query IP address with the IP2Location API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Shopify Developer App trigger and IP2Location 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 Developer App account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Query IP address action
1. Connect your IP2Location account
2. Configure IP Address
3. Select a Package
4. Optional- Select a Response Format
5. Optional- Select a Translation Language
6. Optional- Select one or more Addon
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 Developer App

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

Version:0.0.2

Key:shopify_developer_app-new-cancelled-order

View on GitHub

Shopify Developer App 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 common from "../common/webhook.mjs";
import constants from "../common/constants.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.2",
  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 Developer App	`app`	`app`	This component uses the Shopify Developer App 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
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook

Trigger Authentication#

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

Find your Shop ID

Get your Access Token

Next, 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 Developer App#

Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.

Action#

Query IP address on IP2Location

Description:Query IP address using IP2Location API. [See the docs here](https://www.ip2location.com/web-service/ip2location) for how to use this API.

Version:0.0.2

Key:ip2location-query-ip-info

View on GitHub

IP2Location Overview#

The IP2Location API enables you to uncover valuable information about an IP address. With it, you can pinpoint a user's geographic location, such as country, region, city, and even latitude and longitude coordinates. This data is essential for various tasks like localizing content, analyzing traffic, or enhancing security by detecting potentially malicious activity. Using Pipedream, you can automate actions based on IP location data, integrating it with hundreds of other services without writing any code.

Action Code#

import ip2locationApp from "../../ip2location.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  name: "Query IP address",
  description: "Query IP address using IP2Location API. [See the docs here](https://www.ip2location.com/web-service/ip2location) for how to use this API.",
  key: "ip2location-query-ip-info",
  version: "0.0.2",
  type: "action",
  props: {
    ip2locationApp,
    ipAddress: {
      type: "string",
      label: "IP Address",
      description: "IP address (IPv4 or IPv6) for reverse IP location lookup purposes.",
    },
    wsPackage: {
      type: "string",
      label: "Package",
      options: constants.PACKAGE_OPTIONS,
      description: "Web service package of different granularity of return information. Please refer to the pricing table in our [documentation](https://www.ip2location.com/web-service/ip2location) for the information returned.",
    },
    format: {
      type: "string",
      label: "Response Format",
      options: constants.FORMAT_OPTIONS,
      description: "Format of the response message. Available values are `json` or `xml`. If unspecified, json format will be used for the response message.",
      optional: true,
    },
    language: {
      type: "string",
      label: "Translation Language",
      options: constants.LANGUAGE_OPTIONS,
      description: "Translation information. The translation is only applicable for continent, country, region and city name for the **addon** package.",
      optional: true,
    },
    addon: {
      type: "string[]",
      label: "Addon",
      options: constants.ADDON_OPTIONS,
      description: "Extra information in addition to the above-selected package. Please refer to the pricing table in our [documentation](https://www.ip2location.com/web-service/ip2location) for the information returned. You can query for multiple addons by putting a comma at between of them, for example `continent,country`. Valid value: `continent`, `country`, `region`, `city`, `geotargeting`, `country_groupings`, `time_zone_info`",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      ipAddress,
      format,
      language,
      wsPackage,
      addon,
    } = this;
    var addon_formatted = "";
    for (let i = 0; i < addon.length; i++) {
      addon_formatted += addon[i] + ",";
    }
    const response =
      await this.ip2locationApp.queryIPInfo({
        $,
        params: {
          format: format ?? "json",
          language: language ?? "en",
          ip: ipAddress,
          package: wsPackage,
          addon: addon_formatted ?? "",
        },
      });
    $.export("$summary", "Successfully queried IP address information with IP2Location API.");
    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
IP2Location	`ip2locationApp`	`app`	This component uses the IP2Location app.
IP Address	`ipAddress`	`string`	IP address (IPv4 or IPv6) for reverse IP location lookup purposes.
Package	`wsPackage`	`string`	Select a value from the drop down menu:`WS1WS2WS3WS4WS5WS6WS7WS8WS9WS10WS11WS12WS13WS14WS15WS16WS17WS18WS19WS20WS21WS22WS23WS24WS25`
Response Format	`format`	`string`	Select a value from the drop down menu:`jsonxml`
Translation Language	`language`	`string`	Select a value from the drop down menu:`arcsdadeenesetfifrgaitjakomsnlptrusvtrvizh-cnzh-tw`
Addon	`addon`	`string[]`	Select a value from the drop down menu:`continentcountryregioncitygeotargetingcountry_groupingstime_zone_info`