Logistics API

Logistics or fulfillment is the process of planning and executing the transportation, storage of merchandise, and shipping orders to customers. You can accomplish all of this with the VTEX platform, which allows you to manage your inventory, shipping rates, pickup points and more.

Common parameters

Parameter name	Description	Type
`{{accountName}}`	Name of the VTEX account. Used as part of the URL.	Server variable.
`{{environment}}`	Environment to use. Used as part of the URL. The default value is `vtexcommercestable`.	Server variable.
`X-VTEX-API-AppKey`	Unique identifier of the API key.	Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`.
`X-VTEX-API-AppToken`	Secret token of the API key.	Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`.
`VtexIdclientAutCookie`	User token, valid for 24 hours.	Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`.

Endpoints

Scheduled delivery

Summary	Method	Path
Retrieve blocked delivery windows	GET	`/api/logistics/pvt/configuration/carriers/{carrierId}/getdayofweekblocked`
Add blocked delivery windows	POST	`/api/logistics/pvt/configuration/carriers/{carrierId}/adddayofweekblocked`
Remove blocked delivery windows	POST	`/api/logistics/pvt/configuration/carriers/{carrierId}/removedayofweekblocked`
Search capacity reservations in time range	GET	`/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames`
Get capacity reservation usage by window	GET	`/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames/{windowDay}F{windowStartTime}T{windowEndTime}`

Shipping policies

Summary	Method	Path
Retrieve shipping policy by ID	GET	`/api/logistics/pvt/shipping-policies/{id}`
Delete shipping policy by ID	DELETE	`/api/logistics/pvt/shipping-policies/{id}`
Update shipping policy by ID	PUT	`/api/logistics/pvt/shipping-policies/{id}`
List shipping policies	GET	`/api/logistics/pvt/shipping-policies`
Create shipping policy	POST	`/api/logistics/pvt/shipping-policies`

Docks

Summary	Method	Path
Create or update dock	POST	`/api/logistics/pvt/configuration/docks`
List all docks	GET	`/api/logistics/pvt/configuration/docks`
List dock by ID	GET	`/api/logistics/pvt/configuration/docks/{dockId}`
Delete dock	DELETE	`/api/logistics/pvt/configuration/docks/{dockId}`
Activate dock	POST	`/api/logistics/pvt/configuration/docks/{dockId}/activation`
Deactivate dock	POST	`/api/logistics/pvt/configuration/docks/{dockId}/deactivation`

Warehouses

Summary	Method	Path
Create or update warehouse	POST	`/api/logistics/pvt/configuration/warehouses`
List all warehouses	GET	`/api/logistics/pvt/configuration/warehouses`
List warehouse by ID	GET	`/api/logistics/pvt/configuration/warehouses/{warehouseId}`
Remove warehouse	DELETE	`/api/logistics/pvt/configuration/warehouses/{warehouseId}`
Activate warehouse	POST	`/api/logistics/pvt/configuration/warehouses/{warehouseId}/activation`
Deactivate warehouse	POST	`/api/logistics/pvt/configuration/warehouses/{warehouseId}/deactivation`

Inventory

Summary	Method	Path
List inventory by SKU	GET	`/api/logistics/pvt/inventory/skus/{skuId}`
List inventory by SKU per warehouse	GET	`/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}`
Update inventory by SKU and warehouse	PUT	`/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}`
Update inventory quantity by SKU and warehouse	PATCH	`/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}/quantity`
Update inventory lead time by SKU and warehouse	PATCH	`/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}/lead-time`
List inventory per dock	GET	`/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}`
List inventory per dock and warehouse	GET	`/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}/warehouses/{warehouseId}`
List inventory with dispatched reservations	GET	`/api/logistics/pvt/inventory/items/{itemId}/warehouses/{warehouseId}/dispatched`
List supply lots	GET	`/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots`
Save supply lot	PUT	`/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}`
Transfer supply lot	POST	`/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}/transfer`

Batch operations

Summary	Method	Path
Create batch inventory job	POST	`/availability/v1/inventory/batch`
Confirm batch inventory	POST	`/availability/v1/inventory/batch/{batchId}/confirm`
Get batch inventory status	GET	`/availability/v1/inventory/batch/{batchId}/status`
Get batch inventory errors	GET	`/availability/v1/inventory/batch/{batchId}/errors`

Holidays

Summary	Method	Path
Create or update holiday	PUT	`/api/logistics/pvt/configuration/holidays/{holidayId}`
List holiday by ID	GET	`/api/logistics/pvt/configuration/holidays/{holidayId}`
Delete holiday	DELETE	`/api/logistics/pvt/configuration/holidays/{holidayId}`
List all holidays	GET	`/api/logistics/pvt/configuration/holidays`

Reservations

Summary	Method	Path
Create reservation	POST	`/api/logistics/pvt/inventory/reservations`
List reservation by ID	GET	`/api/logistics/pvt/inventory/reservations/{reservationId}`
Confirm reservation	POST	`/api/logistics/pvt/inventory/reservations/{reservationId}/confirm`
Acknowledgment reservation	POST	`/api/logistics/pvt/inventory/reservations/{reservationId}/acknowledge`
Cancel reservation	POST	`/api/logistics/pvt/inventory/reservations/{reservationId}/cancel`
List reservation by warehouse and SKU	GET	`/api/logistics/pvt/inventory/reservations/{warehouseId}/{skuId}`

SLA

Summary	Method	Path
Calculate SLA	POST	`/api/logistics/pvt/shipping/calculate`

Pickup points

Summary	Method	Path
List pickup points	GET	`/api/logistics/pvt/configuration/pickuppoints`
Create or update pickup point	PUT	`/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}`
List pickup point by ID	GET	`/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}`
Delete pickup point	DELETE	`/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}`
List paged pickup points	GET	`/api/logistics/pvt/configuration/pickuppoints/_search`

Polygons

Summary	Method	Path
List paged polygons	GET	`/api/logistics/pvt/configuration/geoshape`
Create or update polygon	PUT	`/api/logistics/pvt/configuration/geoshape`
List polygon by ID	GET	`/api/logistics/pvt/configuration/geoshape/{polygonName}`
Delete polygon	DELETE	`/api/logistics/pvt/configuration/geoshape/{polygonName}`

Freight values

Summary	Method	Path
Create or update freight values	POST	`/api/logistics/pvt/configuration/freights/{carrierId}/values/update`
List freight values	GET	`/api/logistics/pvt/configuration/freights/{carrierId}/{postalcode}/values`