ApiShip - over 35 courier delivery services for the E-commerce market

The module builds interaction with ApiShip - an integration service for e-commerce, providing fast connection of more than 35 transport companies in one place. There is no need to install additional functionality and thereby load the system. Everything in one module.

The functionality fully integrates all important processes of interaction with a transport company:

  • Calculates the cost to the buyer;
  • In the absence of product dimensions, sets the default parameters for calculating the cost of the product;
  • Forms shipping and transport documents for transferring cargo to the carrier;
  • Tracks the movement of the link to the admin. shop panels;
  • Automatically changes order statuses via CRON.

When the goods are at the pickup point and are ready for delivery, the buyer will receive a notification.

From the moment the order is placed to its delivery, everything is automated as much as possible.

If there are delays or malfunctions on the part of the transport company, the order will still be placed when the service starts responding. No cancellation will take place.

In the case when the store works with third-party suppliers, from whose warehouse it is necessary to arrange delivery, then two work scenarios are possible:

1. Sending documents for the formation of the shipment and the arrival of the courier at the seller's warehouse. The cargo will be packed, handed over to the carrier and sent on behalf of the marketplace.

2. The transport company of the supplier itself is connected. The supplier, for his part, sees all the shipments, downloads the documents, forms boxes and hands them over to the carrier. Thus, the registration takes place on the supplier's side.

The functionality allows you to add an unlimited number of contracts with transport companies. For example, for the transportation of jewelry or foodstuffs, special conditions are needed - not all carriers can provide them and therefore refuse to transport them. In this case, it is quite reasonable that the supplier has a separate transport company to transport a certain group of goods.

For each showcase of the online store, you can add your own contract with the transport company.


FOR MARKETPLACE:

The marketplace can form delivery methods not only on its own behalf, but also on behalf of the vendor. For each vendor, you can configure up to 30 transport companies, which will be formed under his contract. Thus, one module covers 100% of the store's needs.

Vendors can print shipping and shipping documents on their own, saving time on registration. At the same time, the vendor may also have a separate transport company that is not directly related to the marketplace.

For example, there is a marketplace that has a shipping company set up. The vendor enters the orders, confirms the availability of the goods, downloads the documents, prepares the cargo for shipment, transfers it to the carrier. All costs are covered by the marketplace.

Or, when the transport company is configured separately for the vendor. In this case, the marketplace transfers the funds to the seller's account, the seller receives payment, packs the cargo and hands it over to the carrier.

The status change occurs automatically, so there is no need to track the progress of the process.


AVAILABLE DELIVERY SERVICES

- Boxberry
- PickPoint
- Accordpost
- СДЭК
- КСЕ
- Dostavista
- E-KIT
- Hermes Russia
- MaxiPost
- Ozon logistics
- СБЕРЛОГИСТИКА
- SmartSend
- 5post
- Dalli-Service
- TOPDELIVERY
- AZ.Express
- чекбокс
- Dostavka-Club
- dpd
- ПЭК Easyway
- IML
- Neppost
- PONY EXPRESS
- Shop logistic
- Viehali
- Яндекс GO
- k-mestu
- Почта России
- B2CPL
- CityExpress
- Деловые Линии
- DRH logistic
- Gett
- Logsis
- ON-Time
- РУ.ДОСТАВКА
- SmartDostavka
- VOZOVOZ
- ЗАББЕРИ.РУ (СВЯЗНОЙ/Евросеть)






SCOPE OF APPLICATION

Suitable for stores and marketplaces cooperating with the ApiShip service.


EXAMPLE OF APPLICATION

When placing an order, the buyer chooses the delivery method with the calculated ApiShip tariff and then one of the most convenient options for him: courier delivery, self-pickup, Russian post, etc.


SPECIFICATIONS
  • Synchronizes the work of the marketplace with the ApiShip Personal Account;
  • Adds the ability to create a delivery method by adding ApiShip tariff calculation;
  • Sets the default units and parameters of the cargo;
  • Adds the ability to use a test Api;
  • Powered by CRON.


COMMUNICATION WITH OTHER MODULES

For correct operation, install the modules "Cities" and "Seller privileges" for CS-Cart.



CONFIGURING THE MODULE

1. After installing the module, go to the "Modules" tab, in the drop-down menu select the "Modules Management" and "MAURISWEB" items.




2. In the list that opens, select the module you are interested in and click on its name highlighted in blue or black.

 



3. Go to the "General" tab. If the license key is not set automatically and the module settings will be blocked, go to your account at www.maurisweb.ru, copy the license key and paste it into the appropriate item. The key has also been sent to your email.




4. Go down below, select the "Basic settings" section and tick the box "Save data when removing the module" so as not to lose them when reinstalling the module.



5. Go to the "Authorization" tab. Enter your username, password and API token to enter your ApiShip Personal Account. This is necessary to synchronize the marketplace with the service.




These data are contained in the "Dashboard" section of the ApiShip Personal Account.



6. Go to the "Settings" tab. Check the box if you will be using the test API. If you are using a test version of the Personal Account of any transport company, then check the box, if the version is combat, then do not.



7.  Expand the additional menu under "Length units in your system" and select one of the suggested values: "mm", "cm", "m".




8. Specify the default payment method for the courier in cash. To do this, in the "Cash on delivery payment methods" section, select one of the proposed methods. For example: "Bank card", "Issue an invoice", "Discuss by phone", etc. (depending on the payment methods you already have). To select more than one entry, left-click on the entry while holding down the CTRL key. To deselect the selection, left-click on this entry again while holding down the CTRL key.

Please note that different shipping companies may have different payment requirements. Only the data that will be specified by default is set in the settings!



9. Specify the default payment method for the courier by cards. To do this, in the "Cash on delivery card payment methods" section, select one of the proposed methods.



10. As a rule, the transport company includes insurance and cash on delivery in its services. To summarize the total cost of all delivery service fees in the check, tick the appropriate box.




11. Specify in numbers the time to wait for a response from the provider. If this period is exceeded, the request will be rejected.




12. Go to the "Orders" tab. Include a prefix to the order number and a separator for the order number. Orders with this prefix will be created in the Personal Accounts of the delivery services.




13. To send goods on behalf of the marketplace, check the corresponding box.




14. Check the statuses for which you want to make a change request for ApiShip. In this case, the final status does not need synchronization.

For example, while the order is being processed, its status will be "Open" and the carrier does not need information about this. But the status "On hold" means that the process is frozen pending confirmation (payment or availability of goods) and will not be transferred to the carrier until its completion. The status "Completed" means the completion of the transportation, the buyer has received the order and will not need to make a new request to change the status.

  



15. Go to the "Profile fields" tab and specify from which profile fields information will be imported for the "Phone", "First name", "Last name", "Seller brand" fields. These fields are required for transport companies.




16. Go to the "CRON" tab. Write commands to the CRON scheduler. Note that the CRON job is configured on the server. The stability of the store will depend on the correct setting.

The address for CRON settings (for example: php / var / www / mwdevelopers / data / www / popov-mv.mwdevelopers.ru / admin.php - p --dispatch = maurisweb_apiship.send_orders.create) may differ from the control panel or other settings server. Contact your server administrator to configure the job.




17. Go to the "Logging" tab and select the type of logging: "Not selected", "File system", "Database".




18. Save the module settings by clicking on the blue "Save" button at the top right of the screen.





PRIVILEGE


1. To set up privileges for a user group, go to the "Customers" tab and select the "User Groups" section.




2. Select the required user group and click on its name highlighted in blue.

Do not forget that in order to correctly configure the privileges of groups with the "Seller" type, the "Privileges for sellers" module must be installed and enabled.




3. Go to the "MW: ApiShip" section and specify the access level for the "Transport companies" and "Settings" items: "Full access", "View only", "No access".

The item "Transport companies" gives access to view and create TCs, as well as carry out their approval (only for administrators).

The "Settings" item allows you to change the statuses of orders.




4. Save your changes by clicking on the blue "Save" button in the lower right corner of the window.





FUNCTIONALITY OF THE MODULE

APISHIP SYNCHRONIZATION SETTINGS


To synchronize ApiShip Personal Account data with the platform, go to the "Modules" tab, the "ApiShip" section and select "Settings".



For the initial setup of synchronization, be sure to observe the following order:


1. DELIVERY SERVICES


1. First of all, synchronize data on delivery services with your ApiShip Personal Account.



2. To do this, first click on the white button "Synchronize delivery services",



3. then "Synchronize tariffs".



4. The list of delivery services will be filled in automatically. If this does not happen, then check the module settings (see the "MODULE SETTINGS" section). It is possible that the authorization data is entered incorrectly (item 5) or the test mode is used incorrectly (item 6).



2. TRANSPORTATION COMPANIES


1. Information about carriers is contained in the "Transport companies" tab.




2. It is synchronized with the "Delivery Services" tab in the ApiShip Personal Account. The "Connected" section contains those transport companies that can already be used. The rest are located in the "Available for connection" section.




3. First click on the "Synchronize" button.




4. The connected transport companies will be displayed in the tab.




3. TYPE OF RECEPTION. DELIVERY TYPE.

1. Every time, after adding a new shopping mall not through synchronization (for example, added by the seller), you need to synchronize the types of reception and types of delivery.

To do this, go to the "Receive types" tab and click on the "Synchronize" button.



2. Then go to the "Delivery Type" tab and click on the "Synchronize" button.


4. STATUS

1. For correct synchronization of the store and transport companies, you need to correlate the statuses. To do this, go to the "Statuses" tab and click on the "Synchronize" button (especially after a new TC has been added).



2. The statuses of the transport companies will be listed in the left column.



3. On the right - store statuses.



4. Expand the additional menu and select the store status, which will be correlated with a specific status for transport companies.

For example, the status of the store "Failure" can be correlated to the status of transport companies "There was a problem". Now, when updating the order status by CRON in case of a problem, the order status will change to "Failed".

You may not be able to match all statuses, but it is recommended to do this for the maximum number so that no problems arise in the process.


5. After completing the matching of statuses, click on the blue "Save" button.





ADDING A NEW TRANSPORT COMPANY BY THE SELLER


The seller can independently add a new transport company (TC) if he has privileges for this. Also, the seller must have a correct address.




1. To add a new TC, in the seller's panel, go to the "Modules" tab, the "ApiShip" section and select "Settings".




2. Click the green "Add New" button.




3. Enter the name of the shipping company you are adding.




4. Expand the additional menu in the "Delivery service" item and select the required company.




5. To fill in the data for creating a new shopping mall, you need to enter your ApiShip Personal Account and select the required delivery service in the "Connected" section.




6. Inside there will be all the information to fill in the data on the new TC.



7. When all the data is filled in, click on the green "Save" button in the lower right corner of the window.




8. After that, the added TC will appear in the tab and will be marked in red until it is verified by the administrator.





VERIFICATION OF THE NEW TRANSPORT COMPANY BY THE ADMINISTRATOR


1.  After the seller has added a new shopping mall, it must be verified by the administrator in order to use its services for the store.

To do this, in the admin panel, go to the "Administration" tab, the "Shipping and taxes" section and select "Transport companies".




2. Select the TC highlighted in red.




3. Set the status: "On" (enabled) or "Off" (turned off). And add the ID to ApiShip.




4. ID is located in the name of the shopping mall in the Personal Account of ApiShip (see clause 6 of the section "ADD A NEW TRANSPORTATION COMPANY AS A SELLER")



5. After checking all the data of the new TC, click on the blue "Save" button in the lower right corner of the panel.




6. The red selection will disappear from the checked TC and now it can be used.




CREATION OF A DELIVERY METHOD


1. To showcase the ability to select the services of a specific transport company, you need to create a delivery method.

To do this, go to the "Administration" tab, the "Shipping and taxes" section and select "Delivery methods".




2. To create a new delivery method, click on the plus-shaped button on the right side of the panel.




3. Enter the title.



4. Expand the additional menu in the "Tariff calculation" item and select "ApiShip".



5. Click on the blue "Create" button in the upper right corner of the panel.




6. Go to the "Customize" tab. Check the box if the delivery is paid by the recipient. If the delivery service does not support payment by the recipient, then there will be problems with the transfer of the order to the shopping mall,



7. In the "Transport company", select the delivery service.

Please note that the items marked with a red asterisk are required!





8. In the "Tariff" item, select the desired tariff. Please note that if you want to add different tariffs from the carrier, then you need to create a delivery method for each of them. One shipping method = one tariff.




9. If the tariff assumes the presence of a pickup point, then you must enter the city of reception.




10. Click on the "Select a collection point" button.



11. The pickup catalog will appear. Click on the arrow and select a pickup point by double clicking on it.




12. The selected pickup point will appear on the page.




13. Fill in the parameters for the weight, length, width and height of the load.




14. Save your changes by clicking on the blue "Save" button in the upper right corner of the panel.




15. In case you need to add a delivery method to all sellers, click on the blue gear button, select "Allow delivery for all sellers". A shipping method will be added for all sellers in the store.





ORDERING


1. Go to the storefront by clicking on the button in the form of a grocery basket.




2. Make a purchase.




3. Created delivery methods will be displayed on the checkout page.




4. If you select a tariff that implies the presence of a pickup point, a map and a list of pick-up points will open.




5. You can use the side menu to select a pickup point.




6. Or select a pickup point on the map. If points with numbers appear on the map, it means there are no pickup points in this area. Click on the round with a number.




7. The map zooms in to show the pickup point in the desired region. Click on one of them to select.




8. A window with data on the pickup point will open: full address, phone number, working hours and landmarks. Click on the red "Select" button to complete the selection of the pickup point.




9. Complete the checkout process.




CHANGE OF ORDER AFTER REGISTRATION


1. After the order is placed, its further editing takes place in the admin panel. To do this, go to the "Orders" tab and select "All orders".




2. Select an order and click on its name highlighted in blue.




3. The delivery method in the order will indicate exactly the one chosen by the buyer.




4. To change the status of the order, click on it, open the additional menu and select the one that you want to install.




5. To send the selected order to the shopping mall, select it, click on the "Actions" button, and then go to "Send selected to T. K." and one of the options: "New only", "Update existing" or "Create new, update existing".




6. The message "Sent to T.K." will appear under the order status.




7. To download the labels, select the "Download address labels and acts" and "Download address labels" function. After formation, the PDF document will be loaded into memory.




8. To receive the closing documents, select the function "Execute an action in ApiShip for the selected orders" and "Download acceptance certificates". The archive with documents will be loaded into memory.





COMMON PROBLEMS AND THEIR SOLUTION


1. Failure of the module may be caused by the fact that the product does not have a tax form specified.

1.1. To check the taxation form for a product, go to the "Products" tab and select "Products".




1.2. Click on the name highlighted in blue or black.




1.3. In the main tab, in the "Pricing / Warehouse" section, in the "Taxes" section, the taxation form will be indicated.




For convenience and so that there is no need to constantly check the seller's tax forms, you can use the MAURISWEB "Tax Form" module.


2. There may also be problems when the shipping method is not displayed on the storefront. In this case, empty the trash and cache.

2.1. To empty the cart, go to the "Orders" tab and select "Incomplete purchases".




2.2. Then select all the lines and select the "Delete Selected" action.




2.3. To clear the cache, go to the "Administration" tab, then "Data storage" and "Clear cache".




It is recommended to clear the cache after adding each new TC.


Following pages