Content
What is a Generic ERP Integration?
The Generic sync ERP Integration allows a quick integration with any ERP. It's an easy-to-use App Store allowing multiple optional functionalities.
Need to have
To use this app store, you will need to have an API that can support responses and requests based on the below documentation.
We have created multiple articles to allow an easy to build experience:
For the Orders, Order by ID, Invoices, Invoice by ID, we have this article.
For the Customer A/R Balance, we have this article.
For the Checkout Tax Integration, we have this article.
For the Checkout Shipping Methods, we have this article.
Install from the App Store
Key and Token: Both fields are used on the request header. Can be use for authentication.
Orders URL: Api endpoint for a list of orders.
Order by id URL: Api endpoint for a single order using ID.
Invoices URL: Api endpoint for a list of invoices.
Invoice by id URL: Api endpoint for a single invoice using ID.
Customer A/R Balance URL: Api endpoint for a Customer Summary or A/R Balance.
Checkout Taxes URL: Api endpoint for a live tax lookup on checkout.
Checkout Shipping Methods URL: Api endpoint for a live shipping methods lookup on checkout.
Error notification e-mail Sender: SES E-mail address to be used as sender (FROM) for emails sent when an integration error occurs.
Error notification e-mail Receiver: E-mail address to receive (TO) information when an integration error occurs.
Tricks and tips
All errors are suppressed for the end user, the errors can be seen on the Event module.
The functionalities are enabled and disabled depending on the endpoint, if it's provided or not.
Developer experience
After the developer scopes the previous mentioned articles and builds the Api endpoints, we provide a simple to use way of testing and debugging the code.
Follow the steps:
Go to the storefront in Customers > All Users > (View a user) > "Login On storefront". (Be sure that the user has permission to do the action)
Perform the action.
Track the Event on Admin in Developers > Events > (select the event).
Observe the image above, there's a lot of information about the request, being the most important the sections "Object Payload" and "Related Requests".
Object Payload
On the "event_data" we can obtain the following fields:
external_customer_id: We save the Account Number used in the request.
related_to:
customer: In some cases, we store the Evox Account ID.
user: In some cases, we store the Evox User ID.
evoxlogger_trace_id: The trace ID provided here is use by the Evox Staff.
error: The error is a short message, in human language, describing an existing problem.
Related Requests
In this section we can obtain more data about the request and the response provided by the ERP Api. We can confirm the Method, Endpoint, response Status, the request Date, and the request ID.
After clicking on the request ID a new page is going to be load, with information changed between Evox and the ERP Api.
The Payload contains the request made for the ERP Api and the response given.
Note: The Related Requests section, it's an asynchronous event trigger after the request has been made, because of that, the section may have a delay and not be access when the event is created.
Contact the customer success team to discuss an integration project.