{"section":"tutorials","requestedLocale":"pt","requestedSlug":"campo-codigo-de-vendedor-no-checkout","locale":"pt","slug":"campo-codigo-de-vendedor-no-checkout","path":"docs/pt/tutorials/promoções-e-taxas/promoções/campo-codigo-de-vendedor-no-checkout.md","branch":"main","content":"Na VTEX, você pode criar um campo para registrar o código de vendedor no Checkout. Por meio dele, é possível:\n- Associar uma determinada ordem de compra a um vendedor.\n- Oferecer descontos exclusivos ao consumidor.\n- Administrar a performance de seus vendedores, extraindo dados como número de vendas / ticket médio por vendedor, ranking para comissionamento de vendas, entre outros.\n\n> ⚠️ O campo **código de vendedor** não substitui o campo **cupom de desconto** (nativo na plataforma VTEX). Ao realizar as configurações deste artigo, ambos poderão ser utilizados para oferecer descontos.\n\nPara criar o campo e inseri-lo na tela do Checkout de sua loja, três etapas são necessárias:\n\n1. [Criar nova entidade de dados](#criar-nova-entidade-de-dados)\n2. [Criar promoção Código do Vendedor](#criar-promocao-codigo-do-vendedor)\n3. [Customizar UI no Checkout](#customizar-ui-no-checkout)\n\n## Criar nova entidade de dados\n\nO campo **Código de Vendedor** deve ser registrado no [Master Data](/pt/docs/tutorials/master-data) como uma nova entidade. Para criar a entidade de dados, siga os passos abaixo:\n\n1. No Admin VTEX, acesse **Configurações da loja > Storefront > Master Data**, ou digite **Master Data** na barra de busca no topo da página.\n2. Crie uma nova [entidade de dados](/pt/docs/tutorials/entidade-de-dados#como-configurar) chamada *codigovendedor*.\n3. Dentro da nova entidade de dados, crie os seguintes campos:\n    - **Código do vendedor**: com valor máximo de 10 caracteres (tipo Varchar10).\n    - **Email**: endereço de email do vendedor (tipo Email).\n    - **Nome**: nome de vendedor (tipo Text).\n    - **Status**: indica se o vendedor está ativo ou inativo (tipo Boolean).\n    - **Loja**: identificação da loja onde o vendedor atua (tipo Text).\n    - Demais campos (conforme necessidade).\n\n<blockquote><ui>4. Cadastre as informações de cada vendedor nos campos criados no passo anterior.</ui>\n\n<blockquote><ui>5. Crie um [formulário](/pt/docs/tutorials/criando-formulario-no-master-data) para ter acesso às informações da nova entidade *codigovendedor* por meio da interface do Master Data.</ui>\n\n## Criar promoção Código do Vendedor\n\nApós a criação da entidade *codigovendedor*, é necessário associá-la a uma promoção. Para criar uma nova promoção, siga os passos abaixo:\n\n1. No Admin VTEX, acesse **Promoções > Promoções**, ou digite **Promoções** na barra de busca no topo da página.\n2. Crie uma nova [promoção regular](/pt/docs/tracks/criar-promocao-regular). Preencha as informações de **Dados gerais de promoção** e **A quais itens esta promoção será aplicada?** conforme desejado.\n\n> ℹ️ Caso deseje utilizar o campo código de vendedor para oferecer desconto no valor da compra, preencha as informações em **Tipo e valor de de desconto?**.\n\n<blockquote><ui>3. Em **Quais as condições para a promoção ser válida?**, clique na opção **utm_campaign** e digite no campo *codigovendedor*.</ui>\n\n![utm campaign codigovendedor](https://cdn.statically.io/gh/vtexdocs/help-center-content/refs/heads/main/docs/pt/tutorials/promoções-e-taxas/promoções/campo-codigo-de-vendedor-no-checkout_1.PNG)\n\n<blockquote><ui>4. Em **Restrições e limitações de uso**, adicione as demais restrições disponíveis, caso desejar. Selecione a opção **Permitir acumular promoções**.</ui>\n\n<blockquote><ui>5. Clique em **Salvar**.</ui>\n\n## Customizar UI no Checkout\n\nA última etapa consiste em configurar a tela do Checkout para permitir a exibição do campo **Código do Vendedor**. \n\nPara realizar esta customização, é necessário entrar em contato com a agência parceira responsável pela criação da sua loja e solicitar que o novo campo seja inserido, permitindo que o cliente insira o código do vendedor e o nome do mesmo seja exibido. \n\nAdicionalmente, os seguintes passos devem ser realizados:\n\n1. Ao simular uma compra e inserir o código do vendedor na tela do Checkout, certifique-se que a chamada GET [Search Documents](https://developers.vtex.com/docs/api-reference/master-data-api-v2#get-/api/dataentities/-dataEntityName-/search) realize a busca na entidade `codigovendedor` e retorne todas as informações cadastradas do vendedor. Exemplo de chamada: https://\\{accountName\\}.\\{environment\\}.com.br/api/dataentities/codigovendedor/search?codigovendedor=12345.\n\n> ⚠️ O campo **status** deve retornar o valor **true**, indicando que o código do vendedor é válido.\n\n<blockquote><ui>2. Efetue a chamada POST [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm) para incluir as seguintes informações no [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) de sua loja</ui>:\n\n<blockquote><blockquote>- **marketingData**: em *\"utmCampaign\"*, inserir *codigovendedor\"*. Caso esta informação não seja descrita, a promoção (código do vendedor) não será aplicada no carrinho e o campo não será exibido.\n\n<blockquote><blockquote>- **openTextField** (opcional): inserir observações ou comentários (ex. informações para filtros de comissionamento).\n\n> ⚠️ Somente a informação do nome do vendedor deve ser exibida na tela do Checkout.\n\nApós executar todas as etapas acima descritas, o campo **Código do Vendedor** estará disponível na tela do Checkout.\n\n![Código do vendedor](https://cdn.statically.io/gh/vtexdocs/help-center-content/refs/heads/main/docs/pt/tutorials/promoções-e-taxas/promoções/campo-codigo-de-vendedor-no-checkout_2.png)"}