Vendedores

Um vendedor (vendor) é um lojista independente que oferece produtos pelo seu marketplace Venddor. A API de Vendors permite que os administradores da plataforma gerenciem as contas de vendedor: aprovar novos vendedores, alterar dados e comissão e acompanhá-los. Todas as chamadas usam HTTP Basic com o e-mail:chave_de_api do administrador.

Como funciona

Cada vendedor mantém o próprio catálogo de produtos, estoque, estrutura de preços, opções de envio e perfil e identidade da loja. Como administrador, você cria a conta do vendedor e define o status, as regras de moderação, as categorias permitidas, os métodos de envio e a comissão.

1. Crie o vendedor

   Envie POST /api/vendors. A resposta traz o ID do novo vendedor em store_id. Veja Criar um vendedor.

2. Consulte e liste os vendedores

   Use GET /api/vendors para listar e GET /api/vendors/{company_id} para consultar um. Veja Listar vendedores e Consultar um vendedor.

3. Altere ou remova o vendedor

   Use PUT /api/vendors/{company_id} para alterar dados e DELETE /api/vendors/{company_id} para remover o vendedor. Veja Atualizar um vendedor e Excluir um vendedor.

Status do vendedor

Conceitos-chave

ID do vendedor

O identificador de um vendedor é o company_id, uma string como "2". As chamadas de criar e atualizar respondem com store_id, que traz o mesmo ID.

Comissão

commission é o valor retirado do vendedor em cada venda, no formato xx.xx. commission_type diz como ler esse valor: A (valor fixo) ou P (percentual).

Moderação

pre_moderation, pre_moderation_edit e pre_moderation_edit_vendors recebem Y para exigir a aprovação do administrador da loja para novos produtos, para alterações de produtos e para alterações do perfil do vendedor. Só valem se você configurar o add-on de Pré-moderação de Dados do Vendedor.

Excluir e desativar

A visão geral da API de Vendors descreve o DELETE como a desativação da conta do vendedor. A página Excluir um vendedor afirma que, depois de excluído, o vendedor e todos os dados associados não podem ser recuperados. Trate a chamada como permanente. Para desativar um vendedor temporariamente, mude o status dele com a chamada de atualização.

Campos que podem não vir

Alguns campos documentados nas chamadas de escrita podem não ser devolvidos pelas requisições GET, mas ainda assim podem ser usados em POST e PUT.

Endpoints

Erros comuns

• Reutilizar um valor de storefront. Ele precisa ser único para cada vendedor criado pela API REST.
• Esquecer o storefront na criação. A API REST o exige, mesmo que ele não tenha nenhuma função específica.
• Esperar que os campos de moderação funcionem sem o add-on de Pré-moderação de Dados do Vendedor configurado.
• Excluir um vendedor que ainda tem produtos ou pedidos ativos. A chamada responde 400 Bad Request e pode causar inconsistências.
• Usar DELETE quando você só quer pausar um vendedor. Mude o status com PUT.

Próximos passos