Introduction

Welcome to the generated API reference. Get Postman Collection

Customers

Add Customer

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/customer" \
-H "Accept: application/json" \
    -d "firstname"="optio" \
    -d "email"="howell98@example.org" \
    -d "telephone"="optio" \
    -d "password"="optio" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/customer",
    "method": "POST",
    "data": {
        "firstname": "optio",
        "email": "howell98@example.org",
        "telephone": "optio",
        "password": "optio"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "customer_id": 1
    }
}

HTTP Request

POST v1/in/customer

Middleware

api

Parameters

Parameter	Type	Status	Description
firstname	string	required
email	email	required
telephone	string	required
password	string	required

Update customer.

Example request:

curl -X PUT "http://api.vanillaeshop.com/v1/in/customer/{customer}" \
-H "Accept: application/json" \
    -d "firstname"="sint" \
    -d "email"="haleigh24@example.com" \
    -d "telephone"="sint" \
    -d "password"="sint" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/customer/{customer}",
    "method": "PUT",
    "data": {
        "firstname": "sint",
        "email": "haleigh24@example.com",
        "telephone": "sint",
        "password": "sint"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "customer_id": 1
    }
}

HTTP Request

PUT v1/in/customer/{customer} PATCH v1/in/customer/{customer}

Middleware

api

Parameters

Parameter	Type	Status	Description
firstname	string	required
email	email	required
telephone	string	required
password	string	optional

Remove customer.

Example request:

curl -X DELETE "http://api.vanillaeshop.com/v1/in/customer/{customer}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/customer/{customer}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": null
}

HTTP Request

DELETE v1/in/customer/{customer}

Middleware

api

Manufacture

Add manufacturer

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/manufacturer" \
-H "Accept: application/json" \
    -d "name"="qui" \
    -d "entity_id"="qui" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/manufacturer",
    "method": "POST",
    "data": {
        "name": "qui",
        "entity_id": "qui"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": null
}

HTTP Request

POST v1/in/manufacturer

Middleware

api

Parameters

Parameter	Type	Status	Description
name	string	required
entity_id	string	required

Update manufacturer

replace {manufacturer} to entity id of magento

Example request:

curl -X PUT "http://api.vanillaeshop.com/v1/in/manufacturer/{manufacturer}" \
-H "Accept: application/json" \
    -d "name"="sit" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/manufacturer/{manufacturer}",
    "method": "PUT",
    "data": {
        "name": "sit"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": null
}

HTTP Request

PUT v1/in/manufacturer/{manufacturer} PATCH v1/in/manufacturer/{manufacturer}

Middleware

api

Parameters

Parameter	Type	Status	Description
name	string	required

Options

Create Option Value.

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/optionValue" \
-H "Accept: application/json" \
    -d "option_id"="consequatur" \
    -d "ar"="consequatur" \
    -d "ar.name"="consequatur" \
    -d "en"="consequatur" \
    -d "en.name"="consequatur" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/optionValue",
    "method": "POST",
    "data": {
        "option_id": "consequatur",
        "ar": "consequatur",
        "ar.name": "consequatur",
        "en": "consequatur",
        "en.name": "consequatur"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "option_value_id": 23,
        "option_id": 2,
        "image": "",
        "sort_order": 1
    }
}

HTTP Request

POST v1/in/optionValue

Middleware

api

Parameters

Parameter	Type	Status	Description
option_id	string	required	Valid option option_id
ar	array	required
ar.name	string	required
en	array	required
en.name	string	required

Update Option Value.

replace {optionValue} with option_value_id

Example request:

curl -X PUT "http://api.vanillaeshop.com/v1/in/optionValue/{optionValue}" \
-H "Accept: application/json" \
    -d "option_id"="voluptate" \
    -d "ar"="voluptate" \
    -d "ar.name"="voluptate" \
    -d "en"="voluptate" \
    -d "en.name"="voluptate" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/optionValue/{optionValue}",
    "method": "PUT",
    "data": {
        "option_id": "voluptate",
        "ar": "voluptate",
        "ar.name": "voluptate",
        "en": "voluptate",
        "en.name": "voluptate"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "option_value_id": 23,
        "option_id": 2,
        "image": "",
        "sort_order": 1
    }
}

HTTP Request

PUT v1/in/optionValue/{optionValue} PATCH v1/in/optionValue/{optionValue}

Middleware

api

Parameters

Parameter	Type	Status	Description
option_id	string	required	Valid option option_id
ar	array	required
ar.name	string	required
en	array	required
en.name	string	required

Order

Update Order address

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/order/{order}/updateAddress" \
-H "Accept: application/json" \
    -d "payment_firstname"="nihil" \
    -d "payment_lastname"="nihil" \
    -d "payment_address_1"="nihil" \
    -d "payment_address_2"="nihil" \
    -d "payment_city"="nihil" \
    -d "payment_postcode"="nihil" \
    -d "payment_country_id"="nihil" \
    -d "payment_zone_id"="nihil" \
    -d "payment_address_lat"="nihil" \
    -d "payment_address_lng"="nihil" \
    -d "shipping_firstname"="nihil" \
    -d "shipping_lastname"="nihil" \
    -d "shipping_address_1"="nihil" \
    -d "shipping_address_2"="nihil" \
    -d "shipping_city"="nihil" \
    -d "shipping_postcode"="nihil" \
    -d "shipping_country_id"="nihil" \
    -d "shipping_zone_id"="nihil" \
    -d "shipping_telephone"="nihil" \
    -d "shipping_address_lat"="nihil" \
    -d "shipping_address_lng"="nihil" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/order/{order}/updateAddress",
    "method": "POST",
    "data": {
        "payment_firstname": "nihil",
        "payment_lastname": "nihil",
        "payment_address_1": "nihil",
        "payment_address_2": "nihil",
        "payment_city": "nihil",
        "payment_postcode": "nihil",
        "payment_country_id": "nihil",
        "payment_zone_id": "nihil",
        "payment_address_lat": "nihil",
        "payment_address_lng": "nihil",
        "shipping_firstname": "nihil",
        "shipping_lastname": "nihil",
        "shipping_address_1": "nihil",
        "shipping_address_2": "nihil",
        "shipping_city": "nihil",
        "shipping_postcode": "nihil",
        "shipping_country_id": "nihil",
        "shipping_zone_id": "nihil",
        "shipping_telephone": "nihil",
        "shipping_address_lat": "nihil",
        "shipping_address_lng": "nihil"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "order_id": 2,
        "invoice_no": 138,
        "invoice_prefix": "INV-2011-0",
        "store_id": 0,
        "store_name": "Your Store",
        "store_url": "http:\/\/dev.ecommercesea.com\/ocar\/",
        "customer_id": 0,
        "customer_group_id": 8,
        "firstname": "بدون اسم",
        "lastname": "يوووه",
        "email": "imailq.q@gmail.com",
        "telephone": "0597170004",
        "fax": "",
        "payment_firstname": "بدون اسم",
        "payment_lastname": "يوووه",
        "payment_company": "",
        "shipping_firstname": "بدون اسم",
        "shipping_lastname": "يوووه",
        "shipping_company": "",
        "shipping_address_1": "الشركة",
        "shipping_address_2": "",
        "shipping_city": "Riyadh",
        "shipping_postcode": "22211",
        "shipping_country": "Saudi Arabia",
        "shipping_country_id": 184,
        "shipping_zone": "المدينة المنورة",
        "shipping_zone_id": 2877,
        "shipping_zone_naqel": null,
        "shipping_address_lat": null,
        "shipping_address_lng": null,
        "shipping_address_format": "",
        "shipping_method": "شحن عادي",
        "shipping_cost": "0.0000",
        "shipping_code": "flat.flat",
        "comment": "",
        "total": "105.0000",
        "reward": 0,
        "order_status_id": 7,
        "affiliate_id": 0,
        "commission": "0.0000",
        "language_id": 2,
        "currency_id": 2,
        "currency_code": "USD",
        "currency_value": "1.00000000",
        "date_completed": "2011-10-25 10:31:24",
        "ip": "77.30.3.140",
        "forwarded_ip": "",
        "user_agent": "",
        "accept_language": "",
        "date_added": "2011-10-25 10:31:24",
        "date_modified": "2012-04-10 12:30:34",
        "money_received": 0,
        "money_confirmed": 0,
        "notified": 0,
        "survey": 0,
        "kashoo_sent": 1,
        "payment_company_id": "",
        "payment_tax_id": "",
        "payment_address_1": "الشركة",
        "payment_address_2": "",
        "payment_city": "Riyadh",
        "payment_postcode": "22211",
        "payment_country": "Saudi Arabia",
        "payment_country_id": 184,
        "payment_zone": "Al Madinah",
        "payment_zone_id": 2877,
        "payment_w3w": null,
        "payment_address_lat": null,
        "payment_address_lng": null,
        "payment_address_format": "",
        "payment_method": "تـحـويـل بـنـكـي",
        "is_gift": 0,
        "prepare_by": null,
        "payment_cost": "0.0000",
        "payment_code": "bank_transfer",
        "promotions": null,
        "shipping_telephone": null,
        "gift_code": null,
        "free_shipping": null,
        "is_mobile_order": null,
        "products": [],
        "totals": [],
        "history": []
    }
}

HTTP Request

POST v1/in/order/{order}/updateAddress

Middleware

api, skip-db-trigger

Parameters

Parameter	Type	Status	Description
payment_firstname	string	required
payment_lastname	string	optional
payment_address_1	string	required
payment_address_2	string	required
payment_city	string	required
payment_postcode	string	optional
payment_country_id	string	required	Valid country iso_code_2
payment_zone_id	string	required	Valid zone code
payment_address_lat	string	optional
payment_address_lng	string	optional
shipping_firstname	string	required
shipping_lastname	string	optional
shipping_address_1	string	required
shipping_address_2	string	required
shipping_city	string	required
shipping_postcode	string	optional
shipping_country_id	string	required	Valid country iso_code_2
shipping_zone_id	string	required	Valid zone code
shipping_telephone	string	required
shipping_address_lat	string	optional
shipping_address_lng	string	optional

Create Order

Create a new order.

the entity id of product should be the entity id of magento for example

• if the product is simple then will be the entity id of product
• if the product is Configuration then the entity id will the id of option

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/order" \
-H "Accept: application/json" \
    -d "order_id"="1727611741" \
    -d "store_id"="63568784" \
    -d "customer_id"="aut" \
    -d "customer_group_id"="aut" \
    -d "firstname"="aut" \
    -d "lastname"="aut" \
    -d "email"="inicolas@example.com" \
    -d "telephone"="aut" \
    -d "fax"="aut" \
    -d "payment_firstname"="aut" \
    -d "payment_lastname"="aut" \
    -d "payment_address_1"="aut" \
    -d "payment_address_2"="aut" \
    -d "payment_city"="aut" \
    -d "payment_postcode"="aut" \
    -d "payment_country_id"="aut" \
    -d "payment_zone_id"="aut" \
    -d "payment_address_lat"="aut" \
    -d "payment_address_lng"="aut" \
    -d "shipping_firstname"="aut" \
    -d "shipping_lastname"="aut" \
    -d "shipping_address_1"="aut" \
    -d "shipping_address_2"="aut" \
    -d "shipping_city"="aut" \
    -d "shipping_postcode"="aut" \
    -d "shipping_country_id"="aut" \
    -d "shipping_zone_id"="aut" \
    -d "shipping_telephone"="aut" \
    -d "shipping_address_lat"="aut" \
    -d "shipping_address_lng"="aut" \
    -d "shipping_code"="returns.returns" \
    -d "payment_code"="bank_transfer" \
    -d "coupon"="aut" \
    -d "order_status_code"="processing_warehouse" \
    -d "is_gift"="1" \
    -d "gift_code"="G8" \
    -d "is_mobile_order"="1" \
    -d "comment"="aut" \
    -d "language"="en" \
    -d "forwarded_ip"="aut" \
    -d "ip"="aut" \
    -d "user_agent"="aut" \
    -d "accept_language"="aut" \
    -d "promotions"="aut" \
    -d "products"="aut" \
    -d "totals"="aut" \
    -d "products.0.sku"="aut" \
    -d "products.0.name"="aut" \
    -d "products.0.quantity"="1727513960" \
    -d "products.0.price"="1727513960" \
    -d "products.0.cost"="1727513960" \
    -d "products.0.total"="1727513960" \
    -d "products.0.tax"="1727513960" \
    -d "totals.0.code"="tax" \
    -d "totals.0.title"="aut" \
    -d "totals.0.value"="63568784" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/order",
    "method": "POST",
    "data": {
        "order_id": 1727611741,
        "store_id": 63568784,
        "customer_id": "aut",
        "customer_group_id": "aut",
        "firstname": "aut",
        "lastname": "aut",
        "email": "inicolas@example.com",
        "telephone": "aut",
        "fax": "aut",
        "payment_firstname": "aut",
        "payment_lastname": "aut",
        "payment_address_1": "aut",
        "payment_address_2": "aut",
        "payment_city": "aut",
        "payment_postcode": "aut",
        "payment_country_id": "aut",
        "payment_zone_id": "aut",
        "payment_address_lat": "aut",
        "payment_address_lng": "aut",
        "shipping_firstname": "aut",
        "shipping_lastname": "aut",
        "shipping_address_1": "aut",
        "shipping_address_2": "aut",
        "shipping_city": "aut",
        "shipping_postcode": "aut",
        "shipping_country_id": "aut",
        "shipping_zone_id": "aut",
        "shipping_telephone": "aut",
        "shipping_address_lat": "aut",
        "shipping_address_lng": "aut",
        "shipping_code": "returns.returns",
        "payment_code": "bank_transfer",
        "coupon": "aut",
        "order_status_code": "processing_warehouse",
        "is_gift": true,
        "gift_code": "G8",
        "is_mobile_order": true,
        "comment": "aut",
        "language": "en",
        "forwarded_ip": "aut",
        "ip": "aut",
        "user_agent": "aut",
        "accept_language": "aut",
        "promotions": "aut",
        "products": "aut",
        "totals": "aut",
        "products.0.sku": "aut",
        "products.0.name": "aut",
        "products.0.quantity": 1727513960,
        "products.0.price": 1727513960,
        "products.0.cost": 1727513960,
        "products.0.total": 1727513960,
        "products.0.tax": 1727513960,
        "totals.0.code": "tax",
        "totals.0.title": "aut",
        "totals.0.value": 63568784
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "order_id": 2,
        "invoice_no": 138,
        "invoice_prefix": "INV-2011-0",
        "store_id": 0,
        "store_name": "Your Store",
        "store_url": "http:\/\/dev.ecommercesea.com\/ocar\/",
        "customer_id": 0,
        "customer_group_id": 8,
        "firstname": "بدون اسم",
        "lastname": "يوووه",
        "email": "imailq.q@gmail.com",
        "telephone": "0597170004",
        "fax": "",
        "payment_firstname": "بدون اسم",
        "payment_lastname": "يوووه",
        "payment_company": "",
        "shipping_firstname": "بدون اسم",
        "shipping_lastname": "يوووه",
        "shipping_company": "",
        "shipping_address_1": "الشركة",
        "shipping_address_2": "",
        "shipping_city": "Riyadh",
        "shipping_postcode": "22211",
        "shipping_country": "Saudi Arabia",
        "shipping_country_id": 184,
        "shipping_zone": "المدينة المنورة",
        "shipping_zone_id": 2877,
        "shipping_zone_naqel": null,
        "shipping_address_lat": null,
        "shipping_address_lng": null,
        "shipping_address_format": "",
        "shipping_method": "شحن عادي",
        "shipping_cost": "0.0000",
        "shipping_code": "flat.flat",
        "comment": "",
        "total": "105.0000",
        "reward": 0,
        "order_status_id": 7,
        "affiliate_id": 0,
        "commission": "0.0000",
        "language_id": 2,
        "currency_id": 2,
        "currency_code": "USD",
        "currency_value": "1.00000000",
        "date_completed": "2011-10-25 10:31:24",
        "ip": "77.30.3.140",
        "forwarded_ip": "",
        "user_agent": "",
        "accept_language": "",
        "date_added": "2011-10-25 10:31:24",
        "date_modified": "2012-04-10 12:30:34",
        "money_received": 0,
        "money_confirmed": 0,
        "notified": 0,
        "survey": 0,
        "kashoo_sent": 1,
        "payment_company_id": "",
        "payment_tax_id": "",
        "payment_address_1": "الشركة",
        "payment_address_2": "",
        "payment_city": "Riyadh",
        "payment_postcode": "22211",
        "payment_country": "Saudi Arabia",
        "payment_country_id": 184,
        "payment_zone": "Al Madinah",
        "payment_zone_id": 2877,
        "payment_w3w": null,
        "payment_address_lat": null,
        "payment_address_lng": null,
        "payment_address_format": "",
        "payment_method": "تـحـويـل بـنـكـي",
        "is_gift": 0,
        "prepare_by": null,
        "payment_cost": "0.0000",
        "payment_code": "bank_transfer",
        "promotions": null,
        "shipping_telephone": null,
        "gift_code": null,
        "free_shipping": null,
        "is_mobile_order": null,
        "products": [],
        "totals": [],
        "history": []
    }
}

HTTP Request

POST v1/in/order

Middleware

api, skip-db-trigger

Parameters

Parameter	Type	Status	Description
order_id	numeric	required	Minimum: 500000
store_id	numeric	required	Valid store store_id
customer_id	string	optional	Valid customer customer_id
customer_group_id	string	optional	Valid customer_group customer_group_id
firstname	string	required
lastname	string	required
email	email	required
telephone	string	required
fax	string	optional
payment_firstname	string	required
payment_lastname	string	optional
payment_address_1	string	required
payment_address_2	string	required
payment_city	string	required
payment_postcode	string	optional
payment_country_id	string	required	Valid country iso_code_2
payment_zone_id	string	required	Valid zone code
payment_address_lat	string	optional
payment_address_lng	string	optional
shipping_firstname	string	required
shipping_lastname	string	optional
shipping_address_1	string	required
shipping_address_2	string	required
shipping_city	string	required
shipping_postcode	string	optional
shipping_country_id	string	required	Valid country iso_code_2
shipping_zone_id	string	required	Valid zone code
shipping_telephone	string	required
shipping_address_lat	string	optional
shipping_address_lng	string	optional
shipping_code	string	required	flat.flat, flat3.flat3, flat2.flat2, free.free or returns.returns
payment_code	string	required	cod3, cod, free_checkout, payfort_fort or bank_transfer
coupon	string	optional
order_status_code	string	required	canceled, complete, fraud, holded, payment_review, paypal_canceled_reversal, paypal_reversed, pending, pending_mobile_confirm, pending_payment, pending_paypal, processing, processing_warehouse, ready_to_ship, shipped or under_review
is_gift	boolean	required
gift_code	string	optional	G0, G2, G1, G5, G6, G4, G3, G7, G8 or G9
is_mobile_order	boolean	required
comment	string	optional
language	string	required	ar or en
forwarded_ip	string	optional
ip	string	optional
user_agent	string	optional
accept_language	string	optional
promotions	array	optional	Valid promotion promotion_id
products	array	required	Minimum: 1
totals	array	required	Minimum: 3
products.0.sku	string	required
products.0.name	string	required
products.0.quantity	numeric	required	Minimum: 1
products.0.price	numeric	required	Minimum: 0
products.0.cost	numeric	required	Minimum: 0
products.0.total	numeric	required	Minimum: 0
products.0.tax	numeric	required	Minimum: 0
totals.0.code	string	required	bundle, cod3, cod, coupon, credit, gift, payfort_fort_charges, sadad_charges, shipping, sub_total, tax, total or voucher
totals.0.title	string	required
totals.0.value	numeric	required

Get Order

Example request:

curl -X GET "http://api.vanillaeshop.com/v1/in/order/{order}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/order/{order}",
    "method": "GET",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "order_id": 2,
        "invoice_no": 138,
        "invoice_prefix": "INV-2011-0",
        "store_id": 0,
        "store_name": "Your Store",
        "store_url": "http:\/\/dev.ecommercesea.com\/ocar\/",
        "customer_id": 0,
        "customer_group_id": 8,
        "firstname": "بدون اسم",
        "lastname": "يوووه",
        "email": "imailq.q@gmail.com",
        "telephone": "0597170004",
        "fax": "",
        "payment_firstname": "بدون اسم",
        "payment_lastname": "يوووه",
        "payment_company": "",
        "shipping_firstname": "بدون اسم",
        "shipping_lastname": "يوووه",
        "shipping_company": "",
        "shipping_address_1": "الشركة",
        "shipping_address_2": "",
        "shipping_city": "Riyadh",
        "shipping_postcode": "22211",
        "shipping_country": "Saudi Arabia",
        "shipping_country_id": 184,
        "shipping_zone": "المدينة المنورة",
        "shipping_zone_id": 2877,
        "shipping_zone_naqel": null,
        "shipping_address_lat": null,
        "shipping_address_lng": null,
        "shipping_address_format": "",
        "shipping_method": "شحن عادي",
        "shipping_cost": "0.0000",
        "shipping_code": "flat.flat",
        "comment": "",
        "total": "105.0000",
        "reward": 0,
        "order_status_id": 7,
        "affiliate_id": 0,
        "commission": "0.0000",
        "language_id": 2,
        "currency_id": 2,
        "currency_code": "USD",
        "currency_value": "1.00000000",
        "date_completed": "2011-10-25 10:31:24",
        "ip": "77.30.3.140",
        "forwarded_ip": "",
        "user_agent": "",
        "accept_language": "",
        "date_added": "2011-10-25 10:31:24",
        "date_modified": "2012-04-10 12:30:34",
        "money_received": 0,
        "money_confirmed": 0,
        "notified": 0,
        "survey": 0,
        "kashoo_sent": 1,
        "payment_company_id": "",
        "payment_tax_id": "",
        "payment_address_1": "الشركة",
        "payment_address_2": "",
        "payment_city": "Riyadh",
        "payment_postcode": "22211",
        "payment_country": "Saudi Arabia",
        "payment_country_id": 184,
        "payment_zone": "Al Madinah",
        "payment_zone_id": 2877,
        "payment_w3w": null,
        "payment_address_lat": null,
        "payment_address_lng": null,
        "payment_address_format": "",
        "payment_method": "تـحـويـل بـنـكـي",
        "is_gift": 0,
        "prepare_by": null,
        "payment_cost": "0.0000",
        "payment_code": "bank_transfer",
        "promotions": null,
        "shipping_telephone": null,
        "gift_code": null,
        "free_shipping": null,
        "is_mobile_order": null,
        "products": [],
        "totals": [],
        "history": []
    }
}

HTTP Request

GET v1/in/order/{order} HEAD v1/in/order/{order}

Middleware

api, skip-db-trigger

Update Order

Example request:

curl -X PUT "http://api.vanillaeshop.com/v1/in/order/{order}" \
-H "Accept: application/json" \
    -d "store_id"="75" \
    -d "customer_id"="ratione" \
    -d "customer_group_id"="ratione" \
    -d "firstname"="ratione" \
    -d "lastname"="ratione" \
    -d "email"="roob.holly@example.net" \
    -d "telephone"="ratione" \
    -d "fax"="ratione" \
    -d "payment_firstname"="ratione" \
    -d "payment_lastname"="ratione" \
    -d "payment_address_1"="ratione" \
    -d "payment_address_2"="ratione" \
    -d "payment_city"="ratione" \
    -d "payment_postcode"="ratione" \
    -d "payment_country_id"="ratione" \
    -d "payment_zone_id"="ratione" \
    -d "payment_address_lat"="ratione" \
    -d "payment_address_lng"="ratione" \
    -d "shipping_firstname"="ratione" \
    -d "shipping_lastname"="ratione" \
    -d "shipping_address_1"="ratione" \
    -d "shipping_address_2"="ratione" \
    -d "shipping_city"="ratione" \
    -d "shipping_postcode"="ratione" \
    -d "shipping_country_id"="ratione" \
    -d "shipping_zone_id"="ratione" \
    -d "shipping_telephone"="ratione" \
    -d "shipping_address_lat"="ratione" \
    -d "shipping_address_lng"="ratione" \
    -d "shipping_code"="flat.flat" \
    -d "payment_code"="cod3" \
    -d "coupon"="ratione" \
    -d "order_status_code"="fraud" \
    -d "is_gift"="1" \
    -d "gift_code"="G2" \
    -d "is_mobile_order"="1" \
    -d "comment"="ratione" \
    -d "language"="ar" \
    -d "forwarded_ip"="ratione" \
    -d "ip"="ratione" \
    -d "user_agent"="ratione" \
    -d "accept_language"="ratione" \
    -d "promotions"="ratione" \
    -d "products"="ratione" \
    -d "totals"="ratione" \
    -d "products.0.sku"="ratione" \
    -d "products.0.name"="ratione" \
    -d "products.0.quantity"="314015005" \
    -d "products.0.price"="314015005" \
    -d "products.0.cost"="314015005" \
    -d "products.0.total"="314015005" \
    -d "products.0.tax"="314015005" \
    -d "totals.0.code"="cod3" \
    -d "totals.0.title"="ratione" \
    -d "totals.0.value"="75" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/order/{order}",
    "method": "PUT",
    "data": {
        "store_id": 75,
        "customer_id": "ratione",
        "customer_group_id": "ratione",
        "firstname": "ratione",
        "lastname": "ratione",
        "email": "roob.holly@example.net",
        "telephone": "ratione",
        "fax": "ratione",
        "payment_firstname": "ratione",
        "payment_lastname": "ratione",
        "payment_address_1": "ratione",
        "payment_address_2": "ratione",
        "payment_city": "ratione",
        "payment_postcode": "ratione",
        "payment_country_id": "ratione",
        "payment_zone_id": "ratione",
        "payment_address_lat": "ratione",
        "payment_address_lng": "ratione",
        "shipping_firstname": "ratione",
        "shipping_lastname": "ratione",
        "shipping_address_1": "ratione",
        "shipping_address_2": "ratione",
        "shipping_city": "ratione",
        "shipping_postcode": "ratione",
        "shipping_country_id": "ratione",
        "shipping_zone_id": "ratione",
        "shipping_telephone": "ratione",
        "shipping_address_lat": "ratione",
        "shipping_address_lng": "ratione",
        "shipping_code": "flat.flat",
        "payment_code": "cod3",
        "coupon": "ratione",
        "order_status_code": "fraud",
        "is_gift": true,
        "gift_code": "G2",
        "is_mobile_order": true,
        "comment": "ratione",
        "language": "ar",
        "forwarded_ip": "ratione",
        "ip": "ratione",
        "user_agent": "ratione",
        "accept_language": "ratione",
        "promotions": "ratione",
        "products": "ratione",
        "totals": "ratione",
        "products.0.sku": "ratione",
        "products.0.name": "ratione",
        "products.0.quantity": 314015005,
        "products.0.price": 314015005,
        "products.0.cost": 314015005,
        "products.0.total": 314015005,
        "products.0.tax": 314015005,
        "totals.0.code": "cod3",
        "totals.0.title": "ratione",
        "totals.0.value": 75
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "order_id": 2,
        "invoice_no": 138,
        "invoice_prefix": "INV-2011-0",
        "store_id": 0,
        "store_name": "Your Store",
        "store_url": "http:\/\/dev.ecommercesea.com\/ocar\/",
        "customer_id": 0,
        "customer_group_id": 8,
        "firstname": "بدون اسم",
        "lastname": "يوووه",
        "email": "imailq.q@gmail.com",
        "telephone": "0597170004",
        "fax": "",
        "payment_firstname": "بدون اسم",
        "payment_lastname": "يوووه",
        "payment_company": "",
        "shipping_firstname": "بدون اسم",
        "shipping_lastname": "يوووه",
        "shipping_company": "",
        "shipping_address_1": "الشركة",
        "shipping_address_2": "",
        "shipping_city": "Riyadh",
        "shipping_postcode": "22211",
        "shipping_country": "Saudi Arabia",
        "shipping_country_id": 184,
        "shipping_zone": "المدينة المنورة",
        "shipping_zone_id": 2877,
        "shipping_zone_naqel": null,
        "shipping_address_lat": null,
        "shipping_address_lng": null,
        "shipping_address_format": "",
        "shipping_method": "شحن عادي",
        "shipping_cost": "0.0000",
        "shipping_code": "flat.flat",
        "comment": "",
        "total": "105.0000",
        "reward": 0,
        "order_status_id": 7,
        "affiliate_id": 0,
        "commission": "0.0000",
        "language_id": 2,
        "currency_id": 2,
        "currency_code": "USD",
        "currency_value": "1.00000000",
        "date_completed": "2011-10-25 10:31:24",
        "ip": "77.30.3.140",
        "forwarded_ip": "",
        "user_agent": "",
        "accept_language": "",
        "date_added": "2011-10-25 10:31:24",
        "date_modified": "2012-04-10 12:30:34",
        "money_received": 0,
        "money_confirmed": 0,
        "notified": 0,
        "survey": 0,
        "kashoo_sent": 1,
        "payment_company_id": "",
        "payment_tax_id": "",
        "payment_address_1": "الشركة",
        "payment_address_2": "",
        "payment_city": "Riyadh",
        "payment_postcode": "22211",
        "payment_country": "Saudi Arabia",
        "payment_country_id": 184,
        "payment_zone": "Al Madinah",
        "payment_zone_id": 2877,
        "payment_w3w": null,
        "payment_address_lat": null,
        "payment_address_lng": null,
        "payment_address_format": "",
        "payment_method": "تـحـويـل بـنـكـي",
        "is_gift": 0,
        "prepare_by": null,
        "payment_cost": "0.0000",
        "payment_code": "bank_transfer",
        "promotions": null,
        "shipping_telephone": null,
        "gift_code": null,
        "free_shipping": null,
        "is_mobile_order": null,
        "products": [],
        "totals": [],
        "history": []
    }
}

HTTP Request

PUT v1/in/order/{order} PATCH v1/in/order/{order}

Middleware

api, skip-db-trigger

Parameters

Parameter	Type	Status	Description
store_id	numeric	required	Valid store store_id
customer_id	string	optional	Valid customer customer_id
customer_group_id	string	optional	Valid customer_group customer_group_id
firstname	string	required
lastname	string	required
email	email	required
telephone	string	required
fax	string	optional
payment_firstname	string	required
payment_lastname	string	optional
payment_address_1	string	required
payment_address_2	string	required
payment_city	string	required
payment_postcode	string	optional
payment_country_id	string	required	Valid country iso_code_2
payment_zone_id	string	required	Valid zone code
payment_address_lat	string	optional
payment_address_lng	string	optional
shipping_firstname	string	required
shipping_lastname	string	optional
shipping_address_1	string	required
shipping_address_2	string	required
shipping_city	string	required
shipping_postcode	string	optional
shipping_country_id	string	required	Valid country iso_code_2
shipping_zone_id	string	required	Valid zone code
shipping_telephone	string	required
shipping_address_lat	string	optional
shipping_address_lng	string	optional
shipping_code	string	required	flat.flat, flat3.flat3, flat2.flat2, free.free or returns.returns
payment_code	string	required	cod3, cod, free_checkout, payfort_fort or bank_transfer
coupon	string	optional
order_status_code	string	required	canceled, complete, fraud, holded, payment_review, paypal_canceled_reversal, paypal_reversed, pending, pending_mobile_confirm, pending_payment, pending_paypal, processing, processing_warehouse, ready_to_ship, shipped or under_review
is_gift	boolean	required
gift_code	string	optional	G0, G2, G1, G5, G6, G4, G3, G7, G8 or G9
is_mobile_order	boolean	required
comment	string	optional
language	string	required	ar or en
forwarded_ip	string	optional
ip	string	optional
user_agent	string	optional
accept_language	string	optional
promotions	array	optional	Valid promotion promotion_id
products	array	required	Minimum: 1
totals	array	required	Minimum: 3
products.0.sku	string	required
products.0.name	string	required
products.0.quantity	numeric	required	Minimum: 1
products.0.price	numeric	required	Minimum: 0
products.0.cost	numeric	required	Minimum: 0
products.0.total	numeric	required	Minimum: 0
products.0.tax	numeric	required	Minimum: 0
totals.0.code	string	required	bundle, cod3, cod, coupon, credit, gift, payfort_fort_charges, sadad_charges, shipping, sub_total, tax, total or voucher
totals.0.title	string	required
totals.0.value	numeric	required

Change Order Status

Update order status and insert comment.

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/orderStatus" \
-H "Accept: application/json" \
    -d "order_status_code"="holded" \
    -d "order_id"="dolore" \
    -d "user_id"="dolore" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/orderStatus",
    "method": "POST",
    "data": {
        "order_status_code": "holded",
        "order_id": "dolore",
        "user_id": "dolore"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "order_history_id": 12,
        "order_history_template_id": -1,
        "order_id": 19,
        "user_id": -1,
        "order_status_id": 1,
        "notify": 1,
        "comment": "",
        "date_added": "2011-11-15 09:39:23"
    }
}

HTTP Request

POST v1/in/orderStatus

Middleware

api, skip-db-trigger

Parameters

Parameter	Type	Status	Description
order_status_code	string	required	canceled, complete, fraud, holded, payment_review, paypal_canceled_reversal, paypal_reversed, pending, pending_mobile_confirm, pending_payment, pending_paypal, processing, processing_warehouse, ready_to_ship, shipped or under_review
order_id	string	required	Valid order order_id
user_id	string	optional	Valid user user_id

Add Comment Order

Insert comment to order.

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/orderHistory" \
-H "Accept: application/json" \
    -d "comment"="modi" \
    -d "order_id"="modi" \
    -d "user_id"="modi" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/orderHistory",
    "method": "POST",
    "data": {
        "comment": "modi",
        "order_id": "modi",
        "user_id": "modi"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "order_history_id": 12,
        "order_history_template_id": -1,
        "order_id": 19,
        "user_id": -1,
        "order_status_id": 1,
        "notify": 1,
        "comment": "",
        "date_added": "2011-11-15 09:39:23"
    }
}

HTTP Request

POST v1/in/orderHistory

Middleware

api, skip-db-trigger

Parameters

Parameter	Type	Status	Description
comment	string	required
order_id	string	required	Valid order order_id
user_id	string	optional	Valid user user_id

Prices

Add price

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/pricing" \
-H "Accept: application/json" \
    -d "entity_id"="pariatur" \
    -d "priority"="15308427" \
    -d "price"="15308427" \
    -d "date_start"="2011-07-19" \
    -d "date_end"="2011-07-19" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/pricing",
    "method": "POST",
    "data": {
        "entity_id": "pariatur",
        "priority": 15308427,
        "price": 15308427,
        "date_start": "2011-07-19",
        "date_end": "2011-07-19"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "product_id": null,
        "priority": null,
        "price": null,
        "date_start": null,
        "date_end": null
    }
}

HTTP Request

POST v1/in/pricing

Middleware

api

Parameters

Parameter	Type	Status	Description
entity_id	string	required	Valid product_to_magento entity_id
priority	numeric	optional
price	numeric	required
date_start	date	required
date_end	date	required

Add Bulk prices

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/pricing/bulk" \
-H "Accept: application/json" \
    -d "products"="tenetur" \
    -d "products.0.entity_id"="tenetur" \
    -d "products.0.priority"="80141874" \
    -d "products.0.price"="80141874" \
    -d "products.0.date_start"="2016-07-27" \
    -d "products.0.date_end"="2016-07-27" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/pricing/bulk",
    "method": "POST",
    "data": {
        "products": "tenetur",
        "products.0.entity_id": "tenetur",
        "products.0.priority": 80141874,
        "products.0.price": 80141874,
        "products.0.date_start": "2016-07-27",
        "products.0.date_end": "2016-07-27"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "product_id": null,
        "priority": null,
        "price": null,
        "date_start": null,
        "date_end": null
    }
}

HTTP Request

POST v1/in/pricing/bulk

Middleware

api

Parameters

Parameter	Type	Status	Description
products	array	required	Minimum: 1
products.0.entity_id	string	required	Valid product_to_magento entity_id
products.0.priority	numeric	optional
products.0.price	numeric	required
products.0.date_start	date	required
products.0.date_end	date	required

Products

Change Sku

if user change sku in magento you should change the sku then call update request to prevent un-expected errors.

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/products/{sku}/change-sku" \
-H "Accept: application/json" \
    -d "new_sku"="quidem" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/products/{sku}/change-sku",
    "method": "POST",
    "data": {
        "new_sku": "quidem"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

HTTP Request

POST v1/in/products/{sku}/change-sku

Middleware

api

Parameters

Parameter	Type	Status	Description
new_sku	string	required

Create Product

Create a new product.

• attribute: product attribute is simple information as string (not use for order product)
• option: product options (size, color) and currently we have only one level option, please make sure to send all available option in update request because will remove any options exists on database and doesn't exists on update request
• special: product specials price, also make sure to pass all available prices because will remove any prices doesn't exists on update request

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/products" \
-H "Accept: application/json" \
    -d "sku"="veritatis" \
    -d "ar.name"="veritatis" \
    -d "ar.meta_description"="veritatis" \
    -d "ar.meta_keyword"="veritatis" \
    -d "ar.description"="veritatis" \
    -d "ar.tag"="veritatis" \
    -d "ar.is_done"="1" \
    -d "en.name"="veritatis" \
    -d "en.meta_description"="veritatis" \
    -d "en.meta_keyword"="veritatis" \
    -d "en.description"="veritatis" \
    -d "en.tag"="veritatis" \
    -d "en.is_done"="1" \
    -d "price"="130468021" \
    -d "logistics_cost"="130468021" \
    -d "inventory_cost"="130468021" \
    -d "cost"="130468021" \
    -d "quantity"="130468021" \
    -d "upc"="veritatis" \
    -d "image"="veritatis" \
    -d "minimum"="130468021" \
    -d "maximum"="0" \
    -d "subtract"="130468021" \
    -d "stock_status_id"="veritatis" \
    -d "is_returnable"="1" \
    -d "status"="veritatis" \
    -d "status_demand"="veritatis" \
    -d "status_supplier"="veritatis" \
    -d "status_clead"="veritatis" \
    -d "shipping_country"="veritatis" \
    -d "product_link"="veritatis" \
    -d "date_available"="2018-11-13" \
    -d "manufacturer_id"="veritatis" \
    -d "master_category_id"="veritatis" \
    -d "product_categories"="veritatis" \
    -d "product_filters"="veritatis" \
    -d "product_related"="veritatis" \
    -d "attribute"="veritatis" \
    -d "option"="veritatis" \
    -d "special"="veritatis" \
    -d "attribute.0.attribute_id"="veritatis" \
    -d "attribute.0.ar.description"="veritatis" \
    -d "attribute.0.en.description"="veritatis" \
    -d "option.0.option_id"="veritatis" \
    -d "option.0.required"="1" \
    -d "option.0.values.0.option_value_id"="veritatis" \
    -d "option.0.values.0.sku"="veritatis" \
    -d "option.0.values.0.quantity"="130468021" \
    -d "option.0.values.0.price"="130468021" \
    -d "special.0.price"="130468021" \
    -d "special.0.date_start"="2018-11-13 13:49:04" \
    -d "special.0.date_end"="2018-11-13 13:49:04" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/products",
    "method": "POST",
    "data": {
        "sku": "veritatis",
        "ar.name": "veritatis",
        "ar.meta_description": "veritatis",
        "ar.meta_keyword": "veritatis",
        "ar.description": "veritatis",
        "ar.tag": "veritatis",
        "ar.is_done": true,
        "en.name": "veritatis",
        "en.meta_description": "veritatis",
        "en.meta_keyword": "veritatis",
        "en.description": "veritatis",
        "en.tag": "veritatis",
        "en.is_done": true,
        "price": 130468021,
        "logistics_cost": 130468021,
        "inventory_cost": 130468021,
        "cost": 130468021,
        "quantity": 130468021,
        "upc": "veritatis",
        "image": "veritatis",
        "minimum": 130468021,
        "maximum": 0,
        "subtract": 130468021,
        "stock_status_id": "veritatis",
        "is_returnable": true,
        "status": "veritatis",
        "status_demand": "veritatis",
        "status_supplier": "veritatis",
        "status_clead": "veritatis",
        "shipping_country": "veritatis",
        "product_link": "veritatis",
        "date_available": "2018-11-13",
        "manufacturer_id": "veritatis",
        "master_category_id": "veritatis",
        "product_categories": "veritatis",
        "product_filters": "veritatis",
        "product_related": "veritatis",
        "attribute": "veritatis",
        "option": "veritatis",
        "special": "veritatis",
        "attribute.0.attribute_id": "veritatis",
        "attribute.0.ar.description": "veritatis",
        "attribute.0.en.description": "veritatis",
        "option.0.option_id": "veritatis",
        "option.0.required": true,
        "option.0.values.0.option_value_id": "veritatis",
        "option.0.values.0.sku": "veritatis",
        "option.0.values.0.quantity": 130468021,
        "option.0.values.0.price": 130468021,
        "special.0.price": 130468021,
        "special.0.date_start": "2018-11-13 13:49:04",
        "special.0.date_end": "2018-11-13 13:49:04"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "product_id": 85,
        "sku": "van.85",
        "quantity": 0,
        "price": "15.0000",
        "optionValues": [
            {
                "id": 1055,
                "option_id": 36,
                "option_value_id": 262,
                "sku": "van.85.1055",
                "quantity": 0,
                "price": "0.0000",
                "value": "green"
            },
            {
                "id": 1056,
                "option_id": 36,
                "option_value_id": 263,
                "sku": "van.85.1056",
                "quantity": 0,
                "price": "0.0000",
                "value": "pink"
            },
            {
                "id": 1057,
                "option_id": 36,
                "option_value_id": 264,
                "sku": "van.85.1057",
                "quantity": 0,
                "price": "0.0000",
                "value": "red"
            },
            {
                "id": 1058,
                "option_id": 36,
                "option_value_id": 265,
                "sku": "van.85.1058",
                "quantity": 0,
                "price": "0.0000",
                "value": "yellow"
            },
            {
                "id": 1059,
                "option_id": 36,
                "option_value_id": 266,
                "sku": "van.85.1059",
                "quantity": 0,
                "price": "0.0000",
                "value": "white"
            }
        ]
    }
}

HTTP Request

POST v1/in/products

Middleware

api

Parameters

Parameter	Type	Status	Description
sku	string	required
ar.name	string	required
ar.meta_description	string	optional
ar.meta_keyword	string	optional
ar.description	string	optional
ar.tag	string	optional
ar.is_done	boolean	optional
en.name	string	required
en.meta_description	string	optional
en.meta_keyword	string	optional
en.description	string	optional
en.tag	string	optional
en.is_done	boolean	optional
price	numeric	required	Minimum: 0
logistics_cost	numeric	required	Minimum: 0
inventory_cost	numeric	required	Minimum: 0
cost	numeric	required	Minimum: 0
quantity	numeric	required	Minimum: 0
upc	string	optional
image	string	optional
minimum	numeric	required	Minimum: 1
maximum	numeric	required	Minimum: 1 Maximum: 10
subtract	numeric	optional	Minimum: 1
stock_status_id	string	required	Valid stock_status stock_status_id
is_returnable	boolean	required
status	string	required	Valid product_status product_status_id
status_demand	string	optional	Valid product_demand_status product_demand_status_id
status_supplier	string	optional	Valid product_supplier_status product_supplier_status_id
status_clead	string	optional	Valid product_clead_status product_clead_status_id
shipping_country	array	optional	Valid country iso_code_2
product_link	string	required
date_available	date	optional	Date format: Y-m-d
manufacturer_id	string	optional	Valid magento_manufacturer entity_id
master_category_id	string	required	Valid category category_id
product_categories	array	optional	Valid category category_id
product_filters	array	optional	Valid filter filter_id
product_related	array	optional	Valid product product_id
attribute	array	optional	Minimum: 1
option	array	optional	Minimum: 1
special	array	optional	Minimum: 1
attribute.0.attribute_id	string	optional	Required if the parameters attribute are present. Valid attribute attribute_id
attribute.0.ar.description	string	optional	Required if the parameters attribute are present.
attribute.0.en.description	string	optional	Required if the parameters attribute are present.
option.0.option_id	string	optional	Required if the parameters option are present. Valid option option_id
option.0.required	boolean	optional	Required if the parameters option are present.
option.0.values.0.option_value_id	string	optional	Required if the parameters option are present. Valid option_value option_value_id
option.0.values.0.sku	string	optional	Required if the parameters option are present.
option.0.values.0.quantity	numeric	optional	Required if the parameters option are present. Minimum: 0
option.0.values.0.price	numeric	optional	Required if the parameters option are present. Minimum: 0
special.0.price	numeric	optional	Required if the parameters special are present. Minimum: 0
special.0.date_start	date	optional	Required if the parameters special are present. Date format: Y-m-d H:i:s
special.0.date_end	date	optional	Required if the parameters special are present. Date format: Y-m-d H:i:s

Update Product

Update the specified resource in storage.

• attribute: product attribute is simple information as string (not use for order product)
• option: product options (size, color) and currently we have only one level option, please make sure to send all available option in update request because will remove any options exists on database and doesn't exists on update request
• special: product specials price, also make sure to pass all available prices because will remove any prices doesn't exists on update request

FYI: replace {product} with sku of magento

Example request:

curl -X PUT "http://api.vanillaeshop.com/v1/in/products/{product}" \
-H "Accept: application/json" \
    -d "ar.name"="reiciendis" \
    -d "ar.meta_description"="reiciendis" \
    -d "ar.meta_keyword"="reiciendis" \
    -d "ar.description"="reiciendis" \
    -d "ar.tag"="reiciendis" \
    -d "ar.is_done"="1" \
    -d "en.name"="reiciendis" \
    -d "en.meta_description"="reiciendis" \
    -d "en.meta_keyword"="reiciendis" \
    -d "en.description"="reiciendis" \
    -d "en.tag"="reiciendis" \
    -d "en.is_done"="1" \
    -d "price"="2099302232" \
    -d "logistics_cost"="2099302232" \
    -d "inventory_cost"="2099302232" \
    -d "cost"="2099302232" \
    -d "quantity"="2099302232" \
    -d "upc"="reiciendis" \
    -d "image"="reiciendis" \
    -d "minimum"="2099302232" \
    -d "maximum"="10" \
    -d "subtract"="2099302232" \
    -d "stock_status_id"="reiciendis" \
    -d "is_returnable"="1" \
    -d "status"="reiciendis" \
    -d "status_demand"="reiciendis" \
    -d "status_supplier"="reiciendis" \
    -d "status_clead"="reiciendis" \
    -d "shipping_country"="reiciendis" \
    -d "product_link"="reiciendis" \
    -d "date_available"="2018-11-13" \
    -d "manufacturer_id"="reiciendis" \
    -d "master_category_id"="reiciendis" \
    -d "product_categories"="reiciendis" \
    -d "product_filters"="reiciendis" \
    -d "product_related"="reiciendis" \
    -d "attribute"="reiciendis" \
    -d "option"="reiciendis" \
    -d "special"="reiciendis" \
    -d "attribute.0.attribute_id"="reiciendis" \
    -d "attribute.0.ar.description"="reiciendis" \
    -d "attribute.0.en.description"="reiciendis" \
    -d "option.0.option_id"="reiciendis" \
    -d "option.0.required"="1" \
    -d "option.0.values.0.option_value_id"="reiciendis" \
    -d "option.0.values.0.sku"="reiciendis" \
    -d "option.0.values.0.quantity"="2099302232" \
    -d "option.0.values.0.price"="2099302232" \
    -d "special.0.price"="2099302232" \
    -d "special.0.date_start"="2018-11-13 13:49:04" \
    -d "special.0.date_end"="2018-11-13 13:49:04" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/products/{product}",
    "method": "PUT",
    "data": {
        "ar.name": "reiciendis",
        "ar.meta_description": "reiciendis",
        "ar.meta_keyword": "reiciendis",
        "ar.description": "reiciendis",
        "ar.tag": "reiciendis",
        "ar.is_done": true,
        "en.name": "reiciendis",
        "en.meta_description": "reiciendis",
        "en.meta_keyword": "reiciendis",
        "en.description": "reiciendis",
        "en.tag": "reiciendis",
        "en.is_done": true,
        "price": 2099302232,
        "logistics_cost": 2099302232,
        "inventory_cost": 2099302232,
        "cost": 2099302232,
        "quantity": 2099302232,
        "upc": "reiciendis",
        "image": "reiciendis",
        "minimum": 2099302232,
        "maximum": 10,
        "subtract": 2099302232,
        "stock_status_id": "reiciendis",
        "is_returnable": true,
        "status": "reiciendis",
        "status_demand": "reiciendis",
        "status_supplier": "reiciendis",
        "status_clead": "reiciendis",
        "shipping_country": "reiciendis",
        "product_link": "reiciendis",
        "date_available": "2018-11-13",
        "manufacturer_id": "reiciendis",
        "master_category_id": "reiciendis",
        "product_categories": "reiciendis",
        "product_filters": "reiciendis",
        "product_related": "reiciendis",
        "attribute": "reiciendis",
        "option": "reiciendis",
        "special": "reiciendis",
        "attribute.0.attribute_id": "reiciendis",
        "attribute.0.ar.description": "reiciendis",
        "attribute.0.en.description": "reiciendis",
        "option.0.option_id": "reiciendis",
        "option.0.required": true,
        "option.0.values.0.option_value_id": "reiciendis",
        "option.0.values.0.sku": "reiciendis",
        "option.0.values.0.quantity": 2099302232,
        "option.0.values.0.price": 2099302232,
        "special.0.price": 2099302232,
        "special.0.date_start": "2018-11-13 13:49:04",
        "special.0.date_end": "2018-11-13 13:49:04"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "product_id": 85,
        "sku": "van.85",
        "quantity": 0,
        "price": "15.0000",
        "optionValues": [
            {
                "id": 1055,
                "option_id": 36,
                "option_value_id": 262,
                "sku": "van.85.1055",
                "quantity": 0,
                "price": "0.0000",
                "value": "green"
            },
            {
                "id": 1056,
                "option_id": 36,
                "option_value_id": 263,
                "sku": "van.85.1056",
                "quantity": 0,
                "price": "0.0000",
                "value": "pink"
            },
            {
                "id": 1057,
                "option_id": 36,
                "option_value_id": 264,
                "sku": "van.85.1057",
                "quantity": 0,
                "price": "0.0000",
                "value": "red"
            },
            {
                "id": 1058,
                "option_id": 36,
                "option_value_id": 265,
                "sku": "van.85.1058",
                "quantity": 0,
                "price": "0.0000",
                "value": "yellow"
            },
            {
                "id": 1059,
                "option_id": 36,
                "option_value_id": 266,
                "sku": "van.85.1059",
                "quantity": 0,
                "price": "0.0000",
                "value": "white"
            }
        ]
    }
}

HTTP Request

PUT v1/in/products/{product} PATCH v1/in/products/{product}

Middleware

api

Parameters

Parameter	Type	Status	Description
ar.name	string	required
ar.meta_description	string	optional
ar.meta_keyword	string	optional
ar.description	string	optional
ar.tag	string	optional
ar.is_done	boolean	optional
en.name	string	required
en.meta_description	string	optional
en.meta_keyword	string	optional
en.description	string	optional
en.tag	string	optional
en.is_done	boolean	optional
price	numeric	required	Minimum: 0
logistics_cost	numeric	required	Minimum: 0
inventory_cost	numeric	required	Minimum: 0
cost	numeric	required	Minimum: 0
quantity	numeric	required	Minimum: 0
upc	string	optional
image	string	optional
minimum	numeric	required	Minimum: 1
maximum	numeric	required	Minimum: 1 Maximum: 10
subtract	numeric	optional	Minimum: 1
stock_status_id	string	required	Valid stock_status stock_status_id
is_returnable	boolean	required
status	string	required	Valid product_status product_status_id
status_demand	string	optional	Valid product_demand_status product_demand_status_id
status_supplier	string	optional	Valid product_supplier_status product_supplier_status_id
status_clead	string	optional	Valid product_clead_status product_clead_status_id
shipping_country	array	optional	Valid country iso_code_2
product_link	string	required
date_available	date	optional	Date format: Y-m-d
manufacturer_id	string	optional	Valid magento_manufacturer entity_id
master_category_id	string	required	Valid category category_id
product_categories	array	optional	Valid category category_id
product_filters	array	optional	Valid filter filter_id
product_related	array	optional	Valid product product_id
attribute	array	optional	Minimum: 1
option	array	optional	Minimum: 1
special	array	optional	Minimum: 1
attribute.0.attribute_id	string	optional	Required if the parameters attribute are present. Valid attribute attribute_id
attribute.0.ar.description	string	optional	Required if the parameters attribute are present.
attribute.0.en.description	string	optional	Required if the parameters attribute are present.
option.0.option_id	string	optional	Required if the parameters option are present. Valid option option_id
option.0.required	boolean	optional	Required if the parameters option are present.
option.0.values.0.option_value_id	string	optional	Required if the parameters option are present. Valid option_value option_value_id
option.0.values.0.sku	string	optional	Required if the parameters option are present.
option.0.values.0.quantity	numeric	optional	Required if the parameters option are present. Minimum: 0
option.0.values.0.price	numeric	optional	Required if the parameters option are present. Minimum: 0
special.0.price	numeric	optional	Required if the parameters special are present. Minimum: 0
special.0.date_start	date	optional	Required if the parameters special are present. Date format: Y-m-d H:i:s
special.0.date_end	date	optional	Required if the parameters special are present. Date format: Y-m-d H:i:s

Remove Product

Remove the specified resource from storage.

FYI: replace {product} with entity id of magento

Example request:

curl -X DELETE "http://api.vanillaeshop.com/v1/in/products/{product}" \
-H "Accept: application/json"

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/products/{product}",
    "method": "DELETE",
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": null
}

HTTP Request

DELETE v1/in/products/{product}

Middleware

api

Bulk Create

Create bulk product in same required, for update you should provide product_id with product information.

Example request:

curl -X POST "http://api.vanillaeshop.com/v1/in/products/bulk" \
-H "Accept: application/json" \
    -d "products"="non" \
    -d "products.0.sku"="non" \
    -d "products.0.ar.name"="non" \
    -d "products.0.ar.meta_description"="non" \
    -d "products.0.ar.meta_keyword"="non" \
    -d "products.0.ar.description"="non" \
    -d "products.0.ar.tag"="non" \
    -d "products.0.ar.is_done"="1" \
    -d "products.0.en.name"="non" \
    -d "products.0.en.meta_description"="non" \
    -d "products.0.en.meta_keyword"="non" \
    -d "products.0.en.description"="non" \
    -d "products.0.en.tag"="non" \
    -d "products.0.en.is_done"="1" \
    -d "products.0.price"="454980639" \
    -d "products.0.logistics_cost"="454980639" \
    -d "products.0.inventory_cost"="454980639" \
    -d "products.0.cost"="454980639" \
    -d "products.0.quantity"="454980639" \
    -d "products.0.upc"="non" \
    -d "products.0.minimum"="454980639" \
    -d "products.0.maximum"="2" \
    -d "products.0.subtract"="454980639" \
    -d "products.0.stock_status_id"="non" \
    -d "products.0.is_returnable"="1" \
    -d "products.0.status"="non" \
    -d "products.0.status_demand"="non" \
    -d "products.0.status_supplier"="non" \
    -d "products.0.status_clead"="non" \
    -d "products.0.shipping_country"="non" \
    -d "products.0.product_link"="non" \
    -d "products.0.date_available"="2018-11-13" \
    -d "products.0.manufacturer_id"="non" \
    -d "products.0.master_category_id"="non" \
    -d "products.0.product_categories"="non" \
    -d "products.0.product_filters"="non" \
    -d "products.0.product_related"="non" \
    -d "products.0.attribute"="non" \
    -d "products.0.attribute.0.attribute_id"="non" \
    -d "products.0.attribute.0.ar.description"="non" \
    -d "products.0.attribute.0.en.description"="non" \
    -d "products.0.option"="non" \
    -d "products.0.option.0.option_id"="non" \
    -d "products.0.option.0.required"="1" \
    -d "products.0.option.0.values.0.option_value_id"="non" \
    -d "products.0.option.0.values.0.sku"="non" \
    -d "products.0.option.0.values.0.quantity"="454980639" \
    -d "products.0.option.0.values.0.price"="454980639" \
    -d "products.0.special"="non" \
    -d "products.0.special.0.price"="454980639" \
    -d "products.0.special.0.date_start"="2018-11-13 13:49:04" \
    -d "products.0.special.0.date_end"="2018-11-13 13:49:04" \

var settings = {
    "async": true,
    "crossDomain": true,
    "url": "http://api.vanillaeshop.com/v1/in/products/bulk",
    "method": "POST",
    "data": {
        "products": "non",
        "products.0.sku": "non",
        "products.0.ar.name": "non",
        "products.0.ar.meta_description": "non",
        "products.0.ar.meta_keyword": "non",
        "products.0.ar.description": "non",
        "products.0.ar.tag": "non",
        "products.0.ar.is_done": true,
        "products.0.en.name": "non",
        "products.0.en.meta_description": "non",
        "products.0.en.meta_keyword": "non",
        "products.0.en.description": "non",
        "products.0.en.tag": "non",
        "products.0.en.is_done": true,
        "products.0.price": 454980639,
        "products.0.logistics_cost": 454980639,
        "products.0.inventory_cost": 454980639,
        "products.0.cost": 454980639,
        "products.0.quantity": 454980639,
        "products.0.upc": "non",
        "products.0.minimum": 454980639,
        "products.0.maximum": 2,
        "products.0.subtract": 454980639,
        "products.0.stock_status_id": "non",
        "products.0.is_returnable": true,
        "products.0.status": "non",
        "products.0.status_demand": "non",
        "products.0.status_supplier": "non",
        "products.0.status_clead": "non",
        "products.0.shipping_country": "non",
        "products.0.product_link": "non",
        "products.0.date_available": "2018-11-13",
        "products.0.manufacturer_id": "non",
        "products.0.master_category_id": "non",
        "products.0.product_categories": "non",
        "products.0.product_filters": "non",
        "products.0.product_related": "non",
        "products.0.attribute": "non",
        "products.0.attribute.0.attribute_id": "non",
        "products.0.attribute.0.ar.description": "non",
        "products.0.attribute.0.en.description": "non",
        "products.0.option": "non",
        "products.0.option.0.option_id": "non",
        "products.0.option.0.required": true,
        "products.0.option.0.values.0.option_value_id": "non",
        "products.0.option.0.values.0.sku": "non",
        "products.0.option.0.values.0.quantity": 454980639,
        "products.0.option.0.values.0.price": 454980639,
        "products.0.special": "non",
        "products.0.special.0.price": 454980639,
        "products.0.special.0.date_start": "2018-11-13 13:49:04",
        "products.0.special.0.date_end": "2018-11-13 13:49:04"
},
    "headers": {
        "accept": "application/json"
    }
}

$.ajax(settings).done(function (response) {
    console.log(response);
});

Example response:

{
    "status": 200,
    "success": true,
    "data": {
        "product_id": 85,
        "sku": "van.85",
        "quantity": 0,
        "price": "15.0000",
        "optionValues": [
            {
                "id": 1055,
                "option_id": 36,
                "option_value_id": 262,
                "sku": "van.85.1055",
                "quantity": 0,
                "price": "0.0000",
                "value": "green"
            },
            {
                "id": 1056,
                "option_id": 36,
                "option_value_id": 263,
                "sku": "van.85.1056",
                "quantity": 0,
                "price": "0.0000",
                "value": "pink"
            },
            {
                "id": 1057,
                "option_id": 36,
                "option_value_id": 264,
                "sku": "van.85.1057",
                "quantity": 0,
                "price": "0.0000",
                "value": "red"
            },
            {
                "id": 1058,
                "option_id": 36,
                "option_value_id": 265,
                "sku": "van.85.1058",
                "quantity": 0,
                "price": "0.0000",
                "value": "yellow"
            },
            {
                "id": 1059,
                "option_id": 36,
                "option_value_id": 266,
                "sku": "van.85.1059",
                "quantity": 0,
                "price": "0.0000",
                "value": "white"
            }
        ]
    }
}

HTTP Request

POST v1/in/products/bulk

Middleware

api

Parameters

Parameter	Type	Status	Description
products	array	required	Minimum: 1 Maximum: 10
products.0.sku	string	optional
products.0.ar.name	string	required
products.0.ar.meta_description	string	optional
products.0.ar.meta_keyword	string	optional
products.0.ar.description	string	optional
products.0.ar.tag	string	optional
products.0.ar.is_done	boolean	optional
products.0.en.name	string	required
products.0.en.meta_description	string	optional
products.0.en.meta_keyword	string	optional
products.0.en.description	string	optional
products.0.en.tag	string	optional
products.0.en.is_done	boolean	optional
products.0.price	numeric	required	Minimum: 0
products.0.logistics_cost	numeric	required	Minimum: 0
products.0.inventory_cost	numeric	required	Minimum: 0
products.0.cost	numeric	required	Minimum: 0
products.0.quantity	numeric	required	Minimum: 0
products.0.upc	string	optional
products.0.minimum	numeric	required	Minimum: 1
products.0.maximum	numeric	required	Minimum: 1 Maximum: 10
products.0.subtract	numeric	optional	Minimum: 1
products.0.stock_status_id	string	required	Valid stock_status stock_status_id
products.0.is_returnable	boolean	required
products.0.status	string	required	Valid product_status product_status_id
products.0.status_demand	string	optional	Valid product_demand_status product_demand_status_id
products.0.status_supplier	string	optional	Valid product_supplier_status product_supplier_status_id
products.0.status_clead	string	optional	Valid product_clead_status product_clead_status_id
products.0.shipping_country	array	optional	Valid country iso_code_2
products.0.product_link	string	required
products.0.date_available	date	optional	Date format: Y-m-d
products.0.manufacturer_id	string	optional	Valid magento_manufacturer entity_id
products.0.master_category_id	string	required	Valid category category_id
products.0.product_categories	array	optional	Valid category category_id
products.0.product_filters	array	optional	Valid filter filter_id
products.0.product_related	array	optional	Valid product product_id
products.0.attribute	array	optional	Minimum: 1
products.0.attribute.0.attribute_id	string	optional	Required if the parameters attribute are present. Valid attribute attribute_id
products.0.attribute.0.ar.description	string	optional	Required if the parameters attribute are present.
products.0.attribute.0.en.description	string	optional	Required if the parameters attribute are present.
products.0.option	array	optional	Minimum: 1
products.0.option.0.option_id	string	optional	Required if the parameters option are present. Valid option option_id
products.0.option.0.required	boolean	optional	Required if the parameters option are present.
products.0.option.0.values.0.option_value_id	string	optional	Required if the parameters option are present. Valid option_value option_value_id
products.0.option.0.values.0.sku	string	optional	Required if the parameters option are present.
products.0.option.0.values.0.quantity	numeric	optional	Required if the parameters option are present. Minimum: 0
products.0.option.0.values.0.price	numeric	optional	Required if the parameters option are present. Minimum: 0
products.0.special	array	optional	Minimum: 1
products.0.special.0.price	numeric	optional	Required if the parameters special are present. Minimum: 0
products.0.special.0.date_start	date	optional	Required if the parameters special are present. Date format: Y-m-d H:i:s
products.0.special.0.date_end	date	optional	Required if the parameters special are present. Date format: Y-m-d H:i:s

Errors

The Kittn API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request sucks
401	Unauthorized -- Your API key is wrong
403	Forbidden -- The kitten requested is hidden for administrators only
404	Not Found -- The specified kitten could not be found
405	Method Not Allowed -- You tried to access a kitten with an invalid method
406	Not Acceptable -- You requested a format that isn't json
410	Gone -- The kitten requested has been removed from our servers
418	I'm a teapot
429	Too Many Requests -- You're requesting too many kittens! Slow down!
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarially offline for maintanance. Please try again later.