v54

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

Add blocked delivery windows

Adds blocked delivery windows for your store's shipping policies.

⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the account.

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 shipping full access
LogisticsLogistics accessLogistics full access

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

RoleResource
Logistics - Full accessLogistics shipping full access
OMS - Full accessLogistics shipping full access
Logistics - Full accessLogistics full access
OMS - Full accessLogistics 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.

post/api/logistics/pvt/configuration/carriers/{carrierId}/adddayofweekblocked

Path parameters

carrierIdstring required
Example:carrier-123

Shipping policy ID (carrier ID).

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

string required

Delivery window block starting date and time in the format YYYY-MM-DDTHH:MM:SS. The time zone is set according to the store account. Requests with incorrect values will be disconsidered by the system (for example, a date in the past), regardless of a successful response.

Example request

"2025-12-09T08:00:00"

Response

OK

boolean required

Successful requests return the message true.