Pular para o conteúdo principal

Produtos

RotaEscopoO que faz
GET /v1/productsreadlista produtos
GET /v1/products/{id}readmostra um produto (com foto e, se pedir, os lotes)
POST /v1/productswritecria um produto
PATCH /v1/products/{id}writealtera um produto
DELETE /v1/products/{id}deleteexclui um produto e todos os seus lotes

Os lotes de um produto têm rotas próprias: veja Lotes.

O produto​

CampoTipoDescrição
idUUIDidentificador
nametextonome do produto
codetexto ou nullcódigo de barras (EAN/GTIN) ou código interno
days_to_be_nextnúmero ou nullquantos dias antes da validade o lote passa a contar como "vencendo"
brand_idUUID ou nullmarca
category_idUUID ou nullcategoria
store_idUUID ou nullloja
has_imagesim/nãose o produto tem foto
created_at, updated_atdata e horacriação e última alteração

Listar: GET /v1/products​

ParâmetroDescrição
qbusca no nome ou no código (contém o texto, sem diferenciar maiúsculas)
codecódigo exato
brand_id, category_id, store_idsó os produtos dessa marca, categoria ou loja
updated_sincesó os criados ou alterados a partir desse instante
limit, cursorpaginação
curl "https://api.validades.com/v1/products?code=7891000100103" \
-H "Authorization: Bearer vld_live_SUA_CHAVE"

Consultar: GET /v1/products/{id}​

A resposta traz também:

CampoDescrição
image_urllink temporário da foto do produto (vale alguns minutos), ou null
batchessó com include=batches: até 500 lotes, ordenados pela validade
batches_truncatedsó com include=batches: true se o produto tem mais de 500 lotes
curl "https://api.validades.com/v1/products/ID_DO_PRODUTO?include=batches" \
-H "Authorization: Bearer vld_live_SUA_CHAVE"

Sem include, a resposta traz o cabeçalho ETag e aceita If-None-Match. Veja Concorrência e idempotência.

Criar: POST /v1/products​

CampoObrigatórioRegras
namesim1 a 255 caracteres
codenãoaté 100 caracteres
days_to_be_nextnãonúmero inteiro de 0 a 3650
brand_id, category_idnãoprecisa existir na organização
store_idnãoprecisa existir na organização e estar ativa
idnãoUUID gerado por você; se já existir, a resposta é 409 conflict
curl -X POST https://api.validades.com/v1/products \
-H "Authorization: Bearer vld_live_SUA_CHAVE" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: produto-7891000100103" \
-d '{"name": "Leite integral 1L", "code": "7891000100103", "days_to_be_next": 15, "category_id": "ID_DA_CATEGORIA"}'

Resposta 201 com { "data": { …produto… } } e o cabeçalho ETag.

Alterar: PATCH /v1/products/{id}​

Envie só os campos que quer mudar (pelo menos um). null limpa o campo, exceto name, que não pode ficar vazio.

curl -X PATCH https://api.validades.com/v1/products/ID_DO_PRODUTO \
-H "Authorization: Bearer vld_live_SUA_CHAVE" \
-H "Content-Type: application/json" \
-d '{"days_to_be_next": 7, "brand_id": null}'

Resposta 200 com o produto atualizado. Aceita If-Match.

Excluir: DELETE /v1/products/{id}​

Exclui também os lotes

Excluir um produto exclui todos os lotes dele e a foto, em todos os aparelhos da organização. A exclusão é definitiva.

{
"data": {
"id": "6b7e1f0a-…",
"deleted": { "product": 1, "batches": 3 }
}
}

Aceita If-Match.