Guia de uso
Como assinar notificações relevantes para os negócios de um parceiro de vendas.
API Version: v1
O que é a API de Notificações?
A API do parceiro de vendas para notificações permite que você assine notificações relevantes para os negócios de um parceiro de vendas. Usando essa API, você pode criar um destino para receber notificações, assinar notificações, excluir assinaturas de notificações e muito mais. Em vez de pesquisar informações, seu aplicativo pode receber informações diretamente da Amazon quando um evento aciona uma notificação na qual você está inscrito.
Você pode assinar notificações em nome de vendedores ou vendedores. Para determinar se você pode assinar um tipo de notificação apenas em nome de vendedores, apenas de fornecedores ou ambos, vá para notificationType.
Terminologia
- Amazon EventBridge: um barramento de eventos sem servidor que conecta dados de aplicativos de seus próprios aplicativos, aplicativos integrados de software como serviço (SaaS) e serviços da AWS. Para obter mais informações, consulte Amazon EventBridge.
- Amazon Simple Queue Service (Amazon SQS): um serviço de enfileiramento de mensagens totalmente gerenciado para microsserviços, sistemas distribuídos e aplicativos sem servidor. Para obter mais informações, consulte Amazon Simple Queue Service.
- Partner event source: usado por um parceiro da AWS para enviar eventos para uma conta de cliente da AWS. Para receber esses eventos, o cliente deve associar um barramento de eventos à fonte de eventos do parceiro. Para obter mais informações, consulte O que é o Amazon EventBridge?
- Event bus: recebe eventos de uma origem e os roteia para recursos de destino de acordo com as regras associadas ao barramento de eventos. Para obter mais informações, consulte EventBus.
Fluxos de Notificação
Existem dois fluxos de trabalho separados para receber notificações. O fluxo de trabalho que você usa depende do tipo de notificação que você deseja receber.
Fluxo Amazon EventBridge
Use este fluxo de trabalho para receber os seguintes tipos de notificação:
-
BRANDED_ITEM_CONTENT_CHANGE. Enviado sempre que houver uma alteração no título, descrição, marcadores ou imagens, para qualquer ASIN com o qual o parceiro de vendas tenha um relacionamento com a marca.
-
ITEM_PRODUCT_TYPE_CHANGE. Enviado sempre que houver uma alteração no nome do tipo de produto de qualquer ASIN com o qual o parceiro de vendas tenha um relacionamento de marca.* LISTINGS_ITEM_STATUS_CHANGE. Enviado sempre que houver uma alteração no status da listagem, incluindo transição comprável, criação ou exclusão de listagem para qualquer SKU que o parceiro de vendas tenha.
-
LISTINGS_ITEM_ISSUES_CHANGE. Enviado sempre que houver uma alteração de problemas para qualquer SKU que o parceiro de vendas tenha.
-
PRODUCT_TYPE_DEFINITIONS_CHANGE. Enviado sempre que houver um novo Tipo de Produto ou Versão de Tipo de Produto.
Fluxo Amazon Simple Queue Service
Use este fluxo de trabalho para receber os seguintes tipos de notificação:
-
ACCOUNT_STATUS_CHANGED. Enviado sempre que o Status da conta muda para os pares de comerciante/mercado inscritos pelos desenvolvedores. Uma notificação é publicada sempre que o status da conta do comerciante muda entre NORMAL, AT_RISK e DEACTIVATED.
-
ANY_OFFER_CHANGED. Enviado sempre que houver uma alteração em qualquer uma das 20 principais ofertas, por condição (novo ou usado), ou se o preço externo (o preço de outros varejistas) mudar para um item listado pelo vendedor.
-
B2B_ANY_OFFER_CHANGED. Enviado sempre que houver uma alteração em qualquer uma das 20 principais ofertas B2B, na forma de qualquer alteração de preço (seja por unidade única ou preços de nível de desconto por quantidade) para um item listado pelo vendedor.
-
FBA_OUTBOUND_SHIPMENT_STATUS. Enviado sempre que criamos ou cancelamos uma remessa do Fulfillment by Amazon para um vendedor.* FEE_PROMOTION. Enviado quando uma promoção se torna ativa.
-
FEED_PROCESSING_FINISHED. Enviado sempre que qualquer feed enviado usando a Selling Partner API for Feeds atinge um status de processamento de feed CONCLUÍDO, CANCELADO ou FATAL.
-
FULFILLMENT_ORDER_STATUS. Enviado sempre que houver uma alteração no status de um pedido de atendimento multicanal.
-
MFN_ORDER_STATUS_CHANGE. Enviado sempre que houver alteração no status de disponibilidade de um pedido MFN.
-
ORDER_STATUS_CHANGE. Enviado sempre que houver alteração no status de disponibilidade do pedido.
-
PRICING_HEALTH. Enviado sempre que uma oferta do vendedor não é elegível para ser a Oferta em Destaque (oferta Buy Box) devido a um preço não competitivo.
-
REPORT_PROCESSING_FINISHED. Enviado sempre que qualquer relatório que você solicitou usando a API do parceiro de vendas para relatórios atingir um status de processamento de relatório de CONCLUÍDO, CANCELADO ou FATAL.
Consulte Tutorial: Configurar notificações (fluxo de trabalho do Amazon Simple Queue Service).
Tutorial: configurar notificações (fluxo do Amazon EventBridge)
Use este fluxo de trabalho para receber os seguintes tipos de notificação:
-
BRANDED_ITEM_CONTENT_CHANGE. Enviado sempre que houver uma alteração no título, descrição, marcadores ou imagens, para qualquer ASIN com o qual o parceiro de vendas tenha um relacionamento com a marca.
-
ITEM_PRODUCT_TYPE_CHANGE. Enviado sempre que houver uma alteração no nome do tipo de produto de qualquer ASIN com o qual o parceiro de vendas tenha um relacionamento de marca.
-
LISTINGS_ITEM_STATUS_CHANGE. Enviado sempre que houver uma alteração no status da listagem, incluindo transição comprável, criação ou exclusão de listagem para qualquer SKU que o parceiro de vendas tenha.
-
LISTINGS_ITEM_ISSUES_CHANGE. Enviado sempre que houver uma alteração de problemas para qualquer SKU que o parceiro de vendas tenha.
-
PRODUCT_TYPE_DEFINITIONS_CHANGE. Enviado sempre que houver um novo Tipo de Produto ou Versão de Tipo de Produto. Se você quiser receber qualquer outro tipo de notificação, ignore este tutorial e vá para Tutorial: Configurar notificações (fluxo do Amazon Simple Queue Service).
Pré-requisitos
Para concluir este tutorial, você precisará de:
-
Autorização dos parceiros de vendas (vendedores ou vendedores) para os quais você está fazendo chamadas. Consulte o Guia do desenvolvedor da API Selling Partner para obter mais informações.
-
Uma conta da AWS. Essa conta da AWS será responsável pelas cobranças relacionadas ao recebimento de notificações. Se você ainda não é cliente da AWS, pode criar uma conta gratuita da AWS. Para obter mais informações, consulte Nível gratuito da AWS.
-
Um recurso de destino para receber eventos de notificação. Para obter mais informações, consulte O que é o Amazon EventBridge?
-
Uma compreensão básica do Amazon EventBridge. Para obter mais informações, consulte Amazon EventBridge.
Etapa 1. Crie um destino
Chame a operação createDestination para criar um destino do Amazon EventBridge.Observação: você só pode criar um destino EventBridge por conta da AWS. * Chame a operação createDestination, passando os seguintes parâmetros do corpo:
Parametro | Descrição | Requerido |
---|---|---|
resourceSpecification | As informações necessárias para criar um recurso de destino. Neste fluxo de trabalho, inclua a especificação eventBridge. Tipo: resourceSpecification | Sim |
name | Um nome definido pelo desenvolvedor para ajudar a identificar esse destino. Tipo: string | Sim |
Observação: Chamar a operação createDestination não requer autorização de nenhum parceiro de vendas. A esse respeito, esta operação é uma operação "sem concessão" e possui um modelo de autorização diferente da maioria das outras operações da API do Parceiro de Vendas. Para obter mais informações, consulte Operações Grantless no Guia do desenvolvedor da API do parceiro de vendas.Exemplo de solicitação:
POST https://sellingpartnerapi-na.amazon.com/notifications/v1/destinations
{
"resourceSpecification":
{
"eventBridge":
{
"accountId": "123456789",
"region": "us-east-1"
}
},
"name": "YourDestinationName"
}
Resposta Uma resposta bem-sucedida inclui o seguinte:
Nome | Descrição |
---|---|
resource | O recurso que receberá notificações associadas a este destino. Tipo: DestinationResource |
destinationId | O identificador de destino gerado quando você criou o destino. Tipo: string |
name | O nome deste destino. Tipo: string |
Exemplo de resposta:
{
"payload": {
"resource": {
"sqs": null,
"eventBridge": {
"name": "sellingpartnerapi.amazon.com/amzn1.sellerapps.app.15a75829-cd4a-4efc-b947-0cc39d874577",
"accountId": "123456789",
"region": "us-east-1"
}
},
"destinationId": "64a4a891-60dd-303f-89f9-43caf25cb3ec",
"name": "YourDestinationName"
}
}
- Salve os seguintes valores: resource:eventBridge:name. Use esse valor na Etapa 2. Configure o Amazon EventBridge para lidar com notificações. destinationId. Passe esse valor na Etapa 4. Crie uma assinatura.
Etapa 2. Configure o Amazon EventBridge para lidar com notificações
Associe um barramento de eventos à fonte de eventos de seu parceiro. Para definições, consulte Terminologia.
-
Acesse o Amazon EventBridge e faça login no Console AWS usando o ID da conta da AWS que você especificou quando chamou a operação createDestination na Etapa 1. Crie um destino.
-
No console, verifique se a região da AWS que você especificou ao chamar a operação createDestination está selecionada.
-
No painel de navegação, clique em Fontes de eventos do parceiro.
-
Na área Origens do evento do parceiro, em Nome, clique na origem do evento do parceiro que corresponde ao valor resource:eventBridge:name retornado na Etapa 1. Crie um destino. A origem do evento do parceiro está neste formato: aws.partner/sellingpartnerapi.amazon.com/{ID da conta da AWS}/{ID do aplicativo}
-
Na nova página exibida, clique no botão Associar ao barramento de eventos.
-
Na página Associar ao barramento de eventos, deixe as caixas de seleção desmarcadas e clique no botão Associar.
-
Você criou um barramento de eventos do parceiro e o associou à sua fonte de eventos do parceiro. Vá para a Etapa 3. Crie uma regra que acione um evento de notificação.
Etapa 3. Crie uma regra que seja acionada em um evento de notificação
Crie uma regra que observe eventos de notificação específicos e os roteie para o recurso de destino de sua escolha.
-
Acesse Amazon Amazon EventBridge . Se você ainda não estiver conectado ao Console AWS, faça login usando o ID da conta da AWS que você especificou quando chamou a operação createDestination na Etapa 1. Crie um destino.
-
No console, verifique se a região da AWS que você especificou ao chamar a operação createDestination está selecionada.
-
No painel de navegação, clique em Regras.
-
Clique no botão Criar regra.
-
Insira um nome e uma descrição opcional para a regra.
-
Na área Definir padrão, selecione Padrão de evento.
-
Selecione Padrão predefinido por serviço.
-
Em Provedor de serviço, selecione Parceiros de serviço.
-
Em Nome do serviço, selecione APIs de parceiros de vendas da Amazon.
O padrão de evento exibido deve ser semelhante ao seguinte, o que indica que você receberá todos os eventos emitidos por sellingpartnerapi.amazon.com:
{
"account": [
"1234567890"
]
}
- (Opcional) Edite o padrão de evento para incluir regras que correspondam apenas aos eventos de notificação que você deseja. O padrão de evento a seguir contém uma regra que corresponde apenas a eventos BRANDED_ITEM_CONTENT_CHANGE de sellingpartnerapi.amazon.com:
{
"account": [
"1234567890"
],
"detail-type": [
"BRANDED_ITEM_CONTENT_CHANGE"
]
}
Para obter informações sobre como criar regras mais complexas, consulte Event Patterns na documentação da AWS.
-
Na área selecionar event bus, selecione Custom or partner event bus e, em seguida, selecione o barramento de eventos do parceiro que você configurou na Etapa 2. Configure o Amazon EventBridge para lidar com notificações.
-
Na área Selecionar destinos, selecione o serviço da AWS que deve agir quando um evento do tipo selecionado for detectado. Insira outras informações específicas para este tipo de destino, se necessário.
-
Observação. Para muitos tipos de destino, o EventBridge precisa de permissões para enviar eventos ao destino. Nesses casos, você pode criar uma nova função do IAM ou usar uma função existente do IAM. Faça um dos seguintes:
- Para criar uma função do IAM, selecione Criar uma nova função para este recurso específico.
- Para usar uma função do IAM que você já criou, selecione Usar função existente.
-
(Opcional) Clique em Adicionar destino para adicionar outro destino para esta regra.
-
(Opcional) Insira uma ou mais tags para a regra. Para obter mais informações, consulte Marcar seus recursos do Amazon EventBridge na documentação da AWS.
Clique no botão Criar.
Solução de problemas:
-
Se você criar uma regra com uma fila do Amazon SQS criptografada como destino, deverá incluir uma ação de descriptografia em sua política de chaves do AWS Key Management Service para que o evento seja entregue com êxito à fila criptografada. Para obter mais informações, consulte Meus eventos não são entregues à fila de destino do Amazon SQS na documentação da AWS.
-
Para obter mais informações sobre solução de problemas, consulte Solução de problemas do Amazon EventBridge na documentação da AWS.
Etapa 4. Crie uma assinatura
Assine um tipo de notificação para ser entregue ao destino que você criou na Etapa 1. Crie um destino.
Observação: apenas uma assinatura por aplicativo, tipo de notificação e parte (vendedor/fornecedor) é permitida por região.
- Chame a operação createSubscription, passando os seguintes parâmetros:
Parâmetros no path:
Parâmetro | Descrição | Requerido |
---|---|---|
notificationType | O tipo de notificação que você deseja assinar. Valores possíveis: BRANDED_ITEM_CONTENT_CHANGE, ITEM_PRODUCT_TYPE_CHANGE, LISTINGS_ITEM_STATUS_CHANGE, LISTINGS_ITEM_ISSUES_CHANGE, PRODUCT_TYPE_DEFINITIONS_CHANGE. Consulte notificationType. Tipo: string | Sim |
Parâmetros no body:
Parâmetro | Descrição | Requerido |
---|---|---|
payloadVersion | A versão do objeto de carga útil a ser usada na notificação. | Sim |
destinationId | O identificador para o destino onde as notificações serão entregues. Use o valor destinationId que você salvou na Etapa 1. Crie um destino. Tipo: : string | Sim |
Exemplo de solicitação:
POST https://sellingpartnerapi-na.amazon.com/ notifications/v1/subscriptions/BRANDED_ITEM_CONTENT_CHANGE
{
"payloadVersion":"1.0",
"destinationId":"3acafc7e-121b-1329-8ae8-1571be663aa2"
}
Resposta
Nome | Descrição |
---|---|
subscriptionId | O identificador de assinatura gerado quando a assinatura é criada. Tipo: string |
payloadVersion | A versão do objeto de carga útil a ser usada na notificação. Tipo: string |
destinationId | O identificador para o destino onde as notificações serão entregues. Tipo: string |
Exemplo de resposta:
{
"payload":{
"subscriptionId":" 7fcacc7e-727b-11e9-8848-1681be663d3e",
"payloadVersion":" 1.0",
"destinationId":"3acafc7e-121b-1329-8ae8-1571be663aa2"
}
}
Você está inscrito para receber notificações de BRANDED_ITEM_CONTENT_CHANGE.
Tutorial: Configurar notificações (fluxo do Amazon Simple Queue Service)
Use este tutorial para configurar seu sistema para receber qualquer um dos seguintes tipos de notificações:
-
ACCOUNT_STATUS_CHANGED. Enviado sempre que o Status da conta muda para os pares de comerciante/mercado inscritos pelos desenvolvedores. Uma notificação é publicada sempre que o status da conta do comerciante muda entre NORMAL, AT_RISK e DEACTIVATED.
-
ANY_OFFER_CHANGED. Enviado sempre que houver uma alteração na listagem de qualquer uma das 20 principais ofertas, por condição (novo ou usado), ou se o preço externo (o preço de outros varejistas) for alterado para um item listado pelo vendedor.
Conceda permissão à API do parceiro de vendas para gravar em sua fila do SQS -
B2B_ANY_OFFER_CHANGED. Enviado sempre que houver uma alteração em qualquer uma das 20 principais ofertas B2B, na forma de qualquer alteração de preço (seja por unidade única ou preços de nível de desconto por quantidade) para um item listado pelo vendedor.
-
FBA_OUTBOUND_SHIPMENT_STATUS. Enviado sempre que criamos ou cancelamos uma remessa do Fulfillment by Amazon para um vendedor.
-
FEE_PROMOTION. Enviado quando uma promoção se torna ativa.
-
FEED_PROCESSING_FINISHED. Enviado sempre que qualquer feed enviado usando a Selling Partner API for Feeds atinge um status de processamento de feed CONCLUÍDO, CANCELADO ou FATAL.
-
FULFILLMENT_ORDER_STATUS. Enviado sempre que houver uma alteração no status de um pedido de atendimento multicanal.
-
MFN_ORDER_STATUS_CHANGE. Enviado sempre que houver alteração no status de disponibilidade de um pedido MFN.
-
ORDER_STATUS_CHANGE. Enviado sempre que houver alteração no status de disponibilidade do pedido.
-
PRICING_HEALTH](#pricing_health). Enviado sempre que uma oferta do vendedor não é elegível para ser a Oferta em Destaque (oferta Buy Box) devido a um preço não competitivo.
-
REPORT_PROCESSING_FINISHED. Enviado sempre que qualquer relatório que você solicitou usando a API do parceiro de vendas para relatórios atingir um status de processamento de relatório de CONCLUÍDO, CANCELADO ou FATAL.
Importante: para receber qualquer outro tipo de notificação, acesse Tutorial: Configurar notificações (fluxo de trabalho do Amazon EventBridge)
Pré-requisitos
Para concluir este tutorial, você precisará de:
-
Authorization from the selling partners for whom you are making calls. See the Selling Partner API Developer Guide for more information.
-
An AWS Account. If you are not already an AWS customer, you can create a free AWS account. For more information, see AWS Free Tier.
-
An Amazon Simple Queue Service (SQS) queue. For information about setting up an SQS queue, see Amazon Simple Queue Service.
Etapa 1. Conceda permissão à API do parceiro de vendas para gravar em sua fila do SQS
Para receber notificações, você deve conceder permissão à Selling Partner API para gravar em sua fila do SQS.
-
Abra o Console de gerenciamento da AWS e faça login com suas credenciais da AWS.
-
No console, abra o Simple Queue Service.
-
Selecione a fila Padrão onde você deseja receber notificações.
-
Escolha a guia Política de Acesso.
-
Na seção Política de acesso (permissões), selecione Editar. A página Editar fila de teste é aberta.
-
Role para baixo até Política de acesso e selecione o link Gerador de política. O AWS Policy Generator é aberto em uma nova guia.
-
Na Etapa 1 do gerador de política, selecione SQS Queue Policy.
-
Na Etapa 2 do gerador de política:
Defina Efeito para Permitir.
Defina Principal para 437568002678.
Defina Ações para SendMessage e GetQueueAttributes.
Insira o valor do ARN do SQS em Amazon Resource Name (ARN).
Escolha Add Statement e verifique os detalhes. -
Na Etapa 3 do gerador de política, selecione Gerar Política. Uma caixa de diálogo com a nova política é aberta.
-
Copie a política.
-
Navegue de volta para a fila do Amazon SQS, abra a guia Política de acesso e cole a política na seção Política de acesso (permissões).
-
Salve as alterações.
-
Consulte a seção Detalhes da fila e anote o ARN dessa fila. Você passará esse valor usando o parâmetro arn ao chamar a operação createDestination na Etapa 2. Crie um destino.
Observação: se você estiver usando a criptografia do lado do servidor (SSE), deverá fornecer acesso à Selling Partner API à sua chave usando o AWS Key Management Service (KMS). Considere usar a seguinte política:
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::437568002678:root"
},
"Action": [
"kms:GenerateDataKey",
"kms:Decrypt"
],
"Resource": "*"
}
]
}
Consulte Gerenciamento de chaves para obter mais informações.
Etapa 2. Crie um destino
Chame a operação createDestination para criar um destino do Amazon Simple Queue Service (SQS).
- Chame a operação createDestination, passando os seguintes parâmetros do corpo:
Parâmetro | Descrição | Requerido |
---|---|---|
resourceSpecification | As informações necessárias para criar um destino SQS. Isso inclui o valor sqs:arn obtido na Etapa 1. Conceder permissão à API do parceiro de vendas para gravar em sua fila do SQS. Tipo: objeto | Sim |
name | Um nome que você especifica para ajudá-lo a identificar esse destino. Tipo: string | Sim |
Observação: Chamar a operação createDestination não requer autorização de nenhum parceiro de vendas. A esse respeito, esta operação é uma operação "sem concessão" e possui um modelo de autorização diferente da maioria das outras operações da API do Parceiro de Vendas. Para obter mais informações, consulte Operações Grantless no Guia do desenvolvedor da API do parceiro de vendas.
Exemplo de solicitação:
POST https://sellingpartnerapi-na.amazon.com/ notifications/v1/destinations
{
"name": "YourDestinationName",
"resourceSpecification":
{
"sqs":
{
"arn": "arn:aws:sqs:us-east-2:444455556666:queue1"
}
}
}
Resposta
Nome | Descrição |
---|---|
name | O nome definido pelo desenvolvedor para este destino. Tipo: string |
destinationId | O identificador de destino gerado quando você criou o destino. Tipo: string |
resource | O recurso que receberá notificações associadas a este destino. Tipo: objeto |
Exemplo de resposta:
{
"payload": {
"name": "YourDestinationName",
"destinationId": "ExampleDestinationId",
"resource": {
"sqs": {
"arn": "arn:aws:sqs:us-east-2:444455556666:queue1"
}
}
}
}
- Salve o valor destinationId como entrada para a Etapa 3. Crie uma assinatura.
Etapa 3. Crie uma assinatura
Crie uma assinatura para um tipo de notificação para ser entregue ao destino que você criou na etapa anterior.
Observação: apenas uma assinatura por aplicativo, tipo de notificação e parte (vendedor/fornecedor) é permitida por região.
- Chame a operação createSubscription, passando os seguintes parâmetros:
Parâmetro path:
Parâmetro | Descrição | Requerido |
---|---|---|
notificationType | O tipo de notificação que você deseja assinar. Valores possíveis: ACCOUNT_STATUS_CHANGED, ANY_OFFER_CHANGED, B2B_ANY_OFFER_CHANGED, FBA_OUTBOUND_SHIPMENT_STATUS, FEE_PROMOTION, FEED_PROCESSING_FINISHED, FULFILLMENT_ORDER_STATUS, MFN_ORDER_STATUS_CHANGE, ORDER_STATUS_CHANGE, PRICING_HEALTH, REPORT_PROCESSING_FINISHED. Ver notificationType Tipo: string | Sim |
Parâmetro do body:
Parâmetro | Descrição | Requerido |
---|---|---|
payloadVersion | A versão do objeto de carga útil a ser usada na notificação. Tipo: string | Sim |
destinationId | O identificador para o destino onde as notificações serão entregues. Use o valor que você salvou na [Etapa 2. Crie um destino[(#etapa-2-crie-um-destino). Tipo: string | Sim |
processingDirective | Informações adicionais passadas para a assinatura para controlar o processamento das notificações. Por exemplo, você pode usar um eventFilter para personalizar sua assinatura para enviar notificações apenas para os marketplaceIds especificados ou selecionar o período de agregação no qual enviar notificações (por exemplo, limite a uma notificação a cada cinco minutos para notificações de alta frequência). Os recursos específicos disponíveis variam de acordo com o notificationType. Observação: esse recurso é limitado a tipos de notificação específicos e atualmente é compatível apenas com o tipo de notificação ANY_OFFER_CHANGED. Tipo: ProcessingDirective | Não |
Exemplo de solicitação (sem uma diretiva de processamento):
POST https://sellingpartnerapi-na.amazon.com/ notifications/v1/subscriptions/ANY_OFFER_CHANGED
{
"payloadVersion":"1.0",
"destinationId":"3acafc7e-121b-1329-8ae8-1571be663aa2"
}
Resposta
Nome | Descrição |
---|---|
subscriptionId | O identificador de assinatura gerado quando a assinatura é criada. Tipo: string |
payloadVersion | A versão do objeto de carga útil a ser usada na notificação. Tipo: string |
destinationId | O identificador para o destino onde as notificações serão entregues. Use o valor destinationId que você salvou na etapa anterior. Tipo: string |
Exemplo de resposta:
{
"payload": {
"subscriptionId": "7fcacc7e-727b-11e9-8848-1681be663d3e",
"payloadVersion": "1.0",
"destinationId": "3acafc7e-121b-1329-8ae8-1571be663aa2",
}
}
Resposta
Nome | Descrição |
---|---|
subscriptionId | O identificador de assinatura gerado quando a assinatura é criada. Tipo: string |
payloadVersion | A versão do objeto de carga útil a ser usada na notificação. Tipo: string |
destinationId | O identificador para o destino onde as notificações serão entregues. Use o valor destinationId que você salvou na etapa anterior. Tipo: string |
Exemplos que usam um processingDirective (suportado apenas pelo notificationType ANY_OFFER_CHANGED)
Exemplo de solicitação para criar uma assinatura que envia notificações apenas para os marketplaceIds especificados:
POST https://sellingpartnerapi-na.amazon.com/ notifications/v1/subscriptions/ANY_OFFER_CHANGED
{
"destinationId": "12d803a2-7e70-4bb2-a797-2b4b43e10051",
"payloadVersion": "1.0",
"processingDirective": {
"eventFilter": {
"eventFilterType": "ANY_OFFER_CHANGED",
"marketplaceIds": ["ATVPDKIKX0DER"]
}
}
}
Exemplo de resposta:
{
"payload": {
"subscriptionId": "7318ddfb-18e4-4fe0-89f5-a437321d2e79",
"destinationId": "12d803a2-7e70-4bb2-a797-2b4b43e10051",
"payloadVersion": "1.0",
"processingDirective": {
"eventFilter": {
"marketplaceIds": [
"ATVPDKIKX0DER"
],
"eventFilterType": "ANY_OFFER_CHANGED"
}
}
}
}
Exemplo de solicitação para criar uma assinatura que limita a frequência de notificações a uma a cada cinco minutos
POST https://sellingpartnerapi-na.amazon.com/ notifications/v1/subscriptions/ANY_OFFER_CHANGED
{
"destinationId": "12d803a2-7e70-4bb2-a797-2b4b43e10051",
"payloadVersion": "1.0",
"processingDirective": {
"eventFilter": {
"eventFilterType": "ANY_OFFER_CHANGED",
"aggregationSettings": {
"aggregationTimePeriod": "FiveMinutes"
}
}
}
}
Exemplo de resposta:
{
"payload": {
"subscriptionId": "b8877fdf-17a6-4d59-bb1d-9650d9d823e0",
"destinationId": "12d803a2-7e70-4bb2-a797-2b4b43e10051",
"payloadVersion": "1.0",
"processingDirective": {
"eventFilter": {
"aggregationSettings": {
"aggregationTimePeriod": "FiveMinutes"
},
"eventFilterType": "ANY_OFFER_CHANGED"
}
}
}
}
Processando notificações da sua fila
Há várias propriedades importantes das filas do Amazon SQS que você deve entender para processar notificações corretamente:
-
A Selling Partner API não oferece suporte à entrega em filas FIFO. Você deve usar filas padrão do Amazon SQS para receber notificações.
-
As filas padrão da API do parceiro de vendas não garantem que as notificações sejam recebidas na ordem em que foram enviadas. As filas padrão fornecem ordenação de melhor esforço, o que significa que as notificações geralmente são entregues na mesma ordem em que são enviadas. No entanto, ocasionalmente, mais de uma cópia de uma notificação pode ser entregue fora de ordem. Portanto, você deve projetar seu aplicativo para aceitar notificações em qualquer ordem.
-
As notificações de fila padrão do Amazon SQS podem ser entregues mais de uma vez. O Amazon SQS armazena cópias de suas notificações em vários servidores para redundância e alta disponibilidade. Em raras ocasiões, um dos servidores que armazena uma cópia de uma notificação pode estar indisponível quando você recebe ou exclui uma notificação. Se esse cenário ocorrer, a cópia da notificação não será excluída nesse servidor indisponível e você poderá obter essa cópia de notificação novamente quando receber notificações. Portanto, você deve projetar seu aplicativo para aceitar várias cópias de qualquer notificação.
-
Você pode determinar se uma notificação é uma duplicata de uma notificação que você já recebeu observando a propriedade notificationId da notificação. Você pode encontrar a propriedade notificationId no objeto NotificationMetaData da notificação.
Para obter mais informações sobre o processamento de notificações de filas do Amazon SQS, consulte o Guia do desenvolvedor do Amazon Simple Queue Service e a Referência de API do Amazon Simple Queue Service no portal de documentação da AWS.
Diretivas de processamento
Uma diretiva de processamento é um parâmetro opcional que você pode fornecer ao chamar a operação createSubscription. Ele pode ser usado para alterar o comportamento de uma assinatura para determinados notificationTypes. Atualmente, só é compatível com o tipo de notificação ANY_OFFER_CHANGED. O uso com um notificationType sem suporte resulta em uma falha de solicitação com uma resposta HTTP 400.
Use um processingDirective para passar informações adicionais à assinatura para controlar o processamento de notificações. Por exemplo, você pode usar um eventFilter para personalizar sua assinatura para enviar notificações apenas para os marketplaceIds especificados ou para selecionar o período de agregação no qual enviar notificações (por exemplo, limite a uma notificação a cada cinco minutos para notificações de alta frequência).
Os seguintes valores eventFilter são suportados:
Nome | Descrição |
---|---|
eventFilterType | Um valor eventFilterType que é compatível com o notificationType específico. Isso é usado pelo serviço de assinatura para determinar o tipo de filtro de eventos. Exemplo: "eventFilterType":"ANY_OFFER_CHANGED" Requerido. |
aggregationSettings | A container to support aggregated filtering of notifications. Supports using an aggregationTimePeriod to limit (filter) the sending of notifications to a five or ten minute frequency. Example: "aggregationSettings": {"aggregationTimePeriod": "FiveMinutes"} Optional. |
marketplaceIds | Uma lista de identificadores de mercado para se inscrever. Para receber notificações de todos os marketplaces, não forneça esta lista. Exemplo: "marketplaceIds": [ "ATVPDKIKX0DER", "A2EUQ1WTGCTBG2" ] Opcional. |
Para obter mais informações, consulte ProcessingDirective na referência da API.
Exemplo de solicitação que implementa um processingDirective com os dois valores eventFilter:
POST https://sellingpartnerapi-na.amazon.com/notifications/v1/subscriptions/ANY_OFFER_CHANGED
{
"payloadVersion": "1.0",
"destinationId": "3acafc7e-121b-1329-8ae8-1571be663aa2",
"processingDirective": {
"eventFilter": {
"marketplaceIds": [
"ATVPDKIKX0DER",
"A2EUQ1WTGCTBG2"
],
"aggregationSettings": {
"aggregationTimePeriod": "FiveMinutes"
},
"eventFilterType": "ANY_OFFER_CHANGED"
}
}
}
Resposta:
{
"payload": {
"subscriptionId": "7fcacc7e-727b-11e9-8848-1681be663d3e",
"payloadVersion": "1.0",
"destinationId": "3acafc7e-121b-1329-8ae8-1571be663aa2",
"processingDirective": {
"eventFilter": {
"marketplaceIds": [
"ATVPDKIKX0DER",
"A2EUQ1WTGCTBG2"
],
"aggregationSettings": {
"aggregationTimePeriod": "FiveMinutes"
},
"eventFilterType": "ANY_OFFER_CHANGED"
}
}
}
}
Estrutura de notificação
As notificações do parceiro de vendas estão no formato JSON. Cada notificação contém um objeto Payload, que contém os dados acionáveis da notificação. O NotificationType, em combinação com PayloadVersion, determina a estrutura do objeto Payload.
Uma notificação do parceiro de vendas com NotificationVersion=1.0 contém as seguintes propriedades:
Objeto | Descrição | Tipo |
---|---|---|
NotificationVersion | A versão de notificação. Isso controla a estrutura da notificação. | string |
NotificationType | O tipo de notificação. NotificationType, combinado com PayloadVersion, controla a estrutura do objeto Payload. | string |
PayloadVersion | A versão de carga. PayloadVersion, combinado com NotificationType, controla a estrutura do objeto Payload. | string |
EventTime | A data e hora (em UTC) em que ocorreu o evento que acionou a notificação. | string |
Payload | Os dados acionáveis da notificação. A estrutura do Payload é determinada por NotificationType, em combinação com PayloadVersion. | Objeto JSON Para obter mais informações, consulte Notificações. |
NotificationMetadata | Os metadados de notificação. Isso inclui os seguintes objetos: ApplicationId – The identifier for the application that uses the notifications. Type = string SubscriptionId - A unique identifier for the subscription which resulted in this notification. Type = string PublishTime - The date and time (in UTC) that the notification was sent. Type = string NotificationId - A unique identifier for this notification instance. Type = string | Objeto JSON |
Exemplo de notificação:
{
"NotificationVersion": "1.0",
"NotificationType": "BRANDED_ITEM_CONTENT_CHANGE",
"PayloadVersion": "1.0",
"EventTime": "2019-03-20T18:59:30.194Z",
"Payload":
{
"MarketplaceId": "ATVPDKIKX0DER",
"BrandName": "Great Brand",
"Asin": "B1234567",
"AttributesChanged": [
"bullet_point",
"item_name",
"product_description",
"main_product_image_locator",
"other_product_image_locator_1",
"other_product_image_locator_2",
"other_product_image_locator_3",
"other_product_image_locator_4",
"other_product_image_locator_5",
"other_product_image_locator_6",
"other_product_image_locator_7",
"other_product_image_locator_8",
"swatch_product_image_locator"
]
},
"NotificationMetadata":
{
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime": "2019-03-20T18:59:48.768Z",
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
}
}
notificationType
Você pode assinar várias notificações, dependendo das informações do parceiro de vendas que deseja receber.
Os seguintes valores notificationType indicam o tipo de notificação:
-
ACCOUNT_STATUS_CHANGED. Enviado sempre que o Status da conta muda para os pares de comerciante/mercado inscritos pelos desenvolvedores. Uma notificação é publicada sempre que o status da conta do comerciante muda entre NORMAL, AT_RISK e DEACTIVATED.
-
ANY_OFFER_CHANGED. Enviado sempre que houver alteração em qualquer uma das 20 principais ofertas, por condição (novo ou usado), ou se o preço externo (o preço de outros varejistas) mudar para um item listado pelo vendedor.
-
B2B_ANY_OFFER_CHANGED. Enviado sempre que houver uma alteração em qualquer uma das 20 principais ofertas B2B, na forma de qualquer alteração de preço (seja por unidade única ou preços de nível de desconto por quantidade) para um item listado pelo vendedor.
-
BRANDED_ITEM_CONTENT_CHANGE. Enviado sempre que houver uma alteração no título, descrição, marcadores ou imagens, para qualquer ASIN com o qual o parceiro de vendas tenha um relacionamento com a marca.
-
FBA_OUTBOUND_SHIPMENT_STATUS. Enviado sempre que criamos ou cancelamos uma remessa do Fulfillment by Amazon para um vendedor.
-
FEE_PROMOTION. Enviado quando uma promoção se torna ativa.
-
FEED_PROCESSING_FINISHED. Enviado sempre que qualquer feed enviado usando a Selling Partner API for Feeds atinge um status de processamento de feed CONCLUÍDO, CANCELADO ou FATAL.
-
FULFILLMENT_ORDER_STATUS. Enviado sempre que houver uma alteração no status de um pedido de atendimento multicanal.
-
ITEM_PRODUCT_TYPE_CHANGE. Enviado sempre que houver uma alteração no nome do tipo de produto de qualquer ASIN com o qual o parceiro de vendas tenha um relacionamento de marca.
-
LISTINGS_ITEM_STATUS_CHANGE. Enviado sempre que houver uma alteração no status de um item de listagem que um parceiro de vendas possui.
-
LISTINGS_ITEM_ISSUES_CHANGE. Enviado sempre que houver uma alteração nos problemas associados a um item de listagem de propriedade do parceiro de vendas.
-
MFN_ORDER_STATUS_CHANGE. Enviado sempre que houver alteração no status de disponibilidade de um pedido MFN.
-
ORDER_STATUS_CHANGE. Enviado sempre que houver alteração no status de disponibilidade do pedido.
-
PRICING_HEALTH. Enviado sempre que uma oferta do vendedor não é elegível para ser a Oferta em Destaque (oferta Buy Box) devido a um preço não competitivo.
-
PRODUCT_TYPE_DEFINITIONS_CHANGE. Enviado sempre que houver um novo Tipo de Produto ou Versão de Tipo de Produto.
-
REPORT_PROCESSING_FINISHED. Enviado sempre que qualquer relatório que você solicitou usando a API do parceiro de vendas para relatórios atingir um status de processamento de relatório de CONCLUÍDO, CANCELADO ou FATAL.
ACCOUNT_STATUS_CHANGED
Os vendedores podem assinar esta notificação.
A notificação ACCOUNT_STATUS_CHANGED é enviada sempre que o Status da conta muda para os pares de comerciante/mercado inscritos pelos desenvolvedores. Uma notificação é publicada sempre que o status da conta do comerciante muda entre NORMAL, AT_RISK e DEACTIVATED.
ACCOUNT_STATUS_CHANGED Payload schema: Version 2021-01-01
A tabela a seguir mostra as propriedades do objeto accountStatusChangeNotification:
Nome | Descrição |
---|---|
previousAccountStatus | O status da conta do vendedor antes desta atualização. Requeridos. Tipo: string Valores possíveis: NORMAL, AT_RISK, DEACTIVATED |
currentAccountStatus | O novo status da conta do vendedor. Requerido. Tipo: string Valores possíveis: NORMAL, AT_RISK, DEACTIVATED |
Esquema de notificação: AccountStatusChangedNotification.json
Exemplo de notificação:
{
"notificationVersion": "1.0",
"notificationType": "ACCOUNT_STATUS_CHANGED",
"payloadVersion": "2021-01-01",
"eventTime": "2020-12-11T19:42:04.284Z",
"payload": {
"accountStatusChangeNotification": {
"previousAccountStatus" : "NORMAL",
"currentAccountStatus" : "AT_RISK"
}
},
"notificationMetadata": {
"applicationId": "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746",
"subscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"publishTime": "2020-12-11T19:45:04.284Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
ANY_OFFER_CHANGED
Os vendedores podem assinar esta notificação.
Essa notificação oferece suporte aos seguintes valores de filtro de evento: aggregationSettings, marketplaceIds. Para usar esses filtros, você também deve fornecer o seguinte eventFilterType: "eventFilterType": "ANY_OFFER_CHANGED".
Consulte Diretivas de Processamento para obter mais informações.
A notificação ANY_OFFER_CHANGED é enviada sempre que houver uma alteração em qualquer uma das 20 principais ofertas, por condição (nova ou usada), ou se o preço externo (o preço de outros varejistas) mudar para um item que você vende, ou se houver uma mudança para qual oferta ganha o BuyBox, ou uma mudança no preço do BuyBox. As 20 principais ofertas são determinadas pelo preço final, que é o preço mais o frete menos os Amazon Points. Se vários vendedores estiverem cobrando o mesmo preço de destino, os resultados serão retornados em ordem aleatória.
Você só receberá notificações ANY_OFFER_CHANGED para itens para os quais tem ofertas ativas. Você não pode assinar notificações para itens para os quais não tem ofertas ativas.
A tabela a seguir mostra os objetos e as propriedades do objeto AnyOfferChangedNotification:
Nome | Descrição |
---|---|
SellerId | O identificador do vendedor para a oferta. Requerido. Tipo: string |
OfferChangeTrigger | O evento que causou o envio da notificação. Requerido. Tipo: OfferChangeTrigger |
Summary | Informações sobre o produto que teve a oferta alterada. As informações neste resumo se aplicam a todas as condições do produto. Requerido. Tipo: Summary |
Offers | As 20 principais ofertas competitivas para o item e condição que acionaram a notificação. Requerido. Tipo: Array de Offer |
A tabela a seguir mostra os objetos e propriedades do objeto BuyBoxPrice:
Nome | Descrição |
---|---|
LandedPrice | Preço do anúncio + frete - pontos. Requerido. Tipo: MoneyType |
ListingPrice | O preço do item. Requerido. Tipo: MoneyType |
Shipping | O custo de envio. Requerido. Tipo: MoneyType |
Points | O número de Amazon Points oferecidos com a compra de um item. Opcional. Nota: O objeto Points só é retornado no Japão (JP). Tipo: Points |
Condition | Indica a condição do item. Por exemplo: Novo, Usado, Colecionável, Recondicionado ou Clube. Requerido. Tipo: string |
A tabela a seguir mostra os objetos e as propriedades do objeto LowestPrice:
Nome | Descrição |
---|---|
LandedPrice | Preço do anúncio + frete - pontos. Requerido. Tipo: MoneyType |
ListingPrice | O preço do item. Requerido. Tipo: MoneyType |
Shipping | O custo de envio. Requerido. Tipo: MoneyType |
Points | O número de Amazon Points oferecidos com a compra de um item. Opcional. Nota: O objeto Points só é retornado no Japão (JP). Tipo: Points |
Condition | Indica a condição do item. Por exemplo: Novo, Usado, Colecionável, Recondicionado ou Clube. Requerido. Tipo: string |
FulfillmentChannel | Indica se o item é processado pela Amazon ou pelo vendedor. Requerido. Tipo: FulfillmentChannelType |
A tabela a seguir mostra os objetos e propriedades do objeto Oferta:
Nome | Descrição |
---|---|
SellerId | O identificador do vendedor para a oferta. Requerido. Tipo: string |
SubCondition | A subcondição do item. Por exemplo: Novo, Perfeito, Muito Bom, Bom, Aceitável, Ruim, Clube, OEM, Garantia, Garantia Recondicionado, Recondicionado, Caixa Aberta ou Outro. Requerido. Tipo: string |
SellerFeedbackRating | Informações sobre o feedback do vendedor, incluindo a porcentagem de feedback positivo e a contagem total de feedback recebido. Opcional. Tipo: SellerFeedbackRating |
ShippingTime | O tempo mínimo e máximo, em horas, que o item provavelmente será enviado após a realização do pedido. Requerido. Tipo: ShippingTime |
ListingPrice | O preço do item. Requerido. Tipo: MoneyType |
Points | O número de Amazon Points oferecidos com a compra de um item. Opcional. Nota: O objeto Points só é retornado no Japão (JP). Tipo: Points |
Shipping | O custo de envio. Requerido. Tipo: MoneyType |
ShipsFrom | O estado e o país de onde o item é enviado. Opcional. Tipo: ShipsFrom |
IsFulfilledByAmazon | Indica se a oferta é atendida pela Amazon. Requerido. Tipo: booleano |
IsBuyBoxWinner | Indica se a oferta está atualmente na Buy Box. Pode haver até dois vencedores do Buy Box a qualquer momento por ASIN, um que é elegível para Prime e outro que não é elegível para Prime. Opcional. Tipo: booleano |
ConditionNotes | Informações sobre o estado do item. Opcional. Tipo: string |
PrimeInformation | Informações Amazon Prime. Opcional. Tipo: PrimeInformation |
IsExpeditedShippingAvailable | Indica se o envio expresso está disponível. Opcional. Tipo: booleano |
IsFeaturedMerchant | Indica se o vendedor do item está qualificado para ganhar a Buy Box. Opcional. Tipo: booleano |
ShipsDomestically | Indica se o item é enviado internamente. Opcional. Tipo: booleano |
A tabela a seguir mostra as propriedades do objeto OfferChangeTrigger:
Nome | Descrição |
---|---|
MarketplaceId | O identificador de mercado do item que teve uma alteração de oferta. Requerido. Tipo: string |
ASIN | O ASIN para o item que teve uma mudança de oferta. Requerido. Tipo: string |
ItemCondition | A condição do item que teve uma mudança de oferta. Por exemplo, se uma oferta usada for alterada, a matriz de ofertas no objeto Ofertas será apenas de itens usados. O objeto Summary fornece um resumo das outras condições que podem ser usadas para redefinição de preços. Requerido. Tipo: string |
TimeOfOfferChange | O tempo de atualização da oferta que causou essa notificação, no formato ISO 8601. Requerido. Tipo: string |
OfferChangeType | O tipo de oferta que mudou e acionou esta notificação. Valores OfferChangeType: Externo - O CompetitivePriceThreshold no objeto Summary foi alterado, acionado por uma nova oferta de um vendedor não Amazon. Interno - O preço de uma oferta no site de varejo da Amazon mudou. Oferta em destaque - O vencedor do BuyBox ou o preço do BuyBox mudou. Requerido. Tipo: string |
A tabela a seguir mostra os objetos e propriedades do objeto OfferCount:
Nome | Descrição |
---|---|
Condition | Indica a condição do item. Por exemplo: Novo, Usado, Colecionável, Recondicionado ou Clube. Requerido. Tipo: string |
FulfillmentChannel | Indica se o item é processado pela Amazon ou pelo vendedor. Requeridos. Tipo: FulfillmentChannelType |
OfferCount | O número total de ofertas para a condição especificada e o canal de atendimento. Tipo: integer |
A tabela a seguir mostra as propriedades do objeto Points:
Nome | Descrição |
---|---|
PointsNumber | O número de Amazon Points oferecidos com a compra de um item. Requerido. Tipo: integer |
A tabela a seguir mostra os objetos e propriedades do objeto PrimeInformation:
Nome | Descrição |
---|---|
IsOfferNationalPrime | Indica se a oferta é uma oferta Amazon Prime em todo o mercado em que está listada. Requerido. Tipo: booleano |
IsOfferPrime | Indica se a oferta é uma oferta Amazon Prime. Requerido. Tipo: booleano |
A tabela a seguir mostra as propriedades do objeto SalesRank:
Nome | Descrição |
---|---|
ProductCategoryId | O identificador da categoria do produto do item. Requeridos. Tipo: string |
Rank | A classificação de vendas do item na categoria de produto fornecida. Requeridos. Tipo: integer |
A tabela a seguir mostra os objetos e propriedades do objeto SellerFeedbackRating:
Nome | Descrição |
---|---|
SellerPositiveFeedbackRating | A porcentagem de feedback positivo para o vendedor nos últimos 365 dias. Opcional. Tipo: double |
FeedbackCount | A contagem de comentários recebidos sobre o vendedor. Requerido. Tipo: long |
A tabela a seguir mostra as propriedades do objeto ShippingTime:
Nome | Descrição |
---|---|
MinimumHours | O tempo mínimo, em horas, que o item provavelmente será enviado após o pedido ter sido feito. Opcional. Tipo: short |
MaximumHours | O tempo máximo, em horas, que o item provavelmente será enviado após o pedido ter sido feito. Opcional. Tipo: short |
AvailableDate | A data em que o item estará disponível para envio. Exibido apenas para itens que não estão disponíveis para envio no momento. Opcional. Tipo: string |
AvailabilityType | Indica se o item está disponível para envio agora ou em uma data conhecida ou desconhecida no futuro. Se conhecido, o atributo availableDate indica a data em que o item estará disponível para envio. Opcional. Tipo: string |
A tabela a seguir mostra os objetos e propriedades do objeto ShipsFrom:
Nome | Descrição |
---|---|
State | O estado de onde o item é enviado. Opcional. Tipo: string |
Country | O país de onde o item é enviado. Opcional. Tipo: string |
IsFulfilledByAmazon | Indica se a oferta é atendida pela Amazon. Requeridos. Tipo: booleano |
A tabela a seguir mostra os objetos e as propriedades do objeto Summary:
Nome | Descrição |
---|---|
NumberOfOffers | Uma lista que contém o número total de ofertas para o item para as condições e canais de atendimento fornecidos. Requerido. Tipo: Array de OfferCount |
LowestPrices | Uma lista que contém os preços mais baixos do item para as condições e canais de atendimento fornecidos. Requerido. Tipo: Array de LowestPrice |
BuyBoxPrices | Uma lista que contém o preço da Buy Box do item para as condições fornecidas. Opcional. Tipo: Array de BuyBoxPrice |
ListPrice | O preço de tabela do item, conforme sugerido pelo fabricante. Opcional. Tipo: MoneyType |
SuggestedLowerPricePlusShipping | O preço mais baixo sugerido do item, incluindo frete (menos Amazon Points). O preço mais baixo sugerido é baseado em vários fatores, incluindo preços de venda históricos, preços recentes qualificados para Buy Box e informações de clientes para seus produtos. Opcional. Tipo: MoneyType |
SalesRankings | Uma lista que contém a classificação de vendas do item nas categorias de produtos especificadas. Opcional. Tipo: Array de SalesRank |
NumberOfBuyBoxEligibleOffers | Uma lista que contém o número total de ofertas qualificadas para a Buy Box para as condições e canais de atendimento fornecidos. Requerido. Tipo: Array de OfferCount |
CompetitivePriceThreshold | Este preço é baseado em preços competitivos de outros varejistas (excluindo outros vendedores da Amazon). Sua oferta pode ser inelegível para a Buy Box se seu preço + frete for maior que esse preço competitivo. Opcional. Tipo: MoneyType |
Esquema de notificação: AnyOfferChangedNotification.json
Exemplo de notificação:
{
"NotificationVersion": "1.0",
"NotificationType": "ANY_OFFER_CHANGED",
"PayloadVersion": "1.0",
"EventTime": "2020-01-11T00:09:53.109Z",
"NotificationMetadata":
{
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId": "7d78cc50-95c8-4641-add7-10af4b1fedc9",
"PublishTime": "2020-01-11T00:02:50.501Z",
"NotificationId": " 2012e8e5-b365-4cb1-9fd8-be9dfc6d5eaf"
},
"Payload":
{
"AnyOfferChangedNotification":
{
"SellerId": "merchantId",
"OfferChangeTrigger":
{
"MarketplaceId": "marketplaceId",
"ASIN": "ysp2k4cziG",
"ItemCondition": "Collectible",
"TimeOfOfferChange": "2020-01-11T00:02:50.501Z",
"OfferChangeType": ""
},
"Summary":
{
"NumberOfOffers": [
{
"Condition": "new",
"FulfillmentChannel": "Merchant",
"OfferCount": 28
}
],
"LowestPrices": [
{
"Condition": "new",
"FulfillmentChannel": "Merchant",
"LandedPrice":
{
"Amount": 28.59,
"CurrencyCode": "USD"
},
"ListingPrice":
{
"Amount": 28.59,
"CurrencyCode": "USD"
},
"Shipping":
{
"Amount": 0,
"CurrencyCode": "USD"
}
}
],
"BuyBoxPrices": [
{
"Condition": "new",
"LandedPrice":
{
"Amount": 14,
"CurrencyCode": "USD"
},
"ListingPrice":
{
"Amount": 12,
"CurrencyCode": "USD"
},
"Shipping":
{
"Amount": 2,
"CurrencyCode": "USD"
}
}
],
"ListPrice":
{
"Amount": 14,
"CurrencyCode": "USD"
},
"SalesRankings": [
{
"ProductCategoryId": "lawn_and_garden_display_on_website",
"Rank": 4013
},
{
"ProductCategoryId": "home_garden_display_on_website",
"Rank": 17316
}
],
"NumberOfBuyBoxEligibleOffers": [
{
"Condition": "new",
"FulfillmentChannel": "Merchant",
"OfferCount": 10
}
]
},
"Offers": [
{
"SellerId": "AQNACJEM8PUJ1",
"SubCondition": "new",
"SellerFeedbackRating":
{
"FeedbackCount": 78786,
"SellerPositiveFeedbackRating": 92
},
"ShippingTime":
{
"MinimumHours": 24,
"MaximumHours": 48,
"AvailabilityType": "",
"AvailableDate": ""
},
"ListingPrice":
{
"Amount": 28.59,
"CurrencyCode": "USD"
},
"Shipping":
{
"Amount": 0,
"CurrencyCode": "USD"
},
"ShipsFrom":
{
"Country": "",
"State": ""
},
"IsFulfilledByAmazon": false
},
{
"SellerId": "A28SS3BS1DBQ92",
"SubCondition": "new",
"SellerFeedbackRating":
{
"FeedbackCount": 6532,
"SellerPositiveFeedbackRating": 99
},
"ShippingTime":
{
"MinimumHours": 24,
"MaximumHours": 48,
"AvailabilityType": "",
"AvailableDate": ""
},
"ListingPrice":
{
"Amount": 28.69,
"CurrencyCode": "USD"
},
"Shipping":
{
"Amount": 0,
"CurrencyCode": "USD"
},
"ShipsFrom":
{
"Country": "",
"State": ""
},
"IsFulfilledByAmazon": false
}
]
}
}
}
B2B_ANY_OFFER_CHANGED
A notificação B2B_ANY_OFFER_CHANGED é enviada sempre que houver uma alteração em qualquer uma das 20 principais ofertas B2B, na forma de qualquer alteração de preço (seja por unidade única ou preços de nível de desconto por quantidade) para um item listado pelo vendedor. As 20 principais ofertas B2B são determinadas pelo preço unitário de desembarque, que é o preço mais o frete. Se vários vendedores estiverem cobrando o mesmo preço de destino, os resultados serão retornados em ordem aleatória.
Você só receberá notificações B2B_ANY_OFFER_CHANGED para itens para os quais o vendedor tem ofertas ativas. Você não pode assinar notificações de itens para os quais o vendedor não tem ofertas ativas.
A tabela a seguir mostra os objetos e propriedades do objeto b2b AnyOfferChangedNotification:
Nome | Descrição |
---|---|
OfferChangeTrigger | O evento que causou o envio da notificação. Requerido. Tipo: OfferChangeTrigger |
Summary | Informações sobre o produto que teve a oferta alterada. As informações neste resumo se aplicam a todas as condições do produto. Requerido. Tipo: Summary |
Offers | As 20 principais ofertas B2B competitivas para o item e condição que acionaram a notificação. Requerido. Tipo: Array de Offer |
SellerId | O identificador do vendedor para a oferta. Requerido. Tipo: string |
A tabela a seguir mostra os objetos e as propriedades do objeto BuyBoxPrice.
Nome | Descrição |
---|---|
landedPrice | Preço + frete. Opcional. Tipo: MoneyType |
listingPrice | O preço do item. Requerido. Tipo: MoneyType |
shipping | O custo de envio. Opcional. Tipo: MoneyType |
offerType | Indica se a oferta é uma oferta B2B ou uma oferta B2C. Quando o tipo de oferta é B2C com desconto por quantidade, o vendedor está ganhando a Buy Box porque outros não têm estoque nessa quantidade, não porque têm desconto por quantidade no ASIN. Requerido. Tipo: string |
quantityTier | O nível de quantidade da oferta. Requeridos. Tipo: inteiro |
discountType | Indica se o nível de quantidade é para Desconto por Quantidade ou Desconto Progressivo. Opcional. Tipo: string |
condition | Indica a condição do item. Por exemplo: Novo, Usado, Colecionável, Recondicionado ou Clube. Requerido. Tipo: string |
sellerId | O vendedor se identifica para a oferta. Opcional. Tipo: string |
A tabela a seguir mostra os objetos e as propriedades do tipo LowestPrice no objeto Summary:
Nome | Descrição |
---|---|
LandedPrice | Preço + frete. Opcional. Tipo: MoneyType |
ListingPrice | O preço do item. Requerido. Tipo: MoneyType |
Shipping | O custo de envio. Opcional. Tipo: MoneyType |
OfferType | Indica se a oferta é uma oferta B2B ou uma oferta B2C Requeridos. Tipo: string |
QuantityTier | O nível de quantidade para a oferta Requeridos. Tipo: inteiro |
DiscountType | Indica se o nível de quantidade é para Desconto por Quantidade ou Desconto Progressivo. Opcional. Tipo: string |
Condition | Indica a condição do item. Por exemplo: Novo, Usado, Colecionável, Recondicionado ou Clube. Requerido. Tipo: string |
FulfillmentChannel | Indica se o item é processado pela Amazon ou pelo vendedor. Requerido. Tipo: FulfillmentChannelType |
A tabela a seguir mostra os objetos e propriedades do objeto Oferta:
Nome | Descrição |
---|---|
SellerId | O identificador do vendedor para a oferta. Requerido. Tipo: string |
SubCondition | A subcondição do item. Por exemplo: Novo, Perfeito, Muito Bom, Bom, Aceitável, Ruim, Clube, OEM, Garantia, Garantia Recondicionado, Recondicionado, Caixa Aberta ou Outro. Requerido. Tipo: string |
SellerFeedbackRating | Informações sobre o feedback do vendedor, incluindo a porcentagem de feedback positivo e a contagem total de feedback recebido. Opcional. Tipo: SellerFeedbackRating |
ShippingTime | O tempo mínimo e máximo, em horas, que o item provavelmente será enviado após a realização do pedido. Requeridos. Tipo: ShippingTime |
ListingPrice | O preço do item. Requerido. Tipo: MoneyType |
Shipping | O custo de envio. Requerido. Tipo: MoneyType |
ShipsFrom | O país de onde o item é enviado. Opcional. Tipo: ShipsFrom |
IsFulfilledByAmazon | Indica se a oferta é atendida pela Amazon. Requerido. Tipo: booleano |
IsBuyBoxWinner | Indica se a oferta está atualmente na Buy Box. Pode haver até dois vencedores do Buy Box a qualquer momento por ASIN, um que é elegível para Prime e outro que não é elegível para Prime. Opcional. Tipo: booleano |
ConditionNotes | Informações sobre o estado do item. Opcional. Tipo: string |
PrimeInformation | Informações Amazon Prime. Opcional. Tipo: PrimeInformation |
IsFeaturedMerchant | Indica se o vendedor do item está qualificado para ganhar a Buy Box. Opcional. Tipo: booleano |
A tabela a seguir mostra as propriedades do objeto OfferChangeTrigger:
Nome | Descrição |
---|---|
MarketplaceId | O identificador de mercado do item que teve uma alteração de oferta. Requerido. Tipo: string |
ASIN | O ASIN para o item que teve uma mudança de oferta. Requerido. Tipo: string |
ItemCondition | A condição do item que teve uma mudança de oferta. Por exemplo, se uma oferta usada for alterada, a matriz de ofertas no objeto Ofertas será apenas de itens usados. O objeto Summary fornece um resumo das outras condições que podem ser usadas para redefinição de preços. Requeridos. Tipo: string |
TimeOfOfferChange | O tempo de atualização da oferta que causou essa notificação. Requerido. Tipo: string |
A tabela a seguir mostra os objetos e propriedades do tipo OfferCount:
Nome | Descrição |
---|---|
Condition | Indica a condição do item. Por exemplo: Novo, Usado, Colecionável, Recondicionado ou Clube. Requerido. Tipo: string |
FulfillmentChannel | Indica se o item é processado pela Amazon ou pelo vendedor. Requerido. Tipo: FulfillmentChannelType |
OfferCount | O número total de ofertas para a condição especificada e o canal de atendimento. Tipo: inteiro |
A tabela a seguir mostra as propriedades do objeto PrimeInformation:
Nome | Descrição |
---|---|
IsOfferNationalPrime | Indica se a oferta é uma oferta Amazon Prime em todo o mercado em que está listada. Requerido. Tipo: booleano |
IsOfferPrime | Indica se a oferta é uma oferta Amazon Prime. Requerido. Tipo: booleano |
A tabela a seguir mostra as propriedades do objeto SellerFeedbackRating:
Nome | Descrição |
---|---|
SellerPositiveFeedbackRating | A porcentagem de feedback positivo para o vendedor nos últimos 365 dias. Opcional. Tipo: inteiro |
FeedbackCount | A contagem de comentários recebidos sobre o vendedor. Requerido. Tipo: inteiro |
A tabela a seguir mostra as propriedades do objeto ShippingTime:
Nome | Descrição |
---|---|
MinimumHours | O tempo mínimo, em horas, que o item provavelmente será enviado após o pedido ter sido feito. Opcional. Tipo: inteiro |
MaximumHours | O tempo máximo, em horas, que o item provavelmente será enviado após o pedido ter sido feito. Opcional. Tipo: inteiro |
AvailableDate | A data em que o item estará disponível para envio. Exibido apenas para itens que não estão disponíveis para envio no momento. Opcional. Tipo: string |
AvailabilityType | Indica se o item está disponível para envio agora ou em uma data conhecida ou desconhecida no futuro. Se conhecido, a propriedade availableDate indica a data em que o item estará disponível para envio. Opcional. Tipo: string |
A tabela a seguir mostra as propriedades do objeto ShipsFrom:
Nome | Descrição |
---|---|
Country | O país de onde o item é enviado. Opcional. Tipo: string |
Summary
">
A tabela a seguir mostra os objetos e as propriedades do objeto Resumo:
Nome | Descrição |
---|---|
NumberOfOffers | Uma lista que contém o número total de ofertas B2B para o item para as condições e canais de atendimento fornecidos. Requerido. Tipo: Array de OfferCount |
LowestPrices | Uma lista que contém os preços mais baixos do item para determinadas condições, canais de atendimento, níveis de quantidade e tipos de desconto. Os sete níveis de quantidade predefinidos para o tipo de desconto “Descontos por Quantidade” são 2, 3, 5, 10, 20, 30 e 50. Requerido. Tipo: Array de LowestPrice |
BuyBoxPrices | Uma lista que contém o preço da Buy Box do item para as condições, níveis de quantidade e tipos de desconto fornecidos. São mostrados até os primeiros 50 níveis de quantidade. Opcional. Tipo: Array de BuyBoxPrice |
BuyBoxEligibleOffers | Uma lista que contém o número total de ofertas B2B qualificadas para a Buy Box para as condições e canais de atendimento fornecidos. Requerido. Tipo: Array de OfferCount |
Esquema de notificação: B2bAnyOfferChangedNotification.json
Exemplo de notificação:
{
"notificationVersion": "1.0",
"notificationType": "B2B_ANY_OFFER_CHANGED",
"payloadVersion": "1.0",
"eventTime": "2020-09-23T21:30:13.713Z",
"notificationMetadata":
{
"applicationId": "amzn1.sellerapps.app.1da85d14-a68d-4ff3-9ff0-df6429e00d9a",
"subscriptionId": "e3a059ca-677a-442a-8d39-05b2848971b6",
"publishTime": "2020-09-23T21:30:16.903Z",
"notificationId": "23ae41cd-3537-4676-af46-6ee9abf8802e"
},
"payload":
{
"b2bAnyOfferChangedNotification":
{
"sellerId": "A3EZFOFNDPFB8R",
"offerChangeTrigger":
{
"marketplaceId": "ATVPDKIKX0DER",
"asin": "B007IBIWZY",
"itemCondition": "new",
"timeOfOfferChange": "2020-09-23T21:30:13.409Z"
},
"summary":
{
"numberOfOffers": [
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"offerCount": 3
}
],
"buyBoxEligibleOffers": [
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"offerCount": 3
}
],
"lowestPrices": [
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"offerType": "B2B",
"quantityTier": 1,
"listingPrice":
{
"amount": 8184.23,
"currencyCode": "USD"
},
"shipping":
{
"amount": 4.49,
"currencyCode": "USD"
},
"landedPrice":
{
"amount": 8188.72,
"currencyCode": "USD"
}
},
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"offerType": "B2B",
"quantityTier": 20,
"listingPrice":
{
"amount": 7500,
"currencyCode": "USD"
}
},
{
"condition": "new",
"fulfillmentChannel": "Merchant",
"offerType": "B2B",
"quantityTier": 30,
"discountType": "QUANTITY_DISCOUNT",
"listingPrice":
{
"amount": 6975,
"currencyCode": "USD"
}
}
],
"buyBoxPrices": [
{
"condition": "new",
"offerType": "B2B",
"quantityTier": 1,
"listingPrice":
{
"amount": 8184.23,
"currencyCode": "USD"
},
"shipping":
{
"amount": 4.49,
"currencyCode": "USD"
},
"landedPrice":
{
"amount": 8188.72,
"currencyCode": "USD"
}
},
{
"condition": "new",
"offerType": "B2B",
"quantityTier": 20,
"discountType": "QUANTITY_DISCOUNT",
"listingPrice":
{
"amount": 8000,
"currencyCode": "USD"
}
},
{
"condition": "new",
"offerType": "B2B",
"quantityTier": 30,
"discountType": "QUANTITY_DISCOUNT",
"listingPrice":
{
"amount": 7800,
"currencyCode": "USD"
}
}
]
},
"offers": [
{
"sellerId": "A2VUIDM8BZ902A",
"subCondition": "new",
"sellerFeedbackRating":
{
"feedbackCount": 1,
"sellerPositiveFeedbackRating": 0
},
"shippingTime":
{
"minimumHours": 24,
"maximumHours": 48,
"availabilityType": "available",
"availableDate": "2020-07-13T19:42:04.284Z"
},
"listingPrice":
{
"amount": 8184.23,
"currencyCode": "USD"
},
"shipping":
{
"amount": 4.49,
"currencyCode": "USD"
},
"shipsFrom":
{
"country": "US"
},
"isFulfilledByAmazon": false,
"isBuyBoxWinner": true,
"conditionNotes": "New in box",
"primeInformation":
{
"isPrime": true,
"isNationalPrime": true
},
"isFeaturedMerchant": true
}
]
}
}
}
BRANDED_ITEM_CONTENT_CHANGE
A Amazon envia uma notificação BRANDED_ITEM_CONTENT_CHANGE sempre que houver uma alteração no título, descrição, marcadores ou imagens para qualquer ASIN com o qual o parceiro de vendas tenha um relacionamento com a marca. Um parceiro de vendas tem um relacionamento de marca com um ASIN, conforme definido no programa Amazon Registered Brands, quando é um proprietário de marca verificado. O parceiro de vendas é a parte que autoriza um aplicativo a chamar a API de Notificações em seu nome, com a finalidade de criar e gerenciar assinaturas de notificação. A Amazon envia notificações BRANDED_ITEM_CONTENT_CHANGE para itens listados em qualquer mercado da Amazon.
BRANDED_ITEM_CONTENT_CHANGE Payload schema: Version 1.0
Uma notificação BRANDED_ITEM_CONTENT_CHANGE com PayloadVersion=1.0 inclui as seguintes propriedades no objeto Payload.
Nome | Descrição | Requerido |
---|---|---|
MarketplaceId | O mercado em que o item está listado. Tipo: string | Sim |
BrandName | O nome da marca do item. Tipo: string | Sim |
ASIN | O ASIN do item. Tipo: string | Sim |
AttributesChanged | A matriz de atributos de item que foram alterados. Nomes de atributos, descrições e requisitos estão disponíveis chamando a API Product Type Definitions. Para obter mais informações, consulte o Guia de caso de uso da API de definições de tipo de produto. Tipo: Matriz de string Valores possíveis: bullet_point item_name product_description main_product_image_locator other_product_image_locator_1 other_product_image_locator_2 other_product_image_locator_3 other_product_image_locator_4 other_product_image_locator_5 other_product_image_locator_6 other_product_image_locator_7 other_product_image_locator_8 swatch_product_image_locator Observação: A presença de um ou mais dos valores acima que contêm a palavra imagem (por exemplo, main_product_image_locator, other_product_image_locator_1 e assim por diante) indica que pelo menos uma imagem foi alterada na página de detalhes do produto. O número de valores que contêm a palavra imagem não corresponde necessariamente ao número de imagens alteradas na página de detalhes do produto. | Sim |
Esquema de notificação: BrandedItemContentChangeNotification.json
Exemplo de notificação:
{
"NotificationVersion": "1.0",
"NotificationType": "BRANDED_ITEM_CONTENT_CHANGE",
"PayloadVersion": "1.0",
"EventTime": "2019-03-20T18:59:30.194Z",
"Payload":
{
"MarketplaceId": "ATVPDKIKX0DER",
"BrandName": "Great Brand",
"Asin": "B1234567",
"AttributesChanged": [
"bullet_point",
"item_name",
"product_description",
"main_product_image_locator",
"other_product_image_locator_1",
"other_product_image_locator_2",
"other_product_image_locator_3",
"other_product_image_locator_4",
"other_product_image_locator_5",
"other_product_image_locator_6",
"other_product_image_locator_7",
"other_product_image_locator_8",
"swatch_product_image_locator"
]
},
"NotificationMetadata":
{
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId": "93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime": "2019-03-20T18:59:48.768Z",
"NotificationId": "8e009934-da2c-4f9c-9bc7-93f23b7e1f60"
}
}
FBA_OUTBOUND_SHIPMENT_STATUS
Os vendedores podem assinar esta notificação.
A notificação FBA_OUTBOUND_SHIPMENT_STATUS é enviada sempre que a Amazon cria ou cancela uma remessa Fulfillment by Amazon para um vendedor. Esta notificação é apenas para remessas FBA Onsite. Esta notificação está disponível apenas no marketplace do Brasil.
FBAOutboundShipmentStatusNotification
A tabela a seguir mostra os objetos e propriedades do objeto FBAOutboundShipmentStatusNotification:
Nome | Descrição |
---|---|
SellerId | O identificador do vendedor. Tipo: string |
AmazonOrderId | O identificador de pedido definido pela Amazon. Tipo: string |
AmazonShipmentId | O identificador de remessa definido pela Amazon. Tipo: string |
ShipmentStatus | O estado do envio. Valores ShipmentStatus: Criado, Cancelado. Tipo: string |
Esquema de notificação: FBAOutboundShipmentStatusNotification.json
Exemplo de notificação:
{
"NotificationVersion": "1.0",
"NotificationType": "FBA_OUTBOUND_SHIPMENT_STATUS",
"PayloadVersion": "1.0",
"EventTime": "2020-01-11T00:09:53.109Z",
"Payload":
{
"FBAOutboundShipmentStatusNotification":
{
"SellerId": "merchantId",
"AmazonOrderId": "113-2646096-4474645",
"AmazonShipmentId": "DrLqQwqvb",
"ShipmentStatus": "Created"
}
},
"NotificationMetadata":
{
"ApplicationId": "appId",
"SubscriptionId": "subId",
"PublishTime": "2020-01-11T00:02:50.501Z",
"NotificationId": "requestId"
}
}
FEE_PROMOTION
Os vendedores podem assinar esta notificação.
Os vendedores que usam a Selling Partner API podem se beneficiar de promoções de taxas por tempo limitado. Para receber notificação de promoções de taxas disponíveis, os vendedores devem assinar a notificação FEE_PROMOTION. Quando o vendedor se inscreve inicialmente para a assinatura e isEnabled é definido como verdadeiro, o vendedor recebe todas as promoções ativas no momento. Cada promoção é enviada como uma única mensagem. As notificações de promoção subsequentes são enviadas quando a promoção se torna ativa.
A notificação FEE_PROMOTION é composta por um conjunto de campos de dados que descrevem os detalhes dessa promoção. Todos os critérios de qualificação para cada promoção serão descritos nesses campos de dados.
Observação: as taxas estimadas retornadas por esta API não são garantidas. As taxas reais podem variar. Para obter mais informações sobre taxas, consulte Vender na tabela de taxas da Amazon e recursos e taxas do FBA no Seller Central.
A tabela a seguir mostra os objetos e as propriedades de um objeto FeeDetail:
Nome | Descrição | Requerido | Valor |
---|---|---|---|
FeeType | O tipo de taxas cobradas. | Sim | Tipos de taxas permitidas: ReferralFee, VariableClosingFee, PerItemFee, FBAFees, FBAPickAndPack, FBAWeightHandling, FBAOrderHandling, FBADeliveryServicesFee. Tipo: string |
FeeAmount | O valor da taxa correspondente ao tipo de taxa. | Sim | Tipo: MoneyType |
FeePromotion | O valor da promoção de taxa correspondente ao tipo de taxa. | Não | Tipo: MoneyType |
TaxAmount | O imposto calculado sobre a taxa que seria cobrada do vendedor. | Não | Tipo: MoneyType |
FinalFee | A taxa final que seria cobrada do vendedor. | Sim | O FeeAmount menos o FeePromotion. Tipo: MoneyType |
IncludedFees | Uma lista estruturada de FeeDetail que contém a especificação de um tipo de taxa específico. | Não | Tipo: Array of FeeDetail |
A tabela a seguir mostra os objetos e propriedades do objeto FeesEstimate:
Nome | Descrição | Requerido | Valor |
---|---|---|---|
TimeOfFeesEstimated | A data e hora em que as taxas foram estimadas. | Sim | Tipo: string |
TotalFeesEstimate | O valor total das taxas se o preço for reduzido para ou abaixo do limite de preço. | Sim | Tipo: MoneyType |
FeeDetails | Uma especificação do TotalFeesEstimate). | Sim | Tipo: Array de FeeDetail |
Cada objeto FeePromotionNotification é composto pelos seguintes objetos de dados:
Nome | Descrição | Requerido | Valor |
---|---|---|---|
FeePromotionType | O tipo de promoção. | Sim | Valores: Preço, SelectionASIN ou SelectionCategory. Tipos adicionais podem se tornar disponíveis no futuro. Tipo: string |
FeePromotionTypeDescription | Fornece mais detalhes sobre o objetivo de uma promoção. | Não | Uma descrição de string amigável e localizada. Útil para os integradores exibirem em uma interface do usuário. Tipo: string |
MarketplaceId | A promoção se aplica a este marketplaceId. | Sim | Tipo: string |
MerchantId | A promoção se aplica a este comercianteId. | Sim | Tipo: string |
Identifiers | Uma lista de itens aos quais esta promoção se aplica. | Sim | Tipo: Array de Identifier |
PromotionActiveTimeRange | O intervalo de tempo em que esta promoção está ativa. | Sim | Tipo: PromotionActiveTimeRange |
PromotionInformation | Um objeto contendo detalhes adicionais sobre a promoção. Uma estimativa de taxa está incluída, se aplicável. | Sim | Tipo: PromotionInformation |
A tabela a seguir descreve os objetos e as propriedades de um objeto da matriz Identifiers:
Nome | Descrição | Requerido | Valor |
---|---|---|---|
IdentifierType | O tipo de identificador de comerciante ao qual esta promoção se aplica. | Sim | Por exemplo: ASIN, SKU, Nó de navegação, Marca. Tipo: string |
IdentifierValues | O nome amigável do valor de ID. | Sim | Por exemplo: os ASINs ou SKUs reais do comerciante, uma lista real de marcas (como Nike), uma lista real de nós de navegação. Tipo: Array de IndentifierValue |
Uma descrição dos valores de identificador aos quais esta promoção se aplica.
Nome | Descrição | Requerido | Valor |
---|---|---|---|
IdentifierValueId | O ID do nó de navegação real, o ASIN/SKU real ou o valor da marca. | Sim | Tipo: string |
IdentifierValueFriendlyName | Os valores do identificador do comerciante aos quais esta promoção se aplicará. | Não | Apenas relevante/preenchido para coisas como nós de navegação. Por exemplo, seria o nome amigável de um nó de navegação. Tipo: string |
A tabela a seguir mostra os objetos e propriedades do objeto PromotionInformation:
Nome | Descrição | Requerido | Valor |
---|---|---|---|
FeeType | Sim | Tipos de taxas permitidas: ReferralFee, VariableClosingFee, PerItemFee, FBAFees, FBAPickAndPack, FBAWeightHandling, FBAOrderHandling, FBADeliveryServicesFee. Tipo: string | |
FeeDiscountType | Sim | Pontos fixos, de desconto ou de porcentagem. Tipo: string | |
PriceThreshold | Não | Tipo: MoneyType | |
FeeDiscountMonetaryAmount | Não | Se o FeeDiscountType envolver um valor monetário, esse valor será preenchido. Tipo: MoneyType | |
FeeDiscountValue | Não | Se o FeeDiscountType envolver um valor não monetário, esse valor será preenchido. Tipo: inteiro | |
FeesEstimate | Não | Tipo: FeesEstimate |
A tabela a seguir mostra as propriedades do objeto PromotionActiveTimeRange:
Nome | Descrição | Requerido | Valor |
---|---|---|---|
EffectiveFromDate | Data (inclusive) em que a promoção se torna ativa. | Sim | Tipo: string |
EffectiveThroughDate | Data (exclusiva) em que a promoção terminou. | Sim | Tipo: string |
Esquema de notificação: FeePromotionNotification.json
Exemplo de notificação:
{
"NotificationVersion": "1.0",
"NotificationType": "FEE_PROMOTION",
"PayloadVersion": "1.0",
"EventTime": "2020-01-11T00:09:53.109Z",
"NotificationMetadata":
{
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId": "7d78cc50-95c8-4641-add7-10af4b1fedc9",
"PublishTime": "2020-01-11T00:02:50.501Z",
"NotificationId": " 2012e8e5-b365-4cb1-9fd8-be9dfc6d5eaf"
},
"Payload":
{
"FeePromotionNotification":
{
"MerchantId": "merchantId",
"MarketplaceId": "marketplaceId1",
"FeePromotionType": "Pricing",
"FeePromotionTypeDescription": "To help you offer a lower price to customers, we are offering you a temporary referral fee discount for every sale when the total sale price (price + shipping+ gift wrap) is at or below the pricing threshold.",
"PromotionActiveTimeRange":
{
"EffectiveFromDate": "2016-05-04T22:24:39.615Z",
"EffectiveThroughDate": "2016-04-28T02:45:12.786Z"
},
"Identifiers": [
{
"IdentifierType": "ASIN",
"IdentifierValues": [
{
"IdentifierValueId": "B0000000",
"IdentifierValueFriendlyName": "1234"
}
]
}
],
"PromotionInformations": [
{
"FeeType": "ReferralFee",
"FeeDiscountType": "Percentage points off",
"FeeDiscountValue": 5,
"PriceThreshold":
{
"Amount": 1,
"CurrencyCode": "USD"
},
"FeesEstimate":
{
"TimeOfFeesEstimated": "2016-05-05T22:24:39.635Z",
"TotalFeesEstimate":
{
"Amount": 10,
"CurrencyCode": "USD"
},
"FeeDetails": [
{
"FeeType": "feeType",
"FeeAmount":
{
"Amount": 1,
"CurrencyCode": "USD"
},
"FeePromotion":
{
"Amount": 0.8,
"CurrencyCode": "USD"
},
"FinalFee":
{
"Amount": 0.2,
"CurrencyCode": "USD"
}
}
]
}
}
]
}
}
}
FEED_PROCESSING_FINISHED
Os vendedores podem assinar esta notificação.
A notificação FEED_PROCESSING_FINISHED é enviada sempre que qualquer feed enviado usando a Selling Partner API for Feeds atinge um status de processamento de feed DONE, CANCELLED ou FATAL.
FEED_PROCESSING_FINISHED Payload schema: Version 1.0
Uma notificação FEED_PROCESSING_FINISHED com PayloadVersion=2020-09-04 inclui os seguintes objetos no objeto feedProcessingFinishedNotification.
Nome | Descrição | Tipo | Requerido |
---|---|---|---|
sellerId | O identificador do parceiro de vendas. | string | Sim |
feedId | O identificador do feed. | string | Sim |
feedType | O tipo de alimentação. Para obter mais informações, consulte valores de feedType. | string | Sim |
processingStatus | O status de processamento do feed. | string | Sim |
resultFeedDocumentId | O identificador do documento de alimentação. Esse identificador é exclusivo apenas em combinação com um ID de vendedor. | string | Não |
Esquema de notificação: FeedProcessingFinishedNotification.json
Exemplo de notificação:
{
"notificationVersion": "2020-09-04",
"notificationType": "FEED_PROCESSING_FINISHED",
"payloadVersion": "2020-09-04",
"eventTime": "2020-07-13T19:42:04.284Z",
"payload":
{
"feedProcessingFinishedNotification":
{
"sellerId": "A3TH9S8BH6GOGM",
"feedId": "53347018456",
"feedType": "POST_PRODUCT_DATA",
"processingStatus": "DONE",
"resultFeedDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.URUTI57URI9BMZ"
}
},
"notificationMetadata":
{
"applicationId": "amzn1.sellerapps.app.aacccfff-44aa-4b7c-b42b-ed4ec98dd746",
"subscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"publishTime": "2020-07-13T19:42:04.284Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
FULFILLMENT_ORDER_STATUS
Os vendedores podem assinar esta notificação. A notificação FULFILLMENT_ORDER_STATUS é enviada sempre que há uma alteração no status de um pedido de processamento de processamento multicanal.
A tabela a seguir mostra os objetos e as propriedades do objeto FulfillmentOrderStatusNotification:
Nome | Descrição |
---|---|
EventType | Indica se a notificação contém informações de pedido, remessa ou devolução. Valores do tipo de evento: Pedido - Esta notificação contém informações sobre um pedido de atendimento. Remessa - Esta notificação contém informações sobre uma remessa de atendimento. Para obter mais informações, consulte o objeto FulfillmentShipment. Devolução - Esta notificação contém informações sobre uma devolução de cumprimento. Requerido Tipo: string |
SellerId | O identificador do vendedor. Tipo: string |
StatusUpdatedDateTime | A data e hora em que o status foi atualizado pela última vez. No formato ISO 8601. Requeridos Tipo: string |
SellerFulfillmentOrderId | O identificador do pedido de atendimento que você criou e enviou usando a operação CreateFulfillmentOrder. Requerido Tipo: string |
FulfillmentOrderStatus | O status atual do pedido de atendimento. Valores de FulfillmentOrderStatus: Received - O pedido de atendimento foi recebido e validado. A validação inclui determinar que o endereço de destino é válido e que os registros da Amazon indicam que o vendedor tem estoque suficiente para venda (sem danos) para atender ao pedido. O vendedor pode cancelar um pedido de atendimento que tenha o status de Recebido. Invalid - O pedido de atendimento foi recebido, mas não pôde ser validado. Os motivos para isso incluem um endereço de destino inválido ou registros da Amazon indicando que o vendedor não possui estoque vendável suficiente para atender ao pedido. Quando isso acontece, o pedido de atendimento é inválido e nenhum item no pedido será enviado. Planning - O pedido de atendimento foi enviado para a rede de atendimento da Amazon para iniciar o planejamento do envio, mas nenhuma unidade em nenhum envio foi retirada do estoque ainda. O vendedor pode cancelar um pedido de atendimento com status de Planejamento. Processing - O processo de separação de unidades do estoque começou em pelo menos uma remessa no pedido de atendimento. O vendedor não pode cancelar um pedido de atendimento com status de Processamento. Cancelled - O pedido de atendimento foi cancelado pelo vendedor. Complete - Todas as quantidades de itens no pedido de atendimento foram atendidas. CompletePartialled - Algumas quantidades de itens no pedido de atendimento foram atendidas; os demais foram cancelados ou incumpridos. Unfulfillable - Nenhuma quantidade de item no pedido de atendimento pôde ser atendida porque os funcionários do centro de atendimento da Amazon não encontraram estoque para esses itens ou não encontraram estoque em condições de venda (sem danos). Requerido Tipo: string |
FulfillmentShipment | Informações de entrega e item para uma remessa em um pedido de atendimento. Opcional. Retornado somente quando EventType é Shipment. Tipo: FulfillmentShipment |
FulfillmentReturnItem | Informações sobre um item que foi devolvido a um centro de distribuição da Amazon. Opcional. Retornado somente quando EventType é Return. Tipo: FulfillmentReturnItem |
A tabela a seguir mostra os objetos e propriedades do objeto FulfillmentReturnItem:
Nome | Descrição |
---|---|
ReceivedDateTime | A data e hora em que o item devolvido foi recebido pelo centro de distribuição da Amazon. No formato de data e hora ISO 8601. Requerido Tipo: string |
ReturnedQuantity | A quantidade que foi devolvida. Requerido Tipo: inteiro |
SellerSKU | O SKU do vendedor do item. Requerido Tipo: string |
A tabela a seguir mostra os objetos e propriedades do objeto FulfillmentShipment:
Nome | Descrição |
---|---|
FulfillmentShipmentStatus | O status atual da remessa. Valores de FulfillmentShipmentStatus: Pending - O processo de separação de unidades do estoque foi iniciado. Shipped - Todos os pacotes da remessa deixaram o centro de distribuição. CancelledByFulfiller - O centro de distribuição da Amazon não pôde processar a remessa conforme planejado. Isso pode ocorrer porque o estoque não estava no local esperado no centro de distribuição. Depois de cancelar o pedido de atendimento, a Amazon cria imediatamente uma nova remessa de atendimento e tenta novamente atender o pedido. CancelledBySeller - A remessa foi cancelada usando a operação CancelFulfillmentOrder. Requerido Tipo: string |
AmazonShipmentId | Um identificador de remessa atribuído pela Amazon. Requerido Tipo: string |
EstimatedArrivalDateTime | A hora estimada de chegada da remessa, no formato de data e hora ISO 8601. Observe que esse valor pode mudar com o tempo. Se uma remessa incluir mais de um pacote, EstimatedArrivalDateTime se aplicará a todos os pacotes da remessa. Se o envio foi cancelado, EstimatedArrivalDateTime não é devolvido. Requerido Tipo: string |
FulfillmentShipmentPackages | Contém todos os pacotes na remessa de atendimento. Opcional Tipo: Array de FulfillmentShipmentPackage |
A tabela a seguir mostra os objetos e propriedades do objeto FulfillmentShipmentPackage:
Nome | Descrição |
---|---|
PackageNumber | Identifica um pacote dentro de uma remessa. Requeridos Tipo: inteiro |
CarrierCode | Identifica a transportadora que entregará o pacote. Requeridos Tipo: string |
TrackingNumber | O número de rastreamento usado para obter informações de rastreamento e entrega. Requeridos Tipo: string |
Esquema de notificação: FulfillmentOrderStatusNotification.json
Exemplo de notificação:
{
"NotificationVersion": "1.0",
"NotificationType": "FULFILLMENT_ORDER_STATUS",
"PayloadVersion": "1.0",
"EventTime": "2020-01-11T00:09:53.109Z",
"Payload":
{
"FulfillmentOrderStatusNotification":
{
"SellerId": "merchantId",
"EventType": "Shipment",
"StatusUpdatedDateTime": "2020-01-11T00:09:53.109Z",
"SellerFulfillmentOrderId": "OrderId",
"FulfillmentOrderStatus": "Complete",
"FulfillmentShipment":
{
"FulfillmentShipmentStatus": "Shipped",
"AmazonShipmentId": "DZRSmwG2N",
"EstimatedArrivalDateTime": "2014-12-19T22:59:59Z",
"FulfillmentShipmentPackages": [
{
"PackageNumber": 1,
"CarrierCode": "HERMESIT",
"TrackingNumber": "&0113838XXXXXX8300169397"
}
]
}
}
},
"NotificationMetadata":
{
"ApplicationId": "amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId": "7d78cc50-95c8-4641-add7-10af4b1fedc9",
"PublishTime": "2020-01-11T00:02:50.501Z",
"NotificationId": " 2012e8e5-b365-4cb1-9fd8-be9dfc6d5eaf"
}
}
ITEM_PRODUCT_TYPE_CHANGE
Os vendedores podem assinar esta notificação.
A Amazon envia uma notificação ITEM_PRODUCT_TYPE_CHANGE sempre que houver uma alteração no tipo de produto de qualquer item com o qual o parceiro de vendas tenha um relacionamento com a marca. Um parceiro de vendas tem um relacionamento de marca com um item, conforme definido no programa Amazon Registered Brands, quando é um proprietário de marca verificado. O parceiro de vendas é a parte que autoriza um aplicativo a chamar a API de Notificações em seu nome, com a finalidade de criar e gerenciar assinaturas de notificação. A Amazon envia notificações ITEM_PRODUCT_TYPE_CHANGE para itens listados em qualquer mercado da Amazon.
ITEM_PRODUCT_TYPE_CHANGE Payload schema: Version 1.0
Uma notificação ITEM_PRODUCT_TYPE_CHANGE com PayloadVersion=1.0 inclui os seguintes objetos no objeto Payload.
Objeto | Descrição |
---|---|
MarketplaceId | O mercado em que o item está listado. |
Asin | O ASIN do item. |
PreviousProductType | O tipo de produto anterior. |
CurrentProductType | O tipo de produto atual. |
Esquema de notificação: ItemProductTypeChangeNotification.json
Exemplo de notificação:
{
"NotificationVersion":"1.0",
"NotificationType":"ITEM_PRODUCT_TYPE_CHANGE",
"PayloadVersion":"1.0",
"EventTime":"2019-03-20T18:59:30.194Z",
"Payload":{
"MarketplaceId": "ATVPDKIKX0DER",
"Asin": "B1234567",
"PreviousProductType": "PET_HEALTH_CARE",
"CurrentProductType": "PET_APPAREL"
},
"NotificationMetadata":{
"ApplicationId":"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId":"93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime":"2019-03-20T18:59:48.768Z",
"NotificationId":"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
}
}
LISTINGS_ITEM_STATUS_CHANGE
Os vendedores podem assinar esta notificação.
A Amazon envia uma notificação LISTRINGS_ITEM_STATUS_CHANGE quando o status de um item de listagem é alterado para um parceiro de vendas. As notificações de LISTINGS_ITEM_STATUS_CHANGE são publicadas quando um item de listagem é criado, excluído ou sua capacidade de compra é alterada. A carga de notificação fornece as informações e o status do item de listagens atuais. A Amazon envia notificações LISTRINGS_ITEM_STATUS_CHANGE para itens listados em qualquer mercado da Amazon.
Para recuperar detalhes associados adicionais sobre a listagem, como problemas de itens de listagem, chame a API do parceiro de vendas para itens de listagem. Para obter mais informações, consulte o Guia de caso de uso da API de itens de listagens.
O parceiro de vendas é a parte que autoriza um aplicativo a chamar a API de Notificações em seu nome com a finalidade de criar e gerenciar assinaturas de notificação.
LISTINGS_ITEM_STATUS_CHANGE Payload schema: Version 1.0
Uma notificação LISTINGS_ITEM_STATUS_CHANGE com PayloadVersion=1.0 inclui os seguintes objetos no objeto Payload.
Nome | Descrição | Tipo | Requerido |
---|---|---|---|
SellerID | Identificador de parceiro de venda, como uma conta de vendedor (comerciante), do item de listagem afetado. | string | Sim |
MarketplaceId | Identificador de mercado da Amazon do item de listagem afetado. | string | Não |
Asin | O identificador do Amazon Standard Identification Number (ASIN) do item de catálogo associado ao item de listagem. | string | Não |
Sku | Identificador do item de listagens afetado. | string | Sim |
CreatedDate | Carimbo de data e hora de quando o item de listagem foi criado, formatado como data-hora ISO8601. | string | Não |
Status | Lista de estados de status atualmente associados ao item de listagens afetado. A ausência de um valor indica que o estado do status não é aplicável no momento ao item de listagens. Por exemplo, se "COMPRAR" não estiver presente, o item da listagem não poderá ser comprado no momento. | Array de ListingsItemStatus | Sim |
Esta tabela mostra os valores possíveis para ListingsItemStatus:
Nome | Descrição |
---|---|
BUYABLE | Indica que o item da lista está disponível para compra no site de varejo da Amazon para o mercado da Amazon correspondente. Quando fornecido, o item da lista é comprável. Quando omitido, o item de listagem não é comprável. |
DISCOVERABLE | Indica que o item de catálogo da Amazon associado (ASIN) pode ser descoberto nos resultados de pesquisa no site de varejo da Amazon para o mercado da Amazon correspondente. Quando fornecido, o item de listagens é detectável. Quando omitido, o item de listagens não é detectável. |
DELETED | Quando fornecido, o item de listagem é excluído. Quando omitido, o item de listagens não é excluído. |
Esquema de notificação: ListingsItemStatusChangeNotification.json
Exemplo de notificação:
{
"NotificationVersion":"1.0",
"NotificationType":"LISTINGS_ITEM_STATUS_CHANGE",
"PayloadVersion":"1.0",
"EventTime":"2021-02-03T18:59:30.194Z",
"Payload":{
"SellerId": "AXXXXXXXXXXXXX",
"MarketplaceId": "ATVPDKIKX0DER",
"Asin": "BT6RZ7JM4H",
"Sku": "NLS-SHOES-03",
"CreatedDate": "2021-02-03T18:50:26.196Z",
"Status": [
"BUYABLE",
"DISCOVERABLE"
]
},
"NotificationMetadata":{
"ApplicationId":"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId":"93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime":"2021-02-03T18:59:30.194Z",
"NotificationId":"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
}
}
LISTINGS_ITEM_ISSUES_CHANGE
Vendedores e vendedores podem assinar esta notificação.
A Amazon envia uma notificação LISTINGS_ITEM_ISSUES_CHANGE sempre que houver uma alteração nos problemas associados a um item de listagem de propriedade do parceiro de vendas. Os problemas indicam que o item de listagem tem problemas que causam listagem inativa, supressão de pesquisa ou outros problemas de qualidade. Por exemplo, se a imagem do produto do parceiro de vendas tiver baixa resolução, esse problema causará a supressão de pesquisa para este produto. A Amazon envia notificações LISTRINGS_ITEM_ISSUES_CHANGE para itens listados em qualquer mercado da Amazon.
As notificações de LISTINGS_ITEM_ISSUES_CHANGE são acionadas quando um problema em uma listagem é criado, corrigido ou atualizado. A carga de notificação inclui informações básicas de listagem, gravidade do problema relacionado e ações de imposição causadas por problemas. Para obter mais detalhes sobre problemas associados a uma listagem, chame a Selling Partner API for Listings Items. Para obter mais informações, consulte o Guia de caso de uso da API de itens de listagens.
Todos os problemas que podem ocorrer com uma listagem não têm problemas definidos correspondentes. Como resultado, essa notificação não representa necessariamente todos os problemas com uma listagem (nem a API do parceiro de vendas para itens de listagem). A Amazon está trabalhando para definir mais problemas para representar mais de perto os problemas de listagens que podem ocorrer.
O parceiro de vendas é a parte que autoriza um aplicativo a chamar a API de Notificações em seu nome com a finalidade de criar e gerenciar assinaturas de notificação.
LISTINGS_ITEM_ISSUES_CHANGE Payload schema: Version 1.0
Uma notificação LISTINGS_ITEM_ISSUES_CHANGE com PayloadVersion=1.0 inclui os seguintes objetos no objeto Payload.
Nome | Descrição | Tipo | Requerido |
---|---|---|---|
SellerId | Identificador de parceiro de venda, como uma conta de vendedor (comerciante) ou código de fornecedor, do item de listagem afetado. | string | Sim |
MarketplaceId | Identificador de mercado da Amazon do item de listagem afetado. | string | Não |
Asin | O identificador do Amazon Standard Identification Number (ASIN) do item de catálogo associado ao item de listagem. | string | Não |
Sku | Identificador do item de listagens afetado. | string | Sim |
Severities | Lista de gravidades para os problemas associados ao item de listagem afetado. Quando nenhum problema está afetando o item de listagem, "NONE" é fornecido. | Array de IssueSeverity | Sim |
EnforcementActions | Lista de ações de fiscalização tomadas pela Amazon para os problemas associados ao item de listagem afetado. | Array de IssueEnforcementActions | Não |
Esta tabela mostra os valores possíveis para IssueSeverity:
Nome | Descrição |
---|---|
ERROR | Quando fornecido, pelo menos um problema com a gravidade "ERROR" está afetando o item de listagem. |
WARNING | Quando fornecido, pelo menos um problema com a gravidade "WARNING" está afetando o item de listagem. |
NONE | Quando fornecido, não há problemas definidos que afetem o item de listagens. No entanto, pode haver outros problemas com a listagem. |
Esta tabela mostra os valores possíveis para IssueEnforcementActions:
Nome | Descrição |
---|---|
SEARCH_SUPPRESSED | Quando fornecido, o item da listagem é suprimido dos resultados da pesquisa causado por pelo menos um problema atualmente associado ao item da listagem afetado. |
Esquema de notificação: ListingsItemIssuesChangeNotification.json
Exemplo de notificação:
{
"NotificationVersion":"1.0",
"NotificationType":"LISTINGS_ITEM_ISSUES_CHANGE",
"PayloadVersion":"1.0",
"EventTime":"2021-02-03T18:59:30.194Z",
"Payload":{
"SellerId": "AXXXXXXXXXXXXX",
"MarketplaceId": "ATVPDKIKX0DER",
"Asin": "BT6RZ7JM4H",
"Sku": "NLS-SHOES-03",
"Severities": [
"ERROR",
"WARNING"
],
"EnforcementActions": [
"SEARCH_SUPPRESSED"
]
},
"NotificationMetadata":{
"ApplicationId":"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId":"93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime":"2021-02-03T18:59:30.194Z",
"NotificationId":"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
}
}
MFN_ORDER_STATUS_CHANGE
Os vendedores podem assinar esta notificação.
A notificação MFN_ORDER_STATUS_CHANGE é enviada sempre que houver uma alteração no status de disponibilidade de um pedido MFN.
MFN_ORDER_STATUS_CHANGE Payload schema: Version 1.0
Uma notificação MFN_ORDER_STATUS_CHANGE com PayloadVersion=1.0 inclui as seguintes propriedades no objeto MFNOrderNotification.
Nome | Descrição | Tipo | Requerido |
---|---|---|---|
SellerId | O identificador do parceiro de vendas. | string | Sim |
MarketplaceId | O identificador do mercado. | string | Sim |
AmazonOrderId | Um identificador de pedido definido pela Amazon no formato 3-7-7. | string | Sim |
PurchaseDate | A data de compra do pedido no horário Epoch. | inteiro ou nulo | Sim |
OrderStatus | O status atual do pedido. | string | Sim |
DestinationPostalCode | O código postal de destino. Observação: este código postal está temporariamente indisponível e aparecerá na notificação como um valor nulo. | string ou nulo | Sim |
SupplySourceId | O identificador exclusivo da fonte de fornecimento. | string ou nulo | Sim |
OrderItemId | O identificador de item de pedido definido pela Amazon. | string | Sim |
SellerSKU | O identificador de SKU específico do vendedor para um item. | string | Sim |
Quantity | O número de itens no pedido. | string | Sim |
Esquema de notificação: MfnOrderStatusChangeNotification.json
Exemplo de notificação:
{
"NotificationVersion": "1.0",
"NotificationType": "MFN_ORDER_STATUS_CHANGE",
"PayloadVersion": "1.0",
"EventTime": "2020-07-13T19:42:04.284Z",
"Payload":
{
"MFNOrderStatusChangeNotification":
{
"SellerId": "AXXXXXXXXXXXXX",
"MarketplaceId": "ATVPDKIKX0DER",
"AmazonOrderId": "333-7777777-7777777",
"PurchaseDate": 1595882000633,
"OrderStatus": "SHIPPING",
"DestinationPostalCode": "48110",
"SupplySourceId": "55448834-0d79-5155-75c4-8529543a7c31",
"OrderItemId": "OIID34853450",
"SellerSKU": "SellerSKUID1",
"Quantity": 45
}
},
"NotificationMetadata":
{
"ApplicationId": "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"SubscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"PublishTime": "2020-07-13T19:42:04.284Z",
"NotificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
ORDER_STATUS_CHANGE
Os vendedores podem assinar esta notificação.
A notificação ORDER_STATUS_CHANGE é enviada sempre que houver alteração no status de disponibilidade do pedido.
ORDER_STATUS_CHANGE Payload schema: Version 1.0
A notificação ORDER_STATUS_CHANGE com PayloadVersion=1.0 inclui as seguintes propriedades no objeto OrderNotification.
Nome | Descrição | Tipo | Requerido |
---|---|---|---|
Esquema de notificação: OrderStatusChangeNotification.json
Exemplo de notificação:
{
"NotificationVersion": "1.0",
"NotificationType": "ORDER_STATUS_CHANGE",
"PayloadVersion": "1.0",
"EventTime": "2020-07-13T19:42:04.284Z",
"Payload":
{
"OrderStatusChangeNotification":
{
"SellerId": "AXXXXXXXXXXXXX",
"MarketplaceId": "ATVPDKIKX0DER",
"AmazonOrderId": "333-7777777-7777777",
"PurchaseDate": 1595882000633,
"OrderStatus": "Unshipped",
"DestinationPostalCode": "48110",
"SupplySourceId": "55448834-0d79-5155-75c4-8529543a7c31",
"OrderItemId": "OIID34853450",
"SellerSKU": "SellerSKUID1",
"Quantity": 45,
"FulfillmentChannel": "MFN"
}
},
"NotificationMetadata":
{
"ApplicationId": "app-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"SubscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"PublishTime": "2020-07-13T19:42:04.284Z",
"NotificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
PRICING_HEALTH
Os vendedores podem assinar esta notificação.
A notificação PRICING_HEALTH é enviada sempre que uma oferta do vendedor não é elegível para ser a Oferta em Destaque (oferta Buy Box) devido a um preço não competitivo. Os vendedores podem tomar medidas para restaurar a qualificação da oferta em destaque ajustando o preço total de uma oferta (preço mais frete menos pontos) para que corresponda ou seja inferior ao preço competitivo ou esteja de acordo com os preços de referência fornecidos. Isso inclui o preço da Oferta em Destaque, o preço médio de venda de 60 dias, o preço mais alto de 14 dias (enviado e vendido pela Amazon) e o preço de tabela. Para ser elegível para a Oferta em Destaque, você deve ter preços competitivos e atender a outros critérios de qualificação projetados para oferecer aos clientes uma ótima experiência de compra, incluindo ótimos preços, disponibilidade e velocidade de entrega. A Oferta em Destaque é a oferta selecionada quando o cliente escolhe Adicionar ao Carrinho na página de detalhes do produto.
A notificação PRICING_HEALTH com payloadVersion=1.0 inclui as seguintes propriedades no objeto de carga útil.
Nome | Descrição |
---|---|
issueType | O tipo de problema para a notificação. Requerido. Tipo: string |
sellerId | O identificador do vendedor para a oferta. Requerido. Tipo: string |
offerChangeTrigger | O evento que causou o envio da notificação. Requerido. Tipo: offerChangeTrigger |
merchantOffer | Detalhes da oferta do comerciante que recebe a notificação. Requerido. Tipo: merchantOffer |
summary | Informações sobre o item que teve a oferta alterada. As informações neste resumo se aplicam a todas as condições do produto. Requerido. Tipo: summary |
A tabela a seguir mostra os objetos e propriedades do objeto buyBoxPrice:
Nome | Descrição |
---|---|
condition | Indica a condição do item. Requerido. Tipo: string |
landedPrice | O preço do anúncio mais o frete. Requerido. Tipo: moneyType |
listingPrice | O preço do item. Requerido. Tipo: moneyType |
shipping | O custo de envio. Requerido. Tipo: moneyType |
points | O número de Amazon Points oferecidos com a compra de um item. Opcional. Tipo: points |
A tabela a seguir mostra os objetos e propriedades do objeto merchantOffer:
Nome | Descrição |
---|---|
condition | Indica a condição do item. Requerido. Tipo: string |
fulfillmentType | Indica se o item é processado pela Amazon ou pelo vendedor. Requerido. Tipo: string |
landedPrice | O preço do anúncio mais o frete. Requerido. Tipo: moneyType |
listingPrice | O preço do item. Requerido. Tipo: moneyType |
shipping | O custo de envio. Requerido. Tipo: string |
points | O número de Amazon Points oferecidos com a compra de um item. Opcional. Nota: O objeto Points só é retornado no Japão (JP). Tipo: points |
A tabela a seguir mostra os objetos e propriedades do objeto offerChangeTrigger:
Nome | Descrição |
---|---|
marketplaceId | O identificador de mercado do item que teve uma alteração de oferta. Requerido. Tipo: string |
asin | O ASIN para o item que teve uma mudança de oferta. Requerido. Tipo: string |
itemCondition | A condição do item que teve uma mudança de oferta. Requerido. Tipo: string |
timeOfOfferChange | O tempo de atualização da oferta que causou essa notificação. Opcional. Tipo: string |
A tabela a seguir mostra os objetos e propriedades do objeto offerCount:
Nome | Descrição |
---|---|
condition | Indica a condição do item. Requerido. Tipo: string |
fulfillmentType | Indica se o item é processado pela Amazon ou pelo vendedor. Requerido. Tipo: string |
offerCount | O número total de ofertas para a condição especificada e o canal de atendimento. Requerido. Tipo: inteiro |
A tabela a seguir mostra os objetos e as propriedades do objeto de pontos:
Nome | Descrição |
---|---|
pointsNumber | O número de Amazon Points oferecidos com a compra de um item. Requerido. Tipo: inteiro |
A tabela a seguir mostra os objetos e as propriedades do objeto referencePrice:
Nome | Descrição |
---|---|
averageSellingPrice | O preço médio de venda do item. Opcional. Tipo: moneyType |
competitivePriceThreshold | O limite de preço competitivo de concorrentes externos da Amazon. Opcional. Tipo: moneyType |
retailOfferPrice | O preço máximo de 14 dias da oferta de varejo. Opcional. Tipo: moneyType |
msrpPrice | O fabricante sugeriu preço de varejo para o ASIN. Opcional. Tipo: moneyType |
A tabela a seguir mostra os objetos e propriedades do objeto salesRank:
Nome | Descrição |
---|---|
productCategoryId | A categoria de produto para a classificação. Requerido. Tipo: string |
rank | A classificação de vendas do ASIN. Requerido. Tipo: inteiro |
A tabela a seguir mostra os objetos e as propriedades do objeto de resumo:
Nome | Descrição |
---|---|
numberOfOffers | Uma lista que contém o número total de ofertas para o item para as condições e canais de atendimento fornecidos. Requerido. Tipo: array de offerCount |
buyBoxEligibleOffers | Uma lista que contém o número total de ofertas qualificadas para a caixa de compra para as condições e canais de atendimento fornecidos. Requerido. Tipo: array de offerCount |
buyBoxPrices | Uma lista que contém o preço da caixa de compra do item para as condições fornecidas. Opcional. Tipo: array de buyBoxPrice |
salesRankings | Uma lista que contém as classificações de vendas do ASIN em várias categorias de produtos. Opcional. Tipo: array de salesRank |
referencePrice | Um conjunto de preços de referência para um determinado ASIN. Requerido. Tipo: referênciaPreço |
Esquema de notificação: PricingHealthNotification.json
Exemplo de notificação:
{
"notificationVersion": "1.0",
"notificationType": "PRICING_HEALTH",
"payloadVersion": "1.0",
"eventTime": "2020-09-23T21:30:13.713Z",
"payload":
{
"issueType": "BuyBoxDisqualification",
"sellerId": "A3EZFOFNDPFB8R",
"offerChangeTrigger":
{
"marketplaceId": "ATVPDKIKX0DER",
"asin": "B007IBIWZY",
"itemCondition": "new",
"timeOfOfferChange": "2020-09-23T21:30:13.409Z"
},
"merchantOffer":
{
"condition": "new",
"fulfillmentType": "MFN",
"listingPrice":
{
"amount": 8184.23,
"currencyCode": "USD"
},
"shipping":
{
"amount": 4.49,
"currencyCode": "USD"
},
"landedPrice":
{
"amount": 8188.72,
"currencyCode": "USD"
},
"points":
{
"pointsNumber": 34343
}
},
"summary":
{
"numberOfOffers": [
{
"condition": "new",
"fulfillmentType": "MFN",
"offerCount": 3
}
],
"buyBoxEligibleOffers": [
{
"condition": "new",
"fulfillmentType": "MFN",
"offerCount": 3
}
],
"buyBoxPrices": [
{
"condition": "new",
"listingPrice":
{
"amount": 8184.23,
"currencyCode": "USD"
},
"shipping":
{
"amount": 4.49,
"currencyCode": "USD"
},
"landedPrice":
{
"amount": 8188.72,
"currencyCode": "USD"
},
"points":
{
"pointsNumber": 34343
}
}
],
"salesRankings": [
{
"productCategoryId": "lawn_and_garden_display_on_website",
"rank": 4013
},
{
"productCategoryId": "home_garden_display_on_website",
"rank": 17316
}
],
"referencePrice":
{
"averageSellingPrice":
{
"amount": 7500,
"currencyCode": "USD"
},
"competitivePriceThreshold":
{
"amount": 8000,
"currencyCode": "USD"
},
"msrpPrice":
{
"amount": 7900,
"currencyCode": "USD"
},
"retailOfferPrice":
{
"amount": 8000,
"currencyCode": "USD"
}
}
}
},
"notificationMetadata":
{
"applicationId": "amzn1.sellerapps.app.1da85d14-a68d-4ff3-9ff0-df6429e00d9a",
"subscriptionId": "e3a059ca-677a-442a-8d39-05b2848971b6",
"publishTime": "2020-09-23T21:30:16.903Z",
"notificationId": "23ae41cd-3537-4676-af46-6ee9abf8802e"
}
}
PRODUCT_TYPE_DEFINITIONS_CHANGE
Vendedores e vendedores podem assinar esta notificação.
A notificação PRODUCT_TYPE_DEFINITIONS_CHANGE é enviada sempre que há um novo tipo de produto ou versão de tipo de produto.
Se a notificação for acionada pela adição de um ou mais novos tipos de produtos em um mercado, a carga útil da notificação fornecerá os nomes dos novos tipos de produtos e a versão do tipo de produto aplicável a esses tipos de produto.
Se a notificação for acionada apenas por uma nova versão do tipo de produto, a carga útil da notificação fornecerá a nova versão do tipo de produto.
Para obter mais informações sobre tipos de produtos, consulte o Guia de casos de uso da API de definições de tipo de produto.
PRODUCT_TYPE_DEFINITIONS_CHANGE Payload schema: Version 1.0
Uma notificação PRODUCT_TYPE_DEFINITIONS_CHANGE com PayloadVersion=1.0 inclui as seguintes propriedades no objeto Payload.
Nome | Descrição | Tipo | Requerido |
---|---|---|---|
AccountId | O identificador do parceiro de vendas, como uma conta de vendedor (comerciante) ou ID de grupo de fornecedores. | string | Sim |
MarketplaceId | Identificador de mercado da Amazon do tipo de produto afetado ou versão do tipo de produto. | string | Não |
ProductTypeVersion | Versão da definição de tipo de produto da Amazon lançada. | string | Sim |
NewProductTypes | Lista de tipos de produtos lançados em um mercado. | Array de string | Não |
Esquema de notificação: ProductTypeDefinitionsChangeNotification.json
Exemplo de notificação:
Exemplo 1: notificação com novos tipos de produtos
{
"NotificationVersion":"1.0",
"NotificationType":"PRODUCT_TYPE_DEFINITIONS_CHANGE",
"PayloadVersion":"1.0",
"EventTime":"2021-02-03T18:59:30.194Z",
"Payload":{
"AccountId": "AXXXXXXXXXXXXX",
"MarketplaceId": "ATVPDKIKX0DER",
"ProductTypeVersion": "Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr",
"NewProductTypes":[
"LUGGAGE",
"SHOES",
]
},
"NotificationMetadata":{
"ApplicationId":"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId":"93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime":"2021-02-03T18:59:30.194Z",
"NotificationId":"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
}
}
Exemplo 2: notificação com alteração de versão do tipo de produto
{
"NotificationVersion":"1.0",
"NotificationType":"PRODUCT_TYPE_DEFINITIONS_CHANGE",
"PayloadVersion":"1.0",
"EventTime":"2021-02-03T18:59:30.194Z",
"Payload":{
"AccountId": "AXXXXXXXXXXXXX",
"ProductTypeVersion": "Uyp-Z6z_y2HhQD2x8sDBXkRAuxBqBionr"
},
"NotificationMetadata":{
"ApplicationId":"amzn1.sellerapps.app.f1234566-aaec-55a6-b123-bcb752069ec5",
"SubscriptionId":"93b098e1-c42-2f45-93a1-78910a6a8369",
"PublishTime":"2021-02-03T18:59:30.194Z",
"NotificationId":"0e999936-da2c-4f9c-9fc2-02b67bae5f49"
}
}
REPORT_PROCESSING_FINISHED
Os vendedores podem assinar esta notificação.
A notificação REPORT_PROCESSING_FINISHED é enviada sempre que qualquer relatório que você solicitou usando a API do parceiro de vendas para relatórios atingir um status de processamento de relatório CONCLUÍDO, CANCELADO ou FATAL.
REPORT_PROCESSING_FINISHED Payload schema: Version 1.0
A notificação REPORT_PROCESSING_FINISHED com PayloadVersion=2020-09-04 inclui os seguintes objetos no objeto reportProcessingFinishedNotification.
Nome | Descrição | Tipo | Requerido |
---|---|---|---|
sellerId | O identificador do parceiro de vendas. | string | Sim |
reportId | O identificador do relatório. | string | Sim |
reportType | O tipo de relatório. Para obter mais informações, consulte reportType values. | string | Sim |
processingStatus | O status de processamento do relatório. | string | Sim |
reportDocumentId | O identificador do documento de relatório. Esse identificador é exclusivo apenas em combinação com um ID de vendedor. | string | Não |
Esquema de notificação: ReportProcessingFinishedNotification.json
*Exemplo de notificação**:
{
"notificationVersion": "2020-09-04",
"notificationType": "REPORT_PROCESSING_FINISHED",
"payloadVersion": "2020-09-04",
"eventTime": "2020-07-14T03:35:13.214Z",
"payload":
{
"reportProcessingFinishedNotification":
{
"sellerId": "AXXXXXXXXXXXXX",
"reportId": "54517018502",
"reportType": "GET_FLAT_FILE_ACTIONABLE_ORDER_DATA",
"processingStatus": "CANCELLED",
"reportDocumentId": "amzn1.tortuga.3.edbcd0d8-3434-8222-1234-52ad8ade1208.REP4567URI9BMZ"
}
},
"notificationMetadata":
{
"applicationId": "amzn1.sellerapps.app.aacccfff-4455-4b7c-4422-664ecacdd336",
"subscriptionId": "subscription-id-d0e9e693-c3ad-4373-979f-ed4ec98dd746",
"publishTime": "2020-07-13T19:42:04.284Z",
"notificationId": "d0e9e693-c3ad-4373-979f-ed4ec98dd746"
}
}
Tipos comuns
Contém tipos comuns que são usados por todas as notificações contidas nos objetos de carga útil Notification.
FulfillmentChannelType
Indica se o item é processado pela Amazon ou pelo vendedor.
Tipo: string
Valores FulfillmentChannelType:
-
Amazon
-
Merchant
moneyType
Tipo de moeda e quantidade.
A tabela a seguir mostra as propriedades do objeto MoneyType:
Nome | Descrição |
---|---|
amount | O valor da moeda. Tipo: integer |
currencyCode | Código de moeda de três dígitos. No formato ISO 4217. Tipo: string |
MoneyType
Tipo de moeda e quantidade.
A tabela a seguir mostra as propriedades do objeto MoneyType:
Nome | Descrição |
---|---|
Amount | O valor da moeda. Tipo: integer |
CurrencyCode | Código de moeda de três dígitos. No formato ISO 4217. Tipo: string |
Updated over 2 years ago