Tutorial: Solicitar un reporte
Cómo solicitar reportes de Amazon para ayudar a los selling partners a gestionar su negocio.
Versión de la API: 2021-06-30
Tutorial: Solicitar y recuperar un reporte
Utilice el siguiente proceso para la solicitud de un reporte:
-
Llame a la operación
createReport
, especificando el tipo de reporte y de los marketplaces que estás solicitando, así como cualquier parámetro opcional.Amazon recibe la solicitud de reporte. Si la operación es correcta, la respuesta incluye un valor
reportId
. -
Periódicamente la encuesta de la cola de Amazon SQS para
REPORT_PROCESSING_FINISHED
la notificación de eventos, que proporciona información cuando el reporte de procesamiento de seCANCELLED
,DONE
oFATAL
. El evento de notificación incluye unreportDocumentId
valor si no hay reporte de los datos disponibles. -
Llame a la operación
getReportDocument
, pasando elreportDocumentId
valor en el paso anterior.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.
-
Descargar el reporte.
Requisitos previos
Los siguientes elementos son necesarios para completar con éxito este tutorial:
- El tipo de reporte que se le solicita. Consulte reportType valores 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 de la Selling Partner API para desarollador para obtener más información.
- Una instalación funcional de Java Development Kit (JDK) para ejecutar código de ejemplo.
Pasos
Paso 1. Solicitar un reporte
Solicita un reporte especificando el tipo de reporte y los marktplaces que estás solicitando, así como cualquier parámetro opcional.
- Llame a la operación
createReport
, pasando los siguientes parámetros:
Body de solicitud:
Nombre | Descripción | Se requiere |
---|---|---|
reportOptions | Información adicional pasa a los reportes. Esto varía según el tipo de reporte. Tipo: | No |
reportType | El tipo de reporte. Para obtener más información, consulte reportType valores. Tipo: string | Sí |
dataStartTime | El inicio de un rango de fecha y hora, en la norma ISO 8601 fecha formato de tiempo, utilizado para la selección de los datos para el reporte. El valor predeterminado es ahora. El valor debe ser anterior o igual a la fecha actual y la hora. No todos los tipos de reportes de hacer uso de esta. Tipo: string (date-time) | No |
dataEndTime | El final de un rango de fecha y hora, en la norma ISO 8601 fecha formato de tiempo, utilizado para la selección de los datos para el reporte. El valor predeterminado es ahora. El valor debe ser anterior o igual a la fecha actual y la hora. No todos los tipos de reportes de hacer uso de esta. Tipo: string (date-time) | No |
marketplaceIds | Una lista de marketplace de los identificadores. El reporte contenido del documento contendrá los datos de todos los marketplaces, a menos que el tipo de reporte que indica lo contrario. Tipo: < string > array | Sí |
Ejemplo de solicitud:
POST https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/reports
{
"reportType": "GET_MERCHANT_LISTINGS_ALL_DATA",
"dataStartTime": "2019-12-10T20:11:24.000Z",
"marketplaceIds": [
"A1PA6795UKMFR9",
"ATVPDKIKX0DER"
]
}
Respuesta
Una respuesta correcta incluye las siguientes propiedades:
Nombre | Descripción |
---|---|
reportId | El identificador para el reporte. Este identificador es único sólo en combinación con un seller ID. Tipo: string |
Respuesta ejemplo:
{
"reportId": "ID323"
}
Paso 2. Confirmar que el reporte que el proceso esté completo
Para confirmar que el reporte que el proceso esté completo, consulte Compruebe que el reporte que el proceso esté completo.
Paso 3. Recuperar el reporte
Para recuperar el reporte, se refieren a Recuperar un reporte.
Updated over 1 year ago