Product support

Get help in the plugin support forum.


ApiShip API integration for Shopaholic E-Commerce plugin / October CMS

Shipping method for Shopaholic that integrates ApiShip delivery API in checkout and backend management.

Plugin features

  • Pickup points select + map (Yandex.Maps)
  • Delivery city autocomplete
  • Calculating delivery price based on ApiShip configured providers
  • Checkout integration example for Shopaholic Bootstrap theme
  • ApiShip Shipping Method in Shopaholic Shipping types
  • Backend config for ApiShip integration
  • Backend delivery management in orders (dispatch send/update/delete)
  • Console commands for pickup points, shipping providers, tariffs, ApiShip statuses and orders delivery status synchronization

Required Plugins

  • Toolbox
  • Shopaholic
  • Orders for Shopaholic


© 2019, GABIX under Commercial License.


  • Register an account at ApiShip Platform to obtain API access using Login and Password
  • Configure needed shipping providers in ApiShip Management Panel and tariff rules if necessary
  • You can use test mode as noted in official documentation, but limited providers will be available for usage and no backend orders management
  • Fill the required params on plugin configuration page in backend, i.e. yoursite.com/backend/system/settings/update/gabix/apishipshopaholic/settings
  • Run (and also configure periodical execution via cron) the following artisan commands to obtain/update providers, tariffs, shipping statuses and pickup points:
  • php artisan shopaholic:apiship.providers
  • php artisan shopaholic:apiship.tariffs
  • php artisan shopaholic:apiship.statuses
  • php artisan shopaholic:apiship.points
  • Note that while using production mode ApiShip fetched data is limited to configured providers at ApiShip Management Panel
  • If you are using cargo self-delivery to shipping terminal, do not forget to specify corresponding points for each active provider in Sender Point-ins tab
  • Note that ApiShip system needs to get not only your company address info (Sender Address tab), and customer Full name, Email and Phone as well as Street, House and Flat (optional) for courier delivery, so corresponding Order fields under the self-titled tab are mandatory
  • You'll need to create only one universal Shipping type (yoursite.com/backend/lovata/ordersshopaholic/shippingtypes) with selected ApiShip API as API method
  • Setup cron artisan commands php artisan shopaholic:apiship.points (synchronize pickup points data) and php artisan shopaholic:apiship.orderstatus (update order delivery statuses)
  • Integrate delivery in frontend checkout, based on example for Shopaholic Bootstrap theme (see partials/themes/lovata-bootstrap-shopaholic in plugin directory for corresponding/edited files)

Experimental Plugin Events

  • You can use 'gabix.apishopaholic.cart.get.sender_city_guid' event for dynamically specifying City GUID in cart shipping price calculation, has to return GUID string
  • And 'gabix.apishopaholic.dispatch.get.sender' event (with Lovata\OrdersShopaholic\Models\Order $obOrder param) on dispatch creation in backend. For example:
Event::listen('gabix.apishopaholic.dispatch.get.sender', function( $obOrder ) {
    $arResult = [
        'city_guid' => '...',
        'postcode' => '...',
        'street' => '...',
        'house' => '...',
        'block' => '...',
        'flat' => '...',
        'company_name' => '...',
        'contact_name' => '...',
        'phone' => '...',
        'email' => '...'
    return $arResult;

Feel free to contact our support team if you have any questions regarding this integration.


Added `experimental` backend shipping price calculation

Mar 14, 2021


Fix ApiShipHelper method

Feb 24, 2021


Added offer dimensions calculation & config

Feb 08, 2021


Initialize plugin.

Dec 14, 2019