VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Dashboards do seller

Ações sobre a aba

Duplica uma aba, define a aba padrão e restaura a aba de fábrica do seller.

Três atalhos sobre uma aba existente. A duplicação também é o caminho para editar uma aba que você só pode ler (a de fábrica renomeada, ou a publicada pelo administrador).

Duplicar aba

Cria uma cópia privada, com o nome acrescido de (cópia), contendo os cards ativos da aba original. Funciona também com uma aba do administrador publicada para sellers: a cópia passa a ser do seller e pode ser editada.

POST/api/v1/vendor/dashboards/{id}/duplicateSeller

Duplicar aba

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório
Id da aba (UUID).

Exemplo de requisição

Resposta

201Cópia criada

Erros

StatusQuandoCorpo de exemplo
404A aba não existe, é de outro seller ou você não pode vê-la. A API responde 404 nos três casos para não revelar que ela existe.{"error":"dashboard not found"}
500Falha ao copiar.{"error":"failed to duplicate dashboard"}
401Token ausente, inválido, expirado ou revogado.invalid or expired token
403O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.{"error":"vendor_pending_review"}

Definir aba padrão

Marca a aba como a que abre primeiro. Só uma aba por seller é a padrão: a anterior deixa de ser, na mesma operação.

POST/api/v1/vendor/dashboards/{id}/set-defaultSeller

Definir aba padrão

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório
Id da aba (UUID).

Exemplo de requisição

Resposta

200Aba padrão

Erros

StatusQuandoCorpo de exemplo
404A aba não existe, é de outro seller ou você não pode vê-la. A API responde 404 nos três casos para não revelar que ela existe.{"error":"dashboard not found"}
500Falha ao gravar.{"error":"failed to set default dashboard"}
401Token ausente, inválido, expirado ou revogado.invalid or expired token
403O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.{"error":"vendor_pending_review"}

Restaurar a aba de fábrica

Apaga todos os cards atuais da aba de fábrica e recria os cards originais. Só vale para a aba de fábrica (is_system: true).

POST/api/v1/vendor/dashboards/{id}/restore-defaultSeller

Restaurar a aba de fábrica

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório
Id da aba (UUID).

Exemplo de requisição

Resposta

200Restaurada

Campos da resposta

cards_createdinteger
Cards recriados.
skippedstring[]
Modelos que não puderam ser recriados.
partial_failureboolean
Só aparece, com true, quando skipped não está vazio.
messagestring
Só aparece com partial_failure: lista os modelos pulados.

Erros

StatusQuandoCorpo de exemplo
404A aba não existe, é de outro seller ou você não pode vê-la. A API responde 404 nos três casos para não revelar que ela existe.{"error":"dashboard not found"}
400A aba não é a de fábrica.{"error":"restore_default_not_system","detail":"..."}
500Falha ao restaurar.{"error":"failed to restore default"}
401Token ausente, inválido, expirado ou revogado.invalid or expired token
403O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.{"error":"vendor_pending_review"}
Apaga as suas alterações

Os cards que o seller criou ou editou na aba de fábrica são removidos. Se partial_failure vier true, a aba ficou incompleta: repita a chamada ou recrie os cards listados.

Veja também

  • Abas
  • Compartilhamento
Anterior
Abas
Próxima
Cards
Nesta página
  • Duplicar aba
  • Exemplo de requisição
  • Resposta
  • Erros
  • Definir aba padrão
  • Exemplo de requisição
  • Resposta
  • Erros
  • Restaurar a aba de fábrica
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também
bash
curl -X POST "$BASE_URL/api/v1/vendor/dashboards/931b3fc7-e703-4cac-bcbc-5c79690f02a8" \
  -H "Authorization: Bearer $TOKEN"
bash
curl -X POST "$BASE_URL/api/v1/vendor/dashboards/931b3fc7-e703-4cac-bcbc-5c79690f02a8" \
  -H "Authorization: Bearer $TOKEN"
bash
curl -X POST "$BASE_URL/api/v1/vendor/dashboards/931b3fc7-e703-4cac-bcbc-5c79690f02a8" \
  -H "Authorization: Bearer $TOKEN"
json
{
  "id": "7a1e8c52-31f3-4a07-bb0a-6d3a8f2b9c10",
  "slug": "0b8c3f44-5a1c-4d2e-8e66-1a2b3c4d5e6f",
  "name": "Dashboard (cópia)",
  "panel": "V",
  "owner_user_id": "0fd409fb-9869-4c50-a18c-a810a19abeed",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "visibility": "P",
  "is_system": false,
  "is_default": false,
  "position": 0,
  "icon": "atividade",
  "color": "#0044FF",
  "default_period": {
    "mode": "preset",
    "preset": "last30"
  },
  "created_at": "2026-10-11T21:31:00Z",
  "updated_at": "2026-10-11T21:31:00Z",
  "version": 1791754260000,
  "is_owner": false
}
json
{
  "id": "931b3fc7-e703-4cac-bcbc-5c79690f02a8",
  "slug": "fabrica",
  "name": "Dashboard",
  "panel": "V",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "visibility": "P",
  "is_system": true,
  "is_default": true,
  "position": 0,
  "icon": "atividade",
  "color": "#0044FF",
  "default_period": {
    "mode": "preset",
    "preset": "last30"
  },
  "created_at": "2026-10-11T21:04:17.245533Z",
  "updated_at": "2026-10-11T21:04:17.245533Z",
  "version": 1791752657246,
  "is_owner": true,
  "permission": "W",
  "kind": "normal"
}
json
{
  "cards_created": 10,
  "skipped": []
}