CS-Cart "eBay orders export" add-on

What eBay information do i need?

1.  Register eBay developer account, use the following link:

https://developer.ebay.com/base/membership/signin/

2.  Generate production keys, follow this link:

https://developer.ebay.com/DevZone/account/default.aspx 

3. Save your DevID, AppID, CertId to some file.

4. Go to 

https://developer.ebay.com/DevZone/account/appsettings/Tokens/ 

and choose:

• environment: Production
• key set: name of your generated key set (Key Set 1 as default)

then click "Generate Token" and enter your eBay account details.

5. Save your Token to some file.

Add-on settings

After the add-on installation in the Administration -> Add-ons, click "Edit" link opposite to the add-on name and complete the following fields:

DevID - enter your DevID which you got from eBay.

AppID - enter your AppID which you got from eBay.

CertID - enter your CertID which you got from eBay.

AppToken - enter your Token which you got from eBay.

Server - choose "Production".

eBay region - choose a country which is used as your region at eBay. According to this setting the list of available eBay shipping methods will be generated on a shipping editing page. 

Cron key (only latin letters and numbers allowed) - enter any letter and number combination, it's necessary for a security reason.

Export period (30 days - max) - all eBay orders that were either created or modified within this period (enter the number of days, i.e, 1) will be returned in your admin panel (after clicking "eBay update" button in Orders -> View orders).

Orders to export - choose what kind of eBay orders you would like to get exported. 

- All paid – all paid and marked as paid eBay orders will be exported to CS-Cart. It is a default functionality;

- Only marked as paid – only those orders that are marked by a eBay customer as paid will be exported to CS-Cart;

- Only marked as paid except PayPal - only those orders that are marked by a eBay customer as paid excluding orders paid via PayPal will be exported to CS-Cart. 

Exclude shipped orders - this setting allows to exclude the eBay orders that have a shipped status from exporting to CS-Cart. Choose "Yes" if you want to exclude shipped orders (default) or "No" if you want to receive orders that have a shipped status.

Order status - choose the order status for your eBay orders which will appear in CS-Cart admin (Processed, Completed or Custom). If "Custom" is chosen, orders will get a status which is specified in the Status letter field below.

Status letter (if order status "Custom" selected) - allows to assign any status to the order exported from eBay. In order to find the Status letter, it is necessary to go to Orders -> Order statuses -> Edit the necessary status (Add status first if you don't have it already created). Status letter is specified in the field "Status".

Where to specify the eBay product title in CS-Cart?

It is necessary to specify the eBay product title because only in this case an order will be exported successfully.

Please go to Products -> Products. Choose the product which you sell at eBay and click "Edit". On product editing page go to "Add-ons" tab . In the field "eBay title" type in the name of a product as it is stated at eBay. 

Don't forget to save changes.

An order exported from eBay will contain the name of the product used in CS-Cart.

Where to specify the eBay shipping method in CS-Cart?

It is necessary to specify the eBay shipping method because only in this case an order will be exported successfully.

Please go to Shipping and taxes -> Shipping methods. Choose a corresponding shipping method and click "Edit". In the eBay shipping method selectbox (General tab) choose a shipping method used at eBay.

An order exported from eBay will contain the name of the shipping method used in CS-Cart.

How can I start the eBay orders export?

1. Log into your CS-Cart admin panel and go to Orders -> View orders.

2. To start exporting orders from eBay click "eBay update" button in the top right corner.

Note! Export may take several seconds.

3. If there are orders from eBay for a period specified in the add-on settings (Export period), they will appear on the orders page with an eBay icon.

Can I set up a cron job for the automatic export?

In order to export eBay orders automatically, you can set up a cron job to trigger the script on your server.

Please contact your hosting provider to learn how to set up a cron job.

Use this url

http://ADDRESS_OF_YOUR_STORE/index.php?dispatch=ebay_orders.get&be6bc64c94bbc062=YOUR_CRON_KEY 

to run the script.

Additional information!

Please make sure your real time zone agrees with the time zone chosen in your admin panel. Log into your CS-Cart admin panel and go to Settings -> Appearance -> Common settings to check up your time zone.

Installation instruction

1. Download the archive with the Ebay orders export add-on.

2. Unpack the archive's content and upload files to your server in the root directory with the installed CS-Cart.

3. Open the following file with any text editor:

/skins/YOUR_SKIN/admin/views/orders/manage.tpl

4. Find the following line (line 99 approximately)

{if $smarty.capture.tools_items|strpos:"<li>"}  |
                      {include file="common_templates/tools.tpl" prefix=$o.order_id hide_actions=true tools_list=$smarty.capture.tools_items display="inline" link_text=$lang.more link_meta="lowercase"}
               {/if}

and on the next line put as follows:

 {hook name="orders:marks"}{/hook}

This hook adds an eBay icon next to the eBay order on the orders page.

3. Log into the administration panel of your store, go to the Administration -> Add-ons page.

4. In the list of add-ons find the Ebay orders export add-on and click Install opposite to its name.

5. Click Edit (CS-Cart 2) or settings (CS-Cart 3)  to edit the add-on settings (click the Documentation tab on this page for more details).