Skip to main content

Addresses

2026-09-25 — Addresses — list, create, update and delete client delivery addresses​

🆕 New

  • GET /v1/addresses — Returns a paginated list of delivery addresses for one client (client_id query parameter is required).
  • POST /v1/addresses — Creates a new delivery address for a client: street address, optional complement, reference, coordinates, and delivery district (area). Its id can be passed as address_id on POST /v1/orders for a DELIVERY order.
  • PATCH /v1/addresses/{id} — Partially updates a delivery address. Only the fields you send are changed; the owning client cannot be changed.
  • DELETE /v1/addresses/{id} — Deletes a delivery address by id.

Scopes​

  • New addresses:read and addresses:write scopes gate the endpoints above.