Pular para o conteúdo principal

Documentação da API

POST /set_purchase_order_active​

Resumo​

Este endpoint ativa ou desativa um pedido de compra.

Descrição​

Utilize este endpoint para ativar ou desativar 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_token_purchase_orderstringSimID do pedido de compra.aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
activeboolSimSe está ativo ou não.true

Exemplo de Requisição​

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

Resposta​

200 OK​

{
    "success": true,
    "data": {
        "ok": true,
        "message": "<message>",
        "data": { 
            "id": "<id>", 
            "active": "<active>"
        },
    }
}

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.