Skip to navigation

Consultar produto ou serviço

Consulta um produto ou serviço, inclusive quando inativo.

Autenticação: Bearer Token da API WBudget. O acesso aos dados respeita as permissões do usuário.

Use o ID do cadastro de produtos e serviços. Não é o ID de uma linha da oportunidade.

Parâmetros de caminho

CampoTipoObrigatórioDescrição
idintegerSimID do produto ou serviço.

Resposta

HTTP 200. Os exemplos usam dados fictícios e mostram os campos principais; outros campos podem acompanhar a resposta. Campos sem valor podem ser nulos.

Campos principais de data:

CampoTipoDescrição
idintegerID do produto ou serviço.
namestringNome, entre 1 e 150 caracteres.
typestringproduct ou service. Padrão product.
categoryinteger ou nullID de categoria existente. Null remove a categoria; omitido na criação usa o padrão da conta.
valuenumberPreço unitário entre 0 e 99999999.9999. Padrão 0.
qtynumberQuantidade entre 0 e 99999999.9999. Padrão 1; arredondada conforme a unidade.
unitstringUnidade cadastrada (até 8 caracteres). Na criação: un para produto e hour para serviço.
descriptionstring ou nullDescrição do produto ou serviço.
activeboolean ou integertrue/false ou 1/0. Padrão true. Itens inativos deixam de aparecer em GET /items.
costnumberCusto não negativo, máximo 99999999.9999. Padrão 0; a consulta respeita as permissões do usuário.
taxnumberTributo não negativo, máximo 999999.999999. Padrão 0, conforme configuração comercial da conta.
skustring ou nullCódigo SKU único, até 45 caracteres. Null ou texto vazio remove o código.
pnstring ou nullCódigo do fabricante único, até 45 caracteres. Null ou texto vazio remove o código.
tagstring ou nullEtiquetas do item.
metadataobject ou nullCampos personalizados. Chaves enviadas são mescladas; uma chave com null é removida. O objeto omitido ou null preserva os valores atuais.
category_namestring ou nullNome da categoria.
create_datestringData de criação.
{
"data": {
"id": 501,
"name": "Consultoria",
"type": "service",
"category": null,
"category_name": null,
"value": 150,
"qty": 1,
"unit": "hour",
"description": "Consultoria por hora",
"active": true,
"cost": 0,
"tax": 0,
"sku": "SERV-501",
"pn": null,
"tag": "consultoria",
"metadata": {
"referencia": "ERP-501"
},
"create_date": "2026-09-06T10:00:00-03:00"
}
}

Erros específicos

HTTPCódigoSituação
404ITEM_NOT_FOUNDItem not found.

Consulte a introdução da collection para o formato de erros e a configuração das variáveis.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

ID do produto ou serviço.

Response

200 — Sucesso — exemplo ilustrativo

dataobjectOptional

Errors

404
Not Found Error