Ezyslips is a platform where store's owner can import their store's orders data from any e-commerce stores like Shopify, Magento, Opencart, CS-cart, Shipway to our platform Ezyslips.com Store's owner can also fetch their order from Marketplace like Amazon, eBay, Flipkart, Paytm, Shopclues and many other stores to our platform Ezyslips.com. As a result, we are continuously providing developer resources to build custom integrations with:
There are two ways to integrate with EzySlips:
Ezyslips integrate a range of courier services with your eCommerce platform. Integrate your selected courier under order set up tab using Courier Integration.
Ezyslips integrate your store with your eCommerce platform. Integrate your selected store under order set up tab using Store Integration.
Using Ezyslips API, Developers can interface their system with Ezyslips Platform. The API is used to automate tasks and processing orders fast and efficiently.
The EzySlips API uses Basic HTTP authentication. Use your Ezyslips Email as the username and License Key as the password. You can find your License Key as the password from Ezyslips > Store Setup > Store Information.
The Authorization header is constructed as follows:
PHP example:
$token = base64_encode("email:License key");
$authHeaderString = 'Authorization: Basic ' . $token;
| Status Code | Response | Description |
|---|---|---|
| 201 | Created | The request is successful and an order is created. |
| 400 | Bad Request | The request is missing required parameters. |
| 401 | Unauthorized | Authentication failed. |
| 403 | Forbidden | Access denied. |
| 404 | Not Found | Resource is not found. |
| 405 | Method not allowed | Requested method is not supported for the specified resource. |
| 500 | Internal Server Error | Ezyslips has encountered an error. |
Ezyslips provides these API to manage orders:
Ezyslips provides PUSH API to interact with Ezyslips system. This API Restful that enables merchants to PUSH orders in Ezyslips system.
The API creates an Order on Ezyslips. The body of this request should specify the following parameters:
Parameters:
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| order_id | Merchant's Order ID | Yes | string |
| products | Products belonging to order | Yes | json |
| payment_type | P - Prepaid, C - COD | Yes | string |
| Customer email | Yes | string | |
| store_code | Order belong to which online store | No | integer |
| discount | Total discount for order (INR) | No | decimal |
| shipping | Total shipping amount for order (INR) | No | decimal |
| order_total | Grand total of order | No | string |
| billing_address | Billing address | No | string |
| billing_address2 | Billing address - Line 2 | No | string |
| billing_city | City(billing address) | No | string |
| billing_state | State(billing address) | No | string |
| billing_country | Country (billing address) | No | string |
| billing_firstname | First Name(billing address) | No | string |
| billing_lastname | Last Name(billing address) | No | string |
| billing_phone | Phone (billing address) | No | string |
| billing_zipcode | Zipcode (billing address) | No | string |
| shipping_address | Shipping address | No | string |
| shipping_address2 | Shipping address - Line 2 | No | string |
| shipping_city | City(Shipping address) | No | string |
| shipping_state | State(Shipping address) | No | string |
| shipping_country | Country (Shipping address) | No | string |
| shipping_firstname | First Name(Shipping address) | No | string |
| shipping_lastname | Last Name(Shipping address) | No | string |
| shipping_phone | Phone (Shipping address) | No | string |
| shipping_zipcode | Zipcode (Shipping address) | No | string |
| order_weight | Order weight (grams) | No | float |
| box_length | Box length (cms) | No | integer |
| box_breadth | Box breadth (cms) | No | integer |
| box_height | Box height (cms) | No | integer |
| order_date | Date of purchase (yyyy-mm-dd hh:mm:ss) | No | Date |
URL
POST https://Ezyslips.com/api/v2orders
Headers
| Content-Type | application/json |
| Authorization | < Enter your $token (which is described in authentication section) > |
{
"order_id":"TESTAPRIL008",
"store_code":"0",
"products":[
{
"product":"My Test Product 5",
"price":"200",
"product_code":"JSN909"
},
{
"product":"My Test Product 23",
"price":"120",
"product_code":"JSN9999",
"amount":"5"
}
],
"discount":"10",
"shipping":"30",
"order_total":"1200",
"payment_type":"P",
"email":"customer@email.com",
"billing_address":"#321",
"billing_address2":"MG Road",
"billing_city":"Gurgaon",
"billing_state":"Haryana",
"billing_country":"India",
"billing_firstname":"John",
"billing_lastname":"Doe",
"billing_phone":"9999999999",
"billing_zipcode":"122001",
"shipping_address":"#321",
"shipping_address2":"MG Road",
"shipping_city":"Gurgaon",
"shipping_state":"Haryana",
"shipping_country":"India",
"shipping_firstname":"John",
"shipping_lastname":"Doe",
"shipping_phone":"9999999999",
"shipping_zipcode":"122001",
"order_weight":"110",
"box_length":"20",
"box_breadth":"15",
"box_height":"10",
"order_date":"2017-03-2018 12:05:00"
}
{"success": 1,"error": "","message": "Order has been added successfully."}
{"message": "Unauthorized","status": 401}
Ezyslips provides GET API to interact with Ezyslips system. This API Restful that enables merchants to GET orders from Ezyslips system.
Ezyslips provide you access to get your order from Ezyslips system. In this, you can get orders in chunks of 100 at use of URL for following status:
Order Status Description
| Status | Description |
|---|---|
| A | Processing |
| E | Manifested |
| G | Dispatched |
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
URL
GET https://ezyslips.com/api/getorders
$curl = curl_init();
$email='nisha12345@gmail.com';
$key='license_key';
$token=base64_encode($email.':'.$key);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://ezyslips.com/api/getorders",
CURLOPT_RETURNTRANSFER => true,v
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
'Authorization: Basic '. $token,
"cache-control: no-cache"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
"success": 1,
"error": "",
"message": [
{
"order_id": "1001",
"discount": "0.00",
"payment_id": "6",
"b_firstname": "Hitesh",
"b_lastname": "Kumar",
"b_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"b_address_2": "Gurgaon",
"b_city": "Gurgaon",
"b_country": "IN",
"b_state": "Haryana",
"b_zipcode": "122001",
"b_phone": "+9149416872993",
"s_firstname": "Hitesh",
"s_lastname": "Kumar",
"s_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"s_address_2": "Gurgaon",
"s_city": "Gurgaon",
"s_state": "Haryana",
"s_country": "IN",
"s_zipcode": "122001",
"s_phone": "+9149416872993",
"store_code": "1",
"weight": "0",
"box_length": "0",
"box_breadth": "0",
"box_height": "0",
"email": "hiteshkumar148@gmail.com",
"status": "E",
"invoice_number": "1001",
"name": "Bluedart",
"tracking_number": "74382378",
"pickup_address": {
"contact_person_name": "Onjection Solution",
"title": "Courier Address",
"address_1": "Gurgaon",
"address_2": "Huda Market",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122001"
},
"return_address": {
"contact_person_name": "Onjection Solution",
"title": "Aramex Courier Address",
"address_1": "Gurgaon",
"address_2": "Huda Market",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122001"
},
"order_date": "2018-12-06 03:03:32",
"ezyslip_order_id": "2737181",
"products": [
{
"product": "T-Shirt",
"product_code": "",
"price": "990.00",
"amount": "1"
}
]
}
}
{"message": "Not Found","status": 404}
Ezyslips provide you access to get your order from Ezyslips system using an orderid filter
URL
GET https://ezyslips.com/api/getorders?orderid=
Parameter
| Field Name | Description | Data Type | orderid | Merchant's Order ID | string |
|---|
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init();
nisha12345@gmail.com
$key='license_key';
$token=base64_encode($email.':'.$key);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://ezyslips.com/api/getorders?orderid=1001",
CURLOPT_RETURNTRANSFER => true,v
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
'Authorization: Basic '. $token,
"cache-control: no-cache"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
"success": 1,
"error": "",
"message": [
{
"order_id": "1001",
"discount": "0.00",
"payment_id": "6",
"b_firstname": "Hitesh",
"b_lastname": "Kumar",
"b_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"b_address_2": "Gurgaon",
"b_city": "Gurgaon",
"b_country": "IN",
"b_state": "Haryana",
"b_zipcode": "122001",
"b_phone": "+9149416872993",
"s_firstname": "Hitesh",
"s_lastname": "Kumar",
"s_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"s_address_2": "Gurgaon",
"s_city": "Gurgaon",
"s_state": "Haryana",
"s_country": "IN",
"s_zipcode": "122001",
"s_phone": "+9149416872993",
"store_code": "1",
"weight": "0",
"box_length": "0",
"box_breadth": "0",
"box_height": "0",
"email": "hiteshkumar148@gmail.com",
"status": "E",
"invoice_number": "1001",
"name": "Bluedart",
"tracking_number": "74382378",
"pickup_address": {
"contact_person_name": "Onjection Solution",
"title": "Courier Address",
"address_1": "Gurgaon",
"address_2": "Huda Market",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122001"
},
"return_address": {
"contact_person_name": "Onjection Solution",
"title": "Aramex Courier Address",
"address_1": "Gurgaon",
"address_2": "Huda Market",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122001"
},
"order_date": "2018-12-06 03:03:32",
"ezyslip_order_id": "2737181",
"products": [
{
"product": "T-Shirt",
"product_code": "",
"price": "990.00",
"amount": "1"
}
]
}
}
{"success": "","error": "1","message": "No order found"}
Ezyslips provide you access to get your order from Ezyslips system. In this, you can get single order using status.
URL
GET https://ezyslips.com/api/getorders?status=
Parameter
| Field Name | Description | Data Type | status | Order status (O, A, E, G) | string |
|---|
Order Status Description
| Status | Description |
|---|---|
| O | New Orders |
| A | Processing |
| E | Manifested |
| G | Dispatched |
* Orders can be searched by Multiple status using a literal ' , ' .
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init();
nisha12345@gmail.com
$key='license_key';
$token=base64_encode($email.':'.$key);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://ezyslips.com/api/getorders?status=O,E",
CURLOPT_RETURNTRANSFER => true,v
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
'Authorization: Basic '. $token,
"cache-control: no-cache"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
"success": 1,
"error": "",
"message": [
{
"order_id": "1002",
"discount": "0.00",
"payment_id": "6",
"b_firstname": "Hitesh",
"b_lastname": "Kumar",
"b_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"b_address_2": "Gurgaon",
"b_city": "Gurgaon",
"b_country": "IN",
"b_state": "Haryana",
"b_zipcode": "122001",
"b_phone": "+9149416872993",
"s_firstname": "Hitesh",
"s_lastname": "Kumar",
"s_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"s_address_2": "Gurgaon",
"s_city": "Gurgaon",
"s_state": "Haryana",
"s_country": "IN",
"s_zipcode": "122001",
"s_phone": "+9149416872993",
"store_code": "1",
"weight": "0",
"box_length": "0",
"box_breadth": "0",
"box_height": "0",
"email": "hiteshkumar148@gmail.com",
"status": "O",
"invoice_number": "1001",
"name": "null",
"tracking_number": "null",
"pickup_address": "null",
"return_address": "null",
"order_date": "2018-12-06 03:03:32",
"ezyslip_order_id": "2737182",
"products": [
{
"product": "T-Shirt",
"product_code": "",
"price": "990.00",
"amount": "1"
}
]
}
}
{
"order_id": "1001",
"discount": "0.00",
"payment_id": "6",
"b_firstname": "Hitesh",
"b_lastname": "Kumar",
"b_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"b_address_2": "Gurgaon",
"b_city": "Gurgaon",
"b_country": "IN",
"b_state": "Haryana",
"b_zipcode": "122001",
"b_phone": "+9149416872993",
"s_firstname": "Hitesh",
"s_lastname": "Kumar",
"s_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"s_address_2": "Gurgaon",
"s_city": "Gurgaon",
"s_state": "Haryana",
"s_country": "IN",
"s_zipcode": "122001",
"s_phone": "+9149416872993",
"store_code": "1",
"weight": "0",
"box_length": "0",
"box_breadth": "0",
"box_height": "0",
"email": "hiteshkumar148@gmail.com",
"status": "E",
"invoice_number": "1001",
"name": "Bluedart",
"tracking_number": "74382378",
"pickup_address": {
"contact_person_name": "Onjection Solution",
"title": "Courier Address",
"address_1": "Gurgaon",
"address_2": "Huda Market",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122001"
},
"return_address": {
"contact_person_name": "Onjection Solution",
"title": "Aramex Courier Address",
"address_1": "Gurgaon",
"address_2": "Huda Market",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122001"
},
"order_date": "2018-12-06 03:03:32",
"ezyslip_order_id": "2737181",
"products": [
{
"product": "T-Shirt",
"product_code": "",
"price": "990.00",
"amount": "1"
}
]
}
}
{"success": "","error": 1,"message": "Wrong status found"}
Ezyslips provide you access to get your order from Ezyslips system. In this, you can get orders using Date.
URL
GET https://ezyslips.com/api/getorders?date_from=&date_to=
Parameter
| Field Name | Description | Data Type |
|---|---|---|
| date_from | Get Orders from date (yyyy-dd-mm hh:mm:ss) | datetime |
| date_to | Get Orders to date (yyyy-dd-mm hh:mm:ss) | datetime |
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init();
nisha12345@gmail.com
$key='license_key';
$token=base64_encode($email.':'.$key);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://ezyslips.com/api/getorders?date_from=2018-11-01&date_to=2018-12-01",
CURLOPT_RETURNTRANSFER => true,v
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
'Authorization: Basic '. $token,
"cache-control: no-cache"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
"success": 1,
"error": "",
"message": [
{
"order_id": "1001",
"discount": "0.00",
"payment_id": "6",
"b_firstname": "Hitesh",
"b_lastname": "Kumar",
"b_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"b_address_2": "Gurgaon",
"b_city": "Gurgaon",
"b_country": "IN",
"b_state": "Haryana",
"b_zipcode": "122001",
"b_phone": "+9149416872993",
"s_firstname": "Hitesh",
"s_lastname": "Kumar",
"s_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"s_address_2": "Gurgaon",
"s_city": "Gurgaon",
"s_state": "Haryana",
"s_country": "IN",
"s_zipcode": "122001",
"s_phone": "+9149416872993",
"store_code": "1",
"weight": "0",
"box_length": "0",
"box_breadth": "0",
"box_height": "0",
"email": "hiteshkumar148@gmail.com",
"status": "E",
"invoice_number": "1001",
"name": "Bluedart",
"tracking_number": "74382378",
"pickup_address": {
"contact_person_name": "Onjection Solution",
"title": "Courier Address",
"address_1": "Gurgaon",
"address_2": "Huda Market",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122001"
},
"return_address": {
"contact_person_name": "Onjection Solution",
"title": "Aramex Courier Address",
"address_1": "Gurgaon",
"address_2": "Huda Market",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122001"
},
"order_date": "2018-12-06 03:03:32",
"ezyslip_order_id": "2737181",
"products": [
{
"product": "T-Shirt",
"product_code": "",
"price": "990.00",
"amount": "1"
}
]
}
}
{"success": 1,"error": "","message": "Wrong date format"}
Ezyslips provide you access to get your order from Ezyslips system. In this you can get orders using Page.On one page, You can get 100 orders.Pages can be accessed using counting all orders.
URL
GET https://ezyslips.com/api/getorders?page=
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init();
nisha12345@gmail.com
$key='license_key';
$token=base64_encode($email.':'.$key);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://ezyslips.com/api/getorders?page=2",
CURLOPT_RETURNTRANSFER => true,v
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
'Authorization: Basic '. $token,
"cache-control: no-cache"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{
"success": 1,
"error": "",
"message": [
{
"order_id": "1001",
"discount": "0.00",
"payment_id": "6",
"b_firstname": "Hitesh",
"b_lastname": "Kumar",
"b_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"b_address_2": "Gurgaon",
"b_city": "Gurgaon",
"b_country": "IN",
"b_state": "Haryana",
"b_zipcode": "122001",
"b_phone": "+9149416872993",
"s_firstname": "Hitesh",
"s_lastname": "Kumar",
"s_address": "#815, Street no. 98, Gurgaon, Gurgaon",
"s_address_2": "Gurgaon",
"s_city": "Gurgaon",
"s_state": "Haryana",
"s_country": "IN",
"s_zipcode": "122001",
"s_phone": "+9149416872993",
"store_code": "1",
"weight": "0",
"box_length": "0",
"box_breadth": "0",
"box_height": "0",
"email": "hiteshkumar148@gmail.com",
"status": "E",
"invoice_number": "1001",
"name": "Bluedart",
"tracking_number": "74382378",
"pickup_address": {
"contact_person_name": "Onjection Solution",
"title": "Courier Address",
"address_1": "Gurgaon",
"address_2": "Huda Market",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122001"
},
"return_address": {
"contact_person_name": "Onjection Solution",
"title": "Aramex Courier Address",
"address_1": "Gurgaon",
"address_2": "Huda Market",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122001"
},
"order_date": "2018-12-06 03:03:32",
"ezyslip_order_id": "2737181",
"products": [
{
"product": "T-Shirt",
"product_code": "",
"price": "990.00",
"amount": "1"
}
]
}
}
{"success": 1,"error": "","message": "No order found"}
Ezyslips provides GET API to interact with Ezyslips system. This API Restful that enables merchants to count orders from Ezyslips system.
Ezyslips provide you access to count your order from Ezyslips system.
URL
GET https://ezyslips.com/api/countorders
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init();
nisha12345@gmail.com
$key='license_key';
$token=base64_encode($email.':'.$key);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://ezyslips.com/api/countorders",
CURLOPT_RETURNTRANSFER => true,v
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
'Authorization: Basic '. $token,
"cache-control: no-cache"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
{"success": 1,"error": "","message": 14}