eCommerce API

In this article

Main Business Central objects

Bookings for LS Central is a general booking and reservation module that can handle multiple types of reservations, ranging from appointments, classes, courses, and rentals.  Resources can be based on schedules, opening hours, or quantity settings. 

The API provides external 3rd party front ends to utilize the module's reservation and price engines, and to place the reservations in the Business Central back end for further processing.  Also, the API allows front ends to lookup various information regarding the client activities, as well as the pre-uploading of the products.

The Business Central setup pages also provide a testing toolkit to allow the Business Central developer or user to review and test the API and make sure the booking process is working according to expectations. The XML respond files can be reviewed from the Business Central setup, if needed.

The articles in this section provide details on the functions supported in the API, the layout of the XML responds, and on the suggested process flow on the front end.

The SOAP API is fairly easily customized, all published API calls reside in a single codeunit, all responding XMLs are using the standard Business Central XML ports, and all web logic resides in a single codeunit as well.  A C# sample program is also included to test the API availability calls outside Business Central.

Note: API using Json respond (REST) is also available in a separate codeunit.

Note: If the payment process on front end is needed, the Commerce module is required for the basket process.

Main Business Central objects

Pages Activity Setup

Activity Web Log

10015815

10015923

Main setups of the integration.

View respond logs and test features.

Codeunits Activity Web Services

Activity Web Support

Activity Web API

10015822

10015823

10015845

Provides the published API with XML responds.

The logic executed for responds.

Provides the Published API with Json responds.

Table Customer Order Line 10016652 Payment results for bookings.

Field "Order Reference", set by CustomerOrderCreate e-commerce API.

XMLPorts Activity Availability

Activity Upload Products

Activity Upload Types

Activity Upload Locations

Activity Issued Allowance

Activity Reservations

Activity Promotions

10015800

10015801

10015802

10015803

10015804

10015805

10015806

Respond to availability request.

Respond to product master request.

Respond to activity types request.

Respond to location request.

Respond to allowance list request.

Respond to client’s activities list request.

Respond to list of active promotions.