1. Obtener credenciales
2. Autenticarse
3. Sincronizar catálogo
4. Informar ingresos (ASN / OC)
5. Crear pedidos
6. Recibir novedades

Para acceder a las APIs expuestas, es necesario autenticar cada solicitud. Este mecanismo permite validar la identidad del cliente y garantizar la seguridad de los recursos disponibles.

Este apartado describe cómo realizar una prueba para obtener un token de autenticación utilizando credenciales de prueba. Esta operación es necesaria para validar la conexión con nuestras APIs antes de pasar a un entorno productivo.

• Las credenciales de prueba deben ser solicitadas al equipo de integraciones (integraciones@oca.com.ar).

Login

• Permite obtener un token JWT necesario para autenticar las solicitudes a la API.

Headers

• Content-Type: application/json
• accept: application/json

{
  "username": "usuario_provisto",
  "password": "password_provisto"
}

{
  "data": {
    "token": "...",
    "expiresAtUtc": "2025-08-27T14:03:22.6420661Z",
    "tokenType": "Bearer"
  },
  "error": null,
  "traceId": "80000565-0001-ff00-b63f-84710c7967bb",
  "message": "Autenticación exitosa.",
  "meta": null
}

Permite mantener el catálogo de productos sincronizado con la plataforma, asegurando que la información necesaria esté disponible para una correcta operación logística.

Crear / actualizar producto

• Permite crear un nuevo producto o actualizar la información de uno existente dentro del catálogo.

Consultar SKUs

• Permite obtener un listado paginado de productos (SKUs) aplicando distintos filtros en la consulta.

Consultar stock

• Devuelve el stock disponible de los productos, agrupado por depósito (warehouse), permitiendo aplicar filtros.

La comunicación de ingresos al centro logístico debe realizarse mediante órdenes de compra y avisos de despacho (ASN). Esta práctica permite una adecuada planificación de la recepción y asegura la correcta gestión de los productos ingresados.

Crear / actualizar proveedor

• Permite registrar un nuevo proveedor o actualizar los datos de uno existente.

Listar proveedores

• Retorna el listado de proveedores actualmente registrados en el sistema.

Crear / actualizar orden de compra

• Permite generar una nueva orden de compra o actualizar una existente.

Consultar órdenes de compra

• Permite obtener un listado de órdenes de compra asociadas al cliente, aplicando filtros.

Crear / actualizar ASN

• Permite registrar un aviso de despacho (ASN) o actualizar uno existente, notificando el ingreso de mercadería al depósito.

Consultar ASN

• Devuelve el listado de ASN registrados, permitiendo aplicar filtros de búsqueda.

Este flujo permite generar pedidos en el sistema logístico a partir de la información recibida desde canales externos. Su objetivo es iniciar el proceso de preparación, empaquetado y despacho de la mercadería. La creación del pedido incluye datos clave como los productos solicitados, cantidades, direcciones de entrega y condiciones de servicio. Es un paso fundamental para activar la operación logística y garantizar una correcta ejecución de la entrega.

Crear / actualizar pedido

• Permite registrar un nuevo pedido o actualizar uno existente, incluyendo productos, cantidades y dirección de entrega.

Consultar pedidos

• Permite obtener un listado de pedidos, aplicando filtros según los parámetros enviados.

Este flujo permite informar actualizaciones sobre el estado de los pedidos procesados en el sistema logístico. Su finalidad es mantener sincronizada la información entre plataformas y asegurar visibilidad en tiempo real sobre el avance de la operación. Las novedades pueden incluir eventos como confirmación de preparación, salida a distribución, entregas realizadas, incidencias u otros hitos relevantes del proceso logístico.

Suscribirse a eventos

• Permite registrar una URL para recibir notificaciones (webhooks) sobre eventos del sistema logístico.

Desuscribirse de eventos

• Permite eliminar una suscripción previamente registrada.

• QA: Swagger UI – QA
• Producción: Swagger UI – Producción

Pasos para utilizar el token en Swagger:

1. Acceder a la documentación Swagger
   1. Ingresar a la URL correspondiente del entorno Swagger.
2. Obtener el token
   1. Seguir el procedimiento descripto en el modulo "Autenticación" para generar un token válido.
3. Habilitar autenticación en Swagger
   1. Hacer clic en el botón "Authorize" ubicado en la parte superior derecha de la interfaz de Swagger.
   2. En el campo de autorización, ingresar el token con el siguiente formato:
      Bearer {token}
   3. Confirmar haciendo clic en "Authorize" y luego cerrar el cuadro.