Comenzar

Last updated: Oct 11th, 2017 REST CRUD API V1.02

Autenticarse

La plataforma CUCUMART esta disponible a traves de una REST CRUD API, la cual se accede de invocaciones estandar HTTP.
Si desea ver mas informacion sobre que es y ventajas de las REST CRUD API puede ver en Saber mas sobre interfaces REST
Para poder trabajar con nuestra API primero es necesario registrarse con un usuario standard. El acceso a los recursos públicos esta habilitado una vez que tiene una cuenta creada y cuenta con una aplicacion Por tal motivo en la siguiente guía le facilitaremos la autenticacion cuando este logeado en su cuenta

Autenticación y Autorización


API-CLIENT: Usted no esta logeado
API-Secret:




Back Office

¿Que es el Back Office?

La informacion del Back Office consiste en las operaciones de gestion de tiendas. Comprende las ventas, los productos, el registro de los stocks en depositos, redes de comercios, pedidos, clientes y su actividad en las tiendas, consultas, respuestas, reclamos, calificaciones y mas.




Customers

La base de customers (clientes de clientes) contiene datos de filiacion de los clientes de sus tiendas: nombre, apellido, email, ultimo login, etc

HTTP
GET /api/customers HTTPS/1.1
curl
curl "https://secure.cucumart.com/api.php/customers/{API-CLIENT}/{API-SECRET}"
JSON Response example
[
  {
	"customers_trait":"Sr",
	"customers_name":"Mario Carlos",
	"customers_surname":"Ledesma",
	"customers_street1":"Calle Solano Lima 1290",
	"customers_street2":"Barrio de los Naranjos",
	"customers_between_streets":"Calle Mocoreta con Calle San Martin",
	"customers_apart":"2do A",
	"customers_town":"Belen",
	"customers_city":"2383",
	"customers_states_id":"99",
	"customers_country_id":"44",
	"customers_zipcode":"1426",
	"customers_nik":"Marito",
	"customers_email":"mario.c.ledesma@gmail.com",
	"customers_alt_email":"mariolesma@hotmail.com",
	"customers_phone1":"1543256784",
	"customers_phone2":"01147022190",
	"customers_timezones_id":"America/Argentina/Buenos_Aires"}
  }  
]					
										
										

Sales

La base de sales (ventas) contiene informacion del resultado de operaciones, mostrando datos de las ventas realizadas tales como, importe, codigo de articulo vendido cuando es uno solo, cliente, fecha, etc

HTTP
GET /api/sales HTTPS/1.1
curl
curl "https://secure.cucumart.com/api.php/sales/{API-CLIENT}/{API-SECRET}"
JSON Response example
[
	{
		"sales_datetime":"2017-01-08 19:36:33",								//Fecha en la que se produjo la venta
		"sales_recorded":"2017-01-08 19:36:35",								//Fecha de registro contable de la venta
		"sales_amount":"1989.89",											//Importe total de la venta	
		"sales_shops_id":"1",												//Tienda donde se realizo la venta
		"sales_carts_id":"1",												//Identificador del carrito con los productos vendidos
		"sales_state":"3",													//Estado actual de la venta
		"sales_paygate_id":"1",												//Medio de pago que fue utilizado
		"sales_last_paygate_state_id":"1",									//Estado de la operacion para el medio de pago
		"sales_paygate_oper_id":"65c12ba90171f01c2017a891fae-12"			//Identificacion de la operacion para el medio de pago
	}
]										
										
										

Productos

La base de productos contiene informacion sobre los articulos del cliente, entre ellos nombre, precio, descripcion, ofertas, etc

HTTP
GET /api/products HTTPS/1.1
curl
curl "https://secure.cucumart.com/api.php/products/{API-CLIENT}/{API-SECRET}"
JSON Response example
[
	{
		"products_name":"Merlot Milagro",									//Nombre del producto que ve el cliente
		"products_description":"Cosecha 1991, varietal Mendocino...",		//Descripcion visible del producto
		"products_categories_id":"136",										//Categoria que fue asignada al producto
		"products_price":"99.95",											//Precio de venta al publico
		"products_cost":"49.20",											//Costo de la mercaderia 
		"products_cogs":"56.09",											//Costo de la mercaderia puesta a disposicion del publico (costo mercaderia vendida/cost of good sold)
		"products_brand_id":"1",											//Codigo de la marca del producto
		"providers_providers_id":"1",										//Proveedor del producto ofrecido
		"products_codbar_type":"EAN",										//Tipo de codigo de barras del producto
		"products_codbar_number":"891827188127643839915610103097",			//Codigo de barras del producto
		"products_security_stock":"20",										//Stock de seguridad a partir del cual hara las solicitudes de reposicion 
		"products_promo_sale":"S",											//Indicador de producto en promocion con descuento
		"products_promo_sale_perc":"10",									//% de descuento de la promocion
		"products_promo_sale_start":"2017-06-04",							//Fecha de inicio de la promocion
		"products_promo_sale_end":"2017-07-04",								//Fecha de finalizacion de la promocion
		"products_size":"900cc",											//Tamaño de la presentacion del producto ofrecido
		"products_height":"30",												//Altura en cm de la presentacion ofrecida
		"products_width":"15",												//Ancho en cm de la presentacion ofrecida
		"products_length":"15",												//Largo en cm de la presentacion ofrecida
		"products_weight":"950",											//Peso en gramos de la presentacion ofrecida
		"products_recall":"S"												//Indicador de reposicion automatica
	}
]										
										
										

Orders

La base de orders (pedidos / envios producidos por las compras) contiene los datos necesarios para la entrega de una compra por un servicio de envios, correo o courier nacional o internacional

HTTP
GET /api/orders HTTPS/1.1
curl
curl "https://secure.cucumart.com/api.php/orders/{API-CLIENT}/{API-SECRET}"
JSON Response example
[
   {
		"orders_datetime":"2017-08-25 20:13:42",
		"orders_cart_id":"51",
		"orders_customers_id":"2",
		"orders_shop_id":"1",
		"orders_customers_trait":"Dra",
		"orders_customers_name":"Liz",
		"orders_customers_surname":"AGUINIS",
		"orders_customers_street1":"Av. Loreto",
		"orders_customers_street2":"",
		"orders_customers_street_num":"910",
		"orders_customers_between_streets":" Av.Elm con Suarez",
		"orders_customers_apart":"B",
		"orders_customers_phone1":"+5491153011009",
		"orders_customers_phone2":"",
		"orders_customers_country_id":"44",
		"orders_customers_state_id":"251",
		"orders_customers_city_id":"89",
		"orders_customers_zip":"1781",
		"orders_customers_delivery_details":"Por favor dejar en la recepcion del hotel",
		"orders_status":"P"
   }  
]					
										
										

Categories

La base de categories (categorias de productos en la tienda) contiene una agrupacion de productos que es administrada por el cliente para presentarlos en la tienda y suelen representar formas de simplificar busquedas (ej. Todos los productos para mujeres pueden estar en una categoria de Indumentaria que se denomina "INDUMENTARIA FEMENINA")

HTTP
GET /api/categories HTTPS/1.1
curl
curl "https://secure.cucumart.com/api.php/categories/{API-CLIENT}/{API-SECRET}"
JSON Response example
[
	{
		"categories_id":"1",												//Identificacion interna de la categoria
		"categories_name":"Malbec",											//Denominacion de la categoria
		"categories_shop_id":"1",											//Tienda a la cual fue asignada la categoria
		"categories_parent_id":"1"											//Categoria superior a la cual pertenece el producto
	}
]					
										
										

Claims

La base de claims (reclamos) contiene la informacion referida a los reclamos realizados por el cliente, ya sea por problemas con la compra, con le servicio, con los envios, etc

HTTP
GET /api/claims HTTPS/1.1
curl
curl "https://secure.cucumart.com/api.php/claims/{API-CLIENT}/{API-SECRET}"
JSON Response example
[
	{
		"claims_datetime":"2017-08-25 20:13:42", 
		"claims_email_from":"horloom@hotmai.com",
		"claims_subject_id":"6",
		"claims_body":"Recibi dos dias tarde el pedido. Los retrasos me causan problemas con mis clientes. Por favor normalizar!", 
		"claims_reason_id":"12",
		"claims_last_reply_datetime":"2017-08-25 20:13:42",
		"claims_closure_datetime":"2017-08-25 20:13:42"
	}  
]					
										
										

Questions

La base de questions (consultas) contiene las preguntas/consultas que hacen los clientes y las respuestas que reciben de parte de la tienda.

HTTP
GET /api/questions HTTPS/1.1
curl
curl "https://secure.cucumart.com/api.php/questions/{API-CLIENT}/{API-SECRET}"
JSON Response example
[
	{
		"questions_shop_id":"1",
		"questions_category_id":"1",
		"questions_product_id":"10",
		"questions_customer_id":"0",
		"questions_customer_name":"Peter Croole",
		"questions_customer_email":"petercr@gmail.com",
		"questions_datetime":"2017-07-13 19:21:07",
		"questions_text":"Queria conocer el medio de entrega (camion o remise) gracias",
		"questions_answer_datetime":"2017-07-13 19:21:21",
		"questions_answer_text":"Si, podes elegirlo. Usualmente enviamos por OCA Pack"
	}
]					
										
										

Error Messages

En respuesta a la ejecucion de un llamado HTTP el mensaje API esta tabulado de la siguiente manera

Mensajes por acciones REST CRUD
HTTP CRUD Global Specific
GET READ 200 OK - Successful execution
403 Forbidden - Not enough privileges
404 NOT FOUND - Resource not found or misspelled
200 OK - Successful execution
200 OK - Single customer
403 Forbidden - Not enough privileges
404 Not Found - Single record ID not found or invalid
POST CREATE 405 Method Not Allowed 200 OK - Successful execution
200 OK - Single customer
403 Forbidden - Not enough privileges
404 Not Found - Single record ID not found or invalid
PUT UPDATE / REPLACE 405 Method Not Allowed 200 OK - Successful execution
200 OK - Single customer
403 Forbidden - Not enough privileges
404 Not Found - Single record ID not found or invalid
PATCH Update/Modify 405 Method Not Allowed 200 OK - Successful execution
200 OK - Single customer
403 Forbidden - Not enough privileges
404 Not Found - Single record ID not found or invalid
DELETE DELETE 405 Method Not Allowed 200 OK - Successful execution
200 OK - Single customer
403 Forbidden - Not enough privileges
404 Not Found - Single record ID not found or invalid