Skip to main content

Integration Guide

In this guide, we will cover the practical way to integrate your ERP or PIM system with the Nuvemshop platform. Here, you will find instructions to synchronize critical information such as orders, products, and inventories, ensuring efficiency and automation in back-office operations.

This guide covers:

  • Product and variation management: Registration, updates, and stock control.
  • Order synchronization: Automated processing using webhooks.
  • Inventory and invoice management: Efficient control of stock levels and issuing invoices.

We include examples in cURL with headers and endpoint details to make your implementation easier. Ideal for businesses seeking fast and reliable integration, this guide helps optimize processes and improve your e-commerce operation.

Guide Summary

1. Application Creation

  • Process to create a partner profile on Nuvemshop and connect the application with the platform.

Useful links:

2. Installation and Onboarding

  • Guide to create an efficient installation experience for public apps on the app store.
  • Focus on granting permissions and linking between stores and ERPs.

Useful links:

Installation Guide

Authentication

3. Inventory and Locations

  • Management of inventories distributed across different locations.

  • Features by plan:

    • Freemium/Plan A: 1 location
    • Plan B: 2 locations
    • Plan C: 3 locations
    • Enterprise: unlimited

Useful links:

Multi-Inventory API Locations

4. Products and Variations

  • Management of products, categories, and variations, allowing full synchronization between Nuvemshop and the ERP.

  • Basic flow:

    • Synchronize created products/categories.
    • Update stock, price, and attributes.
    • Create variations with SKU, name, and initial stock.

Useful links: Products Variations Product Images Categories

5. Orders

  • Capture and process orders for inventory control, billing, and logistics.
  • Key features:
    • Synchronize existing and new orders.
    • Update payment and shipping status.
    • Generate invoices and reintegrate stock on cancellations.

Useful links: Orders Order Webhooks

6. Customers

  • Synchronization of customer information between Nuvemshop and the management system.
  • Features:
    • Capture existing customer list.
    • Create and update customer records in the ERP and Nuvemshop.

Useful links: Customers

7. Additional Resources

8. Certification Checklist