Sign in

v1

latestOpenAPI 3.1.02026-07-24290162.6 KB

Listar endereços de uma loja

get/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.

Response

200

current_pageinteger
first_page_urlstring
frominteger
last_pageinteger
last_page_urlstring
{"stackTrail":"paths:/api/v2/me/companies/{storeId}/addresses:get:responses:200:content:application/json:schema:properties:next_page_url","oasType":"schema","type":"unknown"}
pathstring
per_pageinteger
{"stackTrail":"paths:/api/v2/me/companies/{storeId}/addresses:get:responses:200:content:application/json:schema:properties:prev_page_url","oasType":"schema","type":"unknown"}
tointeger
totalinteger

Example response

{
  "current_page": 1,
  "data": [
    {
      "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"
          }
        }
      }
    }
  ],
  "first_page_url": "https://sandbox.melhorenvio.com.br/api/v2/me/companies/781f86be-c3be-47e7-9bef-70b8675a55c3/addresses?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://sandbox.melhorenvio.com.br/api/v2/me/companies/781f86be-c3be-47e7-9bef-70b8675a55c3/addresses?page=1",
  "path": "https://sandbox.melhorenvio.com.br/api/v2/me/companies/781f86be-c3be-47e7-9bef-70b8675a55c3/addresses",
  "per_page": 10,
  "to": 1,
  "total": 1
}