-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathreadme.txt
399 lines (295 loc) · 14.2 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
=== WooCommerce Pakettikauppa ===
Contributors: joosev, ottok, leotoikka, serter, k1sul1
Donate link: https://pakettikauppa.fi/
Tags: woocommerce, shipping, toimitustavat, smartship, pakettikauppa, posti, smartpost, prinetti, matkahuolto, schenker, seravo, gls
Requires at least: 5.0
Tested up to: 6.3.1
Requires PHP: 7.1
Stable tag: trunk
License: GPLv3 or later
License URI: https://www.gnu.org/licenses/gpl-3.0.html
This plugin enables WooCommerce orders to ship using pretty much any shipping method available in Finland via Pakettikauppa.
== Description ==
[Pakettikauppa](https://www.pakettikauppa.fi/) is a shipping service provider in Finland. This plugin integrates their service into WooCommerce. To start shipping, all your WooCommerce needs is this plugin and a API credentials of your account registered with Pakettikauppa.
> *Note!* If you already have shipping contracts with Posti, Matkahuolto, DB Schenker, Asendia or GLS with reduced prices, you can contact the customer support of Pakettikauppa to get those contracts via Pakettikauppa so you can use the WooCommerce Pakettikauppa plugin with your current shipping contracts. No need to use logistics services own integrations (e.g. Posti SmartShip / Prinetti )
This plugin requires at least WooCommerce version 4.7.0.
== Register and start shipping ==
Register through [www.pakettikauppa.fi](https://www.pakettikauppa.fi/). Process only takes few minutes.
== Features ==
* Integrates Pakettikauppa with WooCommerce
* Based on the official [Pakettikauppa API library](https://github.com/Pakettikauppa/api-library)
* Supports WooCommerce shipping zones and classes (though Pakettikauppa is currently only available in Finland)
* Customers can choose to ship products to an address or to any pickup point available from the Pakettikauppa shipping methods
* Store owners can add pickup points to any shipping zones shipping method
* Store owners can use whatever shipping pricing plugin
* Store owners can generate the shipping label in one click
* Store owners can generate shipping labels as mass action from orders view
* Store owners and customers get tracking code links and status information
* Support for Cash-On-Delivery
* Test mode available that uses the testing API without registration
== Installation ==
1. Install the plugin through the WordPress plugins screen directly or upload the plugin files to the `/wp-content/plugins/woo-pakettikauppa` directory.
1. Activate the plugin through the 'Plugins' screen in WordPress
1. Use the Settings->WooCommerce Pakettikauppa screen to configure the plugin
1. The plugin requires WooCommerce to be installed, with shipping zones configured and this plugin activated and settings set.
This plugin can also be installed directly from Github or using `composer require seravo/woo-pakettikauppa`.
== Developer notes ==
= Hooks =
* pakettikauppa_prepare_create_shipment
arguments: $order, $service_id, $additional_services
* pakettikauppa_post_create_shipment
arguments: $order
= Actions =
* pakettikauppa_create_shipments
Call for example:
$pdf = '';
$order_ids = array (15, 16, 17);
$args = array( $order_ids, &$pdf );
do_action_ref_array('pakettikauppa_create_shipments', $args);"
* pakettikauppa_fetch_shipping_labels
Call for example:
$tracking_codes=array();
$args = array( $order_id, &$tracking_code );
do_action_ref_array('pakettikauppa_fetch_tracking_codes', $args);
* pakettikauppa_fetch_tracking_codes
Call for example:
$args = array( $order_id, $order_id2, ... );
do_action('pakettikauppa_create_shipments', $args);
== Frequently Asked Questions ==
= Is this ready for production use? =
Yes! If you encounter any issues related to this plugin, please report at https://github.com/Seravo/woo-pakettikauppa/issues or to asiakaspalvelu@pakettikauppa.fi
= Can Shipping method names be translated? =
You can use plugin (f.ex. Polylang) to translate shipping method names.
== Screenshots ==
1. Checkout in twentynineteen theme
2. Order confirmation in twentynineteen theme
3. Order screen in admin
4. Setup wizard
== Changelog ==
= 3.9.4 =
* New feature: allow ignoring product weights
* New feature: HPOS support
* Various small fixes
= 3.9.3 =
* Fix missing variable preventing list type of pickup points showing at checkout
* Fix PHP 8.2 related fixes
= 3.9.2 =
* WP and Woo compatibility update
* Update to latest API library
* Various small fixes
= 3.9.1 =
* WP compatibility update
* Bug fix: Attach tracking info to email
= 3.9.0 =
* New feature: Support for order pickups
* New feature: Pickup point filtering
* New feature: Email info as template
* New feature: Custom bulk create order
* New feature: Option to create return labels automatically
* Bug fix: Weight and volume information to shipping labels if variable product
= 3.8.0 =
* Support for shortcodes
* Support for variable products SKU on shipping labels
= 3.7.2 =
* Fix small pickup point search bug
= 3.7.1 =
* Fix for pickup point searches
* Fix for pakettikauppa_fetch_tracking_codes -action
* Various small fixes
= 3.7.0 =
* New feature: Support for different label sizes
* New feature: Shipping phone number optional / mandatory settings
* New feature: Show estimated price of the shipment in the admin view
* New feature: LV translations
* Refactoring: Arranging settings regrading checkout settings
= 3.6.2 =
* Bug fix: load product class when not in admin view
= 3.6.1 =
* Bug fix
= 3.6.0 =
* New feature: LQ-shipments
* New feature: If shipping postcode is missing, use billing address
* New feature: LT translation
* Tested against woocommerce 4.6.1 and wordpress 5.9.2
* Various bug fixes
= 3.5.2 =
* Diagnostic tool bug fix when using Posti Shipping version
* Add error message if mass action operation fails
* Update automated tests and PHP 8.x tests
* Convert API secret as password field for added security
* Update Pakettikauppa API library to latest version
= 3.5.1 =
* Bug fix
= 3.5.0 =
* Customer facing templates (checkout & view order) can now be replaced in own theme dir
* Minumum woocommerce version is now 4.7.0 and tested against woocommerce 6.1.0
= 3.4.1 =
* Bug fix related to token caching
= 3.4.0 =
* New feature: Updated diagnostic tool to check versions and cached tokens
* New feature: Additional info to shipping labels in custom shipment
* New feature: Instuction if no configured shipping method
* Fine tuning: Wizard fixes in settings
* Fine tuning: Double check that cached token is really expired after TTL
* Bug fix: Automated test fixes
* Bug fix: Refactoring, small bug fixes
= 3.3.0 =
* New feature: Diagnostic tool to check everything is working correctly
* New feature: If using only one provider in pickup point searches, don't show the provider name
* Bug fix: Allow saving if more than 16 shipping methods
* Bug fix: Various small bug fixes
= 3.2.3 =
* Minor bugfix for token authentication
= 3.2.2 =
* Minor bugfix
= 3.2.1 =
* Fix timing issue preventing working from most installations
= 3.2.0 =
* Add support for additional info to shipping labels
* Various bug fixes
= 3.1.2 =
* Backwards compatibility for bulk actions
= 3.1.1 =
* If product does not exists, display "unknown product"
= 3.1.0 =
* Create multiple shipping labels from order view
* Allow editing of order phone number and email address
* Make pickup point search optional
* Various bug fixes
= 3.0.1 =
* Fix bug in pickup point saving in checkout
= 3.0.0 =
* Remove Pakettikauppa shipping method option
* Add possibility to choose pickup point in order view
* Fix bug for pickup point not saving in checkout
= 2.4.0 =
* New pickup point chooser for checkout
* Fixing pickup point related bugs
= 2.3.3 =
* Some plugins brake because of forced validation of chosen pickup points. This update loosens the validation little bit
= 2.3.2 =
* Fix to validation that checks if pickup point is chosen
* Add checks that billing email and/or phone exists before adding those to shipping
= 2.3.1 =
* Fix to help to fill orders from previous versions when using pickup points as shipping method
= 2.3.0 =
* Many small changes: f.ex. adding new fields to checkout and to sender configuration
* Fixes compatibility with Klarna
* Fixes return shipments
= 2.2.0 =
* Properly catch exceptions so faulty orders don't cause a fatal error
* Allow supplying a different address for pickup point search
* Fix headers so files download properly
= 2.1.2 =
* Fixed a bug breaking the setup wizard
= 2.1.1 =
* Fixed a bug breaking shipping methods created the old way.
= 2.1.0 =
* Plugin refactored to better support future development. No visible functional changes.
= 2.0.22 =
* New feature: Setup wizard
* Enhancements: Round weight and volume to more precise number
* Enhancements: Refactoring code
= 2.0.21 =
* Version skipped
= 2.0.20 =
* New feature: Change order status after shipping label is printed
* Enhancements: When choosing pickup point in checkout, do ajax call to save that pickup point to session as a backup.
= 2.0.19 =
* New feature: Create multiple return shipments from order view
* New feature: Option for automatic creation of shipping labels when order is complete
* Tested against woocommerce 3.7.0
* Enhancements: Show "Pakettikauppa shipping method" settings option
* Enhancements: Changing texts on settings page to make it easier to understand
* Enhancements: Make note to Pakettikauppa shipping method that it is not required to be used. Shipping methods already available to woo can do more than our own shipping method. Our own shipping method might be removed in the future as obsolete.
* Enhancements: Small refactoring of admin metabox
* Bug fixes: add more data validation
= 2.0.18.1 =
* Bug fix: bulk and quick actions now work
= 2.0.18 =
* Bug fix: Fix for MPS (Multi Parcel Shipment) creation
= 2.0.17 =
* New feature: Possibility to send shipping labels to custom URL on creation to help automations
* New feature: You can define if shipping label is to be displayed on a browser or downloaded
* New feature: add new hooks: pakettikauppa_prepare_create_shipment and pakettikauppa_post_create_shipment.
* Bug fixes: Pickup point search now uses shipping method codes instead of shipping provider names
= 2.0.16 =
* New feature: Allow creation of COD shipments from custom shipment creation
* New feature: Allow using all shipping methods and automatically display it's pickup points if available
* Enhancements: refactored COD functionality
* Enhancements: enhancements to automatic testing
* Bug fixes: misc fixes to translations, checking variables, etc
= 2.0.15.1 =
* Bug fixes
= 2.0.15 =
* New feature: Alternative show pickup points as radio button list
* New feature: New UI for creating custom shipping label
* New feature: Enable multi parcel shipments
* Enhancements: Added more data validation to admin functions, COD settings to own section in settings, admin CSS fix
= 2.0.14 =
* New feature: show label code (Helpostikoodi / aktivointikoodi) if it's present
* Enhancements: Actions from order view are now handled as Ajax -requests
* Enhancements: Added more data validation to admin functions
* Bug fix: compatibility issue with action scheduler is now fixed
* Fix: Mysql support for automatic Travis tests
= 2.0.13 =
* New feature: Add selected pickup point information to the confirmation email
* Enhancements: Added more data validation to admin functions
= 2.0.12 =
* New feature: Add HS tariff number and country of origin to products shipping options
* New feature: Send contents of the order with the shipment creation method
* Enhancements: redo functions using deprecated get_product_from_item function
= 2.0.11 =
* Enhancement: Orders action will open the PDF in the new window/tab
= 2.0.10 =
* New feature: Define shipping method for non-Pakettikauppa shipments
* New feature: Define additional services for non-Pakettikauppa shipments
* Enhancement: Don't create shipping label from orders page for local pickups
* Fixes: Don't display error in the logs, if provided shipping method in the checkout page does not have instance_id
* New feature: Implement hooks to be able to implement Pakettikauppa features in another plugins
* Bug fix: Validate pickup point selection in non-Pakettikauppa shipping methods
= 2.0.9 =
* New feature: support for free shipping coupon code
* Bug fix: Quick action printing of shipping label now prints with correct shipping service
= 2.0.8 =
* New feature: Create quick action to print shipping label for a order
= 2.0.7 =
* New feature: Create and fetch shipping labels from multiple orders
= 2.0.6 =
* Fix an error message when there is no settings available for shipping method
= 2.0.5 =
* Changed the way array is merged with another array
= 2.0.4 =
* Added possibility to add pickup point chooser to any shipping method defined as shipping zone shipping method
= 2.0.3 =
* Allow Pakettikauppa to create shipping labels even if original shipping method is not from Pakettikauppa shipping method.
* Allow shipping method to be changed (does not allow pickup point to be changed).
= 2.0.2 =
* Internal changes / fixes / improvements
* In latest woo pickup points only worked if shipping had testing on
= 2.0.1 =
* Fixed shipping method id in the settings
= 2.0.0 =
* Shipping zone and shipping class support!
* COD-support if payment method is WooCommerce COD (cash-on-delivery) payment method (or extended class)
* This update breaks pricing from 1.x branches - You have to create new prices by adding Pakettikauppa as a new shipping method to Shipping zones
= 1.1.8 =
* Alternative name for the shipping method
= 1.1.7 =
* Updated readme -file with new tags
* Travis-CI Updates
* Sort shipping methods based on shipping code
= 1.1.6 =
* Fixed printing of label
= 1.1.5 =
* Possibility to choose which shiment method to use when none is selected
= 1.1.4 =
* Fixes issues with VAT calculation with shipping costs. You have to enter shipping costs in the settings including VAT. In the Tax -settings page, when chosen option "Shipping tax class based on cart items", it will calculate the shipping taxes "backwards" from the given price correctly. For instance if you have 14% and 24% VAT products in the cart then shipping costs will have also 14% and 24% VAT in the correct proportions.
* Small internal code refactoring changes
= 1.0 =
* Initial release for General Availability.
== Upgrade Notice ==
= 2.0.0 =
Breaks compatibility with 1.x -settings
= 1.0 =
This plugin follows [semantic versioning](https://semver.org). Take it into account when updating.