Skip to navigation

Criar produto ou serviço

Cria um produto ou serviço no cadastro.

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

Requer permissão de edição do cadastro de produtos. Envie um objeto JSON; name é obrigatório. Os demais campos seguem os padrões indicados. Erros de validação ou conflito não criam o item.

Corpo da requisição

CampoTipoObrigatórioDescrição
namestringSimNome, entre 1 e 150 caracteres.
typestringNãoproduct ou service. Padrão product.
categoryinteger ou nullNãoID de categoria existente. Null remove a categoria; omitido na criação usa o padrão da conta.
valuenumberNãoPreço unitário entre 0 e 99999999.9999. Padrão 0.
qtynumberNãoQuantidade entre 0 e 99999999.9999. Padrão 1; arredondada conforme a unidade.
unitstringNãoUnidade cadastrada (até 8 caracteres). Na criação: un para produto e hour para serviço.
descriptionstring ou nullNãoDescrição do produto ou serviço.
activeboolean ou integerNãotrue/false ou 1/0. Padrão true. Itens inativos deixam de aparecer em GET /items.
costnumberNãoCusto não negativo, máximo 99999999.9999. Padrão 0; a consulta respeita as permissões do usuário.
taxnumberNãoTributo não negativo, máximo 999999.999999. Padrão 0, conforme configuração comercial da conta.
skustring ou nullNãoCódigo SKU único, até 45 caracteres. Null ou texto vazio remove o código.
pnstring ou nullNãoCódigo do fabricante único, até 45 caracteres. Null ou texto vazio remove o código.
tagstring ou nullNãoEtiquetas do item.
metadataobject ou nullNãoCampos personalizados. Chaves enviadas são mescladas; uma chave com null é removida. O objeto omitido ou null preserva os valores atuais.

Exemplo de JSON enviado

{
"name": "Consultoria",
"type": "service",
"unit": "hour",
"value": 150,
"qty": 1,
"description": "Consultoria por hora",
"sku": "SERV-501",
"metadata": {
"referencia": "ERP-501"
}
}

Resposta

HTTP 201. 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
422VALIDATION_FAILEDInvalid field: name.
409ITEM_ALREADY_EXISTSSKU or part number already exists.

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.

Request

This endpoint expects an object.
descriptionstringOptional
metadataobjectOptional
namestringOptional
qtydoubleOptional
skustringOptional
typestringOptional
unitstringOptional
valuedoubleOptional

Response

201 — Sucesso — exemplo ilustrativo

dataobjectOptional

Errors

409
Conflict Error
422
Unprocessable Entity Error