REST API Importación de productos V1
Esta fuente se utiliza para importar datos de productos en Quant. El formato de entrada y salida es JSON.
Utilice la sección Tareas automáticas para crear y configurar un importe. Una vez creada, la lista de tareas tendrá el ID que pase en la URL de solicitud.
- Configuración
Antes de utilizar la API, debe editar los siguientes atributos en la pestaña Configuración:
- Marque el atributo Activado para activar la tarea.
- En Usuarios con permiso de acceso a la API, seleccione uno o varios usuarios con el rol Robot que tendrán permiso para ejecutar la tarea.
- En Asignación de atributos de datos de productos, seleccione los atributos que desea importar y, si lo desea, modifique sus claves JSON.
- Además, le recomendamos que rellene el campo Correos electrónicos para notificaciones, donde deberá introducir una o varias direcciones de correo electrónico a las que se enviarán los mensajes con los estados de error.
- Atributos
Atributos | Descripción | Tipo |
Activado | Especifica si la tarea automática está activa y se pueden enviar datos a través de ella. | sí/no |
Título | Nombre personalizado de la tarea automática. | texto |
Descripción | Descripción personalizada de la función de tarea automática. | texto formateado |
Notas | Notas. | texto largo |
Correos electrónicos de notificación | Una o varias direcciones de correo electrónico a las que se enviarán los mensajes con condiciones de error. | lista de cadenas |
Usuarios con permiso de acceso a la API | Usuarios con el rol de Robot quienes están autorizados a ejecutar la tarea. | lista de usuarios |
Unidad de medida | Unidad de medida como, por ejemplo, cm, mm, etc. | selección |
Formato de fecha | Formato de entrada de fecha, por ejemplo 31.12.19. | selección |
Formato de fecha y hora | Formato de entrada de fecha y hora, por ejemplo 19.12.31 23:59:59. | selección |
Atributo coincidente | Un atributo de producto en Quant que se utilizará para hacer coincidir los artículos de importación con los productos en Quant. | selección |
Crear nuevos productos | Si se activa, la importación creará nuevos productos para IDs de productos inexistentes. | sí/no |
Establecer nuevos productos para planogramas | Si se activa, los productos recién creados se establecerán para la creación de planogramas. Esta opción sólo está activa cuando Crear nuevos productos está activado. | sí/no |
Ignorar productos eliminados | Por defecto, cuando la importación no encuentra un producto activo para un ID determinado, busca entre los productos eliminados. Si encuentra uno borrado, lo revive. Si activa esta opción, ignorará los productos eliminados en lugar de recuperarlos. | sí/no |
No sobrescriba las medidas que no sean cero | Si se activa, las dimensiones de los registros importados (por ejemplo, altura, anchura) sólo se importan si el valor de dimensión existente es cero. | sí/no |
Atributos del producto para borrar | Lista de atributos cuyos valores se borran de todos los productos antes de importarlos. | lista de atributos |
Asignación de atributos de datos de productos | Asignación que contiene una entrada para cada atributo que se va a importar. | tipo de complejo |
- Solicitud
/v1/import/product-data/{task_id}
Parámetro | Valor |
URL | Si se añade ?debug a la URL, también se mostrarán advertencias en la respuesta. Sin ello, solo se mostrarán los errores. |
Encabezado | Accept: application/json |
Encabezado | Content-type: application/json |
Encabezado | Authorization: Bearer <TOKEN> TOKEN se obtiene mediante /authenticate (ver Inicio de sesión). |
Método | POST |
El contenido de la solicitud es una matriz de objetos JSON que contienen las claves definidas en la configuración Asignación de atributos de datos de productos.
Es importante que la solicitud cumpla con los estándares JSON. Definidos, por ejemplo, aquí. Envíe los valores numéricos de los atributos sin comillas, véase el ejemplo.
- Respuesta
Clave | Valor |
Estado | Una cadena que describe el estado final de la importación.
|
Advertencias | Es opcional, es decir, solo se incluye si el parámetro ?debug está en la URL y la importación ha generado al menos una advertencia. Lista de cadenas de advertencia. |
Erores | Opcional: se incluye solo si la importación generó al menos un error. Lista de cadenas de advertencia. |
Líneas totales | Opcional: se incluye solo si la importación no finalizó con el estado "FAILURE". Número de registros en la entrada. |
Productos duplicados | Opcional: solo se incluye si la importación no finalizó con el estado "FAILURE". El número de registros que se omitieron porque este producto ya se importó en la misma solicitud. |
Productos ignorados | Opcional: se incluye solo si la importación no finalizó con el estado "FAILURE". Número de productos de entrada cuyos datos no se han importado. Las posibles razones son:
|
- Códigos de estado
Estado | Valor |
200 OK | Importación correcta con estado "SUCCESS" or "PARTIAL_SUCCESS". La respuesta puede contener advertencias o errores menores. |
400 Bad Request | Configuración incorrecta de la tarea o solicitud incorrecta. |
401 Unauthorized | El token de autorización no es válido o el usuario que ha iniciado sesión con el token no tiene permiso para ejecutar esta tarea. |
404 Not Found | No se encontró ninguna tarea con el ID especificado en la URL. |
500 Internal Server Error | Se produjo un error crítico del servidor durante la importación.. |
503 Service Unavailable | La tarea ya se está ejecutando. Vuelva a intentar iniciar la tarea tras el número de segundos indicado en el encabezado de respuesta Retry-After. |
- Registro de ejecución
En Quant, además de la configuración de las tareas, también puede ver los registros de los importes individuales, incluidas las estadísticas, los errores y las advertencias.
Si seleccionamos un registro concreto, podemos mostrar sus detalles pulsando el botón Mostrar artículos.
- Solicitud
curl -X POST --location "https://[YOUR_COMPANY].iquant.eu/v1/import/product-data/145?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d "[{ \"Primary Product ID\": \"100001\", \"Name\": \"Test Product\", \"EAN\": \"8762584623\", \"Width\": 120, \"Height\": 12, \"Depth\": 23}]"
- Respuesta
{
"Status": "SUCCESS",
"Total Lines": 1,
"Duplicated Products": 0,
"Ignored Products": 0
}