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
  }
}

GET

delivery-coverage

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
  }
}

Authorizations

api-key

string

header

required

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

Query Parameters

limit

integer

default:10

Número de elementos para retornar.

Rango requerido: x <= 20

page

integer

default:1

Número de página para retornar.

code

string

El código de la localidad.

parentCode

string

Es el código de la localidad padre.

division

string

La división de la localidad.

parentId

integer

El ID de la localidad padre.

Response

200 - application/json

data

object

Mostrar atributos secundarios

data.id

integer

required

El ID de la localidad.

data.name

string

required

El nombre de la localidad.

data.code

string

required

El código de la localidad.

data.parentCode

string

required

Es el código de la localidad padre.

Ejemplo: La localidad padre del distrito Barranco es la provincia de Lima, cuyo parentCode es 1501.

data.division

string

required

La división de la localidad.

Para obtener más información sobre las divisiones en cada país, consulte https://en.wikipedia.org/wiki/List_of_administrative_divisions_by_country.

data.parentId

integer

required

El ID de la localidad padre.

pagination

object

Mostrar atributos secundarios

pagination.page

integer

Número de la página actual.

pagination.pages

integer

Número total de páginas.

pagination.total

integer

Cantidad total de elementos.

pagination.hasPrevPage

boolean

Indica si existe una página previa.

pagination.hasNextPage

boolean

Indica si existe una página siguiente.

Eliminar Listar

⌘I

Documentación

Referencia

Listar localidades con cobertura

Authorizations

Query Parameters

Response