Exportación de datos de pedidos

Puede utilizar la API REST de HCL Commerce para exportar datos de pedidos de una tienda específica. La salida se exporta en formato CSV.

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.
Nota: De forma predeterminada, para cada tienda, solo se permite 1 exportación de pedidos por usuario (con el rol de control de acceso adecuado) por hora. Para cambiar el tiempo mínimo entre exportaciones, consulte Configuración del tiempo transcurrido mínimo entre exportaciones de pedidos.

Procedimiento

  1. Utilice la consola de administración de organizaciones para asignar los siguientes roles a un usuario de HCL Commerce:
    • Asigne el rol Cliente registrado al usuario. Este rol permite a los usuarios iniciar la sesión en la tienda y acceder a las herramientas de exportación de pedidos 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.
    • Asigne cualquiera de los siguientes roles para proporcionar acceso para exportar y descargar datos de pedidos:
      • Director de operaciones
      • Comprador (lado comprador)
      • Gestor de categorías
      • Director de marketing
      • Director de operaciones
      • Director de logística
      • Director de ventas
      • Jefe de producto
      • Seller
      • Administrador de sitio
  2. Vaya a la tienda de inicio Aurora e inicie la sesión en la tienda con una cuenta de usuario que tenga acceso a la exportación de pedidos. Es necesario iniciar la sesión para utilizar los servicios REST de exportación de pedidos en la interfaz de usuario de Swagger.
  3. Abra un navegador web y vaya al siguiente URL para acceder a la interfaz de usuario de Swagger:
    https://hostname/webapp/wcs/stores/servlet/swagger/index.html

    En la interfaz de usuario de Swagger, la clase order_export se utiliza para exportar los datos de pedidos. Después, la clase order_download se utiliza para descargar los datos de pedidos exportados.

  4. Exporte los datos de pedidos.
    1. Expanda la clase order_export.
    2. Expanda la vía de acceso al método POST /store/{storeId}/order_export/.
    3. Escriba los parámetros necesarios.
      Parámetro Valor
      storeId
      Nota: storeId es un parámetro obligatorio.
      El identificador de la tienda.
      body
      Nota: Especifique los parámetros opcionales en formato JSON.
      Existen dos valores que se pueden someter.
      estado
      Solo exportar pedidos con el estado especificado. Los valores válidos se basan en la columna STATUS de la tabla de base de datos ORDERS.
      Si no se especifica estado, se utilizan los siguientes valores predeterminados
      "A","B","C","D","F","G","H","I","M","R","S","W"
      Nota: La lista predeterminada da por supuesto que se utiliza Sterling Order Management. Por lo tanto, si su entorno no está integrado con Sterling Order Management, es posible que observe que la lista contiene más valores STATUS que la tabla ORDERS.
      timePlacedInDays
      Exportar los pedidos que se formalizaron x días desde la hora actual. Por ejemplo, 0 representa todos los pedidos que se formalizaron después de las 00:00 horas de hoy. 1 representa todos los pedidos después de las 00:00 horas de ayer.

      Si timePlacedInDays no se especifica, 0 se utiliza de forma predeterminada.

      Por ejemplo, los siguientes parámetros exportan pedidos que se formalizaron los últimos 100 días y tienen un estado 'M', 'A' o 'B'.
      {
         "status":"M,A,B",
         "timePlacedInDays":"100"
      }
    4. Pulse ¡Probar ahora!
      Nota: La exportación de pedidos se almacena en la tabla de base de datos UPLOADFILE.
    5. Observe el exportId en el cuerpo de respuesta. El exportId se utiliza para descargar los datos de los pedidos en el paso posterior.
  5. Descargue los datos de pedidos exportados.
    1. Expanda la clase order_download.
    2. Expanda la vía de acceso al método GET /store/{storeId}/order_download/byExportId/.
    3. Escriba el storeId que se ha utilizado anteriormente y el exportId del paso 4.e.
    4. Pulse ¡Pruébelo!
    5. El cuerpo de respuesta contiene los datos de pedidos exportados en formato CSV.
    6. Descargue el archivo CSV yendo al URL de solicitud de respuesta en el navegador web.
      Por ejemplo, para una tienda con storeId 10151 y exportId 10001, el URL de respuesta de solicitud es
      https://localhost:443/wcs/resources/store/10151/order_download/byExportId/10001