Veganistasyon API, çalıştığınız entegrasyon firmasına ekleyebileceğiniz bir yazılım kütüphanesidir.
Veganistasyon API'ı genelde birden fazla pazaryeri ile çalışan mağazalar veya kendi yönetim sistemini kullanan firmalar tercih etmektedir.
Veganistasyon API, JSON olarak çıktı verir.
Aşağıdaki Veganistasyon API mimarisinde yer alan API isteklerini, https://veganistasyon.com/alisveris/magaza/api/ linkinden sonra yazmalısınız.
Örnek Login: https://veganistasyon.com/alisveris/magaza/api/sellerlogin
Login başarılı döndükten sonra, gelen OCSESSID Cookie verisini, tüm sorgularınızda kullanmanız zorunludur.
Örnek Login OCSESSID Cookie Kullanımı //$cookie_sessid = "login_response_ocsessid_cookie_value" CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "cache-control: no-cache", $API_KEYNAME.': '.$API_KEYVAL, 'Cookie: OCSESSID='.$cookie_sessid.'' ),
Aşağıda yer alan PHP API bağlantıları, herhangi bir filtreleme olmadan, tamamen örnek amaçlı yazılmıştır.
API Kullanabilmeniz için, mağaza girişinde kullandığınız email adresiniz ve şifreniz gerekmektedir.
$magaza_email = "[email protected]"; $magaza_password = "magazaşifrem"; curl_setopt_array($curl, array( CURLOPT_URL => 'https://veganistasyon.com/alisveris/magaza/api/sellerlogin', CURLOPT_RETURNTRANSFER => true, CURLOPT_HEADER => true, CURLOPT_COOKIESESSION => true, CURLOPT_TIMEOUT => 30, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => array('email' => $magaza_email,'password' => $magaza_password), CURLOPT_HTTPHEADER => array( "cache-control: no-cache") )); $response = curl_exec($curl); curl_close($curl);
Başarılı Giriş Mesajı;
{ "message":"Seller logged in successfully", "status":true }
Mağaza email adresimiz ve şifremiz ile başarılı bir şekilde giriş yaptıktan sonra, her sorgumuzda aşağıdaki giriş bilgilerini header olarak göndermemiz gerekli.
magaza_api: 4xdwbuMF1NlCVgl1EXmNOpCGUnwn4vqzK4GPIBSZTQlLYMDz6IzDBWz2gyfZBejVtZ1ZacVI44dXjC3reJiQvXGuZFrhNsmJ0DuA8EmnzP2pqHZBEw8L6Lh8M36AQoarYitTfptWaaTzgXfXEVrd8ahX1k2PjYIvUeqQFJaCQhmrVrfX6coEkZMVFKZyJfi0v7jD8gylsDdbmnHQCvB4fWiUQcSNuKAizSupTqQHPqwMMQRMWE30rsYyJSTwj6XX
$API_KEYNAME = "magaza_api";
$API_KEYVAL = "4xdwbuMF1NlCVgl1EXmNOpCGUnwn4vqzK4GPIBSZTQlLYMDz6IzDBWz2gyfZBejVtZ1ZacVI44dXjC3reJiQvXGuZFrhNsmJ0DuA8EmnzP2pqHZBEw8L6Lh8M36AQoarYitTfptWaaTzgXfXEVrd8ahX1k2PjYIvUeqQFJaCQhmrVrfX6coEkZMVFKZyJfi0v7jD8gylsDdbmnHQCvB4fWiUQcSNuKAizSupTqQHPqwMMQRMWE30rsYyJSTwj6XX";
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://veganistasyon.com/alisveris/magaza/api/sellerproduct',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_COOKIESESSION => true,
CURLOPT_TIMEOUT => 30,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
"Content-Type: application/json",
"cache-control: no-cache",
$API_KEYNAME.': '.$API_KEYVAL
),
));
$response = curl_exec($curl);
curl_close($curl);
Aşağıdaki Veganistasyon API mimarisinde yer alan API isteklerini, https://veganistasyon.com/alisveris/magaza/api/ linkinden sonra yazmalısınız.
Örnek LOGIN için: https://veganistasyon.com/alisveris/magaza/api/sellerlogin
POST Request: - To seller login sends these 2 parameters along with other post parameters which are required for
seller login to https://veganistasyon.com/alisveris/magaza/sellerlogin
email: [email protected]
password: xxxxxxxx
NORMAL RESPONSE:
{
" status": "ture",
" message ": " Seller logged in successfully "
}
ERROR RESPONSE:-
email
Status: false
Message: Seller Login has been failed
password
Status: false
Message: Seller Login has been failed
Magaza status
Status: false
Message: Magaza Bakimda
NORMAL RESPONSE
{
"status": "success",
"message": "",
"data": {
"seller_orders": [
{
"order_id": "32",(Order Id)
"customer": "punit kumar",(Name of Customer)
"admin_order_status": "Complete",(Status of Order for Ex. Complete, Refunded
"order_status": "Pending", (Status of order like: - Delivered, Dispatched, Canceled)
"total": "$102.00”,(Total Amount of Commission Charged by Admin from Seller).
"commission": "$0.00",(Charged by Admin per Order ).
"date_added": "02/07/2018",(Date of Order Placed by Customer).
"date_modified": "02/07/2018"(Date of Modifying Order Status).
}....
],
"total_sale": "$1,967.98" ,(Total Sale of All Orders).
"total_pay": 0,(Total Amount Pay to Seller by Admin).
"total_commission": 0, (Total Amount of Commission Charged by Admin from Seller).
"order_total": "11", (Total Number of Order).
"total_payments": "$100.00",(Total Amount Send by Admin to Seller).
"seller_payments": [ (Total Amount of Send to Seller by Admin).
{
"transaction_id": "54544525445", (Transaction Id)
"amount": "$100.00",(Total Number of Amount pay to seller by admin).
"payment_mode": "Cod", (Payment Mode like Net Banking, Mobile Banking, Paypal Etc.)
"status": "success",
"created_at": "05/07/2018” (Date of Transaction).
}
],
"seller_commissions": [(Commissions of Admin charged From Seller)
{
"order_id": "32", (Id of order).
"product_name": "HTC Touch HD"(Name of Product)
"price": "$100.00",(Price of Product)
"commission": "$0.00",(Amount of Commission charged by Admin From Seller).
"created_at": "02/07/2018"(Date of creating Commission).
},.....
],
"pending_payments": "$75.50",(Total pending payments of seller).
"total_order_commission": "$19.50”, (All order commission of seller)
"order_statuses": [
{
"order_status_id": "7",(Order status id)
"name": "Canceled" (Order status type.)
},
]
}
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error_warning (Session)
message = error_warning
status = error
message = No Data
PARAMETERS: -
GET request:
Page: 1 (Enter page Number)
Limit: 15(Enter Number of Items)
NORMAL RESPONSE:-
{
"status": "success",
"message": "",
"data": {
"seller_payments": [
{
"transaction_id": "54544525445",(Transaction Id)
"amount": "$100.00",(SellerPayment Transaction Amount )
"payment_mode": "Cod",(Method of Payment (Credit Card, Debit Card, Net Banking
etc.))
"status": "success",(Status of payment.)
"created_at": "05/07/2018"(Date of Payment.)
}
],
"pagination": {
"total": "1",(Number of page)
"page": 1, (Current page)
"limit": "2"(Number of item like product per page)
},
"results": "Showing 1 to 1 of 1 (1 Pages)",(Number Of Pages (Result of Pagination).
"filter_date_from": "2018-06-06",(Filter Date From)
"filter_date_to": "2018-07-06"(Filter Date To.)
}
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error_warning (Session)
message = error_warning
GET PARAMETERS:-
filter_date_from – Seller Commission Date From
filter_date_to Seller Commission Date To
page- page number
limit – No of products
NORMAL RESPONSE:
{
"status": "success",
"message": "",
"data": {
"seller_commissions": [(Commission of seller)
{
"order_id": "38",(Order ID)
"product_name": "Palm Treo Pro", (Name of Product)
"price": "$559.98",(Total Amount Charge by admin to Seller)
"commission": "$0.00",(Amount of commission)
"created_at": "06/07/2018"(Date of create commission)
},.........
],
"pagination": {
"total": "8",(Number of pages)
"page": 1,(Current page)
"limit": "2"(Number of item like product per page).
},
"results": "Showing 1 to 2 of 8 (4 Pages)",(Number of page (Results of Pagination))
"filter_date_from": "2018-06-06",(Filter date from)
"filter_date_to": "2018-07-06"(FilterDate To)
}
}
ERROR RESPONSE:-
Is Mobile Api Call
Status: error
Message: permission Error
Customer Login
Status: error
Message: Not Customer Login
Seller:
Status: error
Message: Not Seller found
Validate Seller:
Status: error
Message:Seller Not Approve
Satış->Siparişlerim
PARAMETERS:
GET Request:
page= page number
limit = Number of items on page
NORMAL RESPONSE:-
{
"data": {
"seller_orders": [
{
"order_id": "36",(Order Id)
"customer": "demo customer007",(Customer Name)
"admin_order_status": "Complete",(Order status base of admin)
"order_status": "Complete",(Seller order status)
"total": "$80.00",(Order total)
"commission": "$8.00",(Commissionof seller)
"date_added": "06/07/2018",(Data of order place)
"date_modified": "06/07/2018",(Data Of order Status Update)
"shipping_code": "1” (Type of shipping like Flat)
}
],
"total_sale": "$80.00",(Total Amount All Orders)
"total_pay": "$72.00",(Total amount to pay seller)
"total_commission": "$8.00",(Total commission on complete order.)
"filter_order_status": "5", (Filter order, base of seller order status.)
"filter_admin_order_status": "5",(Filter order, base of admin order status.)
"filter_date_from": "2018-06-06",(filter date from. (filter base of the given date))
"filter_date_to": "2018-07-06",(filter date to. (Filter base of the given date))
"order_statuses": [
{
"order_status_id": "7",(Order status id)
"name": "Canceled"(Order status type)
}, ......
],
"pagination": {
"total": "1", (Number of page)
"page": 1,(Current page)
"limit": "2"(Number of item like product per page).
},
"results": "Showing 1 to 1 of 1 (1 Pages)"(Number of page (Results of Pagination))
},
"message": "",
"status": "success"
}
Error response:
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
NORMAL RESPONSE
{
"status": "success",
"message": "",
"data": {
"seller_orders": [
{
"order_id": "32",(Order Id)
"customer": "punit kumar",(Name of Customer)
"admin_order_status": "Complete",(Status of Order for Ex. Complete, Refunded
"order_status": "Pending", (Status of order like: - Delivered, Dispatched, Canceled)
"total": "$102.00”,(Total Amount of Commission Charged by Admin from Seller).
"commission": "$0.00",(Charged by Admin per Order ).
"date_added": "02/07/2018",(Date of Order Placed by Customer).
"date_modified": "02/07/2018"(Date of Modifying Order Status).
}....
],
"total_sale": "$1,967.98" ,(Total Sale of All Orders).
"total_pay": 0,(Total Amount Pay to Seller by Admin).
"total_commission": 0, (Total Amount of Commission Charged by Admin from Seller).
"order_total": "11", (Total Number of Order).
"total_payments": "$100.00",(Total Amount Send by Admin to Seller).
"seller_payments": [ (Total Amount of Send to Seller by Admin).
{
"transaction_id": "54544525445", (Transaction Id)
"amount": "$100.00",(Total Number of Amount pay to seller by admin).
"payment_mode": "Cod", (Payment Mode like Net Banking, Mobile Banking, Paypal Etc.)
"status": "success",
"created_at": "05/07/2018” (Date of Transaction).
}
],
"seller_commissions": [(Commissions of Admin charged From Seller)
{
"order_id": "32", (Id of order).
"product_name": "HTC Touch HD"(Name of Product)
"price": "$100.00",(Price of Product)
"commission": "$0.00",(Amount of Commission charged by Admin From Seller).
"created_at": "02/07/2018"(Date of creating Commission).
},.....
],
"pending_payments": "$75.50",(Total pending payments of seller).
"total_order_commission": "$19.50”, (All order commission of seller)
"order_statuses": [
{
"order_status_id": "7",(Order status id)
"name": "Canceled" (Order status type.)
},
]
}
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error_warning (Session)
message = error_warning
status = error
message = No Data
PARAMETERS:
GET request:
order_id= Order id
POST request:-
order_status_id= Order status id base of order status
comment= Any additional comment
notify= for customer notify or not (Yes Or No)
override= Override Order history or not (Yes Or No)
NORMAL RESPONSE:-
{
"data": [],
"status": "success",
"message": "Success: You have modified orders!"
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
PARAMETERS:
GET Request:
order_id= Order id
page= page number
limit = Number of items on page
NORMAL RESPONSE:
{
"status": "success"
"data": {
"histories": [
{
"notify": "No",(value of notify like yes or no)
"status": "Pending",(Order status)
"comment": "",(Any additional comment)
"date_added": "06/07/2018"(Update order status date)
},........
],
"pagination": {
"total": "4",(Number of page)
"page": 1,(current page)
"limit": "15"(Number of item like product perpage)
},
"results": "Showing 1 to 4 of 4 (1 Pages)" (Number of page in pagination)
}
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
Katalog->Ürünler
PARAMETERS:
POST REQUEST:
Example of post request:
Array
(
[seller_id] => magazaid
[seller_name] => magazaismi
[is_approved] =>
[product_description] => Array
(
[1] => Array
(
[name] => mp3 player
[description] =>mp3 player mp3 player mp3 player mp3 player mp3
player mp3 player mp3 player mp3 player mp3 player mp3 player
[meta_title] => boşbırakın
[meta_description] => boşbırakın
[meta_keyword] => etiket1,etiket2
[tag] => boşbırakın
)
)
[model] => mp31
[sku] => boşbırakın
[upc] => boşbırakın
[ean] => boşbırakın
[jan] => boşbırakın
[isbn] => boşbırakın
[mpn] => boşbırakın
[location] => boşbırakın
[price] => 100
[tax_class_id] => 1
[quantity] => 10
[minimum] => 1
[subtract] => 1
[stock_status_id] => 1
[shipping] => 1
[date_available] => 2018-06-27
[length] => 10
[width] => 20
[height] => 5
[length_class_id] => 1
[weight] => 5
[weight_class_id] =>
[status] => 1
[sort_order] => 1
[manufacturer] => boşbırakın
[manufacturer_id] => boşbırakın
[category] => 1
[product_category] => Array
(
[0] => 1
)
[filter] =>
[product_store] => Array
(
[0] => 0
)
[download] =>
[related] =>
[product_related] => Array
(
boşbırakın
)
[product_attribute] => Array
(
[0] => Array
(
[name] => test 1
[attribute_id] => 4
[product_attribute_description] => Array
(
[1] => Array
(
[text] => mp3 player
)
)
)
)
[option] =>
[product_option] => Array
(
[0] => Array
(
[product_option_id] =>
[name] => Checkbox
[option_id] => 2
[type] => checkbox
[required] => 1
)
)
[product_discount] => Array
(
[0] => Array
(
[customer_group_id] => 1
[quantity] => 1
[priority] => 3
[price] => 89
[date_start] => 2018-06-27
[date_end] => 2018-06-30
)
)
[product_special] => Array
(
[0] => Array
(
[customer_group_id] => 1
[priority] => 2
[price] => 64
[date_start] => 2018-06-27
[date_end] => 2018-06-28
)
)
[image] =>
[points] => 100
[product_reward] => Array
(
[1] => Array
(
[points] => 10
)
)
[product_seo_url] => Array
(
[0] => Array
(
[1] => mp3player
)
)
)
NORMAL RESPONSE:-
{
"data": {
"text_form": "Product Added",(Form name)
"languages": {(Name of language)
"en-gb": {
"language_id": "1",
"name": "English",
"code": "en-gb",(Language code)
"locale": "en-US,en_US.UTF-8,en_US,en-gb,english",(Language location)
"image": "gb.png",(Language image name)
"directory": "english",(Language directory name)
"sort_order": "1",(Language shorting order)
"status": "1"(Language status enable or disable)
}
},
"related_approval": "1",(Related To seller Approval)
"limit_approval": "100",(Limit of Seller Approval)
"seller_id": "1",(ID of seller)
"seller_name": "demo seller",(Name of Seller)
"is_approved": "",
"stores": [
{
"store_id": 0,(ID of store)
"name": "Default"
}
],
"tax_classes": [
{
"tax_class_id": "9",(ID of tax class)
"title": "Taxable Goods",(Title of tax class)
"description": "Taxed goods",(Description about tax)
"date_added": "2009-01-06 23:21:53",(Date of adding the tax)
"date_modified": "2011-09-23 14:07:50"(Date of change the Tax class)
},...............
],
"stock_statuses": [
{
"stock_status_id": "6",(ID of stock Status)
"name": "2-3 Days"(In stock or not)
},...............
],
"weight_classes": [
{
"weight_class_id": "1",(Id of Weight Class)
"value": "1.00000000",(Value of weight class)
"language_id": "1",(Id of language)
"title": "Kilogram", (Title like gram, pound etc.)
"unit": "kg"(Unit like kg, gm etc)
},...............
],
"length_classes": [(Length class of products)
{
"length_class_id": "1",(Length Class Id)
"value": "1.00000000",(Value of Length class)
"language_id": "1",(ID of language)
"title": "Centimeter",(Like Cm, m,km,miles etc )
"unit": "cm"
},...............
],
"customer_groups": [
{
"customer_group_id": "1",(Customer id)
"approval": "0",(Approvals of customer groups)
"sort_order": "1", ()
"language_id": "1",
"name": "Default",
"description": "test"
}
],
"thumb": "/image/cache/no_image-100x100.png",
"placeholder": "/image/cache/no_image-100x100.png",
},
"message": "",
"status": "success"
}
ERROR RESPONSE:-
status = error (API)
message = error_permission
status = error (Login)
message = Seller Not Logged In
message = error_permission
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = error_license
status = error (product name)
message = Product Name must be greater than 3 and less than 255 characters!
status= error (meta title)
message= Meta Title must be greater than 3 and less than 255 characters!
status= error (product weight)
message= Product Weight must be greater than 0!
status= error (product price extra type)
message= Extra Price Type is must, Please select either Fixed or Percentage!
status= error (product extra price)
message= Extra Price must be greater than 0!
status= error (product model)
message= Product Model must be greater than 1 and less than 64 characters!
status= error(product seo keyword)
message= SEO URL already in use!
PARAMETERS:
GET REQUEST
product_id=30
NORMAL RESPONSE:
"data": {
"text_form": "Edit Product",(Form name)
"languages": {(Languages To get Seller)
"en-gb": {
"language_id": "1",( Language id base of all language)
"name": "English",(Name of language)
"code": "en-gb", (Language code)
"locale": "en-US,en_US.UTF-8,en_US,en-gb,english",(Language location)
"image": "gb.png",( Language image name)
"directory": "english",(Language directory name)
"sort_order": "1",(Language shorting order)
"status": "1" (Language status enable or disable)
},
"related_approval": "1", (Product approval status)
"limit_approval": "11", (Product limit approval)
"seller_id": "14", (Seller id)
"seller_name": "seller demo1", (Name of seller)
"is_approved": "1",( Product approve required status)
"product_description": {
"1": {
"name": "HTC Touch HD",(Product name)
"description": (Product description) "<p>\r\n\tHTC Touch - in High
Definition. Watch music videos and streaming content in awe-inspiring high
definition clarity for a mobile experience you never thought possible. Seductively
sleek, the HTC Touch HD provides the next generation of mobile functionality, all at
a simple touch. Fully integrated with Windows Mobile Professional 6.1, ultrafast
3.5G, GPS, 5MP camera, plus lots more - all delivered on a breathtakingly crisp
3.8" WVGA touchscreen - you can take control of your mobile world with the
HTC Touch
HD.</p>\r\n<p>\r\n\t<strong>Features</strong></p>\r\
n<ul>\r\n\t<li>\r\n\t\tProcessor Qualcomm® MSM 7201A™ 528
MHz</li>\r\n\t<li>\r\n\t\tWindows Mobile® 6.1 Professional Operating
System</li>\r\n\t<li>\r\n\t\tMemory: 512 MB ROM, 288 MB
RAM</li>\r\n\t<li>\r\n\t\tDimensions: 115 mm x 62.8 mm x 12 mm /
146.4 grams</li>\r\n\t<li>\r\n\t\t3.8-inch TFT-LCD flat touch-sensitive
screen with 480 x 800 WVGA
resolution</li>\r\n\t<li>\r\n\t\tHSDPA/WCDMA: Europe/Asia: 900/2100
MHz; Up to 2 Mbps up-link and 7.2 Mbps down-link
speeds</li>\r\n\t<li>\r\n\t\tQuad-band GSM/GPRS/EDGE: Europe/Asia:
850/900/1800/1900 MHz (Band frequency, HSUPA availability, and data speed are
operator dependent.)</li>\r\n\t<li>\r\n\t\tDevice Control via HTC
TouchFLO™ 3D & Touch-sensitive front panel
buttons</li>\r\n\t<li>\r\n\t\tGPS and A-GPS
ready</li>\r\n\t<li>\r\n\t\tBluetooth® 2.0 with Enhanced Data Rate and
A2DP for wireless stereo headsets</li>\r\n\t<li>\r\n\t\tWi-Fi®: IEEE
802.11 b/g</li>\r\n\t<li>\r\n\t\tHTC ExtUSB™ (11-pin mini-USB
2.0)</li>\r\n\t<li>\r\n\t\t5 megapixel color camera with auto
focus</li>\r\n\t<li>\r\n\t\tVGA CMOS color
camera</li>\r\n\t<li>\r\n\t\tBuilt-in 3.5 mm audio jack, microphone,
speaker, and FM radio</li>\r\n\t<li>\r\n\t\tRing tone formats: AAC,
AAC+, eAAC+, AMR-NB, AMR-WB, QCP, MP3, WMA,
WAV</li>\r\n\t<li>\r\n\t\t40 polyphonic and standard MIDI format 0 and
1 (SMF)/SP MIDI</li>\r\n\t<li>\r\n\t\tRechargeable Lithium-ion or
Lithium-ion polymer 1350 mAh battery</li>\r\n\t<li>\r\n\t\tExpansion
Slot: microSD™ memory card (SD 2.0 compatible)</li>\r\n\t<li>\r\n\t\tAC
Adapter Voltage range/frequency: 100 ~ 240V AC, 50/60 Hz DC output: 5V and
1A</li>\r\n\t<li>\r\n\t\tSpecial Features: FM Radio, G-
Sensor</li>\r\n</ul>\r\n",
"meta_title": "\t HTC Touch HD", (Product Meta title)
"meta_description": "", (ProductMeta description)
"meta_keyword": "",(Product Meta keyword)
Language id[tag] = (Product Meta tag)
},
"2": {
"name": "HTC Touch HD",
"description": "<p>\r\n\tHTC Touch - in High Definition. Watch music
videos and streaming content in awe-inspiring high definition clarity for a mobile
experience you never thought possible. Seductively sleek, the HTC Touch HD
provides the next generation of mobile functionality, all at a simple touch. Fully
integrated with Windows Mobile Professional 6.1, ultrafast 3.5G, GPS, 5MP camera,
plus lots more - all delivered on a breathtakingly crisp 3.8" WVGA touchscreen
- you can take control of your mobile world with the HTC Touch
HD.</p>\r\n<p>\r\n\t<strong>Features</strong></p>\r\
n<ul>\r\n\t<li>\r\n\t\tProcessor Qualcomm® MSM 7201A™ 528
MHz</li>\r\n\t<li>\r\n\t\tWindows Mobile® 6.1 Professional Operating
System</li>\r\n\t<li>\r\n\t\tMemory: 512 MB ROM, 288 MB
RAM</li>\r\n\t<li>\r\n\t\tDimensions: 115 mm x 62.8 mm x 12 mm /
146.4 grams</li>\r\n\t<li>\r\n\t\t3.8-inch TFT-LCD flat touch-sensitive
screen with 480 x 800 WVGA
resolution</li>\r\n\t<li>\r\n\t\tHSDPA/WCDMA: Europe/Asia: 900/2100
MHz; Up to 2 Mbps up-link and 7.2 Mbps down-link
speeds</li>\r\n\t<li>\r\n\t\tQuad-band GSM/GPRS/EDGE: Europe/Asia:
850/900/1800/1900 MHz (Band frequency, HSUPA availability, and data speed are
operator dependent.)</li>\r\n\t<li>\r\n\t\tDevice Control via HTC
TouchFLO™ 3D & Touch-sensitive front panel
buttons</li>\r\n\t<li>\r\n\t\tGPS and A-GPS
ready</li>\r\n\t<li>\r\n\t\tBluetooth® 2.0 with Enhanced Data Rate and
A2DP for wireless stereo headsets</li>\r\n\t<li>\r\n\t\tWi-Fi®: IEEE
802.11 b/g</li>\r\n\t<li>\r\n\t\tHTC ExtUSB™ (11-pin mini-USB
2.0)</li>\r\n\t<li>\r\n\t\t5 megapixel color camera with auto
focus</li>\r\n\t<li>\r\n\t\tVGA CMOS color
camera</li>\r\n\t<li>\r\n\t\tBuilt-in 3.5 mm audio jack, microphone,
speaker, and FM radio</li>\r\n\t<li>\r\n\t\tRing tone formats: AAC,
AAC+, eAAC+, AMR-NB, AMR-WB, QCP, MP3, WMA,
WAV</li>\r\n\t<li>\r\n\t\t40 polyphonic and standard MIDI format 0 and
1 (SMF)/SP MIDI</li>\r\n\t<li>\r\n\t\tRechargeable Lithium-ion or
Lithium-ion polymer 1350 mAh battery</li>\r\n\t<li>\r\n\t\tExpansion
Slot: microSD™ memory card (SD 2.0 compatible)</li>\r\n\t<li>\r\n\t\tAC
Adapter Voltage range/frequency: 100 ~ 240V AC, 50/60 Hz DC output: 5V and
1A</li>\r\n\t<li>\r\n\t\tSpecial Features: FM Radio, G-
Sensor</li>\r\n</ul>\r\n",
"meta_title": "\t HTC Touch HD",",( Product meta title)
"meta_description": "",(Product meta title)
"meta_keyword": "",( Product meta description)
"tag": ""(Product Meta tag)
}
},
"metal": "0",
"price_extra": "0.0000",
"price_extra_type": "0",
"model": "Product 1",
"sku": "",
"upc": "",
"ean": "",
"jan": "",
"isbn": "",
"mpn": "",
"location": "",
"stores": [
{
"store_id": 0,
"name": "Default"
}
],
"product_store": [
"0"
],
"keyword": "htc-touch-hd",
"shipping": "1",
"price": "100.0000",
"tax_classes": [
{
"tax_class_id": "9",
"title": "Taxable Goods",
"description": "Taxed goods",
"date_added": "2009-01-06 23:21:53",
"date_modified": "2011-09-23 14:07:50"
},........
],
"tax_class_id": "9",(Product tax class id base of tax type)
"date_available": "2009-02-03",(Product available data)
"quantity": "935",(Quantity of products)
"minimum": "1",(Product quantity)
"subtract": "1",(Product subtract or not in quantity when product sold, status
like yes or no)
"sort_order": "0",
"stock_statuses": [
{
"stock_status_id": "6",
"name": "2-3 Days"
},........
],
"stock_status_id": "7",
"status": "0",
"weight": "146.40000000",
"weight_classes": [
{
"weight_class_id": "1",
"value": "1.00000000",
"language_id": "1",
"title": "Kilogram",
"unit": "kg"
},................
],
"weight_class_id": "2",
"length": "0.00000000",
"width": "0.00000000",
"height": "0.00000000",
"length_classes": [
{
"length_class_id": "1",
"value": "1.00000000",
"language_id": "1",
"title": "Centimeter",
"unit": "cm"
},........
],
"length_class_id": "1",
"manufacturer_id": "5",
"manufacturer": "HTC",
"product_categories": [
{
"category_id": "20",
"name": "Desktops"
},
{
"category_id": "24",
"name": "Phones & PDAs"
}
],
"product_seo_url": [
{
"1": "htc-touch-hd"
}
],
"customer_groups": [
{
"customer_group_id": "1",
"approval": "0",
"sort_order": "1",
"language_id": "1",
"name": "Default",
"description": "test"
}
],
"image": "catalog/htc_touch_hd_1.jpg",
"thumb": "//image/cache/catalog/htc_touch_hd_1-
100x100.jpg",
"placeholder": "//image/cache/no_image-100x100.png",
"product_images": [
{
"image": "catalog/htc_touch_hd_3.jpg",
"thumb": "//image/cache/catalog/htc_touch_hd_3-
100x100.jpg",
"sort_order": "0"
},
{
"image": "catalog/profile-45x45.png",
"thumb": "//image/cache/catalog/profile-45x45-
100x100.png",
"sort_order": "0"
}
],
"points": "200",
"product_reward": {
"1": {
"points": "400"
}
}
},
"message": "",
"status": "success"
}
PARAMETERS:
Product_id
EXAMPLE OF POST REQUEST:-
Array
(
[seller_id] => 1
[seller_name] => demo seller
[product_description] => Array
(
[1] => Array
(
[name] => mp3 player
[description] =>mp3 player mp3 player mp3 player mp3 player mp3
player mp3 player mp3 player mp3 player mp3 player mp3 player
[meta_title] => mp3 player
[meta_description] => mp3 player mp3 player mp3 player mp3 player
[meta_keyword] => mp3 player
[tag] => mp3
)
)
[model] => mp31
[sku] =>
[upc] =>
[ean] =>
[jan] =>
[isbn] =>
[mpn] =>
[location] =>
[price] => 100
[tax_class_id] => 9
[quantity] => 10
[minimum] => 1
[subtract] => 1
[stock_status_id] => 6
[shipping] => 1
[date_available] => 2018-06-27
[length] =>
[width] =>
[height] =>
[length_class_id] => 1
[weight] =>
[weight_class_id] => 1
[status] => 1
[sort_order] => 1
[manufacturer] => Apple
[manufacturer_id] => 8
[category] =>
[product_category] => Array
(
[0] => 34
)
[filter] =>
[product_store] => Array
(
[0] => 0
)
[download] =>
[related] =>
[product_related] => Array
(
[0] => 34
[1] => 32
)
[product_attribute] => Array
(
[0] => Array
(
[name] => test 1
[attribute_id] => 4
[product_attribute_description] => Array
(
[1] => Array
(
[text] => mp3 player
)
)
)
)
[option] =>
[product_option] => Array
(
[0] => Array
(
[product_option_id] =>
[name] => Checkbox
[option_id] => 2
[type] => checkbox
[required] => 1
)
)
[product_discount] => Array
(
[0] => Array
(
[customer_group_id] => 1
[quantity] => 1
[priority] => 3
[price] => 89
[date_start] => 2018-06-27
[date_end] => 2018-06-30
)
)
[product_special] => Array
(
[0] => Array
(
[customer_group_id] => 1
[priority] => 2
[price] => 64
[date_start] => 2018-06-27
[date_end] => 2018-06-28
)
)
[image] =>
[points] => 100
[product_reward] => Array
(
[1] => Array
(
[points] => 10
)
)
[product_seo_url] => Array
(
[0] => Array
(
[1] => mp3player
)
)
)
NORMAL RESPONSE:
{
"data": [],
"status": "success",
"message": " Success: Success: You have modified products!"
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
status = error (product name)
message = Product Name must be greater than 3 and less than 255 characters!
status= error (meta title)
message= Meta Title must be greater than 3 and less than 255 characters!
status= error (product weight)
message= Product Weight must be greater than 0!
status= error (product price extra type)
message= Extra Price Type is must, Please select either Fixed or Percentage!
status= error (product extra price)
message= Extra Price must be greater than 0!
status= error (product model)
message= Product Model must be greater than 1 and less than 64 characters!
status= error(product seo keyword)
message= SEO URL already in use!
PARAMETERS:
GET request:
product_id = Product id
NORMAL RESPONSE:
{
"product_id":133,
"status":"success",
"message":"Success: You have modified products!"
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
PARAMETERS:
Post request:
EXAMPLE:
Array
(
[selected] => Array
(
[0] => 30
[1] => 34
)
)
Selected = collection of one or more then one product
[0] =>30( selected product id )
NORMAL RESPONSE:
{
"status": "success",
"message": " Success: Success: You have modified products!"
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
GETPARAMETERS:
GET Request:
filter_name = category name
NORMAL RESPONSE:
{
"category_id": "33",(Category Id of product)
"name": "Cameras"(Category name)
},
...............
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
GET Parameters:
GET Request
filter_name = download name
NORMAL RESPONSE:
{
"download_id": "7",(download Id of product)
"name": "adv"(download file name)
},
..................
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
GET PARAMETERS:-
GET Request:
filter_name = product name
NORMAL RESPONSE:
{
"product_id": "30",(product id)
"name": "Canon EOS 5D",(product name)
"model": "Product 3",(product model)
"option": [(product option data array)
{
"product_option_id": "226",
"product_option_value": [
{
"product_option_value_id": "15",
"option_value_id": "39",
"name": "Red",
"price": false,
"price_prefix": "+"
},
],
"option_id": "5",
"name": "Select",
"type": "select",
"value": "",
"required": "1"
}
],
"price": "100.0000"(product price)
},
.................
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
GET PARAMETERS:-
GET Request:
filter_name = attribute name
NORMAL RESPONSE:
{
"attribute_id": "3",(attribute Id of product)
"name": "Clockspeed",( Attribute file name)
"attribute_group": "Processor"(Name of attribute group)
},
............
ERROR RESPONSE:-
status = error (API)
message = error_permission
status = error (Login)
message = Seller Not Logged In
message = error_permission
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = error_license
GET PARAMETERS:
GET Request:
filter_name = option name
NORMAL RESPONSE:
{
"option_id": "4",(Option id of product)
"name": "Text",(Option file name)
"category": "Input",(Category name of option)
"type": "text",(Option type)
"option_value": [](Option value)
},
{
"option_id": "6",
"name": "Textarea",
"category": "Input",
"type": "textarea",
"option_value": []
},
{
"option_id": "9",
"name": "Time",
"category": "Date",
"type": "time",
"option_value": []
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
Katalog->İndirilenler (Kullanım kılavuzu, ürün kılavuzu, tanıtım broşürü gibi indirilebilir dosyalar ekleme)
PARAMETERS:
GET Request:
page= page number
limit = Number of items
NORMAL RESPONSE:
{
"download_id": "2",(Download Id)
"name": "downlaodable2",(Download language name like English, Arabic etc)
"date_added": "13/06/2018"(The Date Downloads language created)
},
{
"download_id": "8",
"name": "fdfd",
"date_added": "13/06/2018"
},
................
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
PARAMETERS:
POST Request:
Example of post request:
Array
(
[download_description] => Array
(
[1] => Array
(
[name] => demo
)
)
[filename] => Jellyfish.jpg.wzV6UCMtMfrxRH4NTRJigF8cXAcnrOcU
[mask] => Jellyfish.jpg
)
download_descriptionb [1] = Language id
Language id [name] = Download Name
filename = You can upload via the upload button or use FTP to upload to the download directory and enter
the details below
mask = The filename and the mask are different to stop people trying to directly link to your downloads.
NORMAL RESPONSE:
{
"data": {
"text_form": "Add Download",(Form name)
"languages": { (Name of language)
"en-gb": {
"language_id": "1",
"name": "English",
"code": "en-gb",(Language code)
"locale": "en-US,en_US.UTF-8,en_US,en-gb,english",(Language location)
"image": "gb.png",(Language image name)
"directory": "english", (Language directory name)
"sort_order": "1",(Language shorting order)
"status": "1"(Language status enable or disable)
}.........
}
},
"message": "",
"status": "success"(API status)
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
status = error (download name)
message = Download Name must be between 3 and 64 characters!
status = error (filename)
message = Filename must be between 3 and 128 characters!
status = error(mask)
message = Mask must be between 3 and 128 characters!
PARAMETERS:
GET Request:
download_id = Download id base of all download
POST request:
EXAMPLE:-
Array
(
[download_description] => Array
(
[1] => Array
(
[name] => demo
)
..............
)
[filename] => Jellyfish.jpg.wzV6UCMtMfrxRH4NTRJigF8cXAcnrOcU
[mask] => Jellyfish.jpg
)
download_descriptionb [1] = Language id
Language id [name] = Download Name
filename = You can upload via the upload button or use FTP to upload to the download directory and enter
the details below
mask = The filename and the mask are different to stop people trying to directly link to your downloads.
NORMAL RESPONSE:
{
"data": {
"text_form": "Edit Download",(Form name)
"languages": {
"en-gb": {
"language_id": "1",(Language id base of all language)
"name": "English",(Name of language)
"code": "en-gb",(Language code)
"locale": "en-US,en_US.UTF-8,en_US,en-gb,english",(Language location)
"image": "gb.png",(Language image name)
"directory": "english", (Language directory name)
"sort_order": "1",(Language shorting order)
"status": "1"(Language status enable or disable)
},.........
},
"download_id": "2",
"download_description": { (Language id)
"1": {
"name": "downlaodable2"(Download Name 1)
},
"2": {
"name": "downlaodable2"(Download Name 2)
}
},
"filename": "Desert.jpg.EBzBXhXtg0Cq6r7LKG70QCCORABGEkOl",(Name of a File).
"mask": "Desert.jpg"
},
"message": "",
"status": "success"
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
status = error (download name)
message = Download Name must be between 3 and 64 characters!
status = error (filename)
message = Filename must be between 3 and 128 characters!
status = error(mask)
message = Mask must be between 3 and 128 characters!
PARAMETERS:
GET Request:
EXAMPLE OF GET REQUEST:
Array
(
[0] => 1
)
1
[0]=>1 = Download id
Normal response:-
{
"data": [],
"status": "success",
"message": "Your file was successfully deleted!"
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
PARAMETERS:
Request:
file =>data from file stream
NORMAL RESPONSE:
{
"data": [],
"status": "success",
"message": "Your file was successfully uploaded!"
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
Mağaza Yorumları
NORMAL RESPONSE:
{
"status": "success",
"message": "",
"data": {
"customer_id": "1",(Customer id)
"reviews": [ (array(blank))
{
"customer_name": "demo seller", (Customer name)
"review_title": "good",(review title like good)
"review_description": "good seller",(Description of Review)
"rating": 5,(rating value base of 1 to 5 option)
"status": "Approved",(rating status)
"date_added": "27/06/2018"(date of seller review created)
}
],
"pagination": {(Link of Pagination)
"total": "1",(Total number of pages)
"page": 1,(means Which page you are on)
"limit": "2" (Limits of pages)
},
"results": "Showing 1 to 1 of 1 (1 Pages)" (Result of Pagination)
}
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
Kargo Ücretleri / Kargo Sistemi
PARAMETERS:
GET request:
Page: 1 (Enter page Number)
Limit: 15 (Enter Number of Items)
NORMAL RESPONSE:
{
"data": {
"sellers": [ (Data of Sellers like id, country, weight, zip etc.)
{
"shipping_id": "10",(Shipping ID)
"seller_id": "14",(Seller ID)
"shipping_country": "India",(Shipping Country NAme)
"zipcode_from": "200300",(Area Code from)
"zipcode_to": "200500",(Area Code To)
"shipping_price": "$7.00",(Shipping Price)
"weight_from": "0.00",(Weight From)
"weight_to": "1000.00"(Weight to)
}
],
"selected": [],(Used for multiple selections like checkbox)
"pagination": {
"total": "23",(Number of page)
"page": 1,(Current page)
"limit": "2"(Number of item like product per page)
},
"results": "Showing 1 to 2 of 23 (12 Pages)",(Number Of Pages (Result of Pagination).)
"shipping_country": "",(Number Country like zip code, address)
"filter_zip_from": "",
(Filter Zip From.) (Filter Zip From.)
"filter_zip_to": "",(Filter Zip To.)
"filter_price": "",(Filter Price.)
"filter_weight_from": "",(Filter Weight From.)
"filter_weight_to": "",(FilterWeight To.)
"countries": [
{
"country_id": "244",
"name": "Aaland Islands",
"iso_code_2": "AX",
"iso_code_3": "ALA",
"address_format": "",
"postcode_required": "0",
"status": "1"
},...............
],
"sort": "name",
"order": "ASC"
},
"message": "",
"status": "success"
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error ['shipping_country']
message = Please select a country!
status = error['zip_from']
message = Zip code required!
status = error['zip_to']
message = Zip code required!
status = error['price']
message = Price required!
status = error['weight_from']
message = Weight required!
PARAMETERS:
GET Request:
shipping _id = 1
NORMAL RESPONSE:-
{
“status": "success",
"message": "Success: You have deleted shipping rate
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
Status = error (Success)
Message = Success: You have deleted shipping rate”
PARAMETERS: -
Post request:
EXAMPLE:
Array
(
[selected] => Array
(
[0] => 30
[1] => 34
)
)
NORMAL RESPONSE:-
{
“status": "success",
"message": "Success: You have deleted shipping rate!”
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data
Status = error (Success)
Message = Success: You have deleted shipping rate”
Mağaza Müşteri İletişimi
PARAMETERS : GET
page = Page number
limit =Number of items
Normal response:-
{
"status": "success",
"message": "",
"data": {
"contact_mode": "1",(Type of mode like logged in mode or general)
"sellercontacts": [
{
"id": "138",(last message id customer/seller)
"message": "hello customer",(last message)
"customer_id": "20",
"contact_from": "1",
"customer_name": "Calvin Carter",
"customer_email": "[email protected]",(Customer Email ID)
"date_added": "06/07/2018"(communication start date)
}
],
"config_contactseller": "1",(Contact seller status base of admin)
"pagination": {
"total": "1",(Number of page )
"page": 1,(Current page)
"limit": 1(Number of item like product per page)
},
"results": "Showing 1 to 1 of 1 (1 Pages)"(pagination results)
}
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
PARAMETERS:
GET id:last message id with customer
NORMAL RESPONSE:
{
"data": {
"contact_mode": "1",
"customer_id": "20",
"customer": "14",
"sellercontacts": [
{
"contact_from": "0",(reply person like 0 is seller or 1 customer)
"customer_id": "20",(Id of Customer)
"customer_name": "Calvin Carter",(Name of Customer )
"customer_email": "[email protected]",(Customer Email)
"customer_messages": "hello seller...."(Messagesof customer to seller)
"date_added": "06/07/2018"(Date of Added)
},
{
"contact_from": "1",
"customer_id": "20",
"customer_name": "seller demo1",
"customer_email": "[email protected]",
"customer_messages": "badyaaaaaaaaaaaaaa",
"date_added": "06/07/2018"
}
]
}
}
ERROR RESPONSE:-
status = error (API)
message = Permission Error. Check API credentials
status = error (Login)
message = Seller Not Logged In
status = error ( Is Seller)
message = Seller Not Approved
status = error (License)
message = Invalid License
status = error
message = No Data