Referências

Especificações da API

Recupere e gerencie uma variedade de relatórios que podem ajudar os parceiros de vendas a gerenciar seus negócios.

developer-docs.amazon.com

Reports API v2021-06-30 reference

Casos de uso

Como obter relatórios da Amazon para ajudar os parceiros de vendas a gerenciar seus negócios.

developer-docs.amazon.com

Reports API v2021-06-30 Use Case Guide

Definições

Respostas de erro e Schemas

Esta tabela contém códigos de status HTTP e informações associadas para respostas de erro.

Código HTTP	Descrição	Schema
415	O cabeçalho Content-Type da solicitação é inválido. Headers: x-amzn-RateLimit-Limit (string): Seu limite de taxa (solicitações por segundo) para esta operação. Observação: para este código de status, o cabeçalho do limite de taxa foi preterido e não é mais retornado. x-amzn-RequestId (string): identificador de referência de solicitação exclusivo.	ErrorList

ErrorList

Uma lista de respostas de erro retornadas quando uma solicitação não é bem-sucedida.

Nome	Schema
errors Obrigatório	< Error > array

Error

Resposta de erro retornada quando a solicitação não é bem-sucedida.

Nome	Descrição	Schema
code Obrigatório	Um código de erro que identifica o tipo de erro que ocorreu.	string
message Obrigatório	Uma mensagem que descreve a condição de erro em um formato legível.	string
details	Detalhes adicionais que podem ajudar o chamador a entender ou corrigir o problema.	string

Report

Informações detalhadas sobre o relatório.

Nome	Descrição	Schema
marketplaceIds	Uma lista de identificadores de mercado para o relatório.	< string > array
reportId Obrigatório	O identificador do relatório. Esse identificador é exclusivo apenas em combinação com um ID de vendedor.	string
reportType Obrigatório	O tipo de relatório.	string
dataStartTime	O início de um intervalo de data e hora usado para selecionar os dados a serem relatados.	string (date-time)
dataEndTime	O fim de um intervalo de data e hora usado para selecionar os dados a serem relatados.	string (date-time)
reportScheduleId	O identificador da programação de relatórios que criou este relatório (se houver). Esse identificador é exclusivo apenas em combinação com um ID de vendedor.	string
createdTime Obrigatório	A data e hora em que o relatório foi criado.	string (date-time)
processingStatus Obrigatório	O status de processamento do relatório.	enum (ProcessingStatus)
processingStartTime	A data e hora em que o processamento do relatório foi iniciado, no formato de data e hora ISO 8601.	string (date-time)
processingEndTime	A data e hora em que o processamento do relatório foi concluído, no formato de data e hora ISO 8601.	string (date-time)
reportDocumentId	O identificador do documento de relatório. Passe isso para a operação getReportDocument para obter as informações necessárias para recuperar o conteúdo do documento de relatório.	string

ReportList

Uma lista de relatórios.
Tipo : < Report > array

CreateReportScheduleSpecification

Nome	Descrição	Schema
reportType Obrigatório	O tipo de relatório.	string
marketplaceIds Obrigatório	Uma lista de identificadores de mercado para a programação de relatórios.	< string > array
reportOptions	Informações adicionais passadas aos relatórios. Isso varia de acordo com o tipo de relatório.	ReportOptions
period Obrigatório	Um de um conjunto de períodos ISO 8601 predefinidos que especifica com que frequência um relatório deve ser criado.	enum (Period)
nextReportCreationTime	A data e hora em que o agendamento criará seu próximo relatório, no formato de data e hora ISO 8601.	string (date-time)

CreateReportSpecification

Informações necessárias para criar o relatório.

Nome	Descrição	Schema
reportOptions	Informações adicionais passadas aos relatórios. Isso varia de acordo com o tipo de relatório.	ReportOptions
reportType Obrigatório	O tipo de relatório.	string
dataStartTime	O início de um intervalo de data e hora, no formato de data e hora ISO 8601, usado para selecionar os dados a serem relatados. O padrão é agora. O valor deve ser anterior ou igual à data e hora atuais. Nem todos os tipos de relatório fazem uso disso.	string (date-time)
dataEndTime	O fim de um intervalo de data e hora, no formato de data e hora ISO 8601, usado para selecionar os dados a serem relatados. O padrão é agora. O valor deve ser anterior ou igual à data e hora atuais. Nem todos os tipos de relatório fazem uso disso.	string (date-time)
marketplaceIds Obrigatório	Uma lista de identificadores de mercado. O conteúdo do documento de relatório conterá dados para todos os mercados especificados, a menos que o tipo de relatório indique o contrário.	< string > array

ReportOptions

Informações adicionais passadas aos relatórios. Isso varia de acordo com o tipo de relatório.

Tipo : < string, string > map

ReportSchedule

Informações detalhadas sobre uma programação de relatório.

Nome	Descrição	Schema
reportScheduleId Obrigatório	O identificador para a programação do relatório. Esse identificador é exclusivo apenas em combinação com um ID de vendedor.	string
reportType Obrigatório	O tipo de relatório.	string
marketplaceIds	Uma lista de identificadores de mercado. O conteúdo do documento de relatório conterá dados para todos os mercados especificados, a menos que o tipo de relatório indique o contrário.	< string > array
reportOptions	Informações adicionais passadas aos relatórios. Isso varia de acordo com o tipo de relatório.	ReportOptions
period Obrigatório	Um valor de período ISO 8601 que indica com que frequência um relatório deve ser criado.	string
nextReportCreationTime	A data e hora em que o agendamento criará seu próximo relatório, no formato de data e hora ISO 8601.	string (date-time)

ReportScheduleList

Uma lista de agendamentos de relatórios.

Nome	Schema
reportSchedules Obrigatório	< ReportSchedule > array

CreateReportResponse

Esquema de resposta.

Nome	Descrição	Schema
reportId Obrigatório	O identificador do relatório. Esse identificador é exclusivo apenas em combinação com um ID de vendedor.	string

GetReportsResponse

A resposta para a operação getReports.

Nome	Descrição	Schema
reports Obrigatório	Os relatórios.	ReportList
nextToken	Retornado quando o número de resultados excede pageSize. Para obter a próxima página de resultados, chame getReports com este token como o único parâmetro.	string

CreateReportScheduleResponse

Esquema de resposta.

Nome	Descrição	Schema
reportScheduleId Obrigatório	O identificador para a programação do relatório. Esse identificador é exclusivo apenas em combinação com um ID de vendedor.	string

ReportDocument

Informações necessárias para o documento de relatório.

Nome	Descrição	Schema
reportDocumentId Obrigatório	O identificador do documento de relatório. Esse identificador é exclusivo apenas em combinação com um ID de vendedor.	string
url Obrigatório	Um URL pré-assinado para o documento de relatório. Se o compressionAlgorithm não for retornado, você poderá baixar o relatório diretamente deste URL. Este URL expira após 5 minutos.	string
compressionAlgorithm	Se o conteúdo do documento do relatório tiver sido compactado, o algoritmo de compactação utilizado será retornado nesta propriedade e você deverá descompactar o relatório ao fazer o download. Caso contrário, você pode baixar o relatório diretamente. Consulte a Etapa 2. Faça download do relatório no guia de caso de uso, onde o código de amostra é fornecido.	enum (CompressionAlgorithm)

ProcessingStatuses

Tipo : enum

Valor	Descrição
CANCELLED	A reportagem foi cancelada. Há duas maneiras de cancelar um relatório: uma solicitação de cancelamento explícita antes do início do processamento do relatório ou um cancelamento automático se não houver dados a serem retornados.
DONE	O relatório concluiu o processamento.
FATAL	O relatório foi abortado devido a um erro fatal.
IN_PROGRESS	O relatório está sendo processado.
IN_QUEUE	O relatório ainda não começou a ser processado. Ele pode estar aguardando outro relatório IN_PROGRESS.

Period

Um de um conjunto de períodos ISO 8601 predefinidos que especifica com que frequência um relatório deve ser criado.

Tipo : enum

Valor	Descrição
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 dia
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 mês

ProcessingStatus

O status de processamento do relatório.

Tipo : enum

Valor	Descrição
CANCELLED	A reportagem foi cancelada. Há duas maneiras de cancelar um relatório: uma solicitação de cancelamento explícita antes do início do processamento do relatório ou um cancelamento automático se não houver dados a serem retornados.
DONE	O relatório concluiu o processamento.
FATAL	O relatório foi abortado devido a um erro fatal.
IN_PROGRESS	O relatório está sendo processado.
IN_QUEUE	O relatório ainda não começou a ser processado. Ele pode estar aguardando outro relatório IN_PROGRESS.

CompressionAlgorithm

Se o conteúdo do documento do relatório tiver sido compactado, o algoritmo de compactação utilizado será retornado nesta propriedade e você deverá descompactar o relatório ao fazer o download. Caso contrário, você pode baixar o relatório diretamente. Consulte a Etapa 2. Faça download do relatório no guia de caso de uso, onde o código de amostra é fornecido.

Tipo : enum

Valor	Descrição
GZIP	O algoritmo de compactação gzip.