Purchase Shipping Labels with ShipEngine

Use this extension to create domestic US or international shipping labels with ShipEngine. Quickly integrate over 60 carriers to expand your global reach. See the full list of carriers here.

Here’s a basic example document write that would trigger this extension:

admin
  .firestore()
  .collection('shipments')
  .add({
    shipment: {
      carrierId: 'se-423887',
      serviceCode: 'usps_media_mail',
      shipDate: '2021-09-21',
      validateAddress: 'no_validation',
      shipTo: {
        name: 'Amanda Miller',
        addressLine1: '525 S Winchester Blvd',
        cityLocality: 'San Jose',
        stateProvince: 'CA',
        postalCode: '95128',
        countryCode: 'US',
      },
      shipFrom: {
        name: 'John Doe',
        phone: '111-111-1111',
        addressLine1: '4009 Marathon Blvd',
        addressLine2: 'Suite 300',
        cityLocality: 'Austin',
        stateProvince: 'TX',
        postalCode: '78756',
        countryCode: 'US',
      },
      packages: [
        {
          weight: {
            value: 1.0,
            unit: 'ounce',
          },
        },
      ],
    },
  });

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|https://www.shipengine.com/signup/?ref=firebase] 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.