Store Integration Guide will help you integrate with Increff Omni Standard APIs

Terminology

Inbound : API Calls from Client system to Increff system

Protocol

• REST APIs 

• JSON format

Store Integration touch-points

Push Inventory API (Inbound)

Whenever any inventory change happens, Client’s POS system will sent Increff’s OMS current absolute available to sale inventory. Other than this all other flows remain same.

Outward Sales Posting API (Outbound)

This API will call the pos with the details of sales orders which are completed in Omni. This will be triggered at a certain frequency from Omni to the channels.

Return Order Processed Notification (Outbound )

This API will call the client system with return order processing details for B2C orders.This API will be triggered only after the return order has been received and processed in Omni. 

...

Search Store Orders API

This API can be used to search the orders of a store based on the below parameters:

i) locationCode

ii) eventTypes

Some eventTypes are: OUTWARD_ORDER_COMPLETE, OUTWARD_ORDER_CANCEL, OUTWARD_ORDER_PARTIAL_CANCEL, OUTWARD_ORDER_CREATE

Update Pack on Hold Status for POS API

This API can be used to update the pack on hold status for a particular POS order in some store. By default the pack on hold status would be true, once the billing is done on POS system, the pack on hold status will be changed, and further packing workflow will be carried on.