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 GET API to interact with Ezyslips system. This API Restful that enables merchants to get All stores from Ezyslips system.
Ezyslips provide you access to get all Stores from Ezyslips system.
URL
GET https://ezyslips.com/api/Getstores
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init();
$email='example@domain.com';
$key='license_key';
$token=base64_encode($email.':'.$key);
curl_setopt_array($curl, array(
CURLOPT_URL =>"https://ezyslips.com/api/Getstores",
CURLOPT_RETURNTRANSFER => true,
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);
{
"success": 1,
"error": "",
"message": {
"1": {
"store_code": "1",
"name": "Shopify",
"store_url": "test.myshopify.com"
},
"2": {
"store_code": "2",
"name": "shopify 2",
"store_url": "test2.myshopify.com"
},
"5": {
"store_code": "5",
"name": "Cscart",
"store_url": "http://example/cscart/"
},
"6": {
"store_code": "6",
"name": "Opencart",
"store_url": "http://example/opencart/"
}
}
}
Ezyslips provides GET API to interact with Ezyslips system. This API Restful that enables merchants to get Store using Store id from Ezyslips system.
Ezyslips provide you access to get Store using Store id from Ezyslips system.
URL
GET https://ezyslips.com/api/Getstores?store_id=1
Parameter
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| store_code | store code unique id for each Channel which you have integrated in ezyslips | Yes | integer |
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init(); $email='example@domain.com'; $key='license_key'; $token=base64_encode($email.':'.$key); curl_setopt_array($curl, array( CURLOPT_URL =>"https://ezyslips.com/api/Getstores?store_code=1", CURLOPT_RETURNTRANSFER => true, 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);
{
"success": 1,
"error": "",
"message": {
"store_code": "1",
"name": "Shopify",
"store_url": "test.myshopify.com"
}
}
Ezyslips provides Push Orders 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 JSON (More Details) | Yes | json |
| payment_type | P - Prepaid, C - COD | Yes | string |
| Customer email | No | string | |
| store_code | Order belong to which online store click here | No | integer |
| discount | Total discount for order (INR) | No | decimal |
| gift_card_amt | Gift card amount if apply gift card on orders (INR) | No | decimal |
| taxes | Oders Taxes (INR) | No | decimal |
| tax_rate | Tax Rate | No | decimal |
| tax_title | Tax Title (IGST,SGST,CGST) | No | string |
| 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) [Country code or country name Please Click Here] | 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) [Country code or country name Please Click Here] | Yes | string |
| shipping_firstname | First Name(Shipping address) | No | string |
| shipping_lastname | Last Name(Shipping address) | No | string |
| shipping_phone | Phone (Shipping address) | Yes | string |
| shipping_zipcode | Zipcode (Shipping address) | Yes | 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 |
| Name | Description |
|---|---|
| product | name of the product |
| price | price per quantity |
| product_code | sku code of the product |
| amount | no of quantity |
| discount | discount per quantity (product discount and order discount can not be clubbed together) |
| tax_rate | tax rate in percentage e.g., 18. If taxes in order request is 0 then it consider as including taxes else excluding taxes. |
| tax_title | tax title e.g., IGST, SGST |
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",
"amount":"1",
"discount":"0",
"tax_rate":"5",
"tax_title":"IGST"
},
{
"product":"My Test Product 23",
"price":"120",
"product_code":"JSN9999",
"amount":"5",
"discount":"0",
"tax_rate":"5",
"tax_title":"IGST"
}
],
"discount":"0",
"shipping":"30",
"order_total":"870",
"gift_card_amt":"100",
"taxes":"40",
"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":"2019-07-01 12:05:00"
}
{"success": 1,"error": "","message": "Order has been added successfully."}
{"message": "Unauthorized","status": 401}
Ezyslips provides Push Orders with Assign awb no API to interact with Ezyslips system. This API Restful that enables merchants to PUSH orders in Ezyslips system.
The API creates an Order and assign tracking number 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 |
| carrier_id | Carrier's Carrier ID | Yes | integer |
| warehouse_id | Warehouse ID | Yes | integer |
| return_warehouse_id | Return Warehouse ID | Yes | integer |
| products | Products belonging to order | Yes | json |
| payment_type | P - Prepaid, C - COD | Yes | string |
| Customer email | No | string | |
| store_code | Order belong to which online store click here | No | integer |
| discount | Total discount for order (INR) | No | decimal |
| gift_card_amt | Gift card amount if apply gift card on orders (INR) | No | decimal |
| taxes | Oders Taxes (INR) | No | decimal |
| tax_rate | Tax Rate | No | decimal |
| tax_title | Tax Title (IGST,SGST,CGST) | No | string |
| 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) [Country code or country name Please Click Here] | 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) [Country code or country name Please Click Here] | Yes | string |
| shipping_firstname | First Name(Shipping address) | No | string |
| shipping_lastname | Last Name(Shipping address) | No | string |
| shipping_phone | Phone (Shipping address) | Yes | string |
| shipping_zipcode | Zipcode (Shipping address) | Yes | 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",
"carrier_id":"1",
"warehouse_id":"1",
"return_warehouse_id":"1",
"products":[
{
"product":"My Test Product 5",
"price":"200",
"product_code":"JSN909",
"amount":"1",
"discount":"0",
"tax_rate":"5",
"tax_title":"IGST"
},
{
"product":"My Test Product 23",
"price":"120",
"product_code":"JSN9999",
"amount":"5",
"discount":"0",
"tax_rate":"5",
"tax_title":"IGST"
}
],
"discount":"0",
"shipping":"30",
"order_total":"870",
"gift_card_amt":"100",
"taxes":"40",
"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":"2019-07-01 12:05:00"
}
There are two condition for success response,which is given below-
1.In case create new orders.
{
"success": 1,
"error": "",
"message": "Order has been added successfully."
"awb_response": {
"success": true,
"message": "AWB No assigned Successfully",
"AWB": "69648484544",
"shipping_url": "https://ezyslips.com/shipping_labels/2df8cbdddf7960dfc98772fa7c402500_thermal.pdf"
}
} 2.In case orders are already exist.
{
"success": "",
"error": 1,
"message": "Order already exists with order id TESTAPRIL198",
"awb_response": {
"success": true,
"message": "AWB No assigned Successfully",
"AWB": "69648484544",
"shipping_url": "https://ezyslips.com/shipping_labels/2df8cbdddf7960dfc98772fa7c402500_thermal.pdf"
}
}
3.In case AWB already Assigned.
{
"success": "",
"error": 1,
"message": "Order already exists with order id TESTAPRIL198",
"awb_response": {
"success": false,
"message": "AWB No already assigned",
"AWB": "69648484544",
"shipping_url": "https://ezyslips.com/shipping_labels/2df8cbdddf7960dfc98772fa7c402500_thermal.pdf"
}
}
1.In case Invalid Credentials.
{"message": "Unauthorized","status": 401}
2.In case Carrier is not exit in ezyslips.
{
"success": "",
"error": 1,
"message": "Order already exists with order id TESTAPRIL199",
"awb_response": {
"success": false,
"error": [
"Service for this Courier is unavailable now."
]
}
}
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='youremail@domain.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",
"order_total": "1030.00",
"shipping_cost": "50.00",
"other_charges": "10.00",
"discount": "20.00",
"payment_id": "6",
"payment_method": "Cash on Delivery",
"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",
"carrier_title": "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"
}
],
"order_tags": []
}
}
{"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();
$email='youremail@domain.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",
"order_total": "1030.00",
"shipping_cost": "50.00",
"other_charges": "10.00",
"discount": "20.00",
"payment_id": "6",
"payment_method": "Cash on Delivery",
"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",
"carrier_title": "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"
}
],
"order_tags": []
}
}
{"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();
$email='youremail@domain.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",
"order_total": "1030.00",
"shipping_cost": "50.00",
"other_charges": "10.00",
"discount": "20.00",
"payment_id": "6",
"payment_method": "Cash on Delivery",
"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_tags": []
}
}
{
"order_id": "1001",
"order_total": "1030.00",
"shipping_cost": "50.00",
"other_charges": "10.00",
"discount": "20.00",
"payment_id": "6",
"payment_method": "Cash on Delivery",
"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",
"carrier_title": "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"
}
],
"order_tags": []
}
}
{"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 tags.
URL
GET https://ezyslips.com/api/getorders?tags=
Parameter
| Field Name | Description | Data Type | tags | Order tags (COD,Prime) | string |
|---|
* Orders can be searched by Multiple tags using a literal ' , ' .
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
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();
$email='youremail@domain.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",
"order_total": "1030.00",
"shipping_cost": "50.00",
"other_charges": "10.00",
"discount": "20.00",
"payment_id": "6",
"payment_method": "Cash on Delivery",
"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",
"carrier_title": "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"
}
],
"order_tags": []
}
}
{"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();
$email='youremail@domain.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",
"order_total": "1030.00",
"shipping_cost": "50.00",
"other_charges": "10.00",
"discount": "20.00",
"payment_id": "6",
"payment_method": "Cash on Delivery",
"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",
"carrier_title": "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"
}
],
"order_tags": []
}
}
{"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();
$email='youremail@domain.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}
Ezyslips provides Push Orders with Assign awb no API to interact with Ezyslips system. This API Restful that enables merchants to create return orders in Ezyslips system.
The API creates an Return 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 |
| store_code | Order belong to which online store click here | No | integer |
| return_order_status | E - Exchange, R - Refund | Yes | string |
| products | Products belonging to order | Yes | json |
| payment_type | P - Prepaid, C - COD | Yes | string |
| Customer email | No | string | |
| discount | Total discount for order (INR) | No | decimal |
| gift_card_amt | Gift card amount if apply gift card on orders (INR) | No | decimal |
| taxes | Oders Taxes (INR) | No | decimal |
| tax_rate | Tax Rate | No | decimal |
| tax_title | Tax Title (IGST,SGST,CGST) | No | string |
| 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) [Country code or country name Please Click Here] | 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) [Country code or country name Please Click Here] | Yes | string |
| shipping_firstname | First Name(Shipping address) | No | string |
| shipping_lastname | Last Name(Shipping address) | No | string |
| shipping_phone | Phone (Shipping address) | Yes | string |
| shipping_zipcode | Zipcode (Shipping address) | Yes | 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/Createreturns
Headers
| Content-Type | application/json |
| Authorization | < Enter your $token (which is described in authentication section) > |
{
"order_id":"TESTAPRILd00",
"store_code":"0",
"return_order_status":"E",
"products":[
{
"product":"My Test Product 5",
"price":"200",
"product_code":"JSN909",
"amount":"1",
"discount":"0",
"tax_rate":"5",
"tax_title":"IGST"
},
{
"product":"My Test Product 23",
"price":"120",
"product_code":"JSN9999",
"amount":"5",
"discount":"0",
"tax_rate":"5",
"tax_title":"IGST"
}
],
"discount":"0",
"shipping":"30",
"order_total":"870",
"gift_card_amt":"100",
"taxes":"40",
"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":"2019-07-01 12:05:00"
}
There are two condition for success response,which is given below-
1.In case Create Return orders.
{
"success": 1,
"error": "",
"message": "Order has been added successfully.",
"create_return_response": {
"success": 1,
"error": "",
"message": "Return is created successfully"
}
} 2.In case Orders are already exist.
{
"success":1 ,
"error": "",
"message": "Order has been updated successfully.",
"create_return_response": {
"success": 1,
"error": "",
"message": "Return is created successfully"
}
}
3.In case Return Created Already.
{
"success": 1,
"error": "",
"message": "Order has been updated successfully.",
"create_return_response": {
"success": "",
"error": 1,
"message": "Return is created already"
}
}
1.In case Invalid Credentials.
{"message": "Unauthorized","status": 401}
2.In case return_order_status is not pass request.
{
"success": "",
"error": 1,
"message": "Field return_order_status is mandatory.",
"create_return_response": {
"error": 1,
"success": "",
"message": "Field return_order_status is mandatory."
}
}
Ezyslips provides to Create Returns with Assign awb no API to interact with Ezyslips system. This API Restful that enables merchants to create return orders with Assign awb in Ezyslips system.
The API creates an Return Order with assign awb 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 |
| store_code | Order belong to which online store click here | No | integer |
| return_order_status | E - Exchange, R - Refund | Yes | string |
| return_reason_id | Return Reasons id By Using this click here | Yes | integer |
| return_warehouse_id | Return Warehouse id where you want to return orders | Yes | integer |
| products | Products belonging to order | Yes | json |
| payment_type | P - Prepaid, C - COD | Yes | string |
| Customer email | No | string | |
| discount | Total discount for order (INR) | No | decimal |
| gift_card_amt | Gift card amount if apply gift card on orders (INR) | No | decimal |
| taxes | Oders Taxes (INR) | No | decimal |
| tax_rate | Tax Rate | No | decimal |
| tax_title | Tax Title (IGST,SGST,CGST) | No | string |
| 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) [Country code or country name Please Click Here] | 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) [Country code or country name Please Click Here] | Yes | string |
| shipping_firstname | First Name(Shipping address) | No | string |
| shipping_lastname | Last Name(Shipping address) | No | string |
| shipping_phone | Phone (Shipping address) | Yes | string |
| shipping_zipcode | Zipcode (Shipping address) | Yes | 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/Createreturns
Headers
| Content-Type | application/json |
| Authorization | < Enter your $token (which is described in authentication section) > |
{
"order_id":"TESTAPRIL008",
"store_code":"0",
"carrier_id":"1",
"return_warehouse_id":"1",
"return_reason_id":"1",
"return_order_status":"E",
"products":[
{
"product":"My Test Product 5",
"price":"200",
"product_code":"JSN909",
"amount":"1",
"discount":"0",
"tax_rate":"5",
"tax_title":"IGST"
},
{
"product":"My Test Product 23",
"price":"120",
"product_code":"JSN9999",
"amount":"5",
"discount":"0",
"tax_rate":"5",
"tax_title":"IGST"
}
],
"discount":"0",
"shipping":"30",
"order_total":"870",
"gift_card_amt":"100",
"taxes":"40",
"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":"2019-07-01 12:05:00"
}
There are two condition for success response,which is given below-
1.In case Create Return orders.
{
"success": 1,
"error": "",
"message": "Order has been added successfully.",
"create_return_response": {
"success": 1,
"error": "",
"message": "Return is created successfully"
},
"awb_response": {
"success": 1,
"message": "AWB No assigned Successfully",
"AWB": "69541180435"
}
} 2.In case Orders are already exist.
{
"success":1 ,
"error": "",
"message": "Order has been updated successfully.",
"create_return_response": {
"success": 1,
"error": "",
"message": "Return is created successfully"
},
"awb_response": {
"success": 1,
"message": "AWB No assigned Successfully",
"AWB": "69541180435"
}
}
3.In case Return Created Already.
{
"success": 1,
"error": "",
"message": "Order has been updated successfully.",
"create_return_response": {
"success": "",
"error": 1,
"message": "Return is created already"
},"awb_response": {
"success": 1,
"message": "AWB No assigned Successfully",
"AWB": "69541180435"
}
}
1.In case Invalid Credentials.
{"message": "Unauthorized","status": 401}
2.In case return_order_status is not pass request.
{
"success": "",
"error": 1,
"message": "Field return_order_status is mandatory.",
"create_return_response": {
"error": 1,
"success": "",
"message": "Field return_order_status is mandatory."
}
}
Ezyslips provides Create Return Using Order Id to interact with Ezyslips system. This API Restful that enables merchants to create return using order id in Ezyslips system.
The API creates an Return 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 |
| store_code | Order belong to which online store click here | No | integer |
| order_id_type | 1.vendor_order_id - which is exist in Ezyslips. 2.shopify_order_id - which is shopify order id | Yes | string |
| return_order_status | E - Exchange, R - Refund | Yes | string |
URL
POST https://ezyslips.com/api/Createreturnbyorderid
Headers
| Content-Type | application/json |
| Authorization | < Enter your $token (which is described in authentication section) > |
{
"order_id":"TESTAPRILsd001",
"store_code":"0",
"order_id_type":"vendor_order_id",
"return_order_status":"E"
}
There are two condition for success response,which is given below-
1.In case Create Return using shopify order id.
{
"success": 1,
"error": "",
"message": "Order has been added successfully.",
"create_return_response": {
"success": 1,
"error": "",
"message": "Return is created successfully"
}
} 2.In case Create Return using vendor order id.
{
"success": "",
"error": 1,
"message": "Order already exists.",
"create_return_response": {
"success": 1,
"error": "",
"message": "Return is created successfully"
}
}
3.In case Return Created Already.
{
"success": 1,
"error": "",
"message": "Order already exists.",
"create_return_response": {
"success": "",
"error": 1,
"message": "Return is created already"
}
}
1.In case Invalid Credentials.
{"message": "Unauthorized","status": 401}
2.In case order does not exist in Ezyslips.
{
"order_id":"TESTAPRILsd001",
"store_code":"0",
"order_id_type":"vendor_order_id",
"return_reason_id":"1",
"return_order_status":"E"
}
Ezyslips provides Create Return By Order Id with assign awb no to interact with Ezyslips system. This API Restful that enables merchants to create return by order id with assign awb no in Ezyslips system.
The API creates an Return By Order Id with assign awb no 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 |
| store_code | Order belong to which online store click here | No | integer |
| carrier_id | Carrier's Carrier ID | Yes | integer |
| order_id_type | 1.vendor_order_id - which is exist in Ezyslips. 2.shopify_order_id - which is shopify order id | Yes | string |
| return_order_status | E - Exchange, R - Refund | Yes | string |
| return_reason_id | Return Reasons id By Using this click here | Yes | integer |
| return_warehouse_id | Return Warehouse id where you want to return orders | Yes | integer |
URL
POST https://ezyslips.com/api/Createreturnbyorderid
Headers
| Content-Type | application/json |
| Authorization | < Enter your $token (which is described in authentication section) > |
{
"order_id":"TESTAPRILsd001",
"store_code":"0",
"carrier_id":"0",
"order_id_type":"vendor_order_id",
"return_reason_id":"1",
"return_order_status":"E",
"return_warehouse_id":"1"
}
There are two condition for success response,which is given below-
1.In case Create Return using shopify order id.
{
"success": 1,
"error": "",
"message": "Order has been added successfully.",
"create_return_response": {
"success": 1,
"error": "",
"message": "Return is created successfully"
},"awb_response": {
"success": 1,
"message": "AWB No assigned Successfully",
"AWB": "69541180435"
}
} 2.In case Create Return using vendor order id.
{
"success": "",
"error": 1,
"message": "Order already exists.",
"create_return_response": {
"success": 1,
"error": "",
"message": "Return is created successfully"
},"awb_response": {
"success": 1,
"message": "AWB No assigned Successfully",
"AWB": "69541180435"
}
}
3.In case Return Created Already.
{
"success": 1,
"error": "",
"message": "Order already exists.",
"create_return_response": {
"success": "",
"error": 1,
"message": "Return is created already"
},"awb_response": {
"success": 1,
"message": "AWB No assigned Successfully",
"AWB": "69541180435"
}
}
1.In case Invalid Credentials.
{"message": "Unauthorized","status": 401}
2.In case order does not exist in Ezyslips.
{
"order_id":"TESTAPRILsd001",
"store_code":"0",
"order_id_type":"vendor_order_id",
"return_reason_id":1",
"return_order_status":"E"
}
Ezyslips provides Cretae Warehouse API to interact with Ezyslips system. This API Restful that enables merchants to create warehouse in Ezyslips system.
Ezyslips provide you access to Create warehouse from Ezyslips system.
URL
POST https://ezyslips.com/api/warehouse/
Parameter
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| title | Warehouse's Title Name | Yes | string |
| contact_person_name | Warehouse Contact Person Name | Yes | string |
| Warehouse Email Id | Yes | string | |
| phone (pass with country code) | Warehouse Phone number | Yes | integer |
| phone_print | For using on Shipping Label | Optional | string |
| address_1 | Warehouse Address | Yes | string |
| address_2 | Warehouse Address | Optional | string |
| city | Warehouse City | Yes | string |
| state | Warehouse State | Yes | string |
| country | Warehouse Country Name | Yes | string |
| pincode | Warehouse Pincode Number | Yes | integer |
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
{
"title": "Warehouse Title",
"company": "Company Name",
"contact_person_name": "Test Name",
"email": "contact@ezyslips.com",
"phone": "+91-9999999999",
"phone_print": "",
"address_1": "Spaze Tech Park",
"address_2": "10 Floor",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122001"
}
{
{
"success": true,
"error": ,
"message": "Wareshouse Created Successfully",
"warehouse_response": {
"warehouse_id": 1172
}
}
Ezyslips provides GET API to interact with Ezyslips system. This API Restful that enables merchants to get All warehouse from Ezyslips system.
Ezyslips provide you access to get all warehouse from Ezyslips system.
URL
GET https://ezyslips.com/api/getwarehouses
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init();
$email='example@domain.com';
$key='license_key';
$token=base64_encode($email.':'.$key);
curl_setopt_array($curl, array(
CURLOPT_URL =>"https://ezyslips.com/api/getwarehouses",
CURLOPT_RETURNTRANSFER => true,
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);
{
"success": 1,
"error": "",
"message": {
"876": {
"warehouse_id": "876",
"company_id": "1",
"user_id": "0",
"default": "0",
"title": "Warehouse",
"company": "Ezyslips",
"contact_person_name": "Contact",
"email": "contact@ezyslips.com",
"phone": "+91-1244279990",
"phone_print": "",
"address_1": "#1002, 10th Floor, Tower B4, ",
"address_2": "Spaze IT Park, Sohna Road, Sector 49",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122002",
"timestamp": "1541162421",
"updated_timestamp": "1561706967",
"status": "0"
},
"1148": {
"warehouse_id": "1148",
"company_id": "8122",
"user_id": "0",
"default": "1",
"title": "ezyslips",
"company": "Test",
"contact_person_name": "Test ",
"email": "test@test.com",
"phone": "+91-9999999999",
"phone_print": "",
"address_1": "I Tech Spaze Park",
"address_2": "",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122018",
"timestamp": "1552903864",
"updated_timestamp": "1558597175",
"status": "0"
}
}
}
Ezyslips provides GET API to interact with Ezyslips system. This API Restful that enables merchants to get warehouse using warehouse id from Ezyslips system.
Ezyslips provide you access to get warehouse using warehouse id from Ezyslips system.
URL
GET https://ezyslips.com/api/getwarehouses?warehouseid=876
Parameter
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| warehouseid | Warehouse's Warehouse ID | Yes | integer |
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init(); $email='example@domain.com'; $key='license_key'; $token=base64_encode($email.':'.$key); curl_setopt_array($curl, array( CURLOPT_URL =>"https://ezyslips.com/api/getwarehouses?warehouseid=876", CURLOPT_RETURNTRANSFER => true, 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);
{
"success": 1,
"error": "",
"message": {
"warehouse_id": "876",
"company_id": "1",
"user_id": "0",
"default": "0",
"title": "Warehouse",
"company": "Ezyslips",
"contact_person_name": "Contact",
"email": "contact@ezyslips.com",
"phone": "+91-1244279990",
"phone_print": "",
"address_1": "#1002, 10th Floor, Tower B4, ",
"address_2": "Spaze IT Park, Sohna Road, Sector 49",
"city": "Gurgaon",
"state": "Haryana",
"country": "India",
"pincode": "122002",
"timestamp": "1541162421",
"updated_timestamp": "1561706967",
"status": "0"
}
}
Ezyslips provides GET API to interact with Ezyslips system. This API Restful that enables merchants to get All warehouse from Ezyslips system.
Ezyslips provide you access to get all Return Reason from Ezyslips system.
URL
GET https://ezyslips.com/api/Getreturnreasons
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init();
$email='example@domain.com';
$key='license_key';
$token=base64_encode($email.':'.$key);
curl_setopt_array($curl, array(
CURLOPT_URL =>"https://ezyslips.com/api/Getreturnreasons",
CURLOPT_RETURNTRANSFER => true,
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);
{
"success": 1,
"error": "",
"message": [
{
"id": "189",
"reason": "Item is damaged"
},
{
"id": "190",
"reason": "Received wrong item"
},
{
"id": "191",
"reason": "Changed mind"
},
{
"id": "192",
"reason": "Not what I expected"
},
{
"id": "193",
"reason": "Did not fit"
},
{
"id": "194",
"reason": "Wrong item deliver"
}
]
}
Ezyslips provides GET API to interact with Ezyslips system. This API Restful that enables merchants to get return reason using return reason id from Ezyslips system.
Ezyslips provide you access to get warehouse using warehouse id from Ezyslips system.
URL
GET https://ezyslips.com/api/Getreturnreasons?return_reason_id=1
Parameter
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| return_reason_id | Reason id of Return reason | Yes | integer |
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init(); $email='example@domain.com'; $key='license_key'; $token=base64_encode($email.':'.$key); curl_setopt_array($curl, array( CURLOPT_URL =>"https://ezyslips.com/api/Getreturnreasons?warehouseid=1", CURLOPT_RETURNTRANSFER => true, 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);
{
"success": 1,
"error": "",
"message": {
"id": "1",
"company_id": "1",
"type": "M",
"reason": "Item is damaged",
"insert_time": "0000-00-00 00:00:00",
"update_time": "2020-02-06 13:29:35"
}
}
Ezyslips provides GET API to interact with Ezyslips system. This API Restful that enables merchants to get All Carriers from Ezyslips system.
Ezyslips provide you access to get all Carriers from Ezyslips system.
URL
GET https://ezyslips.com/api/getcarrier
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init(); $email='example@domain.com'; $key='license_key'; $token=base64_encode($email.':'.$key); curl_setopt_array($curl, array( CURLOPT_URL =>"https://ezyslips.com/api/getcarrier", CURLOPT_RETURNTRANSFER => true, 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);
{
"success": 1,
"error": "",
"message": [
{
"id": "1",
"name": "Bluedart",
"carrier_title": "Bluedart Air"
},
{
"id": "234",
"name": "Bluedart",
"carrier_title": "Bluedart Ground"
},
{
"id": "2",
"name": "Delhivery",
"carrier_title": "Delhivery"
},
{
"id": "3",
"name": "Fedex India",
"carrier_title": "fedex"
},
{
"id": "682",
"name": "Fedex India",
"carrier_title": "Fedex Air"
}
]
}
Ezyslips provides GET API to interact with Ezyslips system. This API Restful that enables merchants to get Carrier using carrier id from Ezyslips system.
Ezyslips provide you access to get Carrier using Carrier id from Ezyslips system.
URL
GET https://ezyslips.com/api/getcarrier?carrierid=1
Parameter
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| carrierid | Carrier's Carrierid ID | Yes | integer |
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init(); $email='example@domain.com'; $key='license_key'; $token=base64_encode($email.':'.$key); curl_setopt_array($curl, array( CURLOPT_URL =>"https://ezyslips.com/api/getcarrier?carrierid=1", CURLOPT_RETURNTRANSFER => true, 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);
{
"success": 1,
"error": "",
"message": [
{
"id": "1",
"name": "Bluedart",
"carrier_title": "Bluedart Air"
}
]
}
Ezyslips provides Pincode Serviceable to interact with Ezyslips system. This API Restful that enables merchants to get Pincode Serviceable from Ezyslips system.
Ezyslips provide you access to find Pincode Serviceable from Ezyslips system.
URL
GET https://ezyslips.com/api/pincodeserviceable?pincode=122008
Parameter
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| pincode | Billing or Shipping Zipcode | Yes | integer |
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init();
$email='example@domain.com';
$key='license_key';
$token=base64_encode($email.':'.$key);
curl_setopt_array($curl, array(
CURLOPT_URL =>"https://ezyslips.com/api/pincodeserviceable?pincode=122008",
CURLOPT_RETURNTRANSFER => true,
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);
{
"success": 1,
"error": "",
"message": [
{
"carrier_id": "1",
"name": "Bludart",
"carrier_title": "Bluedart",
"payment_type": "P"
},
{
"carrier_id": "1",
"name": "Bluedart",
"carrier_title": "Bluedart",
"payment_type": "C"
},
{
"carrier_id": "24",
"name": "Fedex",
"carrier_title": "Fedex Air",
"payment_type": "C"
},
]
}
Ezyslips provides GET API to interact with Ezyslips system. This API Restful that enables merchants to get Pincode Serviceable using Payment Type from Ezyslips system.
Ezyslips provide you access to get Pincode Serviceable using Payment Type from Ezyslips system.
URL
GET https://ezyslips.com/api/pincodeserviceable?pincode=122008&payment_type=P
Parameter
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| pincode | Billing or Shipping Zipcode | Yes | integer |
| payment_type | P - Prepaid, C - COD | Yes | string |
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
$curl = curl_init(); $email='example@domain.com'; $key='license_key'; $token=base64_encode($email.':'.$key); curl_setopt_array($curl, array( CURLOPT_URL =>"https://ezyslips.com/api/pincodeserviceable?pincode=122008&payment_type=P", CURLOPT_RETURNTRANSFER => true, 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);
{
"success": 1,
"error": "",
"message": [
{
"carrier_id": "1",
"name": "Bluedart",
"carrier_title": "Bluedart",
"payment_type": "P"
},
]
}
Ezyslips provides Pickup Create to interact with Ezyslips system. This API Restful that enables merchants to Pickup Create from Ezyslips system.
Ezyslips provide you access to Create Pickup from Ezyslips system.
URL
POST https://ezyslips.com/api/createpickup/
Parameter
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| pickup_date | Pickup Date (yyyy-dd-mm) | Yes | date |
| pickup_time | Pickup Time (mm:ss) | Yes | time |
| carrier_id | Carrier Id Of Carrier | Yes | integer |
| office_close_time | Office Closing time (mm:ss) | Yes | time |
| warehouse_id | Warehouse id from where You want to Pickup | Yes | integer |
| return_warehouse_id | Yes | integer | |
| payment_type | P - Prepaid, C - COD | Yes | string |
| order_ids | Merchant's Order IDs | Yes | string |
Headers
| Content-Type | application/json |
| Authorization | < Enter your $token (which is described in authentication section) > |
{
"pickup_date":"2019-10-16",
"pickup_time":"14:30",
"office_close_time":"18:00",
"package_count":1,
"carrier_id":2,
"warehouse_id":1147,
"return_warehouse_id":1147,
"payment_type":"C",
"order_ids":
[
"dummy_order_35_04",
"dummy_order_34_42"
]
}
{
"success": "",
"error": "",
"message": "Success",
"pickup_response": {
"success": true,
"message": "Pickup Created Successfully",
"Pickup_id": "34715DEMO"
}
}
{
"success": "",
"error": 1,
"message": "",
"pickup_response": {
"success": false,
"error": [
"Invalid Pickup Date. < 19/12/2019"
]
}
}
Ezyslips provides Cancel order API to interact with Ezyslips system. This API Restful that enables merchants to create Cancel order in Ezyslips system.
Ezyslips provide you access to Create Cancel order from Ezyslips system.
URL
POST https://ezyslips.com/api/Cancelorders/
Parameter
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| store_code | Order belong to which online store click here | Yes | integer |
| order_ids | Order ids added in json format like ["test","test"] (You can Cancel only New and Onhold Orders) | Yes | string |
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
{"store_code":"0","order_ids":["TEST123","test2"]}
[
{
"order_id": "TEST123",
"error": true,
"success": false,
"message": "You can mark as Cancel only New and Onhold Orders"
},
{
"order_id": "test2",
"error": false,
"success": true,
"message": "Order has marked Cancel successfully."
}
]
[
{
"order_id": "",
"error": true,
"success": false,
"message": "Field order_ids is mandatory."
}
]
Ezyslips provides Onhold order API to interact with Ezyslips system. This API Restful that enables merchants to create onhold order in Ezyslips system.
Ezyslips provide you access to Create onhold order in Ezyslips system.
URL
POST https://ezyslips.com/api/Onholdorders/
Parameter
| Field Name | Description | Mandatory | Data Type |
|---|---|---|---|
| store_code | Order belong to which online store click here | Yes | integer |
| order_ids | order ids added in json format like ["test","test"] (You can mark as Onhold only New Orders) | Yes | string |
Headers
| Authorization | < Enter your $token (which is described in authentication section) > |
{"store_code":"0","order_ids":["TEST123","test2"]}
[
{
"order_id": "2238",
"error": true,
"success": false,
"message": "You can mark as Onhold only New Orders"
},
{
"order_id": "2233",
"error": false,
"success": true,
"message": "Order has marked Onhold successfully."
}
]
[
{
"order_id": "",
"error": true,
"success": false,
"message": "Field order_ids is mandatory."
}
]
You can use country code or country name in billing_country and shipping_country
| Country Code | Country Name |
|---|---|
| IN | India |
| US | United States |
| AE | United Arab Emirates |
| SA | Saudi Arabia |
| AD | Andorra |
| AF | Afghanistan |
| AG | Antigua and Barbuda |
| AI | Anguilla |
| AL | Albania |
| AM | Armenia |
| AO | Angola |
| AQ | Antarctica |
| AR | Argentina |
| AS | American Samoa |
| AT | Austria |
| AU | Australia |
| AW | Aruba |
| AZ | Azerbaijan |
| BA | Bosnia and Herzegowina |
| BB | Barbados |
| BD | Bangladesh |
| BE | Belgium |
| BF | Burkina Faso |
| BG | Bulgaria |
| BH | Bahrain |
| BI | Burundi |
| BJ | Benin |
| BM | Bermuda |
| BN | Brunei Darussalam |
| BO | Bolivia |
| BR | Brazil |
| BS | Bahamas |
| BT | Bhutan |
| BV | Bouvet Island |
| BW | Botswana |
| BY | Belarus |
| BZ | Belize |
| CA | Canada |
| CC | Cocos (Keeling) Islands |
| CF | Central African Republic |
| CG | Congo |
| CH | Switzerland |
| CI | Cote Divoire |
| CK | Cook Islands |
| CL | Chile |
| CM | Cameroon |
| CN | China |
| CO | Colombia |
| CR | Costa Rica |
| CU | Cuba |
| CV | Cape Verde |
| CX | Christmas Island |
| CY | Cyprus |
| CZ | Czech Republic |
| DE | Germany |
| DJ | Djibouti |
| DK | Denmark |
| DM | Dominica |
| DO | Dominican Republic |
| DZ | Algeria |
| EC | Ecuador |
| EE | Estonia |
| EG | Egypt |
| EH | Western Sahara |
| ER | Eritrea |
| ES | Spain |
| ET | Ethiopia |
| FI | Finland |
| FJ | Fiji |
| FK | Falkland Islands (Malvinas) |
| FM | Micronesia |
| FO | Faroe Islands |
| FR | France |
| FX | France, Metropolitan |
| GA | Gabon |
| GB | United Kingdom (Great Britain) |
| GD | Grenada |
| GE | Georgia |
| GF | French Guiana |
| GH | Ghana |
| GI | Gibraltar |
| GL | Greenland |
| GM | Gambia |
| GN | Guinea |
| GP | Guadeloupe |
| GQ | Equatorial Guinea |
| GR | Greece |
| GT | Guatemala |
| GU | Guam |
| GW | Guinea-Bissau |
| GY | Guyana |
| HK | Hong Kong |
| HM | Heard and McDonald Islands |
| HN | Honduras |
| HR | Croatia |
| HT | Haiti |
| HU | Hungary |
| ID | Indonesia |
| IE | Ireland |
| IL | Israel |
| IO | British Indian Ocean Territory |
| IQ | Iraq |
| IR | Islamic Republic of Iran |
| IS | Iceland |
| IT | Italy |
| IM | Isle of Man |
| JM | Jamaica |
| JO | Jordan |
| JP | Japan |
| KE | Kenya |
| KG | Kyrgyzstan |
| KH | Cambodia |
| KI | Kiribati |
| KM | Comoros |
| KN | St. Kitts and Nevis |
| KP | Korea |
| KR | Korea, Republic of |
| KW | Kuwait |
| KY | Cayman Islands |
| KZ | Kazakhstan |
| LA | Laos |
| LB | Lebanon |
| LC | Saint Lucia |
| LI | Liechtenstein |
| LK | Sri Lanka |
| LR | Liberia |
| LS | Lesotho |
| LT | Lithuania |
| LU | Luxembourg |
| LV | Latvia |
| LY | Libyan Arab Jamahiriya |
| MA | Morocco |
| MC | Monaco |
| MD | Moldova, Republic of |
| MG | Madagascar |
| MH | Marshall Islands |
| MK | Macedonia |
| ML | Mali |
| MM | Myanmar |
| MN | Mongolia |
| ME | Montenegro |
| MO | Macau |
| MP | Northern Mariana Islands |
| MQ | Martinique |
| MR | Mauritania |
| MS | Montserrat |
| MT | Malta |
| MU | Mauritius |
| MV | Maldives |
| MW | Malawi |
| MX | Mexico |
| MY | Malaysia |
| MZ | Mozambique |
| NA | Namibia |
| NC | New Caledonia |
| NE | Niger |
| NF | Norfolk Island |
| NG | Nigeria |
| NI | Nicaragua |
| NL | Netherlands |
| NO | Norway |
| NP | Nepal |
| NR | Nauru |
| NU | Niue |
| NZ | New Zealand |
| OM | Oman |
| PA | Panama |
| PE | Peru |
| PF | French Polynesia |
| PG | Papua New Guinea |
| PH | Philippines |
| PK | Pakistan |
| PL | Poland |
| PM | St. Pierre and Miquelon |
| PN | Pitcairn |
| PR | Puerto Rico |
| PS | Palestine Authority |
| PT | Portugal |
| PW | Palau |
| PY | Paraguay |
| QA | Qatar |
| RE | Reunion |
| RO | Romania |
| RU | Russian Federation |
| RW | Rwanda |
| CS | Serbia |
| SB | Solomon Islands |
| SC | Seychelles |
| SD | Sudan |
| SE | Sweden |
| SG | Singapore |
| SH | St. Helena |
| SI | Slovenia |
| SJ | Svalbard and Jan Mayen Islands |
| SK | Slovakia |
| SL | Sierra Leone |
| SM | San Marino |
| SN | Senegal |
| SO | Somalia |
| SR | Suriname |
| ST | Sao Tome and Principe |
| SV | El Salvador |
| SY | Syrian Arab Republic |
| SZ | Swaziland |
| TC | Turks and Caicos Islands |
| TD | Chad |
| TF | French Southern Territories |
| TG | Togo |
| TH | Thailand |
| TJ | Tajikistan |
| TK | Tokelau |
| TM | Turkmenistan |
| TN | Tunisia |
| TO | Tonga |
| TL | East Timor |
| TR | Turkey |
| TT | Trinidad and Tobago |
| TV | Tuvalu |
| TW | Taiwan |
| TZ | Tanzania, United Republic of |
| UA | Ukraine |
| UG | Uganda |
| UY | Uruguay |
| UZ | Uzbekistan |
| VA | Vatican City State |
| VC | St. Vincent and the Grenadines |
| VE | Venezuela |
| VG | British Virgin Islands |
| VI | United States Virgin Islands |
| VN | Viet Nam |
| VU | Vanuatu |
| WF | Wallis And Futuna Islands |
| WS | Samoa |
| YE | Yemen |
| YT | Mayotte |
| ZA | South Africa |
| ZM | Zambia |
| ZR | Zaire |
| ZW | Zimbabwe |
| CD | Democratic Republic of Congo |
| AP | Asia-Pacific |
| RS | Republic of Serbia |
| AX | Aland Islands |
| EU | Europe |
| GG | Guernsey |
| JE | Jersey |
| CW | Curaçao |
| SX | Sint Maarten |