Access Key
To request Access Key (Access Licence Number) firstly please make sure to be registered online.
Use the following link: https://www.ups.com/upsdeveloperkit?loc=en_GB
and follow steps below:
Step 1: Sign up for a ups.com® profile or Log-in now.
Step 2: Select an API.
Step 3: Download the API documentation.
Step 4: Request an access key.
Field Requirements:
|
Intersoft Intelligent Shipper® Field Name |
Comments |
|
Item HS Code |
Mandatory when using Paperless Trade |
|
Item Country of Origin |
Mandatory when using Paperless Trade |
|
Invoice Date |
Mandatory when using Paperless Trade NOTE: The Intelligent Shipper createShipment request requires that Invoice Number is provided along with Invoice Date. See the document “Intelligent Shipper API - Multipiece Shipment Bookings” for more information. |
|
Destination Company Name |
Mandatory when using Paperless Trade |
|
Shipper County |
Mandatory when shipping to: |
|
Destination County |
Service Enhancements - available.
If you would like to use any of the enhancements, please first speak to your UPS account manager to confirm which of them are available for the services that you would like to be using.
To utilise this within Intelligent Shipper, you would need to add Enhancement Service Code field to your file / API request, followed by a specific code.
|
Service Enhancement |
Supporting Data Required |
Business Rules / Constraints |
|
Email Notification - Ship Notification |
Receiver Email Address |
N/A |
|
Email Notification - Exception Notification |
||
|
Email Notification - Delivery Notification |
||
|
Email Notification - Alternate Delivery Location Notification |
||
|
Saturday Delivery |
N/A |
Shipment date and service must equal a Saturday delivery (e.g. if shipment date is a Thursday and a Next Day service is used, Saturday Delivery enhancement cannot be used as the shipment will arrive on Friday). |
|
Delivery Confirmation |
Adult Signature Required |
N/A |
Multipiece Shipments - available.
Carrier Packaging - available.
The following carrier package type names can be used with UPS shipments:
- UPS Letter
- Customer Supplied Package
- Tube
- PAK
- UPS Express Box
- UPS 25KG Box
- UPS 10KG Box
- Pallet
- Small Express Box
- Medium Express Box
- Large Express Box
- Flats
- Parcels
- BPM
- First Class
- Priority
- Machinables
- Irregulars
- Parcel Post
- BPM Parcel
- Media Mail
- BPM Flat
- Standard Flat
To utilise this within Intelligent Shipper, you would need to add Package Type Name field to your file / API request, followed by a specific code.
If package type name is not provided, the package type will default to Customer Supplied Package.
Delivery Instructions - not available.
Hazardous Materials - not available.
Incoterms - DDU, DDP
Paperless Trade - avaialble.
If not shipping paperless,you would need to provide a Commercial Invoice and attach it to the parcel. The invoice is not a part of the label you receive from Intersoft. You have two options here:
- Creating your own paperwork.
- Using printDocument API call to receive an Intersoft version of Commercial Invoice.
Please check with the carrier how many copies of Commercial Invoice are required.