Difference between revisions of "X-Cart:FedEx"

From X-Cart 4 Classic
Jump to: navigation, search
(FedEx Ship Manager Direct issue: Person Name is changed when clicking on 'Get the FedEx meter number')
m
 
(41 intermediate revisions by 4 users not shown)
Line 3: Line 3:
 
== Setting up shipping cost calculation for FedEx ==
 
== Setting up shipping cost calculation for FedEx ==
  
'''To set up shipping cost calculation for FedEx:'''
+
1. If you haven't yet done so, provide your own company's address in the '<u>General settings->Company options</u>' section. Make sure you have provided that address correctly - it will be submitted to the real-time shipping calculator as the origin address for all shipments from your store and thus affect the shipping rates.
  
1. If you haven't yet done so, provide your own company address in the '<u>General settings->Company options</u>' section. Make sure you provide this address correctly - it will be submitted to the real-time shipping calculator as the origin address for all shipments from your store and thus will affect the shipping rates.
+
2. Obtain an account for FedEx Web Services (http://www.fedex.com/us/oadr/); make sure it is moved to production so that you have a functioning account (please contact FedEx for details).
 
 
2. Obtain an account for FedEx Web Services (please contact FedEx for details).
 
  
 
3. Enable your store to use the real-time shipping calculator provided by FedEx:
 
3. Enable your store to use the real-time shipping calculator provided by FedEx:
  
:# In your store's Admin area, go to the '<u>General settings->Shipping options</u>' section.
+
:a) In your store's Admin area, go to the '<u>General settings->Shipping options</u>' section.
:# On the '<u>General settings->Shipping options</u>' page, select the check box '<u>Enable real-time shipping calculation</u>'. Unselect the check box '<u>Use Intershipper calculation service</u>'.
+
:b) Select the check box '<u>Enable real-time shipping calculation</u>'. Unselect the check box '<u>Use InterShipper calculation service</u>'.
:# Use the '<u>FedEx account details</u>' subsection of '<u>General settings->Shipping options</u>' page to provide your FedEx account information:
+
:c) Use the '<u>FedEx options</u>' subsection of '<u>General settings->Shipping options</u>' page to provide your FedEx account information:
:#* FedEx account number,
+
:* FedEx account number
:#* FedEx authentication key,
+
:* FedEx authentication key
:#* FedEx authentication password. <br/>
+
:* FedEx authentication password
 +
:* FedEx meter number <br/>
  
[[Image:Fedex_acc_info.gif|Fedex_acc_info.gif|center|border]]
+
[[Image:Fedex_acc_info.gif|Fedex_acc_info.gif|center]]
  
:: {{Note1|Please note that FedEx uses different credentials for production and test accounts. A production account does not work in test mode, and vice versa.}}
+
:: {{Note1|If you use 4.4.3 or older version, make sure [[X-Cart:FedEx#FedEx_Web_Services_issue:_Can_not_get_FedEx_meter_number | these patches]] have been installed. The patches add the "FedEx meter number" field to the '<u>FedEx options</u>' subsection of '<u>General settings->Shipping options</u>' page.}}
  
:: {{Note1|Your production credentials (FedEx authentication key and FedEx authentication password) can be obtained from FedEx Developer Resource Center at http://www.fedex.com/developer. Please contact FedEx Online Support for assistance on getting your production credentials for FedEx Web Services.}}
+
:: {{Note1|FedEx meter number is provided along with other account details like FedEx account number, FedEx authentication key/password, when setting up an account with FedEx.}}
  
4. Obtain a meter number from FedEx:
+
:: {{Note1|Please note that FedEx uses different credentials for production and test accounts. A production account does not work in the test mode, and vice versa. If you account is already in production, make sure the '''Test mode''' check-box is unticked.}}
  
Go to the '<u>Shipping methods</u>' section of your store's Admin area (<u>Settings menu->Shipping methods</u>). Find FedEx on the list of real-time shipping methods and click on the Options >> link against it. This opens the '<u>FedEx options</u>' dialog box:
+
:: {{Note1|Your production credentials (FedEx authentication key and FedEx authentication password) can be obtained from FedEx Developer Resource Center at http://www.fedex.com/developer. Please contact FedEx Online Support for assistance with getting your production credentials for FedEx Web Services.}}
  
<div align="center">[[Image:fedex_dir_opts1.gif|center|border]]
+
:c) Click the '''Apply changes''' button to save the settings.
</div>
 
  
The '<u>FedEx options</u>' dialog box provides a form that you must complete to obtain a meter number. Be sure to complete all the required fields, then click the '''Get the FedEx meter number''' button.
+
4. Set up FedEx options:
  
{{Note1|Please make sure you enter your phone number without the country code, otherwise it will not be accepted.}}
+
:a) Go to the '<u>Shipping methods</u>' section of your store's Admin area (<u>Shipping and Taxes menu -> Shipping methods</u>). Find FedEx on the list of real-time shipping methods and click on the Options >> link against it.
  
After you click on '''Get the FedEx meter number''', X-Cart software will connect to FedEx and request a meter number for your account. As soon as the meter number is obtained, the contents of the '<u>FedEx options</u>' dialog box will be reloaded and you will see a form like the following (Note that your meter number will be displayed at its top):
+
:b) Adjust the settings in the '<u>FedEx options</u>' dialog box according to your preferences:
  
<div align="center">[[Image:fedex_opts.gif|668px]]
+
<div align="center">[[Image:fedex_opts.gif]]
 +
</div>
 +
:: Note that if you select the '''Add SmartPost Shipping data to request''' checkbox option, the <u>SmartPost Shipping settings</u> section is expanded and you get to adjust a few more options:
 +
<div align="center">[[Image:Smartpost.png]]
 
</div>
 
</div>
  
# Adjust the settings in the '<u>FedEx options</u>' dialog box according to your preferences.
+
:c) Click the '''Apply''' button to save the changes.
# Click the '''Apply''' button to save the changes.
 
  
 
That is all. Now you can test whether your store can receive real-time shipping rates correctly. For details, see [[X-Cart:Testing Your Store's Ability to Receive Real-time Shipping Rates]] page.
 
That is all. Now you can test whether your store can receive real-time shipping rates correctly. For details, see [[X-Cart:Testing Your Store's Ability to Receive Real-time Shipping Rates]] page.
  
[[Category:X-Cart user manual]]
+
== Shipping in multiple packages ==
 +
X-Cart now provides a packaging algorithm that allows splitting an entire purchase into multiple packages that fit certain limitations (maximum package weight and dimensions). This algorithm allows to get real-time shipping rates even when the cart contains a large quantity of products with the total weight and dimensions exceeding the values allowed for a single package.
 +
 
 +
With the [[X-Cart:Setting_Up_Dimensional_Shipping|Dimensional Shipping]] feature, you can specify dimensions for each product you have got at your store (See the <u>Product details</u>  page) and use those dimensions for calculating shipping rates using the on-line shipping rate calculation service.
 +
 
 +
For more information, please refer to [[X-Cart:Setting_Up_Dimensional_Shipping|Setting Up Dimensional Shipping]].
 +
 
 +
{{Note|When using the '''Ship in a separate box''' option for products, make sure that the '''Split the shipment into multiple packages if its weight/dimensions exceed the limitations''' option is enabled.}}
 +
 
 +
== Troubleshooting ==
 +
 
 +
=== Authentication failure error; rates don't show ===
 +
 
 +
When trying to get shipping rates, I get the "Authentication Failed" error, and shipping rates wouldn't show.
 +
 
 +
'''Solution:'''
  
==Troubleshooting==
+
If you get the "Authentication Failed" error, or the service fails to return shipping rates, try enabling or disabling '''Test mode''' in the FedEx options; that's on the Shipping Options page of the Admin area. Normally, you should disable the test mode as soon as your account is moved to production environment.
  
===FedEx Ship Manager Direct issue: meter number fetch failure ===
+
=== FedEx Ship Manager Direct issue: meter number fetch failure ===
  
 
When attempting to fetch a meter number for Fedex Real time shipping, I got the following error:
 
When attempting to fetch a meter number for Fedex Real time shipping, I got the following error:
Line 61: Line 76:
 
The problem may be caused by the fact that none of the HTTPS modules (Net::SSLeay, CURL, libCURL, OpenSSL) are installed / functional on your host.
 
The problem may be caused by the fact that none of the HTTPS modules (Net::SSLeay, CURL, libCURL, OpenSSL) are installed / functional on your host.
  
Check it on the "Summary" page in your X-Cart admin area. [[X-Cart:How_to_set_up_HTTPS_modules]]
+
Check it on the "Summary" page in your X-Cart admin area. [[X-Cart:Setting_Up_HTTPS_modules]]
  
 
If you find it difficult to resolve this issue yourself, feel free to contact our support team for assistance.
 
If you find it difficult to resolve this issue yourself, feel free to contact our support team for assistance.
  
===FedEx Ship Manager Direct issue: Can not get FedEx meter number===
+
=== FedEx Ship Manager Direct issue: Can not get FedEx meter number ===
  
 
{{XC version|version=4.1.11}} Affected version: X-Cart 4.1.11
 
{{XC version|version=4.1.11}} Affected version: X-Cart 4.1.11
Line 78: Line 93:
 
In order to fix the issue, apply [[:File:fedex_meter_number_fix.txt]] patch.
 
In order to fix the issue, apply [[:File:fedex_meter_number_fix.txt]] patch.
  
===FedEx Ship Manager Direct issue: Person Name is changed when clicking on 'Get the FedEx meter number'===
+
=== FedEx Ship Manager Direct issue: Person Name is changed when clicking on 'Get the FedEx meter number' ===
  
 
{{XC version|version=4.1.11}} Affected version: X-Cart 4.1.11
 
{{XC version|version=4.1.11}} Affected version: X-Cart 4.1.11
Line 86: Line 101:
 
Solution: upgrade your store up to the 4.1.12 version or contact our support team for the necessary patches.
 
Solution: upgrade your store up to the 4.1.12 version or contact our support team for the necessary patches.
  
==FAQ==
+
=== FedEx Web Services issue: Can not get FedEx meter number ===
 +
 
 +
{{XC version|version=4.3.x; 4.4.0-4.4.3}} Affected versions: X-Cart 4.3.x, 4.4.0-4.4.3.
 +
 
 +
<u>Problem:</u> When I try to get a FedEx meter number, I receive the following error:
 +
 
 +
<pre>
 +
The following error has been received from FedEx server: FedEx module: The received data could not be parsed correctly.
 +
</pre>
 +
 
 +
<u>Solution:</u>
 +
 
 +
FedEx meter number is now provided along with other account details like FedEx account number, FedEx authentication key/password, when setting up an account with FedEx. You do not need to generate it via X-Cart Admin area anymore.
 +
 
 +
To be able to provide your X-Cart store with your FedEx meter number:
 +
 
 +
1) Apply the following update patches:
 +
:- File patch: [[:File:FEDEX_meter_number.patch.txt]] for 4.4.x or [[:File:FEDEX_meter_number.patch.4_3_x.txt]] for 4.3.x (see: [[X-Cart:Applying_Patches#Applying_File_Patches | Applying File Patches]]).
 +
:- SQL patch: [[:File:FEDEX_meter_number.sql.txt]] for both 4.4.x and 4.3.x (see: [[X-Cart:Applying_Patches#Applying_SQL_Patches | Applying SQL Patches]]).
 +
 
 +
{{Note|For versions 4.4.0-4.4.2 and 4.3.0-4.3.1 you may need to apply the file patch [[X-Cart:To_apply_a_patch_manually | manually]].}}
 +
 
 +
2) Fill in your FedEx meter number in the <u>'FedEx options'</u> subsection of <u>'General settings->Shipping options'</u> page.
 +
 
 +
3) Proceed with the [[X-Cart:FedEx#Setting_up_shipping_cost_calculation_for_FedEx | FedEx setup instructions]] at step 4.
 +
 
 +
=== Applicable rates are not applied to my FedEx account. How do I solve the problem? ===
 +
 
 +
If you do not get correct rates from FedEx, first of all, make sure you have entered appropriate account credentials in the '<u>FedEx options</u>' subsection of '<u>General settings->Shipping options</u>' page:
 +
 
 +
* FedEx account number
 +
* FedEx authentication key
 +
* FedEx authentication password
 +
* FedEx meter number
 +
 
 +
Please note, applicable rates returned from FedEx depends on what account credentials are used. For example, to get retail rates from FedEx for your account, you should use the appropriate authentication key, authentication password and meter number which retail rates are applied to.
 +
 
 +
You may also need to contact FedEx, and ask them to check if you use proper account credentials (authentication key, authentication password and meter number) associated with your FedEx account, as well as to check if the rates you expect are applied to your FedEx account. Please do not forget to provide them with your FedEx account number and credentials that are used in your X-Cart store.
 +
 
 +
{{Note1|If you use 4.4.3 or older version, make sure [[X-Cart:FedEx#FedEx_Web_Services_issue:_Can_not_get_FedEx_meter_number | these patches]] have been installed. The patches add the "FedEx meter number" field to the '<u>FedEx options</u>' subsection of '<u>General settings->Shipping options</u>' page.}}
 +
 
 +
See also: [[X-Cart:FedEx#Setting_up_shipping_cost_calculation_for_FedEx | section "Setting up shipping cost calculation for FedEx"]].
 +
 
 +
== FAQ ==
 +
 
 +
=== FedEx is migrating from FedEx Ship Manager Direct to FedEx  Web Services. Will I need to upgrade, or modify my system? ===
 +
 
 +
FedEx Web Services was introduced in X-Cart 4.3.0. So, if you use any version from 4.3.x or 4.4.x branch, no update is needed. However, if you use an older version, upgrade to 4.3.x or 4.4.x is required.
 +
 
 +
=== FedEx Home Delivery / FedEx Ground not returning rates. How do I solve the problem? ===
 +
 
 +
FedEx can provide rates for one of the shipping methods only: FedEx Home Delivery or FedEx Ground. It depends on the following option being configured on the "FedEx options" page in X-Cart admin back-end:
  
===FedEx is migrating from API to Web Services. Will I need to upgrade, or modify my system?===
+
* Shipment is Residential Delivery
  
FedEx Web Services was introduced in X-Cart 4.3. So, if you use any version from 4.3 branch, no update is needed. However, if you use an older version, upgrade to 4.3 is required.
+
When the above option is enabled, FedEx returns rates for FedEx Home Delivery, otherwise it return rates for FedEx Ground.
  
 +
=== How do I make FedEx do not show estimated shipment arrival date along with the shipping rates? ===
 +
 +
FedEx returns the estimated date when the shipment will arrive along with the shipping rates. I don't want to display those.
 +
 +
For example - now it says:
 +
 +
* FedEx 2Day® - Mon Apr 30 $25.01
 +
* FedEx Ground® - 1 day $19.85
 +
 +
All I want is:
 +
 +
* FedEx 2Day®  $25.01
 +
* FedEx Ground® $19.85
 +
 +
How do I do that?
 +
 +
<u>Solution:</u>
 +
 +
1) Modify "<xcart_dir>/shipping/mod_FEDEX.php", find the following line of code:
 +
 +
<pre>
 +
$estimated_time = func_fedex_get_estimated_time($entry, $prefix);
 +
</pre>
 +
 +
and change it to:
 +
 +
<pre>
 +
$estimated_time = "";//func_fedex_get_estimated_time($entry, $prefix);
 +
</pre>
 +
 +
2) Make sure the "Delivery time" field is empty for all FedEdx shipping methods on the [[X-Cart:Shipping_Settings#Shipping_Methods | "Shipping methods"]] page.
 +
 +
== See also ==
 +
 +
* [[X-Cart:Setting_Up_Dimensional_Shipping|Setting up Dimensional Shipping]]
 +
 +
[[Category:X-Cart user manual]]
 +
[[Category:X-Cart user manual]]
 +
[[Category:X-Cart user manual]]
 
[[Category:X-Cart user manual]]
 
[[Category:X-Cart user manual]]

Latest revision as of 14:33, 14 May 2013

To use FedEx real-time shipping cost calculation, you must complete end-user certification with FedEx.

Setting up shipping cost calculation for FedEx

1. If you haven't yet done so, provide your own company's address in the 'General settings->Company options' section. Make sure you have provided that address correctly - it will be submitted to the real-time shipping calculator as the origin address for all shipments from your store and thus affect the shipping rates.

2. Obtain an account for FedEx Web Services (http://www.fedex.com/us/oadr/); make sure it is moved to production so that you have a functioning account (please contact FedEx for details).

3. Enable your store to use the real-time shipping calculator provided by FedEx:

a) In your store's Admin area, go to the 'General settings->Shipping options' section.
b) Select the check box 'Enable real-time shipping calculation'. Unselect the check box 'Use InterShipper calculation service'.
c) Use the 'FedEx options' subsection of 'General settings->Shipping options' page to provide your FedEx account information:
  • FedEx account number
  • FedEx authentication key
  • FedEx authentication password
  • FedEx meter number
Fedex_acc_info.gif
If you use 4.4.3 or older version, make sure these patches have been installed. The patches add the "FedEx meter number" field to the 'FedEx options' subsection of 'General settings->Shipping options' page.
FedEx meter number is provided along with other account details like FedEx account number, FedEx authentication key/password, when setting up an account with FedEx.
Please note that FedEx uses different credentials for production and test accounts. A production account does not work in the test mode, and vice versa. If you account is already in production, make sure the Test mode check-box is unticked.
Your production credentials (FedEx authentication key and FedEx authentication password) can be obtained from FedEx Developer Resource Center at http://www.fedex.com/developer. Please contact FedEx Online Support for assistance with getting your production credentials for FedEx Web Services.
c) Click the Apply changes button to save the settings.

4. Set up FedEx options:

a) Go to the 'Shipping methods' section of your store's Admin area (Shipping and Taxes menu -> Shipping methods). Find FedEx on the list of real-time shipping methods and click on the Options >> link against it.
b) Adjust the settings in the 'FedEx options' dialog box according to your preferences:
Fedex opts.gif
Note that if you select the Add SmartPost Shipping data to request checkbox option, the SmartPost Shipping settings section is expanded and you get to adjust a few more options:
Smartpost.png
c) Click the Apply button to save the changes.

That is all. Now you can test whether your store can receive real-time shipping rates correctly. For details, see X-Cart:Testing Your Store's Ability to Receive Real-time Shipping Rates page.

Shipping in multiple packages

X-Cart now provides a packaging algorithm that allows splitting an entire purchase into multiple packages that fit certain limitations (maximum package weight and dimensions). This algorithm allows to get real-time shipping rates even when the cart contains a large quantity of products with the total weight and dimensions exceeding the values allowed for a single package.

With the Dimensional Shipping feature, you can specify dimensions for each product you have got at your store (See the Product details page) and use those dimensions for calculating shipping rates using the on-line shipping rate calculation service.

For more information, please refer to Setting Up Dimensional Shipping.

Note: When using the Ship in a separate box option for products, make sure that the Split the shipment into multiple packages if its weight/dimensions exceed the limitations option is enabled.

Troubleshooting

Authentication failure error; rates don't show

When trying to get shipping rates, I get the "Authentication Failed" error, and shipping rates wouldn't show.

Solution:

If you get the "Authentication Failed" error, or the service fails to return shipping rates, try enabling or disabling Test mode in the FedEx options; that's on the Shipping Options page of the Admin area. Normally, you should disable the test mode as soon as your account is moved to production environment.

FedEx Ship Manager Direct issue: meter number fetch failure

When attempting to fetch a meter number for Fedex Real time shipping, I got the following error:

"The following error has been received from FedEx server: FedEx module: The received data could not be parsed correctly."

Solution:

The problem may be caused by the fact that none of the HTTPS modules (Net::SSLeay, CURL, libCURL, OpenSSL) are installed / functional on your host.

Check it on the "Summary" page in your X-Cart admin area. X-Cart:Setting_Up_HTTPS_modules

If you find it difficult to resolve this issue yourself, feel free to contact our support team for assistance.

FedEx Ship Manager Direct issue: Can not get FedEx meter number

X-Cart 4.1.11

Affected version: X-Cart 4.1.11

When you try to get FedEx meter number you receive random errors:

The following error has been received from FedEx server: XML FATAL Parse Error: Expected entity name for reference Line 1 Column 467
The following error has been received from FedEx server: XML FATAL Parse Error: Expected entity name for reference Line 1 Column 471''

In order to fix the issue, apply File:fedex_meter_number_fix.txt patch.

FedEx Ship Manager Direct issue: Person Name is changed when clicking on 'Get the FedEx meter number'

X-Cart 4.1.11

Affected version: X-Cart 4.1.11

After you click on the 'Get the FedEx meter number' it changes the Person name on the FedEx Ship Manager Direct to Master Master.

Solution: upgrade your store up to the 4.1.12 version or contact our support team for the necessary patches.

FedEx Web Services issue: Can not get FedEx meter number

X-Cart 4.3.x; 4.4.0-4.4.3

Affected versions: X-Cart 4.3.x, 4.4.0-4.4.3.

Problem: When I try to get a FedEx meter number, I receive the following error:

The following error has been received from FedEx server: FedEx module: The received data could not be parsed correctly.

Solution:

FedEx meter number is now provided along with other account details like FedEx account number, FedEx authentication key/password, when setting up an account with FedEx. You do not need to generate it via X-Cart Admin area anymore.

To be able to provide your X-Cart store with your FedEx meter number:

1) Apply the following update patches:

- File patch: File:FEDEX_meter_number.patch.txt for 4.4.x or File:FEDEX_meter_number.patch.4_3_x.txt for 4.3.x (see: Applying File Patches).
- SQL patch: File:FEDEX_meter_number.sql.txt for both 4.4.x and 4.3.x (see: Applying SQL Patches).
Note: For versions 4.4.0-4.4.2 and 4.3.0-4.3.1 you may need to apply the file patch manually.

2) Fill in your FedEx meter number in the 'FedEx options' subsection of 'General settings->Shipping options' page.

3) Proceed with the FedEx setup instructions at step 4.

Applicable rates are not applied to my FedEx account. How do I solve the problem?

If you do not get correct rates from FedEx, first of all, make sure you have entered appropriate account credentials in the 'FedEx options' subsection of 'General settings->Shipping options' page:

  • FedEx account number
  • FedEx authentication key
  • FedEx authentication password
  • FedEx meter number

Please note, applicable rates returned from FedEx depends on what account credentials are used. For example, to get retail rates from FedEx for your account, you should use the appropriate authentication key, authentication password and meter number which retail rates are applied to.

You may also need to contact FedEx, and ask them to check if you use proper account credentials (authentication key, authentication password and meter number) associated with your FedEx account, as well as to check if the rates you expect are applied to your FedEx account. Please do not forget to provide them with your FedEx account number and credentials that are used in your X-Cart store.

If you use 4.4.3 or older version, make sure these patches have been installed. The patches add the "FedEx meter number" field to the 'FedEx options' subsection of 'General settings->Shipping options' page.

See also: section "Setting up shipping cost calculation for FedEx".

FAQ

FedEx is migrating from FedEx Ship Manager Direct to FedEx Web Services. Will I need to upgrade, or modify my system?

FedEx Web Services was introduced in X-Cart 4.3.0. So, if you use any version from 4.3.x or 4.4.x branch, no update is needed. However, if you use an older version, upgrade to 4.3.x or 4.4.x is required.

FedEx Home Delivery / FedEx Ground not returning rates. How do I solve the problem?

FedEx can provide rates for one of the shipping methods only: FedEx Home Delivery or FedEx Ground. It depends on the following option being configured on the "FedEx options" page in X-Cart admin back-end:

  • Shipment is Residential Delivery

When the above option is enabled, FedEx returns rates for FedEx Home Delivery, otherwise it return rates for FedEx Ground.

How do I make FedEx do not show estimated shipment arrival date along with the shipping rates?

FedEx returns the estimated date when the shipment will arrive along with the shipping rates. I don't want to display those.

For example - now it says:

  • FedEx 2Day® - Mon Apr 30 $25.01
  • FedEx Ground® - 1 day $19.85

All I want is:

  • FedEx 2Day® $25.01
  • FedEx Ground® $19.85

How do I do that?

Solution:

1) Modify "<xcart_dir>/shipping/mod_FEDEX.php", find the following line of code:

$estimated_time = func_fedex_get_estimated_time($entry, $prefix);

and change it to:

$estimated_time = "";//func_fedex_get_estimated_time($entry, $prefix);

2) Make sure the "Delivery time" field is empty for all FedEdx shipping methods on the "Shipping methods" page.

See also