Endereços

Developing

GET

/api/v1/customers/{customer}/addresses

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200OK

application/json

Body

Example

{
    "success": true,
    "message": "Endereços recuperados com sucesso",
    "search_query": "",
    "filters": [],
    "pagination": {
        "page": 1,
        "per_page": 15,
        "last_page": 1,
        "has_prev_page": false,
        "has_next_page": false,
        "records": {
            "from": 1,
            "to": 1,
            "total": 1
        }
    },
    "data": [
        {
            "address_id": "01k0fp6p7jnkcyv37fcnxp9vd3",
            "type": "shipping",
            "label": "Loja Principal",
            "street": "Rua Augusta",
            "number": "456",
            "complement": null,
            "neighborhood": "Consolação",
            "city": "São Paulo",
            "state": "SP",
            "zip_code": "01305-000",
            "country": "BR",
            "is_default": true,
            "is_active": true,
            "created_at": "2025-07-18T21:14:21.000000Z",
            "updated_at": "2025-07-18T21:14:21.000000Z",
            "deleted_at": null
        }
    ]
}

Excluir

Adicionar Endereço