Endpoints - Embalagem

1. Exemplo do json:

[
  {
      "codigo": 5,
      "id_unidade_medida_origem": 1,
      "id_unidade_medida_destino": 2,
      "descricao": "KG/SC",
      "multiplicador": 60,
      "fator_conversao": "M",
      "codigo_externo": 45,
      "ativo" : "S"
  }
]

Campos:

codigo: Código do registro no banco de dados do CRM
codigo_unidade_medida_origem: Código da unidade de media de origem da embalagem;
codigo_unidade_medida_destino: Código da unidade de media de destino da embalagem;
descricao: Descrição da embalagem;
multiplicador: Valor de multiplicação de quantidade para a embalagem;
fator_conversao: O tipo de cálculo que será utilizado para converter a quantidade da embalagem (M para multiplicação e D para divisão)
codigo_externo: Código da embalagem no sistema integrado.
ativo: Campo para indicar se a embalagem está ativa (S) ou inativa (N)

Todos os endpoints, com exceção do deletar, retornam o json nesse formato.

2. Endpoints

2.1 - Buscar uma embalagem pelo código

Endpoint: /embalagem

Tipo: get

Parâmetros:

codigoInterno: Tipo: Inteiro. Código da embalagem no banco de dados do CRM.
codigoExterno: Tipo: String. Código da embalagem no banco de dados do sistema integrado

Validações: É necessário informar pelo menos um dos parâmetros. Caso informado os dois o sistema prioriza o código externo.

Resposta: Status 200 - Retorna a embalagem no formato documentado na sessão Exemplo do json

2.2 - Buscar todas as embalagens

Endpoint: /embalagem/todos

Tipo: get

Resposta: Status 200 - Retorna a lista das embalagem no formato documentado na sessão Exemplo do json

2.3 - Cadastrar ou editar embalagem

Endpoint: /embalagem

Tipo: post

Notas:

Informe no corpo da requisição o json conforme exemplo na sessão 1.
Para cadastrar uma nova embalagem não informe o campo “codigo”;
Para editar uma embalagem já existente informe o campo “codigo” com o código da embalagem que deseja editar;
Serão permitidos o cadastro/edição de até 20 itens por vez.

Resposta: Status 200 - Retorna a embalagem cadastrada, no formato documentado na sessão Exemplo do json

2.4 - Inativar uma embalagem

Não é possível deletar uma embalagem, apenas inativar, pois a embalagem pode ter vinculo com um pedido ou outros registros. Nesse caso, a embalagem continuar no banco de dados porém com o status inativo.

Endpoint: /embalagem

Tipo: delete

Parâmetros:

codigoInterno: Tipo: Inteiro. Código da embalagem no banco de dados do CRM.
codigoExterno: Tipo: String. Código da embalagem no banco de dados do sistema integrado, caso existir.

Resposta: Status 200 - Mensagem: Registro inativado com sucesso.

2.5 - Retornar os metadados da embalagem

Endpoint: /embalagem/metadados

Tipo: get

Descrição: Retorna os campos do json, com as informações de tipo, tamanho máximo, se o campo é requerido, filtrável e/ou ordenável

Resposta: Status 200 - Retorna um json com as informações dos campos da embalagem

2.6 - Pesquisar

Endpoint: /embalagem/pesquisa

Tipo: post

Notas:

Esse endpoint retorna as embalagens baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:
{ "pagina": 1, "quantidadeRegistros": 2, "filtros": [ { "campo": "descricao", "comparacao": "CONTEM", "valor": "KG" } ], "ordenacao": [ { "campo": "descricao", "ordenacao": "ASC" } ] }
Nesse exemplo, estamos filtrando todas as embalagens cuja descrição possua o texto “KG”, também estamos ordenando os registros pela descrição de forma ascendente.