Oficina · Referência
Ordens de Serviço (legado)
OS do sistema anterior (somente consulta histórica).
GET
/v1/ordens_servico_legadoListarGET/v1/ordens_servico_legado/{id}DetalharGET/v1/ordens_servico_legado/exportarExportar em loteO objeto ordens de serviço (legado)
| Campo | Tipo | Descrição | |
|---|---|---|---|
id | inteiro | Identificador | ordenar |
vehicle_id | inteiro | ID do veículo | filtro |
plate | texto | Placa | filtro |
mechanic_id | inteiro | mechanic id | |
status | texto (enum) | SituaçãoABERTA CONCLUIDA CANCELADA | filtro |
opened_at | data-hora | opened at | ordenar |
released_at | data-hora | released at | |
km_current | inteiro | km current | |
diagnosis | texto | diagnosis | |
obs | texto | obs | |
parts_total | decimal (string) | parts total | |
services_total | decimal (string) | services total | |
total | decimal (string) | total | |
created_at | data-hora | Criado em | |
updated_at | data-hora | Atualizado em | |
log_origem | texto | Origem do registro (sistema novo/antigo) |
Exemplo do objeto200 OK
{
"id": 1024,
"vehicle_id": 512,
"plate": "ABC1D23",
"mechanic_id": 512,
"status": "ABERTA",
"opened_at": "2026-10-08T14:30:00-03:00",
"released_at": "2026-10-08T14:30:00-03:00",
"km_current": 45210,
"diagnosis": "Pastilhas gastas",
"obs": "texto",
"parts_total": "450.00",
"services_total": "450.00",
"total": "450.00",
"created_at": "2026-10-08T14:30:00-03:00",
"updated_at": "2026-10-08T14:30:00-03:00",
"log_origem": "sistema_novo"
}GET Listar
Retorna os registros paginados, do mais recente para o mais antigo (padrão). Requer Ler.
Parâmetros de consulta
| Parâmetro | Tipo | Descrição |
|---|---|---|
pagina | inteiro | Página (padrão 1) |
por_pagina | inteiro | 1 a 200 (padrão 50) |
ordenar | texto | Aceita: id, opened_at — prefixo - para decrescente |
campos | texto | Lista de campos do objeto, separados por vírgula |
status | texto (enum) | Situação — valor exato ou lista separada por vírgulaABERTA CONCLUIDA CANCELADA |
vehicle_id | inteiro | ID do veículo — valor exato ou lista separada por vírgula |
plate | texto | Placa — valor exato ou lista separada por vírgula |
criado_desde / criado_ate | data | Período de criação |
atualizado_desde | data-hora | Criados ou alterados desde (pela coluna de atualização) |
RequisiçãoTestar ▸
curl -X GET "https://apimapogos.sixinformatica.com/v1/ordens_servico_legado?por_pagina=20" \
-H "Authorization: Bearer $MAPOGOS_API_KEY"<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/ordens_servico_legado?por_pagina=20');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($resposta['sucesso']) {
print_r($resposta['dados']);
} else {
echo $resposta['erro']['mensagem'];
}const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/ordens_servico_legado?por_pagina=20', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
},
});
const json = await resposta.json();
if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);import os, uuid, requests
resposta = requests.request(
"GET",
"https://apimapogos.sixinformatica.com/v1/ordens_servico_legado?por_pagina=20",
headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])Resposta200 OK
{
"sucesso": true,
"dados": [
{
"id": 1024,
"vehicle_id": 512,
"plate": "ABC1D23",
"mechanic_id": 512,
"status": "ABERTA",
"opened_at": "2026-10-08T14:30:00-03:00",
"released_at": "2026-10-08T14:30:00-03:00",
"km_current": 45210
}
],
"meta": {
"total": 1,
"pagina": 1,
"por_pagina": 20,
"paginas": 1
},
"request_id": "req_0f1e2d3c4b5a69788796"
}GET Detalhar
Retorna um registro pelo id. Requer Ler.
| Erro | Quando |
|---|---|
404 nao_encontrado | Não existe ou está fora das carteiras da chave |
403 permissao_negada | Sem Ler no módulo (ou numa relação pedida) |
RequisiçãoTestar ▸
curl -X GET "https://apimapogos.sixinformatica.com/v1/ordens_servico_legado/1024" \
-H "Authorization: Bearer $MAPOGOS_API_KEY"<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/ordens_servico_legado/1024');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($resposta['sucesso']) {
print_r($resposta['dados']);
} else {
echo $resposta['erro']['mensagem'];
}const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/ordens_servico_legado/1024', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
},
});
const json = await resposta.json();
if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);import os, uuid, requests
resposta = requests.request(
"GET",
"https://apimapogos.sixinformatica.com/v1/ordens_servico_legado/1024",
headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])Resposta200 OK
{
"sucesso": true,
"dados": {
"id": 1024,
"vehicle_id": 512,
"plate": "ABC1D23",
"mechanic_id": 512,
"status": "ABERTA",
"opened_at": "2026-10-08T14:30:00-03:00",
"released_at": "2026-10-08T14:30:00-03:00",
"km_current": 45210
},
"request_id": "req_1d2c3b4a5f6e7d8c9b0a"
}GET Exportar em lote
Até 1000 registros por chamada, paginando por cursor. Requer Ler e Exportar. Aceita os mesmos filtros da listagem e formato=csv. Detalhes no guia Exportação em lote.
RequisiçãoTestar ▸
curl -X GET "https://apimapogos.sixinformatica.com/v1/ordens_servico_legado/exportar?limite=1000" \
-H "Authorization: Bearer $MAPOGOS_API_KEY"<?php
$ch = curl_init('https://apimapogos.sixinformatica.com/v1/ordens_servico_legado/exportar?limite=1000');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('MAPOGOS_API_KEY'),
],
]);
$resposta = json_decode(curl_exec($ch), true);
$http = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($resposta['sucesso']) {
print_r($resposta['dados']);
} else {
echo $resposta['erro']['mensagem'];
}const resposta = await fetch('https://apimapogos.sixinformatica.com/v1/ordens_servico_legado/exportar?limite=1000', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.MAPOGOS_API_KEY}`,
},
});
const json = await resposta.json();
if (json.sucesso) console.log(json.dados);
else console.error(json.erro.mensagem);import os, uuid, requests
resposta = requests.request(
"GET",
"https://apimapogos.sixinformatica.com/v1/ordens_servico_legado/exportar?limite=1000",
headers={"Authorization": f"Bearer {os.environ['MAPOGOS_API_KEY']}"},
timeout=30,
)
json = resposta.json()
print(json["dados"] if json["sucesso"] else json["erro"]["mensagem"])