Os campos de endereço devem conter o máximo de informação possível. Tenha em mente que o endereço será utilizado pelo entregador para localizar o ponto de entrega/coleta e, portanto, será lido por uma pessoa.

📘

Dica

Se você usa o serviço de localização do Google Maps (geocoding), o campo formatted_address é um ótimo valor para o campo address.address.

Exemplo

mutation {
  createOrder(
    input: {
      # ...
      address: {
        address: "Rua Minas Gerais, 236 - Higienópolis, São Paulo - SP, 01244-010, Brasil"
      }
      # ...
    }
  )
}

Detalhamento:

Rua Minas Gerais, 236 - Higienópolis, São Paulo - SP, 01244-010, Brasil
-   ----------   ---    ----------    -------   ---   -------    ----
1       2         3         4            5       6       7         8

1. Rua: tipo de logradouro
2. Minas Gerais: logradouro, nesse caso, o nome da rua
3. 236: número
4. Higienópolis: bairro
5. São Paulo: cidade
6. SP: estado
7. 01244-010: CEP/código postal
8. Brasil: país

Garanta que você está passando todas essas informações.

❗️

Erros

Caso você envie um endereço mal descrito, a API pode retornar um dos seguintes erros:

• CEP inválido, tente novamente.
• Local fora da área de cobertura para a cidade X.

Complemento

O complemento deve ser enviado em um campo à parte (address.complement). Caso você envie o complemento na string de endereço (address.address), o seguinte erro será retornado:

{
	"error": "Não deve ser enviado complemento dentro do endereço. Para isso existe o campo “complement” exclusivo para isso."
}

Exemplo de complemento correto

mutation {
  createOrder(
    input: {
      # ...
      address: {
        address: "Rua Minas Gerais, 236 - Higienópolis, São Paulo - SP, 01244-010, Brasil"
        complement: "Bloco 5, Apto 202"
      }
      # ...
    }
  )
}

Exemplo de complemento incorreto

mutation {
  createOrder(
    input: {
      # ...
      address: {
        address: "Rua Minas Gerais, 236, Bloco 5, Apto 202 - Higienópolis, São Paulo - SP, 01244-010, Brasil"
      }
      # ...
    }
  )
}

Entregas em condomínios

O Google Maps não resolve endereços internos de condomínios. No campo de endereço (address.address), coloque apenas as informações do endereço do condomínio. No campo complemento (address.complement), coloque as informações adicionais internas ao condomínio, como prédio e apartamento. Caso seja necessário passar mais informações, como, por exemplo, "Entregar pacote ao zelador.", envie essas informações no campo de instruções (package.instructions ou pickup.instructions).

Abrangência de entrega

Dependendo da cidade, não há garantia de entrega em municípios vizinhos. Nesse caso um erro será retornado:

{
	"error": "Fora da área de cobertura."
}

📘

Grande São Paulo tem cobertura para entrega entre municípios diferentes.