Funções na API do parceiro de vendas

Saiba como usar funções na API do parceiro de vendas.

O que é uma função?

Uma função é o mecanismo usado pelas APIs do parceiro de vendas para determinar se um desenvolvedor ou aplicativo tem acesso a uma operação ou recurso. Como desenvolvedor, você deve solicitar e se qualificar para uma função específica, ou não poderá acessar as operações e os recursos agrupados sob essa função. As funções protegem o acesso a informações de identificação pessoal (PII) e outros dados confidenciais, além de limitar o acesso aos dados para garantir que os desenvolvedores acessem somente os dados necessários para um aplicativo. Isso ajuda a garantir que os clientes confiem na Amazon e nas empresas de serviços de parceiros de vendas que empregam as APIs de parceiros de vendas.

Definições de função

Na tabela a seguir, restrito indica que a função requer dados confidenciais que podem incluir informações de identificação pessoal (PII). Nesse caso, será necessário fornecer informações adicionais sobre o uso desses dados e os controles de segurança adotados.

Função Descrição
Análise de marca Acesse relatórios que contêm informações sobre o desempenho do vendedor e do fornecedor na Amazon e relatórios de comportamento do consumidor que fornecem informações sobre como os clientes encontram e compram os produtos de um parceiro de vendas na Amazon. Exemplos de operações que exigem essa atribuição de função:
  • O createReport operação da API do parceiro de vendas para relatórios, quando usada para solicitar a GET_BRAND_ANALYTICS_SEARCH_TERMS_REPORT relatório. Esse relatório retorna dados sobre os ASINs mais clicados por palavra-chave de pesquisa e departamento de um mercado.
  • O createReport operação da API do parceiro de vendas para relatórios, quando usada para solicitar a GET_PROMOTION_PERFORMANCE_REPORT relatório. Esse relatório retorna dados de campanhas promocionais para ajudar fornecedores e vendedores a otimizar suas promoções e ajustar suas estratégias de publicidade.
Consulte a Análise de marca para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.

Oferta de produtos Crie e gerencie ofertas de produtos. Geralmente usado para relatórios, feeds e operações relacionados ao catálogo de produtos. Exemplos de operações que exigem essa atribuição de função:
  • O getCatalogItem operação da API do parceiro de vendas para itens do catálogo, que retorna informações sobre o item indicado e seus atributos.
  • O createReport operação da API do parceiro de vendas para relatórios, quando usada para solicitar a GET_MERCHANT_LISTINGS_INACTIVE_DATA relatório. Esse relatório retorna listagens inativas detalhadas.
  • O getMyFeesEstimateForSKU operação da API do parceiro de vendas para taxas de produtos, que retorna as taxas estimadas para o item indicado.
Consulte Oferta de produtos para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.

Preços Determine os preços sugeridos e automatize os preços dos produtos. Geralmente usado para relatórios, feeds e operações relacionados a preços. Exemplos de operações que exigem essa atribuição de função:
  • O createFeed operação da API do parceiro de vendas para feeds quando usada para enviar um RFQ_UPLOAD_FEED alimentação. Isso permite que você faça upload de descontos por quantidade em resposta a solicitações de clientes corporativos.
  • O getPricing operação da API Selling Partner for Pricing, que retorna as informações de preços dos anúncios de ofertas de um vendedor.
  • O createReport operação da API do parceiro de vendas para relatórios, quando usada para solicitar a GET_MERCHANT_CANCELLED_LISTINGS_DATA relatório. Esse relatório retorna anúncios cancelados.
Consulte Preços para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.

Logística da Amazon Envie para a Amazon e a Amazon envia diretamente aos clientes (Logística da Amazon (FBA), Rede logística da Amazon (AFN)). Geralmente usado para relatórios de vendas do Logística da Amazon, relatórios de rastreamento de pedidos e operações relacionadas à gestão da logística de pedidos. Exemplos de operações que exigem essa atribuição de função:
  • O createReport operação da API do parceiro de vendas para relatórios, quando usada para solicitar a GET_FBA_ESTIMATED_FBA_FEES_TXT_DATA relatório. Este relatório contém as taxas estimadas de vendas e atendimento da Amazon.
  • O getSubscription operação da API do parceiro de vendas para notificações quando usada para assinar FBA_OUTBOUND_SHIPMENT_STATUS notificações. Essas notificações são enviadas sempre que criamos ou cancelamos uma remessa FBA para um vendedor.
  • O getLabels operação da API Selling Partner for Fulfillment Inbound, que retorna etiquetas de pacotes/paletes.
  • O createFeed operação da API do parceiro de vendas para feeds quando usada para enviar um POST_FBA_INBOUND_CARTON_CONTENTS alimentação. Isso permite que você envie informações sobre o conteúdo da embalagem ao enviar o inventário para a rede de distribuição da Amazon.
Consulte Logística da Amazon para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.

Comunicação com o comprador Gerencie mensagens de e para compradores da Amazon. Geralmente usado para enviar mensagens aos compradores da Amazon usando a API do parceiro de vendas para Mensagens. Exemplos de operações que exigem essa atribuição de função:
  • O getMessagingActionsForOrder operação da Selling Partner API for Messaging, que retorna uma lista dos tipos de mensagens disponíveis para um pedido específico.
  • O createConfirmOrderDetails operação da API do parceiro de vendas para mensagens, que envia uma mensagem para fazer ao comprador uma pergunta relacionada ao pedido antes do envio.
  • O createConfirmDeliveryDetails operação da API do parceiro de vendas para mensagens, que envia uma mensagem ao comprador para organizar uma entrega ou confirmar as informações de contato para fazer uma entrega.
Consulte Comunicação com o comprador para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.

Solicitação do comprador Solicite feedback dos compradores da Amazon. Geralmente usado para solicitar feedback dos compradores da Amazon usando a API do parceiro de vendas para Solicitações. Exemplos de operações que exigem a atribuição dessa função:
  • O getSolicitationActionsForOrder operação da API do parceiro de vendas para solicitações, que retorna uma lista dos tipos de solicitação disponíveis para um pedido.
  • O createProductReviewAndSellerFeedbackSolicitation operação, que envia uma solicitação a um comprador solicitando feedback e uma avaliação do produto de um pedido.
Consulte Solicitação do comprador para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.

Insights sobre parceiros de vendas Veja informações sobre a conta e o desempenho do parceiro de vendas da Amazon. Geralmente usado para relatórios e operações para devolver informações do vendedor. Exemplos de operações que exigem a atribuição dessa função:
  • O createReport operação da API do parceiro de vendas para relatórios, quando usada para solicitar a GET_V1_SELLER_PERFORMANCE_REPORT relatório. Esse relatório contém métricas de desempenho individuais do painel do Seller Central.
  • O getMarketplaceParticipations operação da API do parceiro de vendas para vendedores, que retorna uma lista de mercados nos quais um vendedor pode vender e informações sobre a participação do vendedor nesses mercados.
Consulte Insights sobre parceiros de vendas para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.

Finanças e contabilidade Produza demonstrações contábeis e financeiras. Geralmente usado para criar demonstrações contábeis e financeiras. Exemplos de operações que exigem a atribuição dessa função:
  • O getReports operação da API do parceiro de vendas para relatórios, quando usada para retornar uma lista dos GET_V2_SETTLEMENT_REPORT_DATA_FLAT_FILE relatórios criados.
  • O getSubscription operação da API do parceiro de vendas para notificações, quando usada para devolver informações sobre assinaturas ao FEE_PROMOTION tipo de notificação.
Consulte Finanças e contabilidade para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.

Rastreamento de inventário e pedidos Analise e gerencie o inventário. Geralmente usado para relatórios de vendas do Logística da Amazon, relatórios de rastreamento de pedidos e operações relacionadas a pedidos, pedidos de fornecedores, métricas de pedidos de vendas e gerenciamento de estoque. As operações que exigem essa função não usam as PII necessárias para enviar um pedido. Em vez disso, essa função é necessária para aplicativos que rastreiam remessas de pedidos para gerenciar estoque/fabricação/compras. Exemplos de operações que exigem a atribuição dessa função:
  • O createReport operação da API do parceiro de vendas para relatórios, quando usada para solicitar a GET_MERCHANT_LISTINGS_DATA relatório. Esse relatório retorna listagens ativas detalhadas.
  • O createFeed operação da API do parceiro de vendas para feeds quando usada para enviar um POST_FLAT_FILE_FULFILLMENT_DATA alimentação. Isso permite que você envie informações de atendimento de pedidos para a Amazon.
  • O getOrderMetrics operação da API Selling Partner for Sales, que retorna métricas agregadas de pedidos.
Consulte Rastreamento de inventário e pedidos para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.

Armazenamento e distribuição na Amazon Analyze and manage Amazon Warehousing and Distribution shipments and inventory. Generally used for interacting with AWD inventory information and shipment details using the Selling Partner API for Amazon Warehousing and Distribution. Examples of operations that require this role assignment:
  • A operação listInventory da API do parceiro de vendas para armazenamento e distribuição na Amazon, que retorna os níveis e estados de inventário dos produtos em AWD.
  • A operação getInboundShipment, que retorna detalhes sobre a remessa, como status e quantidades recebidas para reconciliação.
Consulte Armazenamento e distribuição na Amazon para obter uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.
Notificações no Seller Central Send targeted notifications to sellers within Seller Central. Using the App Integrations API v2024-04-01, you can send notifications that inform the seller about their business or to encourage the seller to take action on your website. Examples of operations that require this role assignment:
  • O createNotification A operação cria e envia uma notificação aos vendedores com informações relevantes para seus negócios.
  • O deleteNotifications a operação exclui uma notificação que foi enviada anteriormente a um vendedor.
Para obter uma lista completa das operações que requerem essa função, consulte a função Notificações no Seller Central.
Provedor de serviços de iniciação de pagamentos Permite o início de um pagamento no método de depósito do vendedor e a emissão de um reembolso (ajuste) para um pedido. Você pode usar a função de Provedor de Serviços de Iniciação de Pagamento (PISP) para visualizar as formas de pagamento do vendedor.
Para obter uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função, consulte Provedor de serviços de iniciação de pagamentos.
Para obter informações sobre o registro de desenvolvedores de fornecedores terceirizados, consulte Registro de fornecedor terceiri.
Provedor de serviços de informações de contas Fornece informações sobre a conta do Parceiro de Vendas da Amazon, incluindo informações sobre a empresa do vendedor e os mercados em que a conta do vendedor está ativa. Você pode usar a função de provedor de serviços de informações da conta (AISP) para visualizar formas de pagamento e eventos financeiros para o vendedor.
Para obter uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função, consulte Provedor de serviços de informações de contas.
Para obter informações sobre o registro de desenvolvedores de fornecedores terceirizados, consulte Registro de fornecedor terceiri.
Envio direto ao consumidor (restrito) Envie pedidos diretamente aos clientes usando a transportadora de sua escolha, incluindo a Amazon. As operações que exigem essa função usam PII para permitir o envio. Geralmente usado para relatórios de pedidos, relatórios de rastreamento de pedidos, EasyShip e para operações relacionadas ao envio de pedidos feitos na Amazon. Exemplos de operações que exigem a atribuição dessa função:
  • O getShipment operação da API Selling Partner for Merchant Fulfillment, que retorna as informações de remessa de uma remessa especificada.
  • O getOrders operação da API do parceiro de vendas para pedidos, que retorna uma lista de pedidos e informações do pedido com base nos critérios especificados.
  • O createReport operação da API do parceiro de vendas para relatórios, quando usada para solicitar a GET_FLAT_FILE_ ORDER_REPORT_DATA_SHIPPING relatório.
  • O createFeed operação da API do parceiro de vendas para feeds, quando usada para enviar um POST_ORDER_FULFILLMENT_DATA alimentação. Esse feed permite que seu sistema atualize o sistema da Amazon com informações de atendimento de pedidos.
Consulte Envio direto ao consumidor (restrito) para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.

Faturamento fiscal (restrito) Gere notas fiscais para cumprir a regulamentação tributária. As operações que exigem essa função exigem PII para permitir a geração de notas fiscais. Geralmente usado para relatórios fiscais e relatórios de pedidos e operações que retornam informações sobre pedidos. Exemplos de operações que exigem a atribuição dessa função:
  • O createReport operação da API do parceiro de vendas para relatórios, quando usada para solicitar a GET_AMAZON_FULFILLED_SHIPMENTS_INVOICING relatório. Esse relatório retorna informações detalhadas do pedido/remessa/item.
  • O getOrderAddress operação da API do parceiro de vendas para pedidos, que retorna o endereço de entrega de um pedido.
  • O getOrderBuyerInfo operação da API do parceiro de vendas para pedidos, que retorna as informações do comprador para um pedido.
  • O createReport operação da API do parceiro de vendas para relatórios, quando usada para solicitar a GET_EASYSHIP_DOCUMENTS relatório. Esse relatório contém a fatura, a etiqueta de envio e os documentos de garantia de um pedido do Easy Ship.
Consulte Faturamento fiscal (restrito) para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.
Remessa fiscal (restrito) Calculate and remit sales taxes. Operations that require this role might use PII to calculate sales taxes. Generally used for FBA Sales Reports and Order Reports and operations that return information about orders. Examples of operations that require this role assignment:
  • O createReport operação da API do parceiro de vendas para relatórios, quando usada para solicitar a GET_AMAZON_FULFILLED_SHIPMENTS_REMITTANCE relatório. Esse relatório retorna informações detalhadas do pedido/remessa/item.
  • O getOrderItems operação da API do parceiro de vendas para pedidos, que retorna informações detalhadas do item do pedido.
  • O getOrders operação da API do parceiro de vendas para pedidos, que retorna uma lista de informações do item do pedido para um período de tempo e uma série de critérios.
Consulte Remessa fiscal (restrito) para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.
Serviços profissionais (restrito) Provides add-on services such as Room of Choice Delivery, Assembly and Installation to Amazon buyers. Generally used to provide add-on services to Amazon buyers using the Selling Partner API for Services. Examples of operations that require this role assignment:
  • A operação getServiceJobs da API do parceiro de vendas para serviços, que retorna uma lista de detalhes do serviço com base nos filtros da consulta especificados.
  • A operação addAppointmentForServiceJobByServiceJobId, que adiciona um agendamento ao serviço indicado pelo identificador de serviço especificado.
Consulte Serviços profissionais para acessar uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem essa função.

Perguntas frequentes

Como faço para solicitar e me qualificar para uma função?

Você solicita e se qualifica para funções na API do parceiro de vendas preenchendo seu perfil de desenvolvedor. As informações específicas solicitadas dependem de você ter se cadastrado anteriormente.

Após o envio do seu perfil, a Amazon avalia as informações fornecidas e aprova ou recusa sua solicitação. Se a solicitação for recusada, você poderá resolver o motivo da recusa e reenviar seu perfil.

Como escolho as funções para meu aplicativo?

Ao criar seu aplicativo da API do parceiro de vendas na página de criação do cliente do aplicativo, você pode escolher funções dentre as que foram solicitadas e aprovadas em seu perfil de desenvolvedor. Se a função necessária estiver ausente, será necessário atualizar seu perfil de desenvolvedor para incluí-la e reenviar seu perfil para avaliação da Amazon. Após a aprovação, a função adicionada estará disponível para seleção no seu aplicativo.

Observação: se você tiver um aplicativo híbrido da SP-API publicado, deverá colocar novamente seu aplicativo em oferta antes da reautorização.

Como determino quais funções solicitar?

Analise as descrições das funções neste documento para entender a finalidade de cada uma e veja exemplos dos recursos e operações regidas por cada função. Para cada função, use o link fornecido para acessar a documentação com uma lista completa das operações e dos tipos de feed, relatório e notificação que exigem a função.

O que acontece quando eu chamo uma operação para a qual não tenho as funções necessárias?

A resposta à solicitação terá um código de status HTTP 403 e informações de erro no corpo da resposta.

Como adiciono uma nova função após a publicação do meu aplicativo?

Para adicionar uma nova função após a publicação do seu aplicativo, siga estas etapas:

  1. Acesse seu perfil de desenvolvedor e envie uma função para ser adicionada.
  2. Quando seu perfil do desenvolvedor for aprovado, acesse a configuração do seu aplicativo e aplique a função recém-aprovada ao aplicativo. Em seguida, salve as alterações e publique novamente o aplicativo.
  3. Depois que a inscrição for aprovada, obtenha novas autorizações para gerar um novo token de atualização que concederá acesso às operações, relatórios, feeds e notificações da API fornecida pela nova função.

Esta página ajudou você?