Developers

Integrate The Garuda Express's REST API in your web/mobile application

1. Introduction

TGE offers to its all merchants to integrate its rest api to list, create delivery orders (pickup requests) and manage customers from their own system (could be web application or mobile application).

Please follow up below mentioned steps to integrate our rest api.

2. Get an API key

TGE only provides API key to their valid registered merchants. To get your API key please contact us.

3. API Introduction

TGE develops restfull api.

Our production base url is "https://www.thegarudaexpress.com"

You have to send your api key in header of each api requests in "apikey" header key.

3.1. Customer Address API

This api provides you to perform read/write operation for customer address.

Method	URI	Description
GET	/api/addresses	List addresses Request Example curl -X GET "https://www.thegarudaexpress.com/api/addresses" -H "accept: application/json" -H "apikey: YourApiKey"
POST	/api/addresses	Create new address Request Example curl -X POST "https://www.thegarudaexpress.com/api/addresses" -H "accept: application/json" -H "apikey: YourApiKey" -H "Content-Type: application/json" -d "{"address":{ "name": "Ram Ji", "email": "[email protected]", "mobile": "9800000000", "address": "Koteshwor, Mahadevsthan", "district": "1", "latitude": "28.3698", "longitude": "27.2544", "pinCode": "44600"}}"
GET	/api/addresses/{id}	Address detail Request Example curl -X GET "http://thegarudaexpress.test/api/addresses/3" -H "accept: application/json" -H "apikey: YourApiKey"
PATCH	/api/addresses/{id}	Updates address Request Example curl -X PATCH "https://www.thegarudaexpress.com/api/addresses/3" -H "accept: application/json" -H "apikey: YourApiKey" -H "Content-Type: application/json" -d "{"address":{ "name": "Ram G", "email": "[email protected]", "mobile": "9800000000", "address": "Koteshwor, Mahadevsthan", "district": "1", "latitude": "28.3698", "longitude": "27.2544", "pinCode": "44600"}}"

3.2. Order API

This api provides you to perform read/write operation for order.

Method	URI	Description
GET	/api/orders	List orders Default Parameters: page = 1 per_page = 10 Request Example curl -X GET "https://thegarudaexpress.com/api/orders" -H "accept: application/json" -H "apikey: YourApiKey"
POST	/api/orders	Create new order Request Example curl -X POST "https://www.thegarudaexpress.com/api/orders" -H "accept: application/json" -H "apikey: YourApiKey" -H "Content-Type: application/json" -d "{"order":{ "pickupAddress": "1", "deliveryAddress": "2", "packageWeight": "1.5", "packageTotalItems": "1", "packageOrderAmount": 1550, "pickupDate": "2020-03-12T10:44:30.535Z", "note": "Deliver in evening"}}"
GET	/api/orders/{id}	Order detail Request Example curl -X GET "https://www.thegarudaexpress.com/api/orders/1" -H "accept: application/json" -H "apikey: YourApiKey"
DELETE	/api/orders/{id}	Deletes order. Only order with status NEW could be deleted.
GET	/api/orders/track/{number}	Order track. Response will be same as of order detail API.

3.3. District

This api provides you the list of districts.

Method	URI	Description
GET	/api/districts	List districts

Developers

Integrate The Garuda Express's REST API in your web/mobile application

The Garuda Express

Quick Links

Resources

Customer Care