Documentación

Obtener información general

Este endpoint crea una tarea para generar un archivo con los campos generales de tus productos y variaciones. Devuelve el ID de la tarea (task_id), que se puede utilizar para consultar el estado de la tarea. Una vez que la tarea esté completa, se enviará un webhook con el topic products-gral-report, incluyendo el ID de la tarea para acceder al informe generado.

El archivo da la siguiente información:

  • Lista los productos con sus campos generales como nombre, descripción, imagenes, tipo de envío, texto personalizado, etc.
  • Dentro de cada producto podrás encontrar las variaciones correspondientes con sus caracteristicas.

El archivo generado es un jsonl, es decir, cada linea del archivo es un producto con su información. Esto te permitirá procesar de una manera más sencilla y con menos recursos el archivo

🚧

¡Límite!

Puedes generar este reporte cada 24 horas.

Endpoint:

POST https://api.tp.yuju.io/products-gral-report

Body: N/A

Respuesta

{
	"message": "Estamos generando tu reporte, una vez esté listo lanzaremos una notificación (webhook)",
	"id_task": "302dd26d7af44afab0ff48db4bn2m417"
}

Consultar el estado de una tarea

Endpoint

GET https://api.tp.yuju.io/products-gral-report/{id_task}

ParámetroDescripción
id_taskid de la tarea

Respuesta:

CampoDescripción
statusEstado de la tarea, posibles valores: CREATED, PROCESSING, COMPLETED, REJECTED, ERROR
urlUrl del archivo generado, únicamente tiene valor cuando la tarea está en estado COMPLETED
{  
   "status": "COMPLETED",  
   "url": "https\://..../file.jsonl"  
}