Integrating with OMS API


This document describes the different ways to integrate with Magento OMS API.

Integration options

The way to connect with the OMS is JSON-RPC over HTTP. There are three different integration approaches:

  • MC Extensions
  • Reference Middleware:
  • Custom Middleware

Actually, any integration is a mix of way of integrating. Typically, you will be using the Magento OM connector in MC which is an MC extension, the warehouse integration will be done through a middleware, etc. The difference between reference and custom middleware is more in the intention than in the result.

  • Reference middleware is a construct middle Magento propose for system integrations to start with sample application.
  • Custom middleware means that you can implement your own connection following purely our documentation, using whatever technology you see fit.

Alt Text

When to use Extension and Middleware?

Integration with MC Extension

Audience - System Integrators
- Simple setups
- Cloud Commerce friendly
Advantages - SI excels at MC Extension
- Runs in the same server, less maintenance
- Extension can be built and sold on the marketplace

Preferred integration when all orders comes from one front-end.

Integration with Middleware

Audience - System Integrators
- Bigger clients
Advantages - Provides Dummy implementation of important messages
- Uses PHP industry standard Symfony Framework
- Can be shared for multiple brands/client
- Scale apart from MC

Preferred integration when all orders comes from many front-ends or omnichannel.

Note: when using middleware to connect to third parties systems (i.e.: WMS, ERP), then middleware is hosted by the System Integrator on the location of their choice.

Alt Text