Nuvemshop API

https://tiendanube.github.io/api-documentation/2025-03
Admin
Nuvemshop API is a REST-style API that enables developers to integrate with Tiendanube and Nuvemshop...
Tokens:3,878
Snippets:35
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Pagination Example

Source: https://tiendanube.github.io/api-documentation/intro

Demonstrates how to paginate through API results using the `page` and `per_page` parameters. It also shows how to interpret the `x-total-count` and `Link` headers for navigation.

```APIDOC
## Pagination

Requests that return multiple items will not be paginated by default. You must specify further pages with the `page` parameter. You can also set a custom page size up to 200 with the `per_page` parameter.

```curl
curl -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'User-Agent: MyApp (name@email.com)' \
  'https://api.tiendanube.com/2025-03/123456/products?page=2&per_page=100'
```

Note that page numbering is 1-based and that ommiting the `page` parameter will return the first page.

To check the total count of the results you can use the `x-total-count` header:

```
x-total-count: 156
```

To check the next and previous links for pagination you can use the `Link` header:

```
Link: <https://api.tiendanube.com/2025-03/123456/products?page=3&per_page=100>; rel="next",
  <https://api.tiendanube.com/2025-03/123456/products?page=50&per_page=100>; rel="last"
```

The possible `rel` values are:
  * `next` : Shows the URL of the immediate next page of results.
  * `last` : Shows the URL of the last page of results.
  * `first` : Shows the URL of the first page of results.
  * `prev` : Shows the URL of the immediate previous page of results.

You **should** use the `Link` URLs instead of building your own.
```

--------------------------------

### Create Product with Internationalized Name

Source: https://tiendanube.github.io/api-documentation/intro

This example demonstrates how to create a new product, specifying the product name for multiple languages.

```APIDOC
## POST /products

### Description
Creates a new product. You can provide internationalized values for properties like 'name'.

### Method
POST

### Endpoint
`/v1/products`

### Parameters
#### Query Parameters
None

#### Request Body
- **name** (object or string) - Required - The name of the product. Can be an object with language codes as keys, or a single string to apply to all languages.

### Request Example (Multiple Languages)
```bash
curl -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -H 'User-Agent: MyApp (name@email.com)' \
     -d '{ "name": {"es": "Ejemplo", "pt": "Exemplo"} }' \
     https://api.tiendanube.com/2025-03/123456/products
```

### Request Example (Single Language)
```bash
curl -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -H 'User-Agent: MyApp (name@email.com)' \
     -d '{ "name": "Example" }' \
     https://api.tiendanube.com/2025-03/123456/products
```

### Response
#### Success Response (201)
Details of the created product will be returned. (Specific fields depend on the full product schema, not detailed in source).
```

--------------------------------

### Example User-Agent Headers

Source: https://tiendanube.github.io/api-documentation/intro

Include a User-Agent header with your application's name and contact information in every API request. Failure to do so results in a 400 Bad Request.

```text
User-Agent: Super app (http://superapp.com/contact)
```

```text
User-Agent: Awesome app (awesome@app.com)
```

--------------------------------

### Get Category with Internationalized Properties

Source: https://tiendanube.github.io/api-documentation/intro

This example shows how to retrieve a category, demonstrating how internationalized properties like 'name', 'description', and 'handle' are returned as objects with language codes as keys.

```APIDOC
## GET /categories/{id}

### Description
Retrieves a specific category, including its internationalized properties.

### Method
GET

### Endpoint
`/v1/categories/{id}`

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the category to retrieve.

### Request Example
```bash
curl -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'User-Agent: MyApp (name@email.com)' \
     -D - \
     https://api.tiendanube.com/2025-03/123456/categories/1234
```

### Response
#### Success Response (200)
- **id** (integer) - The category ID.
- **name** (object) - An object containing the category name for each language.
- **description** (object) - An object containing the category description for each language.
- **handle** (object) - An object containing the category handle for each language.
- **parent** (object or null) - The parent category object or null if it has no parent.
- **subcategories** (array) - An array of subcategory objects.
- **created_at** (string) - The date and time the category was created.
- **updated_at** (string) - The date and time the category was last updated.

#### Response Example
```json
{
    "id": 1234,
    "name": {
        "es": "Nombre de la Categoría",
        "pt": "Nome da Categoria"
    },
    "description": {
        "es": "",
        "pt": ""
    },
    "handle": {
        "es": "nombre-de-la-categoria",
        "pt": "nome-da-categoria"
    },
    "parent": null,
    "subcategories": [],
    "created_at": "2013-09-05T17:59:19+0000",
    "updated_at": "2013-09-05T17:59:19+0000"
}
```

### Headers
- **X-Main-Language** (string) - The main language code of the store.
```

--------------------------------

### Get Category with Internationalization

Source: https://tiendanube.github.io/api-documentation/intro

Use this endpoint to retrieve a category. The response includes localized values for name, description, and handle, provided as objects with language codes as keys.

```curl
curl -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'User-Agent: MyApp (name@email.com)' \
     -D - \
     https://api.tiendanube.com/2025-03/123456/categories/1234
```

```http
HTTP/1.1 200 OK
Date: Thu, 05 Sep 2013 18:18:22 GMT
Content-Type: application/json; charset=UTF-8
Content-Length: 376
x-main-language: es
```

```json
{
    "id": 1234,
    "name": {
        "es": "Nombre de la Categoría",
        "pt": "Nome da Categoria"
    },
    "description": {
        "es": "",
        "pt": ""
    },
    "handle": {
        "es": "nombre-de-la-categoria",
        "pt": "nome-da-categoria"
    },
    "parent": null,
    "subcategories": [

    ],
    "created_at": "2013-09-05T17:59:19+0000",
    "updated_at": "2013-09-05T17:59:19+0000"
}
```

--------------------------------

### Create a New Product

Source: https://tiendanube.github.io/api-documentation/intro

This cURL command demonstrates how to create a new product for a store. It requires setting the 'Content-Type' header to 'application/json' and providing the product data in JSON format within the request body. Remember to use a valid ACCESS_TOKEN and the correct store ID.

```bash
curl -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -H 'User-Agent: MyApp (name@email.com)' \
     -d '{ "name": "My new product" }' \
     https://api.tiendanube.com/2025-03/123456/products
```

--------------------------------

### Retrieve Store Products

Source: https://tiendanube.github.io/api-documentation/intro

Use this cURL command to fetch all products for a specific store. Ensure you replace ACCESS_TOKEN with a valid store access token and adjust the store ID and API endpoint as needed.

```bash
curl -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'User-Agent: MyApp (name@email.com)' \
     https://api.tiendanube.com/2025-03/123456/products
```

--------------------------------

### Create Product with Specific Languages

Source: https://tiendanube.github.io/api-documentation/intro

When creating or updating a product, you can specify localized values for properties like 'name' by providing an object with language codes as keys.

```curl
curl -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -H 'User-Agent: MyApp (name@email.com)' \
     -d '{ "name": {"es": "Ejemplo", "pt": "Exemplo"} }' \
     https://api.tiendanube.com/2025-03/123456/products
```

--------------------------------

### Fetch paginated products

Source: https://tiendanube.github.io/api-documentation/intro

Use the `page` and `per_page` parameters to retrieve specific pages of product data. The `per_page` parameter can be set up to 200.

```curl
curl -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'User-Agent: MyApp (name@email.com)' \
  'https://api.tiendanube.com/2025-03/123456/products?page=2&per_page=100'
```

--------------------------------

### Create Product with Single Language Value

Source: https://tiendanube.github.io/api-documentation/intro

Alternatively, you can provide a single string value for a property, which will be applied to all active languages for that property.

```curl
curl -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -H 'User-Agent: MyApp (name@email.com)' \
     -d '{ "name": "Example" }' \
     https://api.tiendanube.com/2025-03/123456/products
```

--------------------------------

### HTTP Verbs

Source: https://tiendanube.github.io/api-documentation/intro

Overview of the HTTP verbs supported by the API for performing actions on resources.

```APIDOC
## HTTP Verbs

Where possible, API `2025-03` strives to use appropriate HTTP verbs for each action.
  * `HEAD` : Can be issued against any resource to get just the HTTP header info.
  * `GET` : Used for retrieving resources.
  * `POST` : Used for creating resources.
  * `PUT` : Used for replacing resources or collections. For PUT requests with no body attribute, be sure to set the Content-Length header to zero.
  * `DELETE` : Used for deleting resources.
```

--------------------------------

### Pagination Link header

Source: https://tiendanube.github.io/api-documentation/intro

The `Link` header provides URLs for navigating through paginated results, including 'next' and 'last' pages. It is recommended to use these URLs directly.

```http-header
Link: <https://api.tiendanube.com/2025-03/123456/products?page=3&per_page=100>; rel="next",
  <https://api.tiendanube.com/2025-03/123456/products?page=50&per_page=100>; rel="last"
```

--------------------------------

### Registering for Variant Change Events

Source: https://tiendanube.github.io/api-documentation/intro

Use this JavaScript function to bind a callback to the event that fires when a product variant is changed. The callback receives variant information, including a jQuery selector for the variant's form container.

```javascript
LS.registerOnChangeVariant(callback)
```

--------------------------------

### 422 Unprocessable Entity - Invalid Fields

Source: https://tiendanube.github.io/api-documentation/intro

This response indicates that the request body contains invalid fields. The response body details which fields are problematic and why.

```http
HTTP/1.1 422 Unprocessable Entity
Content-Length: 47

{
  "src": [
      "can't be blank"
    ]
}
```

--------------------------------

### 400 Bad Request - Invalid JSON

Source: https://tiendanube.github.io/api-documentation/intro

This response is returned when the API receives invalid JSON in the request body. Ensure your JSON is correctly formatted.

```http
HTTP/1.1 400 Bad Request
Content-Length: 34

{"error": "Problems parsing JSON"}
```

--------------------------------

### Total count header

Source: https://tiendanube.github.io/api-documentation/intro

The `x-total-count` header indicates the total number of results available for a paginated request.

```http-header
x-total-count: 156
```
Tokens:
Raw