Update delivery address

The delivery address update is used to correct the address if any inconsistency is found or if delivery fails three times.

Request

ENDPOINT

/wallet/WALLET_KEY/card/CARD_KEY/address

METHOD

PATCH

Path params

Field	Type	Description	Characters
WALLET_KEY *	string	Wallet identification key.	uuid
CARD_KEY *	string	Card identification key.	uuid

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

address object

Field	Type	Description	Characters
street *	string	Street address	100
number *	string	Number	10
neighborhood *	string	Neighborhood	100
postal_code *	string	Postal code	8
city *	string	City	100
complement	string	Complement	100
reference	string	Reference point	100
notes	string array	Address-related notes	100
phones	object array	Contact phones	phone object
state *	string	State (UF)	state enumerators
address_type *	string	Address type	address_type enumerators

Attention!

Up to two contact phones and four notes can be sent. If there are no contact phones and/or notes, these fields (phones and notes) should not be sent.

phone object

Field	Type	Description	Characters
international_dial_code *	string	International dial code (DDI)	2
area_code *	string	Area code (DDD)	2
number *	string	Complement	9

address_type enumerators

Enumerator	Description
residential	residential address
commercial	commercial address
other	other address types

state enumerators

Enumerator	Description
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	Exception

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

Field	Type	Description	Characters
card_key *	uuidv4	Unique card identification key, in uuid v4 format	36
tracking_code *	string	Card delivery tracking code	14
address	object	Object of type address, similar to what is sent in the request	address object

Error Response

STATUS

4xx

Response Body: Error

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

HTTP Code status	QI Code code	Title title	Description (eng) description	Description (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.