Pickup points

List paged pickup points

Changed on

Lists paged pickup points of your store.

ℹ️ The endpoint can return up to 1,000 pickup points per page and up to 100 pages, totaling up to 100,000 pickup points.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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:

ProductCategoryResource
LogisticsLogistics accessLogistics full access
LogisticsLogistics accessLogistics viewer
LogisticsLogistics accessLogistics shipping full access

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
Logistics - Full accessLogistics full access
OMS - Full accessLogistics full access
Logistics - Full accessLogistics viewer
Logistics - Read onlyLogistics viewer
Logistics - Full accessLogistics shipping full access
OMS - Full accessLogistics shipping full access

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. 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. To learn more about machine authentication at VTEX, see Authentication overview.

get/api/logistics/pvt/configuration/pickuppoints/_search

Request

  • Base URL
    https://apiexamples.vtexcommercestable.com.br
  • URL
    https://apiexamples.vtexcommercestable.com.br/api/logistics/pvt/configuration/pickuppoints/_search
  • Auth
    • API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
    • or API key in header VtexIdclientAutCookie

Query parameters

pageinteger
Example:2

Number of the page of the response. When not informed, the default page returned is 1, but you can use this parameter to retrieve a specific page. The response is limited to 100 pages.

pageSizeinteger
Example:15

Number of pickup points per page. The maximum value is 1,000.

keywordstring
Example:Rio

Search pickup points by using a keyword.

isActiveboolean
Example:true

Filters pickup points by status. When true, the response returns only active pickup points. When false, the response returns only inactive pickup points.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

Changes

    • info

      for the query request parameter pageSize, the max was increased from 100.00 to 1000.00

    • breaking

      for the query request parameter pageSize, the max was decreased from 1000.00 to 100.00

    • info

      added the new optional query request parameter isActive