📄️ Abandoned Checkout
The abandoned checkout is created when the customer reaches checkout's seconds step, but for some reason it does not finish the process.
📄️ Billing
Introduction
📄️ Business Rules
The Business Rules API offers the ability to define different business behaviours for the shipping and payments domains through a set of conditions.
📄️ Cart
The Cart resource allows the manipulation of shopping carts generated in a storefront.
📄️ Category Custom Fields
A custom field allows the store owner/merchant to expand their experience and control their own business through personalized and unique custom fields for categories.
📄️ Category
A Category lets the store owner group his/her products to make the store easier to browse.
📄️ Checkout
Payment Options (Javascript Interface)
📄️ Checkout SDK
This library allows you to customize the checkout, through the methods below
📄️ Coupons
A discount coupon is a promotional tool that allows a store to offer savings to its customers. There are three types of coupons available:
📄️ Customer
A Customer of the store. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.
📄️ Customer Custom Fields
A custom field allows the store owner/merchant to expand their experience and control their own business through personalized and unique custom fields for customers.
📄️ Discount
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
A draft order enables create orders through outside channels.
📄️ Email Templates
Overview
📄️ Fulfillment Order
An order can now have multiple shipments. Each shipment is described in a new entity called Fulfillment Order.
📄️ Location
A Location of the store where physical goods reside.
📄️ Metafields
The metafields are Namespaced Key - Value store for Apps.
📄️ Order
An order is created when a customer completes the checkout process. Orders also can be created through the API.
📄️ Order Custom Fields
A custom field allows the store owner/merchant to expand their experience and control their own business through personalized and unique custom fields for orders.
📄️ Pages
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.
📄️ Product Custom Fields
A custom field allows the store owner/merchant to expand their experience and control their own business through personalized and unique custom fields for products.
📄️ Product Variant Custom Fields
A custom field allows the store owner/merchant to expand their experience and control their own business through personalized and unique custom fields for product variants.
📄️ Scripts
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
A shipping carrier (or shipping company) service provides real-time shipping rates for merchants.
📄️ Store
The Store resource contains general settings and information about a Tiendanube/Nuvemshop's store.
📄️ Transaction
Each movement of money is modeled through a Transaction object, which can be of different types (e.g. credit card, debit card, boleto, wire transfer, etc.). Each Transaction type has a Finite State Machine (FSM) that defines its current status. The Transaction Event object represents transitions in the Transaction's FSM.
📄️ 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: