Create Affiliate with Refersion API on New Draft Order (Instant) from Shopify Developer App API

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

Trigger workflow on

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

Next, do this

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

Select this integration
Configure the New Draft Order (Instant) trigger
1. Connect your Shopify Developer App account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Create Affiliate action
1. Connect your Refersion account
2. Configure First Name
3. Configure Last Name
4. Configure Email
5. Configure Password
6. Select a Status
7. Optional- Configure Offer
8. Optional- Configure Company
9. Optional- Configure Paypal Email
10. Optional- Configure Address 1
11. Optional- Configure Address 2
12. Optional- Configure City
13. Optional- Configure State
14. Optional- Configure Zip
15. Optional- Select a Country
16. Optional- Configure Phone
17. Optional- Configure Send Welcome
18. Optional- Configure Conversion Trigger Coupon
19. Optional- Configure Unique Merchant ID
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 Draft Order (Instant) on Shopify Developer App

Description:Emit new event for each new draft order submitted to a store.

Version:0.0.2

Key:shopify_developer_app-new-draft-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-draft-order",
  name: "New Draft Order (Instant)",
  type: "source",
  description: "Emit new event for each new draft order submitted to a store.",
  version: "0.0.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.DRAFT_ORDERS_CREATE;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.created_at);
      return {
        id: resource.id,
        summary: `New Draft 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 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#

Create Affiliate on Refersion

Description:Create a new affiliate. [See the docs here](https://www.refersion.dev/reference/new_affiliate)

Version:0.0.1

Key:refersion-create-affiliate

View on GitHub

Refersion Overview#

Refersion is a powerful affiliate tracking platform that streamlines the process of managing, tracking, and growing your affiliate network. Through its API, you can automate affiliate registrations, commission tracking, and payout processes. Pipedream's serverless platform allows you to connect Refersion with hundreds of other apps to automate workflows, sync data across platforms, and respond to events in real time.

Action Code#

import app from "../../refersion.app.mjs";
import options from "../../common/options.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  name: "Create Affiliate",
  description: "Create a new affiliate. [See the docs here](https://www.refersion.dev/reference/new_affiliate)",
  key: "refersion-create-affiliate",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the affiliate",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the affiliate",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email of the affiliate",
    },
    password: {
      type: "string",
      label: "Password",
      description: "Has at least 9 characters. The password is NOT more than 72 characters. Has at least 1 upper case character. Has at least 1 lower case character. Has at least 1 numerical character. Has at least 1 special character. Does NOT have the same character repeated more than 3 times in a row. Password does NOT match the email of the user.",
    },
    status: {
      type: "string",
      label: "Status",
      description: "Status of the affiliate",
      options: options.AFFILIATE_STATUS,
    },
    offer: {
      type: "string",
      label: "Offer",
      description: "Specific Offer ID to opt affiliate into, otherwise your default offer is used.",
      optional: true,
    },
    company: {
      type: "string",
      label: "Company",
      description: "Company of the affiliate",
      optional: true,
    },
    paypalEmail: {
      type: "string",
      label: "Paypal Email",
      description: "Paypal email of the affiliate",
      optional: true,
    },
    address1: {
      type: "string",
      label: "Address 1",
      description: "Address 1 of the affiliate",
      optional: true,
    },
    address2: {
      type: "string",
      label: "Address 2",
      description: "Address 2 of the affiliate",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "City of the affiliate",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "State of the affiliate",
      optional: true,
    },
    zip: {
      type: "string",
      label: "Zip",
      description: "Zip of the affiliate",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "Country of the affiliate",
      optional: true,
      options: options.COUNTRIES,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Phone of the affiliate",
      optional: true,
    },
    sendWelcome: {
      type: "boolean",
      label: "Send Welcome",
      description: "Send welcome email to affiliate",
      optional: true,
    },
    conversionTriggerCoupon: {
      type: "string",
      label: "Conversion Trigger Coupon",
      description: "A unique coupon code to assign to this affiliate as a conversion trigger.",
      optional: true,
    },
    uniqueMerchantId: {
      type: "string",
      label: "Unique Merchant ID",
      description: "An optional alphanumeric identifier for the affiliate for your team's internal use.",
      optional: true,
    },
  },
  async run({ $ }) {
    const data = {
      first_name: this.firstName,
      last_name: this.lastName,
      email: this.email,
      password: this.password,
      status: this.status,
      offer: this.offer,
      company: this.company,
      paypal_email: this.paypalEmail,
      address1: this.address1,
      address2: this.address2,
      city: this.city,
      state: this.state,
      zip: this.zip,
      country: this.country,
      phone: this.phone,
      send_welcome: this.sendWelcome
        ? "TRUE"
        : "FALSE",
      conversion_trigger_coupon: this.conversionTriggerCoupon,
      unique_merchant_id: this.uniqueMerchantId,
    };
    const res = await this.app.createAffiliate(data, $);
    if (res.error) {
      throw new ConfigurationError(res.error);
    }
    $.export("$summary", `Affiliate successfully created with id "${res.id}"`);
    return res;
  },
};

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
Refersion	`app`	`app`	This component uses the Refersion app.
First Name	`firstName`	`string`	First name of the affiliate
Last Name	`lastName`	`string`	Last name of the affiliate
Email	`email`	`string`	Email of the affiliate
Password	`password`	`string`	Has at least 9 characters. The password is NOT more than 72 characters. Has at least 1 upper case character. Has at least 1 lower case character. Has at least 1 numerical character. Has at least 1 special character. Does NOT have the same character repeated more than 3 times in a row. Password does NOT match the email of the user.
Status	`status`	`string`	Select a value from the drop down menu:`PENDINGACTIVE`
Offer	`offer`	`string`	Specific Offer ID to opt affiliate into, otherwise your default offer is used.
Company	`company`	`string`	Company of the affiliate
Paypal Email	`paypalEmail`	`string`	Paypal email of the affiliate
Address 1	`address1`	`string`	Address 1 of the affiliate
Address 2	`address2`	`string`	Address 2 of the affiliate
City	`city`	`string`	City of the affiliate
State	`state`	`string`	State of the affiliate
Zip	`zip`	`string`	Zip of the affiliate
Country	`country`	`string`	Select a value from the drop down menu:`{ "value": "US", "label": "United States" }{ "value": "AE", "label": "United Arab Emirates" }{ "value": "AR", "label": "Argentina" }{ "value": "AS", "label": "American Samoa" }{ "value": "AT", "label": "Austria" }{ "value": "AU", "label": "Australia" }{ "value": "BA", "label": "Bosnia and Herzegovina" }{ "value": "BD", "label": "Bangladesh" }{ "value": "BE", "label": "Belgium" }{ "value": "BG", "label": "Bulgaria" }{ "value": "BR", "label": "Brazil" }{ "value": "CA", "label": "Canada" }{ "value": "CH", "label": "Switzerland" }{ "value": "CL", "label": "Chile" }{ "value": "CN", "label": "China" }{ "value": "CO", "label": "Colombia" }{ "value": "CR", "label": "Costa Rica" }{ "value": "CZ", "label": "Czech Republic" }{ "value": "DE", "label": "Germany" }{ "value": "DK", "label": "Denmark" }{ "value": "DZ", "label": "Algeria" }{ "value": "EE", "label": "Estonia" }{ "value": "ES", "label": "Spain" }{ "value": "FI", "label": "Finland" }{ "value": "FM", "label": "Micronesia, Federated States of" }{ "value": "FO", "label": "Faroe Islands" }{ "value": "FR", "label": "France" }{ "value": "GB", "label": "United Kingdom" }{ "value": "GH", "label": "Ghana" }{ "value": "GR", "label": "Greece" }{ "value": "GU", "label": "Guam" }{ "value": "HK", "label": "Hong Kong" }{ "value": "HN", "label": "Honduras" }{ "value": "HR", "label": "Croatia" }{ "value": "HU", "label": "Hungary" }{ "value": "ID", "label": "Indonesia" }{ "value": "IE", "label": "Ireland" }{ "value": "IL", "label": "Israel" }{ "value": "IM", "label": "Isle of Man" }{ "value": "IN", "label": "India" }{ "value": "IS", "label": "Iceland" }{ "value": "IT", "label": "Italy" }{ "value": "JM", "label": "Jamaica" }{ "value": "JP", "label": "Japan" }{ "value": "KR", "label": "South Korea" }{ "value": "KW", "label": "Kuwait" }{ "value": "LT", "label": "Lithuania" }{ "value": "LU", "label": "Luxembourg" }{ "value": "LV", "label": "Latvia" }{ "value": "MA", "label": "Morocco" }{ "value": "MH", "label": "Marshall Islands" }{ "value": "MK", "label": "North Macedonia" }{ "value": "MP", "label": "Northern Mariana Islands" }{ "value": "MT", "label": "Malta" }{ "value": "MX", "label": "Mexico" }{ "value": "MY", "label": "Malaysia" }{ "value": "NG", "label": "Nigeria" }{ "value": "NL", "label": "Netherlands" }{ "value": "NO", "label": "Norway" }{ "value": "NZ", "label": "New Zealand" }{ "value": "OM", "label": "Oman" }{ "value": "PE", "label": "Peru" }{ "value": "PH", "label": "Philippines" }{ "value": "PK", "label": "Pakistan" }{ "value": "PL", "label": "Poland" }{ "value": "PR", "label": "Puerto Rico" }{ "value": "PT", "label": "Portugal" }{ "value": "PW", "label": "Palau" }{ "value": "QA", "label": "Qatar" }{ "value": "RO", "label": "Romania" }{ "value": "RS", "label": "Serbia" }{ "value": "RU", "label": "Russia" }{ "value": "SA", "label": "Saudi Arabia" }{ "value": "SE", "label": "Sweden" }{ "value": "SG", "label": "Singapore" }{ "value": "SI", "label": "Slovenia" }{ "value": "SK", "label": "Slovakia" }{ "value": "SV", "label": "El Salvador" }{ "value": "TH", "label": "Thailand" }{ "value": "TN", "label": "Tunisia" }{ "value": "TR", "label": "Turkey" }{ "value": "TW", "label": "Taiwan" }{ "value": "TZ", "label": "Tanzania" }{ "value": "UA", "label": "Ukraine" }{ "value": "UY", "label": "Uruguay" }{ "value": "VG", "label": "British Virgin Islands" }{ "value": "VI", "label": "U.S. Virgin Islands" }{ "value": "VN", "label": "Vietnam" }{ "value": "WS", "label": "Samoa" }{ "value": "ZA", "label": "South Africa" }`
Phone	`phone`	`string`	Phone of the affiliate
Send Welcome	`sendWelcome`	`boolean`	Send welcome email to affiliate
Conversion Trigger Coupon	`conversionTriggerCoupon`	`string`	A unique coupon code to assign to this affiliate as a conversion trigger.
Unique Merchant ID	`uniqueMerchantId`	`string`	An optional alphanumeric identifier for the affiliate for your team's internal use.

Action Authentication#

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

To retrieve your Refersion Public and Secret keys,

Navigate to your Refersion account and sign in
Go to “Account” > “Settings” > “Refersion API” > “Refersion API Keys”