Referencia de Reports API v2020-09-04
Recupere y administre una variedad de reportes que pueden ayudar a los selling partners a gestionar su negocio.
Descripción general
A partir del 27 de junio de 2023 , la Selling Partner API para Reports v2020-09-04 ya no estará disponible y todas las llamadas fallarán. Las integraciones que dependen de la API de Reportes deben migrar a Reports v2021-06-30 para evitar la interrupción del servicio.
Información de versión
Versión : 2020-09-04
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
Paths
GET /reports/2020-09-04/reports
Precaución :
Esta operación está en desuso.
Operación: getReports
Descripción
A partir del 27 de junio de 2023 , la operación getReports no estará disponible en la Selling Partner API para Reports v2020-09-04 y todas las llamadas fallarán. Las integraciones que dependen de esta operación deben migrar a Reports v2021-06-30 para evitar la interrupción del servicio.
Parámetros
| Tipo | Nombre | Descripción | Esquema | Por defecto |
|---|---|---|---|---|
| Query | reportTypes opcional | Una lista de reportTypes usados para filtrar Reports. Cuando se proporciona reportTypes, también se pueden proporcionar los otros parámetros de filtro (processingStatuses, marketplaceIds, createdSince, createdUntil) y pageSize. Se requiere reportTypes 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 Reports. Recuento mínimo : 1 | < enum ( processingStatuses ) > array | - |
| Query | marketplaceIds opcional | Una lista de identificadores de marketplace utilizados para filtrar Reports. Los Reports 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 Reports para devolver en una sola llamada. Mínimo : 1 Máximo : 100 | integer | 10 |
| Query | createdSince opcional | La primera fecha y hora de creación del reporte para que los Reports se incluyan en la respuesta, en formato de fecha y hora ISO 8601. El valor predeterminado es hace 90 días. Los Reports 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 Reports 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. | GetReportsResponse |
| 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 Note: 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. | GetReportsResponse |
| 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. | GetReportsResponse |
| 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. | GetReportsResponse |
| 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 Note: 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. | GetReportsResponse |
| 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 Note: 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. | GetReportsResponse |
| 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 Note: 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. | GetReportsResponse |
| 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 Note: 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. | GetReportsResponse |
POST /reports/2020-09-04/reports
Precaución :
Esta operación está en desuso.
Operación: createReport
Descripción
A partir del 27 de junio de 2023 , la operación createReport no estará disponible en la Selling Partner API for Reports v2020-09-04 y todas las llamadas fallarán. Las integraciones que dependen de esta operación deben migrar a Reports v2021-06-30 para evitar la interrupción del servicio.
Parámetros
| Tipo | Nombre | Esquema |
|---|---|---|
| Body | body requerido | 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. | CrearReporteRespuesta |
| 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 Note: 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. | CrearReporteRespuesta |
| 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. | CrearReporteRespuesta |
| 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. | CrearReporteRespuesta |
| 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 Note: 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. | CrearReporteRespuesta |
| 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 Note: 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. | CrearReporteRespuesta |
| 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 Note: 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. | CrearReporteRespuesta |
| 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 Note: 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. | CrearReporteRespuesta |
GET /reports/2020-09-04/reports/{reportId}
Precaución :
Esta operación está en desuso.
Operación: getReport
Descripción
A partir del 27 de junio de 2023 , el getReport no estará disponible en la Selling Partner API for Reports v2020-09-04 y todas las llamadas fallarán. Las integraciones que dependen de esta operación deben migrar a Reports v2021-06-30 para evitar la interrupción del servicio.
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. | GetReportResponse |
| 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. | GetReportResponse |
| 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 Note: 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. | GetReportResponse |
| 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. | GetReportResponse |
| 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. | GetReportResponse |
| 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. | GetReportResponse |
| 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. | GetReportResponse |
| 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. | GetReportResponse |
| 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. | GetReportResponse |
DELETE /reports/2020-09-04/reports/{reportId}
Precaución :
Esta operación está en desuso.
Operación: cancelReport
Descripción
A partir del 27 de junio de 2023 , el cancelReport no estará disponible en la Selling Partner API para Reports v2020-09-04 y todas las llamadas fallarán. Las integraciones que dependen de esta operación deben migrar a Reports v2021-06-30 para evitar la interrupción del servicio.
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. | CancelReportResponse |
| 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. | CancelReportResponse |
| 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. | CancelReportResponse |
| 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. | CancelReportResponse |
| 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. | CancelReportResponse |
| 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. | CancelReportResponse |
| 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. | CancelReportResponse |
| 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. | CancelReportResponse |
| 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. | CancelReportResponse |
GET /reports/2020-09-04/schedules
Precaución :
Esta operación está en desuso.
Operación: getReportSchedules
Descripción
A partir del 27 de junio de 2023 , el getReportSchedules no estará disponible en la Selling Partner API para Reports v2020-09-04 y todas las llamadas fallarán. Las integraciones que dependen de esta operación deben migrar a Reports v2021-06-30 para evitar la interrupción del servicio.
Parámetros
| Tipo | Nombre | Descripción | Esquema |
|---|---|---|---|
| Query | reportTypes requerido | Una lista de reportTypes utilizados para filtrar programaciones de Reports. 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. | GetReportSchedulesResponse |
| 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. | GetReportSchedulesResponse |
| 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. | GetReportSchedulesResponse |
| 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. | GetReportSchedulesResponse |
| 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. | GetReportSchedulesResponse |
| 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. | GetReportSchedulesResponse |
| 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. | GetReportSchedulesResponse |
| 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. | GetReportSchedulesResponse |
| 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. | GetReportSchedulesResponse |
POST /reports/2020-09-04/schedules
Precaución :
Esta operación está en desuso.
Operación: createReportSchedule
Descripción
A partir del 27 de junio de 2023 , el createReportSchedule no estará disponible en la Selling Partner API para Reports v2020-09-04 y todas las llamadas fallarán. Las integraciones que dependen de esta operación deben migrar a Reports v2021-06-30 para evitar la interrupción del servicio.
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. | CreateReportScheduleResponse |
| 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. | CreateReportScheduleResponse |
| 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. | CreateReportScheduleResponse |
| 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. | CreateReportScheduleResponse |
| 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. | CreateReportScheduleResponse |
| 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. | CreateReportScheduleResponse |
| 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. | CreateReportScheduleResponse |
| 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. | CreateReportScheduleResponse |
GET /reports/2020-09-04/schedules/{reportScheduleId}
Precaución :
Esta operación está en desuso.
Operación: getReportSchedule
Descripción
A partir del 27 de junio de 2023 , el getReportSchedule no estará disponible en la Selling Partner API para Reports v2020-09-04 y todas las llamadas fallarán. Las integraciones que dependen de esta operación deben migrar a Reports v2021-06-30 para evitar la interrupción del servicio.
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. | GetReportScheduleResponse |
| 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. | GetReportScheduleResponse |
| 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. | GetReportScheduleResponse |
| 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. | GetReportScheduleResponse |
| 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. | GetReportScheduleResponse |
| 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. | GetReportScheduleResponse |
| 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. | GetReportScheduleResponse |
| 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. | GetReportScheduleResponse |
| 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. | GetReportScheduleResponse |
DELETE /reports/2020-09-04/schedules/{reportScheduleId}
Precaución :
Esta operación está en desuso.
Operación: cancelReportSchedule
Descripción
A partir del 27 de junio de 2023 , el cancelReportSchedule no estará disponible en la Selling Partner API para Reports v2020-09-04 y todas las llamadas fallarán. Las integraciones que dependen de esta operación deben migrar a Reports v2021-06-30 para evitar la interrupción del servicio.
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. | CancelReportScheduleResponse |
| 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. | CancelReportScheduleResponse |
| 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. | CancelReportScheduleResponse |
| 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. | CancelReportScheduleResponse |
| 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. | CancelReportScheduleResponse |
| 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. | CancelReportScheduleResponse |
| 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. | CancelReportScheduleResponse |
| 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. | CancelReportScheduleResponse |
| 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. | CancelReportScheduleResponse |
GET /reports/2020-09-04/documents/{reportDocumentId}
Precaución :
Esta operación está en desuso.
Operación: getReportDocument
Descripción
A partir del 27 de junio de 2023 , el getReportDocument no estará disponible en la Selling Partner API para Reports v2020-09-04 y todas las llamadas fallarán. Las integraciones que dependen de esta operación deben migrar a Reports v2021-06-30 para evitar la interrupción del servicio.
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. | GetReportDocumentResponse |
| 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. | GetReportDocumentResponse |
| 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. | GetReportDocumentResponse |
| 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. | GetReportDocumentResponse |
| 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. | GetReportDocumentResponse |
| 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. | GetReportDocumentResponse |
| 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. | GetReportDocumentResponse |
| 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. | GetReportDocumentResponse |
| 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. | GetReportDocumentResponse |
Definiciones
ErrorList
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 |
ReportDocumentEncryptionDetails
Detalles de cifrado necesarios para descifrar el contenido de un documento de reporte.
| Nombre | Descripción | Esquema |
|---|---|---|
| standard requerido | El standard de cifrado requerido para descifrar el contenido del documento. | enum ( standard ) |
| initializationVector requerido | El vector para descifrar el contenido del documento utilizando Cipher Block Chaining (CBC). | string |
| key requerido | La clave de cifrado utilizada para descifrar el contenido del documento. | string |
Report
| 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. | 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 y descifrar el contenido del documento del reporte. | string |
ReportList
CreateReportScheduleSpecification
| Nombre | Descripción | Esquema |
|---|---|---|
| reportType requerido | El reportType. | string |
| marketplaceIds requerido | Una lista de identificadores de marketplace para el calendario de Reports. | < string > array |
| reportOptions opcional | Información adicional pasada a Reports. 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
| Nombre | Descripción | Esquema |
|---|---|---|
| reportOptions opcional | Información adicional pasada a Reports. Esto varía según el reportType. | reportOptions |
| reportType requerido | El reportType. | 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 reportTypes 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 reportTypes 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 Reports. 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. | 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 Reports. Esto varía según el reportType. | reportOptions |
| period requerido | Un valor de period 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
CreateReportResult
| 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 |
|---|---|---|
| payload opcional | payload para la operación getReports. | ReportList |
| ficha siguiente 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 |
| errores opcional | Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente. | ErrorList |
CreateReportResponse
La respuesta para la operación createReport.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | payload para la operación createReport. | CreateReportResult |
| errores opcional | Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente. | ErrorList |
CancelReportResponse
La respuesta para la operación cancelReport.
| Nombre | Descripción | Esquema |
|---|---|---|
| errores opcional | Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente. | ErrorList |
CancelReportScheduleResponse
La respuesta para la operación cancelReportSchedule.
| Nombre | Descripción | Esquema |
|---|---|---|
| errores opcional | Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente. | ErrorList |
GetReportResponse
La respuesta para la operación getReport.
GetReportSchedulesResponse
La respuesta para la operación getReportSchedules.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | payload para la operación getReportSchedules. | ReportScheduleList |
| errores opcional | Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente. | ErrorList |
GetReportScheduleResponse
La respuesta para la operación getReportSchedule.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | payload para la operación getReportSchedule. | ReportSchedule |
| errores opcional | Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente. | ErrorList |
CreateReportScheduleResult
| 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 |
CreateReportScheduleResponse
La respuesta para la operación createReportSchedule.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | payload para la operación createReportSchedule. | CreateReportScheduleResult |
| errores opcional | Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente. | ErrorList |
ReportDocument
| 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 |
| encryptionDetails requerido | Detalles de cifrado necesarios para descifrar el contenido de un documento de reporte. | ReportDocumentEncryptionDetails |
| compressionAlgorithm opcional | Si el contenido del documento del reporte se comprimió, el compressionAlgorithm 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 y descifre el reporte en la guía de casos de uso, donde se proporciona un código de muestra. | enum ( compressionAlgorithm ) |
GetReportDocumentResponse
esquema de respuesta.
| Nombre | Descripción | Esquema |
|---|---|---|
| payload opcional | - | ReportDocument |
| errores opcional | Una lista de respuestas de error devueltas cuando una solicitud no se realiza correctamente. | ErrorList |
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 días |
| P3D | 3 días |
| PT84H | 84 horas |
| P7D | 7 días |
| P14D | 14 dias |
| P15D | 15 días |
| P18D | 18 dias |
| P30D | 30 dias |
| P1M | 1 mes |
Standard
El standard de cifrado requerido para descifrar el contenido del documento.
Tipo : enum
| Valor | Descripción |
|---|---|
| AES | El Advanced Encryption Standard (AES). |
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 compressionAlgorithm 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 y descifre 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 about 2 years ago
