Tiendanube API

https://tiendanube.github.io/api-documentation/
Admin
Tiendanube API is a REST-style API that enables developers to integrate applications with...
Tokens:458,043
Snippets:2,116
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### GET /products/{id} response example

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

Example response for GET /products/1234. The response includes product details such as attributes, categories, images, variants, and localized fields. The HTTP status line is shown as 'HTTP/1.1 200 OK'.

```http
HTTP/1.1 200 OK
```

```json
{  
  "attributes": [  
    {  
      "en": "Size"  
    }  
  ],  
  "categories": [  
    {  
      "created_at": "2013-01-03T09:11:51-03:00",  
      "description": {  
        "en": "",  
        "es": "",  
        "pt": ""  
      },  
      "handle": {  
        "en": "poke-balls",  
        "es": "poke-balls",  
        "pt": "poke-balls"  
      },  
      "id": 4567,  
      "name": {  
        "en": "Poké Balls",  
        "es": "Poké Balls",  
        "pt": "Poké Balls"  
      },  
      "parent": null,  
      "subcategories": [],  
      "google_shopping_category": null,  
      "updated_at": "2013-03-11T09:14:11-03:00"  
    }  
  ],  
  "created_at": "2013-01-03T09:11:51-03:00",  
  "description": {  
    "en": "<p>The best Ball with the ultimate level of performance. It will catch any wild Pokémon without fail.</p>",  
    "es": "<p>La mejor Bola con el nivel máximo de desempeño. Atrapará cualquier Pokémon sin fallar.</p>",  
    "pt": "<p>A melhor Bola com o nível máximo de desempenho. Ele vai pegar qualquer Pokémon selvagem sem falhar.</p>"  
  },  
  "handle": {  
    "en": "master-ball",  
    "es": "master-ball",  
    "pt": "master-ball"  
  },  
  "id": 1234,  
  "images": [  
    {  
      "id": 101,  
      "src": "http://d26lpennugtm8s.cloudfront.net/stores/001/234/products/servine-640-0.jpg",  
      "position": 1,  
      "product_id": 1234  
    },  
    {  
      "id": 112,  
      "src": "http://d26lpennugtm8s.cloudfront.net/stores/001/234/products/onyx-640-0.jpg",  
      "position": 2,  
      "product_id": 1234  
    },  
    {  
      "id": 123,  
      "src": "http://d26lpennugtm8s.cloudfront.net/stores/001/234/products/stoutland-640-0.jpg",  
      "position": 3,  
      "product_id": 1234  
    }  
  ],  
  "name": {  
    "en": "Master Ball",  
    "es": "Master Ball",  
    "pt": "Master Ball"  
  },  
  "brand": null,  
  "video_url": "https://www.youtube.com/watch?v=57aG16_gQcU",  
  "seo_title": "Master Ball",  
  "seo_description": "The best Ball with the ultimate level of performance. It will catch any wild Pokémon without fail.",  
  "published": true,  
  "visibility": "visible",  
  "free_shipping": false,  
  "updated_at": "2013-03-11T09:14:11-03:00",  
  "variants": [  
    {  
      "id": 101,  
      "promotional_price": "19.00",  
      "created_at": "2013-01-03T09:11:51-03:00",  
      "depth": null,  
      "height": null,  
      "values": [  
        {  
          "en": "Small"  
        }  
      ],  
      "price": "25.00",  
      "product_id": 1234,  
      "stock_management": true,  
      "stock": 5,  
      "sku": "BSG1234A",  
      "updated_at": "2013-03-11T09:14:11-03:00",  
      "weight": "2.00",  
      "width": null,  
      "cost": null  
    },  
    {  
      "id": 112,  
      "promotional_price": "19.00",  
      "created_at": "2013-01-03T09:11:51-03:00",  
      "depth": null,  
      "height": null,  
      "values": [  
        {  
          "en": "Small"  
        }  
      ],  
      "price": "25.00",  
      "product_id": 1234,  
      "stock_management": true,  
      "stock": 5,  
      "sku": "BSG1234B",  
      "updated_at": "2013-03-11T09:14:11-03:00",  
      "weight": "2.25",  
      "width": null,  
      "cost": null  
    },  
    {  
      "id": 133,  
      "promotional_price": "19.00",  
      "created_at": "2013-01-03T09:11:51-03:00",  
      "depth": null,  
      "height": null,  
      "values": [  
        {  
          "en": "Small"  
        }  
      ],  
      "price": "25.00",  
      "product_id": 1234,  
      "stock_management": true,  
      "stock": 5,  
      "sku": "BSG1234C",  
      "updated_at": "2013-03-11T09:14:11-03:00",  
      "weight": "2.50",  
      "width": null,  
      "cost": "10.99"  
    }  
  ],  
  "tags": "Brinquedos, pokeball, oferta, colecionismo"  
}  
```

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

### GET /store response example

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

Example response body for the GET /store endpoint, showing all Store properties with sample values. Note the languages object uses currency codes and active flags, and features lists enabled API features.

```json
{  
  "address": null,  
  "admin_language": "pt",  
  "blog": null,  
  "business_id": null,  
  "business_name": null,  
  "business_address": null,  
  "contact_email": "contact@pokestore.com",  
  "country": "BR",  
  "created_at": "2013-01-01T05:12:51-03:00",  
  "customer_accounts": "optional",  
  "description": {  
      "en": "",  
      "es": "",  
      "pt": ""  
  },  
  "domains": [  
    "www.pokestore.com",  
    "www.another.com"  
  ],  
  "email": "owner@pokestore.com",  
  "facebook": "http://www.facebook.com/pokestore",  
  "google_plus": "http://plus.google.com/+pokestore",  
  "id": 1234,  
  "instagram": "http://www.instagram.com/pokestore",  
  "languages": {  
    "en": {  
      "currency" : "USD",  
      "active": true  
    },  
    "es": {  
      "currency" : "ARS",  
      "active": false  
    },  
    "pt": {  
      "currency" : "BRL",  
      "active": true  
    }  
  },  
  "logo": "//d26lpennugtm8s.cloudfront.net/stores/046/themes/common/logo-ff622335866ee56df3bceed2e9d41469.png",  
  "main_currency": "BRL",  
  "current_theme": "luxury",  
  "main_language": "pt",  
  "name": {  
      "en": "Poké Store",  
      "es": "Poké Tienda",  
      "pt": "Poké Loja"  
  },  
  "original_domain" : "pokeloja.nuvemshop.com.br",  
  "phone": null,  
  "whatsapp_phone_number": null,  
  "pinterest": "http://www.pinterest.com/pokestore",  
  "plan_name": "Business",  
  "type": null,  
  "twitter": "http://www.twitter.com/pokestore",  
  "features": [  
    "fulfillment-orders",  
    "inventory-levels"  
  ]  
}  
```

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

### GET /blogs response

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

Example response from the GET /blogs endpoint, showing the blog_id and owner.id fields.

```json
{  
  "blog_id": "019a0baf-d644-755c-aa03-843c92af7047",  
  "owner": {  
    "id": "string"  
  }  
}  

```

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

### GET Dispute Response Example

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

Example response for a GET dispute request, showing the full dispute object with fields such as id, status, amounts, fees, and history.

```json
{  
  "id": "67654a1d7f0000f100f03533",  
  "store_id": "1020559",  
  "app_id": "1234",  
  "order_id": "1612216732",  
  "transaction_id": "02aaa5c6-080a-40e9-a61f-90ca2150d6a2",  
  "reason_code": "fraudulent_activity",  
  "external_reason_code": "fraud",  
  "amount": {  
    "value": "100.00",  
    "currency": "USD"  
  },  
  "transaction_amount": {  
    "value": "100.00",  
    "currency": "USD"  
  },  
  "initiated_at": "2024-12-02T12:30:15.123Z",  
  "evidence_url": "https://url.com",  
  "evidence_sent_at": "2024-12-05T12:30:15.123Z",  
  "closed_at": "2024-12-25T10:42:45.086Z",  
  "status": "won",  
  "evidence_due_at": "2024-12-10T12:30:15.123Z",  
  "retained_total": {  
    "value": "100.00",  
    "currency": "USD"  
  },  
  "retained_settled_amount": {  
    "value": "1000.00",  
    "currency": "ARS",  
    "exchange_rate": {  
      "value": "10.00",  
      "from": "USD"  
    }  
  },  
  "fees": [  
    {  
      "type": "processing_fee",  
      "amount": {  
        "value": "5.00",  
        "currency": "USD"  
      }  
    }  
  ],  
  "history": [  
    {  
      "status": "needs_response",  
      "transitioned_at": "2024-12-02T12:30:15.123Z",  
      "retained_delta": {  
        "value": "0.00",  
        "currency": "USD"  
      },  
      "retained_total": {  
        "value": "0.00",  
        "currency": "USD"  
      },  
      "retained_settled_amount": {  
        "value": "0.00",  
        "currency": "ARS",  
        "exchange_rate": {  
          "value": "10.00",  
          "from": "USD"  
        }  
      }  
    },  
    {  
      "status": "won",  
      "transitioned_at": "2024-12-25T10:42:45.086Z",  
      "retained_delta": {  
        "value": "100.00",  
        "currency": "USD"  
      },  
      "retained_total": {  
        "value": "100.00",  
        "currency": "USD"  
      },  
      "retained_settled_amount": {  
        "value": "1000.00",  
        "currency": "ARS",  
        "exchange_rate": {  
          "value": "10.00",  
          "from": "USD"  
        }  
      }  
    }  
  ]  
}  
```

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

### GET /orders response example

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

Example response for the GET /orders endpoint, showing a single order object with fields such as id, token, store_id, contact information, billing details, totals, and payment_details. The response is truncated at the payment_details object in the source.

```json
HTTP/1.1 200 OK
```
[  
    {  
        "id": 871254203,  
        "token": "b872a1befbcde5aaf0517ecbcc910f5dc005350e",  
        "store_id": "817495",  
        "contact_email": "buyer@tiendanube.com",  
        "contact_name": "Maria Silva",  
        "contact_phone": "+551533276436",  
        "contact_identification": "75839566500",  
        "billing_name": "Maria",  
        "billing_phone": "+551533276436",  
        "billing_address": "Rua Doutor Azevedo Sampaio",  
        "billing_number": "50",  
        "billing_floor": "",  
        "billing_locality": "Centro",  
        "billing_zipcode": "18010220",  
        "billing_city": "Sorocaba",  
        "billing_province": "São Paulo",  
        "billing_country": "BR",  
        "coupon": [],  
        "promotional_discount": {  
            "id": null,  
            "store_id": 817495,  
            "order_id": "871254203",  
            "created_at": "2022-11-15T19:37:08+0000",  
            "total_discount_amount": "0.00",  
            "contents": [],  
            "promotions_applied": []  
        },  
        "subtotal": "6000.00",  
        "discount": "600.00",  
        "discount_coupon": "0.00",  
        "discount_gateway": "600.00",  
        "total": "5400.00",  
        "total_usd": "40.79",  
        "checkout_enabled": true,  
        "weight": "0.000",  
        "currency": "ARS",  
        "language": "es",  
        "gateway": "offline",  
        "gateway_id": null,  
        "gateway_name": "Transferencia Bancaria",  
        "extra": {},  
        "storefront": "store",  
        "note": "",  
        "created_at": "2022-11-15T19:36:59+0000",  
        "updated_at": "2022-11-15T19:37:08+0000",  
        "completed_at": {  
            "date": "2022-11-15 19:36:59.000000",  
            "timezone_type": 3,  
            "timezone": "UTC"  
        },  
        "payment_details": {  
            "method": "custom",  
            "credit_card_company": null,  

```

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

### GET All Fulfillment Order Tracking Events - Response Example

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

Example response for GET /orders/{order_id}/fulfillment-orders/{fulfillment_order_id}/tracking-events. Returns a list of FulfillmentOrderTrackingEvent objects with fields such as id, status, description, address, geolocation, happened_at, estimated_delivery_at, created_at, and updated_at.

```json
[  
   {  
      "id": "01FHZXHK8PTP9FVK99Z66GXJIO",  
      "status": "dispatched",  
      "description": "The package was dispatched",  
      "address": "St. Paul 123, São Paulo - Brazil 02910802",  
      "geolocation": {  
         "longitude": 73.856077,  
         "latitude": 40.848447  
      },  
      "happened_at": "2022-11-24T10:20:19+00:00",                    
      "estimated_delivery_at": "2022-11-24T10:20:19+00:00",                    
      "created_at": "2022-11-24T10:20:19+00:00",  
      "updated_at": "2022-11-24T10:20:19+00:00"  
   }  
]  
```

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

### GET /scripts - List scripts response

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

Example JSON response for GET /scripts with HTTP 200 OK. Shows a list of scripts with fields like id, name, event, location, timestamps, is_auto_install, status, params, current_version, and draft_version.

```json
{
  "result": [
    {
      "id": 12345,
      "name": "Script name",
      "event": "onfirstinteraction",
      "location": "store",
      "created_at": "2024-09-11T20:19:29.000Z",
      "updated_at": "2024-09-11T20:20:19.000Z",
      "is_auto_install": false,
      "status": "active",
      "params": {
        "paramA": 1
      },
      "current_version": {
        "id": 22435,
        "src": "https://apps-scripts.tiendanube.com/app-handle/script-name/2.js?versionId=Dbd4FeTBY9ssDVnDaBeaOmXX8a7raJGS",
        "version": 2
      },
      "draft_version": {
        "id": 22437,
        "src": "https://apps-scripts.tiendanube.com/app-handle/script-name/3.js?versionId=RYH33gaBY9ssDVnDaBeaOmXX8ABDAS3g",
        "version": 3
      }
    },
    {
      "id": 12346,
      "name": "Another script",
      "event": "onfirstinteraction",
      "location": "store",
      "created_at": "2024-09-12T21:40:29.000Z",
      "updated_at": "2024-09-12T21:40:29.000Z",
      "is_auto_install": true,
      "status": "active",
      "current_version": {
        "id": 22456,
        "src": "https://apps-scripts.tiendanube.com/app-handle/another-script/1.js?versionId=Dbd4FeTBY9ssDVnDaBeaOmXX8a7raJGS",
        "version": 1
      },
      "draft_version": null
    }
  ],
  "total": 1
}
```

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

### OAuth authentication configuration example

Source: https://tiendanube.github.io/api-documentation/resources/payment-provider

Example authentication configuration for a Payment Provider using the OAuth scheme. It includes the access token, client credentials, expiration date, refresh token, and the refresh token URL. This configuration is used as the starting point for the token refresh flow.

```json
{  
   "authentication":{  
      "type":"oauth",  
      "access_token":"currentAcccessToken",  
      "client_id":"clientId",  
      "client_secret":"clientSecret",  
      "expires_at":"2023-10-25T12:30:15.000Z",  
      "refresh_token":"refreshToken",  
      "refresh_token_url":"https://acme.com/oauth"  
   }  
}  

```

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

### Create product with image, variant, and categories

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

Request body for POST /products that creates a product with an image URL, multilingual name, video URL, a variant with price/stock/weight/cost, and category IDs.

```json
{  
  "images": [  
    {  
      "src": "http://images1.wikia.nocookie.net/__cb20101106022321/pokemon/images/f/f1/UltraBallArt.png"  
    }  
  ],  
  "name": {  
    "en": "Ultra Ball",  
    "es": "Ultra Ball",  
    "pt": "Ultra Ball"  
  },  
  "video_url": "https://www.youtube.com/watch?v=57aG16_gQcU",  
  "variants": [  
    {  
      "price": "10.00",  
      "stock_management": true,  
      "stock": 12,  
      "weight": "2.00",  
      "cost": "10.99"  
    }  
  ],  
  "categories": [11654304, 11654305]  
}  

```

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

### GET /locations response example

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

Example JSON response for the GET /locations endpoint, showing a list of locations with full address details, tags, and timestamps.

```json
[  
    {  
      "id": "01HTMFDH09VC6E2Q8KGTGP44D3",  
      "name": {
        "es_AR": "Nombre en espanol",  
        "pt_BR": "Nome em português",  
        "en_US": "Name in english"  
      },  
      "store_id": "12345",  
      "priority": 0,  
      "address": {
        "zipcode": "12910802",  
        "street": "St Louis",  
        "number": "01",  
        "floor": "Floor",  
        "locality": "Locality",  
        "city": "São Paulo",  
        "province": {
          "code": "SP",  
          "name": "São Paulo"  
        },  
        "region": {
          "code": "SE",  
          "name": "São Paulo"  
        },  
        "country": {
          "code": "BR",  
          "name": "São Paulo"  
        },  
        "reference": "tiendanube's close",  
        "between_streets": "St Mark Third",  
        "verified_at": "1997-07-16T19:20:30+01:00"  
      },  
      "is_default": true,  
      "tags": [  
        "online",  
        "offline"  
      ],     
      "created_at": "1997-07-16T19:20:30+01:00",  
      "updated_at": "1997-07-16T19:20:30+01:00"  
    },  
    {  
      "id": "01HTMFFHWXRC8TRS40M43XGQFB",  
      "name": {
        "es_AR": "Nombre en espanol",  
        "pt_BR": "Nome em português",  
        "en_US": "Name in english"  
      },  
      "store_id": "12345",  
      "priority": 1,  
      "address": {
        "zipcode": "12910802",  
        "street": "St Louis",  
        "number": "01",  
        "floor": "Floor",  
        "locality": "Locality",  
        "city": "São Paulo",  
        "province": {
          "code": "SP",  
          "name": "São Paulo"  
        },  
        "region": {
          "code": "SE",  
          "name": "São Paulo"  
        },  
        "country": {
          "code": "BR",  
          "name": "São Paulo"  
        },  
        "reference": "tiendanube's close",  
        "between_streets": "St Mark Third",  
        "verified_at": "1997-07-16T19:20:30+01:00"  
      },  
      "is_default": true,  
      "tags": [  
        "online",  
        "offline"  
      ],     
      "created_at": "1997-07-16T19:20:30+01:00",  
      "updated_at": "1997-07-16T19:20:30+01:00"  
    }  
]  
```

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

### Example output of getPaymentIds()

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

Example output of getPaymentIds() showing the format of the returned array of gateway IDs.

```javascript
['mercadopago_transparent_card', 'pagseguro_transparent_debit', 'mercadopago_transparent_offline', 'mercadopago_transparent_pix', 'custom', 'pagseguro_redirect', 'cielo_redirect', 'mercadopago_redirect', 'ame_digital']  
```

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

### Create product with curl

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

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

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

```

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

### GET /locations/{id} response example

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

Example JSON response for the GET /locations/{id} endpoint, showing a single location with full address details, tags, and timestamps.

```json
{  
   "id": "01HTMFDH09VC6E2Q8KGTGP44D3",  
   "name": {
        "es_AR": "Nombre en espanol",  
        "pt_BR": "Nome em português",  
        "en_US": "Name in english"  
   },  
   "store_id": "12345",  
   "priority": 0,  
   "address": {
      "zipcode": "12910802",  
      "street": "St Louis",  
      "number": "01",  
      "floor": "Floor",  
      "locality": "Locality",  
      "city": "São Paulo",  
      "province": {
         "code": "SP",  
         "name": "São Paulo"  
      },  
      "region": {
         "code": "SE",  
         "name": "São Paulo"  
      },  
      "country": {
         "code": "BR",  
         "name": "São Paulo"  
      },  
      "reference": "tiendanube's close",  
      "between_streets": "St Mark Third",  
      "verified_at": "1997-07-16T19:20:30+01:00"  
   },  
   "is_default": true,  
    "tags": [  
      "online",  
      "offline"  
    ],     
   "created_at": "1997-07-16T19:20:30+01:00",  
   "updated_at": "1997-07-16T19:20:30+01:00"  
}  
```

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

### GET /checkouts/{checkout_id} response example

Source: https://tiendanube.github.io/api-documentation/resources/abandoned-checkout

Example response for GET /checkouts/411335234 showing a successful 200 status and the full abandoned checkout object with shipping, billing, product, and payment details.

```http
HTTP/1.1 200 OK
```

```json
	{  
		"id": 411335234,  
		"token": "d0e589b2ba4fef1a4155dc071c253dfk1j34198b9",  
		"store_id": 167985134,  
		"abandoned_checkout_url": "https://nuvemteste.lojavirtualnuvem.com.br/checkout/v3/order/proxy/411335234/d0e589b2ba4fef1a4155dc071c253dfk1j34198b9",  
		"contact_email": "teste@teste.com.br",  
		"contact_name": "Teste 12",  
		"contact_phone": "+551335593019",  
		"contact_identification": "78448385071",  
		"shipping_name": "Teste",  
		"shipping_phone": "+551335593019",  
		"shipping_address": "Rua Ali",  
		"shipping_number": "123",  
		"shipping_floor": "",  
		"shipping_locality": "Mundo Novo",  
		"shipping_zipcode": "29580000",  
		"shipping_city": "Dores do Rio Preto",  
		"shipping_province": "Espirito Santo",  
		"shipping_country": "BR",  
		"shipping_min_days": 0,  
		"shipping_max_days": 0,  
		"billing_name": "Teste",  
		"billing_phone": "+551335593019",  
		"billing_address": "Rua Ali",  
		"billing_number": "123",  
		"billing_floor": "",  
		"billing_locality": "Mundo Novo",  
		"billing_zipcode": "29580000",  
		"billing_city": "Dores do Rio Preto",  
		"billing_province": "Espirito Santo",  
		"billing_country": "BR",  
		"shipping_cost_owner": "1.00",  
		"shipping_cost_customer": "1.00",  
		"coupon": [],  
		"promotional_discount": {  
			"id": null,  
			"store_id": 1679854,  
			"order_id": 411335518,  
			"created_at": "2021-05-18T19:51:19+0000",  
			"total_discount_amount": "0.00",  
			"contents": [],  
			"promotions_applied": []  
			},  
		"subtotal": "290.35",  
		"discount": "0.00",  
		"discount_coupon": "0.00",  
		"discount_gateway": "0.00",  
		"total": "291.35",  
		"total_usd": "0.00",  
		"checkout_enabled": true,  
		"weight": "5.000",  
		"currency": "BRL",  
		"language": "pt",  
		"gateway": null,  
		"gateway_id": null,  
		"shipping": "api_128646",  
		"shipping_option": "Nimbus 2001",  
		"shipping_option_code": "nimbus-201",  
		"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": "store",  
		"note": null,  
		"created_at": "2021-05-12T19:08:06+0000",  
		"updated_at": "2021-05-13T21:04:00+0000",  
		"completed_at": null,  
		"next_action": "noop",  
		"payment_details": {  
			"method": null,  
			"credit_card_company": null,  
			"installments": 1  
		},  
		"attributes": [],  
			"products": [  
			{  
				"id": 516763823,  
				"depth": "2.00",  
				"height": "20.00",  
				"name": "Varinha do Harry Potter (Preto)",  
				"price": "58.07",  
				"product_id": 87219151,  
				"image": {  
					"id": 171099852,  
					"product_id": 87219151,  
					"src": "https://d2r9epyceweg5n.cloudfront.net/stores/001/679/854/products/varinha-hp-luxo-21-5ebe5e31da8e2b693515728471178129-1024-10241-bc9b30adf4b178fabc16202348529015-1024-1024.jpeg",  
					"position": 1,  
					"alt": [],  
					"created_at": "2021-05-05T17:14:05+0000",  
					"updated_at": "2021-05-10T17:22:52+0000"  
					},  
				"quantity": 5,  
				"free_shipping": false,  
				"weight": "1.00",  
				"width": "4.00",  
				"variant_id": 332977991,  
				"variant_values": [  
					"Preto"  
				],  
				"properties": [],  
				"sku": null,  
				"barcode": null  
			}]  
}  
  

```

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

### POST product with string name for all languages

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

POSTs a product with a plain string name, which is applied to all languages. Use this when you want the same value for every 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  

```

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

### POST /products

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

Creates a product and sets its visibility state. You can send either `published` or `visibility`, but not both.

```APIDOC
## [POST] /products

### Description
Creates a product. You may send either `published` or `visibility` to set the product's visibility state, but not both.

### Method
POST

### Endpoint
/products

### Parameters
#### Request Body
- **published** (boolean) - Optional - Sets visibility: `true` → `visible`, `false` → `hidden`. Cannot be sent together with `visibility`.
- **visibility** (string) - Optional - Sets visibility directly: `visible`, `unlisted`, or `hidden`. Cannot be sent together with `published`.

### Request Example
```json
{
  "visibility": "unlisted"
}
```

### Response
#### Success Response (200)
- **visibility** (string) - The resulting visibility state (`visible`, `unlisted`, or `hidden`).
- **published** (boolean) - Derived from `visibility` (`true` for `visible`, `false` otherwise).

#### Response Example
```json
{
  "visibility": "unlisted",
  "published": false
}
```

### Error Handling
- **422** - If both `published` and `visibility` are sent in the same request.

#### Error Response Example
```json
{
  "code": 422,
  "message": "Unprocessable Entity",
  "description": "Cannot send both 'published' and 'visibility'. Use 'visibility' only."
}
```
```

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

### GET Fulfillment Order Tracking Event - Response Example

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

Example response for GET /orders/{order_id}/fulfillment-orders/{fulfillment_order_id}/tracking-events/{fulfillment_order_tracking_event_id}. Returns a single FulfillmentOrderTrackingEvent object with the same fields as the list response.

```json
{  
   "id": "01FHZXHK8PTP9FVK99Z66GXJIO",  
   "status": "dispatched",  
   "description": "The package was dispatched",  
   "address": "St. Paul 123, São Paulo - Brazil 02910802",  
   "geolocation": {  
      "longitude": 73.856077,  
      "latitude": 40.848447  
   },  
   "happened_at": "2022-11-24T10:20:19+00:00",                    
   "estimated_delivery_at": "2022-11-24T10:20:19+00:00",                    
   "created_at": "2022-11-24T10:20:19+00:00",  
   "updated_at": "2022-11-24T10:20:19+00:00"  
}  
```

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

### Create a new promotion - request body

Source: https://tiendanube.github.io/api-documentation/assets/files/postman-291632fb6e11dfc44b4f7be969b78a53.json

Request body for creating a promotion. Includes name, allocation_type, description, disclaimer, active flag, and translations.

```json
{
  "name": "50% off in the second unit",
  "allocation_type": "line_item",
  "description": "Taking two pay 50 percent on the second unit",
  "disclaimer": "Deal only valid for Buenos Aires city",
  "active": true,
  "translations": [
    {
      "lang": "en-us",
      "name": "50% off in the second unit",
      "description": "Taking two pay 50 percent on the second unit",
      "disclaimer": "Deal only valid for Buenos Aires city"
    }
  ]
}
```

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

### POST /products

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

Creates a new product. Sending both `published` and `visibility` in the same request returns HTTP 422.

```APIDOC
## POST /products

### Description
Creates a new product. Sending both `published` and `visibility` in the same request returns HTTP 422.

### Method
POST

### Endpoint
/products

### Request Body
- **published** (boolean) - Optional - Indicates if the product is published.
- **visibility** (string) - Optional - Product visibility setting.

### Response
#### Success Response (200)
- **id** (integer) - Product ID.
- **published** (boolean) - Publication status.
- **visibility** (string) - Visibility setting.

#### Response Example
```json
{
  "id": 5123,
  "published": false,
  "visibility": "unlisted"
}
```

### Error Handling
- **HTTP 422** - Returned when both `published` and `visibility` are sent in the same request.
```

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

### POST /products/{product_id}/images

Source: https://tiendanube.github.io/api-documentation/resources/product-image

Documentation for creating a product image via the POST /products/{product_id}/images endpoint, including parameters, request examples, and responses.

```APIDOC
## POST /products/{product_id}/images

### Description
Creates a new product image. The image can be provided via a URL (`src`), a Base64-encoded attachment, or an existing Store Media UUID (`store_media_uuid`).

### Method
POST

### Endpoint
/products/{product_id}/images

### Parameters
#### Path Parameters
- **product_id** (integer) - Required - The ID of the product to which the image will be added.

#### Request Body
- **src** (string) - Optional - The URL of the image (e.g., `http://example.com/charmander.jpg`).
- **attachment** (string) - Optional - The image encoded as a Base64 string.
- **filename** (string) - Optional - A filename string (e.g., `mewtwo.gif`).
- **position** (integer) - Optional - A number indicating the position in the image list where the new image should be placed.
- **store_media_uuid** (string) - Optional - UUID of an existing Store Media image to use as the source, instead of `src`/`attachment`. The media must belong to the store and be an image (`image/jpeg`, `image/png`, `image/gif`, `image/webp`, `image/avif`). Note: The Store Media resource is only available on the `unstable` version.

### Request Example
```json
{
  "src": "http://example.com/charmander.jpg"
}
```

### Response
#### Success Response (201 Created)
- **id** (integer) - The ID of the created image.
- **src** (string) - The URL of the created image.
- **position** (integer) - The position of the image in the product's image list.
- **product_id** (integer) - The ID of the product.
- **created_at** (string) - The creation timestamp.
- **updated_at** (string) - The last update timestamp.

#### Response Example
```json
{
  "id": 134,
  "src": "http://d26lpennugtm8s.cloudfront.net/stores/001/234/products/charmander-640-0.jpg",
  "position": 4,
  "product_id": 1234,
  "created_at": "2013-04-12T09:14:11-03:00",
  "updated_at": "2013-04-12T09:14:11-03:00"
}
```

### Error Responses
#### 422 Unprocessable Entity
- **src** (array) - Error message when `src` is blank.
- **code** (integer) - Error code.
- **message** (string) - Error message.
- **description** (string) - Detailed error description (e.g., "Product is not allowed to have more than 250 images").

#### Error Example
```json
{
  "src": ["can't be blank"]
}
```

```json
{
  "code": 422,
  "message": "Unprocessable Entity",
  "description": "Product is not allowed to have more than 250 images"
}
```
```
Tokens:
Raw