Sign in

v54

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

Delete polygon

Deletes a polygon of your store, searching by polygon ID.

Successful requests receive a 200 OK status code with true in the response body.

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 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 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.

delete/api/logistics/pvt/configuration/geoshape/{polygonName}

Path parameters

polygonNamestring required
Example:ipanema_leblon

Polygon ID (same as the polygon name).

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

boolean required

Successful requests return the message true.