Subscribe Method

Requests the unique meter number specific to the FedEx customer's account number.

Syntax

fedexmgr.subscribe([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method is applicable to CSP and non-CSP developers.

The customer should call this method to obtain the unique meter number specific to the FedEx customer's account number for integration testing and when a customer application moves to production. This is a one-time only request to register the customer's FedEx account.

Upon successful response, a unique client device (i.e. meter number specific to the customer's FedEx account number), and RegisteredServices (which identifies the FedEx shipping service type(s) that the caller has been registered and authorized to use) will be returned to the client.

This FedExMeterNumber should be used in all subsequent requests sent to FedEx web services.

Note that you must have a valid FedExAccountNumber before requesting a meter number. In most cases, only one meter number is required for your shipping application. For companies with more than one shipping facility or distribution center, you must have a FedEx account number and meter number pair for each facility. For example, if you have distribution centers in California, Texas, and Florida, the label created at the Texas facility must have the account number and meter number associated with that facility. If you submit packages with labels that are generated on the California account and meter number pair, this situation may negatively impact FedEx's ability to deliver your packages in a timely and efficient manner.

The following properties can be passed in the request:

• FedExAccountNumber (required)
• FedExCSPUserKey (required for CSP developers)
• FedExCSPUserPassword (required for CSP developers)
• CSPSolutionId (required for CSP developers)
• FedExDeveloperKey (required)
• FedExPassword (required)
• FedExServer (required)
• SenderAddress1 (required)
• SenderCity (required)
• SenderState (required)
• SenderZipCode (required)
• SenderCountryCode (required)
• SenderFirstName (required)
• SenderLastName (required)
• SenderCompany (required)
• SenderPhone (required)
• SenderEmail (required)

Upon successful response, the following properties will be filled:

• FedExMeterNumber
• RegisteredServices