Integração de Locais - HTTP POST

O endpoint abaixo permite, através de um POST HTTP, criar ou alterar locais de forma simplificada.

Exemplo em cURL

curl 'http://SERVER:PORT/api/place/import' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic aW50ZWdyYcOnw6NvOjEyMzQ1Njc4' \
-d '{
    "items": [
         {
            "reference":"1234", 
            "name":"Local Pai", 
            "address":"Rua x", 
            "localization":"01", 
            "type":"SITE",
            "parentReference":"1234",
            "campoCustom1": true,
            "campoCustom2": 123
        },{
            "reference":"5678", 
            "name":"Local", 
            "address":"Rua X", 
            "localization":"01.01", 
            "type":"WAREHOUSE",
            "parentReference":"1234",
            "campoCustom1": true,
            "campoCustom2": 123
        }
    ]
}

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

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

• items - OBRIGATÓRIO

  • Lista de registros a serem criados/atualizados

• reference - OBRIGATÓRIO

  • Alfanumérico
  • Código Único do local
  • Chave Primaria - Utilizado para criação ou alteração do registro

• name - OBRIGATÓRIO

  • Texto
  • Nome do local

• address

  • Texto
  • Endereço do local

• localization

  • Texto
  • Código Único
  • Localização hierarquica por mascará como o usado em WMS, Ex: 01.01.01, 02.01.01 etc

• type - OBRIGATÓRIO

  • Texto Predefinido - Maiúsculo
  • Tipo do local
  • Valores aceitos:
    • SITE - Planta
    • WAREHOUSE - Armazém/Depósito
    • SECTOR - Setor/Prateleira
    • CONTAINER - Tipo de local para armazenagem com localização

• parentReference

  • Alfanumérico
  • Código Único do local pai
  • Referência do local pai hierárquico desse local

• campoCustom1 e campoCustom2

  • Quaisquer nomes de campos personalizados desde que os mesmos estejam devidamente configurados nas configurações de campos personalizados do sistema.

Resposta em caso de sucesso

Retorna a referência com seu respectivo Identificador interno.

{
    "items": [
        {
            "reference":"1234", 
            "id":"00e80f22-9b9d-44d7-bb57-dbb345b90dec"
        },{
            "reference":"5678", 
            "id":"1b7f433d-5ac2-4882-a440-a998fe5b2fe4"
        }
    ]
}