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) like a WMS or a POS can integrate with Increff OMS and utilise the OMS capabilities and all the Increff marketplace OMS integrations.
API Invocation
Following headers need to be provided (unless otherwise stated). The credentials will be provided to you upon request.
authUsername
authPassword
authDomainName
Content-Type: application/json
Flow Diagram
| Drawio | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Child pages (Children Display) | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| Tip |
|---|
To Migrate to Increff OMS APIs V1, you can refer to Migrating from Increff v0 to v1 OMS APIs |
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 product 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 in Increff OMS | This API |
is used by |
External |
Fulfilment System (EFS) to update the absolute |
Inventory for the Products |
in Increff OMS. | 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 |
OMS to External |
Fulfilment System (EFS) | Mandatory | Increff OMS | External Fulfilment System (EFS) |
Seller Cancellation Notification from EFS | This API |
will be used by |
External Fulfilment System (EFS) to push order cancellation |
to the |
Increff OMS | Mandatory | External Fulfilment System (EFS) | Increff OMS |
Create Picklist for Orders In Increff OMS | This API is used to create a picklist |
of orders in Increff OMS | 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 |
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 |
. 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 |
. | Non-Mandatory | External Fulfilment System (EFS) | Increff OMS |
Shipment Handover Notification to EFS | This API will handover the orders in OMS and required marketplace |
. | Non-Mandatory | Increff OMS | External Fulfilment System (EFS) |
Push Return Order Expectations to EFS | This API is used to |
push the return order expectation coming from marketplaces to |
External Fulfilment System (EFS) | 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) |
Error Handling
To know details about the Http Status codes and Error handling, Please refer to Error handling in Increff Standard APIs