Bring Online Store
to Windsurf

You must provide the coupon code and type (percentage, absolute, or shipping). Optional fields include value, validity dates, minimum purchase amount, and applicable products/categories. Example: { "code": "SUMMER20", "type": "percentage", "value": 20, "min_price": 100, "start_date": "2026-06-01", "end_date": "2026-06-30" } Create a new discount coupon in your Nuvemshop store

You must provide at minimum the customer name and email. Optional fields include phone, addresses, and tags. Example: { "first_name": "João", "last_name": "Silva", "email": "joao@example.com", "phone": "11999999999" } Create a new customer record in your Nuvemshop store

Useful for phone orders, in-person sales, or bulk order imports. You must provide customer information and at least one order item with product ID or variant ID and quantity. Example: { "email": "customer@example.com", "items": [{ "product_id": 123, "quantity": 2 }] } Create a new order manually in your Nuvemshop store

You must provide at minimum the product name and price. Optional fields include description, SKU, stock quantity, categories, images, and variants. Example: { "name": "T-Shirt Blue", "price": 49.90, "sku": "TSH-BLU-001", "stock": 100, "description": "Comfortable cotton t-shirt" } Create a new product in your Nuvemshop store

You must provide the URL to receive notifications and the events to subscribe to. Available events include: orders/create, orders/update, products/create, products/update, products/delete, customers/create, customers/update. Example: { "url": "https://your-app.com/webhooks/nuvemshop", "event": "orders/create" } Create a new webhook for real-time event notifications

You must provide the coupon_id. This action cannot be undone. Use this to deactivate expired or discontinued promotions. Be careful as this will prevent customers from using this coupon code. Delete a discount coupon from your Nuvemshop store

You must provide the product_id. This action cannot be undone. Use this to remove discontinued products, test products, or items that are no longer available. Be careful as this will also remove all associated variants and images for that product. Delete a product from your Nuvemshop store

You must provide the webhook_id. This action cannot be undone. Use this to remove webhook endpoints that are no longer needed or to stop receiving notifications for specific events. Delete a webhook from your Nuvemshop store

Use the coupon_id obtained from list_coupons to inspect full coupon details. Get detailed information about a specific coupon

Use the customer_id obtained from list_customers to inspect full customer details. This is useful for customer support, order management, or analyzing purchase history. Get detailed information about a specific customer

Use the order_id obtained from list_orders to inspect full order details. This is useful for verifying order status, preparing shipments, or reviewing customer purchases. Get detailed information about a specific order

Use the product_id obtained from list_products to inspect full product details. This is useful for verifying product data before updating or checking stock levels. Get detailed information about a specific product

Use this to verify your store setup and understand available features. Get details about your Nuvemshop store

Each category includes name, description, and number of assigned products. Use this to understand your store's product organization and category structure. List all product categories in your Nuvemshop store

Each coupon includes code, type (percentage, absolute, shipping), value, validity dates, usage count, and minimum purchase requirements. Use this to review active promotions and analyze coupon performance. List all discount coupons in your Nuvemshop store

Each customer includes name, email, phone number, total orders, total spent, and registration date. You can optionally specify page number and records per page. Use this to browse your customer database, analyze purchase patterns, or find specific customers by name or email. List all customers in your Nuvemshop store

Each order includes order number, customer name, total value, status (pending, paid, fulfilled, cancelled), payment status, and creation date. You can optionally filter by status, specify page number, and set records per page. Use this to monitor sales, track order fulfillment, and review revenue. List all orders in your Nuvemshop store

Each product includes name, description, price, SKU, stock quantity, status (active, draft, archived), and images. You can optionally filter by status, specify page number, and set records per page (max: 200). Use this to browse your product catalog or find a specific product by name or SKU. List all products in your Nuvemshop store

Each variant includes SKU, price, stock quantity, and option values. Use the product_id from list_products to see all variants of that product. This is useful for managing inventory of products with multiple options. List all variants for a specific product

). Each webhook includes URL, events subscribed, and creation date. Use this to verify your integration endpoints are properly configured. List all webhooks configured in your Nuvemshop store

Common updates include changing discount value, extending validity dates, or modifying minimum purchase requirements. You must provide the coupon_id and the fields to update as JSON. Update an existing discount coupon

Common updates include changing contact information, updating addresses, or adding tags. You must provide the customer_id and the fields to update as JSON. Only provide the fields you want to change. Update an existing customer record

Common updates include changing order status (e.g., from pending to paid, or from paid to fulfilled), updating shipping information, or modifying order items. You must provide the order_id and the fields to update as JSON. Update an existing order in your Nuvemshop store

You must provide the product_id and the fields to update as JSON. Only the fields provided will be updated. Common updates include: changing price, updating stock quantity, modifying description, or changing product status. The product_id must exist in your store. Update an existing product in your Nuvemshop store