Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

EzAccount Type

Represents the details of a shipper account.

Remarks

This type contains data describing the server and login information.

Example: Setting the fields of an account for FedEx servers

EzAccount account = new EzAccount
account.AccountNumber = "1234567"
account.DeveloperKey = "my_developer_key"
account.MeterNumber = "1234567"
account.Password = "my_password"
account.Server = "https://test.fedex.com"

The fields contained by this type are listed below.

Fields

AccessKey
String

An identifier required to connect to UPS. A UserId, Password and AccessKey will be required for each request sent to UPS.

This field is only applicable to UPS accounts.

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 component 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 account number.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

For Canada Post, this field should be set to the customer number of the owner of the mail (mailed on behalf of customer).

DeveloperKey
String

Identifying part of the authentication key used for the sender's identity.

The DeveloperKey is part of the authentication string used to verify sender's identity. This credential is used to authenticate a specific software application, so that your transactions are recognized by the FedEx back-end systems. The Developer Key is provided to you by FedEx after registration and it is the publicly known part of authentication credential.

The DeveloperKey, AccountNumber, MeterNumber, and Password will be required with each input request a user makes to a FedEx server. 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.

This field is only applicable to FedEx servers.

MeterNumber
String

Meter number to use for submitting requests to the FedEx Server.

An AccountNumber and MeterNumber will be required with each input request a user makes to a FedEx server. The Meter Number is provided to you by FedEx when you register for service. 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.

This field is only applicable to FedEx servers.

Password
String

Password for logging in to the Server.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

For Canada Post, this field should be set to the login password for your Canada Post account.

Server
String

URL for the server where the requests are sent.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

UserId
String

User Id for logging in to the Server.

This field is not used by FedEx.

For Canada Post, this field should be set to the login username for your Canada Post account

Constructors

[VB.NET]
Public EzAccount()

[C#]
public EzAccount();



 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0