APIHub
Back to Explore

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

Uncategorized
apiKeyHeader
HTTPS
CORS: Unknown
Visit official documentation

Latency

9ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
POST

/api/logistics/pvt/configuration/carriers/{carrierId}/removedayofweekblocked

Remove blocked delivery windows

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • carrierId (path, required)
GET

/api/logistics/pvt/configuration/carriers/{carrierId}/getdayofweekblocked

Retrieve blocked delivery windows

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • carrierId (path, required)
GET

/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames

Search capacity reservations in time range

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • capacityType (path, required) — How the delivery capacity is measured as defined in the shipping policy. Capacity can be measured by maximum number of orders (`"orders_quantity"`) or SKUs (`"skus_quantity"`).
  • shippingPolicyId (path, required) — ID of shipping policy to search.
  • rangeStart (query, required) — Starting date of time range
  • rangeEnd (query, required) — End date of time range.
GET

/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames/{windowDay}F{windowStartTime}T{windowEndTime}

Get capacity reservation usage by window

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • capacityType (path, required) — How the delivery capacity is measured as defined in the shipping policy. Capacity can be measured by maximum number of orders (`"orders_quantity"`) or SKUs (`"skus_quantity"`).
  • shippingPolicyId (path, required) — ID of shipping policy to search.
  • windowDay (path, required) — Day of the specific scheduled delivery window to be consulted for reservations.
  • windowStartTime (path, required) — Start time of specific scheduled delivery window to be consulted for reservations.
  • windowEndTime (path, required) — End time of specific scheduled delivery window to be consulted for reservations.
POST

/api/logistics/pvt/configuration/carriers/{carrierId}/adddayofweekblocked

Add blocked delivery windows

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • carrierId (path, required)
GET

/api/logistics/pvt/configuration/docks

List all docks

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
POST

/api/logistics/pvt/configuration/docks

Create/update dock

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
DELETE

/api/logistics/pvt/configuration/docks/{dockId}

Delete dock

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • dockId (path, required)
GET

/api/logistics/pvt/configuration/docks/{dockId}

List dock by ID

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • dockId (path, required)
POST

/api/logistics/pvt/configuration/docks/{dockId}/activation

Activate dock

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • dockId (path, required)
POST

/api/logistics/pvt/configuration/docks/{dockId}/deactivation

Deactivate dock

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • dockId (path, required)
POST

/api/logistics/pvt/configuration/freights/{carrierId}/values/update

Create/update freight values

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • carrierId (path, required)
GET

/api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values

List freight values

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • carrierId (path, required) — Carrier ID
  • cep (path, required) — Postal code.
GET

/api/logistics/pvt/configuration/geoshape

List paged polygons

  • page (query, required, page)
  • perPage (query, required, limit)
  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
PUT

/api/logistics/pvt/configuration/geoshape

Create/update polygon

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
DELETE

/api/logistics/pvt/configuration/geoshape/{polygonName}

Delete polygon

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • polygonName (path, required)
GET

/api/logistics/pvt/configuration/geoshape/{polygonName}

List polygon by ID

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • polygonName (path, required)
GET

/api/logistics/pvt/configuration/holidays

List all holidays

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
DELETE

/api/logistics/pvt/configuration/holidays/{holidayId}

Delete holiday

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • holidayId (path, required)
GET

/api/logistics/pvt/configuration/holidays/{holidayId}

List holiday by ID

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • holidayId (path, required)
PUT

/api/logistics/pvt/configuration/holidays/{holidayId}

Create/update holiday

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • Content-Type (header, required) — Type of the content being sent
  • holidayId (path, required)
GET

/api/logistics/pvt/configuration/pickuppoints

List all pickup points

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
GET

/api/logistics/pvt/configuration/pickuppoints/_search

List paged Pickup Points

  • page (query, required, page)
  • pageSize (query, required, limit)
  • keyword (query, required)
  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
DELETE

/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}

Delete Pickup Point

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • pickupPointId (path, required)
GET

/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}

List Pickup Point By ID

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • pickupPointId (path, required)
DELETE

/api/logistics/pvt/shipping-policies/{id}

Delete shipping policies by ID

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • Content-Type (header, required) — Type of the content being sent
  • id (path, required) — ID of the shipping policy.
PUT

/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}

Create/Update Pickup Point

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • pickupPointId (path, required) — Pickup Point ID. Cannot contain spaces.
GET

/api/logistics/pvt/configuration/warehouses

List all warehouses

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
POST

/api/logistics/pvt/configuration/warehouses

Create/update warehouse

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • Content-Type (header, required) — Type of the content being sent
DELETE

/api/logistics/pvt/configuration/warehouses/{warehouseId}

Remove warehouse

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • warehouseId (path, required)
GET

/api/logistics/pvt/configuration/warehouses/{warehouseId}

List warehouse by ID

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • warehouseId (path, required)
POST

/api/logistics/pvt/configuration/warehouses/{warehouseId}/activation

Activate warehouse

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • warehouseId (path, required)
POST

/api/logistics/pvt/configuration/warehouses/{warehouseId}/deactivation

Deactivate warehouse

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • warehouseId (path, required)
GET

/api/logistics/pvt/inventory/items/{itemId}/warehouses/{warehouseId}/dispatched

List inventory with dispatched reservations

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • itemId (path, required)
  • warehouseId (path, required)
PUT

/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}

Update inventory by SKU and warehouse

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
  • Content-Type (header, required) — Type of the content being sent.
  • skuId (path, required)
  • warehouseId (path, required)
GET

/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}

List inventory per dock

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • skuId (path, required)
  • dockId (path, required)
GET

/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}/warehouses/{warehouseId}

List inventory per dock and warehouse

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • skuId (path, required)
  • dockId (path, required)
  • warehouseId (path, required)
GET

/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}

List inventory per warehouse

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • skuId (path, required)
  • warehouseId (path, required)
GET

/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots

List supply lots

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
  • Content-Type (header, required) — Type of the content being sent.
  • skuId (path, required) — ID of the SKU.
  • warehouseId (path, required) — ID of the warehouse where the SKU is located.
PUT

/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}

Save supply lot

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • Content-Type (header, required) — Type of the content being sent
  • skuId (path, required) — ID of the SKU whose availability is being scheduled.
  • warehouseId (path, required) — ID of the warehouse where the SKU will arrive.
  • supplyLotId (path, required) — ID of the Supply Lot in which the SKU's scheduling should be considered.
POST

/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}/transfer

Transfer supply lot

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • Content-Type (header, required) — Type of the content being sent
  • skuId (path, required) — ID of the SKU.
  • warehouseId (path, required) — ID of the warehouse where the SKU is located.
  • supplyLotId (path, required) — ID of the Supply Lot in which the SKU is currently located and from where it will be transfered.
GET

/api/logistics/pvt/shipping-policies

List shipping policies

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • Content-Type (header, required) — Type of the content being sent
  • page (query, required, page) — Desired number of pages to retrieve information from your Shipping Policies.
  • perPage (query, required, limit) — Desired number of items per page, to retrieve information from your Shipping Policies.
POST

/api/logistics/pvt/shipping-policies

Create shipping policy

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • Content-Type (header, required) — Type of the content being sent
POST

/api/logistics/pvt/inventory/reservations

Create reservation

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
  • Content-Type (header, required) — Type of the content being sent.
GET

/api/logistics/pvt/inventory/reservations/{reservationId}

List reservation by ID

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • reservationId (path, required)
POST

/api/logistics/pvt/inventory/reservations/{reservationId}/acknowledge

Acknowledgment reservation

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • reservationId (path, required)
POST

/api/logistics/pvt/inventory/reservations/{reservationId}/cancel

Cancel reservation

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • reservationId (path, required)
POST

/api/logistics/pvt/inventory/reservations/{reservationId}/confirm

Confirm reservation

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • reservationId (path, required)
GET

/api/logistics/pvt/inventory/reservations/{warehouseId}/{skuId}

List reservation by warehouse and SKU

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • warehouseId (path, required)
  • skuId (path, required)
GET

/api/logistics/pvt/inventory/skus/{skuId}

List inventory by SKU

  • Content-Type (header, required) — Type of the content being sent
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • skuId (path, required)
GET

/api/logistics/pvt/shipping-policies/{id}

Retrieve shipping policy by ID

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • Content-Type (header, required) — Type of the content being sent
  • id (path, required) — ID of the shipping policy.
PUT

/api/logistics/pvt/shipping-policies/{id}

Update shipping policy

  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand
  • Content-Type (header, required) — Type of the content being sent
  • id (path, required) — Shipping policy's ID
POST

/api/logistics/pvt/shipping/calculate

Calculate SLA

  • Content-Type (header, required) — Type of the content being sent.
  • Accept (header, required) — HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

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