Skip to content

API integrations

On this page you configure the API integrations between Planograma and the external systems with which your company works: e-commerce platforms and ERP systems. An active integration allows Planograma to automatically take in orders, goods receipts (NIRs) or expenditure receipts from the external system and to send back stocks and statuses as the documents are processed in the warehouse.

Note

The configuration of the integrations is an administration operation. The options are visible and can be saved only by users with administrator permission level. Certain actions (for example the full re-synchronization of the data) are reserved for the superadministrator.

Available integrations

Each integration is activated through a switch. The integrations are mutually exclusive: when you activate one, the others are deactivated automatically, because a tenant communicates at a given moment with a single external system.

Integration System type Activation
SofTech ERP "Communication with SofTech" switch
WinMentor ERP "Communication with Winmentor" switch
SoftOne ERP "Communication with SoftOne" switch
Nexus ERP "Communication with Nexus" switch
GoMag e-commerce platform "Communication with GoMag" switch
EasySales e-commerce platform "Communication with EasySales" switch
MerchantPro e-commerce platform "Communication with MerchantPro" switch

After you activate an integration, under the switch the specific configuration fields appear (connection data, synchronization options and status mappings).

Common synchronization options

Regardless of the chosen system, the integrations expose a common set of options, in the form of switches:

  • Sync orders — Planograma takes in the orders (the outbound documents) from the external system.
  • Sync NIRs — Planograma takes in the goods receipt documents (the inbound documents) from the external system.
  • Sync expenditure receipts — Planograma takes in the expenditure receipts from the external system.
  • Send stocks — Planograma sends back to the external system the updated stocks.

Note

Not all the options are available at each integration. For example, the synchronization of the NIRs appears only at the ERP systems (Nexus, SoftOne, WinMentor), and the sending of stock appears at the e-commerce platforms and at a part of the ERPs.

The mapping of the statuses (Status ID)

For the integrations with orders and NIRs you fill in the status mappings between Planograma and the external system, grouped into Outbound Status ID Settings and Inbound Status ID Settings:

  • Status ID for outbound takeover eligibility in Planograma — the status in the ERP at which an outbound document becomes eligible for takeover in Planograma.
  • Status ID eligible for sending document to picking — the status at which the document is sent to picking.
  • ERP Status ID at the completion of the outbound picking — the status set in the ERP when the picking of the outbound document has ended.
  • ERP Status ID at the completion of the return — the status set in the ERP at the completion of a return.
  • Status ID corresponding to a deleted outbound document (usually 0) and Status ID corresponding to a returned outbound document.
  • The equivalents on the inbound side: Status ID for inbound takeover eligibility, Status ID in the ERP at the completion of the inbound processing, Status ID corresponding to a deleted inbound document.

The values are the status identifiers used by your external system; you obtain them from the configuration of that system.

The connection data per integration

Depending on the activated integration, you fill in the following:

  • SofTech — Collection ID, User Account, Data Source, Outbound Stocks Storage Code, Inbound Stocks Storage Code, Broker Name, Cost Center Code, Profit Center Code.
  • WinMentor — IP, Port and the status mappings (Canceled, Operated, Blocked, Closed).
  • SoftOne — the application ID, the application URL, the application User, the application Password, NIR Series and the status mappings for outbound and inbound documents.
  • Nexus — IP, Port, API Key, plus the order reading filters (see below).
  • GoMag — the application ID, the application URL and the status mappings.
  • EasySales — the application URL, the status mappings and an API key (the Credentials section, see below), plus the list of websites.
  • MerchantPro — the application URL, the status mappings and an API key (the Credentials section).

The Nexus order filters

For Nexus, under "Order reading configurator" you have additional switches that narrow which orders are taken in: only fully reserved orders, include closed orders, only firm orders, only approved orders, include orders approved for delivery, include fulfilled orders, include line details, include the components of the compound products.

Generating and managing an API key

For the integrations that use an API key (for example EasySales and MerchantPro), in the Credentials section you fill in:

  • Api Key — the key (the identifier) issued by the external platform.
  • Api Secret — the secret associated with the key.
  • API URL — the address of the platform's API endpoint (it comes pre-filled with a default value that you can change).

Press Add to save. The key is stored securely in Planograma; next to the label a visual indicator appears: a green check if a key is already saved, respectively a warning sign if you have not yet entered one.

Warning

For security reasons, the secret is not returned in clear text after saving. If you have to change the key, enter the new values and save again — they will replace the previous key.

Websites (token per shop)

At the integrations that support several shops (for example EasySales), under Websites appears the list of the detected shops. Each shop is displayed as a colored label: green if it already has a configured token, respectively yellow if the token is missing (see the message when hovering with the mouse). Press on a shop to open the window in which you enter or reset the Token of that shop, then save.

Re-synchronization and verification

In the integrations area you also have control actions:

  • Re-synchronization — triggers a full re-synchronization of the data for the current tenant. It is an action reserved for the superadministrator and you use it after a reconfiguration or to force a full alignment with the external system.
  • Last synchronization date — displays the moment of the last successful synchronization, as a point of reference for checking whether the integration is running.
  • Integration check — confirms whether the tenant has at least one active integration configured.

Note

After you save the configuration of an integration, the automatic synchronizations run periodically in the background. The manual re-synchronization is useful only when you want an immediate alignment, outside the automatic schedule.