{ "info": { "name": "Modelo M — Entregas Expressas", "description": "Coleção gerada a partir dos endpoints publicados. Preencha as variáveis `base_url` e `api_key` antes de usar.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "base_url", "value": "https://entregasexpressas.com.br", "type": "string" }, { "key": "api_key", "value": "", "type": "string" } ], "item": [ { "name": "Solicitação", "description": "Abrir, consultar, acompanhar e cancelar entregas.", "item": [ { "name": "solicitacao", "request": { "method": "GET", "description": "Lista de solicitações, ou uma só quando `id` é informado — nesse caso os demais filtros são ignorados.\n\nA janela entre as datas é de no máximo 30 dias.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/solicitacao?id=&status_solicitacao=&tipo_pagamento=&cliente_id=&empresa_id=&taxista_id=&data_hora_solicitacao_min=&data_hora_solicitacao_max=&pagina=&limite=", "host": [ "{{base_url}}" ], "path": [ "api", "m", "solicitacao" ], "query": [ { "key": "id", "value": "", "description": "Identificador da solicitação. Informado, ignora os outros filtros.", "disabled": true }, { "key": "status_solicitacao", "value": "", "description": "Letra da situação: D, A, E, F, C, N, L ou R.", "disabled": true }, { "key": "tipo_pagamento", "value": "", "description": "F, R, X, C, D, B, P ou H. As letras de pagamento na entrega (D, B, C, P, H) retornam todas as solicitações pagas na entrega, sem separar por forma.", "disabled": true }, { "key": "cliente_id", "value": "", "description": "Quem abriu a solicitação (o usuário da equipe).", "disabled": true }, { "key": "empresa_id", "value": "", "description": "O contratante dono da solicitação.", "disabled": true }, { "key": "taxista_id", "value": "", "description": "Entregador que atendeu.", "disabled": true }, { "key": "data_hora_solicitacao_min", "value": "", "description": "Início da janela (ISO-8601). Padrão: 30 dias atrás.", "disabled": true }, { "key": "data_hora_solicitacao_max", "value": "", "description": "Fim da janela (ISO-8601). Padrão: agora.", "disabled": true }, { "key": "pagina", "value": "", "description": "Página, começando em 1.", "disabled": true }, { "key": "limite", "value": "", "description": "Itens por página. Máximo 100.", "disabled": true } ] } } }, { "name": "solicitacaoStatus", "request": { "method": "GET", "description": "Só a situação atual, para quem faz consulta frequente e não precisa do restante dos dados.\n\nA chegada do entregador ao local **não** é uma situação própria aqui: ela é uma etapa de `A` (aceita), e só o webhook a distingue.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/solicitacaoStatus?id_mch=", "host": [ "{{base_url}}" ], "path": [ "api", "m", "solicitacaoStatus" ], "query": [ { "key": "id_mch", "value": "", "description": "Identificador da solicitação.", "disabled": true } ] } } }, { "name": "posicaoCondutor", "request": { "method": "GET", "description": "Latitude e longitude do entregador no momento.\n\nDevolve as coordenadas nulas — e não erro — quando a solicitação ainda não foi aceita, já terminou, ou quando a central desabilitou a exibição da localização.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/posicaoCondutor?id_mch=", "host": [ "{{base_url}}" ], "path": [ "api", "m", "posicaoCondutor" ], "query": [ { "key": "id_mch", "value": "", "description": "Identificador da solicitação.", "disabled": true } ] } } }, { "name": "reciboEntrega", "request": { "method": "GET", "description": "Dados para montar o recibo.\n\nExige a solicitação **finalizada**. Enquanto o entregador estiver fazendo o retorno ao local de coleta, a consulta de situação responde `E` (em andamento) e o recibo ainda não é emitido.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/reciboEntrega?id_mch=", "host": [ "{{base_url}}" ], "path": [ "api", "m", "reciboEntrega" ], "query": [ { "key": "id_mch", "value": "", "description": "Identificador da solicitação.", "disabled": true } ] } } }, { "name": "consultarProgramada", "request": { "method": "GET", "description": "Solicitações programadas aguardando disparo.\n\n**`id_mch_programada` e `id_mch` são o mesmo número**: aqui a programada é a própria solicitação aguardando o horário, e não um registro separado. A listagem sem identificador mostra apenas as que ainda não dispararam.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/consultarProgramada?id_mch_programada=&pagina=&limite=", "host": [ "{{base_url}}" ], "path": [ "api", "m", "consultarProgramada" ], "query": [ { "key": "id_mch_programada", "value": "", "description": "Identificador da programada. Sem ele, lista as pendentes.", "disabled": true }, { "key": "pagina", "value": "", "description": "Página, começando em 1.", "disabled": true }, { "key": "limite", "value": "", "description": "Itens por página. Máximo 100.", "disabled": true } ] } } }, { "name": "obterLinkRastreio", "request": { "method": "GET", "description": "Link de acompanhamento e código de confirmação de cada entrega.\n\n**O link é da solicitação, não da entrega**: a resposta traz uma linha por parada, com o `parada_id` correto, mas o mesmo link em todas.\n\nSe a solicitação tiver sido agrupada, a resposta é o erro `97`, com o identificador da solicitação que absorveu as entregas.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/obterLinkRastreio/:id", "host": [ "{{base_url}}" ], "path": [ "api", "m", "obterLinkRastreio", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Identificador" } ] } } }, { "name": "estimarSolicitacao", "request": { "method": "GET", "description": "Valor, distância e tempo estimados, sem criar nada.\n\nOs pontos vão **achatados na query**, com sufixo `_partida` e `_desejado`. Informando só o endereço escrito, ele é geocodificado; informando `lat_partida`/`lng_partida` (e os de destino), a geocodificação é pulada.\n\n`empresa_id` é obrigatório quando a chave é da central — é o contratante que define a tabela de preço. Com chave de empresa, ele é o dono da chave.\n\nTambém aceita o corpo no formato do `abrirSolicitacao`, para quem preferir reaproveitar o payload que já monta.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/estimarSolicitacao?empresa_id=&endereco_partida=&bairro_partida=&cidade_partida=&estado_partida=&lat_partida=&lng_partida=&endereco_desejado=&bairro_desejado=&cidade_desejado=&estado_desejado=&lat_desejado=&lng_desejado=&com_retorno=&categoria_id=&data=&hora=", "host": [ "{{base_url}}" ], "path": [ "api", "m", "estimarSolicitacao" ], "query": [ { "key": "empresa_id", "value": "", "description": "Contratante da estimativa. Obrigatório com chave da central.", "disabled": true }, { "key": "endereco_partida", "value": "", "description": "Logradouro e número da coleta.", "disabled": true }, { "key": "bairro_partida", "value": "", "description": "Bairro da coleta.", "disabled": true }, { "key": "cidade_partida", "value": "", "description": "Cidade da coleta.", "disabled": true }, { "key": "estado_partida", "value": "", "description": "UF da coleta.", "disabled": true }, { "key": "lat_partida", "value": "", "description": "Latitude da coleta. Informada, pula a geocodificação.", "disabled": true }, { "key": "lng_partida", "value": "", "description": "Longitude da coleta.", "disabled": true }, { "key": "endereco_desejado", "value": "", "description": "Logradouro e número do destino.", "disabled": true }, { "key": "bairro_desejado", "value": "", "description": "Bairro do destino.", "disabled": true }, { "key": "cidade_desejado", "value": "", "description": "Cidade do destino.", "disabled": true }, { "key": "estado_desejado", "value": "", "description": "UF do destino.", "disabled": true }, { "key": "lat_desejado", "value": "", "description": "Latitude do destino. Informada, pula a geocodificação.", "disabled": true }, { "key": "lng_desejado", "value": "", "description": "Longitude do destino.", "disabled": true }, { "key": "com_retorno", "value": "", "description": "Se a entrega tem retorno ao local de coleta (1 ou 0).", "disabled": true }, { "key": "categoria_id", "value": "", "description": "Tipo de serviço a estimar. Sem ele, a plataforma escolhe.", "disabled": true }, { "key": "data", "value": "", "description": "Data do disparo, `dd/mm/aaaa`, para estimar uma programada.", "disabled": true }, { "key": "hora", "value": "", "description": "Hora do disparo, `HH:MM:SS`.", "disabled": true } ] } } }, { "name": "abrirSolicitacao", "request": { "method": "POST", "description": "Abre uma solicitação de entrega.\n\nInformando `data` e `hora`, a solicitação nasce programada e é disparada no horário (`antecedencia`, em segundos, antecipa o disparo).\n\nPara direcionar a um entregador específico, envie o bloco `condutor` — ele é identificado por id (`I`), CPF (`C`), telefone (`T`) ou placa (`P`).\n\nFormas de pagamento fora de `F` (faturado) e `R` (carteira) são registradas na parada e informadas ao entregador, que é quem cobra na entrega.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/abrirSolicitacao", "host": [ "{{base_url}}" ], "path": [ "api", "m", "abrirSolicitacao" ] }, "body": { "mode": "raw", "raw": "{\n \"forma_pagamento\": \"F\",\n \"empresa_id\": 845,\n \"partida\": {\n \"endereco\": \"Rua Evandro Câmara, 717\",\n \"bairro\": \"Monte Carmelo\",\n \"cidade\": \"Montes Claros\",\n \"estado\": \"MG\",\n \"referencia\": \"Portão azul\",\n \"lat\": \"-16.7176723\",\n \"lng\": \"-43.8341584\"\n },\n \"paradas\": [\n {\n \"endereco_parada\": \"Aeroporto de Montes Claros\",\n \"bairro_parada\": \"Jaraguá\",\n \"cidade_parada\": \"Montes Claros\",\n \"estado_parada\": \"MG\",\n \"lat_parada\": \"-16.7049531\",\n \"lng_parada\": \"-43.8199862\",\n \"id_externo\": \"714\",\n \"nome_cliente_parada\": \"Ralph Wisozk\",\n \"telefone_cliente_parada\": \"(38) 99999-9999\",\n \"observacao_parada\": \"Entregar na portaria\",\n \"codigo_confirmacao\": \"9999\",\n \"valor_cobrar\": 104.18\n }\n ],\n \"retorno\": false\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "cancelar", "request": { "method": "POST", "description": "Cancela a solicitação.\n\n`motivo_id` é registrado na solicitação e fica visível para a central.\n\nSolicitação já finalizada, cancelada ou não atendida não pode ser cancelada.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/cancelar", "host": [ "{{base_url}}" ], "path": [ "api", "m", "cancelar" ] }, "body": { "mode": "raw", "raw": "{\n \"id_mch\": 1234,\n \"motivo_id\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "cancelarProgramada", "request": { "method": "POST", "description": "Cancela uma programada antes do disparo. Depois de disparada, use `cancelar`.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/cancelarProgramada", "host": [ "{{base_url}}" ], "path": [ "api", "m", "cancelarProgramada" ] }, "body": { "mode": "raw", "raw": "{\n \"id_mch_programada\": 1234\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "request", "request": { "method": "GET", "description": "Os mesmos dados de `solicitacao`, na convenção nova do protocolo: campos em inglês, objeto direto sem envelope e erro no formato `{\"error\": \"...\"}`.\n\nRepare que este endpoint usa o **outro endereço base** (`{base}/v1`).", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/v1/request/:id", "host": [ "{{base_url}}" ], "path": [ "api", "m", "v1", "request", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Identificador" } ] } } } ] }, { "name": "Empresa", "description": "Cadastro e saldo dos contratantes que lançam pedidos.", "item": [ { "name": "empresa", "request": { "method": "GET", "description": "Contratantes da central. Com uma credencial de empresa, devolve apenas o próprio cadastro.\n\nO endereço vem no campo `endereco`; bairro, cidade, UF, CEP e coordenadas retornam nulos porque não são armazenados separadamente.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/empresa?empresa_id=", "host": [ "{{base_url}}" ], "path": [ "api", "m", "empresa" ], "query": [ { "key": "empresa_id", "value": "", "description": "Identificador do contratante. Sem ele, lista todos.", "disabled": true } ] } } }, { "name": "listarAreasAtuacaoEmpresa", "request": { "method": "GET", "description": "Sempre devolve lista vazia: não há área de atuação por contratante nesta plataforma. O endpoint existe para não quebrar quem já o chama.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/listarAreasAtuacaoEmpresa", "host": [ "{{base_url}}" ], "path": [ "api", "m", "listarAreasAtuacaoEmpresa" ] } } }, { "name": "cadastrarEmpresa", "request": { "method": "POST", "description": "Cadastra um contratante.\n\n`tipos_pagamento` é a lista do que fica **permitido** — vazia significa todos. `categorias` são os tipos de serviço liberados, também com vazio significando todos.\n\n`area_atuacao_empresa_id` é aceito e ignorado: não há área de atuação por contratante.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/cadastrarEmpresa", "host": [ "{{base_url}}" ], "path": [ "api", "m", "cadastrarEmpresa" ] }, "body": { "mode": "raw", "raw": "{\n \"documento\": \"57.268.792/0001-05\",\n \"tipo_documento\": \"CNPJ\",\n \"numero_contrato\": \"104896\",\n \"razao_social\": \"Razão social da empresa\",\n \"nome_fantasia\": \"Nome da empresa\",\n \"endereco\": {\n \"logradouro\": \"Rua Dorval Porto\",\n \"complemento\": null,\n \"uf\": \"MG\",\n \"cidade\": \"Montes Claros\",\n \"bairro\": \"Centro\",\n \"cep\": \"39400-000\"\n },\n \"telefone\": {\n \"ddd\": \"38\",\n \"numero\": \"99999-8888\"\n },\n \"situacao_cadastral\": \"A\",\n \"categorias\": [],\n \"tipos_pagamento\": [\n \"F\",\n \"R\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "atualizarEmpresas", "request": { "method": "PUT", "description": "Aplica a mesma alteração a vários contratantes de uma vez.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/atualizarEmpresas", "host": [ "{{base_url}}" ], "path": [ "api", "m", "atualizarEmpresas" ] }, "body": { "mode": "raw", "raw": "{\n \"empresas\": [\n 1,\n 2\n ],\n \"status_empresa\": \"A\",\n \"tipos_pagamento\": [\n \"F\",\n \"R\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "atualizarEmpresa", "request": { "method": "PUT", "description": "Atualiza um contratante. Só `status_empresa`, `numero_contrato`, `categorias` e `tipos_pagamento` são alteráveis.\n\nAs situações `S` (suspenso) e `G` (aguardando ativação) têm o mesmo efeito — o contratante deixa de operar — e a leitura devolve `S` para as duas.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/atualizarEmpresa/:id", "host": [ "{{base_url}}" ], "path": [ "api", "m", "atualizarEmpresa", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Identificador" } ] }, "body": { "mode": "raw", "raw": "{\n \"status_empresa\": \"A\",\n \"numero_contrato\": 997102\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "saldoCreditosEmpresa", "request": { "method": "POST", "description": "Saldo da carteira do contratante. Com credencial de empresa, devolve sempre o próprio saldo, independentemente do bloco `empresa` enviado.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/saldoCreditosEmpresa", "host": [ "{{base_url}}" ], "path": [ "api", "m", "saldoCreditosEmpresa" ] }, "body": { "mode": "raw", "raw": "{\n \"empresa\": {\n \"tipo_identificacao\": \"I\",\n \"identificacao\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "recarregarCreditosEmpresa", "request": { "method": "POST", "description": "Credita saldo na carteira do contratante. Disponível apenas para a credencial da central.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/recarregarCreditosEmpresa", "host": [ "{{base_url}}" ], "path": [ "api", "m", "recarregarCreditosEmpresa" ] }, "body": { "mode": "raw", "raw": "{\n \"valor\": 50,\n \"observacao\": \"Crédito promocional\",\n \"empresa\": {\n \"tipo_identificacao\": \"I\",\n \"identificacao\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "sacarCreditosEmpresa", "request": { "method": "POST", "description": "Debita saldo da carteira do contratante. Não confere saldo — o valor pode ficar negativo, como no ajuste manual pelo painel.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/sacarCreditosEmpresa", "host": [ "{{base_url}}" ], "path": [ "api", "m", "sacarCreditosEmpresa" ] }, "body": { "mode": "raw", "raw": "{\n \"valor\": 50,\n \"observacao\": \"Ajuste\",\n \"empresa\": {\n \"tipo_identificacao\": \"I\",\n \"identificacao\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Condutor", "description": "Cadastro, documentos e saldo dos entregadores. Indisponível para credenciais de empresa.", "item": [ { "name": "condutor", "request": { "method": "GET", "description": "Entregadores da central.\n\nViatura, vínculo, número da CNH e observações internas são devolvidos exatamente como foram enviados — não são usados pela plataforma.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/condutor?id=&status_condutor=&telefone=&pagina=&limite=", "host": [ "{{base_url}}" ], "path": [ "api", "m", "condutor" ], "query": [ { "key": "id", "value": "", "description": "Identificador do entregador.", "disabled": true }, { "key": "status_condutor", "value": "", "description": "Filtra pela situação: A, I, S, E (em análise), R (rejeitado) ou D.", "disabled": true }, { "key": "telefone", "value": "", "description": "Filtra pelo telefone cadastrado do entregador.", "disabled": true }, { "key": "pagina", "value": "", "description": "Página, começando em 1.", "disabled": true }, { "key": "limite", "value": "", "description": "Itens por página. Máximo 200.", "disabled": true } ] } } }, { "name": "atualizarCondutores", "request": { "method": "PUT", "description": "Aplica a mesma situação a vários entregadores.\n\n`areas_bloqueio` é recusado: não existe vínculo de área por entregador nesta plataforma.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/atualizarCondutores", "host": [ "{{base_url}}" ], "path": [ "api", "m", "atualizarCondutores" ] }, "body": { "mode": "raw", "raw": "{\n \"condutores\": [\n 1,\n 2\n ],\n \"status_condutor\": \"A\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "atualizarCondutor", "request": { "method": "POST", "description": "Atualiza o entregador. **Só os atributos enviados são alterados.**\n\n`cor` é o código hexadecimal da cor do veículo.\n\n`status_condutor` aceita **A** (ativo), **I** (inativo) e **S** (suspenso). `E`, `F` e `R` descrevem a aprovação do cadastro, que tem fluxo próprio, e `D` (exclusão) não é feita por esta API — os quatro são recusados.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/atualizarCondutor/:id", "host": [ "{{base_url}}" ], "path": [ "api", "m", "atualizarCondutor", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Identificador" } ] }, "body": { "mode": "raw", "raw": "{\n \"nome\": \"Maurice DuBuque\",\n \"sexo\": \"M\",\n \"data_nascimento\": \"2001-01-01\",\n \"telefone\": \"(38) 99999-9999\",\n \"status_condutor\": \"A\",\n \"cpf\": \"999.999.999-99\",\n \"modelo\": \"Honda CG 160\",\n \"placa\": \"ABC1D23\",\n \"cor\": \"ff0000\",\n \"numero_viatura\": 841\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "obterDocumentosCadastroCondutor", "request": { "method": "POST", "description": "Documentos que o cadastro aceita, e se cada um já foi enviado.\n\nO valor de `tipo` é o que você devolve em `documentoCondutor`.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/obterDocumentosCadastroCondutor", "host": [ "{{base_url}}" ], "path": [ "api", "m", "obterDocumentosCadastroCondutor" ] }, "body": { "mode": "raw", "raw": "{\n \"condutor\": {\n \"tipo_identificacao\": \"I\",\n \"identificacao\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "obterDocumentosCondutor", "request": { "method": "POST", "description": "Somente os documentos já enviados, com a URL da imagem.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/obterDocumentosCondutor", "host": [ "{{base_url}}" ], "path": [ "api", "m", "obterDocumentosCondutor" ] }, "body": { "mode": "raw", "raw": "{\n \"condutor\": {\n \"tipo_identificacao\": \"I\",\n \"identificacao\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "documentoCondutor", "request": { "method": "POST", "description": "Envia ou substitui um documento. Requisição `multipart/form-data` com `tipo` e `foto`.\n\nUse `rosto` como tipo para a foto do rosto; os demais valores vêm de `obterDocumentosCadastroCondutor`.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/documentoCondutor/:id", "host": [ "{{base_url}}" ], "path": [ "api", "m", "documentoCondutor", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Identificador" } ] }, "body": { "mode": "formdata", "formdata": [ { "key": "tipo", "value": "selfie", "type": "text" }, { "key": "foto", "type": "file", "src": [] } ] } } }, { "name": "saldoCreditosCondutor", "request": { "method": "POST", "description": "Saldo da carteira do entregador.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/saldoCreditosCondutor", "host": [ "{{base_url}}" ], "path": [ "api", "m", "saldoCreditosCondutor" ] }, "body": { "mode": "raw", "raw": "{\n \"condutor\": {\n \"tipo_identificacao\": \"I\",\n \"identificacao\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "recarregarCreditosCondutor", "request": { "method": "POST", "description": "Credita saldo na carteira do entregador.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/recarregarCreditosCondutor", "host": [ "{{base_url}}" ], "path": [ "api", "m", "recarregarCreditosCondutor" ] }, "body": { "mode": "raw", "raw": "{\n \"valor\": 50,\n \"observacao\": \"Bônus\",\n \"condutor\": {\n \"tipo_identificacao\": \"I\",\n \"identificacao\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "sacarCreditosCondutor", "request": { "method": "POST", "description": "Debita saldo da carteira do entregador. Não confere saldo.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/sacarCreditosCondutor", "host": [ "{{base_url}}" ], "path": [ "api", "m", "sacarCreditosCondutor" ] }, "body": { "mode": "raw", "raw": "{\n \"valor\": 50,\n \"observacao\": \"Ajuste\",\n \"condutor\": {\n \"tipo_identificacao\": \"I\",\n \"identificacao\": 1\n }\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "vincularAreaPermissao", "request": { "method": "POST", "description": "**Sempre responde erro.** A área de atendimento aqui é avaliada pela posição do entregador no momento, não por um vínculo salvo — responder sucesso faria você acreditar que aplicou uma restrição que não existe.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/vincularAreaPermissao/:id", "host": [ "{{base_url}}" ], "path": [ "api", "m", "vincularAreaPermissao", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Identificador" } ] } } }, { "name": "desvincularAreaPermissao", "request": { "method": "POST", "description": "**Sempre responde erro**, pelo mesmo motivo de `vincularAreaPermissao`.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/desvincularAreaPermissao/:id", "host": [ "{{base_url}}" ], "path": [ "api", "m", "desvincularAreaPermissao", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Identificador" } ] } } } ] }, { "name": "Webhook", "description": "URLs que recebem os eventos de mudança de situação.", "item": [ { "name": "listarWebhook", "request": { "method": "GET", "description": "URLs cadastradas. Com credencial de empresa, apenas as dela.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/listarWebhook", "host": [ "{{base_url}}" ], "path": [ "api", "m", "listarWebhook" ] } } }, { "name": "cadastrarWebhook", "request": { "method": "POST", "description": "Cadastra a URL que receberá os eventos.\n\n`tipo` aceita apenas `status`; `posicao` é recusado enquanto não estiver disponível.\n\nOs eventos chegam a cada mudança de situação e a cada entrega confirmada. O corpo traz `event_id` para você descartar reenvios, e os cabeçalhos `Signature-V2` e `Signature` trazem o HMAC-SHA-512 do corpo assinado com a sua chave de API.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/cadastrarWebhook", "host": [ "{{base_url}}" ], "path": [ "api", "m", "cadastrarWebhook" ] }, "body": { "mode": "raw", "raw": "{\n \"tipo\": \"status\",\n \"url\": \"https://seu-sistema.com/webhook\",\n \"responsabilidade\": \"solicitante\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "atualizarWebhook", "request": { "method": "PUT", "description": "Troca a URL de um webhook já cadastrado.", "header": [ { "key": "api-key", "value": "{{api_key}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{base_url}}/api/m/atualizarWebhook/:id", "host": [ "{{base_url}}" ], "path": [ "api", "m", "atualizarWebhook", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Identificador" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"https://seu-sistema.com/webhook\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "deletarWebhook", "request": { "method": "DELETE", "description": "Remove o webhook. Os eventos param imediatamente.", "header": [ { "key": "api-key", "value": "{{api_key}}" } ], "url": { "raw": "{{base_url}}/api/m/deletarWebhook/:id", "host": [ "{{base_url}}" ], "path": [ "api", "m", "deletarWebhook", ":id" ], "variable": [ { "key": "id", "value": "", "description": "Identificador" } ] } } } ] } ] }