Server Extension

A server extension makes it possible for 3PL license holders to add additional features to Stoqflow, such as adding information to an order that must first be retrieved from another server or first validated by external parameters. The difference between webhooks and a server extension is that Stoqflow will wait for a response from the addressed server before proceeding.

Via Admin > Server Extension, the server extension can be configured, and server extension hooks can be created and managed.

Server Extension Settings

Before the server extension can be used, the following settings must be filled in:

  • Enabled: Whether the server extension is enabled or not
  • URL: The URL where Stoqflow will send the HTTP requests
  • Secret: A unique key used to secure communication between Stoqflow and the server extension

Server Extension Hooks

A server extension hook consists of a trigger and some optional filters.

Triggers

For each server extension hook, a trigger must be chosen. An event where Stoqflow sends an HTTP request to a chosen URL. Some important triggers are, for example:

  • When shipments are registered on an order
  • When an order is modified

Filters

Filters are optional and can be used to determine whether Stoqflow should contact the server extension. Because HTTP traffic between Stoqflow and the server extension may take some time, it's best to avoid this traffic as much as possible by, for example, contacting the server extension only for orders from specific shops.

When is the Server Extension Contacted?

Server extension hooks are always executed before the trigger of the hook is recorded in the database. This means that when a hook is executed at the time of modifying an order, the server extension (if necessary) can still make adjustments before the order is stored in our database.

Examples

A server extension therefore allows you to add an endless series of additional features to Stoqflow. Some good examples are:

  • Setting up a preferred carrier based on parameters in external software
  • Custom shipping labels can be added to orders that can then be printed by Stoqflow

Using Server Extensions

Since setting up and using a server extension requires custom-made software, it's best to contact the developers of Stoqflow to discuss all technical aspects.