Integrating any E-Commerce Webshop with Increff OMS
- Gaurav Mishra (Unlicensed)
- Alaf Azam Khan
This guide provides the information required to integrate an E-commerce portal with the Increff Standard APIs.
Terminology
Inbound : API Calls from Client system to Increff system
Outbound : API Calls from Increff system to Client system
{Client’s URL} : Means client can give their url endpoint to be called. Payload will be increff’s standard.
Protocol
REST APIs
JSON format
Typical Marketplace Integration flows
API Name | Summary | Mandatory/Non-Mandatory | From | To |
|---|---|---|---|---|
This listing is mapping of Product barcode to that marketplace system’s unique identifier “Channel SKu Code”. This API assumes the product master is already created in Increff system. This operation can also done via Increff UI. | Non-Mandatory | Webshop | Increff OMS | |
These APIs will be used by Increff OMS to send marketplace Inventory updates. Depending upon if marketplace location wise inventory or consolidate inventory correct API can be used. | Mandatory | Increff OMS | Webshop | |
This API will be used by the Marketplace to push outward orders to OMS | Mandatory | Webshop | Increff OMS | |
Increff OMS can send an Order Acknowledgement when inventory is available and it is allocated to the order | Not Mandatory | Increff OMS | Webshop | |
This API will call the marketplace system to mark the order as packed | Mandatory | Increff OMS | Webshop | |
This API will fetch invoice URL along with tax details. | Mandatory | Increff OMS | Webshop | |
This API will fetch shipping information from marketplace | Non Mandatory | Increff OMS | Webshop | |
This API will to create a manifest on marketplace | Non Mandatory | Increff OMS | Webshop | |
This API will be used to pull a manifest PDf from the marketplace | Non Mandatory | Increff OMS | Webshop | |
Marketplace will use this API to push order cancellations to Increff OMS | Mandatory | Webshop | Increff OMS | |
Increff OMS will use this API to push order cancellation to marketplace | Non Mandatory | Increff OMS | Webshop | |
Marketplace can update order properties like SLA and onhold | Non Mandatory | Webshop | Increff OMS | |
Marketplace can push Order delivered status to OMS | Non Mandatory | Webshop | Increff OMS | |
Marketplace can update order atrributes using this api. | Non Mandatory | Webshop | Increff OMS | |
Marketplace can push a return order expectation to OMS | Non Mandatory | Webshop | Increff OMS | |
Increff OMS will push a return processed ack to marketplace. | Non Mandatory | Increff OMS | Webshop |