← AfterShip

Create Tracking with AfterShip API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Tracking with the AfterShip API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Tracking with the AfterShip API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Tracking with AfterShip API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + AfterShip
 
Try it
Create Tracking with AfterShip API on New Submission from Typeform API
Typeform + AfterShip
 
Try it
Create Tracking with AfterShip API on Custom Events from Zoom API
Zoom + AfterShip
 
Try it
Create Tracking with AfterShip API on New Submission (Instant) from Jotform API
Jotform + AfterShip
 
Try it
Create Tracking with AfterShip API on New Scheduled Tasks from Pipedream API
Pipedream + AfterShip
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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.
LabelPropTypeDescription
AfterShipaftershipappThis component uses the AfterShip app.
Tracking NumbertrackingNumberstring

The tracking number of the shipment.

Slugslugstring

The unique code of the courier. Get courier codes here.

Titletitlestring

By default this field shows the tracking_number, but you can customize it as you wish with any info (e.g. the order number).

SMSessmsesstring[]

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.

Emailsemailsstring[]

Email address(es) to receive email notifications. Accept either array or comma separated as input. Supports up to 3 email addresses.

Customer NamecustomerNamestring

Customer name of the tracking.

Order IDorderIdstring

A globally-unique identifier for the order.

Order ID PathorderIdPathstring

The URL for the order in your system or store.

Custom FieldscustomFieldsobject

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 NumberorderNumberstring

A unique, human-readable identifier for the order.

LanguagelanguagestringSelect 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 DateorderPromisedDeliveryDatestring

The promised delivery date of the order. It uses the format YYYY-MM-DD.

Delivery TypedeliveryTypestringSelect a value from the drop down menu:pickup_at_storepickup_at_courierdoor_to_door
Pickup locationpickupLocationstring

Shipment pickup location for receiver.

Pickup NotepickupNotestring

Shipment pickup note for receiver.

Tracking Account NumbertrackingAccountNumberstring

The shipper's carrier account number. Refer to this article on additional tracking fields for more details.

Tracking KeytrackingKeystring

A type of tracking credential required by some carriers. Refer to this article on additional tracking fields for more details.

Tracking Ship DatetrackingShipDatestring

The date the shipment was sent, using the format YYYYMMDD. Refer to this article on additional tracking fields for more details.

Origin Country ISO3originCountryIso3string

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 StateoriginStatestring

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 CityoriginCitystring

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 CodeoriginPostalCodestring

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 LocationoriginRawLocationstring

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 ISO3destinationCountryIso3string

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 StatedestinationStatestring

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 CitydestinationCitystring

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.

Notenotestring

Text field for the note.

Order DateorderDatestring

Order date in YYYY-MM-DDTHH:mm:ssZ format. e.g. 2021-07-26T11:23:51-05:00

Shipment TypeshipmentTypestring

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 TagsshipmentTagsstring[]

Used to add tags to your shipments to help categorize and filter them easily. Max 50 items.

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 Use AfterShip

Actions

Get Tracking with the AfterShip API

Obtains an existing tracking system's data by ID. See the documentation

 
Try it
Update Tracking with the AfterShip API

Updates an existing tracking. See the documentation

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Salesforce (REST API)
Salesforce (REST API)
Web services API for interacting with Salesforce
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
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.
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Snowflake
Snowflake
A data warehouse built for the cloud
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.