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ónMétodo y rutaAlcance
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

  • id integer obligatorio
  • kind string obligatorio
  • status string obligatorio
    Valores: uploaded, validating, validated, invalid, committing, committed, failed, cancelled
  • file string | null
  • rows objeto obligatorio
    3 campos de rows
    • total integer | null
    • valid integer | null
    • error integer | null
  • documents objeto obligatorio
    3 campos de documents
    • total integer | null
    • valid integer | null
    • committed integer | null
  • structure_errors array de textos
  • error_report_url string (uri) | null

    Excel con cada fila rechazada y su motivo.

  • committed_at string (date-time) | null
Objeto carga masiva
{
    "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
}