logo
API docs by Redocly

API de Integração TPL (2.0.0)

Download OpenAPI specification:Download

Segurança

HTTP: BasicAuth
A autenticação inicial com as APIs REST da TPL deve ser realizada por meio de uma requisição GET utilizando Basic Auth. Para autenticar, você deve informar o usuário e senha que serão fornecidos pela equipe de projetos da TPL. Esta requisição irá retornar um token que deverá ser utilizado para autenticação nas demais rotas. Este token tem uma validade de 24 horas, e após este intervalo, deverá ser requisitado um novo token.

HTTP: BearerAuth
As autenticações com as APIs REST da TPL devem ser realizadas por meio de um token utilizando Bearer Token. Para autenticar, você deve utilizar o token recebido na rota de Login e adicioná-lo no header de cada requisição. O header de autenticação deve ser enviado para todos os endpoints disponíveis na API.

HTTP Authorization Scheme:
bearer

Gerar token

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

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": [
    ]
}

Produto do Armazem

Endpoints para cadastro, consulta e alteração de produtos.

Cadastrar produto

Cadastrar um produto com base nos dados informados.

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

Listagem de produtos

Responses

Request samples

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

Response samples

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

Alterar produto

Altera os dados do produto informado.

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

Listagem de produtos

Responses

Request samples

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

Response samples

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

Consultar produtos

Consulta todos os produtos cadastrados e ativos do cliente.

Authorizations:
BearerAuth
query Parameters
dataInicioCadastro
integer

Menor data de cadastro do produto a pesquisar, formato de data AAAA-MM-DD

dataTerminoCadastro
integer

Maior data de cadastro do produto a pesquisar, formato de data AAAA-MM-DD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consultar produtos com saldo

Consultar cadastro dos produtos com saldo e ativos do cliente.

Authorizations:
BearerAuth
query Parameters
dataInicioCadastro
integer

Menor data de cadastro do produto a pesquisar, formato de data AAAA-MM-DD

dataTerminoCadastro
integer

Maior data de cadastro do produto a pesquisar, formato de data AAAA-MM-DD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Estoque do Armazem

Endpoints para consultas ao estoque armazenado.

Consultar Estoque

Retorna o saldo atual do estoque de um determinado produto ou de todos os produtos.

Authorizations:
BearerAuth
query Parameters
Produto
integer

Código de referência do produto que deseja consultar, se este parâmetro não for informado retornará o saldo de todos os produtos.

Responses

Response samples

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

Consultar Estoque por lote

Retorna o saldo atual do estoque de um determinado produto ou de todos os produtos, separando entre itens com e sem controle de lote.

Authorizations:
BearerAuth
query Parameters
Produto
integer

Código de referência do produto que deseja consultar, se este parâmetro não for informado retornará o saldo de todos os produtos.

Responses

Response samples

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

Consultar Estoque agrupado

Retorna o saldo atual do estoque de um determinado produto ou de todos os produtos com dados resumidos.

Authorizations:
BearerAuth
query Parameters
Produto
integer

Código de referência do produto que deseja consultar, se este parâmetro não for informado retornará o saldo de todos os produtos.

Responses

Response samples

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

Consultar Estoque Totais

Retorna o total de mercadoria no estoque.

Authorizations:
BearerAuth

Responses

Response samples

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

Ordem do Armazem

Endpoints para cadastro, consulta e alteração de ordens de armazenagem.

Cadastrar ordem

Cadastrar uma nova ordem de armazenagem com base nos dados informados, essa ordem pode ser para realizar uma entrada ou saída de saldo.

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

Listagem de ordens de armazenagem

Responses

Request samples

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

Response samples

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

Cancelar ordem

Cancela a ordem de armazenagem.
Se atentar que, esse método só pode ser utilizado se a ordem ainda estiver no status Cadastrada. Após este status, a equipe operacional já esta realizando processos de separação e preparação do pedido e não é mais possível cancelar uma ordem em operação.
Caso precise cancelar uma ordem que já esteja em operação, é necessário entrar em contato com a equipe de CX responsável pela conta, para que eles, juntamente com a operação da TPL possam realizar todo o processo de cancelamento manual.

Authorizations:
BearerAuth
query Parameters
Numero
required
integer

Número da ordem de armazenagem

Request Body schema: application/json
Motivo
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "Mensagem": "Cancelamento efetuado"
}

Liberar ordem

Libera ordem para inicio de separação.

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

Listagem de ordens de armazenagem

Responses

Request samples

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

Response samples

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

Alterar ordem

Alterar uma ordem de armazenagem com base nos dados informados

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

Listagem de ordens de armazenagem

Responses

Request samples

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

Response samples

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

Consultar ordem individualmente

Retorna todas as informações da uma ordem de armazenagem buscando pelo numero da ordem ou pelo numero do pedido.

Authorizations:
BearerAuth
query Parameters
Numero
integer

Número da ordem de armazenagem

NumeroPedido
integer

Número do pedido da ordem de armazenagem

Responses

Response samples

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

Consultar ordens Ag. montagem de volume

Retorna informações de todas as ordens de armazenagem que estão aguardando montagem de volume.

Authorizations:
BearerAuth

Responses

Response samples

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

Consultar ordens Ag NFe

Retorna lista de ordens de armazenagem de saída que estão Ag NF-e para transporte.

Authorizations:
BearerAuth

Responses

Response samples

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

Consultar ordens Ag NFe (Com dados das Embalagens)

Retorna lista de ordens de armazenagem de saída que estão Ag NF-e para transporte. Diferente do método "/consultarpedidopendente", neste método é retornado os dados das embalagens dos pedidos.

Authorizations:
BearerAuth

Responses

Response samples

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

Consultar ordens em operação

Retorna lista de ordens de armazenagem que estão em operação

Authorizations:
BearerAuth

Responses

Response samples

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

Consultar ordens por data

Retorna lista de ordens de armazenagem que estão em operação, acrescentando ordens encerradas filtrando por data.

Authorizations:
BearerAuth
query Parameters
dataInicioCadastro
integer

Menor data de encerramento de ordem a pesquisar, formato de data AAAA-MM-DD

dataTerminoCadastro
integer

Maior data de encerramento de ordem a pesquisar, formato de data AAAA-MM-DD

Responses

Response samples

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

Consultar ordens encerradas

Retorna todas as informações de todas as ordem de armazenagem que estão encerradas e ainda não foram consultadas neste método.

Authorizations:
BearerAuth

Responses

Response samples

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

Consultar etapas da ordem individualmente

Retorna as datas dos processos da ordem de armazenagem.

Authorizations:
BearerAuth
query Parameters
Numero
required
integer

Número da ordem de armazenagem

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Consultar NF-e da ordem individualmente

Retorna dados da NFe vinculada a ordem de armazenagem.

Authorizations:
BearerAuth
query Parameters
NumeroOrdem
required
integer

Número da ordem de armazenagem

Responses

Response samples

Content type
application/json
{}

Originário do Armazem

Endpoints para cadastro, consulta e alteração de documento originário da ordem de armazenagem.

Cadastrar Originário (NF-e)

Cadastrar e vincular a ordem de armazenagem uma NF-e buscando pelo numero da ordem

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

Listagem de ordens de armazenagem

Responses

Request samples

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

Response samples

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

Cadastrar Originário(NF-e) por número de pedido

Cadastrar e vincular a ordem de armazenagem uma NF-e buscando a ordem pelo numero do pedido

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

Listagem de ordens de armazenagem

Responses

Request samples

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

Response samples

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

Anexos do Armazem

Endpoints para cadastro, consulta e alteração de anexos de pedidos.

Cadastrar anexos

Cadastrar anexos ao processo, como etiquetas que serão vinculadas às ordens de armazenagem, ou documentos auxiliares como NFs, boletos, entre outros, que serão associados ao documento originário do processo.

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

Listagem de ordens de armazenagem

Responses

Request samples

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

Response samples

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

Envios do Armazem ao cliente

Endpoints em que a TPL envia dados para o Web service do cliente.

Gerar token - servidor cliente

URL:
A URL deste método deverá ser passada pelo cliente para a equipe de projetos da TPL.

HTTP: BearerAuth
BASIC, enviamos no cabeçalho da requisição o usuário e a senha passados pelo cliente.

Authorizations:
BearerAuth
query Parameters
usuario
required
string

login do usuário, o nome do parâmetro pode mudar de acordo com o servidor do cliente.

senha
required
string

senha de acesso, o nome do parâmetro pode mudar de acordo com o servidor do cliente.

Responses

Response samples

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

Envia a situação das ordens de armazenagem.

Envia situação atual da ordem de armazenagem no momento em que a ordem muda de situação.

Authorizations:
BearerAuth

Responses

Response samples

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

Envia dados de carregamentos encerrados.

Envia ao cliente dados de carregamentos encerrados.

Authorizations:
BearerAuth

Responses

Response samples

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

Indicador do Armazem

Endpoints de consultas mais elaboradas que podem ser utilizadas para o desenvolvimento de indicadores.

Consultar Quantidade de ordens por status

Retorna a quantidade de ordens de armazenagem por status.

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

Listagem de ordens de armazenagem

Responses

Request samples

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

Response samples

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

Consultar lista de ordens por status

Retorna lista de ordens por status.

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

Listagem de ordens de armazenagem

Responses

Request samples

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

Response samples

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

Ocorrência do Frete Embarcador

Endpoints para consulta de ocorrências em processos do frete embarcador.

Consultar Ocorrências

Retorna todas as ocorrências da uma NFe buscando pela chave da NFe.

Authorizations:
BearerAuth
query Parameters
NFe
required
integer

Chave da NFe

Responses

Response samples

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

Cotação de Transporte

Endpoints para consulta de cotações de transporte.

Cotação de Frete

Retorna a cotação de frete da TPL.

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

Listagem de cotação de frete

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "HANDLE": "string",
  • "PRAZOENTREGA": "string",
  • "TABELA": "string",
  • "VALORTOTAL": "string"
}