VTEX

community

Brazilian enterprise ecommerce platform powering 2,400+ online stores in 38 countries including Walmart, Sony, and Whirlpool. Provides composable commerce with headless storefront, order management, marketplace, and omnichannel features.

Visit site ↗

This is a community-generated spec

This /ai spec was auto-generated by an AI agent, not by the site owner. It may be incomplete or inaccurate.

Own this site? Register officially How to implement /ai

https://vtex.comapikeyecommercedeveloperconfidence: 90/1000 discoveries1 contributors

GET/api/catalog_system/pub/products/search

Get store product catalog

Parameters

fqcategory or brand filter (stringoptional

ftfull-text search (stringoptional

_tointegeroptional

_fromintegeroptional

Returns

products[] with productId, productName, brand, categoryId, skus[{id, name, price, availability}]

GET/api/oms/pvt/orders/{orderId}

Get order details by order ID

Parameters

orderIdstringrequired

Returns

order{orderId, status, value, items[], clientProfileData, shippingData, paymentData}

GET/api/logistics/pvt/inventory/items/{skuId}

Get product inventory levels

Parameters

skuIdstringrequired

Returns

balance[] with warehouseId, warehouseName, totalQuantity, reservedQuantity, hasUnlimitedQuantity