v1Recursos/Locations/getListar estados e regiões

Listar estados e regiões

Lista estados ou regiões por país, texto ou tipo. Sem country, os resultados são paginados com limit e cursor; com country, a lista completa de correspondências é retornada.

get/api/v1/reference/states
locations:read
Parâmetros de consulta
countrystringopcional
qstringopcional
typestringopcional
includeInactivebooleanopcional
limitintegeropcional
cursorstringopcional
Resposta
nextCursorstringopcional
statesarray of objectopcional
countryCodestringopcional
codestringopcional
namestringopcional
typestringopcional
activebooleanopcional
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
503O serviço está temporariamente indisponível. Tente adicionar os créditos novamente com a mesma chave de idempotência.
get/api/v1/reference/states
Sua chave de API
country
q
type
includeInactive
limit
cursor
{}

Guias que usam este recurso