vtex.local

>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 develope

🔑 apikey 53 endpoints

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

lever-sdk ✓ Official

npm install lever-sdk

GitHub integration →

ads-js ✓ Official

npm install ads-js

GitHub integration →

vtex-node-sdk

npm install vtex-node-sdk

GitHub integration →

physical-payments-sdk ✓ Official

# Maven: see https://github.com/vtex-apps/physical-payments-sdk

GitHub integration →

VTEX-SDK-dotnet

dotnet add package VTEX-SDK-dotnet

GitHub integration →

vtex-sdk

composer require vtex-sdk

GitHub integration →

vtex-sdk-php

composer require vtex-sdk-php

GitHub integration →

vtex-api

composer require vtex-api

GitHub integration →

vtex-kotlin-sdk

# See https://github.com/ksetoue/vtex-kotlin-sdk

GitHub integration →

vtex.js ✓ Official

# See https://github.com/vtex/vtex.js

GitHub integration →

curl examples

List shipping policies

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/logistics/pvt/shipping-policies

List all docks

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/logistics/pvt/configuration/docks

List paged polygons

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/logistics/pvt/configuration/geoshape

Endpoints (53 total)

GET

/api/logistics/pvt/shipping-policies

List shipping policies

GET

/api/logistics/pvt/configuration/docks

List all docks

GET

/api/logistics/pvt/configuration/geoshape

List paged polygons

GET

/api/logistics/pvt/configuration/holidays

List all holidays

GET

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

List inventory by SKU

GET

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

Retrieve shipping policy by ID

GET

/api/logistics/pvt/configuration/warehouses

List all warehouses

GET

/api/logistics/pvt/configuration/pickuppoints

List all pickup points

GET

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

List dock by ID

GET

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

List holiday by ID

GET

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

List paged Pickup Points

GET

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

List polygon by ID