Nuvemshop API

https://tiendanube.github.io/api-documentation/intro
Admin
Nuvemshop API is a REST-style API that enables developers to integrate with Tiendanube and Nuvemshop...
Tokens:20,766
Snippets:74
Trust Score:8.3
Update:2 days ago
Show doc for...
Tokens:
Raw
### Link header example for pagination

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

Example response header showing pagination links. The 'rel' values can be 'next', 'last', 'first', or 'prev'. It is recommended to use these URLs instead of building your own.

```text
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"
```

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

### x-total-count header example

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

Example response header showing the total count of results. Use this header to check the total number of items.

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

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

### POST product with string value for all languages

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

Example curl request to create a product, providing a string value that will be applied to all languages.

```shell
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
```

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

### POST product with language-specific values

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

Example curl request to create a product, providing an object with values for each language (es and pt).

```shell
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
```

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

### GET /draft_orders

Source: https://tiendanube.github.io/api-documentation/resources/draft-order

Lists all draft orders. This endpoint retrieves a collection of draft orders from the store.

```APIDOC
## GET /draft_orders

### Description
Lists all draft orders.

### Method
GET

### Endpoint
/draft_orders

```

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

### GET category with multilingual fields

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

Example curl request to retrieve a category, showing that multilingual properties are returned as objects. The response includes the X-Main-Language header indicating the main language code.

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

```text
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"
}
```

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

### Pagination request with curl

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

Example curl command to request a specific page with a custom page size. Uses the 'page' and 'per_page' parameters. Page numbering is 1-based; omitting 'page' returns the first page.

```shell
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'
```

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

### GET /draft_orders

Source: https://tiendanube.github.io/api-documentation/resources/draft-order

Lists all draft orders. Returns an array of draft order objects with details such as customer information, products, shipping, and payment status.

```APIDOC
## GET /draft_orders

### Description
List all draft orders.

### Method
GET

### Endpoint
/draft_orders

### Response
#### Success Response (200)
Returns an array of draft order objects.

#### Response Example
```json
[
    {
        "id": 39138281,
        "token": "73137f3ddd99f3483e89315ed7645f3ebde78867",
        "store_id": "97902",
        "shipping_min_days": null,
        "shipping_max_days": null,
        "billing_name": null,
        "billing_phone": null,
        "billing_address": null,
        "billing_number": null,
        "billing_floor": null,
        "billing_locality": null,
        "billing_zipcode": null,
        "billing_city": null,
        "billing_province": null,
        "billing_country": null,
        "shipping_cost_owner": "0.00",
        "shipping_cost_customer": "0.00",
        "coupon": [],
        "promotional_discount": {
            "id": null,
            "store_id": 97902,
            "order_id": "39138281",
            "created_at": "2020-11-28T00:53:17+0000",
            "total_discount_amount": "0.00",
            "contents": [],
            "promotions_applied": []
        },
        "subtotal": "712.00",
        "discount": "0.00",
        "discount_coupon": "0.00",
        "discount_gateway": "0.00",
        "total": "712.00",
        "total_usd": "0.00",
        "checkout_enabled": true,
        "weight": "0.030",
        "currency": "ARS",
        "language": "es",
        "gateway": "not-provided",
        "gateway_id": null,
        "shipping": "draft",
        "shipping_option": "¡Te vamos a contactar para coordinar la entrega!",
        "shipping_option_code": "draft_99999",
        "shipping_option_reference": null,
        "shipping_pickup_details": null,
        "shipping_tracking_number": null,
        "shipping_tracking_url": null,
        "shipping_store_branch_name": null,
        "shipping_pickup_type": "ship",
        "shipping_suboption": [],
        "extra": {},
        "storefront": "form",
        "note": null,
        "created_at": "2020-11-27T19:51:11+0000",
        "updated_at": "2020-11-27T19:51:11+0000",
        "completed_at": {
            "date": "2020-11-27T19:51:11+0000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "next_action": "noop",
        "payment_details": {
            "method": null,
            "credit_card_company": null,
            "installments": "1"
        },
        "attributes": [],
        "customer": null,
        "products": [
            {
                "id": 32720573,
                "depth": "0.00",
                "height": "0.00",
                "name": "Oleo Esencial Barba",
                "price": "712.00",
                "product_id": 17310749,
                "image": {
                    "id": 0,
                    "product_id": 0,
                    "src": "www.example.com/photo-example",
                    "position": 0,
                    "alt": [],
                    "created_at": "2020-11-28T00:53:19+0000",
                    "updated_at": "2020-11-28T00:53:19+0000"
                },
                "quantity": 1,
                "free_shipping": false,
                "weight": "0.03",
                "width": "0.00",
                "variant_id": 33739143,
                "variant_values": [],
                "properties": [],
                "sku": null,
                "barcode": null
            }
        ],
        "clearsale": {
            "CodigoIntegracao": false,
            "IP": null,
            "Estado": ""
        },
        "number": 0,
        "cancel_reason": null,
        "owner_note": "My nota",
        "cancelled_at": null,
        "closed_at": null,
        "read_at": null,
        "status": "open",
        "payment_status": "pending",
        "shipping_address": null,
        "shipping_status": "unpacked",
        "shipped_at": null,
        "paid_at": null,
        "landing_url": null,
        "client_details": {
            "browser_ip": null,
            "user_agent": null
        },
        "app_id": null,
        "checkout_url": "www.example.com/checkout-example"
    },
    {
        "id": 39138280,
        "token": "22b4e8f860bdc31b16ca3938f742faf8b1d83356",
        "store_id": "97902",
        "shipping_min_days": null,
        "shipping_max_days": null,
        "billing_name": null,
        "billing_phone": null,
        "billing_address": null,
        "billing_number": null,
        "billing_floor": null,
        "billing_locality": null,
        "billing_zipcode": null,
        "billing_city": null,
        "billing_province": null,
        "billing_country": null,
        "shipping_cost_owner": "0.00",
        "shipping_cost_customer": "0.00",
        "coupon": [],
        "promotional_discount": {
            "id": null,
            "store_id": 97902,
            "order_id": "39138280",
            "created_at": "2020-11-28T00:53:17+0000",
            "total_discount_amount": "0.00",
            "contents": [],
            "promotions_applied": []
        },
        "subtotal": "712.00",
        "discount": "0.00",
        "discount_coupon": "0.00",
        "discount_gateway": "0.00",
        "total": "712.00",
        "total_usd": "0.00",
        "checkout_enabled": true,
        "weight": "0.030",
        "currency": "ARS",
        "language": "es",
        "gateway": "not-provided",
        "gateway_id": null,
        "shipping": "draft",
        "shipping_option": "¡Te vamos a contactar para coordinar la entrega!",
        "shipping_option_code": "draft_99999",
        "shipping_option_reference": null,
        "shipping_pickup_details": null,
        "shipping_tracking_number": null,
        "shipping_tracking_url": null,
        "shipping_store_branch_name": null,
        "shipping_pickup_type": "ship",
        "shipping_suboption": [],
        "extra": {},
        "storefront": "form",
        "note": null,
        "created_at": "2020-11-27T19:51:11+0000",
        "updated_at": "2020-11-27T19:51:11+0000",
        "completed_at": {
            "date": "2020-11-27T19:51:11+0000",
            "timezone_type": 3,
            "timezone": "UTC"
        },
        "next_action": "noop",
        "payment_details": {
            "method": null,
            "credit_card_company": null,
            "installments": "1"
        },
        "attributes": [],
        "customer": null,
        "products": [
            {
                "id": 32720572,
                "depth": "0.00",
                "height": "0.00",
                "name": "Oleo Esencial Barba",
                "price": "712.00",
                "product_id": 17310749,
                "image": {
                    "id": 0,
                    "product_id": 0,
                    "src": "www.example.com/photo-example",
                    "position": 0,
                    "alt": [],
                    "created_at": "2020-11-28T00:53:19+0000",
                    "updated_at": "2020-11-28T00:53:19+0000"
                },
                "quantity": 1,
                "free_shipping": false,
                "weight": "0.03",
                "width": "0.00",
                "variant_id": 33739142,
                "variant_values": [],
                "properties": [],
                "sku": null,
                "barcode": null
            }
        ],
        "clearsale": {
            "CodigoIntegracao": false,
            "IP": null,
            "Estado": ""
        },
        "number": 0,
        "cancel_reason": null,
        "owner_note": "My nota",
        "cancelled_at": null,
        "closed_at": null,
        "read_at": null,
        "status": "open",
        "payment_status": "pending",
        "shipping_address": null,
        "shipping_status": "unpacked",
        "shipped_at": null,
        "paid_at": null,
        "landing_url": null,
        "client_details": {
            "browser_ip": null,
            "user_agent": null
        },
        "app_id": null,
        "checkout_url": "www.example.com/checkout-example"
    }
]
```

```

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

### GET /2025-03/{store_id}/categories/{category_id}

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

Retrieves a category with localized name, description, and handle fields. The response includes the X-Main-Language header indicating the main language.

```APIDOC
## GET /2025-03/{store_id}/categories/{category_id}

### Description
Retrieves a category with localized name, description, and handle fields. The response includes the X-Main-Language header indicating the main language.

### Method
GET

### Endpoint
https://api.tiendanube.com/2025-03/{store_id}/categories/{category_id}

### Parameters
#### Path Parameters
- **store_id** (integer) - Required - The store identifier.
- **category_id** (integer) - Required - The category identifier.

### Request Example
```shell
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) - Category ID.
- **name** (object) - Localized category name.
- **description** (object) - Localized category description.
- **handle** (object) - Localized category handle.
- **parent** (null) - Parent category.
- **subcategories** (array) - Subcategories.
- **created_at** (string) - Creation timestamp.
- **updated_at** (string) - Last update timestamp.
- **X-Main-Language** (header) - Code of the main language.

#### 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"
}
```
```

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

### GET /draft_orders

Source: https://tiendanube.github.io/api-documentation/resources/draft-order

Retrieves a list of draft orders. The response includes detailed order information such as totals, products, and shipping details.

```APIDOC
## GET /draft_orders

### Description
Retrieves a list of draft orders. The response includes detailed order information such as totals, products, and shipping details.

### Method
GET

### Endpoint
/draft_orders

### Response
#### Success Response (200)
- **coupon** (array) - List of coupons applied.
- **promotional_discount** (object) - Promotional discount details.
- **subtotal** (string) - Subtotal amount.
- **discount** (string) - Discount amount.
- **discount_coupon** (string) - Coupon discount amount.
- **discount_gateway** (string) - Gateway discount amount.
- **total** (string) - Total amount.
- **total_usd** (string) - Total in USD.
- **checkout_enabled** (boolean) - Whether checkout is enabled.
- **weight** (string) - Order weight.
- **currency** (string) - Currency code.
- **language** (string) - Language code.
- **gateway** (string) - Payment gateway.
- **gateway_id** (null) - Gateway identifier.
- **shipping** (string) - Shipping method.
- **shipping_option** (string) - Shipping option description.
- **shipping_option_code** (string) - Shipping option code.
- **shipping_option_reference** (null) - Shipping option reference.
- **shipping_pickup_details** (null) - Pickup details.
- **shipping_tracking_number** (null) - Tracking number.
- **shipping_tracking_url** (null) - Tracking URL.
- **shipping_store_branch_name** (null) - Store branch name.
- **shipping_pickup_type** (string) - Pickup type.
- **shipping_suboption** (array) - Shipping suboptions.
- **extra** (object) - Extra data.
- **storefront** (string) - Storefront type.
- **note** (null) - Note.
- **created_at** (string) - Creation timestamp.
- **updated_at** (string) - Last update timestamp.
- **completed_at** (object) - Completion timestamp.
- **next_action** (string) - Next action.
- **payment_details** (object) - Payment details.
- **attributes** (array) - Attributes.
- **customer** (null) - Customer information.
- **products** (array) - List of products.
- **clearsale** (object) - ClearSale data.
- **number** (integer) - Order number.
- **cancel_reason** (null) - Cancellation reason.
- **owner_note** (string) - Owner note.
- **cancelled_at** (null) - Cancellation timestamp.
- **closed_at** (null) - Closing timestamp.
- **read_at** (null) - Read timestamp.
- **status** (string) - Order status.
- **payment_status** (string) - Payment status.
- **shipping_address** (null) - Shipping address.
- **shipping_status** (string) - Shipping status.
- **shipped_at** (null) - Shipping timestamp.
- **paid_at** (null) - Payment timestamp.
- **landing_url** (null) - Landing URL.
- **client_details** (object) - Client details.
- **app_id** (null) - Application ID.
- **checkout_url** (string) - Checkout URL.

#### Response Example
```json
{
    "coupon": [],
    "promotional_discount": {
        "id": null,
        "store_id": 97902,
        "order_id": "39138280",
        "created_at": "2020-11-28T00:53:17+0000",
        "total_discount_amount": "0.00",
        "contents": [],
        "promotions_applied": []
    },
    "subtotal": "712.00",
    "discount": "0.00",
    "discount_coupon": "0.00",
    "discount_gateway": "0.00",
    "total": "712.00",
    "total_usd": "0.00",
    "checkout_enabled": true,
    "weight": "0.030",
    "currency": "ARS",
    "language": "es",
    "gateway": "not-provided",
    "gateway_id": null,
    "shipping": "draft",
    "shipping_option": "¡Te vamos a contactar para coordinar la entrega!",
    "shipping_option_code": "draft_99999",
    "shipping_option_reference": null,
    "shipping_pickup_details": null,
    "shipping_tracking_number": null,
    "shipping_tracking_url": null,
    "shipping_store_branch_name": null,
    "shipping_pickup_type": "ship",
    "shipping_suboption": [],
    "extra": {},
    "storefront": "form",
    "note": null,
    "created_at": "-0001-11-30T00:00:00+0000",
    "updated_at": "2020-11-26T19:51:52+0000",
    "completed_at": {
        "date": "-0001-11-30 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    },
    "next_action": "noop",
    "payment_details": {
        "method": null,
        "credit_card_company": null,
        "installments": "1"
    },
    "attributes": [],
    "customer": null,
    "products": [
        {
            "id": 32720572,
            "depth": "0.00",
            "height": "0.00",
            "name": "Pomada para cabello",
            "price": "712.00",
            "product_id": 17310748,
            "image": {
                "id": 0,
                "product_id": 0,
                "src": "www.example.com/photo-example",
                "position": 0,
                "alt": [],
                "created_at": "2020-11-28T00:53:19+0000",
                "updated_at": "2020-11-28T00:53:19+0000"
            },
            "quantity": 1,
            "free_shipping": false,
            "weight": "0.03",
            "width": "0.00",
            "variant_id": 33739146,
            "variant_values": [],
            "properties": [],
            "sku": null,
            "barcode": null
        }
    ],
    "clearsale": {
        "CodigoIntegracao": false,
        "IP": null,
        "Estado": ""
    },
    "number": 0,
    "cancel_reason": null,
    "owner_note": "My nota",
    "cancelled_at": null,
    "closed_at": null,
    "read_at": null,
    "status": "open",
    "payment_status": "pending",
    "shipping_address": null,
    "shipping_status": "unpacked",
    "shipped_at": null,
    "paid_at": null,
    "landing_url": null,
    "client_details": {
        "browser_ip": null,
        "user_agent": null
    },
    "app_id": null,
    "checkout_url": "www.example.com/checkout-example"
}
```

#### Error Response (500)
- **code** (integer) - Error code.
- **message** (string) - Error message.
- **description** (string) - Error description.

#### Error Example
```json
{
    "code": 500,
    "message": "Internal Server Error",
    "description": "Example error."
}
```
```

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

### GET /draft_orders

Source: https://tiendanube.github.io/api-documentation/resources/draft-order

Retrieves a list of draft orders. This endpoint returns all draft orders associated with the store.

```APIDOC
## GET /draft_orders

### Description
Retrieves a list of draft orders.

### Method
GET

### Endpoint
/draft_orders

### Response
#### Success Response (200)
- **draft_orders** (array) - List of draft order objects.

#### Response Example
```json
{
  "draft_orders": [
    {
      "id": 39138263,
      "status": "open",
      "currency": "ARS",
      "total": 100.0,
      "created_at": "2023-01-01T00:00:00Z",
      "updated_at": "2023-01-01T00:00:00Z"
    }
  ]
}
```

#### Error Responses
- **404 Not Found**: Invalid draft order.
- **500 Internal Server Error**: Example error.
```

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

### GET /draft_orders/{id}

Source: https://tiendanube.github.io/api-documentation/resources/draft-order

Retrieves a draft order by its unique identifier. Returns the full draft order object with all its properties. Responds with 404 if the draft order does not exist and 500 for internal errors.

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

### Description
Get a draft order.

### Method
GET

### Endpoint
/draft_orders/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the draft order.

### Response
#### Success Response (200)
Returns the draft order object with fields such as id, token, store_id, subtotal, total, currency, status, products, and more.

#### Response Example
```json
{
    "id": 39138263,
    "token": "462ff0b053bf906e02c79f997a4872df28652e26",
    "store_id": "97902",
    "shipping_min_days": null,
    "shipping_max_days": null,
    "billing_name": null,
    "billing_phone": null,
    "billing_address": null,
    "billing_number": null,
    "billing_floor": null,
    "billing_locality": null,
    "billing_zipcode": null,
    "billing_city": null,
    "billing_province": null,
    "billing_country": null,
    "shipping_cost_owner": "0.00",
    "shipping_cost_customer": "0.00",
    "coupon": [],
    "promotional_discount": {
        "id": null,
        "store_id": 97902,
        "order_id": "39138263",
        "created_at": "2020-11-28T02:37:32+0000",
        "total_discount_amount": "0.00",
        "contents": [],
        "promotions_applied": []
    },
    "subtotal": "712.00",
    "discount": "0.00",
    "discount_coupon": "0.00",
    "discount_gateway": "0.00",
    "total": "712.00",
    "total_usd": "0.00",
    "checkout_enabled": true,
    "weight": "0.030",
    "currency": "ARS",
    "language": "es",
    "gateway": "not-provided",
    "gateway_id": null,
    "shipping": "draft",
    "shipping_option": "¡Te vamos a contactar para coordinar la entrega!",
    "shipping_option_code": "draft_99999",
    "shipping_option_reference": null,
    "shipping_pickup_details": null,
    "shipping_tracking_number": null,
    "shipping_tracking_url": null,
    "shipping_store_branch_name": null,
    "shipping_pickup_type": "ship",
    "shipping_suboption": [],
    "extra": {},
    "storefront": "form",
    "note": null,
    "created_at": "2020-11-17T14:53:30+0000",
    "updated_at": "2020-11-17T14:53:30+0000",
    "completed_at": {
        "date": "2020-11-17 14:53:30.000000",
        "timezone_type": 3,
        "timezone": "UTC"
    },
    "next_action": "noop",
    "payment_details": {
        "method": null,
        "credit_card_company": null,
        "installments": "1"
    },
    "attributes": [],
    "customer": null,
    "products": [
        {
            "id": 32720555,
            "depth": "0.00",
            "height": "0.00",
            "name": "Oleo Esencial Barba",
            "price": "712.00",
            "product_id": 17310749,
            "image": {
                "id": 0,
                "product_id": 0,
                "src": "www.example.com/photo-example",
                "position": 0,
                "alt": [],
                "created_at": "2020-11-28T02:37:33+0000",
                "updated_at": "2020-11-28T02:37:33+0000"
            },
            "quantity": "1",
            "free_shipping": false,
            "weight": "0.03",
            "width": "0.00",
            "variant_id": "33739143",
            "variant_values": [],
            "properties": [],
            "sku": null,
            "barcode": null
        }
    ],
    "clearsale": {
        "CodigoIntegracao": false,
        "IP": null,
        "Estado": ""
    },
    "number": 0,
    "cancel_reason": null,
    "owner_note": "",
    "cancelled_at": "2020-11-17T14:53:30+0000",
    "closed_at": null,
    "read_at": null,
    "status": "cancelled",
    "payment_status": "pending",
    "shipping_address": null,
    "shipping_status": "unpacked",
    "shipped_at": null,
    "paid_at": null,
    "landing_url": null,
    "client_details": {
        "browser_ip": null,
        "user_agent": null
    },
    "app_id": null,
    "checkout_url": "www.example.com/checkout-example"
}
```

#### Error Response (404 Not Found)
Returned when the draft order with the given ID does not exist.

#### Response Example
```json
{
    "code": 404,
    "message": "Not Found",
    "description": "Invalid draft order 39138263"
}
```

#### Error Response (500 Internal Server Error)
Returned when an unexpected error occurs.

#### Response Example
```json
{
    "code": 500,
    "message": "Internal Server Error",
    "description": "Example error."
}
```
```

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

### Create a product with curl

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

Use this curl command to create a product. Include the Content-Type header and JSON data in the request body. Replace ACCESS_TOKEN with the store's access token.

```shell
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
```

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

### GET /draft_orders/{id}

Source: https://tiendanube.github.io/api-documentation/resources/draft-order

Retrieves a specific draft order by its unique identifier. Use this endpoint to get details of a single draft order.

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

### Description
Get a draft order by its ID.

### Method
GET

### Endpoint
/draft_orders/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique numeric identifier for the draft order.

```

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

### Fetch all products with curl

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

Use this curl command to retrieve all products for a store. Replace ACCESS_TOKEN with the store's access token. The User-Agent header must include your app name and contact email.

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

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

### POST /2025-03/{store_id}/products

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

Creates a product with localized name field. You can provide an object with values per language or a single string applied to all languages.

```APIDOC
## POST /2025-03/{store_id}/products

### Description
Creates a product with localized name field. You can provide an object with values per language or a single string applied to all languages.

### Method
POST

### Endpoint
https://api.tiendanube.com/2025-03/{store_id}/products

### Parameters
#### Path Parameters
- **store_id** (integer) - Required - The store identifier.

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

### Request Example (Object per language)
```shell
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 (String for all languages)
```shell
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
```
```

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

### POST /draft_orders

Source: https://tiendanube.github.io/api-documentation/resources/draft-order

Creates a new draft order. This endpoint requires the customer's name, lastname, email, payment status, and a list of products. Optional fields include contact phone, CPF/CNPJ, sale channel, note, discount, and shipping information.

```APIDOC
## POST /draft_orders

### Description
Creates a new draft order.

### Method
POST

### Endpoint
/draft_orders

### Parameters
#### Request Body
- **contact_name** (string) - Required - Customer's name.
- **contact_lastname** (string) - Required - Customer's lastname.
- **contact_email** (E-mail) - Required - Customer contact email.
- **contact_phone** (string) - Optional - Customer contact phone.
- **cpf_cnpj** (string) - Optional - Customer identity number.
- **payment_status** (string) - Required - Draft Order's payment status. Possible values are "unpaid", "pending_confirmation" and "paid".
- **sale_channel** (string) - Optional - Sales channel name.
- **note** (string) - Optional - Store owner's note about the draft order.
- **products** (array) - Required - Draft Order's products list (Product object).
- **discount** (string) - Optional - Discount amount applied to the draft order.
- **discount_type** (string) - Optional - Discount type applied to the draft order. Possible values are "absolute" and "percentage". Default value is "percentage".
- **shipping** (array) - Optional - Shipping information (Shipping object).

#### Product Object
- **variant_id** (Integer) - Required - The product variant ID.
- **quantity** (Integer) - Required - The product quantity. Must be greater than 0.
- **properties** (json) - Optional - JSON object containing product's custom fields.

#### Shipping Object
- **cost** (string) - Optional - The shipping cost the customer has to pay to the store owner.
- **shipping_address** (array) - Optional - Shipping address information (Address object).

#### Address Object
- **address** (String) - Optional - The customer's street.
- **number** (String) - Optional - The address's number.
- **floor** (String) - Optional - The address's complement.
- **locality** (String) - Optional - The address's locality.
- **city** (String) - Optional - The address's city.
- **province** (String) - Optional - The address's province.
- **zipcode** (String) - Optional - The address's postal code.

### Payment Status Values
- **unpaid** - The payment hasn't yet been made.
- **pending_confirmation** - The payment confirmation is pending.
- **paid** - The payment was successfully confirmed and captured.

```

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

### GET /draft_orders/{id}

Source: https://tiendanube.github.io/api-documentation/resources/draft-order

Retrieves a specific draft order by its ID. This endpoint returns the full details of a single draft order.

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

### Description
Retrieves a specific draft order by its ID.

### Method
GET

### Endpoint
/draft_orders/{id}

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

### Response
#### Success Response (200)
- **id** (integer) - The draft order ID.
- **status** (string) - The status of the draft order.
- **currency** (string) - The currency code.
- **total** (number) - The total amount.
- **created_at** (string) - Creation timestamp.
- **updated_at** (string) - Last update timestamp.

#### Response Example
```json
{
  "id": 39138263,
  "status": "open",
  "currency": "ARS",
  "total": 100.0,
  "created_at": "2023-01-01T00:00:00Z",
  "updated_at": "2023-01-01T00:00:00Z"
}
```

#### Error Responses
- **404 Not Found**: Invalid draft order.
- **500 Internal Server Error**: Example error.
```

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

### Pagination

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

Requests that return multiple items are not paginated by default. Use the 'page' and 'per_page' parameters to navigate through results. The 'x-total-count' header provides the total count, and the 'Link' header provides navigation URLs.

```APIDOC
## Pagination

### Description
Requests that return multiple items are not 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.

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number (1-based). Omit to get the first page.
- **per_page** (integer) - Optional - Number of items per page (max 200).

### Request Example
```shell
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'
```

### Response
#### Headers
- **x-total-count** (integer) - Total count of results.
- **Link** (string) - URLs for pagination navigation. Possible `rel` values: `next`, `last`, `first`, `prev`.

#### Response Example
```text
x-total-count: 156
```

```text
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"
```

### Notes
- Page numbering is 1-based.
- Omitting the `page` parameter returns the first page.
- You **should** use the `Link` URLs instead of building your own.
```

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

### HTTP Verbs

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

The API uses appropriate HTTP verbs for each action. This section describes the supported verbs and their purposes.

```APIDOC
## HTTP Verbs

### Description
Where possible, API `2025-03` strives to use appropriate HTTP verbs for each action.

### Supported Verbs
- **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.
```

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

### POST /draft_orders/{id}/confirm

Source: https://tiendanube.github.io/api-documentation/resources/draft-order

Confirms a draft order and converts it to an order. Returns the resulting order object.

```APIDOC
## POST /draft_orders/{id}/confirm

### Description
Confirms a draft order and converts it to an order. Returns an Order object.

### Method
POST

### Endpoint
/draft_orders/{id}/confirm

### Path Parameters
- **id** (integer) - Required - The ID of the draft order to confirm.

### Response
#### Success Response (200 OK)
Returns the confirmed order object. The response structure is similar to the draft order but represents an order.

#### Response Example
```json
{
    "id": 39138283,
    "token": "baadc175bb1fa32aed0ff355d2c54073dc2ea6ee",
    "store_id": 97902,
    "abandoned_checkout_url": "www.example.com/abandoned-checkout-url-example",
    "contact_email": "pedro.alfonso@gmail.com",
    "contact_name": "Pedro Alfonso",
    "contact_phone": "2930495",
    "contact_identification": "37894333",
    "shipping_name": "Pedro",
    "shipping_phone": "2930495",
    "shipping_address": "",
    "shipping_number": "",
    "shipping_floor": "",
    "shipping_locality": "",
    "shipping_zipcode": "",
    "shipping_city": "",
    "shipping_province": "",
    "shipping_country": "AR",
    "shipping_min_days": null,
    "shipping_max_days": null,
    "billing_name": null,
    "billing_phone": null,
    "billing_address": null,
    "billing_number": null,
    "billing_floor": null,
    "billing_locality": null,
    "billing_zipcode": null,
    "billing_city": null,
    "billing_province": null,
    "billing_country": null,
    "shipping_cost_owner": "0.00",
    "shipping_cost_customer": "0.00",
    "coupon": [],
    "promotional_discount": {
        "id": null,
        "store_id": 97902,
        "order_id": 39138283,
        "created_at": "2020-11-28T02:45:31+0000",
        "total_discount_amount": "0.00",
        "contents": [],
        "promotions_applied": []
    },
    "subtotal": "712.00",
    "discount": "0.00",
    "discount_coupon": "0.00",
    "discount_gateway": "0.00",
    "total": "712.00",
    "total_usd": "0.00",
    "checkout_enabled": true,
    "weight": "0.030",
    "currency": "ARS",
    "language": "es",
    "gateway": "not-provided",
    "gateway_id": null,
    "shipping": "draft",
    "shipping_option": "¡Te vamos a contactar para coordinar la entrega!",
    "shipping_option_code": "draft_99999",
    "shipping_option_reference": null,
    "shipping_pickup_details": null,
    "shipping_tracking_number": null,
    "shipping_tracking_url": null,
    "shipping_store_branch_name": null,
    "shipping_pickup_type": "ship",
    "shipping_suboption": [],
    "extra": {},
    "storefront": "form",
    "note": null,
    "created_at": "2020-11-28T02:45:31+0000",
    "updated_at": "2020-11-28T02:45:31+0000",
    "completed_at": null,
    "next_action": "noop",
    "payment_details": {
        "method": null,
        "credit_card_company": null,
        "installments": 1
    },
    "attributes": [],
    "customer": null,
    "products": [
        {
            "id": 32720575,
            "depth": "0.00",
            "height": "0.00",
            "name": "Oleo Esencial Barba",
            "price": "712.00",
            "product_id": 17310749,
            "image": {
                "id": 0,
                "product_id": 0,
                "src": "www.example.com/photo-example",
                "position": 0,
                "alt": [],
                "created_at": "2020-11-28T02:45:32+0000",
                "updated_at": "2020-11-28T02:45:32+0000"
            },
            "quantity": 1,
            "free_shipping": false,
            "weight": "0.03",
            "width": "0.00",
            "variant_id": 33739143,
            "variant_values": [],
            "properties": {
                "label": "Para papá"
            },
            "sku": null,
            "barcode": null
        }
    ],
    "clearsale": {
        "CodigoIntegracao": false,
        "IP": null,
        "Estado": ""
    },
    "checkout_url": "www.example.com/checkout-example"
}
```
```
Tokens:
Raw