Download OpenAPI specification:Download
NOTE This is documentation for version 1 of Telyport apis. You should not use this for any new development. Please use the latest version instead to stay up to date. This version of apis will be deprecated by the end of 2022.
About Telyport
We are an in-city delivery as a service platform that connects couriers with customers and businesses to empower time sensitive delivery. We apply technology to create a reliable, efficient, scalable and cost-effective hyperlocal delivery infrastructure for locals and businesses.
Features
Package Size
Telyport gives you the ability to select package size, which allows you to pay for what you use and also, this lets us pool certain orders to reduce overall shipment cost
small: A Package that fits in a shoe box and weighs less than 3 kgs. Approximate measurement 34 X 32 X 10 cms.
medium: A Package that fits in a hand bag and weighs less than 7 kgs. Approximate measurement 34 X 32 X 20 cms.
large: A Package that fits in a Laundry bag and weighs less than 15 kgs. Approximate measurement 42 X 36 X 37 cms.
Ship Type
Telyport gives you the ability to select Now (next available agent), Rush (in 2 hrs), Xpress (in 4 hrs) or Standard (by Next Day) delivery types by user.
now: When you need something delivered right away, Telyport will handle your delivery at priority.
rush: When you don’t have a minute to spare, Telyport will handle your delivery in 2 hour.
xpress: Need something delivered same day? Choose Telyport Express and our delivery team will get it to you in 4 hours.
standard: Next day delivery is guaranteed when you choose Telyport Standard. Choose Telyport Standard when you need next day delivery.
SEND or RECEIVE
Whether you are an individual or a business, choose a type of delivery that fits your need. By using Telyport you either SEND a package to a Customer or RECEIVE a package from the customer.
Pricing
Our pricing model is dynamic which depends on Package Size, Ship Type and Distance.
Business Charges
Telyport can handle your payments with your customers by charging a handling fee of 3% on your business charges.
Contact
If you want to use Telyport APIs, please drop an email at [email protected] and we will get back to you.
Bulk order API allows you to perform bulk order creation in Telyport. You can also modify, cancel or view them
This is the integration environment provided by telyport
This environment will allow you to create orders that will actually be considered and processed by the company
https://telyport.com/api/
Fields with * are mandatory.
All requests to Business API must be made via HTTPS. Only GET and POST request methods are supported. POST requests should send all parameters in the body of the request in JSON format and UTF-8 encoding; GET requests should send parameters in the query string.
All requests must include a HTTP header ApiKey
Secret auth token. Must be sent as a HTTP header.
API responses are in JSON format and UTF-8 encoding.
Successful responses will have HTTP code 200 (OK)
Create bulk orders
Array of objects |
{- "data": [
- {
- "fromAddress": {
- "address": "202, 1st floor, RK avenue, Bangalore 560001",
- "lat": 2.00002,
- "lng": 2.010001,
- "house_no": "202, 1st floor",
- "landmark": "Near Sweet Shop"
}, - "toAddress": {
- "address": "202, 1st floor, RK avenue, Bangalore 560001",
- "lat": 2.00002,
- "lng": 2.010001,
- "house_no": "202, 1st floor",
- "landmark": "Near Sweet Shop"
}, - "shipType": "standard",
- "pack": {
- "type": "medium",
- "isFragile": false,
- "isSecure": false,
- "itemTypes": [
- "Books & Stationery",
- "Laundry"
], - "no_of_items": 2,
- "weight": 14
}, - "sender": {
- "name": "Suresh",
- "mobileNumber": "+911234567890"
}, - "receiver": {
- "name": "Suresh",
- "mobileNumber": "+911234567890"
}, - "scheduledTimestamp": 0,
- "deliveryChargesPayableAt": "Sender",
- "collectionsAmount": 100.25,
- "collectionsAmountPayableAt": "Sender",
- "tpCommissionsAmountPayableAt": "Sender",
- "paymentMode": "Cash",
- "orderType": "SEND",
- "instructions": "Gift wrap the item"
}
]
}
[- {
- "status": "OK",
- "id": "INS12345567789"
}
]
{- "message": {
- "orders": [
- {
- "status": "OK",
- "id": "INS0123154324"
}
], - "orderId": "bulk-order-asdas",
- "user": "ckvasd0l3a32mnYrMi326TvZagnhf1",
- "timeCreated": "2019-01-21T12:44:17.141Z"
}
}
Cancel an order by providing order ID
id required | string Order id of order to be cancelled |
{- "id": "string"
}
{- "type": "OK",
- "message": "Order was successfully cancelled"
}