<aside> 🗒️ Purpose: This document is designed to guide your team through the migration process from our previous channel integration product to Increff Channel Connect. It provides a step-by-step approach to ensure a seamless transition, enabling you to switch traffic from the old API endpoints to the new ones efficiently.
P.S: The API migration is required only for Marketplace (B2C / B2B) Type channels and not for ERP, POS and OMS/EFS Type channels
</aside>
<aside> 🗒️ Outcome: By following this guide, you will be able to fully transition to Increff Channel Connect, benefiting from faster feature releases and improved integration capabilities.
</aside>
This section provides the specific details of the new API endpoints and base URLs that need to be configured in your systems.
<aside> ℹ️ Base URL : *https://channel-connect.increff.com/api*
</aside>
For your convenience, we’ve included a comparison of the older and newer endpoints below
| API Name | Old Endpoint Details | New Endpoint Details |
|---|---|---|
| Create Outward Order API | POST /orders/outward | POST /orders/outwards |
| Create Outward Order API (Using Partner Codes) | POST /orders/outward/partner-code | POST /orders/outwards/b2b |
| Update Order Properties API | PUT /orders/{orderCode} | PUT /orders/{orderCode} |
| Push Proof Of Delivery Notification | PUT /orders/{orderCode}/delivered | PUT /orders/{orderCode}/delivered |
| Customer Cancellation API | PUT /orders/{orderCode}/cancel | PUT /orders/{orderCode}/cancel |
| Update Outward Order Attributes | PUT /orders/outward/attributes/{orderCode} | PUT /orders/outward/attributes/{orderCode} |
| Create Return Order API | POST /return/return-orders | POST /returns/transforms |
| Update Returns API | POST /return/update-return-order | PUT /returns/transforms |
| Cancel Return Order Items API | PUT /return/cancel-items | POST /returns/transforms/cancel/items |
| Search Inventory API | POST /inventories/search-sku | POST /inventory/transform/search |
Ensure that your team updates these configurations in your OMS system to establish proper communication with Increff Channel Connect.
Follow below steps to migrate to the Increff Channel Connect APIs