API atual/Referência completa/Sellers e microsites

Situação do seller

Reputação do seller, aviso de férias e verificação de entrega.

Três consultas curtas que alimentam os selos da página do seller.

Entrega no destino

GET/api/v1/storefront/vendors/{id}/delivers-toPública

Verifica se o seller entrega no destino

Pergunta se o seller entrega em um destino. Aceita os parâmetros abaixo, mas hoje ignora todos.

Parâmetros de caminho

idstringobrigatório

UUID ou slug do seller. Não é validado.

Parâmetros de consulta

statestring

UF do destino.

citystring

Cidade do destino.

districtstring

Bairro do destino.

cepstring

CEP do destino (o nome do parâmetro é cep, não postal_code).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/vendors/c0000000-0000-0000-0000-000000000002/delivers-to?cep=01310100"

Resposta

200Resposta

json

{ "available": true }

Campos da resposta

availableboolean

Hoje é sempre true: a cobertura geográfica por seller está desativada na plataforma.

Erros

Status	Quando	Corpo
401	Loja que exige login para navegar e chamada sem token.	`{"error":"shopping_requires_login","message":"this storefront requires login to browse"}`

Reputação

GET/api/v1/storefront/vendors/{id}/reputationPública

Reputação do seller

Devolve a nota de reputação do seller (0 a 100) e a faixa de cor para o selo.

Parâmetros de caminho

iduuidobrigatório

UUID do seller.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/vendors/c0000000-0000-0000-0000-000000000002/reputation"

Resposta

200Reputação

json

{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "score": 71,
  "band": "yellow",
  "hidden": false,
  "cold_start": false,
  "top_issues": ["cancellation_rate"],
  "orders_in_window": 3237
}

Campos da resposta

vendor_iduuid

O seller. Vazio quando o id não existe (veja abaixo).

scoreinteger

Nota de 0 a 100. Não exiba quando band é neutral.

bandstring

greenyellowredneutral

Faixa do selo: green (80 ou mais), yellow (50 a 79), red (abaixo de 50) ou neutral (sem termômetro).

hiddenboolean

O administrador escondeu a reputação deste seller. Nesse caso band é neutral e score é 0.

cold_startboolean

true quando o seller teve menos de 10 pedidos na janela de 60 dias: ainda não há dados suficientes.

top_issuesstring[]

Os pontos que mais pesaram contra: cancellation_rate, late_dispatch_rate, return_rate, rating_avg. Pode ser [] ou null.

orders_in_windowinteger

Pedidos considerados na janela de 60 dias.

Erros

Status	Quando	Corpo
200	Id inexistente ou inválido: a rota não dá 404; devolve `band: neutral` com `vendor_id` vazio.	`{"vendor_id":"","score":0,"band":"neutral","hidden":false,"cold_start":false,"top_issues":null,"orders_in_window":0}`

Férias

GET/api/v1/storefront/vendors/{vendorId}/vacationPública

Aviso de férias do seller

Diz se o seller está de férias (o modo em que ele não aceita pedidos novos) e a mensagem e a data de volta, se ele as informou.

Parâmetros de caminho

vendorIduuidobrigatório

UUID do seller. Slug não é aceito.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/vendors/c0000000-0000-0000-0000-000000000002/vacation"

Resposta

200De férias

json

{
  "is_on_vacation": true,
  "message": "Voltamos dia 20, obrigado pela paciência!",
  "until": "2026-10-20T12:00:00Z"
}

200Em atividade

json

{
  "is_on_vacation": false,
  "message": null,
  "until": null
}

Campos da resposta

is_on_vacationboolean

O seller está de férias.

messagestring

Mensagem do seller para o cliente. null se não houver.

untilstring

RFC 3339. Data prevista de volta. null se o seller não informou.

Erros

Status	Quando	Corpo
404	Seller inexistente ou apagado.	`{"error":"VENDOR_NOT_FOUND"}`
500	`vendorId` que não é UUID (por exemplo um slug). Deveria ser 400.	`{"error":"VACATION_STATUS_FAILED","detail":"..."}`

Veja também

API atual/Referência completa/Sellers e microsites

Situação do seller

Reputação do seller, aviso de férias e verificação de entrega.

Três consultas curtas que alimentam os selos da página do seller.

Entrega no destino

GET/api/v1/storefront/vendors/{id}/delivers-toPública

Verifica se o seller entrega no destino

Pergunta se o seller entrega em um destino. Aceita os parâmetros abaixo, mas hoje ignora todos.

Parâmetros de caminho

idstringobrigatório

UUID ou slug do seller. Não é validado.

Parâmetros de consulta

statestring

UF do destino.

citystring

Cidade do destino.

districtstring

Bairro do destino.

cepstring

CEP do destino (o nome do parâmetro é cep, não postal_code).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/vendors/c0000000-0000-0000-0000-000000000002/delivers-to?cep=01310100"

Resposta

200Resposta

json

{ "available": true }

Campos da resposta

availableboolean

Hoje é sempre true: a cobertura geográfica por seller está desativada na plataforma.

Erros

Status	Quando	Corpo
401	Loja que exige login para navegar e chamada sem token.	`{"error":"shopping_requires_login","message":"this storefront requires login to browse"}`

Reputação

GET/api/v1/storefront/vendors/{id}/reputationPública

Reputação do seller

Devolve a nota de reputação do seller (0 a 100) e a faixa de cor para o selo.

Parâmetros de caminho

iduuidobrigatório

UUID do seller.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/vendors/c0000000-0000-0000-0000-000000000002/reputation"

Resposta

200Reputação

json

{
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "score": 71,
  "band": "yellow",
  "hidden": false,
  "cold_start": false,
  "top_issues": ["cancellation_rate"],
  "orders_in_window": 3237
}

Campos da resposta

vendor_iduuid

O seller. Vazio quando o id não existe (veja abaixo).

scoreinteger

Nota de 0 a 100. Não exiba quando band é neutral.

bandstring

greenyellowredneutral

Faixa do selo: green (80 ou mais), yellow (50 a 79), red (abaixo de 50) ou neutral (sem termômetro).

hiddenboolean

O administrador escondeu a reputação deste seller. Nesse caso band é neutral e score é 0.

cold_startboolean

true quando o seller teve menos de 10 pedidos na janela de 60 dias: ainda não há dados suficientes.

top_issuesstring[]

Os pontos que mais pesaram contra: cancellation_rate, late_dispatch_rate, return_rate, rating_avg. Pode ser [] ou null.

orders_in_windowinteger

Pedidos considerados na janela de 60 dias.

Erros

Status	Quando	Corpo
200	Id inexistente ou inválido: a rota não dá 404; devolve `band: neutral` com `vendor_id` vazio.	`{"vendor_id":"","score":0,"band":"neutral","hidden":false,"cold_start":false,"top_issues":null,"orders_in_window":0}`

Férias

GET/api/v1/storefront/vendors/{vendorId}/vacationPública

Aviso de férias do seller

Diz se o seller está de férias (o modo em que ele não aceita pedidos novos) e a mensagem e a data de volta, se ele as informou.

Parâmetros de caminho

vendorIduuidobrigatório

UUID do seller. Slug não é aceito.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/vendors/c0000000-0000-0000-0000-000000000002/vacation"

Resposta

200De férias

json

{
  "is_on_vacation": true,
  "message": "Voltamos dia 20, obrigado pela paciência!",
  "until": "2026-10-20T12:00:00Z"
}

200Em atividade

json

{
  "is_on_vacation": false,
  "message": null,
  "until": null
}

Campos da resposta

is_on_vacationboolean

O seller está de férias.

messagestring

Mensagem do seller para o cliente. null se não houver.

untilstring

RFC 3339. Data prevista de volta. null se o seller não informou.

Erros

Status	Quando	Corpo
404	Seller inexistente ou apagado.	`{"error":"VENDOR_NOT_FOUND"}`
500	`vendorId` que não é UUID (por exemplo um slug). Deveria ser 400.	`{"error":"VACATION_STATUS_FAILED","detail":"..."}`