DOCUMENTAÇÃO CORPORATIVA
Webhook Validar
- Ivan Saavedra (Unlicensed)
- Larissa Oliveira (Unlicensed)
POST URL
Headers
Content-Type | application/json |
Authorization | Api-Key |
Importante:
Se no objeto de Resposta dos campos solicitados no Retorno da Localização houver uma resposta de um campo do tipo MultiSelect (6), os valores serão delimitados por “ ; “ .
Request Body application/json
Schema:
Campo | Tipo | Descrição | Obrigatório |
IdOrdemPagamento | Long | Código de Identificação da Ordem de Pagamento. | Sim |
IdentificadorProduto | String | Identificador do Produto que será vendido. | Sim |
ValorUnitario | Decimal | Valor da Unidade do Produto que foi Vendido. | Sim |
Resposta | Array Of Object <Resposta> | Objeto de Resposta dos campos solicitados no Retorno da Localização. | Sim |
Resposta:
Campo | Tipo | Descrição |
Chave | String | Chave do Campo solicitado na Etapa de Localização. |
Valor | String | Valor preenchido para Validação. |
JSON:
{
"IdOrdemPagamento": 128,
"IdentificadorProduto": "DSS10",
"ValorUnitario": 5.000,
"Campos": [
{
"Chave": "23",
"Descricao": "1000"
},
{
"Chave": "24",
"Descricao": "ZZZ1234"
}
]
}
Response Body application/json
Campo | Tipo | Descrição | Obrigatório |
IdOrdemPagamento | Long | Código de Identificação da Ordem de Pagamento. | Sim |
Mensagem | String | Mensagem indicando resultado da operação. | Não |
Detalhes | Object <Detalhe> | Dados da Ordem de Pagamento a serem apresentados para o Usuário. | Sim |
<Detalhes>:
Campo | Tipo | Descrição | Obrigatório |
Solicitante | String | Nome do Solicitante responsável pela Ordem de Pagamento. | Sim |
DescricaoProduto | String | Descrição do Produto liberado para essa Ordem de Pagamento, quando houver. | Sim |
QuantidadeIndefinida | Boolean | Indica se a Ordem de Pagamento não possui uma Quantidade Previamente Definida. Nesse caso, a venda será realizada respeitando a Quantidade Definida pelo Representante do Solicitante (Comprador), no momento da Compra. | Sim |
QuantidadeLiberada | Decimal | Quantidade liberada para compra. (Disponibilizado apenas para Ordens de Pagamento que não sejam Tanque Cheio) | Não |
JSON:
{
"IdOrdemPagamento": "128",
"Mensagem": "Ordem de Abastecimento Validada com Sucesso!",
"Detalhes": {
"Solicitante": "IS Transportes",
"DescricaoProduto": "Diesel",
"QuantidadeIndefinida": true,
"QuantidadeLiberada": 0.000
}
}