Create Shipment with UPS API on New SNS Messages from AWS API

Pipedream makes it easy to connect APIs for UPS, AWS and 3,000+ other apps remarkably fast.

Trigger workflow on

New SNS Messages from the AWS API

Next, do this

Create Shipment with the UPS 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#

This integration creates a workflow with a AWS trigger and UPS action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New SNS Messages trigger
1. Connect your AWS account
2. Select a AWS Region
3. Optional- Select a SNS Topic
4. Optional- Configure SNS Topic Name
Configure the Create Shipment action
1. Connect your UPS account
2. Configure Shipper Name
3. Configure Shipper Number
4. Configure Shipper Address Line
5. Configure Shipper City
6. Configure Shipper State Province Code
7. Configure Shipper Postal Code
8. Configure Shipper Country Code
9. Configure Ship To Name
10. Configure Ship To Address Line
11. Configure Ship To City
12. Configure Ship To State Province Code
13. Configure Ship To Postal Code
14. Configure Ship To Country Code
15. Select a Service Code
16. Select a Packaging Code
17. Select a Weight Unit
18. Configure Package Weight
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New SNS Messages on AWS

Description:Creates an SNS topic in your AWS account. Messages published to this topic are emitted from the Pipedream source.

Version:0.4.3

Key:aws-new-sns-messages

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import base from "../common/sns.mjs";
import { toSingleLineString } from "../../common/utils.mjs";
import commonSNS from "../../common/common-sns.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...base,
  key: "aws-new-sns-messages",
  name: "New SNS Messages",
  description: toSingleLineString(`
    Creates an SNS topic in your AWS account.
    Messages published to this topic are emitted from the Pipedream source.
  `),
  version: "0.4.3",
  type: "source",
  dedupe: "unique", // Dedupe on SNS message ID
  props: {
    ...base.props,
    topicArn: {
      ...commonSNS.props.topic,
      optional: true,
    },
    topic: {
      label: "SNS Topic Name",
      description: toSingleLineString(`
        **Pipedream will create an SNS topic with this name in your account**,
        converting it to a [valid SNS topic
        name](https://docs.aws.amazon.com/sns/latest/api/API_CreateTopic.html).
      `),
      type: "string",
      optional: true,
    },
  },
  methods: {
    ...base.methods,
    getTopicName() {
      return this.convertNameToValidSNSTopicName(this.topic);
    },
  },
  async run(event) {
    if (!this.topicArn && !this.topic) {
      throw new ConfigurationError("Must specify either an existing topic or a new topic name");
    }

    if (this._isSubscriptionConfirmationEvent(event)) {
      const { body } = event;
      const subscriptionArn = await this._confirmSubscription(body);
      this._setSubscriptionArn(subscriptionArn);
      return;
    }

    await this.processEvent(event);
  },
};

Trigger 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
AWS	`aws`	`app`	This component uses the AWS app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
AWS Region	`region`	`string`	Select a value from the drop down menu.
SNS Topic	`topicArn`	`string`	Select a value from the drop down menu.
SNS Topic Name	`topic`	`string`	Pipedream will create an SNS topic with this name in your account, converting it to a valid SNS topic name

Trigger Authentication#

AWS uses API keys for authentication. When you connect your AWS account, Pipedream securely stores the keys so you can easily authenticate to AWS APIs in both code and no-code steps.

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Action#

Create Shipment on UPS

Description:Create a new shipment. [See the documentation](https://developer.ups.com/tag/Shipping?loc=en_US#operation/Shipment)

Version:0.0.1

Key:ups-create-shipment

View on GitHub

Action Code#

import ups from "../../ups.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "ups-create-shipment",
  name: "Create Shipment",
  description: "Create a new shipment. [See the documentation](https://developer.ups.com/tag/Shipping?loc=en_US#operation/Shipment)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    ups,
    shipperName: {
      type: "string",
      label: "Shipper Name",
      description: "The name of the shipper",
    },
    shipperNumber: {
      type: "string",
      label: "Shipper Number",
      description: "Shipper's six digit alphanumeric account number",
    },
    shipperAddressLine: {
      type: "string",
      label: "Shipper Address Line",
      description: "The address line of the shipper",
    },
    shipperCity: {
      type: "string",
      label: "Shipper City",
      description: "The city of the shipper",
    },
    shipperStateProvinceCode: {
      type: "string",
      label: "Shipper State Province Code",
      description: "The state province code of the shipper",
    },
    shipperPostalCode: {
      type: "string",
      label: "Shipper Postal Code",
      description: "The postal code of the shipper",
    },
    shipperCountryCode: {
      type: "string",
      label: "Shipper Country Code",
      description: "The country code of the shipper",
    },
    shipToName: {
      type: "string",
      label: "Ship To Name",
      description: "The name of the ship to",
    },
    shipToAddressLine: {
      type: "string",
      label: "Ship To Address Line",
      description: "The address line of the ship to",
    },
    shipToCity: {
      type: "string",
      label: "Ship To City",
      description: "The city of the ship to",
    },
    shipToStateProvinceCode: {
      type: "string",
      label: "Ship To State Province Code",
      description: "The state province code of the ship to",
    },
    shipToPostalCode: {
      type: "string",
      label: "Ship To Postal Code",
      description: "The postal code of the ship to",
    },
    shipToCountryCode: {
      type: "string",
      label: "Ship To Country Code",
      description: "The country code of the ship to",
    },
    serviceCode: {
      type: "string",
      label: "Service Code",
      description: "The code of the service",
      options: constants.SERVICE_CODES,
    },
    packagingCode: {
      type: "string",
      label: "Packaging Code",
      description: "The code of the packaging",
      options: constants.PACKAGING_CODES,
    },
    weightUnit: {
      type: "string",
      label: "Weight Unit",
      description: "The unit of weight for the package",
      options: [
        "LBS",
        "KGS",
        "OZS",
      ],
    },
    packageWeight: {
      type: "string",
      label: "Package Weight",
      description: "The weight of the package",
    },
  },
  async run({ $ }) {
    const response = await this.ups.createShipment({
      $,
      data: {
        ShipmentRequest: {
          Request: {
            RequestOption: "nonvalidate",
          },
          Shipment: {
            Shipper: {
              Name: this.shipperName,
              ShipperNumber: this.shipperNumber,
              Address: {
                AddressLine: this.shipperAddressLine,
                City: this.shipperCity,
                StateProvinceCode: this.shipperStateProvinceCode,
                PostalCode: this.shipperPostalCode,
                CountryCode: this.shipperCountryCode,
              },
            },
            ShipTo: {
              Name: this.shipToName,
              Address: {
                AddressLine: this.shipToAddressLine,
                City: this.shipToCity,
                StateProvinceCode: this.shipToStateProvinceCode,
                PostalCode: this.shipToPostalCode,
                CountryCode: this.shipToCountryCode,
              },
            },
            PaymentInformation: {
              ShipmentCharge: [
                {
                  Type: "01", // Transportation Charge
                  BillShipper: {
                    AccountNumber: this.shipperNumber,
                  },
                },
              ],
            },
            Service: {
              Code: this.serviceCode,
            },
            Package: [
              {
                Packaging: {
                  Code: this.packagingCode,
                },
                PackageWeight: {
                  UnitOfMeasurement: {
                    Code: this.weightUnit,
                  },
                  Weight: this.packageWeight,
                },
              },
            ],
          },
        },
      },
    });
    $.export("$summary", "Shipment created successfully");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
UPS	`ups`	`app`	This component uses the UPS app.
Shipper Name	`shipperName`	`string`	The name of the shipper
Shipper Number	`shipperNumber`	`string`	Shipper's six digit alphanumeric account number
Shipper Address Line	`shipperAddressLine`	`string`	The address line of the shipper
Shipper City	`shipperCity`	`string`	The city of the shipper
Shipper State Province Code	`shipperStateProvinceCode`	`string`	The state province code of the shipper
Shipper Postal Code	`shipperPostalCode`	`string`	The postal code of the shipper
Shipper Country Code	`shipperCountryCode`	`string`	The country code of the shipper
Ship To Name	`shipToName`	`string`	The name of the ship to
Ship To Address Line	`shipToAddressLine`	`string`	The address line of the ship to
Ship To City	`shipToCity`	`string`	The city of the ship to
Ship To State Province Code	`shipToStateProvinceCode`	`string`	The state province code of the ship to
Ship To Postal Code	`shipToPostalCode`	`string`	The postal code of the ship to
Ship To Country Code	`shipToCountryCode`	`string`	The country code of the ship to
Service Code	`serviceCode`	`string`	Select a value from the drop down menu:`{ "value": "01", "label": "Next Day Air" }{ "value": "02", "label": "2nd Day Air" }{ "value": "03", "label": "Ground" }{ "value": "07", "label": "Express" }{ "value": "08", "label": "Expedited" }{ "value": "11", "label": "UPS Standard" }{ "value": "12", "label": "3 Day Select" }{ "value": "13", "label": "Next Day Air Saver" }{ "value": "14", "label": "UPS Next Day Air® Early" }{ "value": "17", "label": "UPS Worldwide Economy DDU" }{ "value": "54", "label": "Express Plus" }{ "value": "59", "label": "2nd Day Air A.M." }{ "value": "65", "label": "UPS Saver" }{ "value": "M2", "label": "First Class Mail" }{ "value": "M3", "label": "Priority Mail" }{ "value": "M4", "label": "Expedited MaiI Innovations" }{ "value": "M5", "label": "Priority Mail Innovations" }{ "value": "M6", "label": "Economy Mail Innovations" }{ "value": "M7", "label": "MaiI Innovations (MI) Returns" }{ "value": "70", "label": "UPS Access Point™ Economy" }{ "value": "71", "label": "UPS Worldwide Express Freight Midday" }{ "value": "72", "label": "UPS Worldwide Economy DDP" }{ "value": "74", "label": "UPS Express®12:00" }{ "value": "75", "label": "UPS Heavy Goods" }{ "value": "82", "label": "UPS Today Standard" }{ "value": "83", "label": "UPS Today Dedicated Courier" }{ "value": "84", "label": "UPS Today Intercity" }{ "value": "85", "label": "UPS Today Express" }{ "value": "86", "label": "UPS Today Express Saver" }{ "value": "93", "label": "Ground Saver" }{ "value": "96", "label": "UPS Worldwide Express Freight." }{ "value": "C6", "label": "Roadie XD AM (Morning delivery)" }{ "value": "C7", "label": "Roadie XD PM (Afternoon delivery)" }{ "value": "C8", "label": "Roadie XD (Anytime delivery)" }{ "value": "T0", "label": "Master" }{ "value": "T1", "label": "LTL" }`
Packaging Code	`packagingCode`	`string`	Select a value from the drop down menu:`{ "value": "01", "label": "UPS Letter" }{ "value": "02", "label": "Customer Supplied Package" }{ "value": "03", "label": "Tube" }{ "value": "04", "label": "PAK" }{ "value": "21", "label": "UPS Express Box" }{ "value": "24", "label": "UPS 25KG Box" }{ "value": "25", "label": "UPS 10KG Box" }{ "value": "30", "label": "Pallet" }{ "value": "2a", "label": "Small Express Box" }{ "value": "2b", "label": "Medium Express Box" }{ "value": "2c", "label": "Large Express Box" }{ "value": "56", "label": "Flats" }{ "value": "57", "label": "Parcels" }{ "value": "58", "label": "BPM" }{ "value": "59", "label": "First Class" }{ "value": "60", "label": "Priority" }{ "value": "61", "label": "Machineables" }{ "value": "62", "label": "Irregulars" }{ "value": "63", "label": "Parcel Post" }{ "value": "64", "label": "BPM Parcel" }{ "value": "65", "label": "Media Mail" }{ "value": "66", "label": "BPM Flat" }{ "value": "67", "label": "Standard Flat" }`
Weight Unit	`weightUnit`	`string`	Select a value from the drop down menu:`LBSKGSOZS`
Package Weight	`packageWeight`	`string`	The weight of the package

Action Authentication#

UPS uses OAuth authentication. When you connect your UPS account, Pipedream will open a popup window where you can sign into UPS and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any UPS API.

Pipedream requests the following authorization scopes when you connect your account:

About UPS#

UPS Global Shipping and Logistics Solutions

More Ways to Connect UPS + AWS#

Other Popular Integrations#

Get Tracking Info with UPS API on New DynamoDB Stream Event from AWS API

AWS + UPS

Create Shipment with UPS API on New SNS Messages from AWS API

Pipedream makes it easy to connect APIs for UPS, AWS and 3,000+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular