Track Shipping Labels with ShipEngine

Made by ShipEngine

Provides a callable https function for retrieving label tracking data and a https webhook endpoint for live tracking updates from a ShipEngine account.

Install in Console
Works with
Cloud Firestore
Source
Source code
License
Apache-2.0
Version
0.0.7
Author
ShipEngine

How this extension works

Use this extension to retrieve up-to-date tracking data for any shipment from any carrier using a valid tracking number and a supported carrier code or a ShipEngine label ID.

Here’s an example function call that would trigger this extension:

import { initializeApp } from 'firebase/app';
import { getFunctions, httpsCallable } from 'firebase/functions';

const app = initializeApp({
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
});

const functions = getFunctions(app);

const trackLabel = httpsCallable(functions, 'trackLabel');

trackLabel({
  trackingNumber: '9405511899223197428490',
  carrierCode: 'stamps_com',
}).then((result) => {
  // Read result of the Cloud Function.
  /** @type {any} */
  const data = result.data;
});

Additional setup

Before installing this extension, make sure that you’ve set up a Cloud Firestore database in your Firebase project.

You must also create a ShipEngine account or use your existing account and supply your ShipEngine API Key from the ShipEngine API Management page when you configure this extension.

Billing

To install an extension, your project must be on the Blaze (pay as you go) plan

  • You will be charged a small amount (typically around $0.01/month) for the Firebase resources required by this extension (even if it is not used).
  • This extension uses other Firebase and Google Cloud Platform services, which have associated charges if you exceed the service’s free tier:
    • Cloud Firestore
    • Cloud Functions (Node.js 15+ runtime. See FAQs)
    • Cloud Secret Manager

Usage of this extension also requires you to have a ShipEngine account. You are responsible for any associated costs with your usage of your ShipEngine account.