Validate Addresses with ShipEngine

ShipEngine
Made by ShipEngine

Validates an address based on the contents of a document written to a specified Cloud Firestore collection.

How this extension works

Use this extension to ensure valid mailing addresses around the world with ShipEngine ShipEngine. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues with shipments. This helps brands, ecommerce platforms, 3PLs avoid unnecessary returns and additional carrier fees.

Virtually every country in the world is supported, including the United States, Canada, United Kingdom, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and more than 160 others. Varying levels of validation are available in different countries. For example, one country may validate as precise as a suite/unit number, and another country may only validate as precise as the city. See the full list of countries and their level of validation

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

admin
  .firestore()
  .collection('addresses')
  .add({
    address: {
      name: 'John Smith',
      addressLine1: '200 Sunrise Mall',
      cityLocality: 'Massapequa',
      stateProvince: 'NY',
      postalCode: '11758',
      countryCode: 'US',
    },
  });

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.

How to install this extension

Using the Firebase console

To install and manage extensions, you can use the Firebase console.

Install using console

Using the Firebase CLI

To install and manage extensions, you can also use the Firebase CLI:

Step 1: Run the following npm command to install the CLI or update to the latest CLI version.

npm install -g firebase-tools
Doesn't work? Take a look at the Firebase CLI reference or change your npm permissions.

Step 2: Install this extension by running the following command

firebase ext:install shipengine/validate-addresses --project=projectId_or_alias
Supports
Cloud Firestore
License
Apache-2.0
Version
0.0.3