Get started
The Delicon.co API is a web service which allows you to use our Machine Learning platform from your website, software or mobile application. This API provides access to all of the supported functions of our service. The Web Service uses "REST-Like" RPC-style operations over HTTP POST requests with parameters URL encoded into the request and its response is encoded in JSON. It is designed to be easy to use and you can implement it in any computer language model that allows you to generate web requests.
In order to use the Delicon.co API, you must sign-up for an account, login and get your API Key from your member area. Additionally, while developing your code, it is advised to check out our API Sandbox and generate some test requests, as well.
Using the Delicon.co API or its website indicates that you have read and accept the Terms & Conditions and the Privacy Policy. If you do not accept these terms, you are not authorized to use this service.
To use this API, you need an API key. Please create an Account to get your own API key.
Get Areas
To get areas, you need to make a GET call at the following URL :
Sandbox : https://sandbox.delicon.co/api/v3/get-city-list
Production : https://delicon.co/api/v3/get-city-list
DESCRIPTION
The Get City Lists function will get the info about city and its data i.e. city id, city name, state id, city name in Arabic, city latitude and city longitude.
QUERY PARAMETERS
There is no parameter required for this call.
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.delicon.co/api/v3/get-city-list',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": 200,
"data": {
"city_id": "1",
"city_name": "Bayan",
"city_name_arabic": "بيان",
"city_lat": "29.298107580815447",
"city_long": "48.050959637603775"
"state_id":"2"
},
{
....
}
}
}
Get My Areas
To get my areas, you need to make a Get call at the following URL :
Sandbox : https://sandbox.delicon.co/api/v3/get-my-city-list
Production : https://delicon.co/api/v3/get-my-city-list
DESCRIPTION
The Get My City Lists function will get the info about city and its data i.e. city id, city name, state id, city name in Arabic, city latitude and city longitude.
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.delicon.co/api/v3/get-my-city-list',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'email=&auth_key=',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": 200,
"data": {
"city_id": "1",
"city_name": "Bayan",
"city_name_arabic": "بيان",
"city_lat": "29.298107580815447",
"city_long": "48.050959637603775"
},
{
....
}
}
}
Create order
To create a delivery order, you need to make a POST call at the following URL :
Sandbox : https://sandbox.delicon.co/api/v3/create-order
Production : https://delicon.co/api/v3/create-order
DESCRIPTION
Create Order Function will create an order and return the list of available Fleet Companies if the given params are correct.
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team | |
| delivery_date | Yes | date | Date when delivery to be expected (Y-m-d i.e 2021-10-13) |
| delivery_time | Yes | time | Time when delivery to be expected ( H:i:s i.e 12:20 PM ) |
| dropoff_phone_no | Yes | integer | Drop Off Phone No # |
| dropOff_street | Yes | string | Drop Off Street # |
| dropOff_block_no | Yes | string | Drop Off Block No # |
| extra_direction | No | string | Extra Direction # |
| dropoff_city_id | Yes | integer | Drop Off City Id # |
| is_exchange_order | No | string | Exchange Order |
| cash_amount | No | string | If you want driver should collect cash from customer. |
| dropoff_HouseNo | Yes | string | Drop Off House No # |
| order_instruction | No | string | Any instructions you want to be followed by delicon while processing order |
| apartment | No | string | Apartment # |
| jaddah | No | string | Enter Jaddah Address # |
| pickUp_city_id | No | string | Pickup City ( get the city ID from get city api ) |
| pickUp_block_no | No | string | Pickup Block # |
| pickUp_street | No | string | Pickup Street # |
| pickup_Jadda | No | string | Pickup Jaddah |
| pickup_HouseNo | No | string | Pickup House # |
| pickUp_phone_no | No | string | Your pick up address phone number |
| pickup_Apartment | No | string | Your Pickup Apartment |
| pickup_ExtraDirection | No | string | Your Pickup Extra Direction |
| pickUp_address_name | No | string | This address name is required if you are adding different pickup information |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.delicon.co/api/v3/create-order',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'email=&auth_key=&delivery_time=&delivery_date=&dropoff_phone_no=
&dropOff_street=&dropOff_block_no=&extra_direction=&dropoff_city_id=
&is_exchange_order=&cash_amount=&dropoff_HouseNo=&order_instruction=
&apartment=&jaddah=&pickUp_city_id=&pickUp_block_no&pickUp_street=
&pickup_Jadda=&pickup_HouseNo=&pickUp_phone_no=&pickup_Apartment=
&pickup_ExtraDirection=&pickUp_address_name=',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": 200,
"message": "Fleet companies found",
"data": {
"fleet_companies": [
{
"price": 2,
"image": "https://sandbox.delicon.co/web/admin/images/
userprofile/1606400530828218.png",
"name": "PD Co",
"fleetCompanyId": 431,
"distance": 2.564
},
{
"price": 2,
"image": "https://sandbox.delicon.co/web/admin/
images/userprofile/",
"name": "KBco",
"fleetCompanyId": 967,
"distance": 2.564
}
],
"order_data": {
"order_id": 35853
"delivery_date": "2021-10-13",
"delivery_time": "21:00:00",
"dropOff_arear": "City : Bayan , Block # : 1, Street # : 1 ,
House # : 1",
"pickUp_arear": "City : Bayan , Block # : test1,
Street # : 29 Khalid Ibn Al Waleed St, Al Kuwayt, Kuwait
, Jaddah : test1 , House # : test1",
}
}
}
}
Confirm Order
To confirm order, you need to make a POST call at the following URL :
Sandbox : https://sandbox.delicon.co/api/v3/confirm-order
Production : https://delicon.co/api/v3/confirm-order
DESCRIPTION
When you hit this function amount will be deducted from your wallet and order Function will fetch the order details if you have given the required params, correctly. Required params for 'GET ORDER CONFIRMATION DETAILS' function include “email”, “auth_key”, “fleet_company_id”, and “order_id”.
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team | |
| fleet_company_id | Yes | string | Provided by Delicon Team |
| order_id | Yes | string | Required i.e.: (1737) |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.delicon.co/api/v3/confirm-order',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'email=$auth_key=&fleet_company_id=&order_id=',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": 200,
"message": "Order created successfully.",
"data": {
"order_id": 30022,
"price": 0,
"payment_id": "62348afed0e7362348afed0e7b",
"payment_method": "wallet",
"fleetCompany": "test",
"tracking_code": "62348B00F3605"
}
}
}
Get Order Payment Link
For payment, use payment_gatway_type 1 for wallet, 2 for myfatoorah and 3 for myfatoorah with Knet, you need to make a POST call at the following URL :
https://sandbox.delicon.co/api/v3/get-order-payment-link
DESCRIPTION
Pay payment, use payment_gatway_type 1 for wallet, 2 for myfatoorah and 3 for myfatoorah with Knet, correctly. Required params for 'GET ORDER PAYMENT LINK' function include “email”, “auth_key”, “payment_gate way_type”, and “order_id”.
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team | |
| payment_gateway_type | Yes | string | Provided by Delicon Team |
| order_id | Yes | string | Required i.e.: (1737) |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.delicon.co/api/v3/get-order-payment-link',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'email=$auth_key=&payment_gateway_type=&order_id=',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": 200,
"message": "Order created successfully.",
"data": {
"order_id": 52770,
"price": 2,
"payment_id": "61669eb3cd5b061669eb3cd5b4",
"payment_method": "wallet",
"fleetCompany": "PD CO",
"tracking_code": "61669EB3E30C5"
}
}
}
Delivery Order Details
To get delivery order details, you need to make a POST call at the following URL :
https://sandbox.delicon.co/api/v3/order-details
Sandbox : https://sandbox.delicon.co/api/v3/order-details
Production : https://delicon.co/api/v3/order-details
DESCRIPTION
Get Order Function will fetch the order details if you have given the required params, correctly. Required params for 'Get DELIVERY ORDER DETAILS' function include “email”, “auth_key”, and “order_id”.
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team | |
| order_id | Yes | integar | Required i.e.: (1737) |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.delicon.co/api/v3/order-details',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'email=&auth_key=&order_id=',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": "200",
"data": {
"order_id": "1737",
"price": "2",
"usernmae": "",
"payment_id": "5fff1907cd79f5fff1907cd7a2",
"fleet_company_name": "",
"delivery_date": "2018-05-14",
"delivery_time": "11:00:00",
"pickUp_arear": "29 Khalid Ibn Al Waleed St, Kuwait City, Kuwait",
"dropoff_arear": "29 Khalid Ibn Al Waleed St, Kuwait City, Kuwait",
"driver": "",
"cash": "",
"status": "Pending",
"order_instruction": "",
}
}
}
Get All Delivery Orders
To get all orders, you need to make a POST call at the following URL :
Sandbox : https://sandbox.delicon.co/api/v3/all-orders
Production : https://delicon.co/api/v3/all-orders
DESCRIPTION
Get All Orders Function will fetch users all orders and orders details if you have given the required params, correctly. Required Params for 'Get All Orders' function include “Email" and “auth_key”.
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team | |
| pageno | No | integar | i.e. 1 |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.delicon.co/api/v3/all-orders',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'email=&auth_key=&pageno=',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response":
{
"status": "200",
"data": {
"total_pages": 1,
"total_rows": 8,
"current_page": 1,
"per_page": 20,
"orders": [
{
"order_id": "1737",
"price": "2",
"usernmae": "",
"payment_id": "5fff1907cd79f5fff1907cd7a2",
"fleet_company_name": "",
"delivery_date": "2018-05-14",
"delivery_time": "11:00:00",
"pickUp_arear": "29 Khalid Ibn Al Waleed St, Kuwait City, Kuwait",
"dropoff_arear": "29 Khalid Ibn Al Waleed St, Kuwait City, Kuwait",
"driver": "",
"cash": "",
"status": "Pending",
"order_instruction": "",
}
{ ......
}
]
}
}
}
Cancel Order Request
To cancel a order, you need to make a POST call at the following URL :
Sandbox : https://sandbox.delicon.co/api/v3/cancel-order-request
Production : https://delicon.co/api/v3/cancel-order-request
DESCRIPTION
Cancel Order Request Function will send a request to admin to make the approval for order cancellation if the delivery time gap is at least one hour. Required params for 'Cancel Order Request' function include “Email”, “auth_key”, and “order_id”.
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team | |
| order_id | Yes | integar | Required i.e.: (2028) |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.delicon.co/api/v3/cancel-order-request',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'order_id=&email=&auth_key=',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": 200,
"message": "Request has sent for Approval !",
"data": ""
}
}
Get Shipping Companies List
To get shipping companies' list, you need to make a POST call at the following URL :
Sandbox : https://sandbox.delicon.co/api/v3/get-logistic-companies
Production : https://delicon.co/api/v3/get-logistic-companies
DESCRIPTION
Get Shipping Companies List function will fetch all logistic companies' data if you have given the required params, correctly. Required Params for Get Shipping Companies List function include “Email” and “auth_key”.
Note: This function will return the data of only those logistic companies which has their pricing added on delicon.co
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.delicon.co/api/v3/shipping/get-logistic-companies',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'auth_key=f5435f19-5c26-4105-9f4e-3fa84ce5cfa6&email=delicon%40boutiqaat.com',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": 200,
"message": "Logistic Company list found",
"data": {
"logistic_companies": [
{
"logistic_company_id": "959",
"name": "Aramex"
},
{
"logistic_company_id": "960",
"name": "UPS"
},
{
"logistic_company_id": "1060",
"name": "DHL"
}
]
}
}
}
Get Shipping Countries List
To get shipping countries' list, you need to make a POST call at the following URL :
https://sandbox.delicon.co/api/v3/shipping/get-logistics-countries
DESCRIPTION
Get All Shipping Countries List function will fetch all logistic countries' data if you have given the required params, correctly. Required Params for Get Shipping Countries List function include “Email” and “auth_key”.
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://sandbox.delicon.co/api/v3/shipping/get-logistics-countries',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'email=delicon%40boutiqaat.com&auth_key=cf5b1b39-5303-45b0-a204-7f8efcee12fa',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": 200,
"message": "Country list found",
"data": {
"country_list": [
{
"id": "1",
"country_code": "AF",
"country_name": "Afghanistan",
"is_active": "0"
},
{
"id": "81",
"country_code": "DE",
"country_name": "Germany",
"is_active": "0"
},
]
}
}
}
Get Shipping Prices
To Get Shipping Prices, you need to make a POST call at the following URL :
https://sandbox.delicon.co/api/v3/shipping/get-shipping-pricing
DESCRIPTION
Get All Get Shipping Prices function will return all logistics companies' data that can ship orders in your destination country ID, if you have given the required params, correctly. Required Params for Get Shipping Prices function include “Email”, “auth_key”,“product_ids” and “country_id”.
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team | |
| product_ids | Yes | string | Provided by Delicon Team |
| country_id | Yes | Integer | Provided by Delicon Team |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'http://sandbox.delicon.co/api/v3/shipping/get-shipping-pricing',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'auth_key=f5435f19-5c26-4105-9f4e-3fa84ce5cfa6&email=delicon%40boutiqaat.com&product_ids=9%2C10%2C15%2C16&country_id=1',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": 200,
"message": "Pricing against Afghanistan",
"data": {
"pricing": {
"959": {
"dimentions": [
{
"dimention_id": 1,
"logistic_company_id": 959,
"shipping_fee": "1.000",
"shipment_tax": 0.2125,
"shipment_price": "21.250",
"zone": "zone1"
},
{
"dimention_id": 2,
"logistic_company_id": 959,
"shipping_fee": "1.000",
"shipment_tax": 0.265,
"shipment_price": "26.500",
"zone": "zone1"
},
{
"dimention_id": 3,
"logistic_company_id": 959,
"shipping_fee": "1.000",
"shipment_tax": 2.1375,
"shipment_price": "213.750",
"zone": "zone1"
},
{
"dimention_id": 4,
"logistic_company_id": 959,
"shipping_fee": "1.000",
"shipment_tax": 2.1375,
"shipment_price": "213.750",
"zone": "zone1"
}
],
"pyment_data": {
"shipping_fee": "1.000",
"shipping_vat": "1.000",
"total_shipping_fee": 4,
"total_shipping_tax": 4.7525,
"total_shipping_price": 475.25,
"net_price": 484.0025,
"logistic_company_id": 959,
"first_name": "Aramex",
"image": "3241088061046137.png"
}
},
"960": {
"dimentions": [
{
"dimention_id": 1,
"logistic_company_id": 960,
"shipping_fee": "1.000",
"shipment_tax": 0.41250000000000003,
"shipment_price": "41.250",
"zone": "zone3"
},
{
"dimention_id": 2,
"logistic_company_id": 960,
"shipping_fee": "1.000",
"shipment_tax": 0.5175,
"shipment_price": "51.750",
"zone": "zone3"
},
{
"dimention_id": 3,
"logistic_company_id": 960,
"shipping_fee": "1.000",
"shipment_tax": 3.1775,
"shipment_price": "317.750",
"zone": "zone3"
},
{
"dimention_id": 4,
"logistic_company_id": 960,
"shipping_fee": "1.000",
"shipment_tax": 3.1775,
"shipment_price": "317.750",
"zone": "zone3"
}
],
"pyment_data": {
"shipping_fee": "1.000",
"shipping_vat": "1.000",
"total_shipping_fee": 4,
"total_shipping_tax": 7.285,
"total_shipping_price": 728.5,
"net_price": 739.785,
"logistic_company_id": 960,
"first_name": "UPS",
"image": "3241088061046137.png"
}
},
"1060": {
"dimentions": [
{
"dimention_id": 1,
"logistic_company_id": 1060,
"shipping_fee": "1.000",
"shipment_tax": 0.13369999999999999,
"shipment_price": "13.370",
"zone": "zone1"
},
{
"dimention_id": 2,
"logistic_company_id": 1060,
"shipping_fee": "1.000",
"shipment_tax": 0.166,
"shipment_price": "16.600",
"zone": "zone1"
},
{
"dimention_id": 3,
"logistic_company_id": 1060,
"shipping_fee": "1.000",
"shipment_tax": 1.4723,
"shipment_price": "147.230",
"zone": "zone1"
},
{
"dimention_id": 4,
"logistic_company_id": 1060,
"shipping_fee": "1.000",
"shipment_tax": 1.4723,
"shipment_price": "147.230",
"zone": "zone1"
}
],
"pyment_data": {
"shipping_fee": "1.000",
"shipping_vat": "1.000",
"total_shipping_fee": 4,
"total_shipping_tax": 3.2443,
"total_shipping_price": 324.42999999999995,
"net_price": 331.67429999999996,
"logistic_company_id": 1060,
"first_name": "DHL",
"image": "3241088061046137.png"
}
}
}
}
}
}
Shipping Products List
To Get Shipping Products List, you need to make a POST call at the following URL :
https://sandbox.delicon.co/api/v3/shipping/get-products
DESCRIPTION
Get All Shipping Products List function will fetch all products' data, if you have given the required params, correctly. Required Params for Shipping Products List function include “Email” and “auth_key”.
Note: Shipping Products List will return users' products which they have added on delicon.co
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'http://localhost/delicon/api/v3/shipping/get-products',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'auth_key=f5435f19-5c26-4105-9f4e-3fa84ce5cfa6&email=delicon%40boutiqaat.com',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": 200,
"message": "Product list found",
"data": {
"UserProduct": [
{
"id": "9",
"name": "LCD",
"description": "Desktop LCD ",
"picture": "3345036434083328.png",
"length": "150",
"width": "45",
"height": "4",
"weight": "5.4",
"size": "",
"color": "black",
"ship_deliver": "1",
"created_by": "677",
"created_on": "2021-05-09 05:26:16",
"updated_on": "2021-05-09 05:26:16"
},
{
"id": "10",
"name": "Laptop",
"description": "Dell Laptopssssssss",
"picture": "2582522440664637.png",
"length": "12.8",
"width": "50",
"height": "52.5",
"weight": "6.72",
"size": "",
"color": "",
"ship_deliver": "0",
"created_by": "677",
"created_on": "2021-05-09 05:27:12",
"updated_on": "2021-05-09 05:27:12"
},
]
}
}
}
Add New Shipping Product
To Add New Shipping Product, you need to make a POST call at the following URL :
https://sandbox.delicon.co/api/v3/shipping/add-products
DESCRIPTION
Product will be added by using Add New Shipping Product function, if you have given the required params, correctly. Required Params for Shipping Products List function include “Email”, “auth_key” and product dimensionality details.
QUERY PARAMETERS
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| auth_key | Yes | string | Provided by Delicon Team |
| Yes | string | Provided by Delicon Team | |
| name | Yes | string | Provided by User |
| length | Yes | Double | Provided by User |
| width | Yes | Double | Provided by User |
| height | Yes | Double | Provided by User |
| picture | Yes | string | Provided by User |
| description | Yes | string | Provided by User |
REQUEST
PHP Sample Request
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'http://localhost/delicon/api/v3/shipping/add-products',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => 'auth_key=f5435f19-5c26-4105-9f4e-3fa84ce5cfa6&email=delicon%40boutiqaat.com&name=Dell%20Mouse&length=123&width=123&height=22&picture=test.png&description=Dell%20mouse%20china%20mall',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/x-www-form-urlencoded'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
RESPONSE
{
"response": {
"status": 200,
"message": "Product Added Successfully",
"data": {
"product_data": {
"id": "29",
"name": "Dell Mouse",
"description": "Dell mouse china mall",
"picture": "test.png",
"length": "123",
"width": "123",
"height": "22",
"weight": "66.57",
"size": null,
"color": null,
"ship_deliver": null,
"created_by": "677",
"created_on": "2021-05-26 19:05:50",
"updated_on": "2021-05-26 21:05:50"
}
}
}
}