La API v2 de Handy te permite interactuar con nuestro sistema de manera programática.
Los recursos de uso más frecuente, están marcados con una estrella (⭐).
Las siguientes guías te pueden servir durante el proceso de integración:
Pedidos ⭐️en Acciones primarias
Obtener un pedido
Consulta el diccionario de datos aquí
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Identificador del pedido.
- GEThttps://hub.handy.la/api/v2/salesOrder/id
(Cargando)
(Cargando)
Obtener un pedido por ID externo
Consulta el diccionario de datos aquí
Obtener un pedido usando el ID externo, no el de Handy (externalId). Útil para integraciones.
Puedes establecer el ID de pedido externo usando un PUT a /salesOrder/{id}.
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Identificador externo del pedido.
- GEThttps://hub.handy.la/api/v2/salesOrder/external/id
(Cargando)
(Cargando)
Lista de pedidos
Consulta el diccionario de datos aquí
Enlista todos los pedidos
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Los pedidos que sean considerados como devoluciones, la propiedad salesType
contiene el valor: RETURNSALE
y además cada item estará marcados con el campo isReturn
en true
.
true
o false
. Default: false
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: sin filtro de fecha (todos)
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: sin filtro de fecha (todos)
Fecha a usar para filtrar mobileDateCreated
, dateCreated
o dateDeleted
. Default: mobileDateCreated
. 🔴 En la mayoría de los casos de uso, se recomienda mejor utilizar el campo dateCreated
, que representa el timestamp de llegada al servidor, y no de la captura en el celular. De esta manera, se evita perder pedidos entre pollings si se captura un pedido en modo offline.
Página a regresar. Default: 1
Máximo de registros, topado a 100 por página. Default: 10
Cualquier campo del modelo. Default: dateCreated
asc
o desc
. Default: asc
. 🔴 Sólo se puede utilizar este ordenamiento personalizado en combinación con el campo sort
. Si sólo se especifica order
, no tendrá ningún efecto.
true
o false
.
Indica si el cliente requiere factura. true
ò false
.
true
o false
.
PRESALE
, ROUTESALE
, ó RETURNSALE
.
true
o false
.
- GEThttps://hub.handy.la/api/v2/salesOrder
(Cargando)
(Cargando)
Crear pedido
Consulta el diccionario de datos aquí
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Los pedidos que sean considerados como devoluciones, hay que establecer la propiedad salesType
con el valor: RETURNSALE
y además deben ser marcados con el campo isReturn
en true
en cada item.
Fecha de creación en móvil dd/MM/aaaa HH:mm:ss
.
Arreglo de items
Código de producto
Cantidad
Precio
Total
Comentarios
Precio original
Descuento
Cantidad entregada
IDs de promociones
Nombres de promociones
Código de cliente
Ha sido exportado
Latitud
Precisión
Ventas totales
Tipo
Indica si el cliente requiere factura. true
ò false
.
Comentario del vendedor
Código del precio de lista
Ha sido facturado
Ha sido capturado en ubicación del cliente
Solo en venta en ruta CASH
o CREDIT
Fecha programada para entrega
Longitud
- POSThttps://hub.handy.la/api/v2/salesOrder
(Cargando)
(Cargando)
Actualizar pedido
Consulta el diccionario de datos aquí
Solo se pueden actualizar el atributo externalId y errorMessageFromIntegration
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Identificador del pedido.
Identificador externo
Mensaje de error de la integración
- PUThttps://hub.handy.la/api/v2/salesOrder/id
(Cargando)
(Cargando)
Eliminar pedido
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Identificador del pedido.
- DELETEhttps://hub.handy.la/api/v2/salesOrder/id
(Cargando)
(Cargando)
Marcar como facturado
Marcar un pedido como facturado.
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Identificador del pedido.
- PATCHhttps://hub.handy.la/api/v2/salesOrder/salesOrderId/markAsBilled
(Cargando)
(Cargando)
Marcar como exportado
Marcar un pedido como exportado.
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Identificador del pedido.
- PATCHhttps://hub.handy.la/api/v2/salesOrder/salesOrderId/markAsExported
(Cargando)
(Cargando)
Pedidos del cliente
Enlista todos los pedidos de un cliente.
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
código del cliente.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
true
o false
.
Indica si el cliente requiere factura. true
ò false
.
true
o false
.
- GEThttps://hub.handy.la/api/v2/customer/customerCode/salesOrder
(Cargando)
(Cargando)
Pedidos de la lista de precios
Enlista todos los pedidos de una lista de precios.
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
código de la lista de precios.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
true
o false
.
Indica si el cliente requiere factura. true
ò false
.
true
o false
.
- GEThttps://hub.handy.la/api/v2/priceList/priceListCode/salesOrder
(Cargando)
(Cargando)
Pedidos del usuario
Enlista todos los pedidos de un usuario.
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Identificador de usuario
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
true
o false
.
Indica si el cliente requiere factura. true
ò false
.
true
o false
.
- GEThttps://hub.handy.la/api/v2/user/userId/salesOrder
(Cargando)
(Cargando)
Resumen de pedidos
Muestra un resumen de cantidad de pedidos y total de ventas.
Identificador de usuario
Identificador de cliente
true
o false
. Default: false
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: sin filtro de fecha (todos)
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: sin filtro de fecha (todos)
Fecha a usar para filtrar mobileDateCreated
, dateCreated
o dateDeleted
. Default: mobileDateCreated
. 🔴 En la mayoría de los casos de uso, se recomienda mejor utilizar el campo dateCreated
, que representa el timestamp de llegada al servidor, y no de la captura en el celular. De esta manera, se evita perder pedidos entre pollings si se captura un pedido en modo offline.
true
o false
.
Indica si el cliente requiere factura. true
ò false
.
true
o false
.
PRESALE
, ROUTESALE
, ó RETURNSALE
.
true
o false
.
- GEThttps://hub.handy.la/api/v2/salesOrder/summary
(Cargando)
(Cargando)
Rutas ⭐️en Acciones primarias
Lista de rutas
Enlista todas las rutas
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
true
para solo mostrar rutas cerradas o false
solo para mostrar rutas abiertas,
si requieres ambas no incluyas este parámetro.
Fecha a usar para filtrar mobileDateCreated
, dateCreated
, lastUpdated
, dateFinishedByUser
,
también puedes usar dateClosed
y solo obtendrás rutas cerradas. Default: mobileDateCreated
Hace que la respuesta traiga los IDs de los pedidos (campo salesOrders
) y entregas (campo deliveries
) que pertenecen a la ruta. Puede ser true
ó false
. Default false
.
Hace que la respuesta filtre los pedidos hayan sido eliminados (campo salesOrders
) que pertenecen a la ruta. Puede ser true
ó false
. Y tiene que estar la variable includeSalesOrders
como true
para que se muestren los pedidos. Default true
.
- GEThttps://hub.handy.la/api/v2/route
(Cargando)
(Cargando)
Obtener una ruta
Identificador de la ruta.
Hace que la respuesta traiga un resumen de los pedidos de la ruta (campo salesOrders
) las entregas (campo deliveries
) las devoluciones (campo returnOrders
) y los pagos (campo payments
). Puede ser true
ó false
. Default false
.
- GEThttps://hub.handy.la/api/v2/route/id,includeSalesOrders
(Cargando)
(Cargando)
Crear ruta
Hemos agregado el parámetro - prettyMessages
, este parámetro es usado para regresar un mensaje claro sobre el artículo que tiene errores.
Revisa las respuestas 422
la primera no ha enviado el parámetro prettyMessages
en su solicitud, la segunda sí.
Identificador de usuario.
Incluye el código del artículo con el error y un mensaje claro.
true
o false
. Default: false
Lista de pedidos para repartir
Identificador de pedido
Lista de artículos
Cantidad
Identificador del artículo del pedido
Lista de productos para vender (además de los de los pedidos)
Código de producto
Cantidad
Fecha de entrega dd/MM/aaaa
, si se incluye un listado de pedidos salesOrders
, es obligatorio establecer una fecha, ejemplo el día de mañana
Comentarios
Monto inicial
- POSThttps://hub.handy.la/api/v2/user/userId/route
(Cargando)
(Cargando)
Rutas de usuario
Enlista las rutas de un usuario en específico.
Identificador de usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/user/userId/route
(Cargando)
(Cargando)
Ruta abierta actual de usuario
Obtiene la ruta abierta actual de un usuario en específico.
Identificador de usuario.
- GEThttps://hub.handy.la/api/v2/user/userId/route/current
(Cargando)
(Cargando)
Recargar ruta
Hemos agregado el parámetro - prettyMessages
, este parámetro es usado para regresar un mensaje claro sobre el artículo que tiene errores.
Revisa las respuestas 422
la primera no ha enviado el parámetro prettyMessages
en su solicitud, la segunda sí.
Identificador de usuario.
Incluir el código del artículo con el error y un mensaje claro.
true
o false
. Default: false
Lista de artículos
Código de producto
Cantidad
- POSThttps://hub.handy.la/api/v2/user/userId/route/recharge
(Cargando)
(Cargando)
Lista de pedidos disponibles
Enlista todos los pedidos disponibles para crear una ruta
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Identificador de usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hace 1 año
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: dentro de 1 año
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
- GEThttps://hub.handy.la/api/v2/user/userId/route/salesOrders
(Cargando)
(Cargando)
Lista de entregas asignadas al usuario
Enlista todos las entregas asignadas al usuario dadas las fechas
Identificador de usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
- GEThttps://hub.handy.la/api/v2/user/userId/deliveries
(Cargando)
(Cargando)
Cancelar ruta
Cancela la ruta con el identificador especificado en la URL.
En el objeto de respuesta se incluye el campo canceled
con el valor true
si la ruta fue cancelada exitosamente.
Sólo se puede cancelar una ruta si no ha sido aceptada previamente por el usuario.
ID de la ruta a cancelar.
- DELETEhttps://hub.handy.la/api/v2/route/routeId
(Cargando)
(Cargando)
Clientesen Acciones primarias
Crear cliente
Código.
Descripción.
Identificador de zona
Nombre de la persona que atiende con el cliente. No es el vendedor.
Es prospecto true
ò false
.
Dirección.
Comentarios (tamaño límite 2000
caracteres).
Ciudad.
Latitud.
Código postal.
Descuento.
Indica si el cliente requiere factura. true
ò false
.
Arreglo de fotos de cliente, dadas de alta desde la app móvil.
Identificador de precio de lista.
Número telefónico.
Saldo pendiente.
Es cliente móvil.
Colonia.
Identificador de categoría.
Límite de crédito.
Correo electrónico.
Longitud.
Valor que identifica el regimen fiscal del SAT en Facturama.
Por ejemplo 603
para referirse a Personas Morales con Fines no Lucrativos
.
Podrás consultar todos los valores de los regimes fiscales en este endpoint.
Valor que identifica el uso de CFDI del SAT en Facturama.
Por ejemplo G03
para referirse a Gastos en general
.
Podrás consultar todos los valores de los usos de CFDI en este endpoint.
Identificador externo. Útil para integraciones con otros sistemas.
Tipos de pagos permitidos para realizar entregas. Ejemplo CREDIT
CASH
BOTH
.
En caso de tener pago por defecto con ambos, especificar el valor preferido. Ejemplo CREDIT
CASH
.
Días de crédito.
- POSThttps://hub.handy.la/api/v2/customer
(Cargando)
(Cargando)
Lista de clientes
Enlista todos los clientes
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
Filtra a los clientes prospetos. true
ò false
.
Filtra a los clientes que requieren factura. true
ò false
.
Fecha a usar para filtrar mobileDateCreated
, dateCreated
o dateDeleted
. Default: mobileDateCreated
Filtra clientes por una exacta coincidencia con su descripción.
- GEThttps://hub.handy.la/api/v2/customer
(Cargando)
(Cargando)
Obtener un cliente
Código del cliente.
- GEThttps://hub.handy.la/api/v2/customer/customerCode
(Cargando)
(Cargando)
Obtener un cliente por ID externo
Obtener un cliente usando el ID externo, no el de Handy (externalId). Útil para integraciones.
Puedes establecer el ID de cliente externo usando un PUT a /customer/{id}.
Identificador externo del cliente.
- GEThttps://hub.handy.la/api/v2/customer/external/id
(Cargando)
(Cargando)
Actualizar cliente
Código del cliente. Sólo requerido como parámetro de URL.
Código. Sólo requerido como parámetro de URL.
Descripción.
Identificador de zona
Nombre de la persona que atiende con el cliente. No es el vendedor.
Es prospecto true
ò false
.
Dirección.
Comentarios (tamaño límite 2000
caracteres).
Ciudad.
Latitud.
Código postal.
Descuento.
Indica si el cliente requiere factura. true
ò false
.
Arreglo de fotos de cliente, dadas de alta desde la app móvil.
Identificador de precio de lista.
Número telefónico.
Saldo pendiente.
Es cliente móvil.
Colonia.
Identificador de categoría.
Límite de crédito.
Correo electrónico.
Longitud.
Valor que identifica el regimen fiscal del SAT en Facturama.
Por ejemplo 603
para referirse a Personas Morales con Fines no Lucrativos
.
Podrás consultar todos los valores de los regimes fiscales en este endpoint.
Valor que identifica el uso de CFDI del SAT en Facturama.
Por ejemplo G03
para referirse a Gastos en general
.
Podrás consultar todos los valores de los usos de CFDI en este endpoint.
Identificador externo. Útil para integraciones con otros sistemas.
Tipos de pagos permitidos para realizar entregas. Ejemplo CREDIT
CASH
BOTH
.
En caso de tener pago por defecto con ambos, especificar el valor preferido. Ejemplo CREDIT
CASH
.
Días de crédito.
- PUThttps://hub.handy.la/api/v2/customer/customerCode
(Cargando)
(Cargando)
Eliminar cliente
Código del cliente.
- DELETEhttps://hub.handy.la/api/v2/customer/customerCode
(Cargando)
(Cargando)
Lista de pedidos del cliente
Enlista todos los pedidos de un cliente.
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
código del cliente.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
true
o false
.
Indica si el cliente requiere factura. true
ò false
.
true
o false
.
- GEThttps://hub.handy.la/api/v2/customer/customerCode/salesOrder
(Cargando)
(Cargando)
Precios acordados de un cliente en específico
Enlista todos los precios acordados de un cliente en específico.
Código del cliente.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/customer/customerCode/productCustomer
(Cargando)
(Cargando)
Visitas programadas de un cliente
Enlista todos los pedidos de un cliente.
código del cliente.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/customer/customerCode/calendarEvent
(Cargando)
(Cargando)
Respuestas a formularios de un cliente
Enlista todos las respuestas a formularios de un cliente.
código del cliente.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/customer/customerCode/formResponse
(Cargando)
(Cargando)
Lista de pagos de un cliente
Enlista todos los pagos de un cliente.
código del cliente.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/customer/customerCode/paymentLog
(Cargando)
(Cargando)
Lista de visitas de un cliente
Enlista todas las visitas de un cliente.
código del cliente.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/customer/customerCode/visit
(Cargando)
(Cargando)
Productosen Acciones primarias
Crear producto
Código.
Descripción.
Precio.
Identificador de familia.
Cantidad.
Promover las ventas de este producto. true
o false
Descripción para promover las ventas de este producto.
Identificador de categoría.
Código de producto o servicio del SAT, revisar endpoint de productos del SAT.
Unidad de medida del SAT, revisar endpoint de unidades de medida.
Identificador del impuesto, revisar endpoint de lista de impuestos.
Identificador del impuesto opcional, revisar endpoint de lista de impuestos.
- POSThttps://hub.handy.la/api/v2/product
(Cargando)
(Cargando)
Lista de productos
Enlista todos los productos
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
Fecha a usar para filtrar mobileDateCreated
, dateCreated
o dateDeleted
. Default: mobileDateCreated
Filtra productos por una exacta coincidencia con su descripción.
- GEThttps://hub.handy.la/api/v2/product
(Cargando)
(Cargando)
Obtener un producto
Código del producto.
- GEThttps://hub.handy.la/api/v2/product/productCode
(Cargando)
(Cargando)
Obtener un producto con caracteres especiales en código
Código de producto con caracteres especiales a enviar en el cuerpo del GET.
- GEThttps://hub.handy.la/api/v2/productByCode
(Cargando)
(Cargando)
Actualizar producto
Código del producto.
Código.
Cantidad.
Promover las ventas de este producto. true
o false
Precio.
Descripción.
Descripción para promover las ventas de este producto.
Identificador de categoría.
Identificador de familia.
Código de producto o servicio del SAT, revisar endpoint de productos del SAT.
Unidad de medida del SAT, revisar endpoint de unidades de medida.
Identificador del impuesto, revisar endpoint de lista de impuestos.
Identificador del impuesto opcional, revisar endpoint de lista de impuestos.
- PUThttps://hub.handy.la/api/v2/product/productCode
(Cargando)
(Cargando)
Actualizar producto con caracteres especiales en código
Código.
Código nuevo. Si se quiere actualizar el campo de código: este es el valor que tomará.
Cantidad.
Promover las ventas de este producto. true
o false
Precio.
Descripción.
Descripción para promover las ventas de este producto.
Identificador de categoría.
Identificador de familia.
Código de producto o servicio del SAT, revisar endpoint de productos del SAT.
Unidad de medida del SAT, revisar endpoint de unidades de medida.
Identificador del impuesto, revisar endpoint de lista de impuestos.
Identificador del impuesto opcional, revisar endpoint de lista de impuestos.
- PUThttps://hub.handy.la/api/v2/productByCodeUpdate
(Cargando)
(Cargando)
Eliminar producto
Código del producto.
- DELETEhttps://hub.handy.la/api/v2/product/productCode
(Cargando)
(Cargando)
Precios acordados por cliente de un producto en específico
Enlista todos los precios acordados por cliente de un producto en específico.
Código del producto.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/product/productCode/productCustomer
(Cargando)
(Cargando)
Listas de precios ⭐️en Acciones primarias
Crear lista de precios
Hemos agregado el parámetro - prettyMessages
, este parámetro es usado para regresar un mensaje claro sobre el artículo que tiene errores.
Revisa las respuestas 422
la primera no ha enviado el parámetro prettyMessages
en su solicitud, la segunda sí.
Incluir el código del artículo con el error y un mensaje claro.
true
o false
. Default: false
Código (tamaño límite 50
caracteres).
nombre de lista.
Lista de artículos
Código de producto
Precio
- POSThttps://hub.handy.la/api/v2/priceList
(Cargando)
(Cargando)
Enlistar lista de precios
Enlista todas las listas de precios
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
Fecha a usar para filtrar mobileDateCreated
, dateCreated
o dateDeleted
. Default: mobileDateCreated
true
o false
. Default: true
- GEThttps://hub.handy.la/api/v2/priceList
(Cargando)
(Cargando)
Obtener un precio de lista
Código de la lista de precios.
- GEThttps://hub.handy.la/api/v2/priceList/priceListCode
(Cargando)
(Cargando)
Actualizar lista de precios
Hemos agregado el parámetro - prettyMessages
, este parámetro es usado para regresar un mensaje claro sobre el artículo que tiene errores.
Revisa las respuestas 422
la primera no ha enviado el parámetro prettyMessages
en su solicitud, la segunda sí.
Código de la lista de precios (tamaño límite 50
caracteres).
Incluye el código del artículo con el error y un mensaje claro.
true
o false
. Default: false
Código.
nombre de lista.
Lista de artículos
Código de producto
Precio
- PUThttps://hub.handy.la/api/v2/priceList/priceListCode
(Cargando)
(Cargando)
Eliminar lista de precios
Código de la lista de precios.
- DELETEhttps://hub.handy.la/api/v2/priceList/priceListCode
(Cargando)
(Cargando)
Lista de pedidos de la lista de precios
Enlista todos los pedidos de una lista de precios.
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
código de la lista de precios.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
true
o false
.
Indica si el cliente requiere factura. true
ò false
.
true
o false
.
- GEThttps://hub.handy.la/api/v2/priceList/priceListCode/salesOrder
(Cargando)
(Cargando)
Precios por clienteen Acciones primarias
Crear precios acordados por cliente
Código de producto.
Precio.
Código de cliente.
- POSThttps://hub.handy.la/api/v2/productCustomer
(Cargando)
(Cargando)
Lista precios acordados por cliente
Enlista todos los precios de productos acordados por cliente
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
Fecha a usar para filtrar mobileDateCreated
, dateCreated
o dateDeleted
. Default: mobileDateCreated
true
o false
. Default: true
- GEThttps://hub.handy.la/api/v2/productCustomer
(Cargando)
(Cargando)
Deshabilitar precios acordados por cliente
Deshabilita precios acordados por cliente
Código de producto.
Código de cliente.
- DELETEhttps://hub.handy.la/api/v2/productCustomer
(Cargando)
(Cargando)
Precios acordados de un cliente en específico
Enlista todos los precios acordados de un cliente en específico.
Código del cliente.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/customer/customerCode/productCustomer
(Cargando)
(Cargando)
Precios acordados por cliente de un producto en específico
Enlista todos los precios acordados por cliente de un producto en específico.
Código del producto.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/product/productCode/productCustomer
(Cargando)
(Cargando)
Usuariosen Acciones primarias
Crear usuario
Identificador de rol.
Contraseña (tamaño límite 128
caracteres).
Identificador de Zona.
Nombre.
Correo electrónico.
Comentarios.
Zona horaria.
Latitud.
Url de foto.
Extras.
Lugar del usuario.
Código telefónico del pais del usuario.
Número telefónico.
Si desea enviar el resumen de cumplimiento de precios.
Identificador del tipo de usuario.
Longitud.
Nombre de usuario.
- POSThttps://hub.handy.la/api/v2/user
(Cargando)
(Cargando)
Lista de usuarios
Enlista todos los usuarios
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
Identificador de role.
Identificador de tipo de usuario.
Fecha a usar para filtrar mobileDateCreated
, dateCreated
o dateDeleted
. Default: mobileDateCreated
- GEThttps://hub.handy.la/api/v2/user
(Cargando)
(Cargando)
Obtener un usuario
Identificador del usuario.
- GEThttps://hub.handy.la/api/v2/user/id
(Cargando)
(Cargando)
Actualizar usuario
Identificador del usuario.
Identificador de rol.
Contraseña (tamaño límite 128
caracteres).
Identificador de Zona.
Nombre.
Correo electrónico.
Comentarios.
Zona horaria.
Latitud.
Url de foto.
Extras.
Lugar del usuario.
Código telefónico del pais del usuario.
Número telefónico.
Si desea enviar el resumen de cumplimiento de precios.
Identificador del tipo de usuario.
Longitud.
Nombre de usuario.
- PUThttps://hub.handy.la/api/v2/user/id
(Cargando)
(Cargando)
Deshabilitar usuario
Deshabilita usuario
Identificador del usuario.
- DELETEhttps://hub.handy.la/api/v2/user/id
(Cargando)
(Cargando)
Buscar un usuario
Busca un usuario con su nombre de usuario (Correo electrónico).
Correo electrónico del usuario.
- GEThttps://hub.handy.la/api/v2/user/search?username
(Cargando)
(Cargando)
Lista de pedidos de un usuario
Enlista todos los pedidos de un usuario.
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Identificador de usuario
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
true
o false
.
Indica si el cliente requiere factura. true
ò false
.
true
o false
.
- GEThttps://hub.handy.la/api/v2/user/userId/salesOrder
(Cargando)
(Cargando)
Crear ruta
Hemos agregado el parámetro - prettyMessages
, este parámetro es usado para regresar un mensaje claro sobre el artículo que tiene errores.
Revisa las respuestas 422
la primera no ha enviado el parámetro prettyMessages
en su solicitud, la segunda sí.
Identificador de usuario.
Incluye el código del artículo con el error y un mensaje claro.
true
o false
. Default: false
Lista de pedidos para repartir
Identificador de pedido
Lista de artículos
Cantidad
Identificador del artículo del pedido
Lista de productos para vender (además de los de los pedidos)
Código de producto
Cantidad
Fecha de entrega
Comentarios
Monto inicial
- POSThttps://hub.handy.la/api/v2/user/userId/route
(Cargando)
(Cargando)
Lista de rutas
Enlista todas las rutas
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/route
(Cargando)
(Cargando)
Ruta abierta actual
Obtiene la ruta abierta actual de un usuario en específico.
Identificador de usuario.
- GEThttps://hub.handy.la/api/v2/user/userId/route/current
(Cargando)
(Cargando)
Recargar ruta
Hemos agregado el parámetro - prettyMessages
, este parámetro es usado para regresar un mensaje claro sobre el artículo que tiene errores.
Revisa las respuestas 422
la primera no ha enviado el parámetro prettyMessages
en su solicitud, la segunda sí.
Identificador de usuario.
Incluye el código del artículo con el error y un mensaje claro.
true
o false
. Default: false
Lista de artículos
Código de producto
Cantidad
- POSThttps://hub.handy.la/api/v2/user/userId/route/recharge
(Cargando)
(Cargando)
Lista de pedidos disponibles
Enlista todos los pedidos disponibles para crear una ruta
Hemos agregado el campo a la respuesta - operativeStatus
, el cual contiene los siguientes valores: PENDING_DELIVERY
,ON_ROUTE
,PARTIAL_DELIVERED_OPEN
,PARTIAL_DELIVERED_CLOSED
,DELIVERED_COMPLETE
,RETURNED
,CLOSED
.
También hemos agregado el campo a la respuesta - prettyOperativeStatus
, que nos informa del estatus operativo de una forma más clara y contiene los siguientes valores: Por entregar
,En ruta
,Entrega parcial
,Cerrado - Entrega parcial
,Entrega completa
,Devuelto
,Cerrado
.
Revisa el siguiente link para más información: Estados operativos de pedido
Identificador de usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
- GEThttps://hub.handy.la/api/v2/user/userId/route/salesOrders
(Cargando)
(Cargando)
Lista de entregas asignadas al usuario
Enlista todos las entregas asignadas al usuario dadas las fechas
Identificador de usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
- GEThttps://hub.handy.la/api/v2/user/userId/deliveries
(Cargando)
(Cargando)
Visitas programadas de un usuario
Enlista todos los pedidos de un usuario.
Identificador del usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/user/userId/calendarEvent
(Cargando)
(Cargando)
Elimina visitas programadas de un usuario
Elimina las visitas programadas en un rango de fechas de un usuario en específico.
Identificador del usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
.
Fecha fin dd/MM/aaaa HH:mm:ss
.
- DELETEhttps://hub.handy.la/api/v2/user/userId/calendarEvent
(Cargando)
(Cargando)
Respuestas a formularios de un usuario
Enlista todas las respuestas a formularios de un usuario.
Identificador del usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/user/userId/formResponse
(Cargando)
(Cargando)
Lista de pagos de un usuario
Enlista todas los pagos de un usuario.
Identificador del usuario.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/user/userId/paymentLog
(Cargando)
(Cargando)
Lista de visitas de un usuario
Enlista todas las visitas de un usuario.
Identificador del usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/user/userId/visit
(Cargando)
(Cargando)
Visitas programadasen Acciones primarias
Programar visita
Fecha de termino dd/MM/aaaa HH:mm:ss
.
Fecha de inicio dd/MM/aaaa HH:mm:ss
.
Identificador de usuario.
Código de cliente.
Recurrencia.
Comentario.
Pronostico de venta.
- POSThttps://hub.handy.la/api/v2/calendarEvent
(Cargando)
(Cargando)
Lista de visitas programadas
Enlista todas las visitas programadas.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
Fecha a usar para filtrar mobileDateCreated
, dateCreated
o dateDeleted
. Default: mobileDateCreated
- GEThttps://hub.handy.la/api/v2/calendarEvent
(Cargando)
(Cargando)
Elimina visitas programadas
Elimina las visitas programadas de un rango de fechas.
Fecha inicio dd/MM/aaaa HH:mm:ss
.
Fecha fin dd/MM/aaaa HH:mm:ss
.
- DELETEhttps://hub.handy.la/api/v2/calendarEvent
(Cargando)
(Cargando)
Obtener una visita programada
Identificador de la visita.
- GEThttps://hub.handy.la/api/v2/calendarEvent/id
(Cargando)
(Cargando)
Visitas programadas de un cliente
Enlista todos los pedidos de un cliente.
código del cliente.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/customer/customerCode/calendarEvent
(Cargando)
(Cargando)
Visitas programadas de un usuario
Enlista todos los pedidos de un usuario.
Identificador del usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/user/userId/calendarEvent
(Cargando)
(Cargando)
Elimina visitas programadas de un usuario
Elimina las visitas programadas en un rango de fechas de un usuario en específico.
Identificador del usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
.
Fecha fin dd/MM/aaaa HH:mm:ss
.
- DELETEhttps://hub.handy.la/api/v2/user/userId/calendarEvent
(Cargando)
(Cargando)
Respuestas a formulariosen Acciones primarias
Lista de respuestas a formularios
Enlista todas las respuestas a formularios.
El error 404 se puede presentar si se filtra por un usuario, cliente o formulario que no existen. Los filtros por usuario, cliente o formulario, estás optimizados para utilizarse de forma independiente (no combinados).
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
ID de formulario para filtrar. Ejemplo /formResponse?formId=1
Fecha a usar para filtrar dateAnswered
, dateCreated
. Default: dateAnswered
. Para estar haciendo polling de las respuestas usar dateCreated
.
- GEThttps://hub.handy.la/api/v2/formResponse
(Cargando)
(Cargando)
Obtener una respuesta a formulario
Identificador de la respuesta a formulario.
- GEThttps://hub.handy.la/api/v2/formResponse/id
(Cargando)
(Cargando)
Respuestas a formularios de un cliente
Enlista todos las respuestas a formularios de un cliente.
código del cliente.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/customer/customerCode/formResponse
(Cargando)
(Cargando)
Respuestas a formularios de un usuario
Enlista todas las respuestas a formularios de un usuario.
Identificador del usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/user/userId/formResponse
(Cargando)
(Cargando)
Ubicación de usuariosen Acciones primarias
Historial de ubicaciones
Enlista todas las ubicaciones de un usuario.
Identificador del usuario.
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
- GEThttps://hub.handy.la/api/v2/user/userId/locationHistory
(Cargando)
(Cargando)
Notificacionesen Acciones primarias
Enviar una notificación
Identificador de pedido.
Mensaje.
tipo.
- POSThttps://hub.handy.la/api/v2/notification/push
(Cargando)
(Cargando)
Pagosen Acciones primarias
Lista de pagos
Enlista todos los pagos.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
Fecha a usar para filtrar mobileDateCreated
, dateCreated
o dateDeleted
. Default: mobileDateCreated
- GEThttps://hub.handy.la/api/v2/paymentLog
(Cargando)
(Cargando)
Obtener un pago
Identificador del pago.
- GEThttps://hub.handy.la/api/v2/paymentLog/id
(Cargando)
(Cargando)
Lista de pagos de un cliente
Enlista todos los pagos de un cliente.
código del cliente.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/customer/customerCode/paymentLog
(Cargando)
(Cargando)
Lista de pagos de un usuario
Enlista todas los pagos de un usuario.
Identificador del usuario.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
- GEThttps://hub.handy.la/api/v2/user/userId/paymentLog
(Cargando)
(Cargando)
Lista de pagos de entregas
Enlista los pagos de entregas realizados en una ruta.
true
o false
. Default: true
Fecha inicio dd/MM/aaaa HH:mm:ss
. Default: hoy
Fecha fin dd/MM/aaaa HH:mm:ss
. Default: hoy
Página a regresar. Default: 1
Máximo de registros, topado a 100. Default: 10
asc
o desc
. Default: asc
Cualquier campo del modelo. Default: dateCreated
Id de entrega.
Id de ruta.
Id del cliente.
- GEThttps://hub.handy.la/api/v2/payment/delivery