UPSAccount Type
Represents the details of a UPS account.
Remarks
This type contains data describing the UPS server and login information.
Example: Setting the fields of an account
UPSAccount account = new UPSAccount account.Server = "https://wwwcie.ups.com/"; account.AccessKey = "123451234512345"; account.AccountNumber = "12345"; account.Password = "my_password"; account.UserId = "my_username";
The fields contained by this type are listed below.
Fields
|
AccessKey String |
An identifier required to connect to a UPS server. A UserId, Password and AccessKey will be required for each request sent to UPS. This Access Key is provided to you by UPS. For this, please visit http://www.ups.com/e_comm_access/gettools_index?loc=en_US and follow the steps as instructed on that page. Please read the instructions carefully. You should register first, and after reviewing and accepting the UPS User Agreement, you should submit a request for an UPS OnLine Tools Developer's Key. After the request has been submitted, your Developer's Key will be emailed to the email address you provided to UPS during registration process. After obtaining the Developer's Key, you can then submit a request for the Access License Key (for XML tools). This will also be sent to you via email. Please save it as it is required to be used with all requests sent to any UPS server (via our bean which utilizes UPS Online Tools). An Access Key provides access to UPS systems, which hold the information you or your customers need to ship, track, or rate a package. Your Developer's Key lets you get UPS OnLine Tool documentation; the Access Key lets you actually implement UPS OnLine Tools. You need only one Access Key for access to all UPS OnLine Tools. However, if multiple locations or departments will be accessing the Tools, a great way to monitor and assess usage is to have an Access Key per location. UPS recommends each site implementation of your EC (E-Commerce) solution have separate Access Keys. An example would be a company that is implementing the Tools into three parts of their organization in three different cities. In this case, it is recommended that you obtain three separate Access Keys to uniquely identify each site. If you have Production access for an API, you can still access the Test environment. If you have Test access for one or more APIs, you must Request Production Access in order to use those APIs for production requests. This is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. Sharing the security elements (UserId, Password, AccessKey, and DeveloperKey) with third parties is strictly prohibited as expressed in the UPS Developer Agreement. | ||||||||||||||||||||||||||||||||||||
|
AccountNumber String |
The shipper's UPS account number. This field describes the shipper's 6- or 10- digit UPS account number. | ||||||||||||||||||||||||||||||||||||
|
Password String |
Password to use for logging in to a UPS Server. A UserId and Password will be required with each input request a user makes to a UPS server. These are used to authenticate the client system during login. This password is the one you chose to login when you registered for service with UPS. This is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. Sharing the security elements (UserId, Password, AccessKey, and DeveloperKey) with third parties is strictly prohibited as expressed in the UPS Developer Agreement. Number of characters: 6..10. | ||||||||||||||||||||||||||||||||||||
|
Server String |
URL for the UPS server where the requests are sent. Each request requires specific processing based on the type; therefore, each component has a unique URL for connection purposes. The following URLs may be used for testing:
In a production environment, the URL for connecting to a UPS server (production environment) will be provided to you by UPS when you subscribe for UPS OnLine Tools. | ||||||||||||||||||||||||||||||||||||
|
UserId String |
User Id for logging in to UPS. A UserId and Password will be required with each request made to UPS. These are used to authenticate the client system during login. The UserId is the one you chose to login with when you registered for service with UPS. This is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. Sharing the security elements (UserId, Password, AccessKey, and DeveloperKey) with third parties is strictly prohibited as expressed in the UPS Developer Agreement. Maximum length: 16. |
Constructors
public UPSAccount();