Referencia de API (v2)

Actualizado en March 29, 2022

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

GET
/api/v2/salesOrder/{id}

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

Parámetros URI
id
stringRequerido

Identificador del pedido.

  • GEThttps://hub.handy.la/api/v2/salesOrder/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener un pedido por ID externo

GET
/api/v2/salesOrder/external/{id}

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

Parámetros URI
id
stringRequerido

Identificador externo del pedido.

  • GEThttps://hub.handy.la/api/v2/salesOrder/external/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de pedidos

GET
/api/v2/salesOrder{?enabled,start,end,page,max,order,sort,exported,billable,billed,salesType,filterWithDate}

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

Parámetros URI
enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100 por página. Default: 10

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

order
stringOpcional

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.

exported
stringOpcional

true o false.

billable
stringOpcional

Indica si el cliente requiere factura. true ò false.

billed
stringOpcional

true o false.

salesType
stringOpcional

PRESALE, ROUTESALE, ó RETURNSALE.

filterWithDate
stringOpcional

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.

  • GEThttps://hub.handy.la/api/v2/salesOrder
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Crear pedido

POST
/api/v2/salesOrder

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

Cuerpo de la solicitud
mobileDateCreated
stringRequerido

Fecha de creación en móvil dd/MM/aaaa HH:mm:ss.

items
array[object]Requerido

Arreglo de items

product
stringRequerido

Código de producto

quantity
numberRequerido

Cantidad

price
numberRequerido

Precio

total
numberOpcional

Total

comments
stringOpcional

Comentarios

originalPrice
numberOpcional

Precio original

discount
numberOpcional

Descuento

delivered
numberOpcional

Cantidad entregada

promoIds
stringOpcional

IDs de promociones

promoNames
stringOpcional

Nombres de promociones

customer
stringRequerido

Código de cliente

exported
booleanOpcional

Ha sido exportado

latitude
stringOpcional

Latitud

accuracy
stringOpcional

Precisión

totalSales
numberOpcional

Ventas totales

type
numberOpcional

Tipo

billable
booleanOpcional

Indica si el cliente requiere factura. true ò false.

sellerComment
stringOpcional

Comentario del vendedor

priceList
stringOpcional

Código del precio de lista

billed
booleanOpcional

Ha sido facturado

tookInPlace
booleanOpcional

Ha sido capturado en ubicación del cliente

routeSalePaymentType
stringOpcional

Solo en venta en ruta CASH o CREDIT

scheduledDateForDelivery
stringOpcional

Fecha programada para entrega

longitude
stringOpcional

Longitud

  • POSThttps://hub.handy.la/api/v2/salesOrder
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Actualizar pedido

PUT
/api/v2/salesOrder/{id}

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

Parámetros URI
id
stringRequerido

Identificador del pedido.

Cuerpo de la solicitud
externalId
stringOpcional

Identificador externo

errorMessageFromIntegration
stringOpcional

Mensaje de error de la integración

  • PUThttps://hub.handy.la/api/v2/salesOrder/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Eliminar pedido

DELETE
/api/v2/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

Parámetros URI
id
stringRequerido

Identificador del pedido.

  • DELETEhttps://hub.handy.la/api/v2/salesOrder/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Marcar como facturado

PATCH
/api/v2/salesOrder/{salesOrderId}/markAsBilled

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

Parámetros URI
salesOrderId
stringRequerido

Identificador del pedido.

  • PATCHhttps://hub.handy.la/api/v2/salesOrder/salesOrderId/markAsBilled
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Marcar como exportado

PATCH
/api/v2/salesOrder/{salesOrderId}/markAsExported

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

Parámetros URI
salesOrderId
stringRequerido

Identificador del pedido.

  • PATCHhttps://hub.handy.la/api/v2/salesOrder/salesOrderId/markAsExported
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Pedidos del cliente

GET
/api/v2/customer/{customerCode}/salesOrder{?enabled,start,end,page,max,order,sort,exported,billable,billed,salesType,filterWithDate}

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

Parámetros URI
customerCode
stringRequerido

código del cliente.

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

exported
stringOpcional

true o false.

billable
stringOpcional

Indica si el cliente requiere factura. true ò false.

billed
stringOpcional

true o false.

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/salesOrder
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Pedidos de la lista de precios

GET
/api/v2/priceList/{priceListCode}/salesOrder{?enabled,start,end,page,max,order,sort,exported,billable,billed,salesType,filterWithDate}

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

Parámetros URI
priceListCode
stringRequerido

código de la lista de precios.

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

exported
stringOpcional

true o false.

billable
stringOpcional

Indica si el cliente requiere factura. true ò false.

billed
stringOpcional

true o false.

  • GEThttps://hub.handy.la/api/v2/priceList/priceListCode/salesOrder
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Pedidos del usuario

GET
/api/v2/user/{userId}/salesOrder{?enabled,start,end,page,max,order,sort,exported,billable,billed,salesType,filterWithDate}

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

Parámetros URI
userId
stringRequerido

Identificador de usuario

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

exported
stringOpcional

true o false.

billable
stringOpcional

Indica si el cliente requiere factura. true ò false.

billed
stringOpcional

true o false.

  • GEThttps://hub.handy.la/api/v2/user/userId/salesOrder
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Rutas ⭐️en Acciones primarias

Lista de rutas

GET
/api/v2/route{?start,end,page,max,order,sort,closed,filterWithDate,includeSalesOrders,includeDisabledSalesOrders}

Enlista todas las rutas

Parámetros URI
start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

closed
stringOpcional

true para solo mostrar rutas cerradas o false solo para mostrar rutas abiertas,
si requieres ambas no incluyas este parámetro.

filterWithDate
stringOpcional

Fecha a usar para filtrar mobileDateCreated, dateCreated, lastUpdated, dateFinishedByUser,
también puedes usar dateClosed y solo obtendrás rutas cerradas. Default: mobileDateCreated

includeSalesOrders
stringOpcional

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.

includeDisabledSalesOrders
stringOpcional

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
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener una ruta

GET
/api/v2/route/{id}
Parámetros URI
id
stringRequerido

Identificador de la ruta.

  • GEThttps://hub.handy.la/api/v2/route/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Crear ruta

POST
/api/v2/user/{userId}/route{?prettyMessages}

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í.

Parámetros URI
userId
stringRequerido

Identificador de usuario.

prettyMessages
stringOpcional

Incluye el código del artículo con el error y un mensaje claro.
true o false. Default: false

Cuerpo de la solicitud
salesOrders
array[object]Requerido

Lista de pedidos para repartir

salesOrderId
numberRequerido

Identificador de pedido

items
array[object]Requerido

Lista de artículos

quantity
numberRequerido

Cantidad

salesOrderItemId
numberRequerido

Identificador del artículo del pedido

products
array[object]Requerido

Lista de productos para vender (además de los de los pedidos)

product
stringRequerido

Código de producto

quantity
numberRequerido

Cantidad

dateForDelivery
stringOpcional

Fecha de entrega

comments
stringOpcional

Comentarios

initialAmount
numberOpcional

Monto inicial

  • POSThttps://hub.handy.la/api/v2/user/userId/route
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Rutas de usuario

GET
/api/v2/user/{userId}/route{?start,end,page,max,order,sort}

Enlista las rutas de un usuario en específico.

Parámetros URI
userId
stringRequerido

Identificador de usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/user/userId/route
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Ruta abierta actual de usuario

GET
/api/v2/user/{userId}/route/current}

Obtiene la ruta abierta actual de un usuario en específico.

Parámetros URI
userId
stringRequerido

Identificador de usuario.

  • GEThttps://hub.handy.la/api/v2/user/userId/route/current
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Recargar ruta

POST
/api/v2/user/{userId}/route/recharge{?prettyMessages}

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í.

Parámetros URI
userId
stringRequerido

Identificador de usuario.

prettyMessages
stringOpcional

Incluir el código del artículo con el error y un mensaje claro.
true o false. Default: false

Cuerpo de la solicitud
items
array[object]Requerido

Lista de artículos

product
stringRequerido

Código de producto

quantity
numberRequerido

Cantidad

  • POSThttps://hub.handy.la/api/v2/user/userId/route/recharge
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de pedidos disponibles

GET
/api/v2/user/{userId}/route/salesOrders{?start,end,page,max}

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

Parámetros URI
userId
stringRequerido

Identificador de usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hace 1 año

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: dentro de 1 año

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

  • GEThttps://hub.handy.la/api/v2/user/userId/route/salesOrders
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de entregas asignadas al usuario

GET
/api/v2/user/{userId}/deliveries{?start,end,page,max}

Enlista todos las entregas asignadas al usuario dadas las fechas

Parámetros URI
userId
stringRequerido

Identificador de usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

  • GEThttps://hub.handy.la/api/v2/user/userId/deliveries
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Clientesen Acciones primarias

Crear cliente

POST
/api/v2/customer
Cuerpo de la solicitud
code
stringRequerido

Código.

description
stringRequerido

Descripción.

zone
numberRequerido

Identificador de zona

owner
stringOpcional

Nombre de la persona que atiende con el cliente. No es el vendedor.

isProspect
booleanOpcional

Es prospecto true ò false.

address
stringOpcional

Dirección.

comments
stringOpcional

Comentarios (tamaño límite 2000 caracteres).

city
stringOpcional

Ciudad.

latitude
numberOpcional

Latitud.

postalCode
stringOpcional

Código postal.

discount
numberOpcional

Descuento.

billable
booleanOpcional

Indica si el cliente requiere factura. true ò false.

picturesUrls
stringOpcional

Arreglo de fotos de cliente, dadas de alta desde la app móvil.

priceList
numberOpcional

Identificador de precio de lista.

phoneNumber
stringOpcional

Número telefónico.

balance
numberOpcional

Saldo pendiente.

isMobile
booleanOpcional

Es cliente móvil.

neighborhood
stringOpcional

Colonia.

category
numberOpcional

Identificador de categoría.

credit
numberOpcional

Límite de crédito.

email
stringOpcional

Correo electrónico.

longitude
numberOpcional

Longitud.

fiscalRegime
stringOpcional

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.

cfdiUse
stringOpcional

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.

externalId
stringOpcional

Identificador externo. Útil para integraciones con otros sistemas.

paymentType
stringOpcional

Tipos de pagos permitidos para realizar entregas. Ejemplo CREDIT CASH BOTH.

paymentTypeDefault
stringOpcional

En caso de tener pago por defecto con ambos, especificar el valor preferido. Ejemplo CREDIT CASH.

creditDays
numberOpcional

Días de crédito.

  • POSThttps://hub.handy.la/api/v2/customer
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de clientes

GET
/api/v2/customer{?enabled,start,end,page,max,order,sort,showProspect,billable,filterWithDate,filter}

Enlista todos los clientes

Parámetros URI
enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

showProspect
stringOpcional

Filtra a los clientes prospetos. true ò false.

billable
stringOpcional

Filtra a los clientes que requieren factura. true ò false.

filterWithDate
stringOpcional

Fecha a usar para filtrar mobileDateCreated, dateCreated o dateDeleted. Default: mobileDateCreated

filter
stringOpcional

Filtra clientes por una exacta coincidencia con su descripción.

  • GEThttps://hub.handy.la/api/v2/customer
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener un cliente

GET
/api/v2/customer/{customerCode}
Parámetros URI
customerCode
stringRequerido

Código del cliente.

  • GEThttps://hub.handy.la/api/v2/customer/customerCode
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener un cliente por ID externo

GET
/api/v2/customer/external/{id}

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}.

Parámetros URI
id
stringRequerido

Identificador externo del cliente.

  • GEThttps://hub.handy.la/api/v2/customer/external/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Actualizar cliente

PUT
/api/v2/customer/{customerCode}
Parámetros URI
customerCode
stringRequerido

Código del cliente.

Cuerpo de la solicitud
code
stringRequerido

Código.

description
stringRequerido

Descripción.

zone
numberRequerido

Identificador de zona

owner
stringOpcional

Nombre de la persona que atiende con el cliente. No es el vendedor.

isProspect
booleanOpcional

Es prospecto true ò false.

address
stringOpcional

Dirección.

comments
stringOpcional

Comentarios (tamaño límite 2000 caracteres).

city
stringOpcional

Ciudad.

latitude
numberOpcional

Latitud.

postalCode
stringOpcional

Código postal.

discount
numberOpcional

Descuento.

billable
booleanOpcional

Indica si el cliente requiere factura. true ò false.

picturesUrls
stringOpcional

Arreglo de fotos de cliente, dadas de alta desde la app móvil.

priceList
numberOpcional

Identificador de precio de lista.

phoneNumber
stringOpcional

Número telefónico.

balance
numberOpcional

Saldo pendiente.

isMobile
booleanOpcional

Es cliente móvil.

neighborhood
stringOpcional

Colonia.

category
numberOpcional

Identificador de categoría.

credit
numberOpcional

Límite de crédito.

email
stringOpcional

Correo electrónico.

longitude
numberOpcional

Longitud.

fiscalRegime
stringOpcional

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.

cfdiUse
stringOpcional

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.

externalId
stringOpcional

Identificador externo. Útil para integraciones con otros sistemas.

paymentType
stringOpcional

Tipos de pagos permitidos para realizar entregas. Ejemplo CREDIT CASH BOTH.

paymentTypeDefault
stringOpcional

En caso de tener pago por defecto con ambos, especificar el valor preferido. Ejemplo CREDIT CASH.

creditDays
numberOpcional

Días de crédito.

  • PUThttps://hub.handy.la/api/v2/customer/customerCode
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Eliminar cliente

DELETE
/api/v2/customer/{customerCode}
Parámetros URI
customerCode
stringRequerido

Código del cliente.

  • DELETEhttps://hub.handy.la/api/v2/customer/customerCode
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de pedidos del cliente

GET
/api/v2/customer/{customerCode}/salesOrder{?enabled,start,end,page,max,order,sort,exported,billable,billed,salesType,filterWithDate}

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

Parámetros URI
customerCode
stringRequerido

código del cliente.

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

exported
stringOpcional

true o false.

billable
stringOpcional

Indica si el cliente requiere factura. true ò false.

billed
stringOpcional

true o false.

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/salesOrder
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Precios acordados de un cliente en específico

GET
/api/v2/customer/{customerCode}/productCustomer{?start,end,page,max,order,sort}

Enlista todos los precios acordados de un cliente en específico.

Parámetros URI
customerCode
stringRequerido

Código del cliente.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/productCustomer
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Visitas programadas de un cliente

GET
/api/v2/customer/{customerCode}/calendarEvent{?start,end,page,max,order,sort}

Enlista todos los pedidos de un cliente.

Parámetros URI
customerCode
stringRequerido

código del cliente.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/calendarEvent
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Respuestas a formularios de un cliente

GET
/api/v2/customer/{customerCode}/formResponse{?enabled,start,end,page,max,order,sort}

Enlista todos las respuestas a formularios de un cliente.

Parámetros URI
customerCode
stringRequerido

código del cliente.

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/formResponse
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de pagos de un cliente

GET
/api/v2/customer/{customerCode}/paymentLog{?enabled,start,end,page,max,order,sort}

Enlista todos los pagos de un cliente.

Parámetros URI
customerCode
stringRequerido

código del cliente.

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/paymentLog
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de visitas de un cliente

GET
/api/v2/customer/{customerCode}/visit{?start,end,page,max,order,sort}

Enlista todas las visitas de un cliente.

Parámetros URI
customerCode
stringRequerido

código del cliente.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/visit
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Productosen Acciones primarias

Crear producto

POST
/api/v2/product
Cuerpo de la solicitud
code
stringRequerido

Código.

description
stringRequerido

Descripción.

price
numberRequerido

Precio.

family
numberRequerido

Identificador de familia.

quantity
numberOpcional

Cantidad.

boostSales
booleanOpcional

Promover las ventas de este producto. true o false

boostSalesDescription
stringOpcional

Descripción para promover las ventas de este producto.

category
numberOpcional

Identificador de categoría.

satProduct
stringOpcional

Código de producto o servicio del SAT, revisar endpoint de productos del SAT.

satUnit
stringOpcional

Unidad de medida del SAT, revisar endpoint de unidades de medida.

tax
numberOpcional

Identificador del impuesto, revisar endpoint de lista de impuestos.

taxOptional
numberOpcional

Identificador del impuesto opcional, revisar endpoint de lista de impuestos.

  • POSThttps://hub.handy.la/api/v2/product
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de productos

GET
/api/v2/product{?enabled,start,end,page,max,order,sort,filterWithDate,filter}

Enlista todos los productos

Parámetros URI
enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOpcional

Fecha a usar para filtrar mobileDateCreated, dateCreated o dateDeleted. Default: mobileDateCreated

filter
stringOpcional

Filtra productos por una exacta coincidencia con su descripción.

  • GEThttps://hub.handy.la/api/v2/product
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener un producto

GET
/api/v2/product/{productCode}
Parámetros URI
productCode
stringRequerido

Código del producto.

  • GEThttps://hub.handy.la/api/v2/product/productCode
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener un producto con caracteres especiales en código

GET
/api/v2/productByCode
Datos de respuesta
code
stringRequerido

Código de producto con caracteres especiales a enviar en el cuerpo del GET.

  • GEThttps://hub.handy.la/api/v2/productByCode
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Actualizar producto

PUT
/api/v2/product/{productCode}
Parámetros URI
productCode
stringRequerido

Código del producto.

Cuerpo de la solicitud
code
stringRequerido

Código.

quantity
numberOpcional

Cantidad.

boostSales
booleanOpcional

Promover las ventas de este producto. true o false

price
numberOpcional

Precio.

description
stringOpcional

Descripción.

boostSalesDescription
stringOpcional

Descripción para promover las ventas de este producto.

category
numberOpcional

Identificador de categoría.

family
numberOpcional

Identificador de familia.

satProduct
stringOpcional

Código de producto o servicio del SAT, revisar endpoint de productos del SAT.

satUnit
stringOpcional

Unidad de medida del SAT, revisar endpoint de unidades de medida.

tax
numberOpcional

Identificador del impuesto, revisar endpoint de lista de impuestos.

taxOptional
numberOpcional

Identificador del impuesto opcional, revisar endpoint de lista de impuestos.

  • PUThttps://hub.handy.la/api/v2/product/productCode
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Actualizar producto con caracteres especiales en código

PUT
/api/v2/productByCodeUpdate
Cuerpo de la solicitud
code
stringRequerido

Código.

newCode
stringOpcional

Código nuevo. Si se quiere actualizar el campo de código: este es el valor que tomará.

quantity
numberOpcional

Cantidad.

boostSales
booleanOpcional

Promover las ventas de este producto. true o false

price
numberOpcional

Precio.

description
stringOpcional

Descripción.

boostSalesDescription
stringOpcional

Descripción para promover las ventas de este producto.

category
numberOpcional

Identificador de categoría.

family
numberOpcional

Identificador de familia.

satProduct
stringOpcional

Código de producto o servicio del SAT, revisar endpoint de productos del SAT.

satUnit
stringOpcional

Unidad de medida del SAT, revisar endpoint de unidades de medida.

tax
numberOpcional

Identificador del impuesto, revisar endpoint de lista de impuestos.

taxOptional
numberOpcional

Identificador del impuesto opcional, revisar endpoint de lista de impuestos.

  • PUThttps://hub.handy.la/api/v2/productByCodeUpdate
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Eliminar producto

DELETE
/api/v2/product/{productCode}
Parámetros URI
productCode
stringRequerido

Código del producto.

  • DELETEhttps://hub.handy.la/api/v2/product/productCode
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Precios acordados por cliente de un producto en específico

GET
/api/v2/product/{productCode}/productCustomer{?start,end,page,max,order,sort}

Enlista todos los precios acordados por cliente de un producto en específico.

Parámetros URI
productCode
stringRequerido

Código del producto.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/product/productCode/productCustomer
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Listas de precios ⭐️en Acciones primarias

Crear lista de precios

POST
/api/v2/priceList{?prettyMessages}

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í.

Parámetros URI
prettyMessages
stringOpcional

Incluir el código del artículo con el error y un mensaje claro.
true o false. Default: false

Cuerpo de la solicitud
code
stringRequerido

Código (tamaño límite 50 caracteres).

name
stringRequerido

nombre de lista.

items
array[object]Requerido

Lista de artículos

product
stringRequerido

Código de producto

price
numberRequerido

Precio

  • POSThttps://hub.handy.la/api/v2/priceList
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Enlistar lista de precios

GET
/api/v2/priceList{?enabled,start,end,page,max,order,sort,filterWithDate,includeItems}

Enlista todas las listas de precios

Parámetros URI
enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOpcional

Fecha a usar para filtrar mobileDateCreated, dateCreated o dateDeleted. Default: mobileDateCreated

includeItems
stringOpcional

true o false. Default: true

  • GEThttps://hub.handy.la/api/v2/priceList
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener un precio de lista

GET
/api/v2/priceList/{priceListCode}
Parámetros URI
priceListCode
stringRequerido

Código de la lista de precios.

  • GEThttps://hub.handy.la/api/v2/priceList/priceListCode
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Actualizar lista de precios

PUT
/api/v2/priceList/{priceListCode}{?prettyMessages}

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í.

Parámetros URI
priceListCode
stringRequerido

Código de la lista de precios (tamaño límite 50 caracteres).

prettyMessages
stringOpcional

Incluye el código del artículo con el error y un mensaje claro.
true o false. Default: false

Cuerpo de la solicitud
code
stringRequerido

Código.

name
stringRequerido

nombre de lista.

items
array[object]Requerido

Lista de artículos

product
stringRequerido

Código de producto

price
numberRequerido

Precio

  • PUThttps://hub.handy.la/api/v2/priceList/priceListCode
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Eliminar lista de precios

DELETE
/api/v2/priceList/{priceListCode}
Parámetros URI
priceListCode
stringRequerido

Código de la lista de precios.

  • DELETEhttps://hub.handy.la/api/v2/priceList/priceListCode
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de pedidos de la lista de precios

GET
/api/v2/priceList/{priceListCode}/salesOrder{?enabled,start,end,page,max,order,sort,exported,billable,billed,salesType,filterWithDate}

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

Parámetros URI
priceListCode
stringRequerido

código de la lista de precios.

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

exported
stringOpcional

true o false.

billable
stringOpcional

Indica si el cliente requiere factura. true ò false.

billed
stringOpcional

true o false.

  • GEThttps://hub.handy.la/api/v2/priceList/priceListCode/salesOrder
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Precios por clienteen Acciones primarias

Crear precios acordados por cliente

POST
/api/v2/productCustomer
Cuerpo de la solicitud
product
stringRequerido

Código de producto.

price
numberRequerido

Precio.

customer
stringRequerido

Código de cliente.

  • POSThttps://hub.handy.la/api/v2/productCustomer
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista precios acordados por cliente

GET
/api/v2/productCustomer{?enabled,start,end,page,max,order,sort,filterWithDate,includeItems}

Enlista todos los precios de productos acordados por cliente

Parámetros URI
enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOpcional

Fecha a usar para filtrar mobileDateCreated, dateCreated o dateDeleted. Default: mobileDateCreated

includeItems
stringOpcional

true o false. Default: true

  • GEThttps://hub.handy.la/api/v2/productCustomer
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Deshabilitar precios acordados por cliente

DELETE
/api/v2/productCustomer

Deshabilita precios acordados por cliente

Cuerpo de la solicitud
product
stringRequerido

Código de producto.

customer
stringRequerido

Código de cliente.

  • DELETEhttps://hub.handy.la/api/v2/productCustomer
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Precios acordados de un cliente en específico

GET
/api/v2/customer/{customerCode}/productCustomer{?start,end,page,max,order,sort}

Enlista todos los precios acordados de un cliente en específico.

Parámetros URI
customerCode
stringRequerido

Código del cliente.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/productCustomer
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Precios acordados por cliente de un producto en específico

GET
/api/v2/product/{productCode}/productCustomer{?start,end,page,max,order,sort}

Enlista todos los precios acordados por cliente de un producto en específico.

Parámetros URI
productCode
stringRequerido

Código del producto.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/product/productCode/productCustomer
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Usuariosen Acciones primarias

Crear usuario

POST
/api/v2/user
Cuerpo de la solicitud
role
numberRequerido

Identificador de rol.

password
stringRequerido

Contraseña (tamaño límite 128 caracteres).

zone
numberRequerido

Identificador de Zona.

name
stringRequerido

Nombre.

email
stringRequerido

Correo electrónico.

comments
stringOpcional

Comentarios.

timezone
stringOpcional

Zona horaria.

latitude
numberOpcional

Latitud.

pictureUrl
stringOpcional

Url de foto.

extras
stringOpcional

Extras.

locale
stringOpcional

Lugar del usuario.

phoneNumberCountryCode
stringOpcional

Código telefónico del pais del usuario.

phoneNumber
stringOpcional

Número telefónico.

sendPriceComplianceRecap
booleanOpcional

Si desea enviar el resumen de cumplimiento de precios.

userType
numberOpcional

Identificador del tipo de usuario.

longitude
numberOpcional

Longitud.

username
stringOpcional

Nombre de usuario.

  • POSThttps://hub.handy.la/api/v2/user
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de usuarios

GET
/api/v2/user{?enabled,start,end,page,max,order,sort,filterWithDate,role,userType}

Enlista todos los usuarios

Parámetros URI
enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

role
stringOpcional

Identificador de role.

userType
stringOpcional

Identificador de tipo de usuario.

filterWithDate
stringOpcional

Fecha a usar para filtrar mobileDateCreated, dateCreated o dateDeleted. Default: mobileDateCreated

  • GEThttps://hub.handy.la/api/v2/user
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener un usuario

GET
/api/v2/user/{id}
Parámetros URI
id
stringRequerido

Identificador del usuario.

  • GEThttps://hub.handy.la/api/v2/user/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Actualizar usuario

PUT
/api/v2/user/{id}
Parámetros URI
id
stringRequerido

Identificador del usuario.

Cuerpo de la solicitud
role
numberRequerido

Identificador de rol.

password
stringRequerido

Contraseña (tamaño límite 128 caracteres).

zone
numberRequerido

Identificador de Zona.

name
stringRequerido

Nombre.

email
stringRequerido

Correo electrónico.

comments
stringOpcional

Comentarios.

timezone
stringOpcional

Zona horaria.

latitude
numberOpcional

Latitud.

pictureUrl
stringOpcional

Url de foto.

extras
stringOpcional

Extras.

locale
stringOpcional

Lugar del usuario.

phoneNumberCountryCode
stringOpcional

Código telefónico del pais del usuario.

phoneNumber
stringOpcional

Número telefónico.

sendPriceComplianceRecap
booleanOpcional

Si desea enviar el resumen de cumplimiento de precios.

userType
numberOpcional

Identificador del tipo de usuario.

longitude
numberOpcional

Longitud.

username
stringOpcional

Nombre de usuario.

  • PUThttps://hub.handy.la/api/v2/user/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Deshabilitar usuario

DELETE
/api/v2/user/{id}

Deshabilita usuario

Parámetros URI
id
stringRequerido

Identificador del usuario.

  • DELETEhttps://hub.handy.la/api/v2/user/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Buscar un usuario

GET
/api/v2/user/search?{username}

Busca un usuario con su nombre de usuario (Correo electrónico).

Parámetros URI
username
stringRequerido

Correo electrónico del usuario.

  • GEThttps://hub.handy.la/api/v2/user/search?username
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de pedidos de un usuario

GET
/api/v2/user/{userId}/salesOrder{?enabled,start,end,page,max,order,sort,exported,billable,billed,salesType,filterWithDate}

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

Parámetros URI
userId
stringRequerido

Identificador de usuario

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

exported
stringOpcional

true o false.

billable
stringOpcional

Indica si el cliente requiere factura. true ò false.

billed
stringOpcional

true o false.

  • GEThttps://hub.handy.la/api/v2/user/userId/salesOrder
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Crear ruta

POST
/api/v2/user/{userId}/route{?prettyMessages}

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í.

Parámetros URI
userId
stringRequerido

Identificador de usuario.

prettyMessages
stringOpcional

Incluye el código del artículo con el error y un mensaje claro.
true o false. Default: false

Cuerpo de la solicitud
salesOrders
array[object]Requerido

Lista de pedidos para repartir

salesOrderId
numberRequerido

Identificador de pedido

items
array[object]Requerido

Lista de artículos

quantity
numberRequerido

Cantidad

salesOrderItemId
numberRequerido

Identificador del artículo del pedido

products
array[object]Requerido

Lista de productos para vender (además de los de los pedidos)

product
stringRequerido

Código de producto

quantity
numberRequerido

Cantidad

dateForDelivery
stringOpcional

Fecha de entrega

comments
stringOpcional

Comentarios

initialAmount
numberOpcional

Monto inicial

  • POSThttps://hub.handy.la/api/v2/user/userId/route
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de rutas

GET
/api/v2/route{?start,end,page,max,order,sort}

Enlista todas las rutas

Parámetros URI
start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/route
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Ruta abierta actual

GET
/api/v2/user/{userId}/route/current

Obtiene la ruta abierta actual de un usuario en específico.

Parámetros URI
userId
stringRequerido

Identificador de usuario.

  • GEThttps://hub.handy.la/api/v2/user/userId/route/current
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Recargar ruta

POST
/api/v2/user/{userId}/route/recharge{?prettyMessages}

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í.

Parámetros URI
userId
stringRequerido

Identificador de usuario.

prettyMessages
stringOpcional

Incluye el código del artículo con el error y un mensaje claro.
true o false. Default: false

Cuerpo de la solicitud
items
array[object]Requerido

Lista de artículos

product
stringRequerido

Código de producto

quantity
numberRequerido

Cantidad

  • POSThttps://hub.handy.la/api/v2/user/userId/route/recharge
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de pedidos disponibles

GET
/api/v2/user/{userId}/route/salesOrders{?start,end,page,max}

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

Parámetros URI
userId
stringRequerido

Identificador de usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

  • GEThttps://hub.handy.la/api/v2/user/userId/route/salesOrders
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de entregas asignadas al usuario

GET
/api/v2/user/{userId}/deliveries{?start,end,page,max}

Enlista todos las entregas asignadas al usuario dadas las fechas

Parámetros URI
userId
stringRequerido

Identificador de usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

  • GEThttps://hub.handy.la/api/v2/user/userId/deliveries
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Visitas programadas de un usuario

GET
/api/v2/user/{userId}/calendarEvent{?start,end,page,max,order,sort}

Enlista todos los pedidos de un usuario.

Parámetros URI
userId
stringRequerido

Identificador del usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/user/userId/calendarEvent
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Elimina visitas programadas de un usuario

DELETE
/api/v2/user/{userId}/calendarEvent{?start,end}

Elimina las visitas programadas en un rango de fechas de un usuario en específico.

Parámetros URI
userId
stringRequerido

Identificador del usuario.

start
stringRequerido

Fecha inicio dd/MM/aaaa HH:mm:ss.

end
stringRequerido

Fecha fin dd/MM/aaaa HH:mm:ss.

  • DELETEhttps://hub.handy.la/api/v2/user/userId/calendarEvent
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Respuestas a formularios de un usuario

GET
/api/v2/user/{userId}/formResponse{?start,end,page,max,order,sort}

Enlista todas las respuestas a formularios de un usuario.

Parámetros URI
userId
stringRequerido

Identificador del usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/user/userId/formResponse
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de pagos de un usuario

GET
/api/v2/user/{userId}/paymentLog{?enabled,start,end,page,max,order,sort}

Enlista todas los pagos de un usuario.

Parámetros URI
userId
stringRequerido

Identificador del usuario.

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/user/userId/paymentLog
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de visitas de un usuario

GET
/api/v2/user/{userId}/visit{?start,end,page,max,order,sort}

Enlista todas las visitas de un usuario.

Parámetros URI
userId
stringRequerido

Identificador del usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/user/userId/visit
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Visitas programadasen Acciones primarias

Programar visita

POST
/api/v2/calendarEvent
Cuerpo de la solicitud
eventEnd
stringRequerido

Fecha de termino dd/MM/aaaa HH:mm:ss.

eventStart
stringRequerido

Fecha de inicio dd/MM/aaaa HH:mm:ss.

user
numberRequerido

Identificador de usuario.

customer
stringRequerido

Código de cliente.

recurrence
stringOpcional

Recurrencia.

comment
stringOpcional

Comentario.

salesForecast
numberOpcional

Pronostico de venta.

  • POSThttps://hub.handy.la/api/v2/calendarEvent
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de visitas programadas

GET
/api/v2/calendarEvent{?start,end,page,max,order,sort,filterWithDate}

Enlista todas las visitas programadas.

Parámetros URI
start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOpcional

Fecha a usar para filtrar mobileDateCreated, dateCreated o dateDeleted. Default: mobileDateCreated

  • GEThttps://hub.handy.la/api/v2/calendarEvent
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Elimina visitas programadas

DELETE
/api/v2/calendarEvent{?start,end}

Elimina las visitas programadas de un rango de fechas.

Parámetros URI
start
stringRequerido

Fecha inicio dd/MM/aaaa HH:mm:ss.

end
stringRequerido

Fecha fin dd/MM/aaaa HH:mm:ss.

  • DELETEhttps://hub.handy.la/api/v2/calendarEvent
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener una visita programada

GET
/api/v2/calendarEvent/{id}
Parámetros URI
id
stringRequerido

Identificador de la visita.

  • GEThttps://hub.handy.la/api/v2/calendarEvent/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Visitas programadas de un cliente

GET
/api/v2/customer/{customerCode}/calendarEvent{?start,end,page,max,order,sort}

Enlista todos los pedidos de un cliente.

Parámetros URI
customerCode
stringRequerido

código del cliente.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/calendarEvent
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Visitas programadas de un usuario

GET
/api/v2/user/{userId}/calendarEvent{?start,end,page,max,order,sort}

Enlista todos los pedidos de un usuario.

Parámetros URI
userId
stringRequerido

Identificador del usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/user/userId/calendarEvent
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Elimina visitas programadas de un usuario

DELETE
/api/v2/user/{userId}/calendarEvent{?start,end}

Elimina las visitas programadas en un rango de fechas de un usuario en específico.

Parámetros URI
userId
stringRequerido

Identificador del usuario.

start
stringRequerido

Fecha inicio dd/MM/aaaa HH:mm:ss.

end
stringRequerido

Fecha fin dd/MM/aaaa HH:mm:ss.

  • DELETEhttps://hub.handy.la/api/v2/user/userId/calendarEvent
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Respuestas a formulariosen Acciones primarias

Lista de respuestas a formularios

GET
/api/v2/formResponse{?start,end,page,max,order,sort,filterWithDate,formId}

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).

Parámetros URI
start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

formId
stringOpcional

ID de formulario para filtrar. Ejemplo /formResponse?formId=1

filterWithDate
stringOpcional

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
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener una respuesta a formulario

GET
/api/v2/formResponse/{id}
Parámetros URI
id
stringRequerido

Identificador de la respuesta a formulario.

  • GEThttps://hub.handy.la/api/v2/formResponse/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Respuestas a formularios de un cliente

GET
/api/v2/customer/{customerCode}/formResponse{?enabled,start,end,page,max,order,sort}

Enlista todos las respuestas a formularios de un cliente.

Parámetros URI
customerCode
stringRequerido

código del cliente.

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/formResponse
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Respuestas a formularios de un usuario

GET
/api/v2/user/{userId}/formResponse{?start,end,page,max,order,sort}

Enlista todas las respuestas a formularios de un usuario.

Parámetros URI
userId
stringRequerido

Identificador del usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/user/userId/formResponse
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Ubicación de usuariosen Acciones primarias

Historial de ubicaciones

GET
/api/v2/user/{userId}/locationHistory{?start,end,page,max}

Enlista todas las ubicaciones de un usuario.

Parámetros URI
userId
stringRequerido

Identificador del usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

  • GEThttps://hub.handy.la/api/v2/user/userId/locationHistory
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Notificacionesen Acciones primarias

Enviar una notificación

POST
/api/v2/notification/push
Cuerpo de la solicitud
salesOrderId
stringRequerido

Identificador de pedido.

message
stringRequerido

Mensaje.

type
stringRequerido

tipo.

  • POSThttps://hub.handy.la/api/v2/notification/push
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Pagosen Acciones primarias

Lista de pagos

GET
/api/v2/paymentLog{?enabled,start,end,page,max,order,sort,filterWithDate}

Enlista todos los pagos.

Parámetros URI
enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOpcional

Fecha a usar para filtrar mobileDateCreated, dateCreated o dateDeleted. Default: mobileDateCreated

  • GEThttps://hub.handy.la/api/v2/paymentLog
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener un pago

GET
/api/v2/paymentLog/{id}
Parámetros URI
id
stringRequerido

Identificador del pago.

  • GEThttps://hub.handy.la/api/v2/paymentLog/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de pagos de un cliente

GET
/api/v2/customer/{customerCode}/paymentLog{?enabled,start,end,page,max,order,sort}

Enlista todos los pagos de un cliente.

Parámetros URI
customerCode
stringRequerido

código del cliente.

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/paymentLog
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de pagos de un usuario

GET
/api/v2/user/{userId}/paymentLog{?enabled,start,end,page,max,order,sort}

Enlista todas los pagos de un usuario.

Parámetros URI
userId
stringRequerido

Identificador del usuario.

enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/user/userId/paymentLog
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Metas de ventasen Acciones primarias

Crear meta de venta

POST
/api/v2/salesGoal
Cuerpo de la solicitud
goalAmount
numberRequerido

Monto de meta.

periodicity
stringRequerido

Periodicidad.

user
numberRequerido

Identificador de usuario.

startDate
stringRequerido

Fecha de inicio. yyyy-MM-dd

  • POSThttps://hub.handy.la/api/v2/salesGoal
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de metas de venta

GET
/api/v2/salesGoal{?page,max,order,sort}

Enlista todas las metas de venta.

Parámetros URI
page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/salesGoal
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener una meta de venta

GET
/api/v2/salesGoal/{id}
Parámetros URI
id
stringRequerido

Identificador de meta.

  • GEThttps://hub.handy.la/api/v2/salesGoal/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Actualizar meta de venta

PUT
/api/v2/salesGoal/{id}
Parámetros URI
id
stringRequerido

Identificador de la meta.

Cuerpo de la solicitud
goalAmount
numberRequerido

Monto de meta.

periodicity
stringRequerido

Periodicidad.

user
numberRequerido

Identificador de usuario.

startDate
stringRequerido

Fecha de inicio. yyyy-MM-dd

  • PUThttps://hub.handy.la/api/v2/salesGoal/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Elimina meta de venta

DELETE
/api/v2/salesGoal/{id}

Elimina meta de venta

Parámetros URI
id
stringRequerido

Identificador de meta de venta.

  • DELETEhttps://hub.handy.la/api/v2/salesGoal/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Visitasen Acciones primarias

Crear una visita

POST
/api/v2/visit
Cuerpo de la solicitud
result
numberRequerido

Identificador del resultado de la visita.

createdBy
numberRequerido

Identificador del usuario.

start
stringRequerido

Fecha de inicio dd/MM/aaaa HH:mm:ss.

end
stringRequerido

Fecha de termino dd/MM/aaaa HH:mm:ss.

customer
stringRequerido

Código de cliente.

latitude
numberOpcional

Latitude.

accuracy
numberOpcional

Precisión.

calendarEvent
numberOpcional

Identificador de visita programada.

comment
stringOpcional

Comentario.

longitude
numberOpcional

Longitud.

  • POSThttps://hub.handy.la/api/v2/visit
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de visitas

GET
/api/v2/visit{?start,end,page,max,order,sort,filterWithDate}

Enlista todas las vistas.

Parámetros URI
start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy al inicio del día

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy al final del día

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros por página. Default: 10. Máximo 100.

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: start

filterWithDate
stringOpcional

Fecha a usar para filtrar dateCreated, start o end. Default: start

  • GEThttps://hub.handy.la/api/v2/visit
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Obtener una visita

GET
/api/v2/visit/{id}
Parámetros URI
id
stringRequerido

Identificador de vista.

  • GEThttps://hub.handy.la/api/v2/visit/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de visitas de un cliente

GET
/api/v2/customer/{customerCode}/visit{?start,end,page,max,order,sort}

Enlista todas las visitas de un cliente.

Parámetros URI
customerCode
stringRequerido

código del cliente.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/customer/customerCode/visit
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Lista de visitas de un usuario

GET
/api/v2/user/{userId}/visit{?start,end,page,max,order,sort}

Enlista todas las visitas de un usuario.

Parámetros URI
userId
stringRequerido

Identificador del usuario.

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/user/userId/visit
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Categorías de clientesen Acciones secundarias

Lista de categorías de clientes

GET
/api/v2/category{?enabled,start,end,page,max,order,sort}

Enlista las categorías de clientes

Parámetros URI
enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/category
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Leer una categoría de cliente

GET
/api/v2/category/{id}
Parámetros URI
id
stringRequerido

Identificador de la categoría.

  • GEThttps://hub.handy.la/api/v2/category/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Crear una categoría de cliente

POST
/api/v2/category
Cuerpo de la solicitud
description
stringRequerido

Descripción de la categoría.

  • POSThttps://hub.handy.la/api/v2/category
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Actualizar una categoría de cliente

PUT
/api/v2/category/{id}

Actualiza una categoría que ya estaba creada

Parámetros URI
id
stringRequerido

Identificador de la categoría.

Cuerpo de la solicitud
description
stringRequerido

Descripción de la categoría.

  • PUThttps://hub.handy.la/api/v2/category/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Deshabilitar categoría de cliente

DELETE
/api/v2/category/{id}

Deshabilita la categoría (enabled=false, no es borrada para que se mantengan las referencias)

Parámetros URI
id
stringRequerido

Identificador de la categoría.

  • DELETEhttps://hub.handy.la/api/v2/category/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Categorías de productosen Acciones secundarias

Lista de categorías de producto

GET
/api/v2/productCategory{?enabled,start,end,page,max,order,sort}

Enlista las categorías de producto

Parámetros URI
enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/productCategory
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Leer una categoría de producto

GET
/api/v2/productCategory/{id}
Parámetros URI
id
stringRequerido

Identificador de la categoría.

  • GEThttps://hub.handy.la/api/v2/productCategory/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Crear una categoría de producto

POST
/api/v2/productCategory
Cuerpo de la solicitud
description
stringRequerido

Descripción de la categoría (tamaño límite 100 caracteres).

  • POSThttps://hub.handy.la/api/v2/productCategory
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Actualizar una categoría de producto

PUT
/api/v2/productCategory/{id}

Actualiza una categoría de producto que ya estaba creada

Parámetros URI
id
stringRequerido

Identificador de la categoría.

Cuerpo de la solicitud
description
stringRequerido

Descripción de la categoría (tamaño límite 100 caracteres).

  • PUThttps://hub.handy.la/api/v2/productCategory/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Deshabilitar una categoría de producto

DELETE
/api/v2/productCategory/{id}

Deshabilita la categoría (enabled=false, no es borrada para que se mantengan las referencias)

Parámetros URI
id
stringRequerido

Identificador de la categoría.

  • DELETEhttps://hub.handy.la/api/v2/productCategory/id
HTTP
Solicitud
(Cargando)
Respuesta
(Cargando)

Familias de productosen Acciones secundarias

Lista de familias de producto

GET
/api/v2/productFamily{?enabled,start,end,page,max,order,sort}

Enlista las familias de producto

Parámetros URI
enabled
stringOpcional

true o false. Default: true

start
stringOpcional

Fecha inicio dd/MM/aaaa HH:mm:ss. Default: hoy

end
stringOpcional

Fecha fin dd/MM/aaaa HH:mm:ss. Default: hoy

page
stringOpcional

Página a regresar. Default: 1

max
stringOpcional

Máximo de registros, topado a 100. Default: 10

order
stringOpcional

asc o desc. Default: asc

sort
stringOpcional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://hub.handy.la/api/v2/productFamily