Pular para o conteúdo principal

Documentação da API

POST /get_purchase_order_by_id

Resumo

Este endpoint retorna um pedido de compra.

Descrição

Utilize este endpoint para obter um pedido de compra de uma unidade específica.


Requisição

Body da Requisição

O corpo da requisição deve ser um objeto JSON. Os parâmetros abaixo são aceitos:

ParâmetroTipoObrigatórioDescriçãoExemplo
access_tokenstringSimToken de autenticação do usuário.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
unit_tokenstringSimToken da unidade onde os pedidos serão buscados.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
id_tokenstringSimID do pedido de compra.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Exemplo de Requisição

curl -X POST 'https://portal.fipli.pro/api/v1/get_purchase_order_by_id' \
-H 'Content-Type: application/json' \
-d '{
"access_token": "<access_token>",
"unit_token": "<unit_token>",
"id_token": "<id_token>"
}'

Resposta

200 OK

{
"success": true,
"data": {
"id": "<id>",
"idUnit": "<idUnit>",
"issueDate": "<issueDate>",
"totalValue": "<totalValue>",
"freightValue": "<freightValue>",
"supplierCnpj": "<supplierCnpj>",
"supplierName": "<supplierName>",
"accessKey": "<accessKey>",
"xmlFileName": "<xmlFileName>",
"createdDate": "<createdDate>",
"active": "<active>",
"items": "<items>"
}
}

4xx e 5xx Erros

{
"success": false,
"error": "Invalid data"
}

Erros Comuns

StatusMensagemDescrição
403"Invalid data"Falha na autenticação (access_token ou unit_token inválidos).
500"Erro desconhecido"Erro interno ao listar os pedidos.