Localização

Esses dados são solicitados tanto para coleta quanto para entrega. Eles contêm as informações do endereço onde os pacotes devem ser coletados/entregues. Este objeto é o mesmo para a coleta, mas para a entrega, varia dependendo do país em que você está.

Para o Brasil, é recomendado usar o endereço por componentes na entrega para ter uma melhor geolocalização da entrega.

Coleta no galpão

Você pode usar os galpões salvos no sistema como pontos de coleta para criar uma tarefa.

Detalhes

Propriedade	Tipo	Descrição	Obrigatório	Restrições	Exemplo
warehouse	number	ID do galpão	SIM	-	"J. J. Pérez 90, La Calera, Calera, Valparaíso, Chile"

Exemplo

{
  "warehouse": 9
}

Local padrão para coleta e entrega

Detalhes

Propriedade	Tipo	Descrição	Obrigatório	Restrições	Example value
address	string	Endereço principal.	SIM	-	"J. J. Pérez 90, La Calera, Calera, Valparaíso, Chile"
instructions	string	Detalhes do endereço. Ex: número do apartamento, descrição da faixada, etc.	NÃO	-	Dpt. 403
lat	number	Latitude do endereço.	NÃO	-	-32.7894065
lng	number	Longitude do endereço.	NÃO	-	-71.1897235

Exemplo

{
  "address": "J. J. Pérez 90, La Calera, Calera, Valparaíso, Chile",
  "instructions": "Dpt. 403"
  "lat": -32.7894065,
  "lng": -71.1897235,
}

Localizações especiais para Basil

Para o Brasil, é usado um objeto especial para geolocalizar melhor o endereço por componentes. Aqui, isso depende do CEP (disponível apenas para o Brasil).

Detail

Propriedade	Tipo	Descrição	Mandatório	Restrições	Exemplo
address.zipcode	string	CEP do endereço.	SIM	Apenas números são aceitos	"60348450"
address.neighborhood	string	Bairro do endereço.	SIM	-	"VILA VELHA"
address.streetName	string	Rua do endereço.	SIM	-	"RUA 24,656"
address.state	string	Estado do endereço.	SIM	-	"CE"
address.country	string	País do endereço.	SIM	-	"Brazil"
address.city	string	Cidade do endereço.	SIM	-	"FORTALEZA"
instructions	string	Detalhes do endereço. Ex: número do apartamento, descrição da faixada, etc.	NÃO	-	"CONJ DOS BANCARIOS - REF.ENDERECO: PROX A UPA"

Exemplo

{
    "address": {
        "zipcode": "60348450",
        "neighborhood": "VILA VELHA",
        "streetName": "RUA 24,656",
        "state": "CE",
        "country": "Brazil",
        "city": "FORTALEZA"
    },
    "instructions": "CONJ DOS BANCARIOS - REF.ENDERECO: PROX A UPA"
}