Api

>>>

GET /api/comunas.json
Método que retorna las comunas de Chile

Formatos soportados

json

Ejemplos

Request: https://app.sendu.cl/api/comunas.json 
 Salida: [ [1, 'Arica'], [2, 'Camarones'] .... ]
>>>

GET /api/regions.json
Método que retorna las regiones de Chile

Formatos soportados

json

Ejemplos

Request: https://app.sendu.cl/api/regions.json 
 Salida: [ [1, 'Tarapacá'], [2, 'Antofagasta'] .... ]
>>>

GET /api/couriers.json
Método que retorna los couriers activos en SendU

Formatos soportados

json

Ejemplos

Request: https://app.sendu.cl/api/couriers.json 
 Salida: [ [1, 'Bluexpress'], [2, 'Chilexpress'] .... ]
>>>

GET /api/tracking_states.json
Método que retorna los estados de las órdenes de trabajo en SendU

Formatos soportados

json

Ejemplos

Request: https://app.sendu.cl/api/tracking_states.json 
 Salida: [
    {
        'id': 1,
        'name': 'Pedido creado',
        'description': 'Se ha creado el pedido y se está procesando'
    }, .... ]

Returns

Código: 200

Descripción:

OK

Nombre del parámetro Descripción
id
requerido

ID del estado de tracking

Validations:

  • Must be a Integer
name
requerido

Nombre del estado de tracking

Validations:

  • Must be a String
description
requerido

Descripción del estado de tracking

Validations:

  • Must be a String
>>>

GET /api/comunas_by_region.json
Método que retorna las comunas pertenecientes a una región

Formatos soportados

json

Ejemplos

Request: https://app.sendu.cl/api/comunas_by_region.json?region_id=1
	Salida:
	[
    [
        5,
        'Alto Hospicio'
    ],
    [
        7,
       'Camiña'
    ], ....

Parámetros

Nombre del parámetro Descripción
region_id
opcional

ID de la región a consultar

Validations:

  • Must be a String

Returns

Código: 422

Descripción:

Unprocessable Entity

Nombre del parámetro Descripción
error
requerido

Mensaje indicando el error

Validations:

  • Must be a String
>>>

GET /api/calculator.json
Método que entrega la tarificación de un paquete a partir de distintos datos descritos a continuación

Formatos soportados

json

Errores

Code Description
422 Falta uno o más parámetros de entrada. El formato de uno de estos es incorrecto

Ejemplos

Request: https://app.sendu.cl/api/calculator.json 
 body: {
	'to': 79,
	'weight': 1.0,
	'price_products': 1000,
	'dimensions': {
		'height': 10.0,
		'large': 10.0,
		'deep': 10.0
	}
	} 
 Salida: {'courier_id': 1,'service_type': 0,'transit_days': 4, 'customer_cost': 1990.2} 
 Si no hay cobertura para realizar el envío los campos customer_cost y transit_days toman el valor -1

Parámetros

Nombre del parámetro Descripción
to
requerido

ID de la comuna de destino del envío, rescatado desde el get de comunas

Validations:

  • Must be a Integer
weight
opcional

Peso del paquete a enviar, en kilógramos. Por defecto se setea en 1KG.

Validations:

  • Must be a Float
price_products
opcional

Valor de los productos envíados (esto para proteger el envío ante pérdidas, solo disponible en correos de chile)

Validations:

  • Must be a Integer
dimensions
opcional

Dimensiones del paquete a enviar, en centímetros. Por defecto se setean en 10x10x10cm

Validations:

  • Must be a Hash
dimensions[height]
requerido

Alto del paquete

Validations:

  • Must be a Float
dimensions[deep]
requerido

Ancho del paquete

Validations:

  • Must be a Float
dimensions[large]
requerido

Largo del paquete

Validations:

  • Must be a Float

Returns

Código: 200

Descripción:

OK

Nombre del parámetro Descripción
courier_id
requerido

Courier seleccionado para el envío

Validations:

  • Must be a Integer
service_type
requerido

Tipo de Servicio tarificado: [“Express => 0”, “Express_branch => 1”, “Express_home => 2”, “Extendido => 3”, “Extremos => 4”, “Same_day => 5”, “Next_day => 6”, “No_service => 7”, “Enc_grandes => 8”, “Enc_grandes_extendido => 9”, “Sameday => 10”, “Priority => 11”]

Validations:

  • Must be a Integer
transit_days
requerido

Días de tránsito para el envío

Validations:

  • Must be a Integer
customer_cost
requerido

Valor del envío para el cliente

Validations:

  • Must be a Float

Código: 422

Descripción:

Unprocessable Entity

Nombre del parámetro Descripción
error
requerido

Mensaje indicando el error

Validations:

  • Must be a String
>>>

GET /api/work_orders.json
Método que retorna las órdenes de trabajo de la tienda.

Formatos soportados

json

Ejemplos

Request: https://app.sendu.cl/api/work_orders.json
	https://app.sendu.cl/api/work_orders.json?keywords=Usuario&courier_id=1&work_order_state_id=1&comuna_id=28
	https://app.sendu.cl/api/work_orders.json?keywords=Usuario
	https://app.sendu.cl/api/work_orders.json?courier_id=1
	https://app.sendu.cl/api/work_orders.json?work_order_state_id=3
	https://app.sendu.cl/api/work_orders.json?comuna_id=28
	Salida:
	{
		'id': 63,
		'weight': 1,
		'height': 10,
		'large': 10,
		'deep': 10,
		'lost_coverage': true,
		'name': 'Pablo Reyes',
		'rut': '11111111-1',
		'phone': '987654321',
		'email': 'prueba@api.cl',
		'order': 'R122',
		'category': 'Prueba',
		'price_products': 10000,
		'courier_id': 3,
		'customer_cost': null,
		'courier_ot': '990042995530',
		'transit_days': 3,
		'address': [
			{
				'region_id': 13,
				'comuna_id': 98,
				'street': 'Calle de prueba',
				'numeration': '123',
				'complement': 'La plaza',
				'default': true
			}
		],
		'tracking': [
			{
				'work_order_state_id': 2,
				'event_description': null,
				'event_date': '2019-05-14T11:02:33.986-04:00',
				'reception_date': null,
				'reception_name': null,
				'reception_observation': null,
				'fail_observation': null,
				'last_updated': true
			}
		]
	}, ....

Parámetros

Nombre del parámetro Descripción
keywords
opcional

Filtro de búsqueda para las órdenes de trabajo. Puede ser Rut, email o ID de venta del cliente

Validations:

  • Must be a String
comuna_id
opcional

Filtro de búsqueda por comuna para las órdenes de trabajo

Validations:

  • Must be a String
work_order_state_id
opcional

Filtro de búsqueda por estado de la órden de trabajo.

Validations:

  • Must be a String
courier_id
opcional

Filtro de búsqueda por courier para las órdenes de trabajo

Validations:

  • Must be a String
page
opcional

Número de página requerida

Validations:

  • Must be a String
per_page
opcional

Cantidad de Ordenes por página

Validations:

  • Must be a String

Returns

Código: 200

Descripción:

OK

Nombre del parámetro Descripción
id
requerido

ID de la orden de trabajo

Validations:

  • Must be a Integer
order
requerido

Identificador de compra

Validations:

  • Must be a String
category
requerido

Descripción de la venta

Validations:

  • Must be a String
name
requerido

Nombre del comprador

Validations:

  • Must be a String
email
requerido

Email del comprador

Validations:

  • Must be a String
phone
requerido

Teléfono del comprador

Validations:

  • Must be a String
rut
requerido

Rut del comprador

Validations:

  • Must be a String
weight
requerido

Peso del envío, en KG

Validations:

  • Must be a Float
height
requerido

Alto del paquete a enviar, en CM

Validations:

  • Must be a Float
large
requerido

Largo del paquete a enviar, en CM

Validations:

  • Must be a Float
deep
requerido

Ancho del paquete a enviar, en CM

Validations:

  • Must be a Float
lost_coverage
requerido

Flag que indica si el envío tiene cobertura ante pérdida

Validations:

  • Must be one of: true, false, 1, 0.
company_id
requerido

ID de la tienda

Validations:

  • Must be a Integer
price_products
requerido

Valor de los productos enviados

Validations:

  • Must be a Integer
cost
requerido

Valor del envío para la tienda

Validations:

  • Must be a Float
customer_cost
requerido

Valor del envío para el cliente final

Validations:

  • Must be a Float
courier_id
requerido

ID del courier seleccionado para el envío

Validations:

  • Must be a Integer
courier_ot
requerido

Identificador del envío en el courier

Validations:

  • Must be a String
transit_day
requerido

Dias de transito

Validations:

  • Must be a Integer
address
requerido

Dirección de destino

Validations:

  • Must be a Hash
address[region_id]
requerido

ID de la región de destino

Validations:

  • Must be a Integer
address[comuna_id]
requerido

ID de la comuna de destino

Validations:

  • Must be a Integer
address[street]
requerido

Calle de la dirección de destino

Validations:

  • Must be a String
address[numeration]
requerido

Numeración de la dirección de destino

Validations:

  • Must be a String
address[complement]
requerido

Complemento de la dirección de destino

Validations:

  • Must be a String
address[default]
requerido

Indica si es última dirección de destino ingresada para la compra

Validations:

  • Must be one of: true, false, 1, 0.
tracking
requerido

Cambios de estado de tracking

Validations:

  • Must be an Array of nested elements
tracking[work_order_state_id]
requerido

ID de estado de envío

Validations:

  • Must be a Integer
tracking[event_description]
requerido

Descripción del courier para el estado de tracking

Validations:

  • Must be a String
tracking[event_date]
requerido

Fecha del cambio de estado en el tracking

Validations:

  • Must be a Date
tracking[reception_date]
requerido

Fecha de recepción del envío

Validations:

  • Must be a Date
tracking[reception_name]
requerido

Nombre de quien recibe el envío

Validations:

  • Must be a String
tracking[reception_observation]
requerido

Observación de la entrega del envío ingresada por el courier

Validations:

  • Must be a String
tracking[fail_observation]
requerido

Observación en caso de falla en el envío

Validations:

  • Must be a String
tracking[last_updated]
requerido

Indica si es el último estado reportado por el courier

Validations:

  • Must be one of: true, false, 1, 0.
>>>

POST /api/work_orders.json
Método que permite escribir una orden de trabajo en una tienda

Formatos soportados

json

Ejemplos

Request: https://app.sendu.cl/api/work_orders.json Metodo: POST
	Body:
	{
		'work_order': {
			'order': 'R15',
			'category': 'Prueba',
			'name': 'Prueba Sendu',
			'email': 'prueba@api.cl',
			'phone': '987654321',
			'weight': 1.0,
			'height': 10.0,
			'large': 10.0,
			'deep': 10.0,
			'lost_coverage': true,
			'price_products': 10000,
			'rut': '11111111-1',

			'direction': {
				'region_id': 13,
				'comuna_id': 98,
				'street': 'Calle prueba',
				'numeration': '123',
				'complement': 'La plaza'
			}
		}
	}
	Salida:
	{
		'id': 85,
		'weight': 1,
		'height': 10,
		'large': 10,
		'deep': 10,
		'lost_coverage': true,
		'name': 'Prueba Sendu',
		'rut': '11111111-1',
		'phone': '987654321',
		'email': 'prueba@api.cl',
		'order': 'R15',
		'category': 'Prueba',
		'price_products': 10000,
		'address': [
			{
				'region_id': 13,
				'comuna_id': 98,
				'street': 'Calle prueba',
				'numeration': '123',
				'complement': 'La plaza',
				'default': null
			}
		]
	}

	
 En caso de error se enviará el campo 'error' con la información del mismo.

Parámetros

Nombre del parámetro Descripción
work_order
requerido

Órden de trabajo

Validations:

  • Must be a Hash
work_order[order]
requerido

Identificador de compra

Validations:

  • Must be a String
work_order[category]
opcional

Descripción de la venta

Validations:

  • Must be a String
work_order[name]
requerido

Nombre del comprador

Validations:

  • Must be a String
work_order[email]
requerido

Email del comprador

Validations:

  • Must be a String
work_order[phone]
requerido

Teléfono del comprador

Validations:

  • Must be a String
work_order[rut]
requerido

Rut del comprador

Validations:

  • Must be a String
work_order[weight]
opcional

Peso del envío, en KG

Validations:

  • Must be a decimal number.
work_order[height]
opcional

Alto del paquete a enviar, en CM

Validations:

  • Must be a decimal number.
work_order[large]
opcional

Largo del paquete a enviar, en CM

Validations:

  • Must be a decimal number.
work_order[deep]
opcional

Ancho del paquete a enviar, en CM

Validations:

  • Must be a decimal number.
work_order[lost_coverage]
requerido

Flag que indica si el envío tiene cobertura ante pérdida

Validations:

  • Must be one of: true, false, 1, 0.
work_order[price_products]
requerido

Valor de los productos enviados

Validations:

  • Must be a number.
work_order[direction]
requerido

Dirección de destino

Validations:

  • Must be a Hash
work_order[direction][region_id]
requerido

ID de la región de destino

Validations:

  • Must be a number.
work_order[direction][comuna_id]
requerido

ID de la comuna de destino

Validations:

  • Must be a number.
work_order[direction][street]
requerido

Calle de la dirección de destino

Validations:

  • Must be a String
work_order[direction][numeration]
requerido

Numeración de la dirección de destino

Validations:

  • Must be a String
work_order[direction][complement]
requerido , nil permitido

Complemento de la dirección de destino

Validations:

  • Must be a String

Returns

Código: 422

Descripción:

Unprocessable Entity

Nombre del parámetro Descripción
error
requerido

Mensaje indicando el error

Validations:

  • Must be a String

Código: 200

Descripción:

OK

Nombre del parámetro Descripción
id
requerido

ID de la orden de trabajo

Validations:

  • Must be a Integer
order
requerido

Identificador de compra

Validations:

  • Must be a String
category
requerido

Descripción de la venta

Validations:

  • Must be a String
name
requerido

Nombre del comprador

Validations:

  • Must be a String
email
requerido

Email del comprador

Validations:

  • Must be a String
phone
requerido

Teléfono del comprador

Validations:

  • Must be a String
rut
requerido

Rut del comprador

Validations:

  • Must be a String
weight
requerido

Peso del envío, en KG

Validations:

  • Must be a Float
height
requerido

Alto del paquete a enviar, en CM

Validations:

  • Must be a Float
large
requerido

Largo del paquete a enviar, en CM

Validations:

  • Must be a Float
deep
requerido

Ancho del paquete a enviar, en CM

Validations:

  • Must be a Float
lost_coverage
requerido

Flag que indica si el envío tiene cobertura ante pérdida

Validations:

  • Must be one of: true, false, 1, 0.
company_id
requerido

ID de la tienda

Validations:

  • Must be a Integer
price_products
requerido

Valor de los productos enviados

Validations:

  • Must be a Integer
cost
requerido

Valor del envío para la tienda

Validations:

  • Must be a Float
customer_cost
requerido

Valor del envío para el cliente final

Validations:

  • Must be a Float
courier_id
requerido

ID del courier seleccionado para el envío

Validations:

  • Must be a Integer
courier_ot
requerido

Identificador del envío en el courier

Validations:

  • Must be a String
address
requerido

Dirección de destino

Validations:

  • Must be a Hash
address[region_id]
requerido

ID de la región de destino

Validations:

  • Must be a Integer
address[comuna_id]
requerido

ID de la comuna de destino

Validations:

  • Must be a Integer
address[street]
requerido

Calle de la dirección de destino

Validations:

  • Must be a String
address[numeration]
requerido

Numeración de la dirección de destino

Validations:

  • Must be a String
address[complement]
requerido

Complemento de la dirección de destino

Validations:

  • Must be a String
address[default]
requerido

Indica si es última dirección de destino ingresada para la compra

Validations:

  • Must be one of: true, false, 1, 0.