Exportación de datos de catálogo

Puede utilizar la API REST de HCL Commerce para exportar datos de catálogo en formato CSV. Los tipos de datos predeterminados que puede exportar son categorías o productos.

Antes de empezar

Asegúrese de que la interfaz de usuario de Swagger y la API Discovery REST están habilitadas. Para obtener más información, consulte Habilitar e inhabilitar la API de REST Discover.

Procedimiento

  1. Utilice la consola de administración de organizaciones para asignar los siguientes roles a un usuario de HCL Commerce:
    • Exportador de catálogo: El rol que permite a los usuarios exportar y descargar datos de catálogo. Este rol suele asignarse a gestores de categorías, gestores de productos y administradores de sitios.
    • Cliente registrado: El rol que permite a los usuarios iniciar sesión en la tienda y acceder a las herramientas de exportación de catálogo en la interfaz de usuario de Swagger. Este rol es necesario si la contraseña de usuario ha caducado y debe restablecerse utilizando el escaparate.
    Para obtener más información, consulte Selección de roles para un usuario.
  2. Vaya a la tienda de inicio Aurora e inicie sesión mediante el usuario de HCL Commerce que contiene los roles de Exportador de catálogo y Cliente registrado.
    Este paso es necesario para que los servicios REST de exportación de catálogo puedan utilizarse en la interfaz de usuario de Swagger.
  3. Abra la interfaz de usuario de Swagger.

    En la interfaz de usuario de Swagger, la clase catalog_export se utiliza para exportar datos de catálogo. A continuación, la clase catalog_download se utiliza para descargar los datos de catálogo exportados.

    1. Abra un navegador web y vaya a los URL siguientes: https://localhost/webapp/wcs/stores/servlet/swagger/index.html
  4. Exporte los datos del catálogo.
    1. Expanda la clase catalog_export.
    2. Expanda la vía de acceso al método POST /store/{storeId}/catalog_export/{objectType}.
    3. Escriba los siguientes parámetros:
      Parámetro Valor
      storeId El identificador de la tienda de la que exportar datos del catálogo.

      Por ejemplo, 10151.
      objectType El tipo de datos a exportar. Escriba ya sea Category o Product. Este valor es sensible a las mayúsculas y minúsculas.
      Nota: Asegúrese de especificar un valor válido. La clase catalog_export no valida la entrada. En su lugar, si especifica un valor no válido, se producen errores en el paso posterior cuando trabaja con la clase catalog_download.

      Por ejemplo, Category.
      body Opcional: Escriba valores separados por comas en el formato JSON que desea exportar.
      exportMode
      Indica si se van a exportar datos de catálogo delta o completos. El valor predeterminado es completo.

      Si especifica una compilación delta, la clase catalog_download en el paso siguiente le permite especificar un valor para el parámetro deleted. Este parámetro indica si el archivo descargado contiene solo objetos suprimidos desde la última exportación.

      CSVColumnList
      Una lista de columnas CSV a exportar. El valor predeterminado es todas las columnas.
      catalogId
      El ID del catálogo a exportar. El valor predeterminado es el catálogo maestro.
      langId
      El ID del idioma a exportar. El valor predeterminado es el idioma de tienda predeterminado.
      Por ejemplo, para examinar la exportación del catálogo basándose en el ID de catálogo 10001, especifique el siguiente JSON en el cuerpo:10001
      
{
catalogId : "10001"
}

      Para ver una lista de valores opcionales de ejemplo que puede especificar, consulte Entradas y escenarios de ejemplo de la exportación de catálogo.

      Además de los valores opcionales soportados, también puede especificar los parámetros de consulta opcionales que están disponibles a todos los servicios REST. Para obtener una lista de todos los parámetros de consulta opcionales que puede utilizar con la API REST de HCL Commerce, consulte API REST.
      Por ejemplo, la siguiente captura de pantalla muestra la interfaz de usuario de Swagger con los valores de exportación del catálogo de ejemplo:
      Entrada de la interfaz de usuario de Swagger: entrada de catalog_export
    4. Pulse Inténtelo.
    5. Anote el ID de exportación en el cuerpo de respuesta ya que se utiliza para descargar los datos del catálogo en el paso posterior.
      Por ejemplo, la siguiente captura de pantalla muestra la interfaz de usuario de Swagger con un ID de exportación devuelto de 10001:
      Salida de la interfaz de usuario de Swagger: salida de catalog_export
  5. Descargue los datos de catálogo exportados.
    1. Expanda la clase catalog_download.
    2. Expanda la vía de acceso al método GET /store/{storeId}/catalog_download/byExportId/{exportId}.
    3. Escriba los siguientes parámetros:
      Parámetro Valor
      storeId El identificador de la tienda de la que descargar los datos del catálogo exportados. Utilice el mismo valor de ID de tienda que ha utilizado en el paso anterior.

      Por ejemplo, 10151.
      exportId El ID de exportación que ha anotado en el cuerpo de respuesta del paso anterior después de ejecutar el servicio REST de exportación de catálogo.

      Por ejemplo, 10001.
      deleted Opcional: Indica si el archivo descargado contiene solo objetos suprimidos desde la última exportación. Este parámetro se utiliza al exportar datos de catálogo delta. Es decir, cuando el valor exportMode se establece en delta cuando se exportan datos del catálogo mediante la clase catalog_export en el paso anterior.

      El valor predeterminado es falso, lo que indica que el archivo CSV contiene únicamente los objetos nuevos o actualizados, no los objetos suprimidos.
      Por ejemplo, la siguiente captura de pantalla muestra la interfaz de usuario de Swagger con los valores de exportación del catálogo de ejemplo:
      Entrada de la interfaz de usuario de Swagger: entrada de catalog_download
    4. Pulse Inténtelo.
    5. El cuerpo de respuesta contiene los datos de catálogo exportados en formato CSV.
      Por ejemplo, la siguiente captura de pantalla muestra la interfaz de usuario de Swagger con la respuesta en línea:
      Salida de interfaz de usuario de Swagger: salida de catalog_download
    6. Descargue el archivo CSV yendo al URL de solicitud de respuesta en el navegador web.
      Por ejemplo, en este ejemplo, el URL de respuesta de solicitud es:
      
https://localhost:443/wcs/resources/store/10151/catalog_download/byExportId/10002
      Si se dirige al URL de solicitud provocará la descarga del archivo CSV, en lugar de la respuesta en línea en la interfaz de usuario de Swagger.
      Interfaz de usuario de Swagger: Diálogo para guardar el catalog_download

Qué hacer a continuación

Si surgen problemas al utilizar los servicios de descarga o exportación de catálogo, revise los siguientes consejos de resolución de problemas:
  • Asegúrese de que el sistema tiene suficiente memoria cuando ejecuta una exportación de catálogo delta. Los errores de falta de memoria se producen durante las exportaciones de catálogo delta, porque la comprobación de las diferencias de archivos puede ser potencialmente un proceso con mucha utilización de memoria.
  • Asegúrese de especificar un tipo de objeto válido al ejecutar el servicio de exportación de catálogo. Este valor es sensible a las mayúsculas y minúsculas. La clase catalog_export no valida la entrada. En su lugar, si especifica un valor no válido, se producen errores cuando se trabaje más adelante con la clase catalog_download.
  • Asegúrese de que el servicio de exportación de catálogo se haya completado antes de llamar al servicio de descarga de catálogo. La respuesta de descarga de catálogo lo indica si intenta descargarlo demasiado pronto.
  • Asegúrese de que ha iniciado la sesión como un usuario que contiene los roles Exportador de catálogo y Cliente registrado. De lo contrario, se produce un error NOT_AUTHORIZED_FOR_QUERY cuando trabaja con los servicios de exportación de catálogo.
  • Si la respuesta de descarga de catálogo indica un ID de exportación no válido, podría deberse a alguna de las siguientes razones:
    • El ID de exportación no existe. Compruebe que ha especificado el valor correcto.
    • El ID de catálogo puede existir pero no dentro del ID de tienda que ha solicitado.
    • El ID de exportación puede existir pero ha caducado. Este error podría producirse si se emite una nueva solicitud del mismo tipo, lo que hace que la anterior ya no sea válida.
    • La tienda no contiene ningún catálogo.

Después de descargar los datos de catálogo exportados en formato CSV, puede importarlos a una aplicación de terceros para un proceso adicional.