API Reference

Listar

Descrição: Este endpoint recupera uma lista de origens registradas no sistema.


Descrição dos Campos de Resposta

CampoDescriçãoTipoExemplo
_idIdentificador único da origem.String"123abc456def789ghi101112"
addressObjeto com informações de endereço da origem.Objeto{...}
- geocodeCoordenadas geográficas (lat e lng).Objeto{...}
-- latLatitude do endereço.Float-22.912895
-- lngLongitude do endereço.Float-43.200710
- postal_codeCEP do endereço.String"20031-170"
- countryPaís da origem.String"Brazil"
- stateEstado da origem.String"Rio de Janeiro"
- cityCidade da origem.String"Rio de Janeiro"
- neighborhoodBairro da origem.String"Centro"
- routeNome da rua.String"Avenida Presidente Vargas"
- additional_infoInformações adicionais do endereço.String"Andar 5, Sala 502"
constraintsRestrições específicas da origem.Objeto{...}
- window_dailyJanela de horário de operação.Array[... ]
-- start_timeHora de início da operação diária.String (ISO)"2024-11-01T08:00:00.000Z"
-- end_timeHora de término da operação diária.String (ISO)"2024-11-01T18:00:00.000Z"
nameNome da origem.String"Depot Central RJ"
typeTipo de instalação (e.g., depot).String"depot"
transfer_depotIndica se a origem é de transferência.Booleantrue
codeCódigo de identificação da origem.String"DPT-RJ001"
memberIdentificador do membro associado.String"abcdef1234567890abcdef123"
siteIdentificador do site associado.String"abcdef1234567890abcdef124"
companyIdentificador da empresa associada.String"abcdef1234567890abcdef125"
pre_route_timeTempo antes da rota.Integer15
post_route_timeTempo após a rota.Integer10
contactInformações de contato da origem.Objeto{...}
- emailE-mail de contato.String"[email protected]"
- phoneTelefone de contato.String"21999998888"
documentsDocumentos da empresa associada à origem.Objeto{...}
- corporate_nameNome corporativo.String"Empresa Exemplo S.A."
- cnpjCNPJ da empresa.String"12345678000199"
metadataMetadados adicionais.Objeto{...}
- tagsTags associadas à origem.Array["urgente", "prioridade"]
Language
Credentials
Header
Click Try It! to start a request and see the response here!