Register Request

Function to interact with the Fedex Registration API, this function will register your account with Fedex and attempt to request a valid meter number for use in all other function requests.

In order to use this web tool as with all others you must have an Account number with Fedex and pass to it your valid billing information.

Function RegisterRequest
Output Type - 1 Standard CF variable:
FedexIdentifier
Error Capture Variables FedexError
- 0 = Success
- 1 = Failure
- 2 = Hard Error (configuration problem)

FedexErrorDesc
(contains description of error if present)
Test Environment Available Yes (this will generate a TEST meter number when request in Test mode)
Example Usage INSTALLED AS A CUSTOM TAG
<cf_adminpro_fedexxml
function="RegisterRequest"
accountnumber="your-fedex-account-number"
shippercontactname="Contact Name "
shippercompany="Your Company Name"
shipperdept="Department"
shipperphone="Company Phone Number "
shipperpager=""
shipperfax="Fax Number "
shipperemail="contact email address "
shipperstreet="billing street address "
shipperstreet2="billing street address line 2 "
shippercity="billing city "
shipperstate="billing state "
shipperzip="billing zip code"
shippercountry="billing country "
debug="False"
testingenvironment="false"
>
*Note to use as a custom tag you must install the tool in your ColdFusion server CustomTags directory or have it present in the directory you are calling it from.

CFMODULE
<cfmodule template="adminpro_fedexxml.cfm"
function="RegisterRequest"
accountnumber="your-fedex-account-number"
shippercontactname="Contact Name "
shippercompany="Your Company Name"
shipperdept="Department"
shipperphone="Company Phone Number"
shipperemail="contact email address "
shipperstreet="billing street address "
shipperstreet2="billing street address line 2 "
shippercity="billing city "
shipperstate="billing state "
shipperzip="billing zip code"
shippercountry="billing country "
debug="False"
testingenvironment="false"
>
Supplied Example Files register.cfm


Register Request
Input Attributes (attributes that can be passed to the custom tag with a valid value)
Attribute Name Required Preset value/value list Default Value Restrictions Explanation/Notes
AccountNumber Yes   NO VALUE Your active Fedex account number Your Fedex account number you use for shipping
ShipperCompany No   NO VALUE 35 chars maximum Shipper Company name
ShipperContactName         Shipper Contact name
ShipperDept         Shipper department
ShipperPhone         Shipper Phone number (numbers only, no dashes, spaces or parentheses)
ShipperEmail         Shipper Email address
ShipperStreet Yes   NO VALUE 35 chars maximum Shipper Street address line 1
ShipperStreet2 No   NO VALUE 35 chars maximum Shipper Street address line 2, the second line of an address (if it exists) this could be a unit number (Unit 4B), suite number (STE 77), apartment number (APT 4C) or other
ShipperCity Yes   NO VALUE 35 chars maximum Shipper City
ShipperState Yes   NO VALUE 2 chars maximum Shipper State (must be valid 2 character US state)
ShipperZip No   NO VALUE 9 chars maximum Shipper Zip code (5 digit part)

Register Request - Output
Column/Variable Name Always Present Default Value Explanation/Notes
Response Failure Variables (Present if FedexError = 0, 1 or 2)
FedexError Yes [0 (Successful transaction), 1 (Error from Fedex), 2 (Hard Error, error with request that could not be handled by Fedex, check attributes passed are valid)]
FedexErrorDesc Yes Description of error received
Success variables (Present if FedexError = 0)
FedexIdentifier No NO VALUE Valid Fedex meter number returned if register request was successful