Logistics API
>Check the [Fulfillment onboarding guide](https://developers.vtex.com/docs/guides/fulfillment). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about fulfillment and is organized by focusing on the developer's journey. Logistics or fulfillment is the module responsible for shipping calculation and inventory m
Latency
9ms p95
Uptime
0.0% 30d
Playground
Verified
live
Endpoints
/api/logistics/pvt/configuration/carriers/{carrierId}/removedayofweekblocked
Remove blocked delivery windows
/api/logistics/pvt/configuration/carriers/{carrierId}/getdayofweekblocked
Retrieve blocked delivery windows
/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames
Search capacity reservations in time range
/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames/{windowDay}F{windowStartTime}T{windowEndTime}
Get capacity reservation usage by window
/api/logistics/pvt/configuration/carriers/{carrierId}/adddayofweekblocked
Add blocked delivery windows
/api/logistics/pvt/configuration/docks
List all docks
/api/logistics/pvt/configuration/docks
Create/update dock
/api/logistics/pvt/configuration/docks/{dockId}
Delete dock
/api/logistics/pvt/configuration/docks/{dockId}
List dock by ID
/api/logistics/pvt/configuration/docks/{dockId}/activation
Activate dock
/api/logistics/pvt/configuration/docks/{dockId}/deactivation
Deactivate dock
/api/logistics/pvt/configuration/freights/{carrierId}/values/update
Create/update freight values
/api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values
List freight values
/api/logistics/pvt/configuration/geoshape
List paged polygons
/api/logistics/pvt/configuration/geoshape
Create/update polygon
/api/logistics/pvt/configuration/geoshape/{polygonName}
Delete polygon
/api/logistics/pvt/configuration/geoshape/{polygonName}
List polygon by ID
/api/logistics/pvt/configuration/holidays
List all holidays
/api/logistics/pvt/configuration/holidays/{holidayId}
Delete holiday
/api/logistics/pvt/configuration/holidays/{holidayId}
List holiday by ID
/api/logistics/pvt/configuration/holidays/{holidayId}
Create/update holiday
/api/logistics/pvt/configuration/pickuppoints
List all pickup points
/api/logistics/pvt/configuration/pickuppoints/_search
List paged Pickup Points
/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}
Delete Pickup Point
/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}
List Pickup Point By ID
/api/logistics/pvt/shipping-policies/{id}
Delete shipping policies by ID
/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}
Create/Update Pickup Point
/api/logistics/pvt/configuration/warehouses
List all warehouses
/api/logistics/pvt/configuration/warehouses
Create/update warehouse
/api/logistics/pvt/configuration/warehouses/{warehouseId}
Remove warehouse
/api/logistics/pvt/configuration/warehouses/{warehouseId}
List warehouse by ID
/api/logistics/pvt/configuration/warehouses/{warehouseId}/activation
Activate warehouse
/api/logistics/pvt/configuration/warehouses/{warehouseId}/deactivation
Deactivate warehouse
/api/logistics/pvt/inventory/items/{itemId}/warehouses/{warehouseId}/dispatched
List inventory with dispatched reservations
/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}
Update inventory by SKU and warehouse
/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}
List inventory per dock
/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}/warehouses/{warehouseId}
List inventory per dock and warehouse
/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}
List inventory per warehouse
/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots
List supply lots
/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}
Save supply lot
/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}/transfer
Transfer supply lot
/api/logistics/pvt/shipping-policies
List shipping policies
/api/logistics/pvt/shipping-policies
Create shipping policy
/api/logistics/pvt/inventory/reservations
Create reservation
/api/logistics/pvt/inventory/reservations/{reservationId}
List reservation by ID
/api/logistics/pvt/inventory/reservations/{reservationId}/acknowledge
Acknowledgment reservation
/api/logistics/pvt/inventory/reservations/{reservationId}/cancel
Cancel reservation
/api/logistics/pvt/inventory/reservations/{reservationId}/confirm
Confirm reservation
/api/logistics/pvt/inventory/reservations/{warehouseId}/{skuId}
List reservation by warehouse and SKU
/api/logistics/pvt/inventory/skus/{skuId}
List inventory by SKU
/api/logistics/pvt/shipping-policies/{id}
Retrieve shipping policy by ID
/api/logistics/pvt/shipping-policies/{id}
Update shipping policy
/api/logistics/pvt/shipping/calculate
Calculate SLA
53 endpoints auto-detected
Authentication
This API uses an API key, passed in the "X-VTEX-API-AppKey" header. No OAuth required.
curl -X POST \
"https://vtex.local/api/logistics/pvt/configuration/carriers/{carrierId}/removedayofweekblocked" \
-H "X-VTEX-API-AppKey: YOUR_API_KEY"vtex.local · HTTPS only