VTEXPY

Unofficial VTEX API's Python SDK

VTEXPY is an unofficial Python SDK designed to facilitate integration with the VTEX API.

Even though it is still tagged as beta, vtexpy has been in use by a SaaS company in a production environment for over a year, making millions of requests a day to the VTEX API. The only reason why it is tagged as beta is that it is still under heavy development and breaking changes are expected on the external API.

Features

Easy to use Python interface for calling VTEX API endpoints
Response format standardization
Custom exception handling
Automatic request retrying
Request logging

Getting Started

Requirements

Python >= 3.9, < 3.14

Installation

pip install vtexpy

Usage

If the API you want to call is not yet implemented, feel free to create an issue on the VTEXPY Github repository and request it to be added.

from vtex import VTEX, VTEXConfig

# Instantiate your VTEX API configuration:
vtex_config = VTEXConfig(
    account_name="<ACCOUNT_NAME>",
    app_key="<APP_KEY>",
    app_token="<APP_TOKEN>",
    # Other arguments such as: retrying, logging, etc...
)

# Instantiate the VTEX client with your configuration:
vtex_client = VTEX(config=vtex_config)

# Call one of the available APIs, e.g.:
account_response = vtex_client.license_manager.get_account()
list_sku_ids_response = vtex_client.catalog.list_sku_ids(page=1, page_size=1000)
list_orders_response = vtex_client.orders.list_orders(page=1, page_size=100)

# If the API you want to call is not yet implemented you can use the `custom` API.
response = vtex_client.custom.request(
    method="GET",
    environment="vtexcommercestable",
    endpoint="/api/catalog_system/pvt/commercialcondition/list",
    # Other arguments such as: query params, headers, json data, response class, etc...
)

Metadata

Release files for vtexpy 0.0.0b47

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vtexpy 0.0.0b47
File	Size	Uploaded
vtexpy-0.0.0b47.tar.gz	86.4 kB	Aug 7, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for vtexpy 0.0.0b47
File	Interpreter	ABI	Platform	Reset
vtexpy-0.0.0b47-py3-none-any.whl 31.5 kB Aug 7, 2026	Python 3	none	any	Details

Total release size: 117.9 kB

Release files / vtexpy-0.0.0b47.tar.gz

Download URL	vtexpy-0.0.0b47.tar.gz
Size	86.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`799a50a3852e2f2650ab9961ad22efabaf332233c22f4c92ca25e1ff1d063702`
BLAKE2b-256 checksum How to use checksums	`f91eb44a131c8599860de804cfbcb3bdaeeed538e2b99258331e320aa08ea0ca`
Upload date	Aug 7, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}`

Release files / vtexpy-0.0.0b47-py3-none-any.whl

Download URL	vtexpy-0.0.0b47-py3-none-any.whl
Size	31.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`edef401de9b6159e3427468d769552a092123f77422fb6c645e6abcd2cb884e0`
BLAKE2b-256 checksum How to use checksums	`e75522d1872bb89beae5f88c377d474216c3bef5da0cf203d4ae491c8f365283`
Upload date	Aug 7, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}`