logo
API docs by Redocly

API de Integração PlatinumLog (1.0.0)

Download OpenAPI specification:Download

Segurança - Platinum

HTTP: BasicAuth
A autenticação inicial com as APIs REST da PlatinumLog deve ser realizada por uma requisição GET utilizando Basic Auth. Para autenticar, você deve informar o usuário e senha fornecidos pelo cliente.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
A autenticação com as APIs REST da PlatinumLog deve ser realizadas por token utilizando Bearer Token. Para autenticar, você deve utilizar o token recebido na rota de Login e adicioná-lo no header da requisição. O header de autenticação deve ser enviado para todos os endpoints disponíveis na API.

HTTP Authorization Scheme:
bearer

Gerar novo token - Platinum

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

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

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

Cadastrar novo produto

Cadastrar um novo 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
{
  • "Retorno": [
    ]
}

Alterar cadastro de produto

Altera os dados do produto informado.

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

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

Ordem de armazenagem

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

Cadastrar ordem de armazenagem

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 (ListaOrdem)

Listagem de ordens de armazenagem

Responses

Request samples

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

Response samples

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

Alterar ordem de armazenagem

Alterar uma ordem de armazenagem com base nos dados informados

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

Listagem de ordens de armazenagem

Responses

Request samples

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

Response samples

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

Cancelar ordem de armazenagem

Cancela a ordem de armazenagem

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 de armazenagem

Libera ordem para inicio de separação.

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

Listagem de ordens de armazenagem

Responses

Request samples

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

Response samples

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

Adicionar item em ordem de armazenagem de entrada

Cria um item na ordem de armazenagem de entrada com base nos dados informados. Esta opção é específica para ordens de entrada

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

Listagem de itens da ordem de armazenagem

Responses

Request samples

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

Response samples

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

Adicionar programação em ordem de armazenagem de saída

Cria um programação na ordem de armazenagem de saída com base nos dados informados. Esta opção é específica para ordens de saída

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

Listagem de Programaçao da ordem de armazenagem

Responses

Request samples

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

Response samples

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

Cadastrar NF-e em ordem de armazenagem por número de ordem

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

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

Listagem de produtos

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "Mensagem": "Arquivo recebido"
}

Cadastrar NF-e em ordem de armazenagem 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 (ListaOriginarioporpedido)

Listagem de produtos

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "Mensagem": "Arquivo recebido"
}

Consultar ordem de armazenagem 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
{
  • "Id": "string",
  • "Numero": "string",
  • "NumeroPedido": "string",
  • "NumeroControle": "string",
  • "Filial": "string",
  • "Cliente": "string",
  • "Situacao": "Encerrada",
  • "DataStatus": "01/05/2023 11:23:00",
  • "Entrada": {
    },
  • "programacao": [
    ],
  • "Expedicao": [
    ],
  • "Separacao": [
    ],
  • "XMLRetorno": [
    ],
  • "ProdutividadeSeparacao": [
    ],
  • "ProdutividadeEmbalagem": [
    ]
}

Consultar todas as ordem de armazenagem que estão em operação

Retorna todas as informações de todas as ordem de armazenagem que estão em operação

Authorizations:
BearerAuth

Responses

Response samples

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

Consultar todas as ordens de armazenagem de saída que estão Ag NF-e para transporte.

Retorna todas as informações de todas as 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 todas as ordem de armazenagem que estão 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 situação atual e a data de execução das etapas da ordem de armazenagem 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
{
  • "Etapa": "CONFERÊNCIA",
  • "DataConclusao": "02/07/2020 17:41:11"
}

Embarcador

Endpoints para consulta de 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
{
  • "Retorno": [
    ]
}

Transporte

Endpoints para consulta de processos do transporte e cotações de transporte.

Cotação de Frete

Retorna a cotação de frete da Platinum Log.

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
{
  • "Cotacao": 16863154,
  • "ValorFrete": 120.55,
  • "CnpjTransportadora": 0,
  • "NomeTransportadora": "Platinum Log",
  • "PrazoEntrega": 10,
  • "Modalidade": "Rodoviário"
}

Envios ao servidor do cliente

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

Gerar novo token - servidor cliente

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
{
  • "Id": "string",
  • "Numero": "string",
  • "NumeroPedido": "string",
  • "NumeroControle": "string",
  • "Filial": "string",
  • "Cliente": "string",
  • "Situacao": "Encerrada",
  • "DataStatus": "01/05/2023 11:23:00",
  • "programacao": [
    ],
  • "Expedicao": [
    ],
  • "Separacao": [
    ],
  • "XMLRetorno": [
    ],
  • "ProdutividadeSeparacao": [
    ],
  • "ProdutividadeEmbalagem": [
    ]
}