Versions Compared

Version Old Version 11 New Version Current
Changes made by

Alaf Azam Khan

Suprit Bhattacharjee

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel1
maxLevel7

These APIs are for Logistics Aggregators who want to integrate with Increff RMS. Table of ContentsminLevel1maxLevel7

  • Outbound API call means RMS to Logistic Aggregator

  • Inbound API call means Logistic Aggregator to RMS

APIs

Child pages (Children Display)

Note: The logistic aggregator can have same url for Generate Shipping Label for Forward and Return Orders, or they can have the same URL for them. Same is the case for Get Shipping Label.

Setup

  • Contact increff support Increff Support to get yourself registered as a Logistic aggregator.

  • A unique logistic aggregator name would need to be added to RMS.

  • Unique logistic aggregator name would be passed in the request body by RMS while making API calls to the logistic aggregator and also the logistic aggregator would pass this field in its request body while making API calls to RMS.

...

Credential Headers that will be used by RMS while making API calls to Logistic Aggregator will be provided by logistic aggregator on an organisation level. These are called outbond outbound calls for RMS.

For example, there are 2 increff omni clients who want to use RMS.

...

Client will have to configure this end point on their side and provide us the URL so we can make apis calls. This URL will be used by the logistic aggregator to make the corresponding calls to RMS.

  • Push Notification URL

Brief overview of Forward Order Flow

...

  • RMS will make this API call to Logistic aggregator APIs to generate the AWB and the shipping label PDF against a reference numberorderNumber and, if required, a shipmentCode.

    • Shipment Code will be passed in cases where an order can have multiple shipments.

  • From this list of couriers fetched in the Get Courier Recommendation API, RMS will choose the courier with the highest priority and will pass it in the payload of the generate shipping label call.

  • The logistic aggregator will generate the AWB and shipping label against this courier passed. It will also return a unique id by which the logistic aggregator will identify the order.

...