Logistics API
>Check the [Fulfillment onboarding guide](https://developers.vtex.com/docs/guides/fulfillment). We created this guide to improve the onboarding experience for…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
>Check the Fulfillment onboarding guide. 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 management.
The variable {{environment}} can be filled with vtexcommercestable or vtexcommercebeta, depending on the environment you want to test.
Endpoints 53
Scheduled Delivery
- GETSearch capacity reservations in time range
/api/logistics-capacity/resources/carrier@:capacityType@:shippingPolicyId/time-frames?rangeStart=yyyy-mm-dd&rangeEnd=yyyy-mm-ddGet information on all capacity reservations made to scheduled delivery windows in a given time range. > Note that, while most of our API endpoints return… - GETGet capacity reservation usage by window
/api/logistics-capacity/resources/carrier@:capacityType@:shippingPolicyId/time-frames/:windowDayF:windowStartTimeT:windowEndTimeRetrieves capacity usage of a specific scheduled delivery reservation window. > Note that, while most of our API endpoints return time fields in UTC, this… - POSTAdd blocked delivery windows
/api/logistics/pvt/configuration/carriers/:carrierId/adddayofweekblockedAdds blocked delivery windows for your store's shipping policies. > Note that, while most of our API endpoints return time fields in UTC, this endpoint… - GETRetrieve blocked delivery windows
/api/logistics/pvt/configuration/carriers/:carrierId/getdayofweekblockedLists all blocked delivery windows of your store's shipping policies, searching by carrier ID. > Note that, while most of our API endpoints return time fields… - POSTRemove blocked delivery windows
/api/logistics/pvt/configuration/carriers/:carrierId/removedayofweekblockedRemoves the blocked delivery windows set to your store's shipping policies. > Note that, while most of our API endpoints return time fields in UTC, this…
Shipping Policies
- GETList shipping policies
/api/logistics/pvt/shipping-policies?page=page&perPage=perPageThis endpoint lists existing shipping policies from carriers in your store. > Note that, while most of our API endpoints return time fields in UTC, this… - POSTCreate shipping policy
/api/logistics/pvt/shipping-policiesThis endpoint creates new shipping policies from carriers in your store. > Note that, while most of our API endpoints return time fields in UTC, this endpoint… - GETRetrieve shipping policy by ID
/api/logistics/pvt/shipping-policies/:idThis endpoint lists existing shipping policies from carriers in your store, searching by their IDs. > Note that, while most of our API endpoints return time… - PUTUpdate shipping policy
/api/logistics/pvt/shipping-policies/:idThis endpoint updates information on existing Shipping Policies from carriers. > Note that, while most of our API endpoints return time fields in UTC, this… - DELETEDelete shipping policies by ID
/api/logistics/pvt/shipping-policies/:idThis endpoint deletes existing shipping policies from carriers in your store, searching by their IDs.
Docks
- GETList all docks
/api/logistics/pvt/configuration/docksInforms a list of all docks. - POSTCreate/update dock
/api/logistics/pvt/configuration/docksCreates or updates docks to be used in your logistic operation. - GETList dock by ID
/api/logistics/pvt/configuration/docks/:dockIdInforms a given dock's information, searching by dock ID. - DELETEDelete dock
/api/logistics/pvt/configuration/docks/:dockIdDeletes dock by dock ID. - POSTActivate dock
/api/logistics/pvt/configuration/docks/:dockId/activationActivates dock through dock ID. - POSTDeactivate dock
/api/logistics/pvt/configuration/docks/:dockId/deactivationDeactivate dock by dock ID
Warehouses
- GETList all warehouses
/api/logistics/pvt/configuration/warehousesLists information about all warehouses set up in your store. - POSTCreate/update warehouse
/api/logistics/pvt/configuration/warehousesCreates or updates your store's warehouses - GETList warehouse by ID
/api/logistics/pvt/configuration/warehouses/:warehouseIdLists the information of a given warehouse, searching by warehouse ID. - DELETERemove warehouse
/api/logistics/pvt/configuration/warehouses/:warehouseIdDeletes given warehouse by warehouse ID. - POSTActivate warehouse
/api/logistics/pvt/configuration/warehouses/:warehouseId/activationActivates a given warehouse, by warehouse ID. - POSTDeactivate warehouse
/api/logistics/pvt/configuration/warehouses/:warehouseId/deactivationDeactivates a given warehouse by warehouse ID.
Inventory
- GETList inventory with dispatched reservations
/api/logistics/pvt/inventory/items/:itemId/warehouses/:warehouseId/dispatchedLists inventory with dispatched reservations. When the number of active reservations is more than 2000 the return is an error with status code 400… - GETList inventory per dock
/api/logistics/pvt/inventory/items/:skuId/docks/:dockIdLists inventory information per dock set up in your store. - GETList inventory per dock and warehouse
/api/logistics/pvt/inventory/items/:skuId/docks/:dockId/warehouses/:warehouseIdLists information of inventory per dock and warehouse. - GETList inventory per warehouse
/api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseIdLists inventory information per warehouse on your store. - GETList supply lots
/api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseId/supplyLotsReturns a list of the supply lots of an SKU in a specific warehouse. - PUTSave supply lot
/api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseId/supplyLots/:supplyLotIdCreates a new Supply Lot. A Supply Lot lets the store sell products that are not currently available in stock but whose arrival is already scheduled. Check… - POSTTransfer supply lot
/api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseId/supplyLots/:supplyLotId/transferTransfers an SKU from a Supply Lot to the currently available inventory. Check out how this transfer works in further detail by reading our documentation… - GETList inventory by SKU
/api/logistics/pvt/inventory/skus/:skuIdLists your store's inventory by SKU ID - PUTUpdate inventory by SKU and warehouse
/api/logistics/pvt/inventory/skus/:skuId/warehouses/:warehouseIdUpdates inventory for a given SKU and warehouse.
Holidays
- GETList all holidays
/api/logistics/pvt/configuration/holidaysLists information of all holidays. - GETList holiday by ID
/api/logistics/pvt/configuration/holidays/:holidayIdLists holiday's information by holiday ID. - PUTCreate/update holiday
/api/logistics/pvt/configuration/holidays/:holidayIdCreates or updates holidays through holiday ID. - DELETEDelete holiday
/api/logistics/pvt/configuration/holidays/:holidayIdDeletes given holidays set up in your store.
Reservations
- POSTCreate reservation
/api/logistics/pvt/inventory/reservationsCreates reservation. - GETList reservation by ID
/api/logistics/pvt/inventory/reservations/:reservationIdLists reservation's information by ID. - POSTAcknowledgment reservation
/api/logistics/pvt/inventory/reservations/:reservationId/acknowledgeAcknowledges reservations made by reservation ID. - POSTCancel reservation
/api/logistics/pvt/inventory/reservations/:reservationId/cancelCancels reservation by reservation ID. - POSTConfirm reservation
/api/logistics/pvt/inventory/reservations/:reservationId/confirmConfirms reservation by reservation ID. - GETList reservation by warehouse and SKU
/api/logistics/pvt/inventory/reservations/:warehouseId/:skuIdLists reservations in your store, by searching through warehouse and SKU.
SLA
- POSTCalculate SLA
/api/logistics/pvt/shipping/calculateEndpoint used by the checkout to calculate the Service Level Agreement (SLA), a contract between the store and shoppers on the order's fulfillment conditions,…
Polygons
- GETList paged polygons
/api/logistics/pvt/configuration/geoshape?page={{page}}&perPage={{perPage}}Lists stored polygons. - PUTCreate/update polygon
/api/logistics/pvt/configuration/geoshapeCreates or updates your store's polygons by geoshape coordinates and polygon name. - GETList polygon by ID
/api/logistics/pvt/configuration/geoshape/:polygonNameLists your store's polygons by searching through polygon name - DELETEDelete polygon
/api/logistics/pvt/configuration/geoshape/:polygonNameDeletes polygon set up in your store, by polygon name.
Freight Values
- POSTCreate/update freight values
/api/logistics/pvt/configuration/freights/:carrierId/values/updateCreates or updates the freight values of your store's carriers. Learn more in Shipping rate template. - GETList freight values
/api/logistics/pvt/configuration/freights/:carrierId/:cep/valuesLists freight values apointed to your store's carriers, searching by carrier ID and postal code (cep).
Pickup points
- GETList all pickup points
/api/logistics/pvt/configuration/pickuppointsLists all of your store's pickup points. - GETList paged Pickup Points
/api/logistics/pvt/configuration/pickuppoints/_search?page={{pageNumber}}&pageSize={{pageSize}}&keyword=Lists paged pickup points in your store. - GETList Pickup Point By ID
/api/logistics/pvt/configuration/pickuppoints/:pickupPointIdLists your store's pickup points while searching by ID. - PUTCreate/Update Pickup Point
/api/logistics/pvt/configuration/pickuppoints/:pickupPointIdCreates or updates pickup points in your store by Pickup Point ID. - DELETEDelete Pickup Point
/api/logistics/pvt/configuration/pickuppoints/:pickupPointIdDeletes a given pickup point for your store, by pickup point ID.
API details
- Base URL
https://vtex.localhttps://{accountName}.{environment}.com.br- Authentication
- An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header - Operations
- 53 operations on 40 pathsGET 25POST 16PUT 6DELETE 6
- Main resources
- Inventory 9Docks 6Reservations 6Warehouses 6Pickup points 5Scheduled Delivery 5Shipping Policies 5Holidays 4Polygons 4Freight Values 2
- Response formats
application/json; charset=utf-8application/json- Description format
- OpenAPI 3.0.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Logistics API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Logistics API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Search capacity reservations in time range” (GET /api/logistics-capacity/resources/carrier@:capacityType@:shippingPolicyId/time-frames?rangeStart=yyyy-mm-dd&rangeEnd=yyyy-mm-dd), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Logistics API?
>Check the [Fulfillment onboarding guide](https://developers.vtex.com/docs/guides/fulfillment). We created this guide to improve the onboarding experience for… It is listed under Other and has 53 endpoints.
Who publishes the Logistics API?
It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Logistics API?
Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Logistics API?
It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.
How many endpoints does the Logistics API have?
53 operations on 40 paths (25 GET, 16 POST, 6 PUT, 6 DELETE). The largest groups are Inventory, Docks, Reservations, Warehouses.
Is forking the Logistics API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.