> ## Documentation Index
> Fetch the complete documentation index at: https://docs.riqra.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar localidades con cobertura

> Lista todas las localidades que están vinculadas a la cobertura de la tienda.

Nota: El uso de este endpoint está permitido únicamente en el caso de que la tienda no haga uso de territorios.



## OpenAPI

````yaml /api/openapi.json get /delivery-coverage
openapi: 3.1.0
info:
  title: Riqra API
  version: '1.0'
  contact:
    email: soporte@riqra.com
    url: https://www.riqra.com/
    name: Riqra Support
  description: >-
    Usando nuestra API puedes integrar tu ERP o tu sistema actual de
    administración con [Riqra](https://www.riqra.com/).
servers:
  - url: https://sandbox.api.riqra.com
    description: Sandbox
  - description: Producción
    url: https://api.riqra.com
security:
  - API Key: []
tags:
  - name: Almacenes
  - name: Banners
  - name: Categorías
  - name: Clientes
  - name: Clientes - Direcciones
  - name: Cobertura
  - name: Comercio
  - name: Cupones
  - name: Inventario
  - name: Líneas de Crédito
  - name: Lista de Precios
  - name: Lista de Precios - Precios
  - name: Marcas
  - name: Pedidos
  - name: Productos
  - name: Productos Sugeridos
  - name: Promociones
  - name: Stock
  - name: Subcategorías
  - name: Variantes
paths:
  /delivery-coverage:
    get:
      tags:
        - Cobertura
      summary: Listar localidades con cobertura
      description: >-
        Lista todas las localidades que están vinculadas a la cobertura de la
        tienda.


        Nota: El uso de este endpoint está permitido únicamente en el caso de
        que la tienda no haga uso de territorios.
      operationId: get-all-delivery-coverage
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: 10
            maximum: 20
          description: Número de elementos para retornar.
        - schema:
            type: integer
            default: 1
          in: query
          name: page
          description: Número de página para retornar.
        - name: code
          in: query
          schema:
            type: string
            examples:
              - '150104'
          description: El código de la localidad.
        - name: parentCode
          in: query
          schema:
            type: string
            examples:
              - '1501'
          description: Es el código de la localidad padre.
        - name: division
          in: query
          schema:
            type: string
            examples:
              - Distrito
          description: La división de la localidad.
        - name: parentId
          in: query
          schema:
            type: integer
          description: El ID de la localidad padre.
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LocalitiesCollectionResponse'
components:
  schemas:
    LocalitiesCollectionResponse:
      title: LocalitiesCollectionResponse
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Locality'
        pagination:
          $ref: '#/components/schemas/Pagination'
    Locality:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/LocalityId'
        name:
          $ref: '#/components/schemas/LocalityName'
        code:
          $ref: '#/components/schemas/LocalityCode'
        parentCode:
          $ref: '#/components/schemas/LocalityParentCode'
        division:
          $ref: '#/components/schemas/LocalityDivision'
        parentId:
          $ref: '#/components/schemas/LocalityParentId'
      required:
        - id
        - name
        - code
        - parentCode
        - division
        - parentId
    Pagination:
      type: object
      properties:
        page:
          type: integer
          description: Número de la página actual.
        pages:
          type: integer
          description: Número total de páginas.
        total:
          type: integer
          description: Cantidad total de elementos.
        hasPrevPage:
          type: boolean
          description: Indica si existe una página previa.
        hasNextPage:
          type: boolean
          description: Indica si existe una página siguiente.
    LocalityId:
      type: integer
      description: El ID de la localidad.
    LocalityName:
      type: string
      description: El nombre de la localidad.
      examples:
        - Barranco
    LocalityCode:
      type: string
      description: El código de la localidad.
      examples:
        - '150104'
    LocalityParentCode:
      type: string
      description: >-
        Es el código de la localidad padre.


        Ejemplo: La localidad padre del distrito Barranco es la provincia de
        Lima, cuyo `parentCode` es `1501`.
      examples:
        - '1501'
    LocalityDivision:
      type: string
      description: >-
        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.
      examples:
        - Distrito
    LocalityParentId:
      type: integer
      description: El ID de la localidad padre.
  securitySchemes:
    API Key:
      name: api-key
      type: apiKey
      in: header
      description: >-
        Todas las llamadas al API tienen que contener este header junto a la
        clave para poder autenticar y autorizar al cliente.

````