Author: ShipEngine (https://shipengine.com)

Description: Calculates real-time shipping rates across 60+ carriers using shipment data written to a Cloud Firestore collection.

Details: Use this extension to calculate real-time shipping rates across 50+ global carriers from documents added to a specified Cloud Firestore collection. ShipEngine retrieves all possible rates to help brands, ecommerce platforms, and 3PLs to make the best choice for every shipment, whether shipping cost, time to delivery, carrier capabilities or other factors are most important.

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

admin
  .firestore()
  .collection('shipments')
  .add({
    shipment: {
      shipTo: {
        name: 'Amanda Miller',
        addressLine1: '525 S Winchester Blvd',
        cityLocality: 'San Jose',
        stateProvince: 'CA',
        postalCode: '95128',
        countryCode: 'US',
      },
      shipFrom: {
        companyName: 'Example Corp.',
        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',
          },
        },
      ],
    },
  });

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.

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.

Configuration Parameters:

• Cloud Functions location: Where do you want to deploy the functions created for this extension? You usually want a location close to your database. For help selecting a location, refer to the location selection guide.

• ShipEngine Api Key: Api key found on the api dashboard.

• Firestore path: What is the path to the collection that contains the documents with shipment info for validation?

• Shipping Rates Key: The document key to store the rates result in.

• ShipEngine Carrier IDs: A comma separated list of Carrier IDs from your ShipEngine account.

• Input Schema: A schema object mapping the collection's data to the required ShipEngine API structure.

Cloud Functions:

• getRates: Processes shipment data in the specified Cloud Firestore collection, fetches rates, and updates the document with rate information.

• getRatesHttps: undefined

Access Required:

This extension will operate with the following project IAM roles:

• datastore.user (Reason: Allows this extension to access Cloud Firestore to read and process added documents.)