API de Integração Escalasoft (1.0.0)

Download OpenAPI specification:

Segurança

Gerar token

BASIC, deve ser enviado no cabeçalho da requisição o usuário e a senha gerados pela GH.

Authorizations:
BearerAuth
query Parameters
usuario
required
string

login do usuário

senha
required
string

senha de acesso

Responses

Response samples

Content type
applicatizon/json
{
  • "Retorno": [
    ]
}

Produtos

Criar produto

Cria um produto com base nos dados informados

Authorizations:
BearerAuth
Request Body schema: application/json
object (ListaProduto)

Listagem de produtos

Responses

Request samples

Content type
application/json
{
  • "Lista": {
    }
}

Response samples

Content type
application/json
{
  • "Lista": [
    ]
}

Alterar produto

Altera os dados do produto informado

Authorizations:
BearerAuth
query Parameters
codigoProduto
required
string

Código de referência do produto

Request Body schema: application/json
object (MaterialSuprimentoProdutoPut)

Responses

Request samples

Content type
application/json
{
  • "Item": {
    }
}

Cancelar produto

Cancela o produto informado

Authorizations:
BearerAuth
query Parameters
codigoProduto
required
string

Código de referência do produto

Request Body schema: application/json
Motivo
required
string

Responses

Request samples

Content type
application/json
{
  • "Motivo": "string"
}

Consultar produto

Retorna todas as informações do produto

Authorizations:
BearerAuth
query Parameters
codigoReferencia
required
string

Código de referência do produto

Responses

Response samples

Content type
application/json
{
  • "Item": {
    }
}

Ordem de armazengem

Criar ordem de armazenagem

Cria uma ordem de armazenagem com base nos dados informados

Authorizations:
BearerAuth
Request Body schema: application/json
object (Lista)

Listagem de ordens de armazenagem

Responses

Request samples

Content type
application/json
{
  • "Lista": {
    }
}

Response samples

Content type
application/json
{
  • "Lista": [
    ]
}

Atrelar ordens de armazenagem

Atrela uma ordem a outra ordem de armazenagem

Authorizations:
BearerAuth
query Parameters
numeroOrdem
required
integer

Número da ordem de armazenagem

Request Body schema: application/json
object (AtrelarOrdemArmazenagem)

Atrela a ordem com outra ordem de armazenagem

Responses

Request samples

Content type
application/json
{
  • "AtrelarOrdem": {
    }
}

Response samples

Content type
application/json
{
  • "Mensagem": "Registro cadastrado com sucesso!"
}

Cadastrar anexos da ordem de armazenagem

Cadastra anexos na ordem de armazenagem

Authorizations:
BearerAuth
query Parameters
numeroOrdem
required
integer

Número da ordem de armazenagem

Request Body schema: application/json
object (ListaCadastrarAnexoOrdemArmazenagem)

Cadastrar anexo da ordem de armazenagem

Responses

Request samples

Content type
application/json
{
  • "Lista": {
    }
}

Response samples

Content type
application/json
{
  • "Lista": [
    ]
}

Remover Anexos da ordem de armazenagem

Exclui anexos na ordem de armazenagem

Authorizations:
BearerAuth
query Parameters
numeroOrdem
required
integer

Número da ordem de armazenagem

sequencialAnexo
required
integer

Sequencial do anexo da ordem (retornado na consulta de ordem)

Request Body schema: application/json
object (RemoverAnexoOrdemArmazenagem)

Remover anexo da ordem de armazenagem

Responses

Request samples

Content type
application/json
{
  • "Anexo": {
    }
}

Response samples

Content type
application/json
{
  • "Mensagem": "O registro foi cancelado com sucesso!"
}

Consultar ordem de armazenagem

Retorna todas as informações da ordem de armazenagem

Authorizations:
BearerAuth
query Parameters
numeroOrdem
integer

Número da ordem de armazenagem

numeroPedido
string

Número do pedido

numeroDocumento
string

Número do documento de entrada

serieDocumento
string

Série do documento de entrada

Responses

Response samples

Content type
application/json
{
  • "Situacao": "Cadastrada(o)",
  • "Filial": "string",
  • "Tipo": "string",
  • "Cliente": "string",
  • "ClienteFaturamento": "string",
  • "NaturezaOperacao": "string",
  • "Solicitante": "string",
  • "Deposito": "string",
  • "Projeto": "string",
  • "UnidadeNegocioCliente": "string",
  • "Observacao": "Observação da ordem de armazenagem",
  • "Solicitacao": "06/12/1990 13:30",
  • "Previsao": "06/12/1990 13:30",
  • "Data": "06/12/1990 13:30:00:0000",
  • "NumeroPedido": "PED123784",
  • "NumeroControle": "CONTR648425",
  • "NaoFaturar": "N",
  • "SemServico": "S",
  • "SemServicoAutomatico": "N",
  • "ApontamentoTerceiroObrigatorio": "N",
  • "NaturezaFiscal": "string",
  • "Documento": {
    },
  • "Entrada": {
    },
  • "Saida": {
    },
  • "CargaDescarga": [
    ],
  • "Anexo": [
    ]
}

Consultar entradas encerradas

Retorna os dados da mercadoria recebida

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "Ordem": [
    ]
}

Consultar pedidos pendentes

Retorna todos os pedidos que estão aguardando documento fiscal e que ainda não foram recebidos pelo cliente

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "Pedidos": [
    ]
}

Consultar etapas executadas

Retorna todas as etapas executadas e que ainda não foram recebidos pelo cliente

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "Etapa": [
    ]
}

Estoque

Consultar estoque de mercadoria

Retorna todos o estoque de mercadoria do cliente

Authorizations:
BearerAuth
query Parameters
codigoProduto
string

Código de referência do produto

Responses

Response samples

Content type
application/json
{
  • "EstoqueMercadoria": [
    ]
}

Originário

Cadastrar importação de documento eletrônico

Cadastrar importação de documento eletrônico

Authorizations:
BearerAuth
Request Body schema: application/json
object (ListaOrdemDocumentoOriginario)

Listagem de ordens que serão vinculadas a um originário

Responses

Request samples

Content type
application/json
{
  • "Lista": {
    }
}

Response samples

Content type
application/json
{
  • "Lista": [
    ]
}

Carga e descarga

Consultar carga e descarga

Retorna as informações das cargas/descargas filtradas

Authorizations:
BearerAuth
query Parameters
numero
integer

Número da carga/descarga

dataInicial
string
Example: dataInicial=06/12/1990 13:30

Data de início (dd/mm/yyyy hh:mm)

dataFinal
string
Example: dataFinal=06/12/1990 13:30

Data de término (dd/mm/yyyy hh:mm)

somentePendente
string
Example: somentePendente=S

Retorna apenas os registros pendentes

Responses

Response samples

Content type
application/json
{
  • "CargaDescarga": [
    ]
}