Referencia de API (v2)

Updated on 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 ⭐️in Acciones primarias

Obtener un pedido

GET
/api/v2/salesOrder/{id}
URI Parameters
id
stringRequired

Identificador del pedido.

  • GEThttps://app.handy.la/api/v2/salesOrder/id
HTTP
Request
(loading)
Response
(loading)

Lista de pedidos

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

Enlistas todos los pedidos

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

exported
stringOptional

true o false.

billable
stringOptional

Indica si el cliente requiere factura. true ò false.

billed
stringOptional

true o false.

salesType
stringOptional

PRESALE o ROUTESALE.

filterWithDate
stringOptional

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

  • GEThttps://app.handy.la/api/v2/salesOrder
HTTP
Request
(loading)
Response
(loading)

Crear pedido

POST
/api/v2/salesOrder
Request Body
exported
booleanOptional

Ha sido exportado

mobileDateCreated
stringRequired

Fecha de creación en móvil (01/02/2020 11:30:00)

latitude
stringOptional

Latitud

accuracy
stringOptional

Precisión

totalSales
numberOptional

Ventas totales

type
numberOptional

Tipo

billable
booleanOptional

Indica si el cliente requiere factura. true ò false.

sellerComment
stringOptional

Comentario del vendedor

priceList
stringOptional

Código del precio de lista

billed
booleanOptional

Ha sido facturado

tookInPlace
booleanOptional

Ha sido capturado en ubicación del cliente

routeSalePaymentType
stringOptional

Solo en venta en ruta CASH o CREDIT

items
array[object]Required

Arreglo de items

product
stringRequired

Código de producto

total
numberOptional

Total

comments
stringOptional

Comentarios

quantity
numberRequired

Cantidad

originalPrice
numberOptional

Precio original

price
numberRequired

Precio

discount
numberOptional

Descuento

delivered
numberOptional

Cantidad entregada

promoIds
stringOptional

IDs de promociones

promoNames
stringOptional

Nombres de promociones

scheduledDateForDelivery
stringOptional

Fecha programada para entrega

customer
stringRequired

Código de cliente

longitude
stringOptional

Longitud

  • POSThttps://app.handy.la/api/v2/salesOrder
HTTP
Request
(loading)
Response
(loading)

Actualizar pedido

PUT
/api/v2/salesOrder/{id}

Solo se puede actualizar en atributo externalId

URI Parameters
id
stringRequired

Identificador del pedido.

Request Body
externalId
stringRequired

Identificador externo

  • PUThttps://app.handy.la/api/v2/salesOrder/id
HTTP
Request
(loading)
Response
(loading)

Eliminar pedido

DELETE
/api/v2/salesOrder/{id}
URI Parameters
id
stringRequired

Identificador del pedido.

  • DELETEhttps://app.handy.la/api/v2/salesOrder/id
HTTP
Request
(loading)
Response
(loading)

Marcar como facturado

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

Marcar un pedido como facturado.

URI Parameters
salesOrderId
stringRequired

Identificador del pedido.

  • PATCHhttps://app.handy.la/api/v2/salesOrder/salesOrderId/markAsBilled
HTTP
Request
(loading)
Response
(loading)

Marcar como exportado

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

Marcar un pedido como exportado.

URI Parameters
salesOrderId
stringRequired

Identificador del pedido.

  • PATCHhttps://app.handy.la/api/v2/salesOrder/salesOrderId/markAsExported
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
customerCode
stringRequired

código del cliente.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

exported
stringOptional

true o false.

billable
stringOptional

Indica si el cliente requiere factura. true ò false.

billed
stringOptional

true o false.

  • GEThttps://app.handy.la/api/v2/customer/customerCode/salesOrder
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
priceListCode
stringRequired

código de la lista de precios.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

exported
stringOptional

true o false.

billable
stringOptional

Indica si el cliente requiere factura. true ò false.

billed
stringOptional

true o false.

  • GEThttps://app.handy.la/api/v2/priceList/priceListCode/salesOrder
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
userId
stringRequired

Identificador de usuario

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

exported
stringOptional

true o false.

billable
stringOptional

Indica si el cliente requiere factura. true ò false.

billed
stringOptional

true o false.

  • GEThttps://app.handy.la/api/v2/user/userId/salesOrder
HTTP
Request
(loading)
Response
(loading)

Rutas ⭐️in Acciones primarias

Lista de rutas

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

Enlistas todas las rutas

URI Parameters
start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

closed
stringOptional

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

filterWithDate
stringOptional

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

includeSalesOrders
stringOptional

Trae los ids de los pedidos que pertenecen a la ruta. true o false.

  • GEThttps://app.handy.la/api/v2/user/userId/route
HTTP
Request
(loading)
Response
(loading)

Obtener una ruta

GET
/api/v2/route/{id}
URI Parameters
id
stringRequired

Identificador de la ruta.

  • GEThttps://app.handy.la/api/v2/route/id
HTTP
Request
(loading)
Response
(loading)

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.
Revise las respuestas 422 la primera no ha enviado el parámetro prettyMessages en su solicitud, la segunda sí.

URI Parameters
userId
stringRequired

Identificador de usuario.

prettyMessages
stringOptional

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

Request Body
dateForDelivery
stringOptional

Fecha de entrega

comments
stringOptional

Comentarios

initialAmount
numberOptional

Monto inicial

salesOrders
array[object]Required

Lista de pedidos

salesOrderId
numberRequired

Identificador de pedido

items
array[object]Required

Lista de artículos

quantity
numberRequired

Cantidad

salesOrderItemId
numberRequired

Identificador del artículo del pedido

products
array[object]Required

Lista de productos

product
stringRequired

Código de producto

quantity
numberRequired

Cantidad

  • POSThttps://app.handy.la/api/v2/user/userId/route
HTTP
Request
(loading)
Response
(loading)

Rutas de usuario

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

Enlista las rutas de un usuario en específico.

URI Parameters
userId
stringRequired

Identificador de usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/user/userId/route
HTTP
Request
(loading)
Response
(loading)

Ruta abierta actual de usuario

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

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

URI Parameters
userId
stringRequired

Identificador de usuario.

  • GEThttps://app.handy.la/api/v2/user/userId/route/current
HTTP
Request
(loading)
Response
(loading)

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.
Revise las respuestas 422 la primera no ha enviado el parámetro prettyMessages en su solicitud, la segunda sí.

URI Parameters
userId
stringRequired

Identificador de usuario.

prettyMessages
stringOptional

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

Request Body
items
array[object]Required

Lista de artículos

product
stringRequired

Código de producto

quantity
numberRequired

Cantidad

  • POSThttps://app.handy.la/api/v2/user/userId/route/recharge
HTTP
Request
(loading)
Response
(loading)

Lista de pedidos disponibles

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

Enlistas todos los pedidos disponibles para crear una ruta

URI Parameters
userId
stringRequired

Identificador de usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

  • GEThttps://app.handy.la/api/v2/user/userId/route/salesOrders
HTTP
Request
(loading)
Response
(loading)

Lista de entregas asignadas al usuario

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

Enlistas todos las entregas asignadas al usuario dadas las fechas

URI Parameters
userId
stringRequired

Identificador de usuario.

start
stringOptional

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

end
stringOptional

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

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

  • GEThttps://app.handy.la/api/v2/user/userId/deliveries
HTTP
Request
(loading)
Response
(loading)

Clientesin Acciones primarias

Crear cliente

POST
/api/v2/customer
Request Body
owner
stringOptional

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

isProspect
booleanOptional

Es prospecto true ò false.

address
stringOptional

Dirección.

code
stringRequired

Código.

comments
stringOptional

Comentarios.

city
stringOptional

Ciudad.

latitude
numberOptional

Latitud.

postalCode
stringOptional

Código postal.

description
stringRequired

Descripción.

discount
numberOptional

Descuento.

billable
booleanOptional

Indica si el cliente requiere factura. true ò false.

picturesUrls
stringOptional

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

priceList
numberOptional

Identificador de precio de lista.

phoneNumber
stringOptional

Número telefónico.

balance
numberOptional

Saldo pendiente.

zone
numberRequired

Identificador de zona

isMobile
booleanOptional

Es cliente móvil.

neighborhood
stringOptional

Colonia.

category
numberOptional

Identificador de categoría.

credit
numberOptional

Límite de crédito.

email
stringOptional

Correo electrónico.

longitude
numberOptional

Longitud.

  • POSThttps://app.handy.la/api/v2/customer
HTTP
Request
(loading)
Response
(loading)

Lista de clientes

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

Enlistas todos los clientes

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

showProspect
stringOptional

Filtra a los clientes prospetos. true ò false.

billable
stringOptional

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

filterWithDate
stringOptional

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

filter
stringOptional

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

  • GEThttps://app.handy.la/api/v2/zone/zoneId/customer
HTTP
Request
(loading)
Response
(loading)

Obtener un cliente

GET
/api/v2/customer/{customerCode}
URI Parameters
customerCode
stringRequired

Código del cliente.

  • GEThttps://app.handy.la/api/v2/customer/customerCode
HTTP
Request
(loading)
Response
(loading)

Actualizar cliente

PUT
/api/v2/customer/{customerCode}
URI Parameters
customerCode
stringRequired

Código del cliente.

Request Body
owner
stringOptional

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

isProspect
booleanOptional

Es prospecto true ò false.

address
stringOptional

Dirección.

code
stringRequired

Código.

comments
stringOptional

Comentarios.

city
stringOptional

Ciudad.

latitude
numberOptional

Latitud.

postalCode
stringOptional

Código postal.

description
stringRequired

Descripción.

discount
numberOptional

Descuento.

billable
booleanOptional

Indica si el cliente requiere factura. true ò false.

picturesUrls
stringOptional

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

priceList
numberOptional

Identificador de precio de lista.

phoneNumber
stringOptional

Número telefónico.

balance
numberOptional

Saldo pendiente.

zone
numberRequired

Identificador de zona

isMobile
booleanOptional

Es cliente móvil.

neighborhood
stringOptional

Colonia.

category
numberOptional

Identificador de categoría.

credit
numberOptional

Límite de crédito.

email
stringOptional

Correo electrónico.

longitude
numberOptional

Longitud.

  • PUThttps://app.handy.la/api/v2/customer/customerCode
HTTP
Request
(loading)
Response
(loading)

Eliminar cliente

DELETE
/api/v2/customer/{customerCode}
URI Parameters
customerCode
stringRequired

Código del cliente.

  • DELETEhttps://app.handy.la/api/v2/customer/customerCode
HTTP
Request
(loading)
Response
(loading)

Clientes de una zona

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

Enlistas todos los clientes dada una zona

URI Parameters
zoneId
stringRequired

Identificador de zona.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

showProspect
stringOptional

Filtra a los clientes prospetos. true ò false.

billable
stringOptional

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

  • GEThttps://app.handy.la/api/v2/zone/zoneId/customer
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
customerCode
stringRequired

código del cliente.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

exported
stringOptional

true o false.

billable
stringOptional

Indica si el cliente requiere factura. true ò false.

billed
stringOptional

true o false.

  • GEThttps://app.handy.la/api/v2/customer/customerCode/salesOrder
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
customerCode
stringRequired

Código del cliente.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/customer/customerCode/productCustomer
HTTP
Request
(loading)
Response
(loading)

Visitas programadas de un cliente

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

Enlista todos los pedidos de un cliente.

URI Parameters
customerCode
stringRequired

código del cliente.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/customer/customerCode/calendarEvent
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
customerCode
stringRequired

código del cliente.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/customer/customerCode/formResponse
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
customerCode
stringRequired

código del cliente.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/customer/customerCode/paymentLog
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
customerCode
stringRequired

código del cliente.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/customer/customerCode/visit
HTTP
Request
(loading)
Response
(loading)

Productosin Acciones primarias

Crear producto

POST
/api/v2/product
Request Body
code
stringRequired

Código.

quantity
numberOptional

Cantidad.

boostSales
booleanOptional

Promover las ventas de este producto. true o false

price
numberOptional

Precio.

description
stringOptional

Descripción.

boostSalesDescription
stringOptional

Descripción para promover las ventas de este producto.

category
numberOptional

Identificador de categoría.

family
numberOptional

Identificador de familia.

  • POSThttps://app.handy.la/api/v2/product
HTTP
Request
(loading)
Response
(loading)

Lista de productos

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

Enlistas todos los productos

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOptional

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

filter
stringOptional

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

  • GEThttps://app.handy.la/api/v2/product
HTTP
Request
(loading)
Response
(loading)

Obtener un producto

GET
/api/v2/product/{productCode}
URI Parameters
productCode
stringRequired

Código del producto.

  • GEThttps://app.handy.la/api/v2/product/productCode
HTTP
Request
(loading)
Response
(loading)

Actualizar producto

PUT
/api/v2/product/{productCode}
URI Parameters
productCode
stringRequired

Código del producto.

Request Body
code
stringRequired

Código.

quantity
numberOptional

Cantidad.

boostSales
booleanOptional

Promover las ventas de este producto. true o false

price
numberOptional

Precio.

description
stringOptional

Descripción.

boostSalesDescription
stringOptional

Descripción para promover las ventas de este producto.

category
numberOptional

Identificador de categoría.

family
numberOptional

Identificador de familia.

  • PUThttps://app.handy.la/api/v2/product/productCode
HTTP
Request
(loading)
Response
(loading)

Eliminar producto

DELETE
/api/v2/product/{productCode}
URI Parameters
productCode
stringRequired

Código del producto.

  • DELETEhttps://app.handy.la/api/v2/product/productCode
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
productCode
stringRequired

Código del producto.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/product/productCode/productCustomer
HTTP
Request
(loading)
Response
(loading)

Listas de precios ⭐️in 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.
Revise las respuestas 422 la primera no ha enviado el parámetro prettyMessages en su solicitud, la segunda sí.

URI Parameters
prettyMessages
stringOptional

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

Request Body
code
stringRequired

Código.

name
stringRequired

nombre de lista.

items
array[object]Required

Lista de artículos

product
stringRequired

Código de producto

price
numberRequired

Precio

  • POSThttps://app.handy.la/api/v2/priceList
HTTP
Request
(loading)
Response
(loading)

Enlistar lista de precios

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

Enlistas todas las listas de precios

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOptional

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

  • GEThttps://app.handy.la/api/v2/priceList
HTTP
Request
(loading)
Response
(loading)

Obtener un precio de lista

GET
/api/v2/priceList/{priceListCode}
URI Parameters
priceListCode
stringRequired

Código de la lista de precios.

  • GEThttps://app.handy.la/api/v2/priceList/priceListCode
HTTP
Request
(loading)
Response
(loading)

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.
Revise las respuestas 422 la primera no ha enviado el parámetro prettyMessages en su solicitud, la segunda sí.

URI Parameters
priceListCode
stringRequired

Código de la lista de precios.

prettyMessages
stringOptional

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

Request Body
code
stringRequired

Código.

name
stringRequired

nombre de lista.

items
array[object]Required

Lista de artículos

product
stringRequired

Código de producto

price
numberRequired

Precio

  • PUThttps://app.handy.la/api/v2/priceList/priceListCode
HTTP
Request
(loading)
Response
(loading)

Eliminar lista de precios

DELETE
/api/v2/priceList/{priceListCode}
URI Parameters
priceListCode
stringRequired

Código de la lista de precios.

  • DELETEhttps://app.handy.la/api/v2/priceList/priceListCode
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
priceListCode
stringRequired

código de la lista de precios.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

exported
stringOptional

true o false.

billable
stringOptional

Indica si el cliente requiere factura. true ò false.

billed
stringOptional

true o false.

  • GEThttps://app.handy.la/api/v2/priceList/priceListCode/salesOrder
HTTP
Request
(loading)
Response
(loading)

Precios por clientein Acciones primarias

Crear precios acordados por cliente

POST
/api/v2/productCustomer
Request Body
product
stringRequired

Código de producto.

price
numberRequired

Precio.

customer
stringRequired

Código de cliente.

  • POSThttps://app.handy.la/api/v2/productCustomer
HTTP
Request
(loading)
Response
(loading)

Lista precios acordados por cliente

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

Enlistas todos los precios de productos acordados por cliente

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOptional

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

  • GEThttps://app.handy.la/api/v2/productCustomer
HTTP
Request
(loading)
Response
(loading)

Deshabilitar precios acordados por cliente

DELETE
/api/v2/productCustomer

Deshabilita precios acordados por cliente

Request Body
product
stringRequired

Código de producto.

customer
stringRequired

Código de cliente.

  • DELETEhttps://app.handy.la/api/v2/productCustomer
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
customerCode
stringRequired

Código del cliente.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/customer/customerCode/productCustomer
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
productCode
stringRequired

Código del producto.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/product/productCode/productCustomer
HTTP
Request
(loading)
Response
(loading)

Usuariosin Acciones primarias

Crear usuario

POST
/api/v2/user
Request Body
comments
stringOptional

Comentarios.

role
numberRequired

Identificador de rol.

timezone
stringOptional

Zona horaria.

latitude
numberOptional

Latitud.

pictureUrl
stringOptional

Url de foto.

extras
stringOptional

Extras.

locale
stringOptional

Lugar del usuario.

phoneNumberCountryCode
stringOptional

Código telefónico del pais del usuario.

password
stringRequired

Contraseña.

phoneNumber
stringOptional

Número telefónico.

zone
numberRequired

Identificador de Zona.

name
stringRequired

Nombre.

sendPriceComplianceRecap
booleanOptional

Si desea enviar el resumen de cumplimiento de precios.

userType
numberOptional

Identificador del tipo de usuario.

email
stringRequired

Correo electrónico.

longitude
numberOptional

Longitud.

username
stringOptional

Nombre de usuario.

  • POSThttps://app.handy.la/api/v2/user
HTTP
Request
(loading)
Response
(loading)

Lista de usuarios

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

Enlistas todos los usuarios

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

role
stringOptional

Identificador de role.

userType
stringOptional

Identificador de tipo de usuario.

filterWithDate
stringOptional

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

  • GEThttps://app.handy.la/api/v2/user
HTTP
Request
(loading)
Response
(loading)

Obtener un usuario

GET
/api/v2/user/{id}
URI Parameters
id
stringRequired

Identificador del usuario.

  • GEThttps://app.handy.la/api/v2/user/id
HTTP
Request
(loading)
Response
(loading)

Actualizar usuario

PUT
/api/v2/user/{id}
URI Parameters
id
stringRequired

Identificador del usuario.

Request Body
comments
stringOptional

Comentarios.

role
numberRequired

Identificador de rol.

timezone
stringOptional

Zona horaria.

latitude
numberOptional

Latitud.

pictureUrl
stringOptional

Url de foto.

extras
stringOptional

Extras.

locale
stringOptional

Lugar del usuario.

phoneNumberCountryCode
stringOptional

Código telefónico del pais del usuario.

password
stringRequired

Contraseña.

phoneNumber
stringOptional

Número telefónico.

zone
numberRequired

Identificador de Zona.

name
stringRequired

Nombre.

sendPriceComplianceRecap
booleanOptional

Si desea enviar el resumen de cumplimiento de precios.

userType
numberOptional

Identificador del tipo de usuario.

email
stringRequired

Correo electrónico.

longitude
numberOptional

Longitud.

username
stringOptional

Nombre de usuario.

  • PUThttps://app.handy.la/api/v2/user/id
HTTP
Request
(loading)
Response
(loading)

Deshabilitar usuario

DELETE
/api/v2/user/{id}

Deshabilita usuario

URI Parameters
id
stringRequired

Identificador del usuario.

  • DELETEhttps://app.handy.la/api/v2/user/id
HTTP
Request
(loading)
Response
(loading)

Pedidos disponibles de un repartidor

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

Muestra los pedidos disponibles para una ruta de entrega abierta de un repartidor

URI Parameters
userId
stringRequired

Identificador del usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

  • GEThttps://app.handy.la/api/v2/user/userId/deliverySalesOrders
HTTP
Request
(loading)
Response
(loading)

Buscar un usuario

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

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

URI Parameters
username
stringRequired

Correo electrónico del usuario.

  • GEThttps://app.handy.la/api/v2/user/search?username
HTTP
Request
(loading)
Response
(loading)

Lista de usuarios de una zona en especifico

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

Enlistas todos los clientes dada una zona

URI Parameters
zoneId
stringRequired

Identificador de zona.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/zone/zoneId/user
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
userId
stringRequired

Identificador de usuario

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

exported
stringOptional

true o false.

billable
stringOptional

Indica si el cliente requiere factura. true ò false.

billed
stringOptional

true o false.

  • GEThttps://app.handy.la/api/v2/user/userId/salesOrder
HTTP
Request
(loading)
Response
(loading)

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.
Revise las respuestas 422 la primera no ha enviado el parámetro prettyMessages en su solicitud, la segunda sí.

URI Parameters
userId
stringRequired

Identificador de usuario.

prettyMessages
stringOptional

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

Request Body
dateForDelivery
stringOptional

Fecha de entrega

comments
stringOptional

Comentarios

initialAmount
numberOptional

Monto inicial

salesOrders
array[object]Required

Lista de pedidos

salesOrderId
numberRequired

Identificador de pedido

items
array[object]Required

Lista de artículos

quantity
numberRequired

Cantidad

salesOrderItemId
numberRequired

Identificador del artículo del pedido

products
array[object]Required

Lista de productos

product
stringRequired

Código de producto

quantity
numberRequired

Cantidad

  • POSThttps://app.handy.la/api/v2/user/userId/route
HTTP
Request
(loading)
Response
(loading)

Lista de rutas

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

Enlista las rutas de un usuario en específico.

URI Parameters
userId
stringRequired

Identificador de usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/user/userId/route
HTTP
Request
(loading)
Response
(loading)

Ruta abierta actual

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

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

URI Parameters
userId
stringRequired

Identificador de usuario.

  • GEThttps://app.handy.la/api/v2/user/userId/route/current
HTTP
Request
(loading)
Response
(loading)

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.
Revise las respuestas 422 la primera no ha enviado el parámetro prettyMessages en su solicitud, la segunda sí.

URI Parameters
userId
stringRequired

Identificador de usuario.

prettyMessages
stringOptional

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

Request Body
items
array[object]Required

Lista de artículos

product
stringRequired

Código de producto

quantity
numberRequired

Cantidad

  • POSThttps://app.handy.la/api/v2/user/userId/route/recharge
HTTP
Request
(loading)
Response
(loading)

Lista de pedidos disponibles

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

Enlistas todos los pedidos disponibles para crear una ruta

URI Parameters
userId
stringRequired

Identificador de usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

  • GEThttps://app.handy.la/api/v2/user/userId/route/salesOrders
HTTP
Request
(loading)
Response
(loading)

Lista de entregas asignadas al usuario

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

Enlistas todos las entregas asignadas al usuario dadas las fechas

URI Parameters
userId
stringRequired

Identificador de usuario.

start
stringOptional

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

end
stringOptional

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

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

  • GEThttps://app.handy.la/api/v2/user/userId/deliveries
HTTP
Request
(loading)
Response
(loading)

Visitas programadas de un usuario

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

Enlista todos los pedidos de un usuario.

URI Parameters
userId
stringRequired

Identificador del usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/user/userId/calendarEvent
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
userId
stringRequired

Identificador del usuario.

start
stringRequired

Fecha inicio.

end
stringRequired

Fecha fin.

  • DELETEhttps://app.handy.la/api/v2/user/userId/calendarEvent
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
userId
stringRequired

Identificador del usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/user/userId/formResponse
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
userId
stringRequired

Identificador del usuario.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/user/userId/paymentLog
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
userId
stringRequired

Identificador del usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/user/userId/visit
HTTP
Request
(loading)
Response
(loading)

Visitas programadasin Acciones primarias

Programar visita

POST
/api/v2/calendarEvent
Request Body
recurrence
stringOptional

Recurrencia.

eventEnd
stringRequired

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

comment
stringOptional

Comentario.

eventStart
stringRequired

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

salesForecast
numberOptional

Pronostico de venta.

user
numberRequired

Identificador de usuario.

customer
stringRequired

Código de cliente.

  • POSThttps://app.handy.la/api/v2/calendarEvent
HTTP
Request
(loading)
Response
(loading)

Lista de visitas programadas

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

Enlista todas las visitas programadas.

URI Parameters
start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOptional

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

  • GEThttps://app.handy.la/api/v2/calendarEvent
HTTP
Request
(loading)
Response
(loading)

Elimina visitas programadas

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

Elimina las visitas programadas de un rango de fechas.

URI Parameters
start
stringRequired

Fecha inicio.

end
stringRequired

Fecha fin.

  • DELETEhttps://app.handy.la/api/v2/calendarEvent
HTTP
Request
(loading)
Response
(loading)

Obtener una visita programada

GET
/api/v2/calendarEvent/{id}
URI Parameters
id
stringRequired

Identificador de la visita.

  • GEThttps://app.handy.la/api/v2/calendarEvent/id
HTTP
Request
(loading)
Response
(loading)

Visitas programadas de un cliente

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

Enlista todos los pedidos de un cliente.

URI Parameters
customerCode
stringRequired

código del cliente.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/customer/customerCode/calendarEvent
HTTP
Request
(loading)
Response
(loading)

Visitas programadas de un usuario

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

Enlista todos los pedidos de un usuario.

URI Parameters
userId
stringRequired

Identificador del usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/user/userId/calendarEvent
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
userId
stringRequired

Identificador del usuario.

start
stringRequired

Fecha inicio.

end
stringRequired

Fecha fin.

  • DELETEhttps://app.handy.la/api/v2/user/userId/calendarEvent
HTTP
Request
(loading)
Response
(loading)

Respuestas a formulariosin Acciones primarias

Lista de respuestas a formularios

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

Enlista todas las respuestas a formularios.

URI Parameters
start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOptional

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

  • GEThttps://app.handy.la/api/v2/formResponse
HTTP
Request
(loading)
Response
(loading)

Obtener una respuesta a formulario

GET
/api/v2/formResponse/{id}
URI Parameters
id
stringRequired

Identificador de la respuesta a formulario.

  • GEThttps://app.handy.la/api/v2/formResponse/id
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
customerCode
stringRequired

código del cliente.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/customer/customerCode/formResponse
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
userId
stringRequired

Identificador del usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/user/userId/formResponse
HTTP
Request
(loading)
Response
(loading)

Ubicación de usuariosin Acciones primarias

Historial de ubicaciones

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

Enlista todas las ubicaciones de un usuario.

URI Parameters
userId
stringRequired

Identificador del usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

  • GEThttps://app.handy.la/api/v2/user/userId/locationHistory
HTTP
Request
(loading)
Response
(loading)

Notificacionesin Acciones primarias

Enviar una notificación

POST
/api/v2/notification/push
Request Body
salesOrderId
stringRequired

Identificador de pedido.

message
stringRequired

Mensaje.

type
stringRequired

tipo.

  • POSThttps://app.handy.la/api/v2/notification/push
HTTP
Request
(loading)
Response
(loading)

Pagosin Acciones primarias

Lista de pagos

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

Enlista todos los pagos.

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOptional

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

  • GEThttps://app.handy.la/api/v2/paymentLog
HTTP
Request
(loading)
Response
(loading)

Obtener un pago

GET
/api/v2/paymentLog/{id}
URI Parameters
id
stringRequired

Identificador del pago.

  • GEThttps://app.handy.la/api/v2/paymentLog/id
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
customerCode
stringRequired

código del cliente.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/customer/customerCode/paymentLog
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
userId
stringRequired

Identificador del usuario.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/user/userId/paymentLog
HTTP
Request
(loading)
Response
(loading)

Metas de ventasin Acciones primarias

Crear meta de venta

POST
/api/v2/salesGoal
Request Body
goalAmount
numberRequired

Monto de meta.

periodicity
stringRequired

Periodicidad.

user
numberRequired

Identificador de usuario.

startDate
stringRequired

Fecha de inicio. yyyy-MM-dd

  • POSThttps://app.handy.la/api/v2/salesGoal
HTTP
Request
(loading)
Response
(loading)

Lista de metas de venta

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

Enlistas todas las metas de venta.

URI Parameters
page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/salesGoal
HTTP
Request
(loading)
Response
(loading)

Obtener una meta de venta

GET
/api/v2/salesGoal/{id}
URI Parameters
id
stringRequired

Identificador de meta.

  • GEThttps://app.handy.la/api/v2/salesGoal/id
HTTP
Request
(loading)
Response
(loading)

Actualizar meta de venta

PUT
/api/v2/salesGoal/{id}
URI Parameters
id
stringRequired

Identificador de la meta.

Request Body
goalAmount
numberRequired

Monto de meta.

periodicity
stringRequired

Periodicidad.

user
numberRequired

Identificador de usuario.

startDate
stringRequired

Fecha de inicio. yyyy-MM-dd

  • PUThttps://app.handy.la/api/v2/salesGoal/id
HTTP
Request
(loading)
Response
(loading)

Elimina meta de venta

DELETE
/api/v2/salesGoal/{id}

Elimina meta de venta

URI Parameters
id
stringRequired

Identificador de meta de venta.

  • DELETEhttps://app.handy.la/api/v2/salesGoal/id
HTTP
Request
(loading)
Response
(loading)

Visitasin Acciones primarias

Crear una visita

POST
/api/v2/visit
Request Body
result
numberRequired

Identificador del resultado de la visita.

createdBy
numberRequired

Identificador del usuario.

latitude
numberOptional

Latitude.

start
stringRequired

Fecha de inicio.

accuracy
numberOptional

Precisión.

calendarEvent
numberOptional

Identificador de visita programada.

comment
stringOptional

Comentario.

end
stringRequired

Fecha de termino.

customer
stringRequired

Código de cliente.

longitude
numberOptional

Longitud.

  • POSThttps://app.handy.la/api/v2/visit
HTTP
Request
(loading)
Response
(loading)

Lista de visitas

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

Enlista todas las vistas.

URI Parameters
start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

filterWithDate
stringOptional

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

  • GEThttps://app.handy.la/api/v2/visit
HTTP
Request
(loading)
Response
(loading)

Obtener una visita

GET
/api/v2/visit/{id}
URI Parameters
id
stringRequired

Identificador de vista.

  • GEThttps://app.handy.la/api/v2/visit/id
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
customerCode
stringRequired

código del cliente.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/customer/customerCode/visit
HTTP
Request
(loading)
Response
(loading)

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.

URI Parameters
userId
stringRequired

Identificador del usuario.

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/user/userId/visit
HTTP
Request
(loading)
Response
(loading)

Categorías de clientesin 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

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/category
HTTP
Request
(loading)
Response
(loading)

Leer una categoría de cliente

GET
/api/v2/category/{id}
URI Parameters
id
stringRequired

Identificador de la categoría.

  • GEThttps://app.handy.la/api/v2/category/id
HTTP
Request
(loading)
Response
(loading)

Crear una categoría de cliente

POST
/api/v2/category
Request Body
description
stringRequired

Descripción de la categoría.

  • POSThttps://app.handy.la/api/v2/category
HTTP
Request
(loading)
Response
(loading)

Actualizar una categoría de cliente

PUT
/api/v2/category/{id}

Actualiza una categoría que ya estaba creada

URI Parameters
id
stringRequired

Identificador de la categoría.

Request Body
description
stringRequired

Descripción de la categoría.

  • PUThttps://app.handy.la/api/v2/category/id
HTTP
Request
(loading)
Response
(loading)

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)

URI Parameters
id
stringRequired

Identificador de la categoría.

  • DELETEhttps://app.handy.la/api/v2/category/id
HTTP
Request
(loading)
Response
(loading)

Categorías de productosin 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

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/productCategory
HTTP
Request
(loading)
Response
(loading)

Leer una categoría de producto

GET
/api/v2/category/{id}
URI Parameters
id
stringRequired

Identificador de la categoría.

  • GEThttps://app.handy.la/api/v2/category/id
HTTP
Request
(loading)
Response
(loading)

Crear una categoría de producto

POST
/api/v2/productCategory
Request Body
description
stringRequired

Descripción de la categoría.

  • POSThttps://app.handy.la/api/v2/productCategory
HTTP
Request
(loading)
Response
(loading)

Actualizar una categoría de producto

PUT
/api/v2/productCategory/{id}

Actualiza una categoría de producto que ya estaba creada

URI Parameters
id
stringRequired

Identificador de la categoría.

Request Body
description
stringRequired

Descripción de la categoría.

  • PUThttps://app.handy.la/api/v2/productCategory/id
HTTP
Request
(loading)
Response
(loading)

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)

URI Parameters
id
stringRequired

Identificador de la categoría.

  • DELETEhttps://app.handy.la/api/v2/productCategory/id
HTTP
Request
(loading)
Response
(loading)

Familias de productosin Acciones secundarias

Lista de familias de producto

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

Enlista las familias de producto

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/productFamily
HTTP
Request
(loading)
Response
(loading)

Leer una familia de producto

GET
/api/v2/productFamily/{id}
URI Parameters
id
stringRequired

Identificador de la familia.

  • GEThttps://app.handy.la/api/v2/productFamily/id
HTTP
Request
(loading)
Response
(loading)

Crear una familia de producto

POST
/api/v2/productFamily
Request Body
description
stringRequired

Descripción de la familia.

  • POSThttps://app.handy.la/api/v2/productFamily
HTTP
Request
(loading)
Response
(loading)

Actualizar una familia de producto

PUT
/api/v2/productFamily/{id}

Actualiza una familia de producto que ya estaba creada

URI Parameters
id
stringRequired

Identificador de la familia.

Request Body
description
stringRequired

Descripción de la familia.

  • PUThttps://app.handy.la/api/v2/productFamily/id
HTTP
Request
(loading)
Response
(loading)

Deshabilitar una familia de producto

DELETE
/api/v2/productFamily/{id}

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

URI Parameters
id
stringRequired

Identificador de la familia.

  • DELETEhttps://app.handy.la/api/v2/productFamily/id
HTTP
Request
(loading)
Response
(loading)

Zonasin Acciones secundarias

Asignar zona a usuario

PUT
/api/v2/user/{userId}/zone/{zoneId}

Asignar una zona a un usuario. . Regresa la lista de zonas asignadas al usuario después de la operación . Si ya la tenía asignada, no cambia nada

URI Parameters
userId
stringRequired

Identificador de usuario

zoneId
stringRequired

Identificador de zona

  • PUThttps://app.handy.la/api/v2/user/userId/zone/zoneId
HTTP
Request
(loading)
Response
(loading)

Desasignar zona a usuario

DELETE
/api/v2/user/{userId}/zone/{zoneId}

Elimina la asignación de zona de un usuario. Regresa la lista de zonas asignadas al usuario después de la operación.

URI Parameters
userId
stringRequired

Identificador de usuario

zoneId
stringRequired

Identificador de zona

  • DELETEhttps://app.handy.la/api/v2/user/userId/zone/zoneId
HTTP
Request
(loading)
Response
(loading)

Crear zona

POST
/api/v2/zone

Crea una nueva zona

  • POSThttps://app.handy.la/api/v2/zone
HTTP
Request
(loading)
Response
(loading)

Actualizar zona

PUT
/api/v2/zone/{id}

Cambiar el nombre de una zona. Para deshabilitar, usa el verbo DELETE en lugar de PUT

URI Parameters
id
stringRequired

Identificador de la zona.

  • PUThttps://app.handy.la/api/v2/zone/id
HTTP
Request
(loading)
Response
(loading)

Lista de zonas

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

Enlista las zonas

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/zone
HTTP
Request
(loading)
Response
(loading)

Leer una zona

GET
/api/v2/zone/{id}

Obtener los detalles de una zona.

URI Parameters
id
stringRequired

Identificador de la zona.

  • GEThttps://app.handy.la/api/v2/zone/id
HTTP
Request
(loading)
Response
(loading)

Deshabilitar zona

DELETE
/api/v2/zone/{id}

Deshabilitar una zona. Antes de deshabilitarla, debes desasignarla de los usuarios.

URI Parameters
id
stringRequired

Identificador de la zona.

  • DELETEhttps://app.handy.la/api/v2/zone/id
HTTP
Request
(loading)
Response
(loading)

Lista de clientes

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

Enlistas todos los clientes dada una zona

URI Parameters
zoneId
stringRequired

Identificador de zona.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

showProspect
stringOptional

Filtra a los clientes prospetos. true ò false.

billable
stringOptional

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

  • GEThttps://app.handy.la/api/v2/zone/zoneId/customer
HTTP
Request
(loading)
Response
(loading)

Lista de usuarios de una zona en especifico

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

Enlistas todos los clientes dada una zona

URI Parameters
zoneId
stringRequired

Identificador de zona.

enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/zone/zoneId/user
HTTP
Request
(loading)
Response
(loading)

Tipos de pedidoin Acciones secundarias

Lista de tipos de pedido

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

Enlista los tipos de pedido

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/salesOrderType
HTTP
Request
(loading)
Response
(loading)

Leer tipo de pedido

GET
/api/v2/salesOrderType/{id}
URI Parameters
id
stringRequired

Identificador de tipo de pedido.

  • GEThttps://app.handy.la/api/v2/salesOrderType/id
HTTP
Request
(loading)
Response
(loading)

Crear tipo de pedido

POST
/api/v2/salesOrderType
Request Body
description
stringRequired

Descripción del tipo de pedido.

  • POSThttps://app.handy.la/api/v2/salesOrderType
HTTP
Request
(loading)
Response
(loading)

Actualizar un tipo de pedido

PUT
/api/v2/salesOrderType/{id}

Actualiza un tipo de pedido que ya estaba creado. Sirve para cambiar la descripción

URI Parameters
id
stringRequired

Identificador del tipo de pedido.

Request Body
description
stringRequired

Descripción del tipo de pedido.

  • PUThttps://app.handy.la/api/v2/salesOrderType/id
HTTP
Request
(loading)
Response
(loading)

Deshabilitar un tipo de pedido

DELETE
/api/v2/salesOrderType/{id}

Deshabilita el tipo de pedido (enabled=false, no es borrada para que se mantengan las referencias)

URI Parameters
id
stringRequired

Identificador de tipo de pedido.

  • DELETEhttps://app.handy.la/api/v2/salesOrderType/id
HTTP
Request
(loading)
Response
(loading)

Sincronizaciónin Acciones secundarias

Sincronizar clientes por zona

POST
/api/v2/sync/customers

Sirve para disparar una sincronización hacia los dispositivos móviles, basado en las zonas que hayan cambiado. Por ejemplo, si se agregan masivamente clientes a las zonas 1 y 2, se puede enviar una solicitud a este método para que todos los dispositivos a los que les corresponden esas zonas, se sincronicen en tiempo real.

  • POSThttps://app.handy.la/api/v2/sync/customers
HTTP
Request
(loading)
Response
(loading)

Resultados de visitasin Acciones secundarias

Lista de resultados de visita

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

Enlista los resultados de visita

URI Parameters
enabled
stringOptional

true o false. Default: true

start
stringOptional

Fecha inicio. Default: hoy

end
stringOptional

Fecha fin. Default: hoy

page
stringOptional

Página a regresar. Default: 1

max
stringOptional

Máximo de registros. Default: 10

order
stringOptional

asc o desc. Default: asc

sort
stringOptional

Cualquier campo del modelo. Default: dateCreated

  • GEThttps://app.handy.la/api/v2/visitResult
HTTP
Request
(loading)
Response
(loading)

Leer resultado de visita

GET
/api/v2/visitResult/{id}
URI Parameters
id
stringRequired

Identificador de resultado de visita.

  • GEThttps://app.handy.la/api/v2/visitResult/id
HTTP
Request
(loading)
Response
(loading)

Crear resultado de visita

POST
/api/v2/visitResult
Request Body
description
stringRequired

Descripción de resultado de visita. Es el texto que verá el vendedor en la app

code
stringRequired

Código identificador de resultado de visita. Sirve como un identificador fijo para el resultado de visita.

effective
booleanRequired

Efectivo o no efectivo.

  • POSThttps://app.handy.la/api/v2/visitResult
HTTP
Request
(loading)
Response
(loading)

Actualizar resultado de visita

PUT
/api/v2/visitResult/{id}

Actualiza un resultado de visita que ya estaba creado. No es necesario enviar todos los atributos en el cuerpo, sólo los que se desean editar.

URI Parameters
id
stringRequired

Identificador del resultado de la visita.

Request Body
description
string

Descripción de resultado de visita. Es el texto que verá el vendedor en la app

code
string

Código identificador de resultado de visita. Sirve como un identificador fijo para el resultado de visita.

effective
boolean

Efectivo o no efectivo.

  • PUThttps://app.handy.la/api/v2/visitResult/id
HTTP
Request
(loading)
Response
(loading)

Deshabilitar un resultado de visita

DELETE
/api/v2/visitResult/{id}

Deshabilita resultado de visita (enabled=false, no es borrada para que se mantengan las referencias)

URI Parameters
id
stringRequired

Identificador del resultado de visita.

  • DELETEhttps://app.handy.la/api/v2/visitResult/id
HTTP
Request
(loading)
Response
(loading)