vtex.local

Create shopper profiles and manage their information.

🔑 apikey 27 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 profile

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/storage/profile-system/profiles/{profileId}

Get prospect

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/storage/profile-system/prospects/{prospectId}

Get unmasked profile

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/storage/profile-system/profiles/{profileId}/unmask

Endpoints (27 total)

GET

/api/storage/profile-system/profiles/{profileId}

Get profile

GET

/api/storage/profile-system/prospects/{prospectId}

Get prospect

GET

/api/storage/profile-system/profiles/{profileId}/unmask

Get unmasked profile

GET

/api/storage/profile-system/prospects/{prospectId}/unmask

Get unmasked prospect

GET

/api/storage/profile-system/profiles/{profileId}/addresses

Get client addresses

GET

/api/storage/profile-system/profiles/{profileId}/purchase-info

Get purchase information

GET

/api/storage/profile-system/profiles/{profileId}/addresses/unmask

Get unmasked client addresses

GET

/api/storage/profile-system/profiles/{profileId}/purchase-info/unmask

Get unmasked purchase information

GET

/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}

Get address

GET

/api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}

Get profile by version

GET

/api/storage/profile-system/profiles/{profileId}/addresses/{addressId}/unmask

Get unmasked address

GET

/api/storage/profile-system/profiles/{profileId}/versions/{profileVersionId}/unmask

Get unmasked profile by version