← UPS

Create Shipment with UPS API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Shipment with the UPS API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

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

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Shipment with UPS API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + UPS
 
Try it
Create Shipment with UPS API on New Submission from Typeform API
Typeform + UPS
 
Try it
Create Shipment with UPS API on New Submission (Instant) from Jotform API
Jotform + UPS
 
Try it
Create Shipment with UPS API on New Scheduled Tasks from Pipedream API
Pipedream + UPS
 
Try it
Create Shipment with UPS API on New Download Counts from npm API
npm + UPS
 
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.

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

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;
  },
};

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.
LabelPropTypeDescription
UPSupsappThis component uses the UPS app.
Shipper NameshipperNamestring

The name of the shipper

Shipper NumbershipperNumberstring

Shipper's six digit alphanumeric account number

Shipper Address LineshipperAddressLinestring

The address line of the shipper

Shipper CityshipperCitystring

The city of the shipper

Shipper State Province CodeshipperStateProvinceCodestring

The state province code of the shipper

Shipper Postal CodeshipperPostalCodestring

The postal code of the shipper

Shipper Country CodeshipperCountryCodestring

The country code of the shipper

Ship To NameshipToNamestring

The name of the ship to

Ship To Address LineshipToAddressLinestring

The address line of the ship to

Ship To CityshipToCitystring

The city of the ship to

Ship To State Province CodeshipToStateProvinceCodestring

The state province code of the ship to

Ship To Postal CodeshipToPostalCodestring

The postal code of the ship to

Ship To Country CodeshipToCountryCodestring

The country code of the ship to

Service CodeserviceCodestringSelect 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 CodepackagingCodestringSelect 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 UnitweightUnitstringSelect a value from the drop down menu:LBSKGSOZS
Package WeightpackageWeightstring

The weight of the package

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 Use UPS

Actions

Get Tracking Info with the UPS API

Get tracking information for a UPS tracking number. See the documentation

 
Try it
Recover Label with the UPS API

Recover a label. See the documentation

 
Try it
Void Shipment with the UPS API

Void a shipment. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,900+
apps by most popular

Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Anthropic (Claude)
Anthropic (Claude)
AI research and products that put safety at the frontier. Introducing Claude, a next-generation AI assistant for your tasks, no matter the scale.
Google Sheets
Google Sheets
Use Google Sheets to create and edit online spreadsheets. Get insights together with secure sharing in real-time and from any device.
Telegram
Telegram
Telegram, is a cloud-based, cross-platform, encrypted instant messaging (IM) service.
Google Drive
Google Drive
Google Drive is a file storage and synchronization service which allows you to create and share your work online, and access your documents from anywhere.
HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Google Calendar
Google Calendar
With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Slack
Slack
Slack is the AI-powered platform for work bringing all of your conversations, apps, and customers together in one place. Around the world, Slack is helping businesses of all sizes grow and send productivity through the roof.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.