UPS

UPS Rates & Services using ColdFusion MX 7 or greater.


* Required Attributes

Request


Request Option: *

Rate: The server rates and validates the shipment. This is the default behavior if an option is not provided.
Shop: The server validates the shipment and returns rates for all UPS products from the ShipFrom to the ShipTo addresses.





Service Options


Shipment Documents Only:

Indicates that the shipment contains only documents.


Service Code:

The code for the UPS Service associated with the shipment.


Service Description:

A text description of the UPS Service associated with the shipment.





Pickup


Customer Context:

The requester uses CustomerContext to synchronize request/response pairs. The client establishes CustomerContext, which can contain any information the client wishes to have, as along as it is valid XML; it is echoed back to the requester.


Pickup Type Code:




Valid if ShipFrom country is US


Customer Classification Code:

When the Pickup Type Code is (01) Daily Pickup, the default value is (01) Wholesale.
When the Pickup Type Code is (06) One Time Pickup, (07) On Call Air, (19) Letter Center or (20) Air Service Center, the default value is (03) Occasional.
When the Pickup Type Code is (03) Customer Counter, the default value is 04 (Retail).





Shipper


Shipper Name:

The shipper's name or shipper's company name.


Shipper Number:

The shipper's UPS account number.
(Note: A shipper number is required when requesting to receive the negotiated rates. Optional for published rates.)


Shipper Address Line 1:

The shipper's street address, including name and number (when applicable).


Shipper Address Line 2:

Additional shipper address information, preferably room or floor.


ShipperAddressLine3:

Additional shipper address information, preferably department name.


Shipper City:

The shipper's City


Shipper State Province Code:

The shipper's state code.
(NOTE: for Ireland use the 5 digit abbreviation for county Required for negotiated rates for Ireland shippers.)


Shipper Postal Code: *

The shipper's postal code.


Shipper Country Code: *




Shipper Handling Fee:

If the shipper wants to charge a handling fee, it is applied to each item.





Ship To


Is this going to a residential address?



Ship To Company Name:

The receiver's name or receiver's company name.


Ship To Address Line 1:

The receiver's street address including name and number (when applicable).


Ship To Address Line 2:

Additional receiver address information, preferably room or floor.


Ship To Address Line 3:

Additional receiver address information, preferably department name.


Ship To City:

The receiver's city.


Ship To State Province Code:



Ship To Postal Code: *



Ship To Country Code: *






Ship From


Ship From Company Name:




Ship From Address Line 1:




Ship From Address Line 2:




Ship From Address Line 3:




Ship From City:




Ship From State Province Code:




Ship From Postal Code: *

Required if country utilizes postal codes (i.e. US & PR)


Ship From Country Code: *






Packaging


Packaging Type Code:

The code for the UPS packaging type associated with the package.


Packaging Type Description:

A text description of the code for the UPS packaging type associated with the shipment.




Package Dimensions


NOTE: Required if Packaging Type is not Letter, Express Tube, or Express Box; Required for GB to GB and Poland to Poland shipments

Dimensions UOM Code:



Dimensions UOM Description:

A text description of the code for the unit of measure associated with the package dimensions.


Dimensions Length:

The length of the package used to determine dimensional weight.


Dimensions Width:




Dimensions Height:






Package Weight


Package Weight UOM Code:

The code representing the unit of measure associated with the package weight.


Package Weight UOM Description:

A text description of the code representing the unit of measure associated with the package weight.


Package Weight:

The value of the package weight.


Large Package Indicator:

Presence of LargePackageIndicator specifies that the package is a Large package.




Insurance


Insured Value Currency Code:

Declared value amount currency type. The IATA currency code associated with the declared value amount for the package.



Insured Monetary Value:

Declared value amount.




COD

(NOTE: Delivery Confirmation and COD cannot coexist on a single package)


Indicates COD is requested. Package level COD is available for US/PR to US/PR, CA to CA, and CA to US. CA to US COD is not allowed for package Letter/Envelope.

PSO COD Funds Code:

The code that indicates the type of funds that will be used for the COD payment.
DeliveryConfirmation and COD cannot coexist on a single Package.


PSO COD Amount Currency Code:

The IATA currency code associated with the COD amount for the package.
Required if a value for the COD amount exists in the MonetaryValue tag. Must match one of the IATA currency codes.



PSO COD Amount Monetary Value:

The COD value for the package.
Required if COD option is present.




Delivery Confirmation

(NOTE: Delivery Confirmation and COD cannot coexist on a single package)


PSO Delivery Conf DCIS Type:

Type of delivery confirmation



Verbal Conf Name:

The name of the person that will provide verbal confirmation for the package.

Verbal Conf Phone Number:



Package Requires Additional Handling **


AdditionalHandling: **

A flag indicating if the packages requires additional handling.
** NOTE: This field is not for adding a handling fee to your shipment.






Saturday Services


Saturday Pickup:



Saturday Delivery:





On Call Air


On Call Air Pickup Day:

Date the user wishes UPS to pickup the package.


On Call Air Method:

Method by which the user schedules the pickup.




Shipment COD


Indicates COD is requested. Shipment COD is only available for EU origin countries and for shipper's account type "Daily Pickup" and "Drop Shipping".

SSO COD Funds Code:



SSO COD Currency Code:

COD amount currency code type. Defaults to the currency used in the destination country.


SSO COD Monetary Value:



SSO Delivery Conf DCIS Type:

Type of delivery confirmation


Negotiated Rates Indicator:

Negotiated Rates option indicator. Response will contain your negotiated rates from UPS if you have them.