Atualizar endereço de entrega

A atualização do endereço de entrega serve para corrigir o endereço caso alguma inconsistência seja encontrada ou a entrega seja mal sucedida três vezes.

Atenção!

Como trata-se de um registro assíncrono, o solicitante é notificado via webhook assim que o boleto mudar de status de accepted para registered ou rejected.

Request

ENDPOINT

/account/ACCOUNT_KEY/card/CARD_KEY/address

MÉTODO

POST

Path parameters

Campo	Tipo	Descrição	Caracteres
account_key	uuidv4	Chave única de identificação da conta, no formato uuid v4	36
card_key	uuidv4	Chave única de identificação do cartão, no formato uuid v4	36

Request Body

{
    "postal_code": "5425020",
    "street": "Rua Gilberto Sabino",
    "number": 215,
    "complement": "4 andar",
    "neighborhood": "Pinheiros",
    "city": "So Paulo",
    "state": "SP",
    "reference": "Terminal Pinheiros",
    "address_type": "commercial",
    "notes": ["obs1", "obs2"],
    "phones": [
        {"country_code": "55", "area_code": "19", "number": "983151110"},
        {"country_code": "55", "area_code": "16", "number": "992334318"},
    ],
}

Request Body

Objeto address

Campo	Tipo	Descrição	Caracteres
street *	string	Logradouro	100
number *	string	Número	10
neighborhood *	string	Bairro	100
postal_code *	string	CEP	8
city *	string	Cidade	100
complement	string	Complemento	100
reference	string	Ponto de referência	100
notes	string array	Observações relacionadas ao endereço	100
phones	object array	Telefones de contato	Objeto phone
state *	string	Estado (UF)	Enumeradores state
address_type *	string	Tipo de endereço	Enumeradores address_type

Atenção!

Podem ser enviados até dois telefones de contato e quatro observações. Caso não haja telefone de contato e/ou observações, esses campos (phones e notes) não devem ser enviados.

Objeto phone

Campo	Tipo	Descrição	Caracteres
international_dial_code *	string	Código DDI (Discagem Direta Internacional)	2
area_code *	string	Código DDD (Discagem Direta à Distância)	2
number *	string	Complemento	9

Enumeradores address_type

Enumerador	Descrição
residential	endereço residencial
commercial	endereço comercial
other	outros tipos de endereço

Enumeradores state

Enumerador	Descrição
AC	Acre
AL	Alagoas
AM	Amazonas
AP	Amapá
BA	Bahia
CE	Ceará
DF	Distrito federal
ES	Espírito Santo
GO	Goiás
MA	Maranhão
MG	Minas Gerais
MS	Mato Grosso do Sul
MT	Mato Grosso
PA	Pará
PB	Paraíba
PE	Pernambuco
PI	Piauí
PR	Paraná
RJ	Rio de Janeiro
RN	Rio Grande do Norte
RO	Rondônia
RR	Roraima
RS	Rio Grande do Sul
SC	Santa Catarina
SE	Sergipe
SP	São Paulo
TO	Tocantins
EX	Exceção

Response

STATUS

200

Response Body

{
  "card_key": "1e3183f0-1bac-4e59-81e8-2d89db224040",
  "tracking_code": "FD89B071241022",
  "address": {
    "city": "So Paulo",
    "notes": [
      "obs1",
      "obs2"
    ],
    "state": "SP",
    "number": 215,
    "phones": [
      {
        "number": "983151110",
        "area_code": "19",
        "country_code": "55"
      },
      {
        "number": "992334318",
        "area_code": "16",
        "country_code": "55"
      }
    ],
    "street": "Rua Gilberto Sabino",
    "reference": "Terminal Pinheiros",
    "complement": "4 andar",
    "postal_code": "5425020",
    "address_type": "commercial",
    "neighborhood": "Pinheiros"
  }
}

Response Body Params

Campo	Tipo	Descrição	Caracteres
card_key *	uuidv4	Chave única de identificação do cartão, no formato uuid v4	36
tracking_code *	string	Código de rastreio da entrega do cartão	14
address	object	Objeto do tipo address, semelhante ao que é enviado na requisição	Objeto address

Error Response

STATUS

4xx

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}

Código HTTP status	Código QI code	Título title	Descrição (eng) description	Descrição (pt-br) translation
400	QIT000001	Bad Request	Schema Error	Schema Inválido
403	QIT000005	Permission Validator Error	Selected agent and person_key are different	Agente selecionado e person_key são diferentes
400	TRACK000004	Bad Request	Invalid status to change delivery address.	Status inválido para mudar o endereço de entrega.
500	TRACK000007	Internal Server Error	Failed to update delivery address at delivery service provider. Please, try again later!	Falha ao atualizar endereço de entrega junto à provedora de serviços de delivery. Por favor, tente novamente mais tarde!
404	TRACK000012	Not Found	Tracking not found for the given 'card_key'.	Rastreio não encontrado para a 'card_key' fornecida.