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.

Logistics API Index

Shipping Policies

• GET Retrieve shipping policy by ID
• DELETE Delete shipping policies by ID
• PUT Update shipping policy
• GET List shipping policies
• POST Create shipping policy

Freight Values

• POST Create/update freight values
• GET List freight values

Scheduled Delivery

• GET Retrieve blocked delivery windows
• POST Add blocked delivery windows
• POST Remove blocked delivery windows
• GET Search capacity reservations in time range
• GET Get capacity reservation usage by window

Docks

• POST Create/update dock
• GET List all docks
• GET List dock by ID
• DELETE Delete dock
• POST Activate dock
• POST Deactivate dock

Warehouses

• POST Create/update warehouse
• GET List all warehouses
• GET List warehouse by ID
• DELETE Remove warehouse
• POST Activate warehouse
• POST Deactivate warehouse

Inventory

• GET List inventory by SKU
• GET List inventory per warehouse
• PUT Update inventory by SKU and warehouse
• PATCH Update inventory quantity by SKU and warehouse
• PATCH Update inventory lead time by SKU and warehouse
• GET List inventory per dock
• GET List inventory per dock and warehouse
• GET List inventory with dispatched reservations
• GET List supply lots
• PUT Save supply lot
• POST Transfer supply lot

Batch operations

This feature is in early access, which means that we are working to improve it. If you want to use this feature, please contact our Support Center.

• POST Create batch inventory job
• POST Commit batch inventory
• GET Get batch inventory status
• GET Get batch inventory errors

Holidays

• PUT Create/update holiday
• GET List holiday by ID
• DELETE Delete holiday
• GET List all holidays

Reservations

• POST Create reservation
• GET List reservation by ID
• POST Confirm reservation
• POST Acknowledgment reservation
• POST Cancel reservation
• GET List reservation by warehouse and SKU

SLA

• POST Calculate SLA

Pickup points

• GET List pickup points
• PUT Create/Update Pickup Point
• GET List Pickup Point By ID
• DELETE Delete Pickup Point
• GET List paged Pickup Points

Polygons

• GET List paged polygons
• PUT Create/update polygon
• GET List polygon by ID
• DELETE Delete polygon

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.