Sign in

v1

latestOpenAPI 3.1.02026-07-24290162.6 KB

Cadastrar endereço de uma loja

Cadastro e visualização de endereços e telefones de lojas

post/api/v2/me/companies/{storeId}/addresses

Path parameters

storeIdstring required

ID da loja

Headers

Content-typestring required
Acceptstring required
Authorizationstring required
User-Agentstring required

É obrigatório que seja adicionado o cabeçalho HTTP User-Agent com o nome da sua aplicação junto a um email de contato/suporte.

Request body

postal_codestring required

Código Postal - CEP / EX: 01010010

addressstring required

Endereço | Logradouro / Ex: Av. Teste

numberstring required

Número / Ex: 123

complementstring required

Complemento / Ex: Casa - Apto - ABC

citystring required

Cidade / Ex: São Paulo

statestring required

Estado / Ex: São Paulo

Response

200

idinteger
labelstring
postal_codestring
addressstring
numberstring
complementstring
{"stackTrail":"paths:/api/v2/me/companies/{storeId}/addresses:post:responses:200:content:application/json:schema:properties:district","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/api/v2/me/companies/{storeId}/addresses:post:responses:200:content:application/json:schema:properties:latitude","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/api/v2/me/companies/{storeId}/addresses:post:responses:200:content:application/json:schema:properties:longitude","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/api/v2/me/companies/{storeId}/addresses:post:responses:200:content:application/json:schema:properties:confirmed_at","oasType":"schema","type":"unknown"}
created_atstring
updated_atstring

Example response

{
  "id": 32336,
  "postal_code": "07110000",
  "address": "Av Teste",
  "number": "123",
  "complement": "ABC",
  "created_at": "2022-03-30 17:08:23",
  "updated_at": "2022-03-30 17:08:23",
  "city": {
    "id": 5269,
    "city": "São Paulo",
    "state": {
      "id": 25,
      "state": "São Paulo",
      "state_abbr": "SP",
      "country": {
        "id": "BR",
        "country": "Brazil"
      }
    }
  }
}