Confira a versão atualizada desse guia de integração com marketplace em nosso Developer Portal.

Este documento auxilia na integração de um Marketplace não hospedado na plataforma VTEX com um Seller hospedado na plataforma VTEX.

As ações necessárias para montar essa integração, do lado do Marketplace, podem ser divididas em dois blocos:

• A) Ações referentes à atualização de catálogo (troca de catálogo, mudança de preço ou mudança no estoque de um SKU);
• B) Ações referentes ao envio e processamento de pedidos (simulação de carrinho, envio de pedidos, autorização de despacho, recebimento de nota fiscal, rastreamento de transportadora e cancelamento).

Neste artigo, você confere a visão geral do processo de integração de ambos os blocos, além de ter acesso aos links com o passo a passo específico de cada ação.

Alguns Conceitos:

Seller - Dono do produto, responsável pelo fullfilment, ou seja, por cumprir com a entrega do SKU.

Marketplace/Afiliado - Dono da vitrine (onde o cliente final vê o produto), responsável por expor e fazer a venda do SKU.

SKU - Item a ser trocado e vendido entre Marketplace e Seller.

Política Comercial - Sortimento de produtos, preços e configurações de logística que determina as características de um canal de venda.

Endpoint - Ponto de acesso de um serviço na internet, serviço pronto para receber uma requisição e devolver uma resposta.

MarketplaceServicesEndpoint - Ponto de acesso onde o Seller VTEX entrega ao Marketplace informações sobre o pedido, como a nota fiscal e o código de rastreamento de pedido.

• Dentro da loja hospedada na VTEX (Seller), será cadastrado um afiliado (ou seja, o Marketplace), que é o interessado em receber o catálogo e as atualizações nos SKUs.
• O Marketplace deve implementar um endpoint onde receberá notificações sobre quaisquer alterações de preço, estoque ou catálogo do seller.
• No Seller VTEX, cada vez que um SKU comercializado pelo Marketplace sofrer uma alteração de preço, estoque ou no catálogo, o endpoint de notificação do afiliado será chamado.
• Quando o Marketplace é notificado pelo Seller de que um SKU sofreu essa alteração, o Marketplace deve checar se atualmente comercializa aquele SKU.

Caso SIM: O Marketplace usa a API do Catálogo para obter no Seller os dados do SKU e guarda esses dados.

Caso NÃO: O Marketplace usa a API do Catálogo para obter no Seller os dados do SKU e decidir se deseja incluí-lo na loja ou não.

1. Marketpalce recebe notificação de mudança de preço, estoque ou catálogo.

2. Marketplace busca dados de SKU no Seller pela API do Catálogo.

3. Marketplace busca preço, estoque e dados de frete do SKU pela API de Fullfillment.

Saiba mais na documentação para desenvolvedores External Marketplace.

O fluxo de integrações referente ao envio e processamento de pedidos pode ser dividido em três momentos, cada um com ações específicas:

• Produto é inserido no carrinho do Marketplace ou ocorre a edição de produtos no carrinho.
• Marketplace precisa fazer consulta de simulação de carrinho no Seller para checar preço e estoque.

OBS: quando o cliente fecha o pedido e vai para o pagamento, outra simulação de carrinho deve ser feita.

• Pedido é fechado no Marketplace.
• Marketplace insere pedido no endpoint do Seller.
• Pagamento do pedido é concluído no Marketplace.
• Marketplace faz chamada no endpoint do Seller para autorizar despacho de pedido.

• Seller chama Marketplace Services Endpoint para realizar três possíveis ações finais:
  • Informar nota fiscal.
  • Informar código de rastreamento da transportadora.
  • Enviar solicitação de cancelamento.

1. Simulação de carrinho.

2. Inserir pedido no Seller.

3. Autorizar despacho de pedido no Seller.

4. Informar Nota Fiscal.

5. Informar rastreamento da transportadora.

6. Enviar solicitação de cancelamento.

Saiba mais na documentação para desenvolvedores External Marketplace.