v54

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01594762.7 KB
Pickup points

List pickup points

Retrieves information about your store pickup points.

⚠️ The response is limited to 1.000 pickup points. If you need more results, you can use the List paged pickup points endpoint.

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

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

idstring
namestring

Pickup point name displayed to customers at checkout.

descriptionstring

Pickup point description displayed to customers at checkout.

instructionsstring

Instructions for customers when collecting their package.

formatted_addressstring nullable

Formatted address.

isActiveboolean

Defines if the pickup point is active (true) or inactive (false).

distancenumber

Pickup point configured distance.

sellerstring

Seller that corresponds to the pickup point.

_sortnumber[]

Sort array.

tagsLabelstring[]

Tags that identify a group of pickup points.

isThirdPartyPickupboolean

Defines if the pickup point is third-party (true) or not (false).

accountOwnerNamestring

Account owner name.

accountOwnerIdstring

Account owner ID.

parentAccountNamestring

Parent account name.

originalIdstring nullable

Original ID.