API legada/Referência completa/Vendedores

POSTCriar um vendedor

Cria uma nova conta de vendedor no seu marketplace com vários vendedores.

Este endpoint cria um novo vendedor no seu marketplace com vários vendedores. Vendedores são lojistas terceiros que podem anunciar e vender produtos pela sua plataforma. Envie os parâmetros no corpo da requisição HTTP, de acordo com o Content-Type que você usar. Em caso de sucesso, a resposta traz o ID do novo vendedor em store_id.

POST/api/vendorsAdmin

Cria um novo vendedor com os dados informados

Informações básicas do vendedor

companystringobrigatório

O nome do vendedor.

storefrontstringobrigatório

Um identificador único da vitrine do vendedor. A API REST exige este campo, mas ele não tem nenhuma função específica.

company_descriptionstring

A descrição do vendedor. Você pode usar HTML.

statusstringpadrão: A

NAPD

O status do vendedor: N (novo), A (ativo, o padrão), P (pendente), D (desativado).

lang_codestring

Um código de idioma de duas letras, por exemplo en.

Informações de contato

emailstringobrigatório

E-mail do vendedor.

phonestringobrigatório

Telefone do vendedor.

urlstring

Site do vendedor.

faxstring

Número de fax do vendedor.

Informações de endereço

addressstringobrigatório

Endereço do vendedor.

citystringobrigatório

Cidade do vendedor.

countrystringobrigatório

Código do país do vendedor (por exemplo, US).

statestringobrigatório

Código do estado do vendedor.

zipcodestringobrigatório

CEP (zip code) do vendedor.

Configurações de moderação

pre_moderationstring

YN

Se for Y, todo produto novo do vendedor precisa ser aprovado pelo administrador da loja.

pre_moderation_editstring

YN

Se for Y, toda alteração de dados de produto feita pelo vendedor precisa ser aprovada pelo administrador da loja.

pre_moderation_edit_vendorsstring

YN

Se for Y, toda alteração do perfil do vendedor precisa de aprovação prévia do administrador da loja.

Configurações adicionais

categoriesstring

Uma lista, separada por vírgulas, de IDs de categorias em que o vendedor pode criar produtos. Se estiver vazia, o vendedor pode criar produtos em qualquer categoria.

shippingsobject

Os métodos de envio disponíveis para o vendedor, como um objeto que tem os IDs dos métodos de envio como valores.

commissionstring

O tamanho da comissão retirada do vendedor em cada venda. Usa o formato xx.xx.

commission_typestring

AP

O tipo da comissão: A (valor fixo) ou P (percentual).

termsstring

O texto dos termos e condições do vendedor. Você pode usar HTML. (Adicionado pelo add-on de Termos e Condições do Vendedor.)

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/vendors" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "company": "New Vendor",
  "company_description": "<p>This is the description of the new vendor.</p>",
  "storefront": "example.com",
  "status": "N",
  "lang_code": "en",
  "email": "test_vendor@example.com",
  "phone": "555555555",
  "url": "https://www.venddor.com.br",
  "fax": "+555555555",
  "address": "Boston street",
  "city": "Boston",
  "state": "MA",
  "country": "US",
  "zipcode": "02125",
  "pre_moderation": "Y",
  "pre_moderation_edit": "Y",
  "pre_moderation_edit_vendors": "N",
  "categories": "253,252",
  "shippings": {
    "1": "1",
    "2": "3"
  },
  "commission": "10.55",
  "commission_type": "A",
  "terms": "<p>These are the terms and conditions you must accept before you can buy products from New Vendor.</p>"
}'

Resposta

201Vendedor criado

json

{
  "store_id": 2
}

Erros

Status	Descrição
`201 Created`	O vendedor foi criado.
`400 Bad Request`	Não foi possível criar o vendedor por parâmetros inválidos ou outros problemas.

Notas de implementação

Ao criar vendedores, tenha em mente estas práticas.

Use sempre valores de storefront únicos para cada vendedor, para evitar conflitos.
Defina a moderação de acordo com o seu nível de confiança nos novos vendedores.
Considere limitar os novos vendedores a categorias específicas até que provem ser confiáveis.
Configure comissões justas para atrair bons vendedores sem perder rentabilidade.
Forneça termos e condições claros para estabelecer expectativas e responsabilidades.

Veja também

POSTCriar um vendedor

Cria uma nova conta de vendedor no seu marketplace com vários vendedores.

POST/api/vendorsAdmin

Cria um novo vendedor com os dados informados

Informações básicas do vendedor

companystringobrigatório

O nome do vendedor.

storefrontstringobrigatório

Um identificador único da vitrine do vendedor. A API REST exige este campo, mas ele não tem nenhuma função específica.

company_descriptionstring

A descrição do vendedor. Você pode usar HTML.

statusstringpadrão: A

NAPD

O status do vendedor: N (novo), A (ativo, o padrão), P (pendente), D (desativado).

lang_codestring

Um código de idioma de duas letras, por exemplo en.

Informações de contato

emailstringobrigatório

E-mail do vendedor.

phonestringobrigatório

Telefone do vendedor.

urlstring

Site do vendedor.

faxstring

Número de fax do vendedor.

Informações de endereço

addressstringobrigatório

Endereço do vendedor.

citystringobrigatório

Cidade do vendedor.

countrystringobrigatório

Código do país do vendedor (por exemplo, US).

statestringobrigatório

Código do estado do vendedor.

zipcodestringobrigatório

CEP (zip code) do vendedor.

Configurações de moderação

pre_moderationstring

YN

Se for Y, todo produto novo do vendedor precisa ser aprovado pelo administrador da loja.

pre_moderation_editstring

YN

Se for Y, toda alteração de dados de produto feita pelo vendedor precisa ser aprovada pelo administrador da loja.

pre_moderation_edit_vendorsstring

YN

Se for Y, toda alteração do perfil do vendedor precisa de aprovação prévia do administrador da loja.

Configurações adicionais

categoriesstring

Uma lista, separada por vírgulas, de IDs de categorias em que o vendedor pode criar produtos. Se estiver vazia, o vendedor pode criar produtos em qualquer categoria.

shippingsobject

Os métodos de envio disponíveis para o vendedor, como um objeto que tem os IDs dos métodos de envio como valores.

commissionstring

O tamanho da comissão retirada do vendedor em cada venda. Usa o formato xx.xx.

commission_typestring

AP

O tipo da comissão: A (valor fixo) ou P (percentual).

termsstring

O texto dos termos e condições do vendedor. Você pode usar HTML. (Adicionado pelo add-on de Termos e Condições do Vendedor.)

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/vendors" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "company": "New Vendor",
  "company_description": "<p>This is the description of the new vendor.</p>",
  "storefront": "example.com",
  "status": "N",
  "lang_code": "en",
  "email": "test_vendor@example.com",
  "phone": "555555555",
  "url": "https://www.venddor.com.br",
  "fax": "+555555555",
  "address": "Boston street",
  "city": "Boston",
  "state": "MA",
  "country": "US",
  "zipcode": "02125",
  "pre_moderation": "Y",
  "pre_moderation_edit": "Y",
  "pre_moderation_edit_vendors": "N",
  "categories": "253,252",
  "shippings": {
    "1": "1",
    "2": "3"
  },
  "commission": "10.55",
  "commission_type": "A",
  "terms": "<p>These are the terms and conditions you must accept before you can buy products from New Vendor.</p>"
}'

Resposta

201Vendedor criado

json

{
  "store_id": 2
}

Erros

Status	Descrição
`201 Created`	O vendedor foi criado.
`400 Bad Request`	Não foi possível criar o vendedor por parâmetros inválidos ou outros problemas.

Notas de implementação

Ao criar vendedores, tenha em mente estas práticas.

Use sempre valores de storefront únicos para cada vendedor, para evitar conflitos.
Defina a moderação de acordo com o seu nível de confiança nos novos vendedores.
Considere limitar os novos vendedores a categorias específicas até que provem ser confiáveis.
Configure comissões justas para atrair bons vendedores sem perder rentabilidade.
Forneça termos e condições claros para estabelecer expectativas e responsabilidades.