Referencia de Reports API v2021-06-30
Cómo obtener reportes de Amazon para ayudar a los selling partners a gestionar su negocio.
Descripción general
La Selling Partner API para reportes le permite recuperar y administrar una variedad de reportes que pueden ayudar a los selling partners a administrar sus negocios.
Información de versión
Versión : 2021-06-30
Información del contacto
Contacto : Soporte para desarrolladores Selling Partner API
URL de contacto : https://sellercentral.amazon.com/gp/mws/contactus.html
Información de licencia
Licencia : Licencia Apache 2.0
URL de la licencia : http://www.apache.org/licenses/LICENSE-2.0
esquema URI
Anfitrión : Sellingpartnerapi-na.amazon.com
Ruta base : /
Esquemas : HTTPS
consume
application/json
produce
application/json
Operaciones
getReports
createReport
getReport
cancelReport
getReportSchedules
createReportSchedule
getReportSchedule
cancelReportSchedule
getReportDocument
Caminos
GET /reports/2021-06-30/reports
Operación: getReports
Descripción
Devuelve los detalles del reporte para los reportes que coinciden con los filtros que especifique.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.0222 | 10 |
El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema | Por defecto |
|---|---|---|---|---|
| Query | reportType opcional | Una lista de reportType usados para filtrar reportes. Consulte Valores de reportType para obtener más información. Cuando se proporciona reportType, también se pueden proporcionar los otros parámetros de filtro (processingStatuses, marketplaceIds, createdSince, createdUntil) y pageSize. Se requiere reportType o nextToken. Recuento mínimo : 1 Número máximo : 10 | < string > array | - |
| Query | processingStatuses opcional | Una lista de estados de procesamiento utilizados para filtrar reportes. Recuento mínimo : 1 | < enum ( processingStatuses ) > array | - |
| Query | marketplaceIds opcional | Una lista de identificadores de marketplace utilizados para filtrar reportes. Los reportes devueltos coincidirán con al menos uno de los marketplaces que especifique. Recuento mínimo : 1 Número máximo : 10 | < string > array | - |
| Query | pageSize opcional | El número máximo de reportes para devolver en una sola llamada. Mínimo : 1 Máximo : 100 | entero | 10 |
| Query | createdSince opcional | La primera fecha y hora de creación del reporte para que los reportes se incluyan en la respuesta, en formato de fecha y hora ISO 8601. El valor predeterminado es hace 90 días. Los reportes se conservan durante un máximo de 90 días. | string (date-time) | - |
| Query | createdUntil opcional | La última fecha y hora de creación del reporte para que los reportes se incluyan en la respuesta, en formato de fecha y hora ISO 8601. El valor predeterminado es ahora. | string (date-time) | - |
| Query | nextToken opcional | Un token de string devuelto en la respuesta a su solicitud anterior. nextToken se devuelve cuando el número de resultados supera el valor de tamaño de página especificado. Para obtener la siguiente página de resultados, llame a la operación getReports e incluya este token como el único parámetro. Especificar nextToken con cualquier otro parámetro hará que la solicitud falle. | string | - |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | GetReportsResponse |
| 400 | La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 503 | Sobrecarga temporal o mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
POST /reports/2021-06-30/reports
Operación: createReport
Descripción
Crea un reporte.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.0167 | 15 |
El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Body | body requerido | Información necesaria para crear el reporte. | CreateReportSpecification |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 202 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | CrearReporteRespuesta |
| 400 | La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 503 | Sobrecarga temporal o mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
GET /reports/2021-06-30/reports/{reportId}
Operación: getReport
Descripción
Devuelve detalles del reporte (incluido reportDocumentId, si está disponible) para el reporte que especifique.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 2 | 15 |
El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | reportId requerido | El identificador del reporte. Este identificador es único solo en combinación con una seller ID. | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Report |
| 400 | La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 503 | Sobrecarga temporal o mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
DELETE /reports/2021-06-30/reports/{reportId}
Operación: cancelReport
Descripción
Cancela el reporte que especifique. Solo se pueden cancelar los reportes con processingStatus=IN_QUEUE. Los reportes cancelados se devuelven en llamadas posteriores a las operaciones getReport y getReports.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.0222 | 10 |
El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | reportId requerido | El identificador del reporte. Este identificador es único solo en combinación con una seller ID. | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Sin contenido |
| 400 | La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 503 | Sobrecarga temporal o mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
GET /reports/2021-06-30/schedules
Operación: getReportSchedules
Descripción
Devuelve detalles de programación de reportes que coinciden con los filtros que especifique.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.0222 | 10 |
El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Query | reportType requerido | Una lista de reportType utilizados para filtrar programaciones de reportes. Consulte Valores de reportType para obtener más información. Recuento mínimo : 1 Número máximo : 10 | < string > array |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | ReportScheduleList |
| 400 | La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 503 | Sobrecarga temporal o mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
POST /reports/2021-06-30/schedules
Operación: crearReportSchedule
Descripción
Crea un calendario de reportes. Si ya existe un cronograma de reportes con el mismo reportType y ID de marketplace, se cancelará y se reemplazará por este.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.0222 | 10 |
El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Esquema |
|---|---|---|
| Body | body requerido | CreateReportScheduleSpecification |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 201 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | CreateReportScheduleResponse |
| 400 | La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 503 | Sobrecarga temporal o mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
GET /reports/2021-06-30/schedules/{reportScheduleId}
Operación: getReportSchedule
Descripción
Devuelve los detalles de la programación de reportes para la programación de reportes que especifique.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.0222 | 10 |
El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | reportScheduleId requerido | El identificador de la programación del reporte. Este identificador es único solo en combinación con una seller ID. | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | ReportSchedule |
| 400 | La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 503 | Sobrecarga temporal o mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
DELETE /reports/2021-06-30/schedules/{reportScheduleId}
Operación: cancelReportSchedule
Descripción
Cancela la programación del reporte que especifique.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.0222 | 10 |
El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | reportScheduleId requerido | El identificador de la programación del reporte. Este identificador es único solo en combinación con una seller ID. | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Sin contenido |
| 400 | La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
| 503 | Sobrecarga temporal o mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string) : Identificador de referencia de solicitud único. | Lista de errores |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
GET /reports/2021-06-30/documents/{reportDocumentId}
Operación: getReportDocument
Descripción
Devuelve la información necesaria para recuperar el contenido de un documento de reporte.
Plan de uso:
| Tasa (solicitudes por segundo) | Explosión |
|---|---|
| 0.0167 | 15 |
El x-amzn-RateLimit-Limit El header de respuesta devuelve los límites de tarifa del plan de uso que se aplicaron a la operación solicitada, cuando estén disponibles. La tabla anterior indica la tasa predeterminada y los valores de ráfaga para esta operación. Los Selling partners cuyas demandas comerciales requieren un mayor rendimiento pueden ver valores de tasa y ráfaga más altos que los que se muestran aquí. Para obtener más información, consulte Planes de uso y límites de tarifas en la Selling Partner API .
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Path | reportDocumentId requerido | El identificador del documento de reporte. | string |
Respuestas
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 200 | Éxito. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | ReportDocument |
| 400 | La solicitud tiene parámetros faltantes o no válidos y no se puede analizar. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | Lista de errores |
| 401 | El header de autorización de la solicitud no tiene el formato correcto o no contiene un token válido. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | Lista de errores |
| 403 | Indica que el acceso al recurso está prohibido. Los posibles motivos incluyen acceso denegado, no autorizado, token caducado o firma no válida. Headers : x-amzn-RequestId (string): ID de referencia de solicitud única. | Lista de errores |
| 404 | El recurso especificado no existe. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. x-amzn-RequestId (string): ID de referencia de solicitud única. | Lista de errores |
| 429 | La frecuencia de las solicitudes fue mayor a la permitida. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | Lista de errores |
| 500 | Ocurrió una condición inesperada que impidió que el servidor cumpliera con la solicitud. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | Lista de errores |
| 503 | Sobrecarga temporal o mantenimiento del servidor. Headers : x-amzn-RateLimit-Limit (string) : Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): ID de referencia de solicitud única. | Lista de errores |
Para códigos de estado de error, descripciones y esquemas adicionales, consulte Respuestas y esquemas de error .
Respuestas de error y esquemas
Esta tabla contiene códigos de estado HTTP e información asociada para respuestas de error.
| Código HTTP | Descripción | Esquema |
|---|---|---|
| 415 | El header de tipo de contenido de la solicitud no es válido. Headers : x-amzn-RateLimit-Limit (string): Su límite de velocidad (solicitudes por segundo) para esta operación. Nota: Para este código de estado, el header de límite de tasa está obsoleto y ya no se devuelve. x-amzn-RequestId (string): Identificador de referencia de solicitud único. | Lista de errores |
Definiciones
Lista de errores
Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente.
Error
Respuesta de error devuelta cuando la solicitud no tiene éxito.
| Nombre | Descripción | Esquema |
|---|---|---|
| código requerido | Un código de error que identifica el tipo de error que ocurrió. | string |
| mensaje requerido | Un mensaje que describe la condición de error en un formato legible por humanos. | string |
| detalles opcional | Detalles adicionales que pueden ayudar a la persona que llama a comprender o solucionar el problema. | string |
Report
Información detallada sobre el reporte.
| Nombre | Descripción | Esquema |
|---|---|---|
| marketplaceIds opcional | Una lista de identificadores de marketplace para el reporte. | < string > array |
| reportId requerido | El identificador del reporte. Este identificador es único solo en combinación con una seller ID. | string |
| reportType requerido | El reportType. Consulte Valores de reportType para obtener más información. | string |
| dataStartTime opcional | El inicio de un rango de fechas y horas utilizado para seleccionar los datos para informar. | string (date-time) |
| dataEndTime opcional | El final de un rango de fechas y horas utilizado para seleccionar los datos para informar. | string (date-time) |
| reportScheduleId opcional | El identificador de la programación del reporte que creó este reporte (si existe). Este identificador es único solo en combinación con una seller ID. | string |
| createdTime requerido | La fecha y hora en que se creó el reporte. | string (date-time) |
| processingStatus requerido | El estado de procesamiento del reporte. | enum ( processingStatus ) |
| processingStartTime opcional | La fecha y la hora en que comenzó el procesamiento del reporte, en formato de fecha y hora ISO 8601. | string (date-time) |
| processingEndTime opcional | La fecha y la hora en que se completó el procesamiento del reporte, en formato de fecha y hora ISO 8601. | string (date-time) |
| reportDocumentId opcional | El identificador del documento de reporte. Pase esto a la operación getReportDocument para obtener la información que necesitará para recuperar el contenido del documento del reporte. | string |
ReportList
Una lista de reportes.
CreateReportScheduleSpecification
| Nombre | Descripción | Esquema |
|---|---|---|
| reportType requerido | El reportType. Consulte Valores de reportType para obtener más información. | string |
| marketplaceIds requerido | Una lista de identificadores de marketplace para el calendario de reportes. | < string > array |
| reportOptions opcional | Información adicional pasada a reportes. Esto varía según el reportType. | ReportOptions |
| period requerido | Uno de un conjunto de períodos ISO 8601 predefinidos que especifica la frecuencia con la que se debe crear un reporte. | enum ( Period ) |
| nextReportCreationTime opcional | La fecha y la hora en que la programación creará su próximo reporte, en formato de fecha y hora ISO 8601. | string (date-time) |
CreateReportSpecification
Información necesaria para crear el reporte.
| Nombre | Descripción | Esquema |
|---|---|---|
| reportOptions opcional | Información adicional pasada a reportes. Esto varía según el reportType. | ReportOptions |
| reportType requerido | El reportType. Consulte Valores de reportType para obtener más información. | string |
| dataStartTime opcional | El inicio de un rango de fecha y hora, en formato de fecha y hora ISO 8601, que se utiliza para seleccionar los datos para informar. El valor predeterminado es ahora. El valor debe ser anterior o igual a la fecha y hora actual. No todos los reportType hacen uso de esto. | string (date-time) |
| dataEndTime opcional | El final de un rango de fecha y hora, en formato de fecha y hora ISO 8601, utilizado para seleccionar los datos para informar. El valor predeterminado es ahora. El valor debe ser anterior o igual a la fecha y hora actual. No todos los reportType hacen uso de esto. | string (date-time) |
| marketplaceIds requerido | Una lista de identificadores de marketplace. El contenido del documento del reporte incluirá datos de todos los marketplaces especificados, a menos que el reportType indique lo contrario. | < string > array |
ReportOptions
Información adicional pasada a reportes. Esto varía según el reportType.
Tipo : < string, string > mapa
ReportSchedule
Información detallada sobre la programación de un reporte.
| Nombre | Descripción | Esquema |
|---|---|---|
| reportScheduleId requerido | El identificador de la programación del reporte. Este identificador es único solo en combinación con una seller ID. | string |
| reportType requerido | El reportType. Consulte Valores de reportType para obtener más información. | string |
| marketplaceIds opcional | Una lista de identificadores de marketplace. El contenido del documento del reporte incluirá datos de todos los marketplaces especificados, a menos que el reportType indique lo contrario. | < string > array |
| reportOptions opcional | Información adicional pasada a reportes. Esto varía según el reportType. | ReportOptions |
| period requerido | Un valor de período ISO 8601 que indica la frecuencia con la que se debe crear un reporte. | string |
| nextReportCreationTime opcional | La fecha y la hora en que la programación creará su próximo reporte, en formato de fecha y hora ISO 8601. | string (date-time) |
ReportScheduleList
Una lista de programaciones de reportes.
| Nombre | Esquema |
|---|---|
| reportSchedules requerido | < Programación de reportes > array |
CreateReportResponse
esquema de respuesta.
| Nombre | Descripción | Esquema |
|---|---|---|
| reportId requerido | El identificador del reporte. Este identificador es único solo en combinación con una seller ID. | string |
GetReportsResponse
La respuesta para la operación getReports.
| Nombre | Descripción | Esquema |
|---|---|---|
| reports requerido | los reportes | ReportList |
| nextToken opcional | Devuelto cuando el número de resultados supera el tamaño de página. Para obtener la siguiente página de resultados, llame a getReports con este token como único parámetro. | string |
CreateReportScheduleResponse
esquema de respuesta.
| Nombre | Descripción | Esquema |
|---|---|---|
| reportScheduleId requerido | El identificador de la programación del reporte. Este identificador es único solo en combinación con una seller ID. | string |
ReportDocument
Información requerida para el documento de reporte.
| Nombre | Descripción | Esquema |
|---|---|---|
| reportDocumentId requerido | El identificador del documento de reporte. Este identificador es único solo en combinación con una seller ID. | string |
| URL requerido | Una URL prefirmada para el documento del reporte. Si compressionAlgorithm no se devuelve, puede descargar el reporte directamente desde esta URL. Esta URL caduca después de 5 minutos. | string |
| compressionAlgorithm opcional | Si el contenido del documento del reporte se comprimió, el algoritmo de compresión utilizado se devuelve en esta propiedad y debe descomprimir el reporte cuando lo descarga. De lo contrario, puede descargar el reporte directamente. Consulte el Paso 2. Descargue el reporte en la guía de casos de uso, donde se proporciona un código de muestra. | enum ( CompressionAlgorithm ) |
ProcessingStatuses
Tipo : enum
| Valor | Descripción |
|---|---|
| CANCELLED | El reporte fue cancelado. Hay dos formas de cancelar un reporte: una solicitud de cancelación explícita antes de que el reporte comience a procesarse o una cancelación automática si no hay datos para devolver. |
| DONE | El reporte ha terminado de procesarse. |
| FATAL | El reporte fue abortado debido a un error fatal. |
| IN_PROGRESS | El reporte está siendo procesado. |
| IN_QUEUE | El reporte aún no ha comenzado a procesarse. Puede estar esperando otro reporte IN_PROGRESS. |
Period
Uno de un conjunto de períodos ISO 8601 predefinidos que especifica la frecuencia con la que se debe crear un reporte.
Tipo : enum
| Valor | Descripción |
|---|---|
| PT5M | 5 minutos |
| PT15M | 15 minutos |
| PT30M | 30 minutos |
| PT1H | 1 hora |
| PT2H | 2 horas |
| PT4H | 4 horas |
| PT8H | 8 horas |
| PT12H | 12 horas |
| P1D | 1 día |
| P2D | 2 dias |
| P3D | 3 dias |
| PT84H | 84 horas |
| P7D | 7 dias |
| P14D | 14 dias |
| P15D | 15 dias |
| P18D | 18 dias |
| P30D | 30 dias |
| P1M | 1 mes |
ProcessingStatus
El estado de procesamiento del reporte.
Tipo : enum
| Valor | Descripción |
|---|---|
| CANCELLED | El reporte fue cancelado. Hay dos formas de cancelar un reporte: una solicitud de cancelación explícita antes de que el reporte comience a procesarse o una cancelación automática si no hay datos para devolver. |
| DONE | El reporte ha terminado de procesarse. |
| FATAL | El reporte fue abortado debido a un error fatal. |
| IN_PROGRESS | El reporte está siendo procesado. |
| IN_QUEUE | El reporte aún no ha comenzado a procesarse. Puede estar esperando otro reporte IN_PROGRESS. |
CompressionAlgorithm
Si el contenido del documento del reporte se comprimió, el algoritmo de compresión utilizado se devuelve en esta propiedad y debe descomprimir el reporte cuando lo descarga. De lo contrario, puede descargar el reporte directamente. Consulte el Paso 2. Descargue el reporte en la guía de casos de uso, donde se proporciona un código de muestra.
Tipo : enum
| Valor | Descripción |
|---|---|
| GZIP | El algoritmo de compresión gzip. |
Updated over 1 year ago