---
name: logistics-api
description: "Logistics API skill. Use when working with Logistics for api, availability. Covers 59 endpoints."
version: 1.0.0
generator: lapsh
---

# Logistics API
API version: 1.0

## Auth
ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header

## Base URL
https://apiexamples.vtexcommercestable.com.br

## Setup
1. Set your API key in the appropriate header
2. GET /api/logistics/pvt/shipping-policies -- verify access
3. POST /api/logistics/pvt/shipping-policies -- create first shipping-policies

## Endpoints

59 endpoints across 2 groups. See references/api-spec.lap for full details.

### api
| Method | Path | Description |
|--------|------|-------------|
| GET | /api/logistics/pvt/shipping-policies/{id} | Retrieve shipping policy by ID |
| DELETE | /api/logistics/pvt/shipping-policies/{id} | Delete shipping policy by ID |
| PUT | /api/logistics/pvt/shipping-policies/{id} | Update shipping policy by ID |
| GET | /api/logistics/pvt/shipping-policies | List shipping policies |
| POST | /api/logistics/pvt/shipping-policies | Create shipping policy |
| POST | /api/logistics/pvt/configuration/freights/{carrierId}/values/update | Create or update freight values |
| GET | /api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values | List freight values |
| GET | /api/logistics/pvt/configuration/carriers/{carrierId}/getdayofweekblocked | Retrieve blocked delivery windows |
| POST | /api/logistics/pvt/configuration/carriers/{carrierId}/adddayofweekblocked | Add blocked delivery windows |
| POST | /api/logistics/pvt/configuration/carriers/{carrierId}/removedayofweekblocked | Remove blocked delivery windows |
| POST | /api/logistics/pvt/configuration/docks | Create or update dock |
| GET | /api/logistics/pvt/configuration/docks | List all docks |
| GET | /api/logistics/pvt/configuration/docks/{dockId} | List dock by ID |
| DELETE | /api/logistics/pvt/configuration/docks/{dockId} | Delete dock |
| POST | /api/logistics/pvt/configuration/docks/{dockId}/activation | Activate dock |
| POST | /api/logistics/pvt/configuration/docks/{dockId}/deactivation | Deactivate dock |
| POST | /api/logistics/pvt/configuration/warehouses | Create or update warehouse |
| GET | /api/logistics/pvt/configuration/warehouses | List all warehouses |
| GET | /api/logistics/pvt/configuration/warehouses/{warehouseId} | List warehouse by ID |
| DELETE | /api/logistics/pvt/configuration/warehouses/{warehouseId} | Remove warehouse |
| POST | /api/logistics/pvt/configuration/warehouses/{warehouseId}/activation | Activate warehouse |
| POST | /api/logistics/pvt/configuration/warehouses/{warehouseId}/deactivation | Deactivate warehouse |
| GET | /api/logistics/pvt/inventory/skus/{skuId} | List inventory by SKU |
| GET | /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId} | List inventory per warehouse |
| PUT | /api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId} | Update inventory by SKU and warehouse |
| PATCH | /api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}/quantity | Update inventory quantity by SKU and warehouse |
| PATCH | /api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}/lead-time | Update inventory lead time by SKU and warehouse |
| GET | /api/logistics/pvt/inventory/items/{skuId}/docks/{dockId} | List inventory per dock |
| GET | /api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}/warehouses/{warehouseId} | List inventory per dock and warehouse |
| GET | /api/logistics/pvt/inventory/items/{itemId}/warehouses/{warehouseId}/dispatched | List inventory with dispatched reservations |
| GET | /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots | List supply lots |
| PUT | /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId} | Save supply lot |
| POST | /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}/transfer | Transfer supply lot |
| PUT | /api/logistics/pvt/configuration/holidays/{holidayId} | Create or update holiday |
| GET | /api/logistics/pvt/configuration/holidays/{holidayId} | List holiday by ID |
| DELETE | /api/logistics/pvt/configuration/holidays/{holidayId} | Delete holiday |
| GET | /api/logistics/pvt/configuration/holidays | List all holidays |
| POST | /api/logistics/pvt/inventory/reservations | Create reservation |
| GET | /api/logistics/pvt/inventory/reservations/{reservationId} | List reservation by ID |
| POST | /api/logistics/pvt/inventory/reservations/{reservationId}/confirm | Confirm reservation |
| POST | /api/logistics/pvt/inventory/reservations/{reservationId}/acknowledge | Acknowledgment reservation |
| POST | /api/logistics/pvt/inventory/reservations/{reservationId}/cancel | Cancel reservation |
| GET | /api/logistics/pvt/inventory/reservations/{warehouseId}/{skuId} | List reservation by warehouse and SKU |
| POST | /api/logistics/pvt/shipping/calculate | Calculate SLA |
| GET | /api/logistics/pvt/configuration/pickuppoints | List pickup points |
| PUT | /api/logistics/pvt/configuration/pickuppoints/{pickupPointId} | Create or update pickup point |
| GET | /api/logistics/pvt/configuration/pickuppoints/{pickupPointId} | List pickup point by ID |
| DELETE | /api/logistics/pvt/configuration/pickuppoints/{pickupPointId} | Delete pickup point |
| GET | /api/logistics/pvt/configuration/pickuppoints/_search | List paged pickup points |
| GET | /api/logistics/pvt/configuration/geoshape | List paged polygons |
| PUT | /api/logistics/pvt/configuration/geoshape | Create or update polygon |
| GET | /api/logistics/pvt/configuration/geoshape/{polygonName} | List polygon by ID |
| DELETE | /api/logistics/pvt/configuration/geoshape/{polygonName} | Delete polygon |
| GET | /api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames | Search capacity reservations in time range |
| GET | /api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames/{windowDay}F{windowStartTime}T{windowEndTime} | Get capacity reservation usage by window |

### availability
| Method | Path | Description |
|--------|------|-------------|
| POST | /availability/v1/inventory/batch | Create batch inventory job |
| POST | /availability/v1/inventory/batch/{batchId}/commit | Commit batch inventory |
| GET | /availability/v1/inventory/batch/{batchId}/status | Get batch inventory status |
| GET | /availability/v1/inventory/batch/{batchId}/errors | Get batch inventory errors |

## Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Get shipping-policy details?" -> GET /api/logistics/pvt/shipping-policies/{id}
- "Delete a shipping-policy?" -> DELETE /api/logistics/pvt/shipping-policies/{id}
- "Update a shipping-policy?" -> PUT /api/logistics/pvt/shipping-policies/{id}
- "List all shipping-policies?" -> GET /api/logistics/pvt/shipping-policies
- "Create a shipping-policy?" -> POST /api/logistics/pvt/shipping-policies
- "Create a update?" -> POST /api/logistics/pvt/configuration/freights/{carrierId}/values/update
- "List all values?" -> GET /api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values
- "List all getdayofweekblocked?" -> GET /api/logistics/pvt/configuration/carriers/{carrierId}/getdayofweekblocked
- "Create a adddayofweekblocked?" -> POST /api/logistics/pvt/configuration/carriers/{carrierId}/adddayofweekblocked
- "Create a removedayofweekblocked?" -> POST /api/logistics/pvt/configuration/carriers/{carrierId}/removedayofweekblocked
- "Create a dock?" -> POST /api/logistics/pvt/configuration/docks
- "List all docks?" -> GET /api/logistics/pvt/configuration/docks
- "Get dock details?" -> GET /api/logistics/pvt/configuration/docks/{dockId}
- "Delete a dock?" -> DELETE /api/logistics/pvt/configuration/docks/{dockId}
- "Create a activation?" -> POST /api/logistics/pvt/configuration/docks/{dockId}/activation
- "Create a deactivation?" -> POST /api/logistics/pvt/configuration/docks/{dockId}/deactivation
- "Create a warehouse?" -> POST /api/logistics/pvt/configuration/warehouses
- "List all warehouses?" -> GET /api/logistics/pvt/configuration/warehouses
- "Get warehouse details?" -> GET /api/logistics/pvt/configuration/warehouses/{warehouseId}
- "Delete a warehouse?" -> DELETE /api/logistics/pvt/configuration/warehouses/{warehouseId}
- "Create a activation?" -> POST /api/logistics/pvt/configuration/warehouses/{warehouseId}/activation
- "Create a deactivation?" -> POST /api/logistics/pvt/configuration/warehouses/{warehouseId}/deactivation
- "Get skus details?" -> GET /api/logistics/pvt/inventory/skus/{skuId}
- "Get warehouse details?" -> GET /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}
- "Update a warehouse?" -> PUT /api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}
- "Get dock details?" -> GET /api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}
- "Get warehouse details?" -> GET /api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}/warehouses/{warehouseId}
- "List all dispatched?" -> GET /api/logistics/pvt/inventory/items/{itemId}/warehouses/{warehouseId}/dispatched
- "List all supplyLots?" -> GET /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots
- "Update a supplyLot?" -> PUT /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}
- "Create a transfer?" -> POST /api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}/transfer
- "Create a batch?" -> POST /availability/v1/inventory/batch
- "Create a commit?" -> POST /availability/v1/inventory/batch/{batchId}/commit
- "List all status?" -> GET /availability/v1/inventory/batch/{batchId}/status
- "List all errors?" -> GET /availability/v1/inventory/batch/{batchId}/errors
- "Update a holiday?" -> PUT /api/logistics/pvt/configuration/holidays/{holidayId}
- "Get holiday details?" -> GET /api/logistics/pvt/configuration/holidays/{holidayId}
- "Delete a holiday?" -> DELETE /api/logistics/pvt/configuration/holidays/{holidayId}
- "List all holidays?" -> GET /api/logistics/pvt/configuration/holidays
- "Create a reservation?" -> POST /api/logistics/pvt/inventory/reservations
- "Get reservation details?" -> GET /api/logistics/pvt/inventory/reservations/{reservationId}
- "Create a confirm?" -> POST /api/logistics/pvt/inventory/reservations/{reservationId}/confirm
- "Create a acknowledge?" -> POST /api/logistics/pvt/inventory/reservations/{reservationId}/acknowledge
- "Create a cancel?" -> POST /api/logistics/pvt/inventory/reservations/{reservationId}/cancel
- "Get reservation details?" -> GET /api/logistics/pvt/inventory/reservations/{warehouseId}/{skuId}
- "Create a calculate?" -> POST /api/logistics/pvt/shipping/calculate
- "List all pickuppoints?" -> GET /api/logistics/pvt/configuration/pickuppoints
- "Update a pickuppoint?" -> PUT /api/logistics/pvt/configuration/pickuppoints/{pickupPointId}
- "Get pickuppoint details?" -> GET /api/logistics/pvt/configuration/pickuppoints/{pickupPointId}
- "Delete a pickuppoint?" -> DELETE /api/logistics/pvt/configuration/pickuppoints/{pickupPointId}
- "List all _search?" -> GET /api/logistics/pvt/configuration/pickuppoints/_search
- "List all geoshape?" -> GET /api/logistics/pvt/configuration/geoshape
- "Get geoshape details?" -> GET /api/logistics/pvt/configuration/geoshape/{polygonName}
- "Delete a geoshape?" -> DELETE /api/logistics/pvt/configuration/geoshape/{polygonName}
- "List all time-frames?" -> GET /api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames
- "Get time-frame details?" -> GET /api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames/{windowDay}F{windowStartTime}T{windowEndTime}
- "How to authenticate?" -> See Auth section

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- List endpoints may support pagination; check for limit, offset, or cursor params
- Create/update endpoints typically return the created/updated object

## CLI

```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get logistics-api -o references/api-spec.lap

# Search for related APIs
npx @lap-platform/lapsh search logistics-api
```

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)