Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nuvemshop / Tiendanube Orders API

Customer purchases and their lifecycle.

Nuvemshop / Tiendanube Orders API is one of 10 APIs that Nuvemshop / Tiendanube publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 10 operations across 8 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 2025-03.

Requests are made against 2 base URLs: https://api.tiendanube.com/2025-03/{store_id}, https://api.nuvemshop.com.br/2025-03/{store_id}.

10 operations 8 paths 5 schemas 5 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2025-03
Base URL
https://api.tiendanube.com/2025-03/{store_id}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Nuvemshop / Tiendanube Orders API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authentication (authenticationHeader). By default, every request must be authenticated.

  • authenticationHeader — NON-STANDARD auth header. Send the OAuth 2 access token as Authentication: bearer ACCESSTOKEN - the header name must be Authentication (not Authorization) and…

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 5 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Orders 10

Customer purchases and their lifecycle.

GET
/orders
List orders
listOrders 3 params → 200401429
POST
/orders
Create an order
createOrder body → 201401422
GET
/orders/{id}
Get an order
getOrder 1 param → 200401404
PUT
/orders/{id}
Update an order
updateOrder 1 param body → 200401404
GET
/orders/{id}/history/values
Get order value history
getOrderValueHistory 1 param → 200401404
GET
/orders/{id}/history/editions
Get order edition history
getOrderEditionHistory 1 param → 200401404
GET
/orders/{id}/subscriptions
Get order subscriptions
getOrderSubscriptions 1 param → 200401404
POST
/orders/{id}/close
Close an order
closeOrder 1 param → 200401404
POST
/orders/{id}/open
Re-open an order
openOrder 1 param → 200401404
POST
/orders/{id}/cancel
Cancel an order
cancelOrder 1 param → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are CustomerInput (6 properties), OrderInput (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Customer
OrderInput
object
5 properties
CustomerInput
object
6 properties
Error
object
3 properties
Order

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuvemshop-orders-api-openapi.yml Raw ↑

Other APIs Nuvemshop / Tiendanube publishes across the network.

Nuvemshop / Tiendanube Categories API
Nuvemshop / Tiendanube Coupons API
Nuvemshop / Tiendanube Customers API
Nuvemshop / Tiendanube Product Images API
Nuvemshop / Tiendanube Product Variants API
Nuvemshop / Tiendanube Products API
Nuvemshop / Tiendanube Scripts API
Nuvemshop / Tiendanube Store API
Nuvemshop / Tiendanube Webhooks API