Magento Integration

Overview

Magento Integration seamlessly connects your Magento online store with our Order Management System (OMS), automatically syncing product info, inventory, orders, and customer data. This eliminates manual errors, gives you real-time visibility and improves your customer experience of magento store-front.

Workflows Breakdown

Workflow	Description	Supported	Remarks
Inventory Sync	Update inventory of a specific SKU on Magento	Yes
Forward Orders Sync	Fetch all the orders that match specified search criteria(based on filters for specific status which are configured during client onboarding and created_at time)	Yes	The required by time of Increff OMS(SLA) is set as 2 days from the time at which the order is created at channel.
Routing & Splitting		Yes	In case of multi warehousing all the orders will be split and routed as no location level details are received from marketplace
Forward Pending Order Sync	Fetch all the orders that match specified search criteria(based on filters for specific status which are configured during client onboarding)	Yes
Forward Order Acknowledgement	Change order status to processing on Magento frontend	Yes
Create Shipment	Order gets created on logistic aggregator as well as shipment creation on Magento. Using Courier Aggregators systems like: Clickpost Shiprocket Shipway Eshipz	Yes	The customer address details will not be changed after order creation. Dimensions scanned using packing are sent to logistic aggregator. If absent, default dimensions are sent(for Shiprocket: L,B,H=1 unit, W=0.5 unit and Others: L=18 unit, B=12 unit, H=10 unit, W=500 unit).
Create Invoice	Create Invoice on Magento	Yes	Shipping labels and invoices are generated by Increff The total discount can include the store credit if it is present in `amstorecredit_amount` inside the extension_attributes of the order response payload.
Get Shipment	Get Shipment details from Magento	Yes	The cash on delivery fee is added to the shipping charge in case it is present in the field `cash_on_delivery_fee` inside the extension_attributes of order. The PDF format supported is A4 size.
Manifest	NA	No
Handover	The order is handed over to the delivery partner marking the order complete at magento panel	Yes	No limits in the integration layer
Forward Order Customer Cancellation	Fetch all the orders that match specified search criteria(based on filters for specific status which are configured during client onboarding and updated_at time)	Yes
Forward Order Seller Cancellation	To cancel order from OMS on the Magento panel.	Yes
Replacement/Exchange Order Sync	NA	No
Return Order Sync	Call to be made to Increff system to create returns for a specific forward order	Yes	Return can be created via Magento (Customer return) and logistic aggregator (Return to origin) If the frontend doesn’t have the tracking details, then the tracking details will be fetched from logistic aggregator (extra details are required in return creation in that case)
Return processed notification updates	Acknowledgement call made by Increff system to the specific API when an order is being processed	Yes	In case of return being created via logistic aggregator, Magento frontend will receive return received notification when the return is received in the warehouse
Return Order Cancellation	Call to be made to Increff system to cancel a return order item	Yes
Shipment notifications	Push shipment notifications to Magento after being dispatched from warehouse	Yes

Additional Information

Workflow	API Rate Limit	Batch size of API request (if supported)	Frequency (as per standard configuration)

Workflow	API Rate Limit	Batch size of API request (if supported)	Frequency (as per standard configuration)
Inventory Sync	NA	1 SKU per API call	2 sec
Forward Orders Sync	NA	100 orders per API call	5 sec
Forward Order Customer Cancellation	NA	100 orders per API call	5 min
Forward Pending Order Sync	NA	NA	1 hr
Forward Order Acknowledgement	NA	NA	1 min

For details about Magento APIs you can refer to Magento API details

Visualizing the Flow

Marketplace-Specific Details

Property	Values

Property	Values
Cancellation Reasons	Customer cancellation Payment processing by customer
Return Reasons	Customer return in case of Size, colour etc mismatch RTO in case of three delivery attempt failure RTO in case of courier rejection
Replacement Orders	Replacement orders are treated as new orders. No link with the original order
Cancellation Support	Customer cancellation is supported till Handover state at marketplace Seller cancellation is supported till packing
API Performance	Average time for 1000 SKUs inventory update: 1300 sec

Information required for Channel Onboarding in Increff

Configuration Parameter	Remarks

Configuration Parameter	Remarks
Status	List of statuses on which order has to be fetched and cancelled orders have to be fetched
Store front URL	Frontend url using which calls will be made to Magento frontend
Store front Username	Username used to login to the frontend panel
Store front Password	Password needed to login to the frontend panel
Invoice Logo	Logo to be printed in the invoice
Invoice prefix	Invoice prefix to be used to generate the invoice number
Logistic aggregator details	The logistic aggregator being used by the client and the account details of the logistic aggregator the client is going to be used
Notification URL	The url on which shipment/return notification are to be relayed(if notifications are going to be consumed by the frontend)
Return Ack URL	The url on which return acknowledgment is to be relayed(if acknowledgment is to be consumed by the frontend)

Estimated Go Live Timeline

1 Week

Additional Resources

FAQs

Question: What is the Frontend URL to be shared?
Answer: The frontend URL to be shared is the one using which the authorisation key can be fetched using API. It shouldn’t be the admin backend url.

Question: For example, if a test order is placed and cancelled after 5-6 hours from the Magento System but by the time the invoice generation has already happened, then how can we handle such situations?

Answer: These kind of cancellations can get stuck. Cancellation should be sent till invoice generation.

Question: Also, in case of prepaid order, due to some reason the payment did go through after 1-2 hours and after some time the status of the order is updated. Then will that order be pulled in the Increff system or not? This question has been raised as the Increff team mentioned that the orders are pulled real time.

Answer: Increff will be able to pull the orders on the status update of any order. But client should share the list of statuses along with description which are used for the orders(this should also include any new status in which an order moves when a credit memo is generated). Increff need to do mapping of those status at our end to pull orders based on status & status update.

Question: Who will be sending the notifications (email & SMS) after the order is punched?

Answer: The notifications after receiving from Shiprocket will be passed to Magento by Increff. But Rest Emails and notifications to customers should be managed by Shiprocket.

Question: How will the return orders be handled in Magento integration?

Answer:

Returns can be created either via Logistic Aggregator ie, Shiprocket Interfaces, or via API integration through Magento.
Refer to the API to create return orders at Omni at Magento: Create Return Order.
We would recommend to get the return orders created via Shiprocket. Shiprocket sends Increff the RTO_Delivered, AWB_Generated and Return_Order_Placed notifications, and Increff RMS creates the return orders in WMS based on these notifications.

Question: What will be the shipping charges applicable as the realtime shipping charges cannot be pulled from Shiprocket?

Answer: There is no realtime time tracking in Magento. We will only process if magento will send us the shipping charge in shipping_incl_tax field.

Question: How are the end customers supposed to track the orders?

Answer:

End customers can track orders either on the Magento front end or via SMS updates sent by Shiprocket.

Forward Order tracking

Increff sends API calls to Magento during order acknowledgment (after the order is created and allocated), packing, and dispatch.
During order acknowledgment, the order status in Magento changes from Pending to Processing.
The order status updates to Completed in Magento upon handover/dispatch updates from Increff.
Increff forwards notifications from Shiprocket to Magento, including updates like Pickup, Out for Delivery, In Transit, Delivered, etc.

Return Order tracking

For returns, Increff sends notifications such as Return Order Placed, Out for Picking, Picked, In Transit, Return Cancellation, Shipping AWB, and QC Failed, after receiving them from Shiprocket.
Based on these notifications, Magento can display tracking information on the front end, while Shiprocket sends SMS/tracking details to customers.