Campos de cadastro e estoque: contratos verificados
Estas regras foram extraídas das classes StoreCustomerRequest, StoreProductRequest e UpdateStockRequest da API V1 que acompanhou esta entrega. É necessário validar novamente quando a API evoluir.
Cadastrar cliente
POST /api/v1/customers — permissão customers.create.
name: obrigatório, texto de 3 a 255 caracteres.type: obrigatório,FouJ.code: opcional, até 100 caracteres.taxvat: opcional, normalizado para os dígitos e limitado a 14 caracteres.- Se enviar
addresses, cada endereço exige CEP, rua, bairro, cidade, estado e número.
{"name":"Cliente de exemplo","type":"F"}
Cadastrar produto
POST /api/v1/products — permissão products.create.
manage_stock: obrigatório, booleano.code: obrigatório, código de 3 a 100 caracteres, único na empresa.name: obrigatório, 3 a 255 caracteres.price: obrigatório, numérico e maior ou igual a zero.unit: obrigatório, 1 a 10 caracteres.typeeconditionrecebem valores padrão quando omitidos (SIMPLEeNOT_SPECIFIED). Montagens exigem campos adicionais.
{"manage_stock":false,"code":"SKU-EXEMPLO","name":"Produto ilustrativo","price":19.9,"unit":"UN"}
Atualizar saldo
PUT /api/v1/inventory/stock/products/{product} — permissão inventory.stock.update.
quantity: obrigatório, numérico e não negativo.- Informe exatamente um identificador de depósito:
warehouse_idouwarehouse_code. - Campos alternativos de lote e localização também são mutuamente exclusivos.
- O depósito precisa estar ativo e pertencer à empresa do token.
{"warehouse_code":"DEP-EXEMPLO","quantity":10}
A identificação de depósito no exemplo é ilustrativa; troque por um valor real existente no ambiente autorizado. Não use exemplos contra produção sem conferir seus efeitos.