VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/App do seller (1.0)

Empresa e perfil

Lê e altera os dados da empresa do seller e o perfil do usuário que está logado no app.

A empresa é o cadastro do seller (nome, contato, endereço, CNPJ). O perfil é o da pessoa que usa o app (nome e telefone). São recursos separados: a alteração de um não mexe no outro.

As alterações são parciais: só os campos que você envia mudam, e um campo enviado com "" grava vazio. O seller não pode alterar por aqui o CNPJ, o endereço de vitrine nem a situação.

Ler a empresa

GET/api/v1.0/vendor_companySeller

Ler a empresa

GET/api/vendor_companySeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_company. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/v1.0/vn_company_apiSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_company. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/vn_company_apiSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_company. Use este caminho se o seu cliente já foi escrito para ele.

Alterar a empresa

PUT/api/v1.0/vendor_companySeller

Alterar a empresa

Corpo da requisição

company_namestring
Nome da empresa.
emailstring
E-mail de contato.
phonestring
Telefone.
websitestring
Site.
descriptionstring
Descrição da empresa.
addressstring
Logradouro.
citystring
Cidade.
statestring
UF.
postal_codestring
CEP.
PUT/api/vendor_companySeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/vendor_company. Use este caminho se o seu cliente já foi escrito para ele.

PUT/api/v1.0/vn_company_apiSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/vendor_company. Use este caminho se o seu cliente já foi escrito para ele.

PUT/api/vn_company_apiSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/vendor_company. Use este caminho se o seu cliente já foi escrito para ele.

Ler o perfil

GET/api/v1.0/vendor_profileSeller

Ler o perfil

GET/api/vendor_profileSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_profile. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/v1.0/vn_profile_apiSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_profile. Use este caminho se o seu cliente já foi escrito para ele.

GET/api/vn_profile_apiSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/vendor_profile. Use este caminho se o seu cliente já foi escrito para ele.

Alterar o perfil

PUT/api/v1.0/vendor_profileSeller

Alterar o perfil

Corpo da requisição

first_namestring
Nome.
last_namestring
Sobrenome.
phonestring
Telefone.
PUT/api/vendor_profileSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/vendor_profile. Use este caminho se o seu cliente já foi escrito para ele.

PUT/api/v1.0/vn_profile_apiSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/vendor_profile. Use este caminho se o seu cliente já foi escrito para ele.

PUT/api/vn_profile_apiSeller

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/vendor_profile. Use este caminho se o seu cliente já foi escrito para ele.

Exemplo de requisição

bash
curl -X PUT "$BASE_URL/api/v1.0/vendor_company" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "company_name": "Moda Aurora Ltda",
  "phone": "+55 11 3333-4444",
  "website": "https://modaaurora.example",
  "city": "São Paulo",
  "state": "SP",
  "postal_code": "01310-100"
}'

Resposta

200Ler a empresa
json
{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "company": {
      "company_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "company": "Moda Aurora Ltda",
      "company_name": "Moda Aurora Ltda",
      "email": "contato@modaaurora.example",
      "phone": "+55 11 3333-4444",
      "url": "https://modaaurora.example",
      "website": "https://modaaurora.example",
      "address": "Rua Augusta, 1234",
      "city": "São Paulo",
      "state": "SP",
      "zipcode": "01310-100",
      "postal_code": "01310-100",
      "country": "BR",
      "tax_number": "11222333000181",
      "cnpj": "11222333000181",
      "description": "",
      "status": "A",
      "logos": { "logo_url": "https://cdn.example/logo.png" },
      "logo_url": "https://cdn.example/logo.png",
      "banner_url": "",
      "lang_code": "pt-BR",
      "seo_name": "moda-aurora"
    }
  }
}

Campos da resposta (empresa)

data.companyobject
Cadastro do seller. Traz cada dado em duas chaves, a do vocabulário da 1.0 e a nova: company/company_name, url/website, zipcode/postal_code, tax_number/cnpj, logos.logo_url/logo_url. Também: company_id (UUID), email, phone, address, city, state, country, description, status (letra), lang_code (pt-BR), seo_name (o slug) e banner_url. Dados não cadastrados saem como "".
200Ler o perfil
json
{
  "status": 200,
  "data": {
    "success": true,
    "message": "",
    "profile": {
      "user_id": "f12f30a9-cbec-40ba-98f1-b7fa8f2e8e10",
      "email": "maria@modaaurora.example",
      "first_name": "Maria",
      "last_name": "Souza",
      "phone": "+55 11 98888-7777",
      "user_type": "vendor"
    }
  }
}

Campos da resposta (perfil)

data.profileobject
user_id, email, first_name, last_name, phone e user_type.
200Alterar a empresa
json
{
  "status": 200,
  "data": { "success": true, "message": "Company updated successfully" }
}
200Alterar o perfil
json
{
  "status": 200,
  "data": { "success": true, "message": "Profile updated successfully" }
}

Erros

StatusQuandoCorpo de exemplo
401Sem credencial, ou credencial inválida.{"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."}
403Token de cliente comum (nem seller nem administrador).{"status":403,"message":"Forbidden: vendor scope required"}
200Autenticado, mas o usuário não é de um seller (por exemplo, um administrador).{"status":200,"data":{"success":false,"message":"User is not a vendor","action":"logout"}}
200O usuário não tem seller vinculado.{"status":200,"data":{"success":false,"message":"No vendor assigned to this account","action":"logout"}}
200O seller não está ativo.{"status":200,"data":{"success":false,"message":"Vendor account is not active","action":"logout"}}
200Falha ao gravar (e-mail em uso, dado inválido).{"status":200,"data":{"success":false,"message":"Update failed: <detalhe>"}}
200Corpo inválido.{"status":200,"data":{"success":false,"message":"Invalid request body"}}
200vendor_profile: usuário não encontrado.{"status":200,"data":{"success":false,"message":"User not found"}}
O perfil funciona sem seller

vendor_profile não exige seller ativo: qualquer usuário autenticado que passe pela porta de seller/administrador lê e altera o próprio perfil. A empresa (vendor_company) exige seller ativo.

Veja também

  • Login e cadastro
  • Início, painel e avisos
  • Visão geral do app do seller
Anterior
Início, painel e avisos
Próxima
Chats
Nesta página
  • Ler a empresa
  • Alterar a empresa
  • Ler o perfil
  • Alterar o perfil
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também