Get All Locations

get

https://example.com/api/master-tables/locations

Obtiene las localidades disponibles y permite filtrarlas por location_id o province_id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Consultá las localidades disponibles y su provincia asociada.

Antes de empezar

Usá este endpoint cuando necesites poblar listas de localidades en formularios o validaciones.
Si querés obtener una localidad puntual, enviá location_id como query parameter.
Si querés acotar el resultado por provincia, enviá province_id como query parameter.
Guardá location_id y province_id para reutilizarlos en requests que requieran esos identificadores.

Cómo consultar localidades

GET /api/master-tables/locations

Filtrar una localidad puntual

GET /api/master-tables/locations?location_id=1132

Filtrar por provincia

GET /api/master-tables/locations?province_id=AR-B

Filtrar por localidad y provincia

GET /api/master-tables/locations?location_id=1132&province_id=AR-B

Query parameters

Parámetro	Tipo	Requerido	Descripción
`location_id`	integer	No	Identificador de la localidad que querés consultar.
`province_id`	string	No	Código ISO de la provincia a la que pertenece la localidad.

Qué devuelve este endpoint

La respuesta devuelve un arreglo items. Cada elemento representa una localidad disponible.

Campo	Tipo	Descripción
`location_id`	integer	Identificador de la localidad.
`location`	string	Nombre legible de la localidad.
`province_id`	string	Código ISO de la provincia asociada.
`province`	string	Nombre legible de la provincia asociada.

Respuesta esperada

{
  "items": [
    {
      "location_id": 1132,
      "location": "MERCEDES",
      "province_id": "AR-B",
      "province": "Buenos Aires"
    },
    {
      "location_id": 1098,
      "location": "MAR DEL PLATA",
      "province_id": "AR-B",
      "province": "Buenos Aires"
    },
    {
      "location_id": 1532,
      "location": "SANTIAGO DEL ESTERO",
      "province_id": "AR-G",
      "province": "Santiago del Estero"
    }
  ]
}

Ejemplo de respuesta filtrada

{
  "items": [
    {
      "location_id": 1132,
      "location": "MERCEDES",
      "province_id": "AR-B",
      "province": "Buenos Aires"
    }
  ]
}

Cuándo usar este endpoint

Este endpoint es útil cuando necesitás:

listar localidades en un formulario
validar un identificador de localidad antes de enviarlo a otro servicio
filtrar localidades por provincia
traducir identificadores técnicos a nombres legibles de localidad y provincia

Errores frecuentes

404 Value not found: la localidad o provincia enviada no tiene coincidencias en el maestro.
422 Validation Error: alguno de los query parameters tiene un formato inválido.

Siguiente paso

Si necesitás consultar provincias habilitadas, usá GET /api/master-tables/provinces.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json