Skip to main content
Um pedido (order) é criado a partir de um orçamento. Ao criar o pedido, o CGD envia automaticamente a solicitação para o fornecedor (tenant), que confirmará a disponibilidade e iniciará a operação.
Orçamento obrigatório. Não é possível criar um pedido sem um orçamento prévio. Todos os valores financeiros são derivados do orçamento — o parceiro não informa preços.Um orçamento com status converted não pode ser usado novamente.

Endpoints

MétodoEndpointDescrição
POST/ordersCriar pedido a partir de orçamento
GET/ordersListar pedidos
GET/orders/{id}Buscar pedido por ID

Criar pedido

Campos da requisição

CampoTipoObrigatórioDescrição
customer_idintegerSimID do cliente no CGD
quote_idintegerSimID do orçamento a ser convertido em pedido
curl -X POST https://gds.fretatech.com.br/api/partner/v1/orders \
  -H "Authorization: Bearer SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": 5,
    "quote_id": 76
  }'
Os valores financeiros (preço, margem, taxa de serviço) são herdados diretamente do orçamento, que por sua vez foi calculado a partir da busca de disponibilidade.

Erros possíveis na criação

HTTPMensagemCausa
422Este orçamento já foi convertido em pedidoO quote_id informado já gerou um pedido anteriormente

Resposta

{
  "success": true,
  "data": {
    "id": 120,
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "customer": {
      "id": 5,
      "uuid": "6039e108-f7ac-4b19-9a2c-bbf822d6de18",
      "name": "AC DA SILVA",
      "email": "email@email.com.br",
      "phone": null
    },
    "pricing": {
      "cost": 1610801,
      "central_commission_percentage": "10.00",
      "central_commission_value": 161080,
      "service_price": 1771881,
      "central_service_tax_percentage": "0.00",
      "central_service_tax_value": 0,
      "subtotal_amount": 1799881,
      "markup_percentage": "0.00",
      "markup_amount": 0,
      "total_amount": 2195855,
      "service_fee_percentage": "7.00",
      "service_fee_value": 125992,
      "margin_percentage": "15.00",
      "margin_value": 269982
    },
    "status": "A Faturar",
    "sync_status": "pending",
    "items": [
      {
        "id": 215,
        "tenant_id": "fb4a8f4c-617a-45f8-a2e9-0aebbc5cd0f5",
        "vehicle_id": 28,
        "vehicle_name": "Ônibus Semi-Leito 46 Lugares Motor Traseiro - Bela Vista",
        "type": "onewaytrip",
        "service_price": 1771881,
        "total_amount": 2195855,
        "origin_address": {
          "address": "Peruíbe, SP, Brasil",
          "city": "Peruíbe",
          "lat": "-24.3182917",
          "lng": "-46.9940600"
        },
        "destination_address": {
          "address": "Aparecida, SP, Brasil",
          "city": "Aparecida",
          "lat": "-22.8469289",
          "lng": "-45.2316803"
        },
        "start_date": "2026-03-09T07:00:00-03:00",
        "end_date": "2026-03-09T07:00:00-03:00",
        "status": "Programado"
      }
    ],
    "created_at": "2026-03-08T17:45:00-03:00",
    "updated_at": "2026-03-08T17:45:00-03:00"
  },
  "message": "Pedido criado com sucesso"
}

Campos da resposta

CampoTipoDescrição
idintegerID do pedido
uuidstringUUID do pedido
statusstringStatus atual do pedido (veja abaixo)
pricing.costintegerCusto bruto do fornecedor em centavos
pricing.central_commission_valueintegerTaxa da Central em centavos
pricing.service_priceintegerPreço com taxa Central incluída, em centavos
pricing.subtotal_amountintegerSubtotal (service_price + despesas motorista) em centavos
pricing.service_fee_valueintegerTaxa de serviço CGD em centavos
pricing.margin_valueintegerMargem do parceiro em centavos
pricing.total_amountintegerTotal final em centavos
itemsarrayItens do pedido (um por trecho da viagem)

Fluxo de status do pedido

A Faturar → Faturado → Confirmado (Pago) → Em Execução → Concluído

                                      Cancelado (qualquer etapa)
StatusDescrição
A FaturarPedido criado, aguardando faturamento
FaturadoFatura emitida
Confirmado (Pago)Pagamento confirmado
Em ExecuçãoServiço em execução
ConcluídoServiço concluído com sucesso
CanceladoPedido cancelado
As mudanças de status são notificadas via webhook (order.status_changed). Veja Webhooks.

Listar pedidos

curl -X GET "https://gds.fretatech.com.br/api/partner/v1/orders?status=Confirmado&customer_id=5&date_from=2026-04-01" \
  -H "Authorization: Bearer SUA_API_KEY"

Parâmetros de filtro

ParâmetroTipoDescrição
statusstringFiltra por status do pedido
customer_idintegerFiltra por cliente
date_fromstringData inicial de criação (YYYY-MM-DD)
date_tostringData final de criação (YYYY-MM-DD)

Buscar pedido por ID

curl -X GET https://gds.fretatech.com.br/api/partner/v1/orders/120 \
  -H "Authorization: Bearer SUA_API_KEY"
Retorna o objeto completo do pedido, incluindo o array items com os serviços vinculados. Use os IDs dos itens para consultar dados operacionais via endpoint de Serviços.