v1

latestOpenAPI 3.1.02026-07-26477322.4 KB

Criar endereço

Para a criação de um address é necessário informar o customer_id do cliente ao qual será associado o endereço.

post/customers/{customer_id}/addresses

Path parameters

customer_idstring required

Código do cliente. Formato: cus_XXXXXXXXXXXXXXXX

Request body

line_1string required

Linha 1 do endereço. (Número, Rua, e Bairro - Nesta ordem e separados por vírgula) Max: 256 caracteres.

line_2string

Linha 2 do endereço. (Complemento - Andar, Sala, Apto). Max: 128 caracteres.

zip_codestring required

CEP. Max: 16 caracteres. (Apenas numérico)

citystring required

Cidade. Max: 64 caracteres.

statestring required

Código do estado no formato ISO 3166-2. <a href="https://pt.wikipedia.org/wiki/ISO_3166-2" target="_blank">Saiba mais sobre ISO 3166-2</a>

countrystring required

Código do país no formato ISO 3166-1 alpha-2. <a href="https://pt.wikipedia.org/wiki/ISO_3166-1_alfa-2" target="_blank">Saiba mais sobre ISO 3166-1 alpha-2</a>

metadatastring

Objeto chave/valor utilizado para armazenar informações adicionais sobre o endereço. Saiba mais sobre metadata

Response

200

idstring

line_1string

line_2string

zip_codestring

citystring

statestring

countrystring

statusstring

created_atstring

updated_atstring

Example response

{
  "id": "addr_Pn5x69LCWhrANX2o",
  "line_1": "375, Av. General Justo, Centro",
  "line_2": "8º andar",
  "zip_code": "20021130",
  "city": "Rio de Janeiro",
  "state": "RJ",
  "country": "BR",
  "status": "active",
  "created_at": "2017-04-19T17:49:36Z",
  "updated_at": "2017-04-19T17:49:36Z",
  "customer": {
    "id": "cus_aEkwKv0SmNHMR931",
    "name": "Luke Skywalker",
    "email": "lskywalker@r2d2.com",
    "document": "26224451990",
    "type": "individual",
    "created_at": "2017-04-04T19:41:31Z",
    "updated_at": "2017-04-19T17:44:47Z",
    "metadata": {
      "id": "my_customer_id"
    }
  },
  "metadata": {
    "id": "my_address_id"
  }
}