Saltar al contenido principal

Lojas

RotaEscopoO que faz
GET /v1/storesreadlista lojas
GET /v1/stores/{id}readmostra uma loja
POST /v1/storeswritecria uma loja
PATCH /v1/stores/{id}writealtera uma loja
DELETE /v1/stores/{id}deleteexclui uma loja (veja as regras abaixo)

Campos​

CampoTipoDescrição
idUUIDidentificador
nametextonome da loja
is_activesim/nãolojas desativadas não aceitam produtos novos
created_at, updated_atdata e horacriação e última alteração

Listar​

ParâmetroDescrição
qbusca no nome
is_activetrue ou false
updated_sincesó as criadas ou alteradas a partir desse instante
limit, cursorpaginação

Criar e alterar​

CampoObrigatórioRegras
namesim no POST1 a 100 caracteres
is_activenãotrue ou false (padrão true)
idnão (só no POST)UUID gerado por você
curl -X PATCH https://api.validades.com/v1/stores/ID_DA_LOJA \
-H "Authorization: Bearer vld_live_SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{"is_active": false}'

Excluir uma loja​

Exclusão em cascata

Uma loja pode ter produtos e lotes. Excluir uma loja com cascade=true exclui também todos os produtos dela e todos os lotes desses produtos, em todos os aparelhos da organização. A exclusão é definitiva para você.

1. Confira antes, sem excluir nada: dry_run=true​

curl -X DELETE "https://api.validades.com/v1/stores/ID_DA_LOJA?cascade=true&dry_run=true" \
-H "Authorization: Bearer vld_live_SUA_CHAVE"
{
"data": {
"id": "…",
"dry_run": true,
"requires_cascade": true,
"would_delete": { "store": 1, "products": 132, "batches": 410 },
"members_unassigned": 3
}
}

members_unassigned é a quantidade de membros da organização que estão vinculados a essa loja e perdem o vínculo.

2. Sem cascade, uma loja com produtos não é excluída​

{
"error": {
"code": "store_has_products",
"internal_code": 111,
"message": "…",
"request_id": "req_…",
"details": { "products": 132, "batches": 410 }
}
}

Uma loja sem produtos é excluída normalmente, sem precisar de cascade.

3. Excluir de verdade: cascade=true​

curl -X DELETE "https://api.validades.com/v1/stores/ID_DA_LOJA?cascade=true" \
-H "Authorization: Bearer vld_live_SUA_CHAVE"
{
"data": {
"id": "…",
"cascade": true,
"deleted": { "store": 1, "products": 132, "batches": 410 },
"members_unassigned": 3
}
}

Depois da exclusão:

  • o dono e os administradores recebem um e-mail com a loja, a chave usada, as quantidades, o IP e o request_id;
  • a loja e cada produto aparecem no registro de atividades da organização;
  • a loja, os produtos e os lotes aparecem em /v1/deletions;
  • o Validades guarda uma cópia dos dados excluídos por 30 dias, só para fins de suporte. Isso não é um backup nem garante a recuperação. Se foi um engano, fale com o suporte o quanto antes, informando o request_id.

Aceita If-Match.