WeClapp

The remaining interface of WeClapp can be connected via wemalo-connect. The steps and information required for this are listed below.

Create client in wemalo

The client is created in wemalo in the usual way. For the client’s other facilities in wemalo-connect, the client ID and the warehouse ID must be known.

Create user in wemalo-connect

A new shop user is created in wemalo-connect and linked to the previously created client in wemalo using the client ID. The warehouse ID is also stored.

The creation of a REST-Key is not necessary!

Set up WeClapp interface

The WeClapp interface is created in the “Generic REST Interfaces” area. These interfaces use wemalo’s REST interface to communicate with the back end. However, the creation of a remaining token is not necessary.

A new interface can be defined by clicking on the “New entry” button. After selecting the system, the configuration of the system can be loaded via the button “System-Template”. Using the WeClapp example, key-value pairs are loaded for storing the required settings (URL, token, WeClapp ID, etc.). An overview of the required settings follows in the next subchapter.

You can also select the wemalo instance (previously set up by linking wemalo and the client ID) and the synchronization interval.

A warehouse must be created via Settings- >Basic settings- >Warehouse.
As soon as this is done you can open the warehouse via the edit function (pen symbol) and see the warehouse ID in the browser bar at the end (entityId=XXXX).
This is required in the WeClapp settings.

 

WeClapp Settings

The following settings must be provided by the customer:

  • Token: here you have to enter the token from the WeClapp shop, (My settings- > API Token) which has to be created.
  • url: the URL to the API interface of WeClapp. (Shop URL/webapp/api/v1)
    Example: https://4elements.weclapp.com/webapp/api/v1
  • (WeClappId: 1)
  • (storageLocationId: 1)
  • warehouseId: the ID of the warehouse in WeClapp.

 

The following settings are made by us:

  • extendedLog: true must be entered here to activate extended logging.

 

subscriptions

The following subscriptions can be activated/deactivated:

  • serviceLoadProducts: load product master data from WeClapp and transfer to wemalo.
  • serviceLoadGoodsOrders: load WA orders from WeClapp and send them to wemalo.
  • servicePushPackages: return sent packets from wemalo to WeClapp.
  • servicePushInventoryBookings: Transmission of inventory entries (entries and withdrawals).
  • servicePushIncomingBookings: Transmission of incoming goods bookings
  • servicePushSentBookings: Transmission of outgoing goods bookings.
  • servicePushReturnBookings: Transmission of return bookings.

 

Annotations

Due to API limitations, the following tasks must be performed manually in the shop.

In order to successfully create a delivery of an order, the order must be confirmed by clicking manually.

The dispatch of the delivery and the creation of the invoice must also be confirmed here by a manual click. The stock is not updated until the delivery was shipped.

The return of the order cannot be generated until the delivery has been sent.

The goods from the returns can be posted back to the warehouse by selecting “Post all items to warehouse” under “Goods receipts and workflow” in Weclapp.

 




wemalo connect rest api

The documentation for the interface wemalo connect REST API can be found here: connect-api.wemalo.com




REST API workflow

Is using wemalos rest api, at least the following calls might be used for interacting with wemalo.

First of all, an account needs to be set up for you. You’ll get a rest api token that is being used for authorization. Please see header information: Authorization

Product master data

Orders




WordPress Wemalo API 2

With the second version of the WordPress plugin, Wemalo has considerably extended the range of functions.

furnishing

  • Download and activate the Wemalo Connectplugin from the WordPress shop.
  • A user account must then be set up in wemalo-connect(by a Wemalo employee).
  • The security key generated in wemalo-connect must be stored in the plugin configuration (a Wemalo entry has been added to the admin menu).

products

  • If a product is updated, the change is sent directly to Wemalo via wemalo-connect.
  • In addition, the product master data is requested by Wemalo at regular intervals. Since this is primarily required for the initial setup, the frequency of periodic queries is reduced.

mandatory fields

The only real mandatory field is the article number. However, they are also important for the warehouse processes:

  • EAN (if article number cannot already be scanned)
  • Article dimensions and weight (for storage and shipping)
  • Product image (for visual verification)
  • Product name (for name matching when picking/packing)

Expansion of products

The plugin extends the products and variants and adds the following information:

  • New alternative stock field (for example, B goods)
  • new field EAN (Tab Wemalo in main product)
  • new setting possibility serial number (Tab Wemalo in main product)
  • Overview of serial numbers/batches (Tab Wemalo in main product)

data transfer

  • When the main product is saved, the data record is transmitted directly to Wemalo. The time stamp of the last data transfer is displayed in the Wemalo tab.
  • A direct transmission also takes place when saving variants. Here the timestamp is displayed in the variant view.
  • If an error occurs during transmission, the return of the server is output.

product bundles

  • The WooCommerce product Bundle plugin has been supported since version 2.0.2 of the Wemalo plugin. The WooCommerce product Bundle plugin has been supported since version 2.0.2 of the Wemalo plugin.
  • As an alternative to using a plugin in WooCommerce, sets can also be defined in Wemalo. To do this, the set product must be created as a normal product in WooCommerce and configured accordingly in Wemalo (done by the Wemalo customer consultant).

orders

  • As soon as an order is set to “in progress”, data is transmitted to wemalo-connect and thus directly to Wemalo.
  • The download timestamp is set immediately. If an error occurs during transmission, the error message is stored as a custom field.
  • If the order could be completely reserved, it changes to a new fulfillment status.
  • As long as the order has not been reserved and is being processed in the order, it can also be cancelled in Wemalo using the WordPress stroning function. However, if the order is ready for fulfillment, it must be cancelled manually in Wemalo.
  • Once an hour, WooCommerce queries the current order status as long as the order has not yet been reserved.

Update orders

  • If the order is not yet in fulfillment, it can be processed at any time.

status extension

  • Returns registered (see Returns)
  • Returns posted (see Returns)
  • Order in fulfillment

If an order was sent to Wemalo, but cannot be set to Wemalo status open there (and thus released for picking), it will remain in processing status in WooCommerce and can still be cancelled from WooCommerce.

Wemalo fields in orders

  • Blocked: if the checkbox is checked, a transfer is made to Wemalo and the order is picked and packed. In Wemalo, however, it lands in the status “blocked packed” and is sent only after release.
  • Note: the text field can be used to send a note to the picker or packer.
  • ETD: if the date field has been set and is in the future, the goods will be reserved, but in Wemalo no pick list can be created yet. Only when the date has been reached, the picking list can be created and the order further processed/sent.

Additionally there is the panel with wemalo with the following data:

  • Priority: determines the priority of the order and can be distinguished between normal, high and very high. The priority affects the order of picking and reservation.
  • Order: another WooCommerce order can be linked via order, in which the order number is entered. A function that goes beyond this does not exist (no link in wemalo or similar).
  • Document upload: enables the upload of documents such as invoices or customs declarations.
  • Promi: allows you to mark an order as a Promi dispatch. In addition, a text can be entered which is sent to an e-mail address stored in the configuration. This can be used, for example, to write individual texts for orders and attach them to the packages.
  • Shipping: to hire the shipping service provider.
  • Product: Depending on the shipping service provider, the shipping products can be selected.
  • Returns no SN check: if products contain serial numbers, this flag can be used to switch off the validation of correctly returned serial numbers. The flag is transferred to wemalo when a return is registered.

tracking numbers

Tracking numbers are entered as notes and in the tracking_number field.

If wp_liste for Amazon or Ebay have been installed, the shipping service provider is entered in the field _wpla_tracking_provider (Amazon) / _wpl_tracking_provider (Ebay) and the tracking number in _wpla_tracking_number (Amazon) / _wpl_tracking_number (Ebay).

The tracking number can also be integrated into the e-mails sent automatically by WooCommerce when orders are completed. A manual can be found here: Insert tracking number e-mail at WooCommerce

shipping profiles

An external ID can be stored in Wemalo for matching the shipping profile to be sent. This comes from the WordPress installation and can be found under WooCommerce- > Settings- >Shipping.


Stock

  • Wemalo’s doing a stock update. This means that the stocks changed in Wemalo are transferred to the WooCommerce shop at regular intervals. The stocks of A-goods are transferred to the normal warehouse stock. All other stocks (B-stock, C-stock, etc.) are entered in a separate field for alternative stocks.
  • In order to be able to transfer stocks to WooCommerce, inventory management must be activated in the products on the shop side.

returns

  • The Wemalo API plug-in offers the possibility to turn an order into a registered return. As soon as the status of the order has been changed accordingly, the return is sent to Wemalo.
  • The return can then be scanned against the original order and the goods can therefore be validated.
  • Wemalo reports the received goods back to the plugin and sets the status to Return booked.

Supported Plugins

Supported WordPress plugins




Supported WordPress plugins

Supported versions in Plugin 2.x:

WordPress/ WooCommerce 3.1.2 3.2.6
4.7.1 X ?
4.8.3 X X
4.8.4 X X
4.9.2 ? X

Version 1.x

WordPress/ WooCommerce 2.6.9 3.1.2
4.5.10 ? X
4.7.1 X ?

X = > This combination is supported
? => Diese Kombination wird nicht aktiv unterstützt, könnte aber funktionieren
– = > This combination is not supported.

When using the Wemalo API, the following plugins are supported by Wemalo:

  • Akismet from Automattic
  • FAQ from Etoile Web Design
  • Wp Cookie Choice by Marcus Franke
  • Yoast SEO from Team Yoast
  • WP-Lister for ebay Version 2.0.15 from WPLab
  • WP-Lister for amazon Version 0.9.6.31 von WPLab
  • WooCommerce Multilingual 4.2.6 (from version 2.0.1) from OnTheGoSystems
  • Antispam Bee 2.7.1 by pluginkollektiv
  • WooCommerce product bundle (from version 2.0.2)

If other plugins are used in the shop, the functionality of the Wemalo plugin cannot be guaranteed. If necessary, the plugin must be adapted so that it works together with other plugins.




Shopify

The Shopify REST API is integrated into wemalo-connectand connects Wemalo to the Shopify shop system.

Settings in Shopify

For the connection an API key, password and URL are required.

Under Apps- >Manage prive apps- >Generate API credentials the API access can be set up.
For example, you can assign wemalo-connect as the app name. After the key generation we need the API key, the password and the exact URL. Under “Example URL” there is a link with all the information you need, if you could send it to me, it would help us a lot. Here is an example:
The required access rights can be seen here:
Set up api
The required access rights currently include the following requirements:

Supported actions

  • Loading product Master Data
  • Loading orders
  • Transmission of sent parcels
  • Transfer of stocks

Product master data

  • products for which requires_shippinghas not been set are not loaded.
  • All other products/variants are synchronized. SKU, EAN, weight, name, product group and manufacturer are exchanged.
  • Please note: the SKU (also in variants) must be unique.

Attention: A known bug on the part of Shopify is that Shopify does not change the external ID of duplicated products. This is necessary to transfer a new products to wemalo.

commissions

  • Orders with the financial_status paidand fulfillment_status unshippedare loaded and the Wemalo_Downloadtag is set.
  • Order header data, delivery address and items are synchronized.
  • The note field can be used to specify a pick info.
  • In order to determine the correct shipping service provider, Wemalo queries the name of the selected service provider. To match, this must be stored in Wemalo as an external ID for the profiles to be used.
  • Only positions for which “requires_shipping” has been set are transmitted to Wemalo.
  • Note: once an order has been submitted to Wemalo, no further changes to the order will be submitted to Wemalo.

Transmission of packages/tracking numbers

  • The tracking number is transferred back to Shopware together with the shipping service provider.
  • This automatically changes the fulfillment_status.

Transfer of stocks

  • In order for a Wemalo inventory to be transferred, the Inventory Policymust be activated.
  • Wemalo does nottransmit negative stock if there are incomplete orders that cannot be served. Otherwise the variants can no longer be called in Shopify.
  • Only pickable stocks are confirmed. I.e. goods on blocked stock or already picked goods will not be transferred as available stock to Shopify.

Find out Location ID

  • In the shop, go to Settings (bottom left), then click on the Locations area.
  • Then select the default location.
  • The location ID can then be seen in the address bar of the browser (e.g. 1112222122).

If the Location-ID is not correct, a hidden Location-ID can be determined by wemalo. This is done via the REST call.




wemalo-connect Release

Version 1.2.3

Date: 13.11.2017

Version 1.2.2

Date: 14.09.2017

  • Shopware configuration simplified
  • Activating/deactivating of wemalo instances implemented
  • new rest call for creating inventories implemented

Version 1.2.1

Date: 17.08.2017

  • Loading return orders from Shopware and pushing back booked returns integrated

Version 1.2.0

Date: 16.08.2017

  • Integration of Shopify api
  • Enhancements to shopware api

Version 1.1.0

Date: 07.07.2017

Version 1.0.1

Date: 28.06.2017

  • new call for creating multiple products at once added to connect api
  • possibility to set a product as activated/deactivated added to connect api
  • new rest calls need wemalo-backend 1.5.2.1 or later

Version 1.0.0

Date: 09.06.2017

  • connect-api has finally been implemented
  • wemalo-connect now allows using a wemalo rest api to transmit product data and goods orders and to load information about stock changes and sent packages
  • the api needs wemalo-backend 1.4.4 or higher

Version 0.2

Date: 07.06.2017

  • additional rest calls implemented
  • rest calls are now being validated before sending them to wemalo
  • preparation for managing shop systems in wemalo-connect

Version 0.1

Date: 31.05.2017

  • first beta version of wemalo-connect has been released
  • in this version it’s possible to manage users, wemalo instances and to communicate with wemalo via a rest api



wemalo-connect

wemalo-connect wemalo-connect connects Wemalo to shops, ERPs and other external systems. The software can be used independently of Wemalo, e.g. to synchronize the WordPress shop with the Plentymarkets shop. In addition, wemalo-connect provides a REST API to Wemalo, which is used to exchange product master data, transmit orders and query inventories. The full range of functions can be seen in the interface documentation: connect-api




Setting up WordPress WooCommerce

This article refers to the plugin version 1.x. There is a separate article about version 2.x.

After the Wemalo plugin has been installed in WordPress, it can be paired with Wemalo. To do this, the API WordPress must be selected under Data Exchange and the URL to the shop must be stored.

Setting up the WordPress environment

data subscriptions

Individual data calls can be activated/deactivated via the subscriptions:

  • Get WA orders: Orders received in WooCommerce are transferred to Wemalo where they can be processed as goods issue orders. Only orders that have the status “In process” and have already been paid will be sent to Wemalo.
  • Get product master data: this option must be selected in order to work with the data from WordPress. This transfers the “simple products” and “variable products” from WooCommerce to Wemalo. For variants, the product name is a combination of the title of the parent product and the individual attributes.
  • Transfer GR postings: all goods receipts in the warehouse (goods receipt, returns receipt, inventory entry) are transferred to WooCommerce and the stock of the respective articles is increased accordingly.
  • Submit WA postings: Wemalo reports back to WooCommerce when an order has been sent and sets the status to completed. In addition, inventory write-offs and goods issues without WooCommerce reference are returned as inventory changes.

authentication key

After the data subscriptions have been selected and pressed Save, the system generates a token that must be used for authentication:

Wordpress token

This key must be entered in the Wemalo plugin:

Enter Authkey in the Wemalo plugin at WordPress

 

note in WooCommerce

An article number should also be stored for variants. This is transmitted to Wemalo as SKU. By default, WooCommerce does not allow you to store an EAN for articles. Therefore, this field remains empty in Wemalo. Therefore, only the internal barcode generated by Wemalo or the SKU can be used to scan goods. An alternative would be to deposit the EAN as an SKU.

To note in Wemalo

For orders, the customer (if activated) can choose between national shipping, free shipping, etc.. The ID of the respective shipping option must be entered as Ext. Profile ID in Wemalo in the shipping profiles so that the system selects the correct profile when creating a GI order. The ID of the profile can be found in WordPress under WooCommerce- >Settings- >Shipping:
shipping profiles in WooCommerce

Download page: WemaloAPI.zip