ShiprocketAPI

Document and API Usage Guidelines

  • Our APIs use the basic HTTP request codes: POST, GET, PATCH, & PUT.

  • You can select the required response and request code language by selecting it from the drop-down menu on the top.

  • You can import and test all our full API collection in the Postman app by clicking on the ' Run in Postman' button.

  • Note: Any requests made using the valid API credentials will affect the real-time data in your Shiprocket account.

  • Authorization: Bearer

  • All the APIs are provided with their appropriate example requests and responses for successful and failed calls. The example definitions are:

    • Successful Call: The API call was correct.

    • Invalid Data: The data entered was incorrect.

    • Missing Fields: Some of the required fields are missing.

    • Wrong Format: There is a syntax error in the code.

  • Note: The order_id defined by you at the time of order creation is your reference order id. The order_id returned in the API response is the Shiprocket order id. All our APIs will use this Shiprocket order id to access your created order unless stated otherwise.