SamedayCourier Shipping Plugin

Overview

This plug-in is intended to implement a new shipping method using the Sameday Courier service. As a store owner, after installing the plugin, you are able to import the list of Sameday Courier
service and delivery points assigned to your account. If your customer chooses the order to be delivered with Sameday Courier, you will be able to see this in the list of commands in your store’s
administration panel. You will also be able to create an AWB. You can then add a new parcel in the created AWB and show the AWB as a pdf format. If you want, you can show the AWB history or delete the AWB.

For further information, contact us at software[at]sameday.ro !

Features

• Config Sameday Courier shipping method
• Import Sameday Courier pickup-points
• Import Sameday Courier services
• Import Sameday Courier lockers
• Show AWB as PDF format
• Add new parcel in AWB
• Show AWB status and summary

Configuration

Initial configuration for the plugin

In order to set up the plugin, you need to provide the following information (please refer to screenshot 1 – Initial configuration for the plugin):

• Go to plugin’s Settings
• Title = The title that it will be displayed on your website
• Username = Username provided by Sameday as result of enrolling to our services
• Password = Password provided by Sameday as result of enrolling to our services
• Default label format = The format of paper (e.g. A4) for creating the awbs

• Is testing = If checked, the plugin will be set in development mode. This feature is intended to test services. Should not be checked on production environment

  NOTE: Each environment (eg. test/production) has a different set of credentials. Be sure to use the set of credentials corresponding to selected environment

• Use estimated cost = The cost that it will be displayed for each of the services. Options: never (fixed price – refer to Edit Service form), always (estimated by Sameday). For extra information regard to these options, please refer to the screenshot 1

• Extra fee = Extra fee, defined in percentage value, which will be applied on top of the estimated cost provided by Sameday
• Open package status = Allow the clients to open the package in the moment of delivery in order to check the conformity of the delivered product(s)
• Open package label = This text will be displayed on the checkout page in order to ask them if they would like to open the package on delivery. Please refer to the previous option (Open package status)
• Locker max. items = The maximum amount of items accepted inside the locker

Update services, pickup-points & lockers

To use the plugin, you need to get the available services (see screenshot 2 for details).

• In the settings page, click on the button Services
• Click on the button Refresh services

Now the list of services should be populated.

NOTE: The same procedure should be applied for pickup-points and lockers.

Enabling services

By default, all the services fetched using the previous indications are disabled. Thus, you need to enable those that you want to provide to your clients (please refer to screenshot 3).

• From the services page click on the service name to start editing
• Service name = The name that it will be displayed to your clients on the checkout page (see screenshot 5 for more details)
• Price = Fixed price for this service. This is the delivery price that the clients will pay if they choose this delivery service
• Free delivery price = The minimum order price for which the delivery is free of charge. This is a numeric value bigger than 0

NOTE: If you don’t want to apply a free of charge option leave this field blank

• Status = Enable or disable the service. If enabled, the clients will be able to choose this delivery service

Add shipping method to shipping zone

By default, Sameday operates only in Romania. If you would like to deliver your packages within this shipping zone:

• Go to WooCommerce Shipping zones
• Zone Regions= Choose Romania or counties from Romania
• Click on the button Add shipping method, choose SamedayCourier and save

For more details, please refer to screenshot 4.

Creating an AWB

The AWB is the transport document, created by Sameday, in order to process your transport order.

• Go to the order page
• Click on the button Generate AWB
• In the modal, which originally is pre-completed, you can customize the shipping details (please refer to screenshot 6 for more details)
• Repayment = The amount that the courier should take from the client in the moment of delivery (e.g. If the order is already paid, the repayment will be 0)
• Insured value = The amount that should be insured for the given AWB
• Package weight = The package weight
• Package length = The package length (optional)
• Package height = The package height (optional)
• Package width = The package width (optional)
• Pickup-point = The location from which the package will be taken
• Package type = The type of the package predefined by Sameday
• AWB Payment = Determine who will pay for delivering this package. By default, the site owner
• Service = A list of enabled services (refer to the Enable services section)
• Observation = Any text that will be displayed on observation field in AWB
• Client Reference = Set a unique reference for each AWB. This field can be associated with the id of the order.

A parcel it’s a package of the types predefined by Sameday (Envelope, Parcel, Large Parcel).
Any AWB can have one or more parcels (default one).

After generating the AWB, the admin can add one or more parcels to the same AWB (please refer to screenshot 7).

Requirements

• WordPress v6.0 or later
• WooCommerce v6.1 or later

Plugin installation procedure

• Open your WordPress admin dashboard and go to Plugins/Installed Plugins menu
• Press Add new button and then press Upload Plugin.
• Drag & drop the .zip folder you downloaded and install plugin.

If every thing works, activate plugin and now the new feature are ready to use.

Setup your Plugin

1. Go to WooCommerce/Settings and choose SamedayCourier tab.
2. Complete the form and press Save changes. If everything works well you receive a success message.
3. After that, you are able to import the Services and Pick-up point assigned by Sameday to your account. Go to Service and press “Refresh Service”. The same for pick-up points importing and (optional) for the locker list.
4. Activate the services by changing the status from “Disabled” to “Always” or “Interval”.
5. Add the new SamedayCourier shipping method to your Shipping zones. Go to WooCommerce/Settings menu, open the Shipping zones tab. Choose the shipping zone for which you want to use Sameday services and press “Edit” button then press “Add shipping method” and select “SamedayCourier”.

After you have followed all the steps described above, now in the checkout page of your store, your clients are able to see and choose one of the Sameday service.

In the Order page will be displayed a button “Generate awb”. After awb is generated you can show it as pdf format. Also, you can show the history of the awb, add a new parcel or simply remove the awb.

1. 

   Initial configuration for the plugin

2. 

   Update services

3. 

   Enabling services

4. 

   Add shipping method to shipping zone

5. 

   How clients will choose one of Sameday's shipping methods

6. 

   Creating an AWB

7. 

   Adding more parcels to the AWB

8. 

   Show AWB History

1.7.8

• Bug fix. lockerLastMile issue: LockerLastMile is invalid. (From previous version 1.7.7)
  caused by some inconsistency in the dataType for lockerLastMile.

1.7.6

• Code refactor. Rearrange the field for displaying the showing map button on the checkout page.

1.7.5

• Code refactor. Manage issue with undefined data for shipping address.

1.7.4

• Code refactor. Crossborder validation on shipping rates by country.
• Code refactor. Reinitialize lockerPlugins when user change address in Checkout.
• Bug fix. Deal with such type of exception: Uncaught TypeError: round(): Argument #1 ($num) must be of type int|float

1.7.3

• Code refactor for shipping methods validation.

1.7.2

• Update Cross-border validation for repayment.

1.7.1

• Bug fix. Improve Caught exceptions system for awb generation in order to deal with some new edge-cases from our API.

1.7.0

• Add new feature. Implement Cross-border services XB (For Home delivery Cross border) and XL for (Cross border Locker Services).

1.6.3

• Bug fix. Fix issue from v1.6.1 (!LockerLastMile is invalid).

1.6.2

• Add new feature. Automatic weight converter to kg for Sameday standard unit measure.

1.6.1

• Add new feature. For Locker NextDay Service update delivery address for home delivery with locker address.

1.6.0

• Add new feature. Add button to Import local all data of your Sameday account such as Services, Pickup point and Lockers.

1.5.14

• Update Sameday PHP-SDK library.

1.5.13

• Bug fix. Change name of methods in order to avoid conflicts.

1.5.12

• Bug fix. Fix the issue caused by conflict with Checkout Field Manager plugin.

1.5.11

• Fix $ sign notation conflict for using jQuery library.

1.5.10

• Calculate free price for delivery with or without coupons. Fix floating point issue.

1.5.9

• Calculate free price for delivery with or without coupons.

1.5.8

• Bug fix. Fix problem with ajaxComplete.

• Bug fix. Fix problem for virtual products.

1.5.7

• Bug fix. Deal with float values (replace casting to float for null values).

1.5.6

• Bug fix. Deal with float values.

1.5.5

• Add new feature. Grant permissions to shop_manager in order to generate awb.

1.5.4

• Add new feature. Open Sameday AWB PDF page as a new tab.

1.5.3

• Bug fix. Handle undefined settings options.

1.5.2

• Add new feature. Improve code security by protecting all internal forms with nonce var and validate actions only as administrator.
• Add samedaycourier-shipping text-domain for translations
• Resolve issue with custom fields in checkout page

1.5.1

• Bug fix. Fix Uncaught JsonException: Control character error JSON_THROW_ON_ERROR.

1.5.0

• Add new feature. Add personal delivery optional service.

1.4.4

• Bug fix. “repayment fee”, error “wc-ajax=add_to_cart:1”

1.4.3

• Add new feature. Add repayment fee. You are able to set an extra charge (Optional) to your customers for COD (cash on delivery) service.

1.4.2

• Bug fix. Fatal error: Uncaught JsonException: Syntax error

1.4.1

• Bug fix. Track lockers_sync_admin.js file

1.4.0

• Major release. Refactor code in some legacy part of plugin.
  Add new feature in order that admin be able to change selected LockerId in Generate AWB Form.
  Connecting plugin with eAWB Bulgarian instance.

1.3.2

• Bug fix. Solve edit service form error.

1.3.1

• Bug fix. Solve Fatal error: Uncaught JsonException: Syntax error.

1.3.0

• Major release. Refactor code in order to work with PHP 7.4 version.
  Integrate AddLockerDetails_admin branch in order to show in AWB form the details of selected locker for LN services.
  Rezolve fix init map.
  Do estimate cost only if city and address fields are complete in checkout page.

1.2.19

• Add new feature. Add username api for lockerPlugins init.

1.2.18

• Bug fix. Load locker_syncs.js lib only in checkout page.

1.2.17

• Bug fix. Load locker map only if select LN checkbox.

1.2.16

• BugFix frontend: Single digit Locker ids were not restored from cookie

1.2.15

• Load locker map only if select LN checkbox.

1.2.14

• Add new feature. Show details about selected locker in checkout page.

1.2.13

• Refresh Sameday Api token after each new auth with another set of user credentials
  (Be aware that when you switch from one user to another you will have to redo the import of services and pick-up points !).

1.2.12

• Add client ID and country for lockers map.

1.2.11

• Fixed select2 error. Check if element exist.

1.2.10

• Set lockers list as a select2 field.

1.2.9

• Bug fix. Validate if Host Country param is undefined.

1.2.8

• Bug fix

1.2.7

• Bug fix. SamedayCourierHelperClass::getHostCountry() must be of the type string.

1.2.6

• Add new feature. The client can choose if he wants to show SamedayCourier lockerPlugins map in checkout page.
  By Default the plugin shows lockers list as a drop-down field.

1.2.5

• Add new feature. Integrate ULRs in order to use SamedayCourier Hungarian API.

1.2.4

• Code improvement. Set AwbRecipientEntityObject with data of client instead of locker data.

1.2.3

• Bug fix. Set default value for is_testing option. Remove unnecessary variable “$intervals”.

1.2.1

• Add new feature. Integrate Sameday LockersPlugin library.

1.1.1

• Bug fix. SamedayCourierHelperClass::getApiUrl() must be of the type string.

1.1.0

• Code improvement. Remove is_testing options. The env. mode will be setup based on the set of credentials. Remove Sameday service interval.

1.0.30

• Code improvement. Store Sameday Token into database in order to avoid unnecessary calls to Sameday Auth Method.

1.0.29

• Bug fix. Avoid package_hash notice.

1.0.28

• Add new feature. Set maximum amount of items to fit in lockers.

1.0.27

• Bug fix. Include custom.js file only in checkout page instead of globally.

1.0.26

• Add new feature. Set a unique reference for each AWB. This field can be associated with the id of the order.

1.0.25

• Add new feature. Recalculate the estimated cost after payment method is changed.

1.0.24

• Bug fix. Show AWB History.

1.0.23

• Group locker list by city. This list will be shown in the checkout page.

1.0.22

• Before the locality parameter is sent to the cost estimation method, it is parsed to remove its diacritics.

1.0.21

• Update doc.

1.0.20

• Add new feature. A new option has been added for the “Use estimated cost” field.
  The admin can choose to display on the site the price of the transit cost calculated by Sameday, only if its value
  exceeds the value of the fixed cost assigned by the admin for each service (exp. Additional km situation).

1.0.19

• Add new feature. This option allows customers to use the package opening service when their parcels are delivered to them by the courier.
  Usage: In order to implement this new feature in your site, after update plugin you MUST refresh the Service list.

1.0.18

• Add an improvement. Skip decimal validation on Edit Service menu on “Price” field.

1.0.17

• Add new feature. Add hyperlink in admin zone that land you to Sameday eAWB platform.

1.0.16

• Update documentation.

1.0.15

• Add new feature. Add SamedayCourier shipping method in shipping zone.

1.0.14

• Bug fix. Show awb history. Catches an exception if no data has been found.

1.0.13

• Add new feature. Fill “Repayment” field in the “Generate awb” form with the value of total amount of order only if the payment method is set as “COD” otherwise leave value as 0.
  However, you are able to change this value as you want.

1.0.12

• Bug fix. Estimate cost method.

1.0.11

• Add new feature. Apply extra fee on expedition estimated cost. This feature is useful for those who wish to apply an additional charge to the transport cost over the transport cost calculated by Sameday for each individual shipment.
  Especially useful for those who have unpaid VAT companies.

1.0.10

• Bug fix. Error notification. Show an error message details if the awb generation was unsuccessful.

1.0.9

• Bug fix & code refactor.

1.0.8

• Bug fix. easyBox id must become required if client choose Locker NextDay service in checkout page before submit the order.

1.0.7

• Minor update. Show Company name on SamedayCourier Awb if the client fill “company” field with data.

1.0.6

• Bug fix. Change “Repayment” field validation.

1.0.5

• Bug fix & code refactor.

1.0.4

• Bug fix & code refactor.

1.0.3

• Code improvement. The administrator can change the delivery service before generating the awb regardless of the option chosen by the customer.

1.0.2

• Change Version iteration from 1.0.1 to 1.0.2

1.0.1

• SamedayCourier init version.