v54

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

Pickup points

Create or update pickup point

Creates or updates a pickup point of your store, searching by pickup point ID.

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:

Product	Category	Resource
Logistics	Logistics access	Logistics full access
Logistics	Logistics access	Logistics shipping full access

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

Role	Resource
Logistics - Full access	Logistics full access
OMS - Full access	Logistics full access
Logistics - Full access	Logistics shipping full access
OMS - Full access	Logistics 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.

put/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}

Path parameters

pickupPointIdstring required

Example:b8e7ca56

Pickup point ID. Cannot contain spaces.

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.

Request body

idstring required

Pickup point ID. Cannot contain spaces.

namestring required

Pickup point name displayed to customers at checkout.

descriptionstring required

Pickup point description.

instructionsstring required

Pickup point instructions.

formatted_addressstring required

Formatted address.

isActiveboolean required

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

tagsLabelstring[] required

Tags that identify a group of pickup points.

isThirdPartyPickupboolean

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

Example request

{
  "id": "b8e7ca56",
  "name": "Pickup store.",
  "description": "Pickup your items in our store.",
  "instructions": "Bring your ID in order to pickup your order.",
  "formatted_address": "undefined",
  "address": {
    "postalCode": "22070002",
    "country": {
      "acronym": "BRA",
      "name": "Brazil"
    },
    "city": "Rio de Janeiro",
    "state": "RJ",
    "neighborhood": "Botafogo",
    "street": "Praia de botafogo.",
    "number": "200",
    "complement": "3rd floor",
    "reference": "Grey building",
    "location": {
      "latitude": -22.974477767944336,
      "longitude": -43.18672561645508
    }
  },
  "isActive": true,
  "businessHours": [
    {
      "dayOfWeek": 1,
      "openingTime": "08:00:00",
      "closingTime": "20:00:00"
    }
  ],
  "tagsLabel": [
    "w67",
    "p34"
  ]
}

Response

idstring

Pickup point ID.

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.