Standard APIs

Introduction

RMS provides a set of APIs that can help any external system to do the following things:

  • Compute Tax Details

  • Generate Invoice PDFs

  • Generate AWB and Shipping Label through logistic aggregators like Clickpost and Shiprocket

Protocols

  • REST Synchronous calls

Format

  • JSON format

API Invocation

The following headers need to be provided.

  • authDomainName

  • authUsername

  • authPassword

The “authUsername” and “authPassword” headers and the username and password of a “minions.integration” type of user. A user with “minions.integration” role can be created on account server. //TODO: Elaborate on credentials and account server

Http Status Codes

  • 200: In case of success

  • 400: In case of bad request data

  • 401: In case of authentication / authorization failure

  • 404: In case of url does not exist

  • 500: In case of Internal Server Error