Na VTEX, o afiliado é um código que identifica o marketplace para o seller. O seller VTEX precisa configurar um código de afiliado para poder integrar com um marketplace VTEX, e essa configuração só é necessária quando o marketplace e o seller integrados são ambos lojas VTEX.
Quando o marketplace não é uma loja VTEX (como em integrações externas), ou quando a loja integra com um marketplace certificado (como Amazon ou Mercado Livre), o código do afiliado é criado automaticamente pela plataforma.
Como configurar
Para criar um novo ID do afiliado, siga os passos abaixo:
- No Admin VTEX, acesse Configurações da loja > Pedidos > Configurações, ou digite Pedidos na barra de busca no topo da página e e selecione Configurações da loja / Pedidos.
- Na aba Afiliados, Clique em
+ Novo afiliado. - Preencha os campos da tela, descritos abaixo, e em seguida clique em
Salvar.- Nome: designação do novo afiliado.
- ID: código identificador do afiliado, deve ser composto de três consoantes, sejam elas repetidas ou não. Vogais não são aceitas.
- Política comercial: número da política comercial que definirá o sortimento de catálogo, preço e estratégia de envio dos itens utilizados na integração com o marketplace.
- Email para notificações: endereço eletrônico que receberá notificações sobre a integração.
- Endpoint de busca: URL da aplicação que receberá notificações sobre produtos, preço, estoque, entre outras. O Endpoint de Search pode ser preenchido com o valor:
http://productnotification.vtexcommerce.com.br/api/notification/{NomeDoMarketplace}/{IdDoSeller}
Perceba que o valor {NomeDoMarketplace} deve ser alterado pelo nome da conta do marketplace e o valor {IdDoSeller} deve ser alterado para o ID do seller cadastrado pelo marketplace.
O valor {IdDoSeller} é case sensitive. Dessa forma, ele deverá ser escrito na URL exatamente da mesma maneira que estiver cadastrado no marketplace.
Para casos de marketplaces externos à VTEX, preencha com o valor:
https://{endpointDoAfiliado}/api/notification/.
Saiba mais em nosso artigo no Developer Portal How to confugure the affiliate endpoint.
- Versão do endpoint de busca: insira a opção padrão 1.x.x.
- Usar meu meio de pagamento: é o split de pagamento, voltado para que ele seja transacionado pelo seller. Isto é, o Marketplace fecha o pedido, mas envia o pagamento para o dono do produto realizar. Recomendado utilizar apenas em integrações de VTEX com VTEX por compatibilidade de meios de pagamento.
Para esta modalidade, não é necessário que o seller possua as mesmas formas de pagamento que o marketplace.