API legada/Referência completa/Frete e rotas

GETSellers disponíveis

Lista os sellers (lojistas) ativos da loja, com filtro opcional por estado e cidade, no formato da Venddor 1.0.

Devolve os sellers ativos: os lojistas que vendem na loja (marketplace). Em um marketplace, cada pedido sai de um seller, e muitas integrações precisam desta lista para saber de onde cada produto vem ou para montar um filtro por região. Só aparecem sellers com status ativo; os pendentes ou desativados ficam de fora.

A lista não tem paginação: cada chamada devolve no máximo 20 sellers, mesmo que params.items_per_page informe 250. total_items mostra quantos sellers existem de fato.

GET/api/v1.0/sellers_availabilityAutenticada

Listar os sellers ativos

Parâmetros de consulta

statestring

Sigla do estado do seller (SP, RJ). A comparação é exata e diferencia maiúsculas: rj não encontra nada.

citystring

Nome da cidade do seller, comparação exata e com diferença de maiúsculas e acentos (Volta Redonda).

Cabeçalhos

Authorizationstringobrigatório

Basic base64(e-mail:chave_de_api) ou Bearer $TOKEN. Qualquer usuário autenticado serve.

GET/api/sellers_availabilityAutenticada

Alias de GET /api/v1.0/sellers_availability

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/sellers_availability. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/sellers_availability?state=RJ"

Resposta

200Sellers ativos

json

{
  "companies": [
    {
      "company_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "company": "Loja Seller Teste",
      "company_name": "Loja Seller Teste",
      "status": "A",
      "is_available": true,
      "city": "Volta Redonda",
      "state": "RJ"
    }
  ],
  "search": {
    "state": "RJ", "city": "", "district": "", "user_id": "",
    "items_per_page": 250, "page": 1, "total_items": 1
  },
  "sellers": [
    {
      "company_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "company": "Loja Seller Teste",
      "company_name": "Loja Seller Teste",
      "status": "A",
      "is_available": true,
      "city": "Volta Redonda",
      "state": "RJ"
    }
  ],
  "params": { "page": 1, "items_per_page": 250, "total_items": 1 }
}

Campos da resposta

companiesarray

Os sellers ativos. É o campo que a Venddor 1.0 devolvia; use este.

companies[].company_iduuid

Id do seller. Na URL sem v1.0, inteiro derivado do UUID.

companies[].companystring

Nome do seller.

companies[].company_namestring

Mesmo valor de company, repetido por compatibilidade.

companies[].statusstring

Sempre A, porque só sellers ativos são listados.

companies[].is_availableboolean

Sempre true.

companies[].citystring

Cidade do seller. Ausente se o cadastro não tem cidade.

companies[].statestring

Estado do seller. Ausente se o cadastro não tem estado.

searchobject

Os filtros que a chamada usou e o total. district e user_id ecoam parâmetros da consulta, mas não filtram nada.

sellersarray

Cópia exata de companies, mantida para clientes antigos. Não use em código novo.

paramsobject

page (sempre 1), items_per_page (sempre 250, valor informativo) e total_items (todos os sellers que passam no filtro, que pode ser maior que o tamanho de companies).

Erros

Status	Quando	Corpo
401	Sem credencial ou credencial inválida	`{"message": "Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.", "status": 401}`
500	Falha ao consultar os sellers	`{"message": "Failed to query vendors: ...", "status": 500}`

Veja também