Difference between revisions of "X-Cart:USPS"

From X-Cart 4 Classic
Jump to: navigation, search
m (Warning: fsockopen() : php network getaddresses: getaddrinfo failed: Name or service not known)
m (Setting up USPS real-time shipping calculator)
 
(8 intermediate revisions by 3 users not shown)
Line 11: Line 11:
 
::b. 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. 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>'.
 
::c. Use the '<u>U.S.P.S account details</u>' subsection of '<u>General settings->Shipping options</u>' page to provide the required information.
 
::c. Use the '<u>U.S.P.S account details</u>' subsection of '<u>General settings->Shipping options</u>' page to provide the required information.
:::* USPS Server name: production.shippingapis.com
 
 
:::* Web Tools User ID: the name you were sent in the email
 
:::* Web Tools User ID: the name you were sent in the email
 
::d. Click '''Save'''.
 
::d. Click '''Save'''.
Line 18: Line 17:
 
:b. Find USPS in the list of real-time shipping methods and click the Options >> link opposite it. A dialog box with USPS options opens.
 
:b. Find USPS in the list of real-time shipping methods and click the Options >> link opposite it. A dialog box with USPS options opens.
  
:: [[Image:usps_opts.gif|559px]]
+
:: [[File:usps.png|border]]
  
 
:c. Adjust the options according to your preferences.
 
:c. Adjust the options according to your preferences.
 
:d. Click the '''Apply''' button.
 
:d. Click the '''Apply''' button.
  
{{Note1|Note: Since USPS bases their rates on weight, make sure you have a weight assigned to all of your products. It defaults to lbs, so if you are using ounces be sure to change the conversion in General Settings.}}
+
{{Note1|'''Notes''':<br />1. Since USPS bases their rates on weight, make sure you have a weight assigned to all of your products. It defaults to lbs, so if you are using ounces be sure to change the conversion in General Settings.<br />2. (National shipping) Max. weight for Letter/Postcard first Class Mail Types is 3.5 oz. (0.21875  lbs). See https://www.usps.com/business/web-tools-apis/rate-calculator-api.htm#OLE_LINK5}}
 
 
 
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.
  
Line 36: Line 34:
 
{{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.}}
 
{{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.}}
  
 +
==Using the "USPS filter out Flat Rate options" feature (X-Cart 4.6.6 and later)==
 +
 +
To use the "USPS filter out Flat Rate options" feature you need to unselect all the services on the USPS settings page and make sure that your products have all the dimensions specified.
 +
 +
To control the number of items in one package, use one of the following methods:
 +
* Define product dimensions (See http://help.x-cart.com/index.php?title=X-Cart:Setting_Up_Dimensional_Shipping#Defining_product_dimensions).
 +
OR
 +
* Specify the desired USPS containers:<br />[[File:xc4_usps_containers.png|border]]
 +
For each container X-Cart sends a separate request to USPS, so if you do not need some container types, make sure that the values for them are set as RECTANGULAR/NONRECTANGULAR.
 +
 +
==Recorded Webinar - Automate Your USPS Shipping==
 +
 +
{{X-Cart:Recorded_Webinar_-_Automate_Your_USPS_Shipping}}
 +
<br /><br />
 
==Troubleshooting==
 
==Troubleshooting==
  
Line 59: Line 71:
  
 
We have released official hot-fixes for the problem, which can be found in our Issue tracker system:
 
We have released official hot-fixes for the problem, which can be found in our Issue tracker system:
* https://bugtracker.qtmsoft.com/view.php?id=38896#168592
+
* https://bt.x-cart.com/view.php?id=38896#168592
  
 
The hot-fix is already included into a stock 4.4.2 version.
 
The hot-fix is already included into a stock 4.4.2 version.
Line 68: Line 80:
  
 
The corresponding USPS API update patches for 4.1.x/4.2.x/4.3.x, 4.4.0-4.4.2 versions can be found  in our Issue tracker system:
 
The corresponding USPS API update patches for 4.1.x/4.2.x/4.3.x, 4.4.0-4.4.2 versions can be found  in our Issue tracker system:
* https://bugtracker.qtmsoft.com/view.php?id=38896#171114
+
* https://bt.x-cart.com/view.php?id=38896#171114
  
 
The USPS API update patches (RateV4 and IntlRateV2) for version 4.0.19 can be found here:
 
The USPS API update patches (RateV4 and IntlRateV2) for version 4.0.19 can be found here:
* https://bugtracker.qtmsoft.com/view.php?id=38896#171152
+
* https://bt.x-cart.com/view.php?id=38896#171152
  
Should you need any help in the updates installation in your X-Cart store - do not hesitate to request our support team for assistance via your personal [https://secure.qtmsoft.com/customer.php Helpdesk area].
+
Should you need any help in the updates installation in your X-Cart store - do not hesitate to request our support team for assistance via your personal [https://secure.x-cart.com/customer.php Helpdesk area].
  
 
===USPS error: Authorization failure. Perhaps username and/or password is incorrect.===
 
===USPS error: Authorization failure. Perhaps username and/or password is incorrect.===
  
When testing real-time shipping rates calculation in the X-Cart admin back-end:  [http://www.yoursite.com/xcart/admin/test_realtime_shipping.php]
+
When testing real-time shipping rates calculation in the X-Cart admin back-end (http://www.yoursite.com/xcart/admin/test_realtime_shipping.php),
 
 
 
the USPS server returns the following error:
 
the USPS server returns the following error:
  
Line 106: Line 117:
  
 
To fix this error please get in touch with the Internet Customer Care Center (USPS) and ask them to enable your profile in order to allow you access the Production Server. As soon as this is done, please re-test the real-time shipping rates calculation.
 
To fix this error please get in touch with the Internet Customer Care Center (USPS) and ask them to enable your profile in order to allow you access the Production Server. As soon as this is done, please re-test the real-time shipping rates calculation.
 
===Warning: fsockopen() : php network getaddresses: getaddrinfo failed: Name or service not known===
 
 
The following error is received when trying to get the USPS shipping rates:
 
 
<pre>
 
''Warning: fsockopen() [function.fsockopen]: php_network_getaddresses:
 
getaddrinfo failed: Name or service not known in /var/www/vhosts/ example.com/httpdocs/xcart/include/func/func.http.php on line 85''
 
</pre>
 
 
The reason for the issue is the incorrect  USPS server name in the Admin back end on the '''Administration -> General settings -> Shipping options''' page
 
 
The possible server name:
 
 
* '''production.shippingapis.com'''
 
 
There should not be any  '''http://''' or ''' /ShippingAPI.dll''' in the server names
 
  
 
== See also ==
 
== See also ==
  
 
* [[X-Cart:Setting_Up_Dimensional_Shipping|Setting up Dimensional Shipping]]
 
* [[X-Cart:Setting_Up_Dimensional_Shipping|Setting up Dimensional Shipping]]
 +
* [[X-Cart:Recorded Webinar - Automate Your USPS Shipping]]
  
 
[[Category:X-Cart user manual]]
 
[[Category:X-Cart user manual]]

Latest revision as of 12:54, 6 May 2015

Setting up USPS real-time shipping calculator

To set up shipping cost calculation through USPS real-time shipping calculator, follow these steps:

1. If you haven't yet done so, provide your own company address in the 'General settings->Company options' 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 with USPS (sign up at https://secure.shippingapis.com/registration/). You will receive an email with your username, password and the test server name. Reply to the email you received and tell them that you would like to be moved to the production server because you are using X-Cart and that it doesn't work with the test server. You may get a response asking which API you are using. Tell them you are using the Rates Calculator. You will receive another email with the production server name, which is also not completely correct, so don't enter that in X-Cart either.

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

a. In your store's Admin area, go to the 'General settings->Shipping options' section.
b. On the 'General settings->Shipping options' page, select the check box 'Enable real-time shipping calculation'. Unselect the check box 'Use Intershipper calculation service'.
c. Use the 'U.S.P.S account details' subsection of 'General settings->Shipping options' page to provide the required information.
  • Web Tools User ID: the name you were sent in the email
d. Click Save.

4. Adjust USPS options:

a. Go to the 'Shipping methods' section of your store's Admin area (Settings menu->Shipping methods).
b. Find USPS in the list of real-time shipping methods and click the Options >> link opposite it. A dialog box with USPS options opens.
Usps.png
c. Adjust the options according to your preferences.
d. Click the Apply button.
Notes:
1. Since USPS bases their rates on weight, make sure you have a weight assigned to all of your products. It defaults to lbs, so if you are using ounces be sure to change the conversion in General Settings.
2. (National shipping) Max. weight for Letter/Postcard first Class Mail Types is 3.5 oz. (0.21875 lbs). See https://www.usps.com/business/web-tools-apis/rate-calculator-api.htm#OLE_LINK5

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.

Using the "USPS filter out Flat Rate options" feature (X-Cart 4.6.6 and later)

To use the "USPS filter out Flat Rate options" feature you need to unselect all the services on the USPS settings page and make sure that your products have all the dimensions specified.

To control the number of items in one package, use one of the following methods:

OR

  • Specify the desired USPS containers:
    Xc4 usps containers.png

For each container X-Cart sends a separate request to USPS, so if you do not need some container types, make sure that the values for them are set as RECTANGULAR/NONRECTANGULAR.

Recorded Webinar - Automate Your USPS Shipping

Need to speed up your order fulfillment and lower your shipping costs? Eric Nash of Stamps.com shows how simple and easy the X-Cart integration is to set up inside Stamps.com. All of your orders can be automatically imported where you can easily print USPS shipping labels for domestic and international addresses. The webinar discusses all the shipping features provided including access to discounted USPS shipping rates, hidden postage, return shipping labels, shipment notification emails and more. Plus, you will learn some great tips to help lower your shipping costs.

Download the integration module or read more here: https://marketplace.x-cart.com/addons-modules/store-management/shipping/Stampscom-Print-USPS-Postage



Troubleshooting

API Authorization failure. DeliveryConfirmationV3 is not a valid API name for this protocol

The following error message is received when trying to generate the USPS shipping labels :

USPS server returned the following errors during the transaction:
ExpressMail #1: API Authorization failure. ExpressMailLabel is not a valid API name for this protocol.
ExpressMail #2: API Authorization failure. ExpressMailLabel is not a valid API name for this protocol.
DeliveryConfirmation #1: API Authorization failure. DeliveryConfirmationV3 is not a valid API name for this protocol.
DeliveryConfirmation #2: API Authorization failure. DeliveryConfirmationV3 is not a valid API name for this protocol.

This means that the USPS account sholud be in live mode and the DeliveryConfirmationV3 API must be enabled. This can be done on the USPS side,so please contact the USPS support.

This error may also appear if the shipping labels are generated in test mode (there is such an option in X-Cart), you should try to get them for real orders.

USPS error: Failure to get USPS rates in X-Cart stores.

On January 2, 2011, USPS updated their domestic shipping services and international pricing. Those changes have affected all versions of X-Cart (4.1.x/4.2.x/4.3.x, 4.4.0-4.4.1) and caused a trouble of not getting any USPS rates in live X-Cart stores.

We have released official hot-fixes for the problem, which can be found in our Issue tracker system:

The hot-fix is already included into a stock 4.4.2 version.

Apart from installing the hot-fixes mentioned above, you should also install another update - USPS API update patch - in order to update your store to support RateV4 and IntlRateV2 USPS APIs.

The older USPS APIs implemented in earlier X-Cart versions (4.1.x/4.2.x/4.3.x, 4.4.0-4.4.2) will be retired soon.

The corresponding USPS API update patches for 4.1.x/4.2.x/4.3.x, 4.4.0-4.4.2 versions can be found in our Issue tracker system:

The USPS API update patches (RateV4 and IntlRateV2) for version 4.0.19 can be found here:

Should you need any help in the updates installation in your X-Cart store - do not hesitate to request our support team for assistance via your personal Helpdesk area.

USPS error: Authorization failure. Perhaps username and/or password is incorrect.

When testing real-time shipping rates calculation in the X-Cart admin back-end (http://www.yoursite.com/xcart/admin/test_realtime_shipping.php), the USPS server returns the following error:

<Error>
<Number>80040b1a</Number>
<Description>Authorization failure. Perhaps username and/or password is incorrect.</Description>
<Source>UspsCom::DoAuth</Source>
</Error>

To fix this error please double check the info entered in the 'U.S.P.S account details' subsection of 'General settings->Shipping options' page, re-enter the valid info if necessary. As soon as this is done, please re-test the real-time shipping rates calculation.

USPS error: Authorization failure. You are not authorized to connect to this server.

When testing real-time shipping rates calculation in the X-Cart admin back-end: [1]

the USPS server returns the following error:

<Error>
<Number>80040b1a</Number>
<Description>Authorization failure. You are not authorized to connect to this server.</Description>
<Source>UspsCom::DoAuth</Source>
</Error>

To fix this error please get in touch with the Internet Customer Care Center (USPS) and ask them to enable your profile in order to allow you access the Production Server. As soon as this is done, please re-test the real-time shipping rates calculation.

See also