Saltar al contenido principal
GET
/
delivery-coverage
Listar localidades con cobertura
curl --request GET \
  --url https://sandbox.api.riqra.com/delivery-coverage \
  --header 'api-key: <api-key>'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "code": "<string>",
    "parentCode": "<string>",
    "division": "<string>",
    "parentId": 123
  },
  "pagination": {
    "page": 123,
    "pages": 123,
    "total": 123,
    "hasPrevPage": true,
    "hasNextPage": true
  }
}

Autorizaciones

api-key
string
header
requerido

Todas las llamadas al API tienen que contener este header junto a la clave para poder autenticar y autorizar al cliente.

Parámetros de consulta

limit
integer
predeterminado:10

Número de elementos para retornar.

Rango requerido: x <= 20
page
integer
predeterminado:1

Número de página para retornar.

code
string

El código de la localidad.

Ejemplo:

"150104"

parentCode
string

Es el código de la localidad padre.

Ejemplo:

"1501"

division
string

La división de la localidad.

Ejemplo:

"Distrito"

parentId
integer

El ID de la localidad padre.

Respuesta

200 - application/json
data
object
pagination
object