{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/entregasexpressas.com.br" } ], "info": { "name": "Documenta\u00e7\u00e3o da API do Entregas Expressas", "_postman_id": "7f1b8a8a-b792-4662-8c9e-e80dd2d876ba", "description": "Esta documenta\u00e7\u00e3o detalha os endpoints dispon\u00edveis na API do Entregas Expressas para integra\u00e7\u00e3o do seu sistema com o Entregas Expressas da Dono do App.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Pedidos", "description": "\nEndpoints para gerenciar pedidos de entrega.", "item": [ { "name": "Calcular Valor", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orders\/calcular", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orders\/calcular" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tipo_veiculo_id\":1,\"categoria_id\":3,\"endereco_coleta\":{\"endereco\":\"Rua teste, 123 - Teste, S\u00e3o Paulo - SP, 00000-000\",\"latitude\":-23.570914,\"longitude\":-46.645079,\"nome\":\"Jo\u00e3o\",\"telefone\":\"(11) 99999-9923\"},\"enderecos_entrega\":[{\"endereco\":\"Rua teste, 33 - Teste 2, S\u00e3o Paulo - SP, 00000-000\",\"latitude\":-23.585292,\"longitude\":-46.655723,\"nome\":\"Maria\",\"telefone\":\"(11) 12131-9923\"}],\"cliente_id\":3,\"dimensoes_pacote\":{\"peso\":15,\"largura\":15,\"altura\":15,\"comprimento\":15},\"retorno_necessario\":true,\"prova_entrega_necessaria\":false}" }, "description": "Antes de enviar o pedido, voc\u00ea pode verificar o valor enviando os dados do pedido e recebendo de volta a dist\u00e2ncia e valor final." }, "response": [ { "header": [], "code": 200, "body": "{\n \"preco\": 9.09,\n \"distancia\": 5.92,\n \"precoDescricao\": \"R$ 9,09\",\n \"distanciaDescricao\": \"5.92 km\"\n}\n", "name": "" } ] }, { "name": "Listar Pedidos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orders", "query": [ { "key": "page", "value": "1", "description": "N\u00famero da p\u00e1gina (padr\u00e3o: 1).", "disabled": false }, { "key": "limit", "value": "50", "description": "Itens por p\u00e1gina (m\u00e1x: 100, padr\u00e3o: 50).", "disabled": false }, { "key": "id", "value": "", "description": "Filtrar por ID do pedido.", "disabled": true }, { "key": "external_id", "value": "", "description": "Filtrar por ID externo do pedido.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/orders?page=1&limit=50&id=&external_id=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lista os pedidos paginados. Tamb\u00e9m \u00e9 poss\u00edvel buscar pedidos espec\u00edficos por `id` ou `external_id`." }, "response": [ { "header": [], "code": 200, "body": "{\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 127,\n \"uuid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"central_id\": 1,\n \"external_id\": \"AShb23\",\n \"user_id\": 3,\n \"started_at\": \"2025-01-15 10:30:00\",\n \"pickup_location\": \"Rua teste, 123 - Teste, S\u00e3o Paulo - SP, 00000-000\",\n \"pickup_location_data\": {\n \"endereco\": \"Rua teste, 123 - Teste, S\u00e3o Paulo - SP, 00000-000\",\n \"latitude\": -23.570914,\n \"longitude\": -46.645079,\n \"nome\": \"Jo\u00e3o\",\n \"telefone\": \"(11) 99999-9923\",\n \"external_id\": \"125\"\n },\n \"delivery_locations_data\": [\n {\n \"endereco\": \"Rua teste, 33 - Teste 2, S\u00e3o Paulo - SP, 00000-000\",\n \"latitude\": -23.585292,\n \"longitude\": -46.655723,\n \"nome\": \"Maria\",\n \"telefone\": \"(11) 12131-9923\",\n \"external_id\": \"1500\",\n \"delivered\": false,\n \"evidence\": null\n }\n ],\n \"need_return_to_pickup_location\": false,\n \"need_delivery_proof\": false,\n \"distance\": 5.92,\n \"return_distance\": 0,\n \"total_value\": 9.09,\n \"customer_observation\": null,\n \"valor_pedidos\": null,\n \"offline_payment_method_id\": null,\n \"pagamento_faturado\": false,\n \"payment_gateway\": null,\n \"gateway_method\": null,\n \"payment_code\": null,\n \"payment_base64\": null,\n \"payment_expiration_date\": null,\n \"payment_url\": null,\n \"payment_status\": null,\n \"order_status\": \"accepted\",\n \"order_status_date\": \"2025-01-15T10:30:00.000000Z\",\n \"status_observation\": null,\n \"category_id\": 3,\n \"vehicle_type_id\": 1,\n \"height\": 15,\n \"length\": 15,\n \"width\": 15,\n \"weight\": 15,\n \"created_at\": \"2025-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2025-01-15T10:35:00.000000Z\",\n \"accepted_at\": \"2025-01-15T10:35:00.000000Z\",\n \"arrived_pickup_location_at\": null,\n \"arrived_limit_date\": null,\n \"picked_up_at\": null,\n \"finished_at\": null,\n \"collect_limit_date\": null,\n \"pickup_code\": \"1234\",\n \"status\": \"Aceito\",\n \"courier\": \"Entregador Jo\u00e3o\",\n \"courier_data\": {\n \"id\": 17,\n \"name\": \"Entregador Jo\u00e3o\",\n \"location\": {\n \"latitude\": -23.56501282480426,\n \"longitude\": -46.652052565889385\n }\n },\n \"category\": {\n \"id\": 3,\n \"name\": \"Documentos\"\n },\n \"vehicle_type\": {\n \"id\": 1,\n \"name\": \"Moto\"\n },\n \"user\": {\n \"id\": 3,\n \"name\": \"cliente\",\n \"email\": \"cliente@entregasexpressas.com\",\n \"external_id\": null\n },\n \"tracking_url\": \"https:\/\/entregasexpressas.com.br\/tracking\/a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n }\n ],\n \"first_page_url\": \"https:\/\/entregasexpressas.com.br\/api\/v1\/orders?page=1\",\n \"from\": 1,\n \"last_page\": 77,\n \"last_page_url\": \"https:\/\/entregasexpressas.com.br\/api\/v1\/orders?page=77\",\n \"limit\": 50,\n \"next_page_url\": \"https:\/\/entregasexpressas.com.br\/api\/v1\/orders?page=2\",\n \"path\": \"https:\/\/entregasexpressas.com.br\/api\/v1\/orders\",\n \"prev_page_url\": null,\n \"to\": 50,\n \"total\": 3814\n}\n", "name": "" } ] }, { "name": "Novo Pedido", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orders", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orders" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tipo_veiculo_id\":1,\"categoria_id\":3,\"endereco_coleta\":{\"endereco\":\"Rua teste, 123 - Teste, S\u00e3o Paulo - SP, 00000-000\",\"latitude\":-23.570914,\"longitude\":-46.645079,\"nome\":\"Jo\u00e3o\",\"telefone\":\"(11) 99999-9923\",\"external_id\":\"1552\"},\"enderecos_entrega\":[{\"endereco\":\"Rua teste, 33 - Teste 2, S\u00e3o Paulo - SP, 00000-000\",\"latitude\":-23.585292,\"longitude\":-46.655723,\"nome\":\"Maria\",\"telefone\":\"(11) 12131-9923\",\"external_id\":\"123\",\"order_display_id\":\"PED-001\"}],\"cliente_id\":3,\"cliente\":{\"nome\":\"Jo\u00e3o Silva\",\"email\":\"joao@exemplo.com\",\"telefone\":\"(11) 99999-9923\",\"senha\":\"senha123\"},\"external_id\":\"AS@&ahb23\",\"dimensoes_pacote\":{\"peso\":15,\"largura\":15,\"altura\":15,\"comprimento\":15},\"retorno_necessario\":true,\"prova_entrega_necessaria\":false,\"metodo_pagamento\":\"faturado\",\"status_inicial\":\"pending\"}" }, "description": "Cria um novo pedido de entrega. Os endere\u00e7os de coleta e entrega devem conter latitude e longitude, ou o endere\u00e7o textual para geocodifica\u00e7\u00e3o autom\u00e1tica." }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 127,\n \"uuid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"central_id\": 1,\n \"external_id\": \"AShb23\",\n \"user_id\": 3,\n \"started_at\": \"2025-01-15 10:30:00\",\n \"pickup_location\": \"Rua teste, 123 - Teste, S\u00e3o Paulo - SP, 00000-000\",\n \"pickup_location_data\": {\n \"endereco\": \"Rua teste, 123 - Teste, S\u00e3o Paulo - SP, 00000-000\",\n \"latitude\": -23.570914,\n \"longitude\": -46.645079,\n \"nome\": \"Jo\u00e3o\",\n \"telefone\": \"(11) 99999-9923\",\n \"external_id\": \"125\"\n },\n \"delivery_locations_data\": [\n {\n \"endereco\": \"Rua teste, 33 - Teste 2, S\u00e3o Paulo - SP, 00000-000\",\n \"latitude\": -23.585292,\n \"longitude\": -46.655723,\n \"nome\": \"Maria\",\n \"telefone\": \"(11) 12131-9923\",\n \"external_id\": \"1500\",\n \"delivered\": false,\n \"evidence\": null\n }\n ],\n \"need_return_to_pickup_location\": false,\n \"need_delivery_proof\": false,\n \"distance\": 5.92,\n \"return_distance\": 0,\n \"total_value\": 9.09,\n \"customer_observation\": null,\n \"valor_pedidos\": null,\n \"offline_payment_method_id\": null,\n \"pagamento_faturado\": false,\n \"payment_gateway\": null,\n \"gateway_method\": null,\n \"payment_code\": null,\n \"payment_base64\": null,\n \"payment_expiration_date\": null,\n \"payment_url\": null,\n \"payment_status\": null,\n \"order_status\": \"accepted\",\n \"order_status_date\": \"2025-01-15T10:30:00.000000Z\",\n \"status_observation\": null,\n \"category_id\": 3,\n \"vehicle_type_id\": 1,\n \"height\": 15,\n \"length\": 15,\n \"width\": 15,\n \"weight\": 15,\n \"created_at\": \"2025-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2025-01-15T10:35:00.000000Z\",\n \"accepted_at\": \"2025-01-15T10:35:00.000000Z\",\n \"arrived_pickup_location_at\": null,\n \"arrived_limit_date\": null,\n \"picked_up_at\": null,\n \"finished_at\": null,\n \"collect_limit_date\": null,\n \"pickup_code\": \"1234\",\n \"status\": \"Aceito\",\n \"courier\": \"Entregador Jo\u00e3o\",\n \"courier_data\": {\n \"id\": 17,\n \"name\": \"Entregador Jo\u00e3o\",\n \"location\": {\n \"latitude\": -23.56501282480426,\n \"longitude\": -46.652052565889385\n }\n },\n \"category\": {\n \"id\": 3,\n \"name\": \"Documentos\"\n },\n \"vehicle_type\": {\n \"id\": 1,\n \"name\": \"Moto\"\n },\n \"user\": {\n \"id\": 3,\n \"name\": \"cliente\",\n \"email\": \"cliente@entregasexpressas.com\",\n \"external_id\": null\n },\n \"tracking_url\": \"https:\/\/entregasexpressas.com.br\/tracking\/a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}\n", "name": "" } ] }, { "name": "Obter Pedido", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orders\/:order", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orders\/:order", "variable": [ { "id": "order", "key": "order", "value": "127", "description": "ID do Pedido." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Busque os dados de um pedido espec\u00edfico pelo seu ID." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 127,\n \"uuid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"central_id\": 1,\n \"external_id\": \"AShb23\",\n \"user_id\": 3,\n \"started_at\": \"2025-01-15 10:30:00\",\n \"pickup_location\": \"Rua teste, 123 - Teste, S\u00e3o Paulo - SP, 00000-000\",\n \"pickup_location_data\": {\n \"endereco\": \"Rua teste, 123 - Teste, S\u00e3o Paulo - SP, 00000-000\",\n \"latitude\": -23.570914,\n \"longitude\": -46.645079,\n \"nome\": \"Jo\u00e3o\",\n \"telefone\": \"(11) 99999-9923\",\n \"external_id\": \"125\"\n },\n \"delivery_locations_data\": [\n {\n \"endereco\": \"Rua teste, 33 - Teste 2, S\u00e3o Paulo - SP, 00000-000\",\n \"latitude\": -23.585292,\n \"longitude\": -46.655723,\n \"nome\": \"Maria\",\n \"telefone\": \"(11) 12131-9923\",\n \"external_id\": \"1500\",\n \"delivered\": false,\n \"evidence\": null\n }\n ],\n \"need_return_to_pickup_location\": false,\n \"need_delivery_proof\": false,\n \"distance\": 5.92,\n \"return_distance\": 0,\n \"total_value\": 9.09,\n \"customer_observation\": null,\n \"valor_pedidos\": null,\n \"offline_payment_method_id\": null,\n \"pagamento_faturado\": false,\n \"payment_gateway\": null,\n \"gateway_method\": null,\n \"payment_code\": null,\n \"payment_base64\": null,\n \"payment_expiration_date\": null,\n \"payment_url\": null,\n \"payment_status\": null,\n \"order_status\": \"accepted\",\n \"order_status_date\": \"2025-01-15T10:30:00.000000Z\",\n \"status_observation\": null,\n \"category_id\": 3,\n \"vehicle_type_id\": 1,\n \"height\": 15,\n \"length\": 15,\n \"width\": 15,\n \"weight\": 15,\n \"created_at\": \"2025-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2025-01-15T10:35:00.000000Z\",\n \"accepted_at\": \"2025-01-15T10:35:00.000000Z\",\n \"arrived_pickup_location_at\": null,\n \"arrived_limit_date\": null,\n \"picked_up_at\": null,\n \"finished_at\": null,\n \"collect_limit_date\": null,\n \"pickup_code\": \"1234\",\n \"status\": \"Aceito\",\n \"courier\": \"Entregador Jo\u00e3o\",\n \"courier_data\": {\n \"id\": 17,\n \"name\": \"Entregador Jo\u00e3o\",\n \"location\": {\n \"latitude\": -23.56501282480426,\n \"longitude\": -46.652052565889385\n }\n },\n \"category\": {\n \"id\": 3,\n \"name\": \"Documentos\"\n },\n \"vehicle_type\": {\n \"id\": 1,\n \"name\": \"Moto\"\n },\n \"user\": {\n \"id\": 3,\n \"name\": \"cliente\",\n \"email\": \"cliente@entregasexpressas.com\",\n \"external_id\": null\n },\n \"tracking_url\": \"https:\/\/entregasexpressas.com.br\/tracking\/a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\"mensagem\": \"Pedido n\u00e3o encontrado\"}", "name": "" } ] }, { "name": "Cancelar Pedido", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orders\/:order", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orders\/:order", "variable": [ { "id": "order", "key": "order", "value": "127", "description": "ID do Pedido." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Cancele um pedido. Dispon\u00edvel **apenas para pedidos que ainda n\u00e3o foram aceitos** (status: `pending`, `waiting`, `scheduled` ou `preparing`)." }, "response": [ { "header": [], "code": 200, "body": "{\"mensagem\": \"Pedido cancelado\"}", "name": "" }, { "header": [], "code": 400, "body": "{\"mensagem\": \"O pedido n\u00e3o pode ser cancelado\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"mensagem\": \"Pedido n\u00e3o encontrado\"}", "name": "" } ] } ] }, { "name": "Tipos de Ve\u00edculos", "description": "\nEndpoints para consultar os tipos de ve\u00edculos e suas categorias dispon\u00edveis.", "item": [ { "name": "Listar Categorias do Tipo de Ve\u00edculo", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tipos-veiculos\/:id\/categorias", "query": [ { "key": "nome", "value": "", "description": "Filtrar pelo nome da categoria.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/tipos-veiculos\/:id\/categorias?nome=", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "ID do Tipo de Ve\u00edculo." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lista as categorias de um Tipo de Ve\u00edculo, sendo poss\u00edvel filtrar pelo nome enviando o texto de busca no par\u00e2metro `nome`." }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 1,\n \"nome\": \"Alimentos\",\n \"has_media\": false,\n \"media\": []\n },\n {\n \"id\": 2,\n \"nome\": \"Documentos\",\n \"has_media\": false,\n \"media\": []\n },\n {\n \"id\": 3,\n \"nome\": \"Eletr\u00f4nicos\",\n \"has_media\": true,\n \"media\": []\n }\n]\n", "name": "" }, { "header": [], "code": 404, "body": "{\"message\": \"Tipo de ve\u00edculo n\u00e3o encontrado\"}", "name": "" } ] }, { "name": "Listar Tipos de Ve\u00edculos", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/tipos-veiculos", "query": [ { "key": "nome", "value": "", "description": "Filtrar pelo nome do tipo de ve\u00edculo.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/tipos-veiculos?nome=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lista os Tipos de Ve\u00edculos dispon\u00edveis, sendo poss\u00edvel filtrar pelo nome enviando o texto de busca no par\u00e2metro `nome`." }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 1,\n \"nome\": \"Moto\",\n \"peso_e_dimensoes\": true,\n \"limitar_peso_e_dimensoes\": true,\n \"altura_maxima\": 50,\n \"largura_maxima\": 50,\n \"comprimento_maximo\": 50,\n \"peso_maximo\": 30,\n \"has_media\": true,\n \"media\": []\n },\n {\n \"id\": 2,\n \"nome\": \"Carro\",\n \"peso_e_dimensoes\": false,\n \"limitar_peso_e_dimensoes\": false,\n \"altura_maxima\": null,\n \"largura_maxima\": null,\n \"comprimento_maximo\": null,\n \"peso_maximo\": null,\n \"has_media\": true,\n \"media\": []\n }\n]\n", "name": "" } ] } ] }, { "name": "Usu\u00e1rios", "description": "\nEndpoints para gerenciar usu\u00e1rios (clientes) do sistema.", "item": [ { "name": "Buscar Usu\u00e1rios", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/usuarios", "query": [ { "key": "email", "value": "cliente%40entregasexpressas.com", "description": "Filtrar por e-mail do usu\u00e1rio.", "disabled": false }, { "key": "external_id", "value": "", "description": "Filtrar por ID externo do usu\u00e1rio.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/usuarios?email=cliente%40entregasexpressas.com&external_id=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"email\":\"gbailey@example.net\"}" }, "description": "Busque cadastros de usu\u00e1rios atrav\u00e9s do email ou id externo. Se nenhum filtro for informado, retorna todos os usu\u00e1rios." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": [\n {\n \"id\": 3,\n \"nome\": \"cliente\",\n \"email\": \"cliente@entregasexpressas.com\",\n \"telefone\": \"(11) 99999-9923\",\n \"external_id\": \"12516\",\n \"faturamento\": true,\n \"saldo\": 0,\n \"has_media\": false,\n \"media\": [],\n \"data_criacao\": \"2024-01-15 10:30:00\"\n }\n ]\n}\n", "name": "" } ] }, { "name": "Cadastrar Usu\u00e1rio", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/usuarios", "query": [], "raw": "{{baseUrl}}\/api\/v1\/usuarios" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"nome\":\"Novo Usu\u00e1rio\",\"email\":\"novousuario@entregasexpressas.com\",\"senha\":\"0346nlkasd\",\"telefone\":\"(11) 12532-1234\",\"external_id\":\"12516\"}" }, "description": "Cadastra um novo usu\u00e1rio (cliente) no sistema." }, "response": [ { "header": [], "code": 201, "body": "{\n \"data\": {\n \"id\": 3,\n \"nome\": \"cliente\",\n \"email\": \"cliente@entregasexpressas.com\",\n \"telefone\": \"(11) 99999-9923\",\n \"external_id\": \"12516\",\n \"faturamento\": true,\n \"saldo\": 0,\n \"has_media\": false,\n \"media\": [],\n \"data_criacao\": \"2024-01-15 10:30:00\"\n }\n}\n", "name": "" }, { "header": [], "code": 400, "body": "{\n \"mensagem\": \"Erro de valida\u00e7\u00e3o\",\n \"errors\": {\"email\": [\"O email informado est\u00e1 em uso\"]}\n}", "name": "" } ] }, { "name": "Editar Usu\u00e1rio", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/usuarios\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/usuarios\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the usuario." }, { "id": "usuario", "key": "usuario", "value": "3", "description": "ID do Usu\u00e1rio." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"nome\":\"Novo Nome\",\"telefone\":\"(11) 99999-8888\",\"external_id\":\"11111\",\"senha\":\"NovaSenha123\"}" }, "description": "Atualiza os dados de um usu\u00e1rio existente. Apenas os campos enviados ser\u00e3o atualizados." }, "response": [ { "header": [], "code": 200, "body": "{\n \"data\": {\n \"id\": 3,\n \"nome\": \"cliente\",\n \"email\": \"cliente@entregasexpressas.com\",\n \"telefone\": \"(11) 99999-9923\",\n \"external_id\": \"12516\",\n \"faturamento\": true,\n \"saldo\": 0,\n \"has_media\": false,\n \"media\": [],\n \"data_criacao\": \"2024-01-15 10:30:00\"\n }\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\"mensagem\": \"Usu\u00e1rio n\u00e3o encontrado\"}", "name": "" } ] } ] }, { "name": "URLs de Webhook", "description": "\nEndpoints para gerenciar as URLs de Webhook que receber\u00e3o atualiza\u00e7\u00f5es sobre os pedidos.\n\nAo cadastrar uma URL de Webhook, **todos os pedidos e todas as mudan\u00e7as de status ser\u00e3o enviadas para a URL configurada**, enviando todos os detalhes do pedido no ato da altera\u00e7\u00e3o via requisi\u00e7\u00e3o **POST**.\n\n### Cabe\u00e7alhos enviados\n\n| Cabe\u00e7alho | Valor |\n| --- | --- |\n| Content-Type | application\/json |\n| Accept | application\/json |\n| webhook-security | C\u00f3digo de seguran\u00e7a configurado (se definido) |\n\n### Status do Pedido (order_status)\n\n| Status | Descri\u00e7\u00e3o |\n| --- | --- |\n| `waiting` | Pedido com pagamento online aguardando pagamento (s\u00f3 acontece em pedidos com pagamento online) |\n| `scheduled` | Pedido agendado |\n| `preparing` | Pedido em preparo (s\u00f3 dispon\u00edvel se o status em preparo estiver ativo) |\n| `pending` | Pedido buscando entregador |\n| `accepted` | Pedido aceito por um entregador |\n| `arrived_pickup_location` | Entregador no local de coleta |\n| `collected` | Pedido coletado |\n| `delivered` | Pedido com todos os endere\u00e7os entregues fazendo retorno ao local de coleta (s\u00f3 em pedidos com retorno) |\n| `completed` | Pedido finalizado com sucesso |\n| `cancelled` | Pedido cancelado |\n\n---\n\n**Falha na entrega (`delivery_failed`)**\n\nO campo `need_return_to_pickup_location` indica se o pedido ter\u00e1 retorno para a loja.\n\n- Caso alguma das entregas tenha um problema, o objeto desse endere\u00e7o dentro de `delivery_locations_data` ser\u00e1 retornado com `delivery_failed = true`.\n- Se o pedido n\u00e3o tinha retorno para a loja (`need_return_to_pickup_location = false`) e a configura\u00e7\u00e3o de retorno em caso de falha estiver ativa, o campo `need_return_to_pickup_location` ser\u00e1 alterado automaticamente para `true`.\n\n---\n\n**Exemplo de payload recebido na sua URL**\n\n```json\n{\n \"event\": \"ORDER_UPDATED\",\n \"order\": {\n \"id\": 1234,\n \"uuid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"central_id\": null,\n \"external_id\": null,\n \"user_id\": 10,\n \"started_at\": \"2025-01-15 10:30:00\",\n \"pickup_location\": \"Rua Exemplo, 100 - Centro\",\n \"pickup_location_data\": {\n \"latitude\": -23.5505,\n \"longitude\": -46.6333,\n \"endereco\": \"Rua Exemplo, 100 - Centro\"\n },\n \"delivery_locations_data\": [\n {\n \"id\": \"abc123\",\n \"latitude\": -23.5605,\n \"longitude\": -46.6433,\n \"endereco\": \"Rua Destino, 200 - Bairro\",\n \"rua\": \"Rua Destino\",\n \"numero\": \"200\",\n \"bairro\": \"Bairro\",\n \"cidade\": \"Sao Paulo\",\n \"estado\": \"SP\",\n \"complemento\": \"Apto 101\",\n \"cep\": \"01001-000\",\n \"nome\": \"Joao Silva\",\n \"telefone\": \"(11) 99999-9999\",\n \"external_id\": \"123\",\n \"order_display_id\": \"PED-001\",\n \"delivered\": false,\n \"delivered_date\": null,\n \"delivery_failed\": false,\n \"evidence\": {\n \"photo\": \"https:\/\/exemplo.com\/foto.jpg\",\n \"signature\": null,\n \"document\": \"123.456.789-00\",\n \"name\": \"Joao Silva\"\n }\n }\n ],\n \"need_return_to_pickup_location\": false,\n \"need_delivery_proof\": false,\n \"distance\": 5.2,\n \"return_distance\": 0,\n \"total_value\": 15.50,\n \"pickup_delay_tax\": 0,\n \"repassado\": false,\n \"customer_observation\": \"Pedido via integra\u00e7\u00e3o\",\n \"valor_pedidos\": 89.90,\n \"offline_payment_method_id\": null,\n \"pagamento_faturado\": false,\n \"payment_gateway\": \"carteira_digital\",\n \"gateway_method\": null,\n \"payment_code\": null,\n \"payment_base64\": null,\n \"payment_expiration_date\": null,\n \"payment_url\": null,\n \"payment_status\": \"paid\",\n \"order_status\": \"accepted\",\n \"type\": \"delivery\",\n \"status_observation\": null,\n \"category_id\": 1,\n \"vehicle_type_id\": 1,\n \"height\": null,\n \"length\": null,\n \"width\": null,\n \"weight\": null,\n \"created_at\": \"2025-01-15T10:30:00.000000Z\",\n \"updated_at\": \"2025-01-15T10:35:00.000000Z\",\n \"deleted_at\": null,\n \"accepted_at\": \"2025-01-15T10:35:00.000000Z\",\n \"arrived_pickup_location_at\": null,\n \"arrived_limit_date\": null,\n \"picked_up_at\": null,\n \"delivered_at_data\": null,\n \"finished_at\": null,\n \"collect_limit_date\": null,\n \"pickup_code\": \"1234\",\n \"fatura_id\": null,\n \"status\": \"Aceito\",\n \"courier\": \"Carlos Entregador\",\n \"courier_data\": {\n \"id\": 5,\n \"name\": \"Carlos Entregador\",\n \"location\": {\n \"latitude\": -23.5510,\n \"longitude\": -46.6340\n }\n },\n \"category\": {\"id\": 1, \"name\": \"Alimenta\u00e7\u00e3o\"},\n \"vehicle_type\": {\"id\": 1, \"name\": \"Moto\"},\n \"user\": {\n \"id\": 10,\n \"email\": \"restaurante@exemplo.com\",\n \"name\": \"Restaurante Exemplo\",\n \"external_id\": null\n },\n \"tracking_url\": \"https:\/\/entregasexpressas.com.br\/tracking\/a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n }\n}\n```", "item": [ { "name": "Listar Webhooks", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lista todas as URLs de Webhook cadastradas." }, "response": [ { "header": [], "code": 200, "body": "[\n {\n \"id\": 1,\n \"url\": \"https:\/\/meusite.com\/webhook\",\n \"codigo_seguranca\": \"Aas#asdg@fngasd\"\n },\n {\n \"id\": 2,\n \"url\": \"https:\/\/meusite.com\/webhook2\",\n \"codigo_seguranca\": null\n }\n]\n", "name": "" } ] }, { "name": "Cadastrar Webhook", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"https:\\\/\\\/entregas-expressas.teste\",\"codigo_seguranca\":\"Aas#asdg@fngasd\"}" }, "description": "Cadastra uma nova URL de Webhook para receber atualiza\u00e7\u00f5es de pedidos." }, "response": [ { "header": [], "code": 201, "body": "{\n \"id\": 1,\n \"url\": \"https:\/\/meusite.com\/webhook\",\n \"codigo_seguranca\": \"Aas#asdg@fngasd\"\n}\n", "name": "" }, { "header": [], "code": 400, "body": "{\n \"mensagem\": \"Erro de valida\u00e7\u00e3o\",\n \"errors\": {\"url\": [\"Uma URL de webhook com este endere\u00e7o j\u00e1 existe\"]}\n}", "name": "" } ] }, { "name": "Obter Webhook", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the webhook." }, { "id": "webhook", "key": "webhook", "value": "1", "description": "ID da URL de Webhook." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Busque os dados de uma URL de Webhook espec\u00edfica." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": 1,\n \"url\": \"https:\/\/meusite.com\/webhook\",\n \"codigo_seguranca\": \"Aas#asdg@fngasd\"\n}\n", "name": "" }, { "header": [], "code": 404, "body": "{\"mensagem\": \"Webhook n\u00e3o encontrado\"}", "name": "" } ] }, { "name": "Remover Webhook", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/webhooks\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/webhooks\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the webhook." }, { "id": "webhook", "key": "webhook", "value": "1", "description": "ID da URL de Webhook." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Remove uma URL de Webhook." }, "response": [ { "header": [], "code": 200, "body": "{\"mensagem\": \"Webhook removido com sucesso\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"mensagem\": \"Webhook n\u00e3o encontrado\"}", "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "Authorization", "type": "string" } ] } }