Skip to end of banner
Go to start of banner

Logistic Aggregator Solution

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Overview

  • RMS is integrated with Logistic Aggregators like Clickpost, Shiprocket and Shipway for Shipping Label Generation, Return Order creation, Notification updates etc. through API integration.

  • These Logistic Aggregators are integrated with various Courier Partners like Delhivery,Bluedart etc. using their API endpoints.

  • For the Clickpost and Shipwat Integration, RMS is integrated with their International APIs as well.
    These APIs facilitate Shipping Label Generation in MENA, EU, US and SEA regions.

  • RMS also provides its RMS Magic APIs, using which any Logistic Aggregator System can integrate with RMS endpoints to use Standard Workflows of RMS.

Forward Order Workflows

Workflow Step

API Touchpoint

Summary

1

Create Order API

Creation of Orders / Shipments from RMS to Logistic Aggregator System

2

Generate Shipping Label API

Sending a Notification from RMS to Logistic Aggregator System for allocation of Courier Partner for the Shipment and retrieving Shipment level details like Shipment Number, AWB Number , Courier partner name etc.

3

Get Shipping Label API

Fetching the Shipping Label Document from Logistic Aggregator System

4

Forward Orders Notifications Webhook

Receiving Delivery Notifications like OUT FOR DELIVERY, DELIVERED etc. for forward orders from Logistic Aggregator to RMS System

Shipping Label Generation

  • Using this feature, the Seller can generate AWB and Shipping Label Document for the shipments of Brand.com or Webshops like Shopify and Magento.

  • In this workflow there are three APIs available which are listed below:

    • Create Order API:

      • This will create the order in the logistic aggregator system.

      • The AWB will not be yet assigned to the order/shipment by Loigistic Aggregator System.

      • This is only applicable for Shiprocket and Shipway.

    • Generate Shipping Label API: This API will generats the AWB and Shipping Label PDF (Public URL) in Logistic Aggregator System after the Courier partner is assigned to the shipment.

    • Get Shipping Label API: This API fetches the AWB number details and Shipping Label Document which was generated in previous step from the Logistic Aggregator System.

Multiple Shipping Label Configurations

  • Just like how multiple invoice configurations are possible, multiple shipping label configurations are also possible.

  • They will be identified with the help of logistic account aliases which are configured on RMS UI.

  • This logistic account alias will then be passed in the request payload of the API call which will be used to identify the logistic configuration to be used.

Forward Notification Push

  • Delivery Notifications for Forward Orders can be sent by Logistic Aggregator System in case the Notifications are enabled and Webhook details are configured on Logistic Aggregator System UI.

  • These notifications once received can be forwarded to any External systems by Increff Standard APIs based on the Webhook Endpoint URL configured in RMS User Interface.

  • Notifications can be of statuses mentioned below

    • DELIVERED

    • OUT_FOR_DELIVERY

    • CANCELLED

  • The URL where notifications are to be pushed and the credentials to be used in the notification API call can be configured on the RMS UI.

Return Order Workflows

Workflow Step

API Touchpoint

Summary

1

Generate Return AWB API

Sending notification to Logsitic Aggregator system to generate AWB for Return Shipment

2

Get Return AWB API

Retrieve details of Return Shipments like Courier Partner name, AWB number, Return Shipment Number etc.

3

Return Orders Notifications API

Receiving Shipment notifications like RETURN CREATED, RETURN PICKED UP, IN TRANSIT for Return orders from Logistic Aggregator to RMS System

Return Order Creation

  • Using this feature, Seller can generate Return AWB for a return order which is created on Brand.com or Standard Webhops like Magento or Shopify after the Return Order expectation is first pushed to Increff Standard APIs (Omni Magic APIs)

  • There are 2 APIs available here:

    • Generate Return AWB API: This creates the return order and generates return AWB on the logistic aggregator portal.

    • Get Return AWB API: This fetches the return AWB from the logistic aggregator

  • The same multiple configurations for Logistic Aggregator Credentials can be used here as well as mentioned it for Forward Order Creation Workflow.

Return Notification Push

  • Notifications for Return Shipments will be sent by Logistic Aggregators to RMS system case the Notifications are enabled and Webhook details are configured on Logistic Aggregator System UI.

  • These notifications once received can be forwarded to any External systems by Increff Standard APIs based on the Webhook Endpoint URL configured in RMS User Interface.

  • Notifications for Return Orders can be of Statuses: RTO, RETURN_PICKED_UP etc.

  • No labels