Integração de Documentos - HTTP POST

O endpoint abaixo permite, através de um POST HTTP, criar ou alterar de forma simplificada documento, produtos, cor, tamanho, fornecedores e epc.

Exemplo em cURL

shell

curl 'http://SERVER:PORT/api/document/import' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4' \
-d '{
    "items": [
        {
            "documentReference": "123/1234",
            "documentDescription": "Documento 123",
            "documentDate": "2023-10-18",
            "documentBatch": "LOTE 987",
            "placeReference":"123",
            "placeName":"Local 1",
            "placeType": "WAREHOUSE",
            "customerReference":"321",
            "customerName":"Cliente 1",
            "documentType": "MANUFACTURE",
            "supplierReference": "123457",
            "supplierName": "Fornecedor xyz",
            "productReference": "789",
            "productGridReference":"78915",
            "productType": "RAW",
            "productDescription": "Produto 1",
            "barcode": "9876543210",
            "measureUnit": "Un",
            "size": "M",
            "color": "Azul",
            "batch": "lote 32/2024",
            "fraction": 5,
            "quantity": 10,
            "epc": "ABC456789012345678901234",
            "campoCustom1": false,
            "campoCustom2": "teste"
        }
    ]
}'

Obs 1: SERVER é o IP ou DNS do servidor onde o sistema Valesoft está instalado e PORT é a porta definida na instalação.

Obs 2: A chamada para esse endpoint necessita autenticação do tipo Basic com credenciais de um usuário devidamente cadastrado no sistema Valesoft. Ex: Usuário integração com senha 12345678 => Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4

Baseado nos dados do exemplo cURL seriam criados os seguintes dados:

Local:
- Código - 123
- Nome - Local 1
- Tipo = Depósito(WAREHOUSE)
Cliente:
- Código - 321
- Nome - Cliente 1
Fornecedor:
- Código - 123457
- Nome - Fornecedor xyz
Tamanho:
- Descrição - M
Cor:
- Descrição - Azul
Produto:
- Código - 789
- Descrição - Produto 1
- Tipo - Matéria Prima(RAW)
- Unidade de Medida - Un
- Código de Barras - 9876543210
- Tamanho - M
- Cor - AZ
Documento:
- Código - 123/1234
- Descrição - Documento 123
- Lote - LOTE 987
- Tipo - Ordem de produção(MANUFACTURE)
- Data - 18/10/2023
- Fornecedor - 123457
Item do Documento:
- Produto - 789
- Lote - lote 32/2024
- Quantidade - 10
- Fracionamento - 0
EPC:
- Produto - 789
- Documento - 123/1234
- epc - ABC456789012345678901234
- Lote - lote 32/2024
- Fracionamento - 5

Definições dos campos do corpo da requisição:

items - OBRIGATÓRIO
- Lista de registros a serem criados/atualizados
documentReference - OBRIGATÓRIO
- Alfanumérico
- Código do documento
- Chave Primaria - Utilizado para criação ou alteração do registro
documentDescription - OBRIGATÓRIO
- Texto
- Descrição do documento
documentDate - OBRIGATÓRIO
- Data no formato AAAA-MM-DD
- Data de Emissão do documento
  - Ex 2023-11-01
documentBatch
- Texto
- Lote do documento
documentType - OBRIGATÓRIO
- Texto Predefinido - Maiúsculo
- Tipo do documento
- Valores aceitos:
  - PROCESSING - Ordem de Beneficiamento
  - MANUFACTURE - Ordem de produção
  - ENTRY - Nota de Entrada
  - OUTGOING - Nota de Saída
  - SALES - Pedido de venda
  - SHIPPING - Remessa
placeReference - OBRIGATÓRIO quando informado o placeName
- Alfanumérico
- Código do Local
- Chave Primaria - Utilizado para criação ou alteração do registro
placeName
- Texto -Nome do Local
placeType - OBRIGATÓRIO quando informado o placeName
- Texto Predefinido - Maiúsculo
- Tipo do local
- Valores aceitos:
  - SITE - Planta/Empresa
  - WAREHOUSE - Depósito
  - SECTOR - Setor/Prateleira
  - CONTAINER - Armazenagem de localização
customerReference - OBRIGATÓRIO quando informado o customerName
- Alfanumérico
- Código do Cliente
- Chave Primaria - Utilizado para criação ou alteração do registro
customerName
- Texto
- Nome do Cliente
supplierReference - OBRIGATÓRIO quando informado o supplierName
- Código do fornecedor
- Chave Primaria - Utilizado para criação ou alteração do registro
supplierName
- Nome do fornecedor
productReference - OBRIGATÓRIO
- Alfanumérico
- Código/SKU Único do produto
- Chave Primaria - Utilizado para criação ou alteração do registro
productType - OBRIGATÓRIO
- Texto Predefinido - Maiúsculo
- Tipo do produto
- Valores aceitos:
  - RAW - Matéria-prima
  - PRODUCED - Produto acabado
  - CONTAINER - Armazenagem
  - FIXED_ASSET - Ativo Imobilizado
productDescription - OBRIGATÓRIO
- Alfanumérico
- Descrição do produto
barcode
- Numérico Inteiro
- Código de barras EAN-13 ou um sequencial numérico único do produto, utilizado para a criação da etiqueta EPC no padrão GS1-SGTIN
measureUnit
- Texto
- Unidade de medida do produto
  - Ex. M², Un, KG
productGridReference
- Alfanumérico
- Código/SKU Único da grade do produto
- Chave Primaria - Utilizado para criação ou alteração do registro
size
- Alfanumérico
- Código do tamanho do produto
- Chave Primaria - Utilizado para criação ou alteração do registro
color
- Alfanumérico
- Código da cor do produto
- Chave Primaria - Utilizado para criação ou alteração do registro
batch
- Alfanumérico
- Lote do item no documento/epc
fraction
- Numérico Decimal
- Quantidade fracionada do produto/epc
  - Ex. Peso, Metragem, etc
quantity - OBRIGATÓRIO
- Numérico Inteiro
- Quantidade de etiquetas desse produto no documento
- OBS: Em caso de alteração do documento, quando informados "EPC" ou "LOTE"(Batch), não é possível alterar o campo "quantity".
epc
- Alfanumérico com restrição(A-F0-9)
- Código EPC da etiqueta a ser cadastrada no sistema.
campoCustom1 e campoCustom2
- Quaisquer nomes de campos personalizados desde que os mesmos estejam devidamente configurados nas configurações de campos personalizados do sistema para as tabelas dessa integração.

Resposta em caso de sucesso

Retorna as referências com seus respectivos identificadores interno.

JSON

{
    "items": [
        {
            "documentReference":"123/1234", 
            "documentId":"00e80f22-9b9d-44d7-bb57-dbb345b90dec",
            "productReference":"789", 
            "productId":"2fb615aa-4ec4-423d-b0a7-cf0369d025d8",
            "productGridReference":"789789", 
            "productGridId":"2fb615aa-4ec4-423d-b0a7-cf0369d025d8",
            "placeReference":"789", 
            "placeId":"2fb615aa-4ec4-423d-b0a7-cf0369d025d8",
            "colorReference":"AZ", 
            "colorId":"917346b1-bc78-4e26-9449-9d33c241eb5c",
            "siseReference":"AZ", 
            "siseId":"917346b1-bc78-4e26-9449-9d33c241eb5c",
            "supplierReference":"123457", 
            "supplierId":"e76c711a-e4b4-4ac7-8c13-565d585c04cf",
            "customerReference":"123457", 
            "customerId":"e76c711a-e4b4-4ac7-8c13-565d585c04cf",
            "epcReference":"012345678901234567891234", 
            "epcId":"e76c711a-e4b4-4ac7-8c13-565d585c04cf"
        }
    ]
}

Obs.: Deve ser enviado um máximo de 250 itens.
Caso necessário o envio de mais de 250 itens em um único documento será necessário utilização do parâmetro Remover itens excedentes do documento

Obs 2.: Devido ao parâmetro ser criado na versão 1.29.76, em versões anteriores se faz necessário o envio do documento completo, caso contrario itens não informados serão removidos do documento.

Integração de Documentos - HTTP POST ​

Definições dos campos do corpo da requisição: ​

Resposta em caso de sucesso ​

Integração de Documentos - HTTP POST

Definições dos campos do corpo da requisição:

Resposta em caso de sucesso