📄️ abandoned-checkout
Abandoned Checkout
📄️ billing
Introduction
📄️ blog
Introduction
📄️ business-rules
The Business Rules API offers the ability to define different business behaviours for the shipping, payments and cart domains through a set of conditions.
📄️ cart
The Cart resource allows the manipulation of shopping carts generated in a storefront.
📄️ category
Category
📄️ checkout
Payment Options (Javascript Interface)
📄️ checkout_sdk
This library allows you to customize the checkout, through the methods below
📄️ coupon
A discount coupon is a promotional tool that allows a store to offer savings to its customers. There are three types of coupons available:
🗃️ Custom Fields & Objects
5 items
📄️ customer
Customer
📄️ discounts
Create, manage and apply discount rules.
📄️ disputes
The Dispute API is designed to collect chargeback data from our Payments partners whenever a financial dispute is initiated. With this API, partners can create up to three disputes for a specific store, order, and transaction, including details such as the reason, evidence, and dispute amount. Additionally, the API supports updating the status and evidence of a dispute and retrieving details for a single dispute.
📄️ draft-order
Draft Order
📄️ email-templates
Overview
📄️ external-invoice
An External Invoice (also known as a third-party invoice / nota fiscal terceira) represents a fiscal invoice (e.g. an NF-e in Brazil) that was issued by an external system — such as an ERP or a third-party invoicing provider — and is associated with an Order and one of its Fulfillment Orders.
📄️ fulfillment-order
An order can now have multiple shipments. Each shipment is described in a new entity called Fulfillment Order.
📄️ kit
A Kit (or product bundle) is a product that groups other products together as components. It allows merchants to sell combinations of products as a single unit.
📄️ location
Location
📄️ metafields
Metafields
📄️ order
An order is created when a customer completes the checkout process. Orders also can be created through the API.
📄️ page
Overview
📄️ payment-option
A Payment Provider can implement multiple payment options to be available at the checkout of a store. Payment options are the different alternatives through which a consumer can pay for their order in the store. These options can be integrated in the store checkout in two ways:
📄️ payment-provider
A Payment Provider, shorter name for Payments Services Provider, represents any entity which provides all the necessary resources and infrastructure for merchants and consumers to execute Transactions between them. This entities could be any of the following:
📄️ product
A Product is an item for sale in a Tiendanube/Nuvemshop's store. It can be either a good or a service.
📄️ product-image
Product images could well be the single most important design aspect of any store. Without the ability to touch, hold, smell, taste or otherwise handle the products they are interested in, potential customers have only images to interact with.
📄️ product-variant
Product variants allow you to group a shoe with different sizes and colors in the same product. You can only create products with up to 1000 variants.
📄️ price-tables
A Product Price Table list allows owners/merchants to set custom prices for products through discounts applied at different levels: storewide, specific categories, or individual products. Additionally, it's possible to define business rules such as minimum cart value and minimum product quantity for authenticated customers associated with the price list.
📄️ script
The Script resource allows an app to register a custom Javascript file to be loaded and executed in the Merchant's storefront page. More precisely, on products (store) and payment (checkout) pages.
📄️ shipping-carrier
Shipping Carrier
📄️ store
Store
📄️ store-media
A Store Media is a store-level media asset (currently images) that can be uploaded once and then reused across the store — for example as the source of a Product Image.
📄️ transaction
Transaction
📄️ webhook
A Webhook is a tool that allows you to receive a notification for a certain event. It allows you to register an https URL which will receive the event data, stored in JSON. Webhooks can be registered for the following events: