API Reference

Depot Schema

Objeto de Depot, armazena informações vitais relacionadas a um depósito de logística.

CampoTipoDescriçãoObrigatório
codeStringCódigo do depósitoSim
nameStringNome do depósitoSim
typeStringTipo do depósitoSim
constraintsObjetoRestrições Operacionais do depósitoNão
constraints.window_dailyArray de ObjetosJanelas de operação do depósitoNão
constraints.window_daily[0].start_timeStringData de início da operação do depósitoNão
constraints.window_daily[0].end_timeStringData de término da operação do depósitoNão
address.idStringID de identificação do depósito na plataforma RouteasySim
address.geocodeObjectObjeto de GeolocalizaçãoNão
address.geocode.latFloatLatitudeNão
address.geocode.lngFloatLongitudeNão
address.countryStringPaísNão
address.street_numberStringNúmeroSim
address.neighborhoodStringBairroSim
address.cityStringCidadeSim
address.stateStringEstadoSim
address.postal_codeStringCEP do depósitoNão
address.additional_infoStringComplementoNão
address.routeStringLogradouroSim
address.formatted_addressStringEndereço completoNão

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

{
  "code": "00",
  "name": "ROUT01",
  "type": "depot",
  "constraints": {
    "window_daily": [
      {
        "start_time": "1970-01-01T09:00:00.000Z",
        "end_time": "1970-01-01T22:00:00.000Z"
      }
    ]
  },
  "address": {
    "geocode": {
      "lat": -23.5653804,
      "lng": -46.6543860,
    },
    "_id": "63ff6f3d2b04d33736f48861",
    "country": "Brasil",
    "route": "Rua Marilia",
    "street_number": "40",
    "neighborhood": "Jardim Paulista",
    "city": "São Paulo",
    "state": "São Paulo",
    "postal_code": "07111-080",
    "formatted_address": "R. Marilia, 40 - Jardim Paulista, São Paulo - SP, 000000-000, Brasil"
  }
}