Overview
These APIs will be used when Increff OMS is standalone getting used with other WMS or SFS solutions.
Using these APIs any other External Fulfilment Solution (EFS) can integrate with Increff OMS and utilise the OMS capabilities.
API Summary
API Name | Summary | Mandatory/Non-Mandatory | From | To |
|---|---|---|---|---|
Listing Creation For External Fulfilment System (EFS) | In Increff system we will be creating a new channel of type external fulfillment system. This listing is mapping of Product barcode to that External system’s unique identifier Channel SKu Code. This API assumes the procut master is already created in Increff system. This operation can also done via Increff UI. | Non-Mandatory | External Fulfilment System (EFS) | Increff OMS |
Update Inventory | This API will be called by any External WMS to update the absolute inventory for the Products to be synced to Increff system. | Mandatory | External Fulfilment System (EFS) | Increff OMS |
Outward Order Events Notification to EFS | This API pushes the Sales Order level details based on different configurable Events from Increff system to External fulfilment system. | Mandatory | Increff OMS | External Fulfilment System (EFS) |
Seller Cancellation Notification from EFS | This API is used by Increff system to push order cancellation done by the Seller/Vendor from to the Channel/External System. | Mandatory | External Fulfilment System (EFS) | Increff OMS |
Create Picklist for Orders In Increff OMS | This API is used to create picklist for orders which are to be picked together as part of a Pick Order Group (POG). | Non-Mandatory | External Fulfilment System (EFS) | Increff OMS |
Add Orders to PickList in Increff OMS | This API is used to add more orders to an already created picklist in USP system. | Non-Mandatory | External Fulfilment System (EFS) | Increff OMS |
Pack Order in Increff OMS & Get Pack Details from Increff OMS | This API will pack the order in the OMS & the respective Integrated Marketplace to Increff system and then return the Invoice and Shipping Label documents in the response. | Mandatory | External Fulfilment System (EFS) | Increff OMS |
Create Manifest in Increff OMS | This API will manifest the orders in OMS and the respective marketplace integrated from Increff OMS system | Non-Mandatory | External Fulfilment System (EFS) | Increff OMS |
Shipment Handover Notification to EFS | This API will handover the orders in OMS and required marketplace integrated from Increff OMS system. | Non-Mandatory | Increff OMS | External Fulfilment System (EFS) |
Push Return Order Expectations to EFS | This API is used to pass on the return order expectation coming from marketplaces to external fulfilment systems. | Mandatory | External Fulfilment System (EFS) | Increff OMS |
Return Order Processing Update to Increff OMS | This API is used by external fulfillment system to send Return order processing updates to Increff OMS system. | Mandatory | Increff OMS | External Fulfilment System (EFS) |