Introdução
Autenticação
Resposta e erros
SDKs e plugins
Países
Isenções IVA
Changelog
Vendas
Recibos
Clientes
Clientes - Contas em aberto
Artigos
Artigos - Stock
Artigos - Movimentos stock
Agenda - Marcações
Agenda - Indisponibilidades
Administração
Administração - Armazéns
Administração - Categorias
Administração - Colaboradores
Administração - Condições de pagamento
Administração - Formas de pagamento
Administração - Modos de expedição
Administração - Moedas
Administração - Preços
Administração - Séries
Administração - Taxas de IVA
Administração - Tipos de documento
Administração - Veículos
Administração - Unidades
Subscrição - Locais
Artigos
—Este endpoint visa gerir os artigos.
POST /items/create |
POST /items/:id/update |
POST /items/:id/delete |
POST /items/:id/delete_image |
POST /items/find |
POST /items/list |
POST /items/stock/movements/create |
POST /items/stock/movements/:id/update |
POST /items/stock/movements/:id/delete |
POST /items/:id/stock/actual |
Artigos - Criar
O artigo é sempre criado no estado activo. Caso decida fazer o upload da imagem, o Content-Type enviado nos Headers deve
ser multipart/form-data ou application/x-www-form-urlencoded.
Referência do artigo. Se não for enviado nenhum valor vai ser dado seguimento à última referência ou gerado uma referência aleatória.
Descrição
Descrição detalhada do artigo
Se mostra a descrição detalhada na impressão
Categoria do artigo. Deve ser enviado o ID.
Unidade de medida. Pode ser enviado o ID, descritivo ou símbolo, exemplo: cm, kg, Kilos, etc.
Taxa de IVA a aplicar. Pode ser enviado o ID, descritivo ou a taxa, exemplo: 23, 13, etc.
Isenção de IVA a aplicar. Pode ser enviado o ID ou o código, exemplo: M08, etc. No caso de não preenchimento será assumido o valor M18 - Sem isenção.
Tipo de contabilidade. Deve ser enviado um dos seguintes valores: Embalagens, Matérias primas, Mercadorias, Produtos acabados e intermédios, Serviços, Subprodutos, Transporte, Vasilhame.
Preço de custo do artigo
Observações do artigo
Imagem do artigo
Lista de preços a aplicar
ID da tabela de preços
Preço
Desconto
Lista de códigos barras
Código
Quantidade
Descrição
Lista de stock mínimo (alerta) por armazém
ID da tabela de armazéns
Quantidade
Request POST /items/create
{
"reference": ..
"description": ..
"details": ..
"details_show_print": ..
"category": ..
"unit": ..
"vat": ..
"vat_exemption": ..
"type": ..
"cost_price": ..
"observations": ..
"prices": []
"barcodes": []
"minimum_stock": []
}Response 200
{
"status": true,
"data":
{
"id": ..
"reference": ..
"description": ..
"details": ..
"details_show_print": ..
"category_id": ..
"unit_id": ..
"vat_id": ..
"vat_exemption_id": ..
"type": ..
"cost_price": ..
"observations": ..
"url_image": ..
"reference_blocked": ..
"description_blocked": ..
"active": ..
"updated_at": ..
"created_at": ..
"category": []
"prices": []
"barcodes": []
"averagecostprices": []
"minimumstock": []
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
- Não preencheu todos os campos obrigatórios
- Não tem permissões para executar esta operação
- É obrigatória a indicação de um valor para o campo X
- O valor indicado para o campo referência já se encontra registado
- O formato da imagem não é válido
- O tamanho da imagem não pode ser superior a 3MB