Api

Documentacion del Servicio Web


Esta sección cuenta con toda la documentación para implementar el servicio web de Plaza eCommerce, ideal para automatizar y mejorar la logística de tu eCommerce.


La documentación se divide en las siguientes categorías:


Credenciales: Como obtener y usar las credenciales para usar el servicio.

Crear Envíos: Crear nuevo envíos y obtener las etiquetas de tracking.

Consultar Envíos: Consultar estado de envíos e historial del mismo.

Cotizador: Consultar precios de envío según su destino.

Pickups: Consultar pickups disponibles en todo el país.

Credenciales


Para obtener las credenciales debes acceder a la sección de credenciales dentro de tu cuenta, donde encontrarás los siguientes datos:


Usuario: Es un usuario único asignado para tu cuenta y debe enviarse en todas las consultas del servicio web.


Clave secreta: La clave secreta debe conservarse segura y no debe enviarse en ninguna consulta del servicio, se debe utilizar para hacer un encode sha1 de los datos que envíes en cada consulta, en cada uno de los servicios explicaremos cómo usarlo.

Crear nuevo envío


En este servicio podrás crear nuevos envíos, hay dos tipos de envios disponibles, envío a domicilio y envió a uno de nuestros pickups. Para usar este servicio debes hacer un POST al endpoint indicado aquí debajo con los parámetros obligatorios indicados. El orden de los parámetros es importante para la verificacion del codigo. La cantidad maxima de caracteres de cada parametro es de 255.


Endpoint Sandbox: POST - https://plazaecommerce.com/api/sandbox/envio/

Endpoint: POST - https://plazaecommerce.com/api/nuevo/envio/


ENTREGA A DOMICILIO

usuario
usuario asignado a su cuenta
(requerido)
-string-
referencia
una referencia unica a su envio
(requerido)
-string-
nombre
nombre del cliente
(requerido)
-string-
apellido
apellido del cliente
(requerido)
-string-
email
email del cliente
(requerido)
-string-
telefono
telefono del cliente
(requerido)
-string-
descripcion
descripcion del producto
(requerido)
-string-
tipo_envio
tipo de envio 'domicilio o pickup'
(requerido)
-string-
direccion
direccion de entrega
(requerido)
-string-
direccion_adicional
informacion adicional de entrega
(requerido)
-string-
codigo_region
codigo de region correspondiente al departamento de entrega, lista mas abajo
(requerido)
-string-
ciudad
ciudad de entrega
(requerido)
-string-
codigo_verificador
encode sha1(todos_los_parametros_requeridos+clave privada)
(requerido)
-string-

JSON POST

{

“usuario” : “plazaecommerce”,

“referencia” : “ReferenciaTest123”,

“nombre” : “Pablo”,

“apellido” : “Perez”,

“email” : “hola@plazaecommerce.com”,

“telefono” : “099099099”,

“descripcion” : “descripcion del producto”,

“tipo_envio” : “domicilio”,

“direccion” : “Pardo Bazan 2300”,

“direccion_adicional” : “Apartamento 301”,

“codigo_region” : “UY-MO”,

“ciudad” : “Montevideo”,

“codigo_verificador” : “dd19447119baf097c358b4f06856132491c74159”

}

JSON RESPONSE

{

"estado": "envio_creado",

"referencia": "ReferenciaTest123",

"tracking_id": "100000012",

"etiqueta": "https://plazaecommerce.com/order-label?order=10001234&key=0127409406c1c00a18f9a587db09b5b450915ff1",

"nombre": "Pablo",

"apellido": "Perez",

"email": "hola@plazaecommerce.com",

"telefono": "099099099",

"tipo_envio": "domicilio",

"direccion": "Pardo Bazan",

"direccion_adicional": "2300",

"descripcion": "descripcion del producto",

"ciudad": "Montevideo",

"departamento": "Montevideo",

"costos": {

"moneda": "UYU",

"costo": "150.0000"

}

}

Codigos de region

Region
Codigo
Artigas
UY-AR
Canelones
UY-CA
Cerro Largo
UY-CL
Colonia
UY-CO
Durazno
UY-DU
Flores
UY-FS
Florida
UY-FD
Lavalleja
UY-LA
Maldonado
UY-MA
Montevideo
UY-MO
Paysandu
UY-PA
Rio Negro
UY-RN
Rivera
UY-RV
Rocha
UY-RO
Salto
UY-SA
San Jose
UY-SJ
Soriano
UY-SO
Tacuarembo
UY-TA
Treinta y Tres
UY-TT

PICKUPS

usuario
usuario asignado a su cuenta
(requerido)
-string-
referencia
una referencia unica a su envio
(requerido)
-string-
nombre
nombre del cliente
(requerido)
-string-
apellido
apellido del cliente
(requerido)
-string-
email
email del cliente
(requerido)
-string-
telefono
telefono del cliente
(requerido)
-string-
descripcion
descripcion del producto
(requerido)
-string-
tipo_envio
tipo de envio 'domicilio o pickup'
(requerido)
-string-
codigo_pickup
codigo de pickup obtenido del servicio de pickups activos
(requerido)
-string-

JSON POST

{

"usuario": "plazaecommerce",

"referencia": "ReferenciaTest12",

"nombre": "Pablo",

"apellido": "Perez",

"email": "hola@plazaecommerce.com",

"telefono": "099099099",

"descripcion": "descripcion del producto",

"tipo_envio": "pickup",

"codigo_pickup": "05-01",

"codigo_verificador": "3e28b5523d1abd29539a50f618453c2252107c60"

}

JSON RESPONSE

{

"estado": "envio_creado",

"referencia": "ReferenciaTest12",

"tracking_id": "100012345",

"etiqueta": "https://plazaecommerce.com/order-label?order=100012345&key=0127409406c1c00a18f9a587db09b5b450915ff1",

"nombre": "Pablo",

"apellido": "Perez",

"email": "hola@plazaecommerce.com",

"telefono": "099099099",

"tipo_envio": "pickup",

"codigo_pickup": "05-01",

"direccion": "Camino Castro 253 esq. Molinos de Raffo",

"direccion_adicional": "",

"descripcion": "descripcion del producto",

"ciudad": "Prado Sur",

"departamento": "Montevideo",

"costos": {

"moneda": "UYU",

"costo": "150.0000"

}

}

Consultar estado de un envío


En este servicio podrás consultar el estado actual de los envíos, además del historial de estados por el que pasó el mismo. Para usar este servicio debes hacer un POST al endpoint indicado aquí debajo con los parámetros obligatorios indicados.


Endpoint: POST - https://plazaecommerce.com/api/estado/envio/


tracking_id o referencia
código de tracking que devuelve el servicio de crear un envío
(requerido)
-string-
usuario
usuario asignado a su cuenta
(requerido)
-string-
codigo_verificador
encode sha1(pais+usuario+clave privada)
(requerido)
-string-

JSON POST

{

“tracking_id” : “10001234”,

“usuario” : “plazaecommerce”,

“codigo_verificador” : “dd19447119baf097c358b4f06856132491c74159”

}

{

“referencia” : “referencia123”,

“usuario” : “plazaecommerce”,

“codigo_verificador” : “dd19447119baf097c358b4f06856132491c74159”

}

JSON RESPONSE

{

"estado": "complete",

"estado_titulo": "Envio Completado",

"referencia": "ReferenciaTest1234",

"tracking_id": "10001234",

"etiqueta": "https://plazaecommerce.com/order-label?order=10001234&key=0127409406c1c00a18f9a587db09b5b450915ff1",

"nombre": "Pablo",

"apellido": "Perez",

"email": "hola@plazaecommerce.com",

"telefono": "099099099",

"tipo_envio": "domicilio",

"direccion": "Pardo Bazan",

"direccion_adicional": "2300",

"ciudad": "Montevideo",

"departamento": "Montevideo",

"descripcion": "descripcion del producto",

"costos": {

"moneda": "UYU",

"costo": "150"

},

"estados": {

"nuevo_envio": {

"titulo": "Nuevo Envio ",

"descripcion": "Envio en Proceso",

"fecha": "2018-04-20 18:32:57"

},

"complete": {

"titulo": "Envio Completado",

"descripcion": "Envio Completado",

"fecha": "2018-04-21 18:33:30"

}

}

}

Cotizador


En este servicio podrás consultar el precio de los envíos a las diferentes zonas del país. Para usar este servicio debes hacer un POST al endpoint indicado aquí debajo con los parámetros obligatorios indicados.


Endpoint: POST - https://plazaecommerce.com/api/cotizador/envios/


pais
código iso del país seleccionado (ej ‘uy’ para Uruguay)
(requerido)
-string-
usuario
usuario asignado a su cuenta
(requerido)
-string-
codigo_verificador
encode sha1(pais+usuario+clave privada)
(requerido)
-string-

JSON POST

{

“pais” : “uy”,

“usuario” : “plazaecommerce”,

“codigo_verificador” : “dd19447119baf097c358b4f06856132491c74159”

}

JSON RESPONSE

{

"UY-MO": {

"codigo_region": "UY-MO",

"descripcion": "Envio en Montevideo",

"precio": 150,

"moneda": "UYU"

},

"UY-AR": {

"codigo_region": "UY-AR",

"descripcion": "Envio a Artigas",

"precio": 200,

"moneda": "UYU"

},

"UY-CA": {

"codigo_region": "UY-CA",

"descripcion": "Envio a Canelones",

"precio": 200,

"moneda": "UYU"

}

...

}

Pickups

En este servicio podrás consultar los pickups que están activos para el país seleccionado, cada uno de ellos tiene un código único que deber ser enviado en el servicio de crear envios en el caso de que el envío sea a uno de estos pickups. Para usar este servicio debes hacer un POST al endpoint indicado aquí debajo con los parámetros obligatorios indicados.


Endpoint: POST https://plazaecommerce.com/api/pickups/activos/


pais
código iso del país seleccionado (ej ‘uy’ para Uruguay)
(requerido)
-string-
usuario
usuario asignado a su cuenta
(requerido)
-string-
codigo_verificador
encode sha1(pais+usuario+clave privada)
(requerido)
-string-

JSON POST

{

“pais” : “uy”,

“usuario” : “plazaecommerce”,

“codigo_verificador” : “dd19447119baf097c358b4f06856132491c74159”

}

JSON RESPONSE

[{

"codigo_pickup": "11-06",

"departamento": "Artigas",

"localidad": "Artigas",

"direccion": "Presidente Berreta 551 esq. Treinta y Tres"

}, {

"codigo_pickup": "11-07",

"departamento": "Artigas",

"localidad": "Bella Uni\u00f3n",

"direccion": "Avda. Gral. Artigas 998 entre Pando y Lirio Moraes"

}, {

"codigo_pickup": "11-09",

"departamento": "Artigas",

"localidad": "Artigas",

"direccion": "Eduardo M. Castro 305 esq. Carlos Lecueder"

}...

]

Mensajes de error


En esta seccion encontraras la lista de los posibles mensajes de error y algunos ejemplos de respuestas. La respuesta va a ser Status 200 con una descripcion del primer campo que detecta que fue ingresado incorrectamente.


falta_parametro
el parametro especificado en el mensaje no fue enviado correctamente
(requerido)
-string-
maximo_caracteres
el parametro especificado en el mensaje supera el maximo de caracteres
(requerido)
-string-
codigo_verificador
el codigo verificador no coincide con el que debe enviar
(requerido)
-string-
usuario_no_disponible
el usuario envioado no existe
(requerido)
-string-
pais_no_disponible
el pais enviado no existe o no esta disponible
(requerido)
-string-
pais_no_disponible
el pais seleccionado no existe
(requerido)
-string-
envio_no_encontrado
el envio que esta intentando consultar no existe
(requerido)
-string-
referencia_duplicada
la referencia que esta intentando utilizar ya fue usada antes
(requerido)
-string-
orden_no_creada_contacte_soporte
contactar soporte
(requerido)
-string-

EJ JSON RESPONSE

{

"error": 1,

"falta_parametro": "pais"

}

EJ JSON RESPONSE

{

"error": 1,

"codigo_verificador": "error"

}

Ejemplo de implementacion en php

Descargar