vtex.local

>ℹ️ Check the new Checkout onboarding guide. We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Checkout and is organized by focusing o

🔑 apikey 32 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

Get client profile by email

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/checkout/pub/profiles

Get current or create a new cart

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/checkout/pub/orderForm

List pickup points by location

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/checkout/pub/pickup-points

Endpoints (32 total)

GET

/api/checkout/pub/profiles

Get client profile by email

GET

/api/checkout/pub/orderForm

Get current or create a new cart

GET

/api/checkout/pub/pickup-points

List pickup points by location

GET

/api/checkout/pub/regions/{regionId}

Get sellers by region or address

GET

/api/checkout/pub/orderForm/{orderFormId}

Get cart information by ID

GET

/api/checkout/pvt/configuration/orderForm

Get orderForm configuration

GET

/checkout/changeToAnonymousUser/{orderFormId}

Remove all personal data

GET

/api/checkout/pub/orderForm/{orderFormId}/installments

Cart installments

GET

/api/checkout/pvt/configuration/window-to-change-seller

Get window to change seller

GET

/api/checkout/pub/postal-code/{countryCode}/{postalCode}

Get address by postal code

POST

/api/checkout/pub/orderForms/simulation

Cart simulation

POST

/api/checkout/pvt/configuration/orderForm

Update orderForm configuration