Qodex.ai

WebConnector APIv2

Number of APIs: 114

The WebConnector allows many popular web shop systems to connect with Microsoft Dynamics 365 Business Central. In addition to providing web services for active communication of their own web shops or portal solutions with Business Central, the WebConnector also has an active component to synchronize item information, customer orders, and delivery status. The solution can be used in both online and on-premises environments and has been proven in a variety of projects since 2004.

Getting started guide

To start using the WebConnector APIv2, you need to -

  • Set the base-url to point to the corret Endpoints in the project variables. Visit this page to determin the correct format.
  • Install OAuth authorization for Business Central is the valid method for using the Business Central API or OData web services. Read this setup guide.
  • Set the company Id as a project variable. The web service to obtain the company Ids is in the Company Folder in this project

Authentication

Depending on whether OAuth 2.0 or just username/password is used, the authentication must be done differently. This test project is based on username/password. For the setup of OAuth 2.0, various settings need to be configured in the Active Directory. A guide can be found here. Username and password can be set in the project's variables.

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Need some help?

In case you have questions, go through our WebConnector API Documentation.

  1. Company - Get company GET {{base-url}}/v2.0/companies

  2. WebConnector API Services-Contact - Get Contact with Business Relation GET {{base-url}}/tso/webconnector/v2.0/companies({{company}})/contactsWebCon?$expand=contactBusinessRelationsWebCon

  3. WebConnector API Services-Contact - Create Contact POST {{base-url}}/tso/webconnector/v2.0/companies({{company}})/contactsWebCon

  4. WebConnector API Services-Contact - Update Contact PATCH {{base-url}}/tso/webconnector/v2.0/companies({{company}})/contactsWebCon({{ContactId}})

  5. WebConnector API Services-Contact - Create Customer from Contact POST {{base-url}}/tso/webconnector/v2.0/companies({{company}})/contactsWebCon({{ContactId}})/Microsoft.NAV.createCustomer

  6. WebConnector API Services-Contact - Delete Contact DELETE {{base-url}}/tso/webconnector/v2.0/companies({{company}})/contactsWebCon({{ContactId}})

  7. WebConnector API Services-Vendor - Get Vendor GET {{base-url}}/tso/webconnector/v2.0/companies({{company}})/vendorsWebCon

  8. WebConnector API Services-Vendor - Create Vendor POST {{base-url}}/tso/webconnector/v2.0/companies({{company}})/vendorsWebCon

  9. WebConnector API Services-Vendor - Update Vendor PATCH {{base-url}}/tso/webconnector/v2.0/companies({{company}})/vendorsWebCon({{VendorId}})

  10. WebConnector API Services-Vendor - Delete Vendor DELETE {{base-url}}/tso/webconnector/v2.0/companies({{company}})/vendorsWebCon({{VendorId}})