Produtos

📘
O seu estoque será baseado nos seus produtos.

Os produtos são criados por meio do nosso endpoint de Produto. A requisição deve ser parecida com esta:

[
  {
    "ean13": "92543841385",            // EAN do produto
    "descriptionProduct": "Coca-Cola", // Descrição do produto
    "packingOut": 12,                  // Número de unidades na embalagem que você vende (saída)
    "packingInbound": 12,              // Número de unidades na embalagem que você compra (entrada)
    "validityDays": 180,               // Prazo de validade (em dias)
    "lotControl": 0,                   // Controlar o lote do produto? 0 = Não, 1 = Sim
    "unity": "UN",                     // Unidade de medida do produto
    "relationalProductId": "4587",     // Id do produto no sistema de origem
    "relationalProviderId": "8413",    // Id do fornecedor do produto no sistema de origem
    "providerLine": "PHARMA",          // Categoria do fornecedor do produto, ex.: PHARMA
    "productSituationId": 1            // Situação do produto: 1 = Ativo, 2 = Inativo, 3 = Em cadastro
  }
]

Estes são os campos que você deve enviar para criar um produto.

🚧
A API exige obrigatoriamente descriptionProduct, packingOut, validityDays, lotControl, unity, relationalProductId e productSituationId. Os demais campos mostrados acima (ean13, packingInbound, relationalProviderId, providerLine) são validados por regras de negócio durante o processamento e devem sempre ser enviados quando disponíveis. Se packingInbound for omitido, assume 1 como padrão.

Campos opcionais

📘
Os campos de flag (ex.: variableWeight, isKit, qualityControl, temperatureControl) são booleanos — envie true ou false, e não 1/0.

Nome	Descrição	Valor padrão
generic	Princípio ativo do medicamento
decimalPlaces	Casas decimais a considerar na gestão do estoque do produto	0
height	Altura do produto
width	Largura do produto
length	Comprimento do produto
weight	Peso do produto
packingWeight	Peso da embalagem do produto
group	Grupo do produto; pode ser qualquer valor
subGroup	Subgrupo do produto; pode ser qualquer valor
relationalLogisticOperationId	Id da operação logística no sistema de origem. Obrigatório se houver mais de uma.
salePrice	Preço do produto
variableWeight	True se o produto tem peso variável	false
tolerance	Tolerância de variação de peso do produto
isKit	True se o produto faz parte de um kit	false
specialTreatment	True se o produto precisa de tratamento especial	false
qualityControl	True se o produto precisa de conferência de qualidade	false
inputSerialNumberCheck	True se o produto precisa de controle de número de série nas operações de entrada	false
outgoingSerialNumberCheck	True se o produto precisa de controle de número de série nas operações de saída	false
manufacturerSerialNumberRecord	True se o produto precisa rastrear o número de série do fabricante	false
institutional	True se é um produto institucional	false
surveillance	True se o produto é controlado pela vigilância sanitária	false
hiv	True se o produto se destina ao tratamento de doença grave	false
fragility	Categoria de fragilidade; pode ser qualquer valor
automatedAdrres	Endereço automatizado do produto
temperatureControl	True se o produto precisa de controle de temperatura	false
temperatureGroup	Grupo de temperatura do produto; pode ser qualquer valor
photoLink	URL de uma imagem do produto
update	Atualiza os dados do produto caso ele já exista (1 = Sim, 0 = Não). Observação: atualmente os produtos existentes são sempre atualizados, portanto este flag não tem efeito.	1
locationTrace	Rastreabilidade local
volume	Volumetria do produto (resultado de peso × altura × comprimento)
conferenceSerialNumberMovement	True se o produto confere o número de série na movimentação. Se omitido enquanto `manufacturerSerialNumberRecord` e `inputSerialNumberCheck` forem ambos true, assume true como padrão.	false
linkingLocationSerialNumberId	Onde o vínculo do número de série é realizado: 1 = Checkout, 2 = Separação. Se omitido enquanto `manufacturerSerialNumberRecord` e `outgoingSerialNumberCheck` forem ambos true, assume 1 (Checkout) como padrão.
productPackagings	Lista das embalagens do produto, veja aqui.
productRelationalLogisticOperations	Lista de operações logísticas em que este produto está disponível, veja aqui.
productRestrictionAddresss	Lista de grupos de restrição, veja aqui.
productShelfLifes	Lista de prazos de validade, veja aqui.
productCurves	Lista de curvas do produto, veja aqui.
productKits	Lista de kits do produto, veja aqui.

🚧
Dois nomes de propriedade são escritos exatamente como a API espera — parecem typos, mas não são: automatedAdrres e productRestrictionAddresss (com três "s"). Envie-os exatamente como mostrado.

Embalagens do produto

📘
Dentro de uma embalagem, barCode, quantity e barCodeTypeId são obrigatórios.

Nome	Descrição	Valor padrão
barCode	Código de barras da embalagem. Obrigatório.
quantity	Número de unidades na embalagem. Obrigatório.
barCodeTypeId	Tipo de código de barras: 1 = EAN, 2 = UPC, 3 = DUN-14, 999 = Outros. Obrigatório.
height	Altura da embalagem
width	Largura da embalagem
length	Comprimento da embalagem
weight	Peso da embalagem
primaryBarCode	True se esta é a embalagem principal do produto	false

Operações logísticas do produto

Nome	Descrição	Valor padrão
relationalLogisticOperationId	Id da operação logística no sistema de origem. Obrigatório.
allowed	True se o produto é usado nesta operação	false

Grupos de restrição do produto

Nome	Descrição	Valor padrão
restrictionProductGroup	Grupo de restrição do produto; pode ser qualquer valor. Obrigatório.
delete	True para remover o produto deste grupo de restrição	false

Prazos de validade do produto

Nome	Descrição	Valor padrão
shelfLifeGroup	Nome do grupo de validade; pode ser qualquer valor
minimumValidity	Validade mínima em dias	0
maximumValidity	Validade máxima em dias	0

Curvas do produto

📘
Dentro de uma curva, curve é obrigatório.

Nome	Descrição	Valor padrão
curve	Curva do produto. Obrigatório. O valor deve estar previamente cadastrado no WMSWeb.
relationalLogisticOperationId	Código da operação logística no sistema de origem (ERP). Use quando o produto possuir mais de uma operação logística e a curva precisar ser cadastrada para apenas uma delas.

Kits do produto

📘
Dentro de um kit, amount é obrigatório.

Nome	Descrição	Valor padrão
amount	Quantidade do produto componente no kit. Obrigatório.
relationalInputProductId	Código relacional do produto componente no sistema de origem.

Para mais informações sobre as propriedades, consulte a nossa Referência da API aqui.

Produtos

O seu estoque será baseado nos seus produtos.

Campos opcionais

Os campos de flag (ex.: `variableWeight`, `isKit`, `qualityControl`, `temperatureControl`) são booleanos — envie `true` ou `false`, e não `1`/`0`.

Dois nomes de propriedade são escritos exatamente como a API espera — parecem typos, mas não são: `automatedAdrres` e `productRestrictionAddresss` (com três "s"). Envie-os exatamente como mostrado.

Embalagens do produto

Dentro de uma embalagem, `barCode`, `quantity` e `barCodeTypeId` são obrigatórios.

Operações logísticas do produto

Grupos de restrição do produto

Prazos de validade do produto

Curvas do produto

Dentro de uma curva, `curve` é obrigatório.

Kits do produto

Dentro de um kit, `amount` é obrigatório.

O seu estoque será baseado nos seus produtos.

Campos opcionais

Os campos de flag (ex.: variableWeight, isKit, qualityControl, temperatureControl) são booleanos — envie true ou false, e não 1/0.

Dois nomes de propriedade são escritos exatamente como a API espera — parecem typos, mas não são: automatedAdrres e productRestrictionAddresss (com três "s"). Envie-os exatamente como mostrado.

Embalagens do produto

Dentro de uma embalagem, barCode, quantity e barCodeTypeId são obrigatórios.

Operações logísticas do produto

Grupos de restrição do produto

Prazos de validade do produto

Curvas do produto

Dentro de uma curva, curve é obrigatório.

Kits do produto

Dentro de um kit, amount é obrigatório.

Os campos de flag (ex.: `variableWeight`, `isKit`, `qualityControl`, `temperatureControl`) são booleanos — envie `true` ou `false`, e não `1`/`0`.

Dois nomes de propriedade são escritos exatamente como a API espera — parecem typos, mas não são: `automatedAdrres` e `productRestrictionAddresss` (com três "s"). Envie-os exatamente como mostrado.

Dentro de uma embalagem, `barCode`, `quantity` e `barCodeTypeId` são obrigatórios.

Dentro de uma curva, `curve` é obrigatório.

Dentro de um kit, `amount` é obrigatório.