Tiendanube API Documentation

website·Indexed 29 days ago

https://tiendanube.github.io/devhub-apps/

Technical documentation for the Tiendanube/Nuvemshop platform, covering API v1 and unstable versions. Includes guides for payment and shipping provider integrations, multi-location inventory management, storefront app proxies, and resources for managing stores, products, orders, and disputes.

Tokens
310.9K
Snippets
1.2K
Records
2.3K
Agent score
68%

What's inside Tiendanube

  1. Overview of Tiendanube Developer Tools

    Tiendanube provides a suite of tools to accelerate the development of applications for its ecosystem:

    • Tiendanube API: The primary interface for integrating external services with store data.
    • App Templates: Pre-built code templates to speed up the initial development phase.
    • Nexo: A tool designed to simplify the connection process with store administrators.
    • Nimbus Design System: A standardized design system used to create consistent user interfaces and experiences within the Tiendanube ecosystem.
  2. Overview of the Nimbus Design System

    Nimbus is Nuvemshop's open-source design system used to create consistent, accessible, and high-performance interfaces. For developers building integrated applications for the Nuvemshop store admin, using Nimbus is a prerequisite to maintain interface quality and consistency.
  3. Overview of Tiendanube Integrated Applications

    An Integrated Application is a partner-developed app that operates within the Tiendanube Store Admin context using an iframe. This ensures a seamless user experience by embedding external functionalities directly into the store management interface.
  4. Overview of the Nimbus Design System

    Nimbus is Nuvemshop's open-source design system. It provides validated components, optimized patterns, and templates to help developers and designers create consistent, accessible, and high-performance interfaces. For apps embedded in the Nuvemshop admin, using Nimbus is a prerequisite to maintain interface consistency and quality.
  5. Overview of Tiendanube Order Resource (v1)

    v1
    An order in Tiendanube is created when a customer completes the checkout process or via the API. Note that a new Order API with multi-inventory support is currently being rolled out; for new developments, it is strongly recommended to use the multi-inventory version of the API.
  6. Overview of Nuvemshop App Development Tools

    Nuvemshop provides several tools to accelerate the development of applications within its ecosystem:

    • Nuvemshop API: The primary interface for integrating services with the platform.
    • App Templates: Pre-built code templates to speed up the initial development phase.
    • Nexo: A tool designed to simplify and speed up the connection with store administrators.
    • Nimbus Design System: A dedicated design system for creating consistent interfaces and user experiences within the Nuvemshop environment.
  7. Overview of Tiendanube Integrated App Design Guidelines

    Tiendanube provides a comprehensive set of design guidelines to help developers build integrated applications with consistent and uniform interfaces. The guidelines are divided into four primary pillars: design templates for rapid development, standardized components for custom flows, UX/UI principles aligned with the store admin panel, and UX writing rules for clear communication and naming conventions.