Endpoints de la API. Especificación exacta de cada operación de la API v1 (parámetros, cuerpo, respuestas y ejemplos), generada del documento OpenAPI con el que se valida cada respuesta real. Los procedimientos completos están en Guías.
Documentos y operación
Carga masiva
Archivos de Excel o CSV con productos o documentos, validados antes de aplicarse.
Operaciones
| Operación | Método y ruta | Alcance |
|---|---|---|
| Subir un archivo de carga masiva | POST
/imports |
products:write |
| Consultar una carga | GET
/imports/{id} |
products:read |
| Confirmar una carga | POST
/imports/{id}/commit |
products:write |
Objeto carga masiva
-
idinteger obligatorio -
kindstring obligatorio -
statusstring obligatorioValores:uploaded,validating,validated,invalid,committing,committed,failed,cancelled -
filestring | null -
rowsobjeto obligatorio3 campos de
rows-
totalinteger | null -
validinteger | null -
errorinteger | null
-
-
documentsobjeto obligatorio3 campos de
documents-
totalinteger | null -
validinteger | null -
committedinteger | null
-
-
structure_errorsarray de textos -
error_report_urlstring (uri) | nullExcel con cada fila rechazada y su motivo.
-
committed_atstring (date-time) | null
{
"id": 1,
"kind": "products",
"status": "validated",
"file": "catalogo.csv",
"rows": {
"total": 1,
"valid": 1,
"error": 0
},
"documents": {
"total": 1,
"valid": 1,
"committed": 0
},
"structure_errors": [],
"error_report_url": null,
"committed_at": null
}