Funções da API do parceiro de vendas

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

As funções são o mecanismo pelo qual a API do parceiro de vendas (SP-API) determina se um desenvolvedor ou aplicativo tem acesso a uma operação ou recurso. As funções protegem o acesso a informações de identificação pessoal (PII) e outros dados confidenciais e garantem que os desenvolvedores acessem somente os dados exigidos pelo aplicativo.

Como desenvolvedor, você deve solicitar e se qualificar para uma função específica para obter acesso às operações e aos recursos que a função fornece. Use os tópicos a seguir para identificar qual função você precisa para cada operação e tipo de API da SP-API:

Definições de função

Nas seções a seguir, Restrito significa que a função exige informações confidenciais, que podem incluir informações de identificação pessoal (PII). Para essas funções, você deve fornecer informações adicionais sobre o uso de dados e os controles de segurança.

Provedor de serviços de informações de contas

A função Account Information Service Provider (AISP) fornece acesso a informações sobre a conta do Amazon Selling Partner, incluindo informações sobre a empresa do vendedor e os mercados em que a conta do vendedor está ativa. Você pode usar essa função para visualizar formas de pagamento e eventos financeiros do vendedor.

Selecione exemplos de operações que exigem essa função.

O getAccount operação do API de vendedores v1, que obtém informações sobre uma conta de vendedor e seus mercados.
O getPaymentMethods operação do API de transferências v2024-06-01, que retorna uma lista de formas de pagamento para o vendedor.

Logística da Amazon

A função Amazon Fulfillment fornece acesso às operações de atendimento e aos serviços de envio da Amazon, como Fulfillment by Amazon (FBA) e Amazon Fulfillment Network (AFN). Geralmente, você usa essa função para relatórios de vendas do FBA, relatórios de rastreamento de pedidos e operações relacionadas ao atendimento de pedidos.

Selecione exemplos de operações que exigem essa função.

O createReport operação do API de relatórios v2021-06-30, quando você solicita o Pré-visualização gratuita do FBA relatório. Este relatório contém as taxas estimadas de venda e atendimento da Amazon para o inventário FBA do vendedor com ofertas ativas.
O getSubscription operação do API de notificações v1, quando você assina FBA_OUTBOUND_SHIPMENT_STATUS notificações. Essas notificações significam quando a Amazon cria ou cancela uma remessa de Fulfillment by Amazon para um vendedor.
O listShipmentItems operação do API de entrada de atendimento v2024-03-20, que retorna uma lista de pacotes em uma remessa.
O createFeed operação do API de feeds v2021-06-30, quando você envia um POST_FBA_INBOUND_CARTON_CONTENTS alimentação. Esse feed 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.

Armazenamento e distribuição na Amazon

A função Amazon Warehousing and Distribution (AWD) fornece acesso às operações de envio e estoque da AWD. Geralmente, você usa essa função quando usa o API de armazenagem e distribuição da Amazon para interagir com as informações de inventário e detalhes da remessa da AWD.

Selecione exemplos de operações que exigem essa função.

O listInventory operação do API de armazenamento e distribuição da Amazon v2024-05-09, que retorna os níveis de estoque e os estados dos produtos em AWD.
O getInboundShipment operação do API de armazenamento e distribuição da Amazon v2024-05-09, que retorna detalhes da remessa, como status e quantidades recebidas, para reconciliação.

Análise de marca

A função Brand Analytics fornece acesso a relatórios de análise do mercado, como métricas de desempenho de vendedores e fornecedores e insights de comportamento do consumidor que mostram como os clientes descobrem e compram produtos na Amazon.

Selecione exemplos de operações que exigem essa função.

O createReport operação do API de relatórios v2021-06-30, quando você solicita o 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 do API de relatórios v2021-06-30, quando você solicita o 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.

Comunicação com o comprador

A função de comunicação com o comprador fornece acesso às operações que gerenciam mensagens de e para os compradores da Amazon. Geralmente, você usa essa função quando usa o API de mensagens para enviar mensagens aos compradores da Amazon.

Selecione exemplos de operações que exigem essa função.

O getMessagingActionsForOrder operação do API de mensagens v1, que retorna uma lista dos tipos de mensagens disponíveis para um pedido específico.
O createConfirmOrderDetails operação do API de mensagens v1, que envia uma mensagem para fazer ao comprador uma pergunta relacionada ao pedido antes do envio.
O createConfirmDeliveryDetails operação do API de mensagens v1, que envia uma mensagem ao comprador para agendar uma entrega ou confirmar as informações de contato para fazer uma entrega.

Solicitação do comprador

A função de Solicitação do Comprador fornece acesso às operações de solicitação de feedback do comprador. Geralmente, você usa essa função quando usa o API de solicitações para solicitar feedback dos compradores da Amazon.

Selecione exemplos de operações que exigem essa função.

O getSolicitationActionsForOrder operação do API de solicitações v1, que retorna uma lista dos tipos de solicitação que estão disponíveis para um pedido.
O createProductReviewAndSellerFeedbackSolicitation operação do API de solicitações v1, que envia uma solicitação a um comprador pedindo feedback e uma avaliação do produto de um pedido.

Envio direto ao consumidor (Restrito)

O envio direto ao consumidor A função (restrita) fornece acesso a operações que enviam pedidos diretamente aos clientes usando a operadora de sua escolha, incluindo a Amazon. As operações que exigem essa função usam PII para permitir o envio. Geralmente, você usa essa função para solicitar relatórios de pedidos, relatórios de rastreamento de pedidos, EasyShip e para operações relacionadas a pedidos de envio feitos na Amazon.

Selecione exemplos de operações que exigem essa função.

O getOrders operação do API de pedidos v0, que retorna uma lista de pedidos e informações do pedido com base nos critérios que você especificar.
O createReport operação do API de relatórios v2021-06-30, quando você solicita o GET_FLAT_FILE_ ORDER_REPORT_DATA_SHIPPING relatório.
O createFeed operação do API de feeds v2021-06-30, quando você envia 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.

Finanças e contabilidade

A função Finanças e Contabilidade fornece acesso às operações que criam demonstrações contábeis e financeiras.

Selecione exemplos de operações que exigem essa função.

O getReports operação do API de relatórios v2021-06-30, para retornar uma lista de Liquidação V2 de arquivo simples relatórios.
O getSubscription operação do API de notificações v1, quando você solicita informações sobre assinaturas do FEE_PROMOTION tipo de notificação.

Rastreamento de inventário e pedidos

A função de rastreamento de inventário e pedidos fornece acesso às operações que analisam e gerenciam o estoque. Geralmente, você usa essa função para obter relatórios de vendas do FBA, 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 é para aplicativos que rastreamento remessas.

Selecione exemplos de operações que exigem essa função.

O getOrderMetrics operação do API de vendas v1, que retorna métricas de pedidos agregadas.
O createReport operação do API de relatórios v2021-06-30, quando você solicita o GET_MERCHANT_LISTINGS_DATA relatório. Esse relatório retorna listagens ativas detalhadas.
O createFeed operação do API de feeds v2021-06-30, quando você envia um POST_FLAT_FILE_FULFILLMENT_DATA alimentação. Esse feed permite que você envie informações de atendimento de pedidos para a Amazon.

Notificações no Seller Central

A função Notificações na Central do Vendedor fornece acesso às operações que enviam notificações direcionadas aos vendedores na Central do Vendedor. Por exemplo, você pode usar o API de integrações de aplicativos para enviar notificações que informem o vendedor sobre seus negócios ou para incentivá-lo a agir em seu site.

Selecione exemplos de operações que exigem essa função.

O createNotification operação do API de integrações de aplicativos v2024-04-01 cria e envia uma notificação aos vendedores com informações relevantes para seus negócios.
O deleteNotifications operação do API de integrações de aplicativos v2024-04-01 exclui uma notificação que foi enviada anteriormente a um vendedor.

Provedor de serviços de iniciação de pagamentos

A função de Provedor de Serviços de Iniciação de Pagamentos (PISP) fornece acesso às operações que iniciam o pagamento pelo método de depósito do vendedor e a emissão de um reembolso (ajuste) para um pedido.

Selecione exemplos de operações que exigem essa função.

O initiatePayout operação do API de transferências v2024-06-01, que inicia um pagamento sob demanda para o método de depósito padrão do vendedor.
O createFeed operação do API de feeds v2021-06-30, quando você envia um POST_FLAT_FILE_PAYMENT_ADJUSTMENT_DATA alimentação.

Preços

A função de preços fornece acesso a operações que determinam os preços sugeridos e automatizam os preços dos produtos. Geralmente, você usa essa função para relatórios, feeds e operações relacionados a preços.

Selecione exemplos de operações que exigem essa função.

O getPricing operação do API de preços de produtos v2022-05-01, que retorna as informações de preços dos anúncios de ofertas de um vendedor.
O createFeed operação do API de feeds v2021-06-30, quando você envia um RFQ_UPLOAD_FEED alimentação. Esse feed permite que você faça upload de descontos por quantidade em resposta a solicitações de clientes corporativos.
O createReport operação do API de relatórios v2021-06-30, quando você solicita o GET_MERCHANT_CANCELLED_LISTINGS_DATA relatório. Esse relatório retorna anúncios cancelados.

Oferta de produtos

A função Lista de produtos fornece acesso às operações que criam e gerenciam listas de produtos. Geralmente, você usa essa função para relatórios, feeds e operações relacionados ao catálogo de produtos.

Selecione exemplos de operações que exigem essa função.

O getCatalogItem operação do API de itens do catálogo v2022-04-01, que retorna informações sobre o item indicado e seus atributos.
O createReport operação do API de relatórios v2021-06-30, quando você solicita o GET_MERCHANT_LISTINGS_INACTIVE_DATA relatório. Esse relatório retorna listagens inativas detalhadas.
O getMyFeesEstimateForSKU operação do Taxas de produtos API v0, que retorna as taxas estimadas para o item indicado.

Serviços profissionais (Restrito)

Os serviços profissionais A função (restrita) fornece acesso a operações que fornecem serviços complementares, como montagem e instalação, aos compradores da Amazon. Geralmente, você usa essa função quando usa o API de serviços v1.

Selecione exemplos de operações que exigem essa função.

O getServiceJobs operação do API de serviços v1, que retorna uma lista de detalhes do trabalho de serviço para a consulta de filtro especificada.
O addAppointmentForServiceJobByServiceJobId operação do API de serviços v1, que adiciona um compromisso ao trabalho de serviço indicado pelo identificador de trabalho de serviço especificado.

Insights sobre parceiros de vendas

A função Selling Partner Insights fornece acesso a operações que recuperam informações sobre a conta e o desempenho de um parceiro de vendas.

Selecione exemplos de operações que exigem essa função.

O getMarketplaceParticipations operação do API de vendedores v1, que retorna uma lista de lojas nas quais um vendedor pode vender e informações sobre a participação do vendedor nessas lojas.
O createReport operação do API de relatórios v2021-06-30, quando você solicita o GET_V1_SELLER_PERFORMANCE_REPORT relatório. Esse relatório contém métricas de desempenho individuais do painel do Seller Central.

Faturamento fiscal (Restrito)

O faturamento fiscal A função (restrita) fornece acesso a operações que geram 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, você usa essa função para relatórios fiscais, relatórios de pedidos e operações que retornam informações sobre pedidos.

Selecione exemplos de operações que exigem essa função.

O getOrderBuyerInfo operação do API de pedidos v0, que retorna as informações do comprador para um pedido.
O createReport operação do API de relatórios v2021-06-30, quando você solicita o GET_FLAT_FILE_VAT_INVOICE_DATA_REPORT relatório.
O createReport operação do API de relatórios v2021-06-30, quando você solicita o 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.

Remessa de impostos (Restrito)

A remessa de impostos A função (restrita) fornece acesso a operações que calculam e remetem impostos sobre vendas. As operações que exigem essa função podem usar PII para calcular impostos sobre vendas. Geralmente, você usa essa função para relatórios de vendas, relatórios de pedidos e operações do FBA que retornam informações sobre pedidos.

Selecione exemplos de operações que exigem essa função.

O getOrderItems operação do API de pedidos v0, que retorna informações detalhadas do item de um pedido.
O getOrderAddress operação do API de pedidos v0, que retorna o endereço de entrega de um pedido.
O createReport operação do API de relatórios v2021-06-30, quando você solicita o GET_ORDER_REPORT_DATA_TAX relatório.

Updated 7 days ago

Esta página ajudou você?