Versión de la API: 2021-06-30

Tutorial: Programar y recuperar reportes

Puedes programar solicitudes de reportes para que se envíen periódicamente utilizando la operación createReportSchedule. Utilice el período de enumeración para especificar el período de tiempo. Para identificar qué reportes se pueden programar, revise los Valores de reportType en la documentación de Selling Partner API.

Use el siguiente proceso para solicitar un reporte:

1. Llame a la operación createReportSchedule para crear una programación para enviar periódicamente solicitudes de reportes. Especificar reportType, marketplaceIds y period los valores y todos los parámetros opcionales. Para reportType los valores, consulte valores de reportType. Para period los valores, consulte el período de enumeración.

   Nota: Si ya existe una programación de reporte con el mismo tipo de reporte y los mismos IDs de marketplace, se cancela y se reemplaza con esta programación. De lo contrario, se crea una nueva programación de reporte.

2. Periódicamente la encuesta de la cola de Amazon SQS para REPORT_PROCESSING_FINISHED la notificación de eventos utilizando un intervalo, que es similar a la programación que se ha configurado en el primer paso.

   Si recibes una notificación para el reporte programado, el evento de notificación contiene la información del reporte, incluyendo el reportDocumentId valor de si los datos del reporte está disponible.

3. Para cada uno reportDocumentId:

   1. Llame a la getReportDocument operación, pasando el reportDocumentId valor.

      Amazon devuelve un pre-firmado dirección URL de la ubicación del documento de reporte, y el algoritmo de compresión utilizado si el documento de reporte, los contenidos han sido comprimido.

   2. Descargar el reporte.

Requisitos previos

Los siguientes elementos son necesarios para completar con éxito este tutorial:

• Un tipo de reporte que desea programar. Consulte valores de reportType para una lista de todos los tipos de reporte.
• Autorización del selling partner para el cual estás realizando las llamadas. Consulta la Guía para desarrolladores de Selling Partner API para más información.
• Una instalación funcional de Java Development Kit (JDK) para ejecutar código de ejemplo.

Pasos

1. Crear un horario para las solicitudes de reporte
2. Recuperar periódicamente información acerca de los reportes programados
3. Recuperar el reporte

Paso 1. Crear un horario para las solicitudes de reporte

Llame a la operación createReportSchedule para crear una programación de solicitudes de reportes, especificando los valores dereportType, markeplaceIds, y period y cualquier parámetro opcional. Consulte valores de reportType para una lista de todos los tipos de reporte.

• Llame a la operación createReportSchedule y pasa los siguientes parámetros:

Body parameter:

Ejemplo de Solicitud:

POST https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/schedules
{
  "reportType": "GET_XML_BROWSE_TREE_DATA",
  "period": "P2D",
  "marketplaceIds":["ATVPDKIKX0DER"]
}

Respuesta

Una respuesta correcta incluye lo siguiente:

Respuesta ejemplo:

{
  "reportScheduleId": "ID323"
}

Paso 2. Recuperar periódicamente información acerca de los reportes programados

Periódicamente la encuesta de la cola de Amazon SQS para REPORT_PROCESSING_FINISHED la notificación de eventos utilizando un intervalo, que es similar a la programación que se ha configurado en el paso 1. Para confirmar que el procesamiento del reporte se completa, consulte la REPORT_PROCESSING_FINISHED notificación de eventos.

Paso 3. Recuperar el reporte

Para recuperar un reporte, consulte Recuperar un reporte.