Lista os endereços

GET/v1/addresses

Autentique com o header SelectKey: a chave sk_test_ opera no sandbox, a sk_live_ em produção. Como autenticar.

Parâmetros de consulta

limitinteger
Tamanho da página (itens por página).
offsetinteger
Posição do primeiro item (a partir de 0).
sortstring
Ordem pela data de criação.
Valores:ascendingdescending
daterangeum de
Criados neste dia (YYYY-MM-DD) ou neste instante.
daterangegtstring (date-time)
Criados depois deste instante (exclusivo).
daterangegtestring (date-time)
Criados a partir deste instante (inclusivo).
daterangeltstring (date-time)
Criados antes deste instante (exclusivo).
daterangeltestring (date-time)
Criados até este instante (inclusivo).
customeridstring
Só os endereços deste cliente.

Respostas

200Sucesso

dataobject[]obrigatório
Os itens desta página.
+23 campos de data
- idstringobrigatório
  Identificador público (addr_/cad_/cadm_/add_…)
- citystringobrigatóriopode ser nulo
  Cidade.
- linestringobrigatóriopode ser nulo
  O endereço inteiro numa linha.
- line1stringobrigatóriopode ser nulo
  Primeira linha: logradouro e número.
- line2stringobrigatóriopode ser nulo
  Segunda linha: bairro.
- line3stringobrigatóriopode ser nulo
  Terceira linha: cidade, estado e CEP.
- statestringobrigatóriopode ser nulo
  Estado (sigla de duas letras).
- _linksobject
  Links para operações relacionadas, por ação (self, create, update, delete, list…).
- numberstringobrigatóriopode ser nulo
  Número.
- streetstringobrigatóriopode ser nulo
  Logradouro.
- countrystringobrigatóriopode ser nulo
  Código do país (ISO 3166-1).
- ownerIdstringobrigatório
  Id público do dono.
- primarybooleanobrigatório
  Se é o endereço principal do dono.
- districtstringobrigatóriopode ser nulo
  Bairro.
- latitudestringobrigatóriopode ser nulo
  Latitude, em graus decimais como texto; null quando desconhecida.
- merchantobject
  A conta dona do recurso (o vendedor de registro).
  +3 campos de merchant
  - namestringobrigatóriopode ser nulo
    Nome fantasia da conta dona do recurso.
  - merchantIdstringobrigatóriopode ser nulo
    Id público da conta dona do recurso (bus_…).
  - isSubAccountbooleanobrigatório
    true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.
- metadataobjectobrigatóriopode ser nulo
  Os seus metadados chave-valor; null quando não há.
- postcodestringobrigatório
  CEP, só dígitos.
- createdAtstringobrigatório
  Quando o recurso foi criado (ISO 8601, UTC).
- longitudestringobrigatóriopode ser nulo
  Longitude, em graus decimais como texto; null quando desconhecida.
- ownerTypestringobrigatório
  Quem é dono do endereço: um customer, a própria company, um user ou um vendor.
  Valores:vendorcustomercompanyuser
- updatedAtstringobrigatório
  Quando o recurso foi atualizado pela última vez (ISO 8601, UTC).
- complementstringobrigatóriopode ser nulo
  Complemento (apartamento, sala, bloco…).
pageobjectobrigatório
Cursores de paginação da lista.
+3 campos de page
- totalintegerobrigatório
  Número total de páginas.
- offsetobjectobrigatório
  O offset para pedir a primeira, a anterior, a próxima e a última página.
  +4 campos de offset
  - lastintegerobrigatório
    Posição da última página.
  - nextintegerobrigatório
    Posição da próxima página (fica nesta quando ela é a última).
  - previntegerobrigatório
    Posição da página anterior (0 na primeira).
  - firstintegerobrigatório
    Posição da primeira página.
- currentintegerobrigatório
  Número da página atual (a primeira é 1).
limitintegerobrigatório
Tamanho da página, como pedido.
totalintegerobrigatório
Número total de itens que atendem aos filtros.
_linksobject
Links para operações relacionadas, por ação (self, create, update, delete, list…).
offsetintegerobrigatório
Posição do primeiro item desta página, como pedido.
hasMorebooleanobrigatório
true quando há mais itens depois desta página.
merchantobject
A conta dona do recurso (o vendedor de registro).
+3 campos de merchant
- namestringobrigatóriopode ser nulo
  Nome fantasia da conta dona do recurso.
- merchantIdstringobrigatóriopode ser nulo
  Id público da conta dona do recurso (bus_…).
- isSubAccountbooleanobrigatório
  true quando o recurso pertence a uma sub-conta operada por uma plataforma de marketplace.

401Não autenticado (credencial ausente ou inválida)

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

403Sem permissão

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

404Não encontrado

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

500Erro interno do servidor

errorobjectobrigatório
+8 campos de error
- codestringobrigatório
- paramsobject[]
- statusstringobrigatório
- detailsstring
- messagestringobrigatório
- categorystringobrigatório
  Valores:validationauthenticationauthorizationpaymentclientserverrate_limitpending
- resourcestringobrigatório
- statusCodeintegerobrigatório

AnteriorExclui um cliente PróximaCria um endereço

{ "data": [ { "id": "addr_0a1b2c3d4e5f60718293", "city": "string", "line": "string", "line1": "string", "line2": "string", "line3": "string", "state": "string", "_links": {}, "number": "1000", "street": "string", "country": "string", "ownerId": "string", "primary": true, "district": "string", "latitude": "string", "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true }, "metadata": {}, "postcode": "string", "createdAt": "string", "longitude": "string", "ownerType": "vendor", "updatedAt": "string", "complement": "string" } ], "page": { "total": 5000, "offset": { "last": 0, "next": 0, "prev": 0, "first": 0 }, "current": 0 }, "limit": 0, "total": 5000, "_links": {}, "offset": 0, "hasMore": true, "merchant": { "name": "Acme Ltda", "merchantId": "string", "isSubAccount": true } }