Validate An Address with Shipengine API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Validate An Address with the Shipengine API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Configure the Validate An Address action
1. Connect your Shipengine account
2. Optional- Configure Name
3. Optional- Configure Phone
4. Configure City Or Locality
5. Configure State Or Province
6. Configure Country Code
7. Configure Address Line 1
8. Optional- Configure Address Line 2
9. Optional- Configure Address Line 3
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Validate An Address with Shipengine API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Shipengine

Try it

Validate An Address with Shipengine API on New Submission from Typeform API

Typeform + Shipengine

Try it

Validate An Address with Shipengine API on Custom Events from Zoom API

Zoom + Shipengine

Try it

Validate An Address with Shipengine API on New Submission (Instant) from Jotform API

Jotform + Shipengine

Try it

Validate An Address with Shipengine API on New Custom Webhook Events from Stripe API

Stripe + Shipengine

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.

Validate An Address on Shipengine

Description:Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/validate_address).

Version:0.0.2

Key:shipengine-validate-address

View on GitHub

Code#

import app from "../../shipengine.app.mjs";

export default {
  key: "shipengine-validate-address",
  name: "Validate An Address",
  description: "Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/validate_address).",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    name: {
      type: "string",
      label: "Name",
      description: "The name of a contact person at this address.",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "The phone number of a contact person at this address. The format of this phone number varies depending on the country.",
      optional: true,
    },
    cityLocality: {
      type: "string",
      label: "City Or Locality",
      description: "The name of the city or locality.",
    },
    stateProvince: {
      type: "string",
      label: "State Or Province",
      description: "The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.",
    },
    countryCode: {
      type: "string",
      label: "Country Code",
      description: "The two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1).",
    },
    addressLine1: {
      type: "string",
      label: "Address Line 1",
      description: "The first line of the street address. For some addresses, this may be the only line. Other addresses may have two or three lines.",
    },
    addressLine2: {
      type: "string",
      label: "Address Line 2",
      description: "The second line of the street address.",
      optional: true,
    },
    addressLine3: {
      type: "string",
      label: "Address Line 3",
      description: "The third line of the street address.",
      optional: true,
    },
  },
  methods: {
    validateAddress(args = {}) {
      return this.app.makeRequest({
        method: "post",
        path: "/addresses/validate",
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      name,
      phone,
      cityLocality,
      stateProvince,
      countryCode,
      addressLine1,
      addressLine2,
      addressLine3,
    } = this;

    const response = await this.validateAddress({
      step,
      data: [
        {
          name,
          phone,
          address_line1: addressLine1,
          address_line2: addressLine2,
          address_line3: addressLine3,
          city_locality: cityLocality,
          state_province: stateProvince,
          country_code: countryCode,
        },
      ],
    });

    step.export("$summary", "Successfully validated address");

    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.

Label	Prop	Type	Description
Shipengine	`app`	`app`	This component uses the Shipengine app.
Name	`name`	`string`	The name of a contact person at this address.
Phone	`phone`	`string`	The phone number of a contact person at this address. The format of this phone number varies depending on the country.
City Or Locality	`cityLocality`	`string`	The name of the city or locality.
State Or Province	`stateProvince`	`string`	The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
Country Code	`countryCode`	`string`	The two-letter ISO 3166-1 country code.
Address Line 1	`addressLine1`	`string`	The first line of the street address. For some addresses, this may be the only line. Other addresses may have two or three lines.
Address Line 2	`addressLine2`	`string`	The second line of the street address.
Address Line 3	`addressLine3`	`string`	The third line of the street address.

Try it

New Tracking Event (Instant) from the Shipengine API

Emit new event when a new event is tracked. See the docs.

Try it

Actions#

Find Tracking Status with the Shipengine API

Retrieves package tracking information. See the docs.

Try it

Search Labels with the Shipengine API

By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. See the docs.

Try it

Start Tracking a Package with the Shipengine API

Allows you to subscribe to tracking updates for a package. See the docs.

Try it