API Reference

Location Schema

Objeto de location é um conjunto organizado de informações que descreve detalhadamente os atributos físicos, geográficos e contextuais de um determinado local.

CampoTipoDescriçãoObrigatório
codeStringCódigo do clienteSim
nameStringNome do clienteSim
typeStringTipo do serviçoSim
service_typeStringAção a ser realizada no cliente.Sim
loadsArray de NumbersCapacidadesNão
location.address.routeStringLogradouroSim
location.address.geocodeObjectObjeto de GeolocalizaçãoNão
location.address.geocode.latFloatLatitudeSim
location.address.geocode.lngFloatLongitudeSim
location.address.geocode.sourceStringOrigem da informaçãoNão
geocode_statusStringStatus da localizaçãoNão
constraintsObjetoRestrições Operacionais do clienteNão
constraints.skillsArray de StringsArray de Strings contendo característicasNão
constraints.regionStringRegião/Cluster do ClienteNão
constraints.window_daily.start_timeStringData de início de atendimento do ClienteNão
constraints.window_daily.end_timeStringData de término de atendimento ClienteNão

Este é o objeto necessário para ser utilizado na criação de uma nova Routing. Abaixo segue um exemplo de uso:

{
    "code": "000000000000",
    "name": "Cliente 01",
    "type": "service",
    "service_type": "delivery",
    "loads": [],
    "address": {
        "route": "Rua marilia, 40 - Jardim Paulista, São Paulo - SP, 01420-020, Brazil",
        "geocode": {
            "lat": -23.5653804,
            "lng": -46.6543860,
            "source": "google.api.key"
        }
    },
    "geocode_status": "found",
    "constraints": {
        "skills":[],
        "region":"",
        "window_daily": [
            {
                "start_time": "1970-02-01T11:00:00.000Z",
                "end_time": "1970-02-01T23:00:00.000Z"
            }
        ]
    }
}