Developer Apis Knowledge Base

Frequently asked questions

UPS® Developer Kit

UPS® Developer Kit | Frequently Asked Questions Introduction

Introduction This document is intended to be a self-serve document for frequently asked questions regarding the UPS® Developer Kit, and is not meant to be all-encompassing. Please refer to the UPS Developer Kit community online at ups.com/developerkit for additional questions and an online forum.

Contents Introduction ...... i Address Validation ...... 1 Address Validation Street Level ...... 1 All APIs ...... 2 Quantum View® ...... 4 Rating API - Ground Freight ...... 4 Rating API - Package ...... 5 Shipping API - Ground Freight ...... 7 Shipping API - Package ...... 8 Time in Transit API ...... 12 Tracking API ...... 13 Tracking - Signature Tracking® API ...... 15 UPS TradeAbility® API ...... 15

UPS® Developer Kit | Frequently Asked Questions Address Validation

classification addresses in the United States and Canada. Address Validation How frequently are the databases What countries does the Address updated for Address Validation Street Validation API validate? Level API? The Address Validation API validates city, For Classification, information is updated state and ZIP codes in the United States weekly. and Puerto Rico. For Validation, information is updated How much time will it take to monthly. program/implement the Address Validation API? Does Address Validation Street Level The implementation of the Address API offer the ability to batch upload? Validation API may vary and is strictly No. dependent on the skill level of the developer. An implementation may take How exactly is Address Validation as little as a week for a very skilled Street Level completed? developer to as long as months for a less UPS Address Validation API’s database is skilled developer. updated at monthly intervals with new address information from USPS. How frequently are the databases updated for Address Validation API? Does Address Validation Street Level The database is updated every month. API provide a candidate list for addresses that have suite/apt. Does the Address Validation API allow information? batch upload? The API does not return candidate lists for The API does not allow batch upload and suite or apartment number ranges when only validates one address at a time as they are not provided by the customer. part of each transaction. How much time will it take to Does Address Validation API provide program/implement the Address a candidate list for addresses that Validation Street Level API? have suite/apt. information? The implementation of the API may vary This API only validates city, state and ZIP and is strictly dependent on the skill level code and does not provide any of the developer. An implementation may information for apartment or suite. take as little as a week for a very skilled developer to as long as months for a less Does the Address Validation API skilled developer. classify addresses? No. Does the Address Validation Street Level API classify addresses? The API classifies addresses in both United Address Validation Street Level States and Canada. The API classifies addresses as Residential or Commercial in What countries’ addresses can be keeping with UPS standards. validated by the Address Validation Street Level API? Why do we get back a candidate list The Address Validation Street Level API of addresses even when the response only validates street level addresses in the has a Valid Address Indicator? United States and Puerto Rico. The API The API returns a candidate list even provides Residential/Commercial when there is a Valid Address Indicator because the parameters entered have

UPS® Developer Kit | Frequently Asked Questions All APIs

more than one valid match. If the address 91016 grade C that was entered is returned as part of the Monrovia CA 91016 grade A candidate list then that address is valid and should be used. When the two scores were averaged the score was below the threshold and Is the Address Validation Street Level therefore the Ambiguous Address API CASS-certified or the data we Indicator returned. In this scenario, had receive CASS-certified? you removed the “S.” with the same UPS address validation is not CASS- information you provided, the validation certified. For customers who do not score average would have been high already use CASS-certified address enough and the Valid Address Indicator validation software, the Address Validation returned. Also, had you provided the city API can be used to help validate and state for the regional portion, then addresses for UPS shipments. UPS the score on the regional side would have delivers to addresses that are not in the been high enough that when we averaged USPS database (some examples are the two, the average would have been addresses that are warehouses that do raised over the threshold. not accept mail, and areas where the USPS only provides post office box delivery), so an invalid address may still All APIs be deliverable. Also, a valid address may be the wrong address, and still require an Is XML coding knowledge required to address correction. integrate the UPS Developer Kit APIs? The UPS Developer Kit APIs were designed How is the determination made as to to be implemented by customers with a whether or not an address is prior knowledge of XML and other “ambiguous”? programming language. Integrate requires “Ambiguous Address Indicator” is returned that the XML document must be submitted when the address validation score for the to our servers via a POST using HTTPS. entire address is below a UPS-specified UPS does not provide coding support. confidence threshold. However, Java and other sample codes are supplied in the Developer Kits which Address Validation Score is the average of can help guide application development. detailed validation score and regional validation score. Where can I find high-resolution Detailed Validation Score is calculated UPS logos? when street number, name, suffix, Customers are not routinely provided UPS secondary information are validated based logos and graphics without having a upon USPS feed using proprietary UPS design/layout submitted to UPS Brand validation database. Management for approval. Customers should visit the UPS Brand website to Regional Validation Score is calculated download a limited set of sample images when city, state and postal code are for layout. The website also outlines the validated based upon USPS feed using process of how to secure an approval to proprietary UPS validation database. use these assets. Example: 2724 S. PECK ROAD 91016 What does XPCI mean and what Detailed Score: version should be used in the 2724 S. PECK ROAD grade B Developer Kit APIs? XPCI stands for XML Package Carrier 2724 PECK ROAD grade A Interface (XPCI) and defines a vocabulary Regional Score: and structure for describing packages, shipments, and the activity details for

UPS® Developer Kit | Frequently Asked Questions All APIs

package carriers and their customers. informs customers of the possibility of XPCI is a set of DTDs that defines the experiencing issues throughout the time terminology, transaction enveloping, and period. Sunday maintenance includes XML message definitions. For a client to account-based rates and UPS Freight®. be XPCI-compliant, the client must generate a well-formed XML message that Are the Web Services versions of the validates against the XPCI DTDs. APIs ASMX-based? Several DTDs, organized into three No. All Web Services are XML-based. categories, define XPCI: What does the message: “XML  Vocabulary: this DTD defines the document is well formed but the basic business vocabulary of XPCI. document is not valid” mean? All tags used in a message are This error message is generally returned defined in this DTD. when an element in the XML request does  Interchange: this DTD defines the not follow the requirement defined within transaction-enveloping scheme. the Schema of that API’s developer guide. Every message includes When the API returns this error it also transaction information. indicates the invalid field in the “ErrorLocationElementName” element in  Message: each message has an the XML response. Ensure the XML associated DTD that defines the request is being sent to the correct URL. vocabulary of the message. The URL can be found in the Developer The version and date pertains to version Guide for each API. of the API. However the APIs were not versioned so they currently do not carry Is phone support provided for the significance. UPS will utilize these UPS Developer Kit - Developer APIs? elements in the event the Developer Kit If so, what is the number and what APIs are versioned. are the hours of operation? Phone support is provided for very basic How do I get technical support for the API questions. Questions that cannot be APIs at ups.com? answered verbally will be directed to the Go to ups.com. Under the Support tab, email support form at ups.com. Please go select Technology Support. Under Tools to the Developer Resource Center on and Resources click on Developer ups.com for more information. Resource Center. If your questions are not answered on this page, then click on Are there any examples of API email UPS. implementations to understand how to integrate the APIs? Are there any designated system Please refer to various ups.com down times for the Developer APIs? applications as examples of how the APIs The overall reserved downtime for UPS may be implemented for each function. servers is Saturday 10:00 p.m. ET For example, calculate Time and Cost through Sunday 12:00 p.m. ET. However, application depicts how Rating and Time in the window may be shortened to two 15- Transit APIs can be used together; minute intervals with one starting at 11 Tracking on ups.com is an example of how p.m. and the other occurring sometime the Tracking API may be integrated. between 1 and 3 a.m. ET Sunday morning for most weekends. Typically traffic is Do the APIs support PHP or Perl with handled in such a way that there is very code sample within the Developer little impact to customers, and any impact Guides or the Developer Kit zip files? which does occur does so during the small All available sample codes can be found in 15-minute intervals. This entire time is the Developer Kit of each API. reserved for maintenance and UPS

UPS® Developer Kit | Frequently Asked Questions Quantum View®

Within what countries are the Inbound View – 52 days (45 previous days Developer APIs available? plus 7 future days) The Developer APIs are available in the Freight countries listed on ups.com and vary by each API and by country under the UPS Shipments – 120 days Developer Kit. Click on any particular API Inbound Freight View – 127 days (120 to go to the API page and scroll to the previous days plus 7 future days) bottom of the page to get the country listing for that particular API. Imports – 365 days, but only in 45 day increments Can Japanese Kanji characters be recognized by UPS Developer APIs? How long does it take PLD data for No. shipments from the Shipping API - Package to be populated into What APIs are available for Address Quantum View API? Validation at UPS and how do they The numbers below represent the differ? Quantum View Manage/QVD timeliness of Address Validation (AV) API: This API is manifest information (in minutes). available within the UPS Developer Kit - Note: they are averages across PLD Developer APIs section of ups.com. It compliant shipping solutions. uses the USPS address database. Billing Manifest Received can range Address Validation Street Level API approximately from 30 minutes up to 2.5 (AVSL): This API is available within the hours. The average is approximately 1 UPS Developer Kit - Developer APIs. The hour. backend uses the Trillium algorithms and database. Therefore, AVSL can only be used for the purposes of shipping. Rating API - Ground Freight

Which APIs provide address Is the Fuel Surcharge listed as a classification? separate line item in the response for Shipping, Rating, and Address Validation the Rating API - Ground Freight? Street Level provide address classification Yes. The fuel surcharge is listed as a (residential/commercial). Time in Transit separate line item within the response for and Address Validation do not provide Ground Freight shipments classification. Is Time in Transit available through Quantum View® the Rating - Ground Freight API? Yes. Request must include the “TimeInTransitIndicator”. Presence of the Does the Quantum View API store tag indicates Time in Transit (days in data for the same time period as transit) information is requested and will Quantum View Manage®? How many be returned if available (ground freight days does it store for 45 days? only. Please note the days do not take Visibility time spans are based on manifest into account weekends, holidays or non- scans: work days. Small Package How can I add locations to a Forward Shipments – 45 days contract? Do I need to work through Return Shipments – 120 days my UPS Freight Account Manager? Yes. Please contact our Freight sales Shipments with exceptions – 120 days representative to ensure accounts and locations are added to the UPS Freight LTL

UPS® Developer Kit | Frequently Asked Questions Rating API - Package

negotiated rates. For more information, Does UPS Rating API display the time visit UPS Freight. of day delivery to rural areas? For example: UPS Next Day Air Saver® Can I use any combination of residential and UPS Next Day Air origin/destination postal codes to Saver® commercial scheduled delivery receive ABR with Rating - Ground time in a rural area, etc.? Freight API? Yes. There is a scheduled delivery time Rating API - Ground Freight does not within the response message. behave like the Rating API - Package. In order to see negotiated rates for freight, Does the Rating API - Package the origin postal code must match the support Time in Transit? postal code on file with UPS Freight. When No. the correct origin postal code is not used the response will not include the correct Will the Rating API - Package allow a rates. customer to know if Saturday delivery is available if they are shipping on a Thursday? Rating API - Package Since Saturday delivery is an accessorial, an indication must be included in the Does the Rating API support Account Rating API request. If it is available then Based Rating (ABR), Negotiated Rates the response will specify that the delivery or incented rates? will be on Saturday. The Rating API does ABR, Negotiated Rates and incented rates not specify guaranteed delivery times. are all the same. The Rating API (all versions) support ABR. Does the Rating API - Package support both International and U.S. How does Rating API use address Domestic shipments? validation capability? Yes. No address validation is performed by the API, however, postal code validation is Does the Rating API - Package performed. support international extended area surcharges? Does the Rating API - Package Yes. include fuel surcharge? Yes. However, fuel surcharge is not Does the Rating API support broken out separately and is returned with international rates? other charges. Yes. As long as the shipper number is from the origin country the requests will Is Extended Area Surcharge included be validated. within the rating response? The Extended Area Surcharge (EAS) will What accessorial does the Rating API be included with the transportation support? charges. Additionally, if EAS applies for a Please see the Rating API - Package shipment then a warning is returned in Developer Guide for a list of supported the response stating this charge has been accessorials. added. Does the Rating API - Package How do I get access to negotiated support Delivery Area Surcharge? Package rates? Yes. However, it is included within the Contact your Account Representative to total transportation charge in the rate obtain negotiated rates through the UPS response. Developer Kit - Developer APIs.

UPS® Developer Kit | Frequently Asked Questions Rating API - Package

What is the maximum number of account number, the published rate will be packages that can be rated through in USD but the negotiated rates will be the Rating API - Package? returned in Canadian dollars (CAD). When using the “Rate” function there is a maximum of 200 package containers Does Rating API support Return allowed in each API request. One package Services? container contains the information for one Rating API supports Return Services only individual package. In addition, when for all services. using the “Shop” function there is a maximum of 50 package containers Does Rating API automatically allowed in each API request. validate Residential versus Commercial addresses? What is the difference between a If the residential indicator is included in “Rate” request versus a “Shop” the rate request then the shipment will be request using the Rating API - classified as residential. There is a second Package? validation done and if the address is A “Rate” request returns the rate for a commercial then the classification will be single service for each package, while a changed and the customer is notified of “Shop” request returns the rates for all this in the rate response. services available between a given origin/destination pair for each package. Does Rating API support Account Based Rating (ABR)? Are the rates that a customer gets via Yes, Rating API does support ABR. the Rating API - Package the same as the rates they receive at The UPS Does Rating API support UPS Store® locations or UPS Customer Hundredweight® Service contracts? Centers? Yes, Rating API does support UPS The Rating API - Package allows ability to Hundredweight Service tiered contracts. specify a Customer Classification Code There is no indicator to include in the rate that determines the Rate returned. Please request. ABR will provide contract rates refer to the Developer Guide for more based off of the tier associated with the information. UPS account number. UPS account number must be included in the rate Can Rating API provide both request. published and negotiated rates within the same response? Does Rating API support UPS Ground Yes. Both published and negotiated rates with Freight Pricing (GFP)? are returned in one rates response if an ONLY Rating API - Package Web Service account has ABR activated and the version supports UPS Ground with Freight “NegotiatedRatesIndicator” is included in Pricing. the request. Does Rating API - Package support In what monetary denominations are full UPS Freight LTL or UPS air freight the rates returned by the Rating API? services? A list of currencies and currency codes are No, Rating API - Package does not support available in the Rating API Developer any ground freight service. Guide in the appendices. For published rates the currency returned is based on Can you ship and/or print labels via the country of origin. For negotiated rates the Rating API - Package? the currency returned is based on the No, shipping is not available in the Rating country of the account number. For API - Package. Neither, Rating API example, when rating a shipment from the versions (XML or Web Service) support United States to Canada with a Canadian labeling.

UPS® Developer Kit | Frequently Asked Questions Shipping API - Ground Freight

Is there a comparison available for tag indicates Time in Transit (days in the differences between the XML transit) information is requested and will Rating and Time in Transit APIs? be returned if available. Ground Freight Yes. Tracking and Rating are the only Only. Please note the days does not take HTML APIs available today. Please ask into account Weekends, Holidays or non- your Sales personnel to obtain the work days. comparison for you. If a customer wishes to add locations Why does Rating API, Time in Transit to a contract do they need to work API and Calculate Time and Cost on through their UPS Freight Sales ups.com provide different results? Manager or their Sales The Time in Transit API uses logic in its Representative? calculations and will suppress more Yes. Customers need to contact their sales expensive services if they will not deliver representative to ensure the accounts are the shipment any quicker than those added to their UPS Freight LTL negotiated shown in the Rating API. There is a rule rates. Please reference the UPS Freight that states if ground service is as fast as website. or faster than an air service, i.e., UPS 2nd Day Air®, then that air service will be What is the minimum weight limit for suppressed in the Time in Transit API UPS Freight LTL shipments? response. The minimum weight is 1 lb. for shipping While the unlisted service is still a valid UPS Freight LTL via the UPS Freight LTL shipping option, the customer could save Shipping API Web Service. money choosing from the listed services. What are the valid origin countries for Does the Rating API - Package UPS Freight LTL? support time in transit results? Origin countries available match those No. available through UPS Freight LTL including the United States, Puerto Rico, Canada, and Mexico. Shipping API - Ground Freight How do I get access to UPS Freight What is the maximum shipment LTL negotiated rates? weight for UPS Freight LTL? Origin countries available match those Only less than truckload is allowed via the available through UPS Freight LTL Ground Freight APIs. Any weight 10,000 including the United States, Puerto Rico, lbs. to 19,999 lbs. is considered a Canada, and Mexico. truckload move. Any weight 20,000 lbs. and above will not return a rate on How is the Bill of Lading (BOL) shipments. Instead, the user gets the formatted within the UPS Freight LTL following message: “Rate a Shipment is Shipping API response? not available for this shipment. Please call The BOL data is returned within the UPS Customer Service at 1-800-333-7400 for Freight LTL Shipping API response for the assistance with this rate.” customer’s use.

Are there any rate structures that are Within the Shipping API – UPS Freight LTL not allowable for UPS Freight LTL? Developer Guide, the Bill of Lading No. document is returned in the response as a base64 encoded string which, when Is Time in Transit available through decoded and saved, is a .pdf document Shipping - Ground Freight API? ready to print. Yes. Request must include the “TimeInTransitIndicator”; Presence of the

UPS® Developer Kit | Frequently Asked Questions Shipping API - Package

Does the Shipping API – UPS Freight  ABR will reflect basic and LTL also support Air Freight? performance-tiered incentives No. within 24 hours after the contract is re-started. Shipping API - Package Change to Rolling Average (for example, from 52 weeks to 13 weeks): Does UPS or the Shipping API support  ABR will not reflect performance- double-byte characters for entry of tiered incentives until Monday of address fields and other fields? the second effective week of a new No. UPS backend systems nor shipping contract. systems including the Shipping API do not support double-byte (Unicode, UTF 8) Addition of New Services to Existing characters. Only Latin characters can be Contracts: entered and submitted.  The new services on a contract will follow the time frame described How does the Shipping API utilize above for new contracts. address validation? Shipping API performs regional validation  Existing services on the contract of the city, state, and postal code when will not be impacted and therefore “validate” is specified in the ABR will not be impacted. “RequestOption” element. If “nonvalidate” Addition of New Accounts to Existing is specified then address validation is not Contracts: performed.  ABR will reflect all incentives from How do I associate more than 99 the newly attached contract the account numbers for use with the following Monday. Shipping API?  Accounts that were already on the The Shipping API requires that the existing contract are not impacted account (shipper) number and User ID by the addition of new accounts. used in the XML request are associated within the My UPS Account summary of New ABR Customers: the User ID. Account Summary is limited  For new ABR customers or a new to 99 accounts. If you need more than 99 account with an existing ABR please contact your UPS Account customer, only basic incentives will Representative for assistance. be returned during week one and all incentives at the start of week What is the delay in activating a new two. or modified account for Account Based Rates (ABR) for Rating or  Depending on the business Shipping APIs? processes that will use ABR, it is New Contracts or Plans: suggested to wait until week two to start using the ABR rates.  Performance-tiered incentives will not be available until Monday of Existing ABR Customers: the second effective week of a new  For existing ABR customers, new contract. The first week’s volume services added to an existing calculation is needed after billing contract will have the same delays cycle is completed. as described above for a new  Basic incentives are available the contract, but that existing services first effective week. on the contract would continue rating with ABR uninterrupted. Re-started Contracts:

UPS® Developer Kit | Frequently Asked Questions Shipping API - Package

How do I turn off validation of Yes. Shipping API supports international addresses with the Shipping API? returns and returns in countries where the The value within the “ShipmentRequest/ API is supported. Request/RequestOption” tag of the request needs to be “nonvalidate”. For the print return label option, is there an option to reprint the return What validation is the Shipping API label? using to validate addresses for U.S. There is no option to reprint Print Return and International addresses? Labels using the Shipping API today. Shipping API does not do ANY address Reprint is only possible for Electronic validation at the street level only regional Return Label. Print Return Labels must be validation; city, state, country (postal saved locally to allow reprint. code optional). Is UPS Delivery Intercept® service How do I add a UPS account to My available through the Shipping API? UPS ID account summary? No. As a means of securing customer information, when adding an account to Is Shipper Release available with the the My UPS profile, customers are Shipping API? required to authenticate their account by Yes. providing the following information: from one of the most recent invoices within the Is there a URL ONLY capability for last 90 days: returns within the Shipping API? No.  Invoice number  Invoice amount Can a Return be voided? If yes, what is the cutoff timing to void a return?  Invoice date A customer can void a Return shipment up  Control ID to 2 a.m./3 a.m. the following night (e.g., Monday request, Tuesday 2 a.m./3 a.m. The Control ID located just below the void cutoff). This is based on when the shipper number on the invoice. batch process starts sending RS1/RS3 labels to the centers. After the cutoff, the How do I get access to negotiated customer will not be able to void, and the Package rates? UPS agent is also not able to void. If the Contact a UPS Account Representative to void is completed by the cutoff time then obtain negotiated rates for use within the the customer will not be charged. Shipping API. Does the Shipping API - Package Does the Shipping API support the return rural and super rural charges? Dry Ice indicator? Yes, the Shipping API will return rural and Yes, the Shipping API will support Dry Ice. super rural charges but these charges are Dry Ice is not supported with any other part of the transportation charges. Hazmat materials in the shipment and must meet additional requirements. Can the Shipping API - Package Please refer to ups.com for more generate a Code 128 reference information. number barcode below the 1Z? Can it generate a PDF417 Reference number Does the Shipping API support barcode below the 1Z? international returns and returns in Yes. A Code 128 reference number international countries? barcode can be generated below the 1Z tracking number, as the Shipping API can print a barcode in reference field 1. The

UPS® Developer Kit | Frequently Asked Questions Shipping API - Package

Shipping API - Package does not support Is a receipt and confirmation number PDF417 barcode types. emailed via the Shipping API - Package? Does the Shipping API - Package There is no receipt provided. In addition, support currency conversions? Shipping API only provides the ability to No. The Shipping API - Package does not have the label emailed for Electronic support currency conversions. Return Labels. For forward shipments the customer needs to handle emailing the Will the Shipping API provide label programmatically on their side. validation for Japanese addresses with City and Country and no ZIP Can a customer using the Shipping code? API enter an account number that No, the postal code must be included for doesn’t belong to them to ship third- validation. party or Freight Collect? If yes, does the API validate that the account How does a customer include the number entered is an existing UPS suite/apt. no. within “From” address account number? on the label returned for the Shipping The Shipping API - Package validates third API - Package? Party/Freight Collect account number The customer needs to include the using the postal code and country code suite/apt # in address lines two or three provided. The postal code must match the within the request. “pickup address” postal code included within UPS systems for that account How does the Shipping API - Package number. work with High Values? Does the paperwork come back as a GIF image Can a customer using the Shipping and get printed on a thermal printer? API view shipping history through the Or, does the customer need to API? produce this themselves? The Shipping API does not provide a The High Value Report is returned in four “shipping history”. However, to review formats outlined within the Shipping API - shipping history or reprint labels that were Package portion of the Developer Guide. manifested via the Shipping API - Package The customer is required to successfully customer may log into ups.com® using the produce a High Value Report as a GIF My UPS User ID and password passed in image in the certification process. That their XML request, then navigate to the information is also within the Developer shipping history section. Shipping History Guide. on ups.com will provide the ability to review shipments and reprint labels. Can a Pickup be requested through the Shipping API - Package? Are there any known issues with For customers implementing the Shipping implementing Oracle® technology API - Package after January 2010, the with the Shipping API - Package? Pick-up request functionality will not be UPS is not aware of any issues customers available. The customer must request the may have implementing the Shipping API Pickup API - Package. For customers who - Package using Oracle. The UPS implemented the Shipping API - Package Developer APIs are designed so that they prior to January 2010 they can request a can be integrated into almost any pickup but they will be charged for each environment as long as the application request regardless of the service type can open a secure connection of SSL and shipped (air, ground, international). perform an HTTP Post.

Does the Shipping API - Package support UPS Paperless® Invoice?

UPS® Developer Kit | Frequently Asked Questions Shipping API - Package

Yes. The developer guide for the Shipping How does a customer flag that the API - Package lists the valid countries for SHIP TO is a residential destination? UPS Paperless Invoice. The account A SHIP TO can be flagged as residential by number must be enabled for paperless using the “ResidentialAddress” element invoicing. Once the shipment is processed outlined within the Shipping API - Package an EDI (paperless invoice) or EDI PULL Developer Guide. (paperless invoice and additional export document indicator) will appear on the How are voids processed? bottom right corner of the label image For forward and return movements please returned by the Shipping API. This refer to the Void section of the Shipping indicates that paperless invoicing has API Developer Guide. Forward movements been requested. must be voided within 28 days of shipping. Return shipments must be How does UPS Paperless® Invoice voided within 24 hours. work in terms of the documentation being forwarded? Can a customer create their own Those customers set up for paperless tracking numbers using the Shipping invoicing shipping internationally to a API - Package? paperless supported country with the No. The Shipping API - Package generates necessary data for paperless will have the the tracking numbers for the customer. invoice automatically sent to brokerage. Does the Shipping API - Package Can a UPS Paperless Invoice support World Ease® shipping? shipment be voided through the No. Shipping API - Package? If yes, what happens to the invoice information? Does the Shipping API - Package Yes, a UPS Paperless Invoice shipment support returns capabilities? can be voided via the Shipping API - Yes. Package. If a shipment is voided and consequently the package is never Does the Shipping API - Package tendered to UPS, then the UPS Paperless support international forms? Invoice data that was uploaded for the Yes. shipment is not used to create an invoice image and is eventually purged. Does the Web Services version of the Shipping API - Package behave Can a customer implementing the differently in rendering a label than Shipping API - Package “rename” the XML version of the Shipping API - reference value 1 through the API? Package? That is, can customers replace the The Web Services Shipping API - Package Reference #1 field name with any behaves similarly as the XML Shipping API other value? - Package in that the label elements There is some limited ability to control the returned in the Shipment Accept response label for the Reference number one using consist of two parts, both of which are the Shipping API - Package. This is done base64 encoded data which must be using code values which correspond to decoded. Part one consists of the label specific text which will precede the image and part two contains the HTML reference number value. For example the which is used to properly size the label code PO may be supplied in the XML and image in a browser for display and “Purchase Order” will print on the label printing. When the two parts are next to the reference number. A complete combined they form a unit which will list of Reference Number codes is satisfy the requirements for printing a available within the Developer Guide. proper label to apply to a package. This ensures the label will meet the standards

UPS® Developer Kit | Frequently Asked Questions Time in Transit API

necessary for UPS to scan and process the Can any of the reference fields be label within the shipping system. blocked from printing on the label through a Shipping API? Is there a difference between the No. Please note that “reference numbers” Shipping API - Package Web Service are not required when creating a shipment versus XML versions in the number of with the API. If you are using reference packages that can be included within numbers and do not want them to appear a forward movement? on the label we suggest storing them There is no difference between the internally within your application and not Shipping XML Tool and Web Service Tool pass them to UPS when creating regarding the maximum number of shipments. This would also preclude them packages allowed for forward movements. from being available within UPS’ data and The Web Service Developer Guide they would need to be managed outside of indicates 200 is the maximum. UPS.

What does the Shipping API - Does the Shipping API - Package Package support in terms of support “Signature Required” reference numbers? accessorial? The Shipping API supports two shipment Yes. level reference numbers and two package level reference numbers. You cannot use Is there a future date shipping the shipment level and package level capability within the Shipping API - reference numbers at the same time Package? within a shipment. No. We do not support future date shipping. However, if the customer saves Shipment level reference numbers are the shipment digest or the shipment only allowed for shipments that are not confirm response they can submit that at U.S. to U.S. (origin/destination) or PR to a later time frame (future date). PR (origin/destination). Package level reference numbers are only allowed for shipments that are U.S. to Time in Transit API U.S. (origin/destination) or PR to PR (origin/destination). Why does Rating API, Time in Transit API and Calculate Time and Cost on Reference Number Propagation: ups.com provide different results? 1. In a shipment, if there is no The Time in Transit API uses logic in its package level reference number on calculations and will suppress more the first package of the shipment, expensive services if they will not deliver the shipment level reference the shipment any quicker than those number(s) will be propagated to all shown in the Rating API. There is a rule packages. that states if ground service is as fast as or faster than an air service, i.e., UPS 2nd 2. In a shipment, if there is no Day Air®, then that air service will be shipment level reference number suppressed in the Time in Transit API and there is a package level response. reference number on the first While the unlisted service is still a valid package, the first package’s shipping option, the customer could save reference number will be money choosing from the listed services. propagated up to the shipment level. Does the Time in Transit API - Package include LTL or Air Freight? No. Time in Transit API - Package does not support LTL or Air Freight.

UPS® Developer Kit | Frequently Asked Questions Tracking API

Does the Time in Transit API display Yes. Please search the Tracking Developer available lanes only? Guide using the keyword “Freight” for Yes, only available lanes are returned. more information.

Does the Time in Transit API account Is Pre-Pickup Visibility available for holidays? when tracking freight shipments with Yes. The Time in Transit API takes into UPS Tracking API? account UPS holidays. No. UPS Freight must bill the shipment before information is passed to tracking. What are the minimally required UPS has a rule that header information elements for the “Request” to have a must be established before the shipment “Response” returned? can be displayed. Header information is The minimum requirements for the established at the billing point, and that Response are: usually occurs the night of the shipment.  Date Why can’t I see my freight reference  Number of Packages number in the API response? The Tracking API supports two reference  Weight (only for international numbers per freight shipment. Freight movements) shipments may contain many more  Country reference numbers, however, the API is limited to two.  ZIP Code or Postal Code  Customer Values (only for Could my Tracking API license be international movements) revoked? UPS retains the right to revoke an access key or block access for any user that Tracking API abuses the tracking system and does not adhere to the usage rules included in the What is the UPS Tracking API? Developer Guide. UPS Tracking API provides up-to-the- minute shipment status - from origin to Why am I receiving a response delivery. stating “information unavailable” for my tracking number that I just How much does the UPS Tracking API created? cost? If a shipment was created using Shipping UPS Tracking API is free to license. API or on ups.com®, do not track until the Integration may require IT resources or UPS backend has been populated with the third-party developers depending on the shipment details. This usually takes 5 to complexity of your system. 10 minutes. If a shipment was created using WorldShip® technology, tracking will What is the difference between be unavailable until End of Day is Tracking API and Tracking - Signature completed or UPS receives origin scans for Tracking API? the package. Both APIs are the same, with the exception the Signature Tracking API What transport modes are available provides authorization to see full delivery within the Tracking API? address, “delivered to” name and All modes of transport are available within Signature image. the Tracking API: Package, Ground Freight, Air Freight and Ocean Freight. Can I track freight shipments with UPS Tracking API?

UPS® Developer Kit | Frequently Asked Questions Tracking API

Does a scan type display when a Shipments can be tracked using reference driver scans a Pickup Summary 1 or reference 2 numbers (no other Barcode (PSB) in the Tracking API? reference numbers can be used). When UPS receives PSB scans at the shipment tracking a multi-piece shipment using the level (when available), but we don’t lead shipment tracking number will show display the information within our tracking the information for all packages within the systems. shipment. However, tracking with the child package tracking number only Does the Tracking API - Package provides information for the child package provide a Scheduled Delivery Date? and not the entire shipment. Yes, it is provided within the “ScheduledDeliveryDate” container Is the “Billing Information Received” described within the Developer Guide. If event the same as the “Order the Scheduled Delivery Date changes then Processed: Ready for UPS” event on a date is returned within the ups.com? “RescheduledDeliveryDate” container. Yes, the events are the same.

How long is data stored for tracking Why isn’t there a “Scheduled Day of information? Delivery” (SDD) returned with the Transit scans are removed after three “Billing Information Received” event? months, Exceptions are available for up to Since these are packages that can be nine months and Signature Images and injected into the UPS network from any Delivery Information are available for 18 channel UPS waits until possession of the months. package prior to including an SDD.

In what order are the reference What is the “UPS Internal Activity” numbers in the Tracking Response on scan or event and why is this not a multiple-package shipment sorted? returned by tracking on ups.com? You can track a shipment through UPS Internal Activity scan is a generic reference one or reference two only. description for one of several internal When tracking a multiple-piece shipment operations scans which are filtered by the if you use the lead number it will show web-tracking application. These scans are you the information for all the packages not used externally. You may consider within that shipment however, if you track dropping these records in your process. with tracking number that is not of the lead package, it will only show the Can I obtain Ground Freight delivery tracking information for that individual receipts? package. Yes, there is a linkage at UPS Freight® where it is determined if the My UPS ID is Can I use Tracking information in a associated with either the shipper, the frame on my site? consignee or the third party. That My UPS UPS strongly discourages the use of ID is allowed to see specific document “framed” information. See the ups.com® types and to see additional information “Terms and Conditions” or “UPS contained in the Tracking response. Each Technology Agreement” accepted by all shipper, consignee or third-party users for regulations and restrictions for customer has an account number. If any the usage of UPS technology. of those accounts match any of the accounts associated to the My UPS ID How are multi-piece shipment then they have additional privileges. See information and reference your Account Manager for additional information returned by the API? information. What is the order of the information?

UPS® Developer Kit | Frequently Asked Questions Tracking - Signature Tracking® API

What are the guidelines for high- Yes. It is part of the signature image frequency tracking? returned by the UPS Signature Tracking  Ensure tracking requests are valid. API and cannot be modified in any way. The information received through the API  When errors like “tracking number may include electronic signature images. not found”, “invalid tracking Electronic signature images, other than as number” are returned, fix the issue part of a POD Letter, may not be stored, before continuing to track with the distributed to any third party, copied or same number. modified. Each POD Letter generated or developed as the result of using or access Tracking - Signature Tracking® to the Tracking API may be stored in API electronic format until 18 months after the delivery of the shipment referenced in the What is the UPS Tracking - Signature POD Letter. The application may not Tracking API? distribute a POD Letter electronically to UPS Signature Tracking API provides proof third parties, other than as a facsimile of delivery containing a digitized signature transmission. and delivery address. UPS TradeAbility® API How do I add shipper accounts for authorization to Signature Tracking Do we have Denied Party screening API? lists that are supported via the UPS To add shipper accounts for Signature TradeAbility® API? Tracking API, the user can access My ® A listing of Denied Party screener listings UPS.com by logging in with the user ID can be found on ups.com here. and password associated with the access key, and adding the account number to When I submit my the account summary. A recent invoice “LandedCostRequest” I receive a will be needed to provide the latest Query Response which includes a invoice date, amount and control number number of questions I don’t want to (if applicable) for authentication. answer, is there any way around this? Unfortunately, there is no way to What tracking number should be used ® completely prevent the Query Response to track a UPS Mail Innovations from being returned. When a Query shipment? Response is returned you can respond Shipping API returns in the response without providing any answers to the both the “ShipmentIdentificationNumber/ questions provided. You would want to TrackingNumber” and the USPS PIC respond with an “EstimateRequest” which number. The USPS PIC number is USPS only includes the “TransactionDigest”. Package Identification and it should be used for tracking UPS Mail Innovations An example: shipments.

How long is data stored for Signature Tracking signature image or POD (Proof of Delivery)? The UPS Technology Agreement (UTA) allows storage of a POD letter for a maximum of 18 months.

Is there a watermark behind the signature image returned by the UPS Signature Tracking API?

UPS® Developer Kit | Frequently Asked Questions UPS TradeAbility® API

Why is my partial tariff code not working even with the “TariffCodeAlert” set to false? While generally a six-digit tariff code is sufficient, that rule is not true 100% of the time as there are some exceptions by country and product. If you are unable to use a partial tariff code you will need to use a more detailed tariff code.

Why am I not receiving Value Added Tax (VAT) back in my Landed Cost Response? The VAT is only returned when certain conditions are met. Those conditions differ depending upon the origin, destination and product utilized.

What are the formulas used to determine the duties and fees for Landed Cost and are they available in the Developer Guide? Landed Cost algorithms are not published in the Developer Guide and do not exist in a format for use.

How do I contact UPS with questions on TradeAbility API transaction results? Follow the steps below to submit a Why am I receiving an “Invalid business- or trade-specific inquiry to the Landed Cost Request document” error UPS Trade Content Group: or “No Access and Authentication Credentials provided” error? 1. Login to ups.com with the same This may be because the namespace URLs User ID and Password used in your do not include https. API request. 2. Go to the “Shipping” tab. Why is my landed cost estimate incorrect? 3. Click the menu option “Use Make sure all currency codes are valid and International Tools”. the proper landed cost value is returned. 4. On the left navigation menu click If a request does not specify “Currency the link marked “View Transaction Code” for “Unit Price” Landed Cost History”. defaults the currency code to the destination country’s currency code. 5. Select the appropriate options and click “Search”. How do I remove Tariff Code Alerts? 6. Click the transaction in question. Setting the “TariffCodeAlert” value to ‘0’ (false) will prevent Tariff Code Alerts to be 7. Scroll down the results page and sent. click the link labeled “Contact Trade Support”. 8. Fill out the form and click “Submit”.

UPS® Developer Kit | Frequently Asked Questions UPS TradeAbility® API

This will send your question to our Trade provide these estimates as the fees will experts who will review your information vary by broker. and email a response. What taxes and/or fees are included How often are updates made to the in the “Other taxes and fees” “Denied Party Screening” list? category of the landed cost? Denied Party Screening data is updated on The “Other taxes and fees” category are a daily basis, five days a week (business taxes and fees imposed by the days). Data is acquired through a government and are unrelated to the combination of both manual and product. automated extractions that are compiled, tested and then uploaded to production through a scheduled process that runs every day at 2 p.m. ET.

How often are updates made to “Import Compliance”? Like the tariff, there is no scheduled update for import compliance data. Generally, these changes are usually prompted by legislation or rulings enacted by a country. These updates are also based on prioritization by country, severity of the change and the customer usage levels for that particular destination. Most common updates for compliance-level data usually involve a simple change to the URL.

How often are updates made to “Harmonized Tariff Codes”? There is no formal or synchronized schedule in which Tariff Codes are updated by country. For example, some countries update their Tariff Codes once per year while others make updates once every few years. The United States and Canada make updates throughout the year. Brokerage experts at UPS monitor these changes and make changes every six months or year. These updates are based on prioritization by country, severity of the change and the customer usage levels for that particular destination country.

Why did the TradeAbility API landed cost estimate not include the additional fees included in the actual invoice? Brokerage charges are not included in the landed cost estimate. Neither the ups.com TradeAbility application nor the API can