Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| VTEX_APP_KEY | Yes | Your VTEX App Key | |
| VTEX_APP_TOKEN | Yes | Your VTEX App Token | |
| VTEX_ENVIRONMENT | No | VTEX environment (usually vtexcommercestable) | vtexcommercestable |
| VTEX_ACCOUNT_NAME | Yes | Your VTEX account name |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| vtex_create_product | Create a new product in VTEX catalog |
| vtex_get_product | Get product details by ID |
| vtex_update_product | Update an existing product |
| vtex_delete_product | Delete a product |
| vtex_list_products | List products with pagination |
| vtex_create_sku | Create a new SKU for a product |
| vtex_get_sku | Get SKU details by ID |
| vtex_get_sku_by_refid | Get SKU details by reference ID |
| vtex_update_sku | Update an existing SKU |
| vtex_list_skus | List SKUs, optionally filtered by product |
| vtex_create_category | Create a new category |
| vtex_get_category | Get category details by ID |
| vtex_update_category | Update an existing category |
| vtex_delete_category | Delete a category |
| vtex_list_categories | List all categories in a tree structure |
| vtex_create_brand | Create a new brand |
| vtex_get_brand | Get brand details by ID |
| vtex_update_brand | Update an existing brand |
| vtex_delete_brand | Delete a brand |
| vtex_list_brands | List all brands |
| vtex_get_price | Get price information for a SKU |
| vtex_create_or_update_price | Create or update price for a SKU |
| vtex_delete_price | Delete price for a SKU |
| vtex_list_prices | List all prices with pagination |
| vtex_get_computed_price | Get computed price for a SKU (includes promotions and taxes) |
| vtex_get_inventory | Get inventory information for a SKU |
| vtex_update_inventory | Update inventory quantity for a SKU in a warehouse |
| vtex_list_inventory_by_warehouse | List all inventory items in a warehouse |
| vtex_create_warehouse | Create a new warehouse |
| vtex_get_warehouse | Get warehouse details by ID |
| vtex_list_warehouses | List all warehouses |
| vtex_update_warehouse | Update an existing warehouse |
| vtex_delete_warehouse | Delete a warehouse |
| vtex_create_dock | Create a new dock (loading dock) |
| vtex_get_dock | Get dock details by ID |
| vtex_list_docks | List all docks |
| vtex_update_dock | Update an existing dock |
| vtex_delete_dock | Delete a dock |
| vtex_create_promotion | Create a new promotion |
| vtex_get_promotion | Get promotion details by ID |
| vtex_list_promotions | List all promotions |
| vtex_update_promotion | Update an existing promotion |
| vtex_archive_promotion | Archive a promotion |
| vtex_unarchive_promotion | Unarchive a promotion |
| vtex_create_coupon | Create a new coupon |
| vtex_get_coupon | Get coupon details by code |
| vtex_list_coupons | List all coupons |
| vtex_archive_coupon | Archive a coupon |
| vtex_get_order | Get order details by ID |
| vtex_list_orders | List orders with filters |
| vtex_start_handling | Start handling an order (change status to handling) |
| vtex_cancel_order | Cancel an order |
| vtex_invoice_order | Add invoice to an order |
| vtex_create_document | Create a document in Master Data entity |
| vtex_get_document | Get a document from Master Data |
| vtex_update_document | Update a Master Data document |
| vtex_delete_document | Delete a Master Data document |
| vtex_search_documents | Search documents in Master Data |
| vtex_get_client_by_email | Get client data by email |
| vtex_search_products | Search products in catalog |
| vtex_get_product_by_identifier | Get product by ID, EAN, Reference ID, or SKU |
| vtex_get_product_and_sku_ids | Get all product and SKU IDs (useful for indexing) |
| vtex_get_facets | Get facets and filters for search |
| vtex_autocomplete | Get autocomplete suggestions for search |
| vtex_update_review | Update a review |
| vtex_approve_review | Approve a review for display |
| vtex_get_review_summary | Get review summary and rating statistics for a product |
| vtex_list_payment_providers | List all payment providers/gateways |
| vtex_get_payment_provider | Get payment provider configuration |
| vtex_create_payment_provider | Create a payment provider configuration |
| vtex_update_payment_provider | Update payment provider configuration |
| vtex_delete_payment_provider | Delete a payment provider |
| vtex_get_transaction | Get transaction details |
| vtex_get_segment | Get segment data (campaigns, UTM, location) |
| vtex_create_gift_card | Create a new gift card |
| vtex_get_gift_card | Get gift card by ID |
| vtex_list_gift_cards | List all gift cards |
| vtex_get_gift_card_by_code | Search gift card by redemption code |
| vtex_create_gift_card_transaction | Add transaction to gift card (credit or debit) |
| vtex_list_email_templates | List all email templates |
| vtex_get_email_template | Get email template by ID |
| vtex_create_email_template | Create an email template |
| vtex_update_email_template | Update an email template |
| vtex_send_email | Send an email using template |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |