Venvers
Venvers
API Órdenes de compra
API Órdenes de compra
Embedded Files
Venvers cuenta con una API REST diseñada para simplificar la integración con sistemas ERP u otras plataformas. Esta interfaz permite gestionar las órdenes de compra y las recepciones de mercancía mediante el consumo de endpoints específicos para enviar la información en formatos JSON y XML, así como consultar, actualizar, eliminar y consolidar la información registrada. Además, ofrece funciones adicionales como la visualización en PDF y el reenvío por correo electrónico.
Ambientes productivo y demo
Ambientes productivo y demo
A continuación, se presentan los enlaces a los ambientes Productivo y Demo de la API de Órdenes de compra.
URL productiva
https://app.venvers.com/services/oc/api/
URL demo
https://venvers.detecnodev.mx/integration/oc/api/
Funciones de Órdenes de compra
Funciones de Órdenes de compra
A continuación, se describen las funciones de la API de Órdenes de Compra, junto con sus respectivos endpoints.
POST Token
Endpoint: /api/Auth/Token/{RFC}
Valida las credenciales para el uso de la API.
Se envía el RFC y el api_key proporcionado por DETECNO.
Se obtiene el token de autenticación.
POST OrdenCompra
Endpoint: /api/OrdenCompra
Postea una nueva orden de compra.
Se envía el archivo en formato JSON o XML.
Se obtiene la orden de compra con el ID y el IdEmpresa.
GET RecuperaOrdenes
Endpoint: /api/OrdenCompra/RecuperaOrdenes
Recupera las órdenes de compra y recepciones de mercancía registradas en el sistema.
Se envía un objeto en formato JSON con los parámetros de búsqueda.
Se obtienen las órdenes de compra y recepciones que coinciden con los filtros aplicados.
GET NoOC
Endpoint: /api/OrdenCompra?NoOC
Recupera una orden de compra por su número.
Se le envía el número de orden de compra (NoOC).
Se obtiene la información detallada de la orden de compra.
GET OrdenCompra
Endpoint: /api/OrdenCompra/{Id}
Recupera una orden de compra por su ID.
Se le envía el numero de ID de la orden de compra.
Se obtiene la información detallada de la orden de compra.
GET Estatus
Endpoint: /api/OrdenCompra/Estatus
Consulta el catálogo de estatus disponibles para las órdenes de compra.
No se requiere enviar ningún parámetro en la solicitud.
Se obtiene una lista de estatus (Disponible, Consumida_Parcialmente, Consumida y Cancelada).
GET RecuperaOrdenesRFC
Endpoint: /api/OrdenCompra/RecuperaOrdenesRFC
Consulta las órdenes y recepciones de mercancía asociadas a un RFC.
Se envían los parámetros rfcReceptor y rfcEmisor.
Se obtiene una lista de NoOC y NoRecepcionMercancia asociadas a los RFCs proporcionados.
GET PDF
Endpoint: /api/OrdenCompra/{Id}/PDF
Obtiene el PDF de una orden de compra específica.
Se envía el ID de la orden de compra.
Se obtiene el archivo PDF de la representación impresa de la orden de compra.
GET {IdOrdenCompra}/Consolidacion
Endpoint: /api/OrdenCompra/{Id}/Consolidacion
Consulta la consolidación de una orden de compra por ID de OC.
Se envía el ID de la orden de compra.
Se obtienen los UUIDs relacionados a la orden de compra.
GET NoOC/Consolidacion
Endpoint: /api/OrdenCompra/Consolidacion?NoOC
Consulta la consolidación de una orden de compra por número de orden.
Se envía el número de orden de compra (NoOC).
Se obtienen los UUIDs relacionados a la orden de compra.
POST Reenviar-Correo
Endpoint: /api/OrdenCompra/{Id}/Reenviar-Correo
Envía por correo electrónico una orden de compra.
Se envía el ID de la orden de compra y las direcciones de correo electrónico.
Se obtiene una respuesta con estatus 200 OK.
PUT OrdenCompra
Endpoint: /api/OrdenCompra
Actualiza los datos de una orden de compra.
Se envía el archivo en formato JSON o XML con la información a actualizar.
Se obtiene un archivo JSON o XML con la información actualizada.
DELETE OrdenCompra
Endpoint: /api/OrdenCompra/{Id}
Elimina una orden de compra registrada en el sistema.
Se envía el ID de la orden de compra.
Se obtiene una respuesta que indica que la eliminación fue exitosa.
Funciones de Recepción de mercancías
Funciones de Recepción de mercancías
A continuación, se describen las funciones de la API para la Recepción de mercancías, junto con sus respectivos endpoints.
POST RecepcionMercancias
Endpoint: /api/RecepcionMercancias
Postea una nueva recepción de mercancía en el sistema.
Se envía el archivo JSON o XML con la información de la recepción.
Se obtiene el ID de la recepción de mercancía posteada, el IdEmpresa y el IdOc.
GET RecepcionMercancias
Endpoint: /api/RecepcionMercancias
Consulta las recepciones de mercancía filtrando por número de orden de compra, número de recepción y/o estatus.
Se le envían los parámetros (NoOC, NoRecepcionMercancia y Estatus).
Se obtiene una lista de recepciones de mercancía.
GET RecepcionMercancias/{Id}
Endpoint: /api/RecepcionMercancias/{Id}
Consulta el detalle de una recepción de mercancía por ID.
Se envía el ID de la recepción de mercancía.
Se obtiene el detalle completo de la recepción de mercancía.
GET Estatus
Endpoint: /api/RecepcionMercancias/Estatus
Consulta el catálogo de estatus disponibles para las recepciones de mercancía.
No se requiere enviar ningún parámetro en la solicitud.
Se obtiene una lista de estatus (Disponible, Completada y Cancelada).
PUT RecepcionMercancias
Endpoint: /api/RecepcionMercancias
Actualiza los datos de una recepción de mercancía.
Se envía el archivo JSON o XML con la información de la recepción a actualizar.
Se obtiene el JSON o el XML con la información actualizada.
Estructura de datos de la Orden de compra
Estructura de datos de la Orden de compra
La estructura de los archivos JSON y XML utilizados para el envío de órdenes de compra y recepciones de mercancía se detalla en el siguiente diccionario de datos y en los ejemplos.
Para descargar el archivo, dé clic en el enlace, y una vez abierto, seleccione la opción de descarga.
Diccionario de campos de OC y Recepción de mercancía
Estructura JSON de Orden de compra
Estructura XML de Orden de compra
Documentación interactiva Swagger
Documentación interactiva Swagger
Swagger es una herramienta que permite visualizar y probar los endpoints de la API directamente desde el navegador. Esta interfaz facilita a los desarrolladores conocer cómo funciona cada método, qué parámetros requiere, qué respuesta devuelve, y realizar pruebas sin necesidad de herramientas externas.
Swagger productivo
https://app.venvers.com/services/oc/swagger/index.html
Swagger demo
https://venvers.detecnodev.mx/integration/oc/swagger/index.html
Prueba rápida con Postman
Prueba rápida con Postman
Podrá probar la API de Órdenes de compra y Recepción de mercancía sin necesidad de realizar desarrollos utilizando la herramienta Postman. Para facilitar las pruebas, le proporcionamos una colección de solicitudes preconfiguradas con la URL, parámetros y datos de ejemplo, lista para su ejecución. Para descargar la colección, haga clic en el siguiente enlace y, una vez abierta, seleccione la opción de descarga.
Colección de peticiones de la API de OC y Recepción de mercancía
Page updated
Report abuse