These APIs are for Logistics Aggregators who want to integrate with Increff RMS

• Outbound API call means RMS to Logistic Aggregator

• Inbound API call means Logistic Aggregator to RMS

APIs

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

Credentials

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 outbound calls for RMS.

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

• Orgs are created for them: org-1 and org-2.

• They both want to use a logistic aggregator - say logistic-aggregator-1.

• Then Logistic-aggregator-1 will have to provide separate credentials for org-1 and org-2.

Following credentials will be used by a logistic aggregator to make API calls to RMS. These are called inbound calls for RMS

These will be provided by the Increff team to the logistic aggregator. There will be separate credentials for each organization.

• authDomainName

  • authUsername

  • authPassword

URLs values to be provided by Logistic Aggregator

Increff RMS will configure these url on its side. Still the request response will be shared by Increff RMS.

• Generate Shipping Label URL

• Get Shipping Label URL

• Generate Return AWB URL

• Get Return AWB URL

• Get Couriers URL

URLs values provided by RMS

Client will have to configure this end point on their side. 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

Get Couriers API call

• RMS will make this API call to the logistic aggregator APIs to get the list of couriers to use. RMS will send the basic details of the order in this call.

• This priority of the couriers can also be sent in the response based on which the courier will be selected during the generate shipping label call.

Generate Shipping Label API call

• RMS will make this API call to Logistic aggregator APIs to generate the AWB and the shipping label PDF against a reference number.

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

Get Shipping Label API call

• RMS will use this API call to get the AWB and shipping label details. It will use the unique id returned by the logistic aggregator in the generate shipping label call as a request param to get these details.

Notifications

• Logistic Aggregators can push the statuses of the orders (both forward and return) to RMS.

• These notifications will be stored in RMS and forwarded to any system (proxy/client’s system).