Versions Compared

Key

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

...

  • Push Notification URL

Flows

Table of Contents
minLevel1
maxLevel7

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.

...

  • RMS will make this API call to logistic 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.

...

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

...