Pular para o conteúdo principal

Documentação da API

POST /get_sales_order_by_id

Resumo

Este endpoint retorna um único pedido de venda com base no seu token (ID público).


Descrição

Utilize este endpoint para obter os detalhes completos de um pedido de venda específico, a partir do seu token (id_token) armazenado no sistema.


Requisição

Body da Requisição

ParâmetroTipoObrigatórioDescriçãoExemplo
access_tokenstringSimToken de autenticação do usuário.b31643fc-a45f-448c-99ee-736a547f6989
unit_tokenstringSimToken identificador da unidade.e6988e9e-b0c1-410c-ae08-aed7c64ac71f
tokenstringSimToken do pedido de venda (campo id_token).d3e9f2b7-54ce-4d96-b729-51e4af6b9c10

Exemplo de Requisição

curl -X POST 'https://portal.fipli.pro/api/v1/get_sales_order_by_id' -H 'Content-Type: application/json' -d '{
"access_token": "b31643fc-a45f-448c-99ee-736a547f6989",
"unit_token": "e6988e9e-b0c1-410c-ae08-aed7c64ac71f",
"token": "d3e9f2b7-54ce-4d96-b729-51e4af6b9c10"
}'

Resposta

200 OK

{
"success": true,
"data": {
"token": "d3e9f2b7-54ce-4d96-b729-51e4af6b9c10",
"code_orders": "PV-2024-0001",
"description": "Venda de serviço de consultoria",
"value": 3500.00,
"quantity": 1,
"created_date": "02/09/2024 12:07",
"project_token": "baf65ec0-8335-42c1-8899-6de18e2b9bc6",
"contact_token": "3aeb0f0c-2b94-4ec7-bc3d-e1d7f6e8ac11",
"stock_item_token": "a1b2c3d4-5678-4b3c-9de0-000011112222",
"id_token_category": "cat-1234-5678-90ab-cdef12345678",
"active": true,
"nf": true,
"nf_status": "emitida",
"charge_status": "PAID"
}
}

Erros Comuns

StatusMensagemDescrição
400"Missing id parameter"O parâmetro token não foi enviado.
403"Invalid data"Autenticação inválida.
500"Erro desconhecido"Erro interno ao buscar o pedido.