Waypoint

Um waypoint representa uma parada do pedido. Todo pedido terá no mínimo 2 waypoints, e no máximo 9.

É possível definir um waypoint de duas formas:

  • Por CEP e número do local de parada.
  • Por nome do logradouro, categoria e número do local de parada.

Uma representação de waypoints tem os seguintes campos obrigatórios:

  • by: Definição se o waypoint é representado por cep ou address.

  • query: hash com os dados da parada, as informações dependend do campo by.
    • cep: No caso do by representando um cep a query contem um cep e um number.
    • address No caso do by representando um address a query contem um category, name e number.
    • instructions: Instruções ao motorista (Ex: “Pegar pacote com Carla”).

Um exemplo de waypoint por cep:

{
    "by": "cep",
    "query": {
        "cep": "05135400",
        "number": 77,
        "instructions": "Pegar o envelope com a Dona Aracy"
    }
}

Um exemplo de waypoint por endereço:

{
    "by": "address",
    "query": {
        "category": "Rua",
        "name": "Adalberto Melo Lucena",
        "number": 77,
        "instructions": "Pegar o envelope com a Dona Aracy"
    }
}

Estas são as menores representações para um waypoint, opcionalmente é possível definir as seguintes opções:

  • complement: Indica o complemento ao endereço definido na query.

  • referees: Uma lista de `hash`es com os dados de pessoas com as quais se deseja compartilhar o waypoint. Cada valor desta lista contém as seguintes informações:
    • mobile: Número do celular do contato
    • email: Email do contato

Um exemplo de waypoint com complemento e compartilhamento:

{
    "by": "cep",
    "query": {
        "cep": "05135400",
        "number": "77",
        "address_complement": "2o andar"
        "instructions": "Pegar o envelope com Dona Aracy",
        "referees": [
            {
                "email": "aracy@exemplo.com",
                "mobile": "11999999999"
            }
        ]
    },
}