Bulk Order API (1.0.0)

Download OpenAPI specification:Download

Introduction



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

  • On Time Delivery & Real Time Tracking: We value your time. Telyport allows you to track the activities, real time location of the agents and provide your valuable feedback
  • Budget Friendly : Our delivery platform saves you money whether you are a local or a business. You only pay for what you use. Request your delivery now, prices as low as ₹ 15.
  • Secure Delivery : You will be regularly notified of key order status changes. Our agent will collect Proof of Delivery such as Signature and Photos of the package.

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.

Integration


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.

Requests


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

ApiKey string

Secret auth token. Must be sent as a HTTP header.

Responses


API responses are in JSON format and UTF-8 encoding.

Successful responses will have HTTP code 200 (OK)



API Requests


Create order

Create bulk orders

Request Body schema: application/json

Create bulk orders

Array of objects

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Order

Get all the bulk orders

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Bulk order, order list by history

path Parameters
id
required
string

Bulk order ID

Responses

Response samples

Content type
application/json
{
  • "message": {
    }
}

Get individual order details

path Parameters
id
required
string

Order ID

Responses

Response samples

Content type
application/json
{ }

Order Modification

Cancel Order

Request Body schema: application/json

Cancel an order by providing order ID

id
required
string

Order id of order to be cancelled

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "type": "OK",
  • "message": "Order was successfully cancelled"
}