Sign in

v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
products

Retorna um produto específico através do ID.

Produtos definem os itens associados a uma assinatura ou fatura.

Precificação

A plataforma Vindi suporta vários tipos diferentes de cálculos de precificação para os produtos. Consulte este artigo para mais informações sobre os métodos de cálculo.

get/v1/products/{id}

Path parameters

idinteger required

ID do produto que deverá ser retornado.

Response

Ok. Produto encontrado.

idinteger required

ID do produto

namestring required

Nome do produto

codestring

Código externo do produto

unitstring

Texto para descrever uma unidade do produto. Apenas para quantidade variável

status'active' | 'inactive' | 'deleted' required

Status do produto

descriptionstring

Descrição interna do produto

invoice'always' | 'never'

Indica se este produto será incluído na emissão de notas fiscais. Se não informado, o valor always será utilizado

created_atstring required

Data e hora do cadastro do produto

updated_atstring required

Data e hora da última atualização do produto

metadataobject

Metadados do produto