curl --request POST \
--url https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"ignorar_periodo_dedicado": false
}
'import requests
url = "https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar"
payload = { "ignorar_periodo_dedicado": False }
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({ignorar_periodo_dedicado: false})
};
fetch('https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ignorar_periodo_dedicado' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar"
payload := strings.NewReader("{\n \"ignorar_periodo_dedicado\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ignorar_periodo_dedicado\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ignorar_periodo_dedicado\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "A entrega programada será disparada a seguir."
}Despachar entrega programada
Antecipa para agora o disparo da entrega programada informada em {id}, com a mesma regra do Despachar agora da Gestão de Pedidos. A data e a hora da programada passam a ser as do momento da chamada, no horário local da central, e a estimativa é recalculada.
O endpoint não cria a entrega na hora. Ele responde 202 e a entrega é criada no ciclo seguinte do agendador, em até 1 minuto. Consulte o resultado em GET /entregas/programadas/{id}: a programada passa para a situação D (disparada). Se o agendador não conseguir criar a entrega, por exemplo por falha na pré-autorização do pagamento, a programada fica na situação X (erro) e não é disparada de novo.
Só é possível despachar a programada que está aguardando o disparo (situação A). Programada agrupada automaticamente ou em uso pela junção automática é recusada.
Quando a empresa da entrega está em um período com entregadores dedicados e nenhum deles está livre, a entrega fica restrita aos dedicados. Envie ignorar_periodo_dedicado como true para que ela possa ir também para entregadores de fora do período.
O gestor de empresa só encontra as programadas da própria empresa.
Para acessar este endpoint, o usuário autenticado deve ter a permissão API - Corrida/Entrega.
curl --request POST \
--url https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"ignorar_periodo_dedicado": false
}
'import requests
url = "https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar"
payload = { "ignorar_periodo_dedicado": False }
headers = {
"Authorization": "Basic <encoded-value>",
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Basic <encoded-value>',
'api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({ignorar_periodo_dedicado: false})
};
fetch('https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ignorar_periodo_dedicado' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar"
payload := strings.NewReader("{\n \"ignorar_periodo_dedicado\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar")
.header("Authorization", "Basic <encoded-value>")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ignorar_periodo_dedicado\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.taximachine.com.br/api/v2/integracao/entregas/programadas/{id}/despachar")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ignorar_periodo_dedicado\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "A entrega programada será disparada a seguir."
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Obrigatório. Sua chave API.
Path Parameters
ID da entrega programada
456
Body
Permite que a entrega vá para entregadores de fora do período dedicado da empresa quando nenhum entregador dedicado está livre. Equivale a confirmar Solicitar outros entregadores no painel. Sem período dedicado ativo, não tem efeito.
false
Response
Aceita. A entrega será criada no ciclo seguinte do agendador.
