Table of Contents

Set up a new connection

In this article, you will learn how to set up a new connection to an e-commerce platform using the Aident WebConnect app in Business Central.

Prerequisites

  • An active e-commerce platform must exist.
  • The permission set 'Aident WebConnect - Admin' must be assigned to your user.

General setup

Follow these steps to configure the Aident WebConnect app:

  1. Navigate to Aident WebConnect Setup: In Business Central, search for and go to the Aident WebConnect Setup page.
  2. Select Webshop Order No. Series: Choose the No. Series for all incoming orders from e-commerce platforms to Business Central.
  3. Select Webshop Customers No. Series: Choose the No. Series for all incoming customers from e-commerce platforms to Business Central.
  4. Select Order Archive Retention Period: Define the period after which you want to delete archived orders from the interim table.
  5. Select Customer Retention Period: Define the period after which imported customers will be deleted from the interim table.
  6. Select Request Log Retention Period: Define the period after which request logs will be deleted.

Tenant setup

A Webshop Tenant represents a specific e-commerce platform in Business Central and contains all the necessary configurations for the connection to work. You can create one tenant per platform.

The app provides a wizard that guides you through the setup process.

  1. Navigate to the Setup Wizard:
    • Search for Webshop Tenant Setup Wizard.
  2. Provide Unique Tenant Code and Description:
    • Enter a unique code and description for the new Webshop Tenant. This code will be used in all communications with the e-commerce platform.
  3. Configure Order Options:
    • Choose the Default Sales Location for all orders in this tenant.
    • Enable Check Item Availability to verify inventory during order processing.
    • Enable Use Order Status to keep the current status of each order line in Business Central.
    • Enable Use Order No. from Webshop to use the order number from the e-commerce platform as the document number in Business Central.
    • Enable Use Webshop Order No. as External Document No. for the order number to be used as an external document number.
    • Enable Automatic Document Release for automatic release of sales orders after they're created.
    • Enable Automatic Warehouse Shipment Creation for creating a warehouse shipment along with the sales order. This requires the previous option to be checked.
    • Enable Automatic Warehouse Shipment Release to release warehouse shipments automatically after they're created.
    • Choose a default Payment Terms Code for all orders in this tenant.
  4. Configure Customer Options:
    • Choose a Default Customer Template Code for imported customers.
    • Select the method for Customer Creation: "Job Queue" for post-processing or "Real-time" for immediate creation upon API request.
  5. Configure Contact Information:
    • Enter contact information for the webshop, which can be used in document reports. You can later import a logo in the Webshop Tenant Card page.
  6. Configure Locations:
    • Select relevant locations from Business Central for the tenant. Include the default sales location from step 3.
  7. Configure Countries/Regions:
    • Choose the relevant countries/regions and assign a Customer Template Code and Currency Code for imported customers.
    • Specify any overrides for customer pricing and shipping settings based on country/region.
    • Specify Sales Price List Code and Sales Discount List Code that will be used for selected Tenant and Country/Region.
    • Each Country/Region in this setup can have assigned Dimension. This step can be done on Webshop Tenant Card page.
  8. Configure Shipment Methods:
    • Choose relevant shipment methods for the selected tenant.
  9. Configure Payment Methods:
    • Select relevant payment methods for the selected tenant.
  10. Configure Connection to Webshop:
    • Enable Send Automatic Updates to Webshop for real-time updates from Business Central to e-commerce platform.
    • Choose Authorization Type: Basic (requires username and password) or OAuth (requires access token address, placement of parameters and list of parameters).
    • Specify the Request Base URL of the e-commerce platform.
    • Define objects to be exported, along with the Request Method and Endpoint.

Manual setup

If you prefer to configure settings manually, you can do so by navigating to the Webshop Tenant page.

Role center

The Aident WebConnect app offers a dedicated profile (Aident WebConnect) that enables you to manage all aspects of the connection between Business Central and your e-commerce platform.

Job queues

  • codeunit CustomerImplWENID: Processes imported customers if "Customer Creation" is set to Job Queue to create new customers in Business Central.
  • codeunit OrderImplWENID: Processes imported orders to create new sales orders in Business Central.
  • codeunit PriceImplWENID: Processes sales prices, finds best price for each item and updates Webshop Price table.
  • codeunit ProcessRequestLogWENID: Processes open request logs, sends updates to e-commerce platform and saves response codes and messages.

Next step

Data Management