Overview

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

• These Logistic aggregators Aggregators are integrated with various couriers (Eg-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 regions of Shipping Label Generation in MENA, EU, US and SEA regions.

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

Forward Order Workflows

Shipping Label Generation

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

• There are 3 In this workflow there are theree APIs available herewhich are listed below:

  • Create Order API - :

    • This

    creates

    • will create the order

    on

    • in the logistic aggregator

    portal

    • system.

    • The AWB

    has

    • will not

    been

    • be yet assigned to the order/shipment by Loigistic Aggregator System.

    • This is only applicable for Shiprocket and Shipway.

  • Generate Shipping Label API - : This generates API will generats the AWB and shipping label pdf ( public URL)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 and shipping label from the logistic aggregator, whose shipping label was already generatednumber 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

Return Order Creation

• Using this feature, brands Seller can generate return 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 are 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 forwarded to the client’s systems by RMS.Notifications can be of forward orders containing the information about statuses (DELIVERED, OUT_FOR_DELIVERY,CANCELLED etc) and about return orders (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.) ( insert api doc link)

• Upon receiving the notification from the logistic aggregator, they are then pushed to the client systems based on the url configured.

• 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.