Overview

This page consists of all the details required to migrate from v0 OMS APIs to v1 OMS APIs which external systems can use to interact with Increff OMS system

API Endpoint Details

Below mentioned is the mapping of v0 Increff OMS APIs and v1 Increff OMS APIs. Please make note of these endpoints and the updated API details which needs to be changed in External systems to interact with Increff OMS system.

To check the new API details , please route through the hyperlinks in API Name header.

API Name	Old API endpoint (v0)	New API Endpoint (v1)
Listing Creation By External Fulfilment System (EFS) API	POST /push/skuListing	POST \| /usp/listing/create
Update Inventory API	PUT /sellfast/inventories/absolute-update	PUT \| /usp/inventories/absolute
Outward Order Events to External WMS API	NA	POST \| {Client’s URL}
Seller Cancellation from External Fulfillment System (EFS) API	PUT /sellfast/order/cancel-line-items	PUT \| /usp/order/cancel
Create Picklist for Orders in Increff OMS	POST /sellfast/picklist/release	POST \| /usp/picklist/create
Add Orders to PickList in Increff OMS	POST /sellfast/picklist/add-orders/id	POST \| /usp/picklist/add-order
Pack & Get Pack Details from Increff OMS	POST /sellfast/pack/combined/{orderId}	POST \| /usp/order/pack
Create Manifest in Increff OMS	NA	POST \| /usp/ manifest
Handover Notification to EFS	POST /sellfast/handover	POST \| /usp/ handover
Combined Manifest and Handover	POST /sellfast/manifest/combined	POST /cims/push/usp/handover/combined
Push Return Order Expectations to EFS	NA	POST \| {Client’s URL}
Return Order Processing Update	NA	POST \| /usp/return

Steps of Migration

Updation of Endpoints & BaseUrl

External system should update the API endpoints in their system which are mentioned above.
BaseUrl of Increff OMS system will be shared by Increff Customer success team during the onboarding process to new Increff OMS APIs.

Updation of Authentication Credentials

External system should update the API authentication credentials which are used to communicate with Increff OMS system.
Credentials should be sent in headers while making the API request as stated in the example below.

authUsername:Increff.user
authPassword:Increff@user1

The credentials of the production environment will be shared by Increff Customer success team during the onboarding process to new Increff OMS APIs.

Testing Process

Post the configuration of above-mentioned steps in the External system, testing can be done using Increff Simulator environment (ASIM) by configuring the necessary details.

Old API endpoints are backward compatible untill the testing and onboarding to new OMS APIs will not be completed

Migrating from Increff v0 to v1 OMS APIs