更新配送地址

当发现地址有误或配送三次失败时，可通过更新配送地址来进行纠正。

Request

ENDPOINT

/account/ACCOUNT_KEY/card/CARD_KEY/address

MÉTODO

POST

路径参数

字段	类型	描述	字符数
`account_key`	uuidv4	账户的唯一识别密钥，格式为 uuid v4	36
`card_key`	uuidv4	卡片的唯一识别密钥，格式为 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"},
    ],
}

请求体

address 对象

字段	类型	描述	字符数
`street` *	string	街道/路名	100
`number`	string	门牌号	10
`neighborhood` *	string	街区/社区	100
`postal_code` *	string	邮政编码	8
`city` *	string	城市	100
`complement`	string	补充信息	100
`reference`	string	参考地标	100
`notes`	string array	地址相关备注	100
`phones`	object array	联系电话	phone 对象
`state` *	string	州（UF）	state 枚举值
`address_type` *	string	地址类型	address_type 枚举值

注意！

number 字段为可选项。无门牌号的地址可以不填写此字段。

注意！

最多可发送两个联系电话和四条备注。若无联系电话和/或备注，则不应发送这些字段（phones 和 notes）。

phone 对象

字段	类型	描述	字符数
`international_dial_code` *	string	国际区号（DDI）	2
`area_code` *	string	地区区号（DDD）	2
`number` *	string	电话号码	9

address_type 枚举值

枚举值	描述
residential	住宅地址
commercial	商业地址
other	其他类型地址

state 枚举值

枚举值	描述
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	例外

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"
  }
}

响应体参数

字段	类型	描述	字符数
`card_key` *	uuidv4	卡片的唯一识别密钥，格式为 uuid v4	36
`tracking_code` *	string	卡片配送的物流追踪码	14
`address`	object	`address` 类型对象，与请求中发送的内容类似	address 对象

错误响应

STATUS

4xx

Response Body: Error

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

HTTP 代码 `status`	QI 代码 `code`	标题 `title`	描述（英文） `description`	描述（葡文） `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.

Request​

路径参数​

请求体​

address 对象​

phone 对象​

address_type 枚举值​

state 枚举值​

Response​

响应体参数​

错误响应​