Documentación Técnica

Webhooks

Son notificaciones en tiempo real que se generan cuando ocurre un evento en Multivende y se envía a la aplicación por medio del Callback URL.

Cuando se produce un evento en Multivende, se envía una solicitud HTTPS POST a la URL de devolución de llamada (Callback URL) por cada una de las apps de integración que están suscritas a los webhooks. A partir de las notificaciones se puede usar para desencadenar reglas o procesos específicos de la aplicación.


De esta manera, las apps resultan más eficientes, porque identifican cuando se produce un cambio en tiempo real, y, entonces, puede hacer las solicitudes periódicas en un rango de tiempo más amplio a la API para obtener el contenido actualizado.

 

Los webhooks disponibles son los siguientes:

  • Stock: Se notificará los cambios del stock de una versión de un producto por bodega.
  • Products: Se notificará que hay un cambio en los detalles o un nuevo producto y sus versiones.
  • Product links: Se notificará que hay un cambio en el estado de sincronización del producto con el canal.
  • Checkouts: Se notificará que hay una nueva venta, cambios de estados, cambio en el detalle de la venta.*
  • Prices: Se notificará los cambios en los precios de una versión de un producto por lista de precio.
  • Delivery Orders: Se notificará los cambios de estados en las entregas con despacho a domicilio de una venta.
  • Pick Up Orders: Se notificará los cambios de estados en las entregas con retiro en tienda de una venta.

Ejemplo de notificación cambio de checkouts:

{
"CheckoutId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"MerchantId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"MarketplaceConnectionId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"MerchantAppId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"OauthClient":{
"_id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"client_id":"99631xxxxxxx"
},
"resource":"checkouts",
"attemps":1,
"received":"2021-04-08T19:55:07.061Z"
}

Más ejemplos de notificaciones (link)

Importante:

  • * Si al consultar el detalle de la venta con el CheckoutId el response es con status 404, se debe a que se trata de una venta que presentó error en el registro de Multivende la cual no queda registrada.
  • El Callback URL se registra al momento de crear la aplicación (Crear tu aplicación).
  • El Callback URL debe poseer certificado SSL válido (HTTPS).
  • El Callback URL no debe poseer validación de token.
  • Se recomiendo implementar un sistema de colas para el procesamiento de las notificaciones.
  • Los webhooks se deben complementar con un polling para disminuir la probabilidad de pérdida de datos.


¿Dónde se ingresa el Callback Url? Detalles en: ¿Cómo crear una aplicación?

 

Si tienes dudas sobre este tema contáctanos a través de api@multivende.com y estaremos felices de ayudarte.

Equipo Integraciones API Multivende