Page Comparison

...

• description- Descrição do pedido.

• status - Objeto com dados sobre o status do pedido.

  • value - Valores
    possíveis: ["PREPARING", "ON_THE_WAY", "DONE", "NOT_DONE", "CANCELLED"].

  • label - Texto personalizado para ser exibido na página de rastreio.

• destination - Objeto contendo os dados do local de destino.

  • road - (Opcional) Nome da rua do local de destino.

  • number - (Opcional) Número do local de destino.

  • city - (Opcional) Cidade do local de destino.

  • zipCode - (Opcional) CEP do local de destino.

  • state - (Opcional) Objeto contento dados do local de destino.

    • code - Sigla do estado.

    • name - Nome do estado.

  • mainLocation - Objeto contento as coordenadas do local de destino.

    • lat - Coordenada da latitude em graus decimais.

    • lon - Coordenada da latitude em graus decimais.

  theme - Tema que será usado para a página de rastreamento

  • • .

Exemplo de requisição com parâmetros obrigatórios

{
    "description": "Product Test",
    "status": {
        "value": "PREPARING",
        "label": "Estamos preparando o seu pedido"
    },
    "destination": {
        "road": "R. Menina Rosana",
        "number": "70",
        "city": "Itajaí",
        "zipCode": "88304250",
        "state": {
            "code": "SC",
            "name": "Santa Catarina"
        },
        "mainLocation": {
            "lat": -22.72725697031394,
            "lon": -47.636846753567944
        }
    },
    "theme": "DEFAULT"
}

Parâmetros opcionais

• companyName - Nome da empresa.

• number - Número do pedido.

• theme - Tema que será usado para personalizar a página de rastreamento. Caso não seja informado, o tema white-label será aplicado.

• estimatedArrival - Estimativa de entrega. Formato “yyyy-MM-ddTHH:mm:ss”. Exemplo: "2022-11-22T10:00:00"

• totalValue - Objeto contendo o valor total do pedido.

  • value - Número inteiro representando o valor total do pedido.

  • currency - Tipo de moeda. Para Real, utilize BRL

• driver - Objeto contendo os dados do motorista

  • name - (Opcional) Nome do motorista

  • image- (Opcional) URL da foto do motorista para ser exibida no site

  • currentLocation - Objeto com as coordenadas iniciais do motorista.

    • lat - Coordenada da latitude em graus decimais.

    • lon - Coordenada da longitude em graus decimais.

...