---
title: "List paged pickup points"
method: GET
path: "/api/logistics/pvt/configuration/pickuppoints/_search"
tags: ["Pickup points"]
---

# List paged pickup points

`GET /api/logistics/pvt/configuration/pickuppoints/_search`

Lists paged [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store.

>⚠️ The response is limited to 100 pages.

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Logistics | Logistics access | **Logistics full access** |
| Logistics | Logistics access | **Logistics viewer** |
| Logistics | Logistics access | **Logistics shipping full access** |

You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):

| **Role** | **Resource** | 
| --------------- | ----------------- | 
| Logistics - Full access | Logistics full access |
| OMS - Full access | Logistics full access |
| Logistics - Full access | Logistics viewer |
| Logistics - Read only | Logistics viewer |
| Logistics - Full access | Logistics shipping full access |
| OMS - Full access | Logistics shipping full access |

>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

## Query parameters

- `page` integer
- `pageSize` integer
- `keyword` string

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object — Paged pickup points list.
  - `items` PickupPoint[] — List of pickup points.
    - `id` string — [Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID.
    - `name` string — Pickup point name displayed to customers at checkout.
    - `description` string — Pickup point description displayed to customers at checkout.
    - `instructions` string — Instructions for customers when collecting their package.
    - `formatted_address` string, nullable — Formatted address.
    - `address` object — Pickup point address information.
      - `postalCode` string — Pickup point address postal code.
      - `country` object — Information about the pickup point address country.
        - `acronym` string — Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
        - `name` string — Country name of the pickup point address.
      - `city` string — Pickup point address city.
      - `state` string — Pickup point address state.
      - `neighborhood` string — Pickup point address neighborhood.
      - `street` string — Pickup point address street.
      - `number` string — Pickup point address number.
      - `complement` string — Pickup point address complement.
      - `reference` string — Reference point to help the customer find the pickup point.
      - `location` object — Pickup point address geolocation coordinates.
        - `latitude` number — Latitude coordinate.
        - `longitude` number — Longitude coordinate.
    - `isActive` boolean — Defines if the pickup point is active (`true`) or inactive (`false`).
    - `distance` number — Pickup point configured distance.
    - `seller` string — Seller that corresponds to the pickup point.
    - `_sort` number[] — Sort array.
    - `businessHours` object[] — Pickup point business hours configurations.
      - `dayOfWeek` integer — Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday.
      - `openingTime` string — Opening time in `HH:MM:SS` format.
      - `closingTime` string — Closing time in `HH:MM:SS` format.
    - `tagsLabel` string[] — Tags that identify a group of pickup points.
    - `pickupHolidays` object[] — [Holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured for the pickup point.
      - `date` string — Holiday date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
      - `hourBegin` string — Holiday beginning time in `HH:MM` format.
      - `hourEnd` string — Holiday ending time in `HH:MM` format.
    - `isThirdPartyPickup` boolean — Defines if the pickup point is third-party (`true`) or not (`false`).
    - `accountOwnerName` string — Account owner name.
    - `accountOwnerId` string — Account owner ID.
    - `parentAccountName` string — Parent account name.
    - `originalId` string, nullable — Original ID.
  - `paging` object — Pagination information.
    - `page` integer — Number of the current page of the response. By default, it returns page `1`, unless a different value is informed in the `page` query parameter.
    - `perPage` integer — Number of pickup points per page.
    - `total` integer — Total number of existing pickup points.
    - `pages` integer — Total number of pages, considering the total number of pickup points. Even though there might be other results, the maximum value of this field will be `100`, because the response is limited to 100 pages.

---

[API](https://skmtc.net/vtex/apis/logistics-api.md) · [All operations](https://skmtc.net/vtex/apis/logistics-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/logistics-api/revisions/c08af805d8b3/schema)