Caution
Do not open an issue ticket if you are reporting a security vulnerability. Contact 1984 Hosting directly via [email protected] or the WordPress Security Team instead.
Important
This is a code repository used for the development of 1984 Connector for DK and WooCommerce, a WordPress plugin. Using the raw source files without installing dependencies using Composer will not work and the main branch is considered unstable.
Note
To download a working version of the plugin, please visit the Releases Page and download the 1984-dk-woo.zip file for a current version. In the future, you will be able visit https://wordpress.org/plugins/1984-dk-woo/ to get the currently stable release and get automatic updates.
Please note that there are two readme files. This one (reamde.md) and the user-facing readme (readme.txt) used for providing metadata to the WordPress.org plugin repository as well as a general introduction to the plugin.
This file is mainly intended for development and contribution purposes.
We use Github actions as a continious integration process to automatically test the plugin using the following PHP and WordPress versions:
- PHP 8.1 and above
- WordPress 6.1 and above
We generally assume that the most recent version of WooCommerce is in use and use that for testing across the supported PHP and WordPress versions.
In the most simple terms this WordPress plugin syncs information between a WooCommerce store and the DK accounting software. It syncs product data, creates invoices for fulfilled orders and sync stock levels for products between the two.
- The WooCommerce store is the source of truth for product prices and availability towards the customer
- The DK setup is the source of truth for accounting transactions
- Add a settings page and corresponding JSON endpoint to wp-admin
- Design and add options for sync to the WooCommerce product editor
- Add a kennitala field to the shortcode based checkout page
- Add a kennitala field to the block based checkout page
- Integrate kennitala to the WooCommerce order editor
- Add a kennitala text field to the user profile editor
- Add Icelandic locale files
- Create a corresponding product record in DK when a WooCommerce product is created
- Sync changes to product records upstream from WooCommerce on update
- Sync changes to product records downstream from DK on regular intervals or using web hooks
- Sync and create product inventory when a product is created in DK
- Assign a single warehose in DK for items in the WooCommerce store
- Let customers add a kennitala to their billing address
- Create a corresponding customer record in DK when a WooCommerce customer is created
- Sync changes to customer records upstream from WooCommerce on update
- Sync changes to customer records downstream from DK on regular intervals or using web hooks
- Create and send invoices to customers via DK after a successful payment
- Create and send credit invoices on returns
- Take over the WooCommerce invoice email delivery mechanism and use the same hooks to send invoices via DK
- Assign SKU for delivery costs
- Assign a SKU for other costs
- Assign a SKU for coupons
- Map Payment Gateways in WooCommerce with Payment Methods in DK
- Assign a salesperson in DK for sales in WooCommerce
- Use a BigDecimal-like library to handle tax calculations and such instead of depending on PHP's decimal support
- Improve error handling and validation (Possibly replace
falsereturn values in Export classes with WP_Error, and then doingwp_die()on failure instead of failing softly).
- Sync WooCommerce orders with the DK Sales Order module
- Assign a price group (1, 2, 3) for products
The DK API documentation is well known for being inaccurate and it seems to be written by two different programmers. They also don't seem to like each other very much.
One version of it can be found at https://apidoc.dkplus.is/ and is generated using Postman.
The other version is generated using Swagger and is available at https://api.dkplus.is/swagger/ui/index.
Either version documents certain endpoints at different states. Some features are missing and some of the specifics described seem to be documented ahead of time and don't actually exsist (as they may only be working internally, with the public version trailing behind). There are also spelling errors and other discrepencies in some JSON properties that are not reflected in the documentation.
DK will cut off some string values that exceed its limits without warning. This is not well documented by them.
- Product Codes (SKU): The DK API is unable to accept longer values than 20.
- Product variations need to be treated as separate products
- Product variation SKUs have to be unique and not the same as the parent.
- Product descriptions: The DK API is unable to accept longer textual values than 40.
This means that syncing product descriptions etc. may not be possible using orthodox methodologies and that string values should always be assumed to be either 20 or 40 characters long. (It may be possible to do so via "attachments" but the documentation for those remains questionable.)
The main code repository for the plugin is at https://github.com/1984hosting/. The Subversion account for the WordPress plugin respository is used for "built" releases of the plugin.
We are happy to receive patches and pull requests for new feature ideas, bug fixes and translations. Please contact us directly at [email protected] or the WordPress Security Team in case of security voulnerabilities.
If you are reporting a bug, please describe the steps needed to be taken so that we can replicate it, if possible.
And last but not least, be nice to us and others.
You can contact 1984 Hosting directly by email via [email protected]. The communication lines are short, so you will reach the right person that way, even when it comes to security related issues.
The main author can be contacted via [email protected]. She is available for hire, some of her previous work can be found at and she can be supported via Github Sponsors at https://github.com/sponsors/aldavigdis.
This plugin is provided to you as free software under the GPLv3 license. Runtime dependencies are provided under the MIT and Apache licenses, which are compatible with the GPLv3.
1984 Connector for DK and WooCommerce
Copyright (C) 2024 1984 Hosting and contributors
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.
