Create Tracking with AfterShip API on New Email Received from Gmail API

Pipedream makes it easy to connect APIs for AfterShip, Gmail and 2,200+ other apps remarkably fast.

Trigger workflow on

New Email Received from the Gmail API

Next, do this

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

Select this integration
Configure the New Email Received trigger
1. Connect your Gmail account
2. Select a Trigger Type
3. Optional- Configure Service Account Key JSON
4. Configure serviceAccountKeyJsonInstructions
5. Optional- Select a Pub/Sub Topic
6. Optional- Select a Pub/Sub Topic Name
7. Optional- Select a Label
8. Configure permissionAlert
9. Configure latencyWarningAlert
Configure the Create Tracking action
1. Connect your AfterShip account
2. Configure Tracking Number
3. Optional- Configure Slug
4. Optional- Configure Title
5. Optional- Configure SMSes
6. Optional- Configure Emails
7. Optional- Configure Customer Name
8. Optional- Configure Order ID
9. Optional- Configure Order ID Path
10. Optional- Configure Custom Fields
11. Optional- Configure Order Number
12. Optional- Select a Language
13. Optional- Configure Order Promised Delivery Date
14. Optional- Select a Delivery Type
15. Optional- Configure Pickup location
16. Optional- Configure Pickup Note
17. Optional- Configure Tracking Account Number
18. Optional- Configure Tracking Key
19. Optional- Configure Tracking Ship Date
20. Optional- Configure Origin Country ISO3
21. Optional- Configure Origin State
22. Optional- Configure Origin City
23. Optional- Configure Origin Postal Code
24. Optional- Configure Origin Raw Location
25. Optional- Configure Destination Country ISO3
26. Optional- Configure Destination State
27. Optional- Configure Destination City
28. Optional- Configure Note
29. Optional- Configure Order Date
30. Optional- Configure Shipment Type
31. Optional- Configure Shipment Tags
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 Email Received on Gmail

Description:Emit new event when a new email is received.

Version:0.1.6

Key:gmail-new-email-received

View on GitHub

New Email Received Overview#

The Gmail - New Email Received (Instant) source enables you to trigger Pipedream workflows based on real-time changes to your Gmail inbox.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-history.mjs";
import {
  axios,
  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
  ConfigurationError,
} from "@pipedream/platform";
import { PubSub } from "@google-cloud/pubsub";
import { v4 as uuidv4 } from "uuid";
import verifyClient from "../common/verify-client-id.mjs";

export default {
  ...common,
  key: "gmail-new-email-received",
  name: "New Email Received",
  description: "Emit new event when a new email is received.",
  type: "source",
  version: "0.1.6",
  dedupe: "unique",
  props: {
    gmail,
    db: "$.service.db",
    triggerType: {
      type: "string",
      label: "Trigger Type",
      options: [
        "webhook",
        "polling",
      ],
      description:
        "Configuring this source as a `webhook` (instant) trigger requires a custom OAuth client. [Refer to the guide here to get started](https://pipedream.com/apps/gmail/#getting-started).",
      reloadProps: true,
    },
    serviceAccountKeyJson: {
      type: "string",
      label: "Service Account Key JSON",
      optional: true,
      hidden: true,
      reloadProps: true,
    },
    serviceAccountKeyJsonInstructions: {
      type: "alert",
      alertType: "info",
      content: `1) [Create a service account in GCP](https://cloud.google.com/iam/docs/creating-managing-service-accounts) and set the following permission: **Pub/Sub Admin**
        \n2) [Generate a service account key](https://cloud.google.com/iam/docs/creating-managing-service-account-keys)
        \n3) Download the key details in JSON format
        \n4) Open the JSON in a text editor, and **copy and paste its contents here**.
      `,
      hidden: true,
    },
    topicType: {
      type: "string",
      label: "Pub/Sub Topic",
      description:
        "Do you have an existing Pub/Sub topic, or would you like to create a new one?",
      options: [
        "existing",
        "new",
      ],
      optional: true,
      hidden: true,
      reloadProps: true,
    },
    topic: {
      type: "string",
      label: "Pub/Sub Topic Name",
      description: "Select a Pub/Sub topic from your GCP account to watch",
      async options() {
        return this.getTopics();
      },
      optional: true,
      hidden: true,
      reloadProps: true,
    },
    label: {
      propDefinition: [
        gmail,
        "label",
      ],
      default: "INBOX",
      optional: true,
      hidden: true,
    },
    permissionAlert: {
      type: "alert",
      alertType: "error",
      content: `Unable to grant publish permission to Gmail API service account.
      \n1. Navigate to your [Google Cloud PubSub Topics List](https://console.cloud.google.com/cloudpubsub)
      \n2. Select "View Permissions" for the topic you intend to use for this source.
      \n3. Click "ADD PRINCIPAL"
      \n4. Select "Pub/Sub Publisher" for the Role.
      \n5. Enter \`serviceAccount:gmail-api-push@system.gserviceaccount.com\` as the principal. 
      \n6. Click "Save"
      `,
      hidden: true,
    },
    latencyWarningAlert: {
      type: "alert",
      alertType: "warning",
      content:
        "Please allow up to 1 minute for deployment. We're setting up your real-time email notifications behind the scenes.",
      hidden: true,
    },
  },
  async additionalProps(props) {
    const newProps = {};
    if (this.triggerType === "polling") {
      newProps.timer = {
        type: "$.interface.timer",
        default: {
          intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
        },
      };
    }
    if (this.triggerType === "webhook") {
      // verify that a Custom OAuth client is being used
      const isValidClientId = await this.checkClientId();
      if (!isValidClientId) {
        throw new ConfigurationError(
          "Configuring this source as a `webhook` (instant) trigger requires a custom OAuth client. [Refer to the guide here to get started](https://pipedream.com/apps/gmail/#getting-started).",
        );
      }

      newProps.http = "$.interface.http";
      newProps.timer = {
        type: "$.interface.timer",
        default: {
          intervalSeconds: 24 * 60 * 60,
        },
        hidden: true,
      };

      props.serviceAccountKeyJson.hidden = false;
      props.serviceAccountKeyJson.optional = false;
      props.serviceAccountKeyJsonInstructions.hidden = false;

      if (!this.serviceAccountKeyJson) {
        return newProps;
      }

      props.topicType.hidden = false;
      props.topicType.optional = false;

      if (!this.topicType) {
        return newProps;
      }

      // create topic prop
      let topicName = this.topic;
      if (this.topicType === "new") {
        const authKeyJSON = JSON.parse(this.serviceAccountKeyJson);
        const { project_id: projectId } = authKeyJSON;
        topicName = `projects/${projectId}/topics/${this.convertNameToValidPubSubTopicName(
          uuidv4(),
        )}`;
        props.topic.default = topicName;
        props.topic.reloadProps = false;
      } else {
        props.topic.hidden = false;
        props.topic.optional = false;
      }

      if (this.topic || this.topicType === "new") {
        const topic = await this.getOrCreateTopic(topicName);

        // Retrieves the IAM policy for the topic
        let hasPublisherRole;
        try {
          const [
            policy,
          ] = await topic.iam.getPolicy();
          hasPublisherRole = policy.bindings.find(
            ({
              members, role,
            }) =>
              members.includes(
                "serviceAccount:gmail-api-push@system.gserviceaccount.com",
              ) && role === "roles/pubsub.publisher",
          );
        } catch {
          console.log("Could not retrieve iam policy");
        }

        if (!hasPublisherRole) {
          // Grant publish permission to Gmail API service account
          try {
            await topic.iam.setPolicy({
              bindings: [
                {
                  role: "roles/pubsub.publisher",
                  members: [
                    "serviceAccount:gmail-api-push@system.gserviceaccount.com",
                  ],
                },
              ],
            });
            console.log("Permissions granted to Gmail API service account.");
          } catch {
            props.permissionAlert.hidden = false;
            return newProps;
          }
        }

        props.latencyWarningAlert.hidden = false;

        const historyId = await this.setupGmailNotifications(topicName);
        newProps.initialHistoryId = {
          type: "string",
          default: historyId,
          hidden: true,
        };
      }
    }
    props.label.hidden = false;
    return newProps;
  },
  hooks: {
    ...common.hooks,
    async activate() {
      if (this.triggerType === "polling") {
        return;
      }

      const sdkParams = this.sdkParams();
      const pubSubClient = new PubSub(sdkParams);

      const currentTopic = {
        name: this.topic,
      };

      // Create subscription
      const pushEndpoint = this.http.endpoint;
      const subscriptionName =
        this.convertNameToValidPubSubTopicName(pushEndpoint);
      const subscriptionOptions = {
        pushConfig: {
          pushEndpoint,
        },
      };
      const [
        subscriptionResult,
      ] = await pubSubClient
        .topic(currentTopic.name)
        .createSubscription(subscriptionName, subscriptionOptions);
      this._setSubscriptionName(subscriptionResult.name);
    },
    async deactivate() {
      if (this.triggerType === "polling") {
        return;
      }

      const sdkParams = this.sdkParams();
      const pubSubClient = new PubSub(sdkParams);

      const subscriptionName = this._getSubscriptionName();
      if (subscriptionName) {
        await pubSubClient.subscription(subscriptionName).delete();
      }
    },
  },
  methods: {
    ...verifyClient.methods,
    ...common.methods,
    _getTopicName() {
      return this.db.get("topicName");
    },
    _setTopicName(topicName) {
      this.db.set("topicName", topicName);
    },
    _getSubscriptionName() {
      return this.db.get("subscriptionName");
    },
    _setSubscriptionName(subscriptionName) {
      this.db.set("subscriptionName", subscriptionName);
    },
    _getLastProcessedHistoryId() {
      return this.db.get("lastProcessedHistoryId");
    },
    _setLastProcessedHistoryId(lastProcessedHistoryId) {
      this.db.set("lastProcessedHistoryId", lastProcessedHistoryId);
    },
    sdkParams() {
      const authKeyJSON = JSON.parse(this.serviceAccountKeyJson);
      const {
        project_id: projectId, client_email, private_key,
      } = authKeyJSON;
      const sdkParams = {
        credentials: {
          client_email,
          private_key,
        },
        projectId,
      };
      return sdkParams;
    },
    async getTopics() {
      const sdkParams = this.sdkParams();
      const pubSubClient = new PubSub(sdkParams);
      const topics = (await pubSubClient.getTopics())[0];
      if (topics.length > 0) {
        return topics.map((topic) => topic.name);
      }
      return [];
    },
    convertNameToValidPubSubTopicName(name) {
      // For valid names, see https://cloud.google.com/pubsub/docs/admin#resource_names
      return (
        name
          // Must not start with `goog`. We add a `pd-` at the beginning if that's the case.
          .replace(/(^goog.*)/g, "pd-$1")
          // Must start with a letter, otherwise we add `pd-` at the beginning.
          .replace(/^(?![a-zA-Z]+)/, "pd-")
          // Only certain characters are allowed, the rest will be replaced with a `-`.
          .replace(/[^a-zA-Z0-9_\-.~+%]+/g, "-")
      );
    },
    makeRequest({
      $ = this, path, ...opts
    }) {
      return axios($, {
        url: `https://gmail.googleapis.com/gmail/v1${path}`,
        headers: {
          Authorization: `Bearer ${this.gmail.getToken()}`,
        },
        ...opts,
      });
    },
    async setupGmailNotifications(topicName) {
      // Set up Gmail push notifications using OAuth token
      const watchResponse = await this.makeRequest({
        method: "POST",
        path: "/users/me/watch",
        data: {
          topicName,
          labelIds: [
            this.label || "INBOX",
          ],
        },
      });
      console.log("Watch response:", watchResponse);
      return watchResponse.historyId;
    },
    async getOrCreateTopic(name) {
      const sdkParams = this.sdkParams();
      const pubSubClient = new PubSub(sdkParams);
      const topicName = name || this.topic;
      // Create or get Pub/Sub topic
      let topic;
      try {
        [
          topic,
        ] = await pubSubClient.createTopic(topicName);
        console.log(`Topic ${topicName} created.`);
      } catch (error) {
        if (error.code === 6) {
          // Already exists
          topic = pubSubClient.topic(topicName);
        } else {
          throw error;
        }
      }
      return topic;
    },
    getHistoryTypes() {
      return [
        "messageAdded",
      ];
    },
    generateMeta(message) {
      return {
        id: message.id,
        summary: message.snippet,
        ts: +message.internalDate,
      };
    },
    filterHistory(history) {
      return this.label
        ? history.filter(
          (item) =>
            item.messagesAdded?.length &&
              item.messagesAdded[0].message.labelIds &&
              item.messagesAdded[0].message.labelIds.includes(this.label),
        )
        : history.filter((item) => item.messagesAdded?.length);
    },
    async getMessageDetails(ids) {
      const messages = await Promise.all(ids.map(async (id) => {
        try {
          const message = await this.gmail.getMessage({
            id,
          });
          return message;
        } catch {
          console.log(`Could not find message ${id}`);
          return null;
        }
      }));
      return messages;
    },
  },
  async run(event) {
    if (this.triggerType === "polling") {
      let lastHistoryId = this._getLastHistoryId();

      if (!lastHistoryId) {
        lastHistoryId = await this.getHistoryId();
      }
      await this.emitHistories(lastHistoryId);
    }

    if (this.triggerType === "webhook") {
      if (event.timestamp) {
        // event was triggered by timer
        const topicName = this._getTopicName();
        if (topicName) {
          // renew Gmail push notifications
          await this.setupGmailNotifications(topicName);
          return;
        } else {
          // first run, no need to renew push notifications
          this._setTopicName(this.topic);
          this._setLastProcessedHistoryId(this.initialHistoryId);
          return;
        }
      }

      // Extract the Pub/Sub message data
      const pubsubMessage = event.body.message;
      if (!pubsubMessage) {
        return;
      }
      const decodedData = JSON.parse(
        Buffer.from(pubsubMessage.data, "base64").toString(),
      );

      console.log("Decoded Pub/Sub data:", decodedData);

      const { historyId: receivedHistoryId } = decodedData;

      // Retrieve the last processed historyId
      const lastProcessedHistoryId = this._getLastProcessedHistoryId();
      console.log("Last processed historyId:", lastProcessedHistoryId);

      // Use the minimum of lastProcessedHistoryId and the received historyId
      const startHistoryId = Math.min(
        parseInt(lastProcessedHistoryId),
        parseInt(receivedHistoryId),
      );
      console.log("Using startHistoryId:", startHistoryId);

      // Fetch the history
      const historyResponse = await this.gmail.listHistory({
        startHistoryId,
        historyTypes: [
          "messageAdded",
        ],
        labelId: this.label,
      });

      console.log(
        "History response:",
        JSON.stringify(historyResponse, null, 2),
      );

      // Process history to find new messages
      const newMessages = [];
      if (historyResponse.history) {
        for (const historyItem of historyResponse.history) {
          if (historyItem.messagesAdded) {
            newMessages.push(
              ...historyItem.messagesAdded.map((msg) => msg.message),
            );
          }
        }
      }

      console.log("New messages found:", newMessages.length);

      // Fetch full message details for new messages
      const newMessageIds = newMessages?.map(({ id }) => id) || [];
      const messageDetails = await this.getMessageDetails(newMessageIds);

      if (!messageDetails?.length) {
        return;
      }

      console.log("Fetched message details count:", messageDetails.length);

      // Store the latest historyId in the db
      const latestHistoryId = historyResponse.historyId || receivedHistoryId;
      this._setLastProcessedHistoryId(latestHistoryId);
      console.log("Updated lastProcessedHistoryId:", latestHistoryId);

      messageDetails.forEach((message) => {
        if (message?.id) {
          this.emitEvent(message);
        }
      });
    }
  },
};

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
Gmail	`gmail`	`app`	This component uses the Gmail app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Trigger Type	`triggerType`	`string`	Select a value from the drop down menu:`webhookpolling`

Trigger Authentication#

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

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

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

Create Tracking on AfterShip

Description:Creates a tracking. [See the documentation](https://www.aftership.com/docs/api/4/trackings/post-trackings)

Version:0.1.0

Key:aftership-create-tracking

View on GitHub

AfterShip Overview#

The AfterShip API on Pipedream allows you to seamlessly track shipments across various carriers, get real-time updates, and manage delivery exceptions. It's a gold mine for automating post-purchase customer communication and optimizing logistics operations. By integrating with AfterShip, you can create workflows that trigger upon shipment status changes, delays, or successful deliveries, and connect these events with other apps to streamline your e-commerce processes.

Action Code#

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

export default {
  ...common,
  key: "aftership-create-tracking",
  name: "Create Tracking",
  description: "Creates a tracking. [See the documentation](https://www.aftership.com/docs/api/4/trackings/post-trackings)",
  version: "0.1.0",
  type: "action",
  props: {
    aftership,
    trackingNumber: {
      propDefinition: [
        aftership,
        "trackingNumber",
      ],
    },
    ...common.props,
    shipmentTags: {
      propDefinition: [
        aftership,
        "shipmentTags",
      ],
    },
  },
  async run({ $ }) {
    if (this.trackingNumber.length < 4 || this.trackingNumber.length > 100) {
      throw new ConfigurationError("We only accept tracking numbers with length from 4 to 100");
    }
    const response = await this.aftership.createTracking({
      $,
      data: {
        tracking: this.getData(),
      },
    });

    $.export("$summary", `Successfully created tracking with ID ${response.data.tracking.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
AfterShip	`aftership`	`app`	This component uses the AfterShip app.
Tracking Number	`trackingNumber`	`string`	The tracking number of the shipment.
Slug	`slug`	`string`	The unique code of the courier. Get courier codes here.
Title	`title`	`string`	By default this field shows the `tracking_number`, but you can customize it as you wish with any info (e.g. the order number).
SMSes	`smses`	`string[]`	The phone number(s) to receive sms notifications. Enter `+` andarea `code before` phone number. Accept either array or comma separated as input. Supports up to 3 phone numbers.
Emails	`emails`	`string[]`	Email address(es) to receive email notifications. Accept either array or comma separated as input. Supports up to 3 email addresses.
Customer Name	`customerName`	`string`	Customer name of the tracking.
Order ID	`orderId`	`string`	A globally-unique identifier for the order.
Order ID Path	`orderIdPath`	`string`	The URL for the order in your system or store.
Custom Fields	`customFields`	`object`	Custom fields that accept an object with string field. In order to protect the privacy of your customers, do not include any personal data in custom fields.
Order Number	`orderNumber`	`string`	A unique, human-readable identifier for the order.
Language	`language`	`string`	Select a value from the drop down menu:`{ "value": "ab", "label": "Abkhazian" }{ "value": "aa", "label": "Afar" }{ "value": "af", "label": "Afrikaans" }{ "value": "ak", "label": "Akan" }{ "value": "sq", "label": "Albanian" }{ "value": "am", "label": "Amharic" }{ "value": "ar", "label": "Arabic" }{ "value": "an", "label": "Aragonese" }{ "value": "hy", "label": "Armenian" }{ "value": "as", "label": "Assamese" }{ "value": "av", "label": "Avaric" }{ "value": "ae", "label": "Avestan" }{ "value": "ay", "label": "Aymara" }{ "value": "az", "label": "Azerbaijani" }{ "value": "bm", "label": "Bambara" }{ "value": "ba", "label": "Bashkir" }{ "value": "eu", "label": "Basque" }{ "value": "be", "label": "Belarusian" }{ "value": "bn", "label": "Bengali (Bangla)" }{ "value": "bh", "label": "Bihari" }{ "value": "bi", "label": "Bislama" }{ "value": "bs", "label": "Bosnian" }{ "value": "br", "label": "Breton" }{ "value": "bg", "label": "Bulgarian" }{ "value": "my", "label": "Burmese" }{ "value": "ca", "label": "Catalan" }{ "value": "ch", "label": "Chamorro" }{ "value": "ce", "label": "Chechen" }{ "value": "ny", "label": "Chichewa, Chewa, Nyanja" }{ "value": "zh", "label": "Chinese" }{ "value": "zh-Hans", "label": "Chinese (Simplified)" }{ "value": "zh-Hant", "label": "Chinese (Traditional)" }{ "value": "cv", "label": "Chuvash" }{ "value": "kw", "label": "Cornish" }{ "value": "co", "label": "Corsican" }{ "value": "cr", "label": "Cree" }{ "value": "hr", "label": "Croatian" }{ "value": "cs", "label": "Czech" }{ "value": "da", "label": "Danish" }{ "value": "dv", "label": "Divehi, Dhivehi, Maldivian" }{ "value": "nl", "label": "Dutch" }{ "value": "dz", "label": "Dzongkha" }{ "value": "en", "label": "English" }{ "value": "eo", "label": "Esperanto" }{ "value": "et", "label": "Estonian" }{ "value": "ee", "label": "Ewe" }{ "value": "fo", "label": "Faroese" }{ "value": "fj", "label": "Fijian" }{ "value": "fi", "label": "Finnish" }{ "value": "fr", "label": "French" }{ "value": "ff", "label": "Fula, Fulah, Pulaar, Pular" }{ "value": "gl", "label": "Galician" }{ "value": "gd", "label": "Gaelic (Scottish)" }{ "value": "gv", "label": "Gaelic (Manx), Manx" }{ "value": "ka", "label": "Georgian" }{ "value": "de", "label": "German" }{ "value": "el", "label": "Greek" }{ "value": "kl", "label": "Kalaallisut, Greenlandic" }{ "value": "gn", "label": "Guarani" }{ "value": "gu", "label": "Gujarati" }{ "value": "ht", "label": "Haitian Creole" }{ "value": "ha", "label": "Hausa" }{ "value": "he", "label": "Hebrew" }{ "value": "hz", "label": "Herero" }{ "value": "hi", "label": "Hindi" }{ "value": "ho", "label": "Hiri motu" }{ "value": "hu", "label": "Hungarian" }{ "value": "is", "label": "Icelandic" }{ "value": "io", "label": "Ido" }{ "value": "ig", "label": "Igbo" }{ "value": "id", "label": "Indonesian" }{ "value": "ia", "label": "Interlingua" }{ "value": "ie", "label": "Interlingue" }{ "value": "iu", "label": "Inuktitut" }{ "value": "ik", "label": "Inupiak" }{ "value": "ga", "label": "Irish" }{ "value": "it", "label": "Italian" }{ "value": "ja", "label": "Japanese" }{ "value": "jv", "label": "Javanese" }{ "value": "kn", "label": "Kannada" }{ "value": "kr", "label": "Kanuri" }{ "value": "ks", "label": "Kashmiri" }{ "value": "kk", "label": "Kazakh" }{ "value": "km", "label": "Khmer" }{ "value": "ki", "label": "Kikuyu" }{ "value": "rw", "label": "Kinyarwanda (Rwanda)" }{ "value": "rn", "label": "Kirundi" }{ "value": "ky", "label": "Kyrgyz" }{ "value": "kv", "label": "Komi" }{ "value": "kg", "label": "Kongo" }{ "value": "ko", "label": "Korean" }{ "value": "ku", "label": "Kurdish" }{ "value": "kj", "label": "Kwanyama" }{ "value": "lo", "label": "Lao" }{ "value": "la", "label": "Latin" }{ "value": "lv", "label": "Latvian (Lettish)" }{ "value": "li", "label": "Limburgish ( Limburger)" }{ "value": "ln", "label": "Lingala" }{ "value": "lt", "label": "Lithuanian" }{ "value": "lu", "label": "Luga-Katanga" }{ "value": "lg", "label": "Luganda, Ganda" }{ "value": "lb", "label": "Luxembourgish" }{ "value": "mk", "label": "Macedonian" }{ "value": "mg", "label": "Malagasy" }{ "value": "ms", "label": "Malay" }{ "value": "ml", "label": "Malayalam" }{ "value": "mt", "label": "Maltese" }{ "value": "mi", "label": "Maori" }{ "value": "mr", "label": "Marathi" }{ "value": "mh", "label": "Marshallese" }{ "value": "mn", "label": "Mongolian" }{ "value": "na", "label": "Nauru" }{ "value": "nv", "label": "Navajo" }{ "value": "ng", "label": "Ndonga" }{ "value": "nd", "label": "Northern Ndebele" }{ "value": "ne", "label": "Nepali" }{ "value": "no", "label": "Norwegian" }{ "value": "nb", "label": "Norwegian bokmål" }{ "value": "nn", "label": "Norwegian nynorsk" }{ "value": "ii", "label": "Nuosu, Sichuan Yi" }{ "value": "oc", "label": "Occitan" }{ "value": "oj", "label": "Ojibwe" }{ "value": "cu", "label": "Old Church Slavonic, Old Bulgarian" }{ "value": "or", "label": "Oriya" }{ "value": "om", "label": "Oromo (Afaan Oromo)" }{ "value": "os", "label": "Ossetian" }{ "value": "pi", "label": "Pāli" }{ "value": "ps", "label": "Pashto, Pushto" }{ "value": "fa", "label": "Persian (Farsi)" }{ "value": "pl", "label": "Polish" }{ "value": "pt", "label": "Portuguese" }{ "value": "pa", "label": "Punjabi (Eastern)" }{ "value": "qu", "label": "Quechua" }{ "value": "rm", "label": "Romansh" }{ "value": "ro", "label": "Romanian" }{ "value": "ru", "label": "Russian" }{ "value": "se", "label": "Sami" }{ "value": "sm", "label": "Samoan" }{ "value": "sg", "label": "Sango" }{ "value": "sa", "label": "Sanskrit" }{ "value": "sr", "label": "Serbian" }{ "value": "st", "label": "Sesotho" }{ "value": "tn", "label": "Setswana" }{ "value": "sn", "label": "Shona" }{ "value": "sd", "label": "Sindhi" }{ "value": "si", "label": "Sinhalese" }{ "value": "ss", "label": "Siswati, Swati" }{ "value": "sk", "label": "Slovak" }{ "value": "sl", "label": "Slovenian" }{ "value": "so", "label": "Somali" }{ "value": "nr", "label": "Southern Ndebele" }{ "value": "es", "label": "Spanish" }{ "value": "su", "label": "Sundanese" }{ "value": "sw", "label": "Swahili (Kiswahili)" }{ "value": "sv", "label": "Swedish" }{ "value": "tl", "label": "Tagalog" }{ "value": "ty", "label": "Tahitian" }{ "value": "tg", "label": "Tajik" }{ "value": "ta", "label": "Tamil" }{ "value": "tt", "label": "Tatar" }{ "value": "te", "label": "Telugu" }{ "value": "th", "label": "Thai" }{ "value": "bo", "label": "Tibetan" }{ "value": "ti", "label": "Tigrinya" }{ "value": "to", "label": "Tonga" }{ "value": "ts", "label": "Tsonga" }{ "value": "tr", "label": "Turkish" }{ "value": "tk", "label": "Turkmen" }{ "value": "tw", "label": "Twi" }{ "value": "ug", "label": "Uyghur" }{ "value": "uk", "label": "Ukrainian" }{ "value": "ur", "label": "Urdu" }{ "value": "uz", "label": "Uzbek" }{ "value": "ve", "label": "Venda" }{ "value": "vi", "label": "Vietnamese" }{ "value": "vo", "label": "Volapük" }{ "value": "wa", "label": "Wallon" }{ "value": "cy", "label": "Welsh" }{ "value": "wo", "label": "Wolof" }{ "value": "fy", "label": "Western Frisian" }{ "value": "xh", "label": "Xhosa" }{ "value": "yi", "label": "Yiddish" }{ "value": "yo", "label": "Yoruba" }{ "value": "za", "label": "Zhuang, Chuang" }{ "value": "zu", "label": "Zulu" }`
Order Promised Delivery Date	`orderPromisedDeliveryDate`	`string`	The promised delivery date of the order. It uses the format `YYYY-MM-DD`.
Delivery Type	`deliveryType`	`string`	Select a value from the drop down menu:`pickup_at_storepickup_at_courierdoor_to_door`
Pickup location	`pickupLocation`	`string`	Shipment pickup location for receiver.
Pickup Note	`pickupNote`	`string`	Shipment pickup note for receiver.
Tracking Account Number	`trackingAccountNumber`	`string`	The shipper's carrier account number. Refer to this article on additional tracking fields for more details.
Tracking Key	`trackingKey`	`string`	A type of tracking credential required by some carriers. Refer to this article on additional tracking fields for more details.
Tracking Ship Date	`trackingShipDate`	`string`	The date the shipment was sent, using the format `YYYYMMDD`. Refer to this article on additional tracking fields for more details.
Origin Country ISO3	`originCountryIso3`	`string`	The ISO Alpha-3 code (3 letters) for the origin country/region. E.g. `USA` for the United States. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Origin State	`originState`	`string`	The state of the sender's address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Origin City	`originCity`	`string`	The city of the sender's address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Origin Postal Code	`originPostalCode`	`string`	The postal of the sender's address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Origin Raw Location	`originRawLocation`	`string`	The sender address that the shipment is shipping from. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Destination Country ISO3	`destinationCountryIso3`	`string`	The ISO Alpha-3 code (3 letters) for the destination country/region. E.g. `USA` for the United States. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Destination State	`destinationState`	`string`	The state of the recipient's address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Destination City	`destinationCity`	`string`	The city of the recipient's address. This can help AfterShip with various functions like tracking, carrier auto-detection and auto-correction, calculating an EDD, etc.
Note	`note`	`string`	Text field for the note.
Order Date	`orderDate`	`string`	Order date in YYYY-MM-DDTHH:mm:ssZ format. e.g. `2021-07-26T11:23:51-05:00`
Shipment Type	`shipmentType`	`string`	The carrier service type for the shipment. If you provide info for this field, AfterShip will not update it with info from the carrier.
Shipment Tags	`shipmentTags`	`string[]`	Used to add tags to your shipments to help categorize and filter them easily. Max 50 items.

Action Authentication#

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

About AfterShip#

Create a world-class post-purchase experience.

More Ways to Connect AfterShip + Gmail#

Other Popular Integrations#

Create Tracking with AfterShip API on New Labeled Email from Gmail API

Gmail + AfterShip

Create Tracking with AfterShip API on New Email Received from Gmail API

Pipedream makes it easy to connect APIs for AfterShip, Gmail and 2,200+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,200+apps by most popular

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