Connectors

E-commerce

UPS

UPS shipping: shipments, pickups, delivery intercepts, quotes, and dangerous goods checks

Signs in with: OAuth 2.0 sign-in
Runs on: Cloud or On-Prem Worker
Operations: 79
Ready-made triggers: 0

Connect UPS

In Neblex open Connect › Connections and click New Connection.
Search for UPS and give the connection a clear name.
Fill in the fields. Secret values are encrypted and never shown again.
Click Test, then Create Connection.

For services offered under Connect a Service you only sign in and approve access. Otherwise use Connect with OAuth2 with your own OAuth app. See Authorize with OAuth.

Field	What to enter
EnvironmentRequired	UPS production or customer integration (test) host. Use the token endpoint of the same environment.
Forwarding environmentRequired	Host of the UPS Forwarding API, which UPS publishes separately.
Token endpointRequired	UPS OAuth client-credentials token endpoint of the selected environment.
Client IDRequired	Client ID of the application in the UPS Developer Portal.
Client secretRequiredSecret	Client secret of the application in the UPS Developer Portal.

Use it in a flow

Open a flow, open the node library and search for UPS.
Drag it onto the canvas and choose an Operation and your connection.
Map the operation's fields from earlier steps, or click Map with Matt.
Use Test this step to see what it returns, then save.

To start a flow from UPS without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if UPS can send webhooks, a Webhook trigger receives them at its own URL.

Operations

79 operations in 24 groups. Each one is a step you can add to a flow.

Address validation1

Address ValidationvalidateAddress POST The Address Validation Street Level API can be used to check addresses against the United States Postal Service database of valid addresses in the U.S. and Puerto Rico.

Commerce guard1

Verify chargeback riskverifyChargebackRisk POST Evaluates chargeback risk based on user, payment, and address details.

Customs detail2

Returns required Custom Details`getCustomDetailData`	GET	This returns an array of fields that are required for the provided import and/or export country
Validate and/or submit the fields`postCustomDetailData`	POST	This endpoint will provide the ability to validate and/or submit the additional field information for a shipment

Dangerous goods3

Acceptance Audit Pre-check`acceptanceAuditPreCheck`	POST	Enables shippers perform pre-checks before shipping dangerous goods using the chemical record identifier and the commodity's regulated level code.
Chemical Reference Data`chemicalReferenceData`	POST	The Chemical Reference Data endpoint of the Dangerous Goods API allows shippers look up hazardous material reference information by ID number and shipping name of the specified regulated...
Pre-Notification`preNotification`	POST	The Pre-Notification API allows customer applications to inform UPS operations of Dangerous Goods shipments as they are processed and will enter the UPS transportation network prior to an...

Delivery defense1

Get Verified Address ScorescoreAddress POST This API cleans and verifies inputted addresses to enhance the accuracy of generating an Address Confidence score.

Delivery intercept7

Get charges by inquiry type`getCharges`	POST	Obtains intercept charges specified by the inquiry type and tracking number passed in the interface.
Get eligibility options`getEligibilityOptions`	GET	Retrieves the delivery change eligibility information for the tracking number passed in the interface.
Request cancellation of a prior intercept request`cancelInterceptOption`	POST	Cancel a previously applied intercept on the package.
Request for a new delivery date`rescheduleInterceptOption`	POST	Have the package delivered to the original address but on a different day in the future.
Request to hold the package at a UPS facility for pickup`willcallInterceptOption`	POST	Request your package to be held at or returned to a UPS facility where the receiver may claim the same-day.
Submit a non access point redirect request`getRedirectInterceptOptions`	POST	Submits a deliver to another address delivery change for the tracking number passed in the interface.
Submit a return to sender request`returnInterceptOption`	POST	Return a package to the original shipper prior to delivery.

Export assure1

Submit shipment details for compliance guidancesubmitExportAssure POST Submit shipment details and receive guidance from UPS.

Export description guidance3

Allows the user to provide feedback on a specific question of the overall session`submitDescriptionFeedback`	POST	Allows the user to provide feedback on a specific question of the overall session.
Continues refinement of product description and HTS code via questions and answers`continueDescriptionSession`	POST	This endpoint facilitates the ongoing interactive process for refining a product description and determining its corresponding Harmonized Tariff Schedule (HTS) code.
Initiates an interactive description session for a product`startDescriptionSession`	POST	Initiates an interactive description session for a product.

Forwarding24

Book Quote`airOceanBookQuote`	PATCH	Creates a booking for air or ocean based on the provided request data.
Cancel Order`orderCancel`	DELETE	Cancel a pending order NOTE: Orders can be cancelled only in the following status Cancellable Status: - 1 - Open - 5 - Labeled
Cancel Shipment`cancelAirShipment`	DELETE	Cancels a shipment using the provided shipment number and shipper's UPS Freight Account Number.
Create Label`printLabel`	POST	Prints or re-prints a shipping label for an existing order or shipment.
Create Manifest`printAirManifest`	POST	Generates and returns the manifest for the specified manifest number in the requested format.
Create Order`orderCreate`	POST	Create a pending order which becomes a shipment when processed at end-of-day
Create Quote`createAirOceanQuote`	POST	Creates a quote for air or ocean based on the provided request data.
Get Accessorials`getAccessorials`	POST	Get accessorials by search criteria.
Get Airports`getAirportDetails`	GET	Retrieve airport details by country code.
Get Cities`getCity`	GET	Retrieves city details matching the provided search criteria.
Get Countries`getCountries`	GET	Retrieves country details matching the provided search criteria.
Get Currencies`getCurrencies`	GET	Retrieves the currency details matching the provided search criteria.
Get Order Details`orderSearch`	GET	Search for orders based on criteria.
Get Payment Types`getAirPaymentTypes`	GET	Retrieves payment types matching the provided search criteria.
Get Service Types`getServiceTypes`	GET	Retrieves available service types based on shipper and consignee information.
Get Shipment Details`getShipmentDetails`	GET	Retrieves shipment details for air or ocean quotes based on the specified request parameters.
Get Shipping Documents`getDocuments`	GET	Retrieve existing shipment documents.
Rate Shipment`freightRating`	POST	Generate estimated freight charges based on the provided origin, destination, payor information, and cargo details.
Search Quotes`getQuoteDetails`	GET	Retrieves detailed information for a specific air or ocean freight quote identified by the provided request parameters.
Set Order Date`orderSetDate`	PATCH	Set Date for one or all active orders from a shipper to a future date.
Ship`freightShip`	POST	Generate estimated freight rates based on the provided shipment and party details, and create the shipment.
Submit Order Shipments`submitAirShipment`	PATCH	Processes all shipments created for a specific shipper during the day and returns a manifest.
Track Shipments`getShipmentMilestones`	GET	Get shipment milestones from tracking service.
Upload Document`uploadDocument`	POST	Uploads a document associated with a shipment.

Global checkout1

returns a guaranteed landed cost quotecreateGuaranteedQuote POST This endpoint requests guaranteed quotes for landed cost duties and taxes.

Landed cost1

Landed Cost Quote APIgetLandedCostQuote POST The Landed Cost Quote API allows you to estimate the all-inclusive cost of international shipments - including applicable duties, VAT, taxes, brokerage fees, and other fees.

Locator1

LocatorsearchLocations POST The Locator API allows you to find UPS locations - such as drop-off points, retail locations, and UPS access points (third-party retail locations that offer UPS package drop-off, or...

Paperless documents3

Delete Paperless Document`deletePaperlessDocument`	DELETE	The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History.
Paperless Document Push Image`pushPaperlessImage`	POST	The Paperless Document API web service allows the users to upload their own customized trade documents for customs clearance to Forms History.
Upload Paperless Document`uploadPaperlessDocument`	POST	The Paperless Document API web service allows the users to upload,delete and push to image repository their own customized trade documents for customs clearance to Forms History.

Pickup6

Pickup Cancel`pickupCancel`	DELETE	Using the CancelBy endpoint of the Pickup API, users can request cancellation of a UPS on-demand package pickup.
Pickup Creation`pickupCreation`	POST	Using the Pickup API, applications can schedule pickups, manage previously scheduled pickups, or cancel previously scheduled pickups.
Pickup Get Political Division1 List`pickupGetPoliticalDivision1List`	GET	The countrycode endpoint of the Pickup API helps retrieve a list of political divisions (states) in a specified country or territory.
Pickup Get Service Center Facilities`pickupGetServiceCenterFacilities`	POST	The servicecenterlocations endpoint of the Pickup API helps retrieve service center information in a specified area - including location address, phone number, SLIC (Standard Location...
Pickup Pending Status`pickupPendingStatus`	GET	Using the GET operation of the pickuptype endpoint within the Pickup API, users can retrieve the status of shipments sent via UPS pickup service.
Pickup Rate`pickupRate`	POST	Using the POST operation of the pickuptype endpoint within the Pickup API, users can request rates for UPS on-demand package pickup.

Pickup preferences2

Add or update account level pickup preferences for user UUID`addAccountPickupPref`	PUT	This operation allows the user to add or update account level pickup preference for a specified account number.
Get shipper account pickup preferences for user UUID`getUserAccountPickup`	GET	This endpoint retrieves the shipper account pickup preferences for specified user.

Protected delivery4

Generate Token`generateToken`	POST	This endpoint is used to generate a token using Shipper generated PIN
Get EPRA (Electronic Package Release Authentication) release code and related actions`getEpraCodeAndActions`	GET	This endpoint retrieves the EPRA release code and related actions for a given tracking number.
Get Pin by Token`getPinByToken`	GET	This endpoint is used to get Pin by Token.
Get Pins for the list of Tracking Numbers`getPinsForTrackingNumberList`	POST	This endpoint is used to get Pins for the list of Tracking Numbers.

Quantum View1

Quantum ViewgetQuantumViewEvents POST Get Quantum View Response

Rating1

RatingrateShipment POST The Rating API is used when rating or shopping a shipment.

Shipping3

Label Recovery`labelRecovery`	POST	The Label Shipping API allows us to retrieve forward and return labels.
Shipment`createShipment`	POST	The Shipping API makes UPS shipping services available to client applications that communicate with UPS using the Internet
Void Shipment`voidShipment`	DELETE	The Void Shipping API is used to cancel the previously scheduled shipment

Time in transit1

TimeInTransittimeInTransit POST TimeInTransit

Track alert1

API to create subscriptions by tracking numberssubscribeTrackingNumbers POST This endpoint takes a list of tracking numbers and creates a subscription for each.

Tracking3

Track by Reference Number`trackByReference`	GET	Track by Reference Number
Track Each Package in Shipment`trackShipmentPackages`	GET	Track Each Package in Shipment
Tracking`trackPackage`	GET	Tracking

Trade direct5

Closeout a Master Shipment`closeOutTradeDirectMasterShipment`	POST	Transitions a master shipment to a closed state, finalizing its processing.
Delete Less Than Truckload (LTL) child shipment`deleteTradeDirectLtlChildShipment`	DELETE	Deletes a Less Than Truckload (LTL) child shipment identified by a unique shipment identifier (USI) and a sub pro number.
Delete master shipment`deleteTradeDirectMasterShipment`	DELETE	This API allows users to delete a master shipment identified by a unique shipment identifier (USI) and the shipper's account number.
Delete small package shipment`deleteTradeDirectChildShipment`	DELETE	Deletes a small package child shipment identified by a unique shipment identifier (USI) representing the master shipment and the shipment's tracking number.
Genereate Documents and Labels for LTL Shipments and Closeout`createTradeDirectDocuments`	POST	Generates documents and labels for master/ltl shipments identified by a unique shipment identifier (USI).

WorldEase3

Close Out Shipment`closeOutWorldEaseShipment`	POST	Finalizes the shipment process by marking a package or set of packages as ready for dispatch, effectively ending the consolidation stage.
Delete the child shipment`deleteWorldEaseChildShipment`	DELETE	This is used to delete the child shipment record from the database
Deletes the master shipment`deleteWorldEaseMasterShipment`	DELETE	Deletes the specified master shipment from the system.