Marketplaces Integrating with Increff Standard APIs
Overview
Increff's standardized APIs provide a smooth and efficient method for marketplaces to integrate their operational workflows. This integration streamlines the exchange of data and processes, allowing for a more seamless and automated connection between Increff's systems and those of the marketplace or shopfront.
This document comprehensively details the extent of integration achievable between Increff and various marketplace or shopfront systems. The core of this integration relies on the utilization of Increff's Standard APIs, providing a robust and well-documented framework for data exchange and process automation. This ensures a consistent and reliable integration experience for all participating systems.
API Touchpoint Details
Marketplace would develop and integrate with following Increff APIs
API | Touchpoint details | Mandatory | Workflow | |
Outwards API | Outward Order Creation APIs | Yes | Order Creation (Marketplace → Increff) | |
Outward Order Processing APIs | No |
| ||
Yes | Pack Order Updates (Increff → Marketplace) | |||
No | Increff has the capability of creating invoices as well, if required. | |||
No | Get Shipping Label (Increff → Marketplace) | |||
No |
| |||
No | Handover Notification (Increff → Marketplace) | |||
Outward Order modification APIs | Yes | Seller Cancellation (Increff → Marketplace) | ||
Yes | Customer Cancellation (Marketplace → Increff) | |||
No |
| |||
Inventory APIs | Inventory Update API | Yes | Inventory sync (Increff → Marketplace) | |
Search Inventory API | No |
| ||
Returns APIs | Create Return Order API | No | If return flow is required, these APIs can be used. Return Creation/Updates (Marketplace → Increff) | |
Return Order Acknowledgement API | No | |||
Update Returns API | No | |||
Cancel Return Order Items API | No |
Solution/Implementation Details
Workflow Diagram (Highlighting mandatory flows)
Workflow Details
Inventory Sync
Real Time inventory Updates (Mandatory)
Inventory adjustments, whether increments or decrements, can occur at warehouses whenever there is a change in stock levels. Therefore, it is essential that these updates happen in real time. Real-time inventory updates can be communicated to marketplace platforms through this API.
Product Listings and Catalogue
Sellers are responsible for creating product listings and managing their catalogues on the Marketplace platform. This task falls outside the scope of Increff.
To create listings on Increff, sellers can utilise the user interface or access the system through APIs.
Pre Order Inventory lookup
In case Marketplace Team wants to do a inventory lookup before confirming the customer order by using API request to Increff standard APIs to check the real time stock availability. They can use Search inventory Beta API for this purpose.
Forward Order Journey
Order Creation (Mandatory)
Once a customer order is accepted on the Marketplace Shop front, it will be transferred to the internal service. This service will export the order to the Marketplace OMS and simultaneously invoke Increff’s Standard Order creation API to facilitate the order creation in the Increff system.
Order Processing Updates (Mandatory)
The WH team will pick and pack the items for the order, subsequently triggering a shipment creation request from Increff to the Marketplace system. This request confirms that the order items have been successfully packed in the warehouse.
Following this, the Marketplace will create a shipment within their logistics service and allocate a logistics partner for the pickup of the shipment.
Ship Label and Invoice document
Shipping Label generation → Once order is packed, on the trigger of WH user for generating Shipping label and invoice, an API request will go to Marketplace from Increff system to provide the AWB number details and Shipping label document.
Order Invoicing Flow → As per Marketplace Team, they will create customer invoice on their own and paste it on shipment physically once it reaches from WH to Marketplace warehouse.
In this case, Increff will create a Dummy invoice document which WH team can use if they require to.
Order Handover and Dispatch
On successful completion of all warehouse operations on the forward order, the WH user will handover the shipment packets to Marketplace Logistic partner, at this moment an API request will be triggered from Increff to Marketplace system to confirm the handover operation.
Marketplace will use this notification to mark the order shipped from to Marketplace warehouse managing their mid-mile operations. Here on, last-mile operations will be handled by Marketplace logistics team once the shipments reaches to Marketplace WH.