Skip to content

Tiendup Public API (1.0.0)

API pública para integrar Tiendup 🔑 Para obtener una API Key, sigue los pasos de la documentación:
¿Cómo obtener tu API Key de Tiendup?

Download OpenAPI description
Overview
Languages
Servers
https://{business_slug}.public-api.tiendup.com
Operations
Operations
Operations

Request

Lista productos físicos (ecommerce_type=retail). Para usar este endpoint, el negocio debe tener habilitada la solución de Productos Físicos.

Security
ApiKeyAuth
Query
limitinteger>= 1

Cantidad de resultados por página.

Default 25
pageinteger>= 1

Número de página.

Default 1
curl -i -X GET \
  'https://demo.public-api.tiendup.com/products?limit=25&page=1' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
statusstringrequired
Example: "OK"
dataArray of objects(Product)required

Lista de productos (si no hay, viene vacío).

data[].​idintegerrequired
Example: 12181
data[].​business_idintegerrequired
Example: 265
data[].​hashstring
Example: "WGwJyW"
data[].​namestringrequired
Example: "Producto de ejemplo"
data[].​short_descriptionstring or null
One of:
string
data[].​pricestringrequired
Example: "2500"
data[].​price_minstring or null
One of:
string
data[].​price_maxstring or null
One of:
string
data[].​prices_list_keystring or null
One of:
string
data[].​base_pricestring
Example: "2500"
data[].​price_variesboolean
Example: false
data[].​compare_at_pricestring or null
Example: "3000"
One of:
string
data[].​price_visibleboolean
Example: true
data[].​currencystringrequired
Example: "ARS"
data[].​skustring or null
Example: "abc123"
One of:
string
data[].​slugstring
Example: "producto-de-ejemplo"
data[].​activebooleanrequired
Example: true
data[].​ratinginteger
Example: 0
data[].​reviewsinteger
Example: 0
data[].​salesinteger
Example: 0
data[].​tagsstring
Example: ""
data[].​weightnumber
Example: 1
data[].​lengthnumber
Example: 40
data[].​widthnumber
Example: 40
data[].​heightnumber
Example: 40
data[].​imageProductImage (object) or boolean
One of:
data[].​is_variantboolean
Example: false
data[].​has_variantsboolean
Example: false
data[].​subscription_onlyboolean
Example: false
data[].​requires_shippingboolean
Example: true
data[].​volume_pricing_enabledboolean
Example: false
data[].​ecommerce_typestringrequired
Example: "retail"
data[].​free_shippingboolean
Example: false
data[].​require_loginboolean
Example: false
data[].​double_opt_inboolean
Example: true
data[].​weight_unitstring
Example: "kg"
data[].​vendorstring or null
One of:
string
data[].​stock_managementboolean
Example: false
data[].​sales_channelobject

Mapa de canales de venta donde la clave es el ID del canal.

data[].​is_buyableboolean
Example: true
data[].​publishedboolean
Example: true
data[].​categoriesArray of any
Example: []
data[].​property name*anyadditional property
countFilteredintegerrequired

Cantidad filtrada

countinteger or stringrequired

Puede venir como string o integer.

One of:

Puede venir como string o integer.

integer
previousinteger or nullrequired
One of:
integer
currentintegerrequired
pagesintegerrequired
nextinteger or nullrequired
One of:
integer
property name*anyadditional property
Response
application/json
{ "status": "OK", "data": [ { … } ], "countFiltered": 0, "count": 0, "previous": 0, "current": 0, "pages": 0, "next": 0 }

Traer un producto físico por ID

Request

Devuelve el detalle de un producto físico (ecommerce_type=retail). Requiere que el negocio tenga habilitada la solución de Productos Físicos.

Security
ApiKeyAuth
Path
product_idintegerrequired
Example: 12181
curl -i -X GET \
  https://demo.public-api.tiendup.com/products/12181 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
statusstringrequired
Example: "OK"
dataobject(ProductDetail)required
data.​idintegerrequired
Example: 12181
data.​business_idintegerrequired
Example: 265
data.​hashstring
Example: "WGwJyW"
data.​namestringrequired
Example: "Producto de ejemplo"
data.​short_descriptionstring or null
One of:
string
data.​pricestringrequired
Example: "2500"
data.​price_minstring or null
One of:
string
data.​price_maxstring or null
One of:
string
data.​prices_list_keystring or null
One of:
string
data.​base_pricestring
Example: "2500"
data.​price_variesboolean
Example: false
data.​compare_at_pricestring or null
Example: "3000"
One of:
string
data.​price_visibleboolean
Example: true
data.​currencystringrequired
Example: "ARS"
data.​skustring or null
Example: "abc123"
One of:
string
data.​slugstring
Example: "producto-de-ejemplo"
data.​activebooleanrequired
Example: true
data.​ratinginteger
Example: 0
data.​reviewsinteger
Example: 0
data.​salesinteger
Example: 0
data.​tagsstring
Example: ""
data.​weightnumber
Example: 1
data.​lengthnumber
Example: 40
data.​widthnumber
Example: 40
data.​heightnumber
Example: 40
data.​imageProductImage (object) or boolean
One of:
data.​is_variantboolean
Example: false
data.​has_variantsboolean
Example: false
data.​subscription_onlyboolean
Example: false
data.​requires_shippingboolean
Example: true
data.​volume_pricing_enabledboolean
Example: false
data.​ecommerce_typestringrequired
Example: "retail"
data.​free_shippingboolean
Example: false
data.​require_loginboolean
Example: false
data.​double_opt_inboolean
Example: true
data.​weight_unitstring
Example: "kg"
data.​vendorstring or null
One of:
string
data.​stock_managementboolean
Example: false
data.​sales_channelobject

Mapa de canales de venta donde la clave es el ID del canal.

data.​is_buyableboolean
Example: true
data.​publishedboolean
Example: true
data.​categoriesArray of any
Example: []
data.​descriptionstring or null

Descripción HTML del producto.

Example: "<p>Una descripcion impresionante</p>"
One of:

Descripción HTML del producto.

string
data.​imagesArray of objects(ProductImage)
data.​categoryobject or null

Puede venir null.

One of:

Puede venir null.

object
data.​sellerobject or null
One of:
object
data.​variantsboolean or Array of any

En este ejemplo viene false, pero puede variar.

One of:

En este ejemplo viene false, pero puede variar.

boolean
Valuefalse
data.​related_productsArray of any
Example: []
data.​stock_warehousesArray of any
Example: []
data.​default_variantboolean or object
One of:
boolean
data.​metafieldsobject or null
One of:
object
data.​by_business_gatewaysboolean or object
One of:
boolean
data.​promotional_videoboolean or object
One of:
boolean
data.​customers_permissionsArray of any
Example: []
data.​welcome_email_messagestring or null
One of:
string
data.​property name*anyadditional property
property name*anyadditional property
Response
application/json
{ "status": "OK", "data": { "id": 12181, "business_id": 265, "hash": "WGwJyW", "name": "Producto de ejemplo", "short_description": "string", "price": "2500", "price_min": "string", "price_max": "string", "prices_list_key": "string", "base_price": "2500", "price_varies": false, "compare_at_price": "3000", "price_visible": true, "currency": "ARS", "sku": "abc123", "slug": "producto-de-ejemplo", "active": true, "rating": 0, "reviews": 0, "sales": 0, "tags": "", "weight": 1, "length": 40, "width": 40, "height": 40, "image": { … }, "is_variant": false, "has_variants": false, "subscription_only": false, "requires_shipping": true, "volume_pricing_enabled": false, "ecommerce_type": "retail", "free_shipping": false, "require_login": false, "double_opt_in": true, "weight_unit": "kg", "vendor": "string", "stock_management": false, "sales_channel": { … }, "is_buyable": true, "published": true, "categories": [], "description": "<p>Una descripcion impresionante</p>", "images": [ … ], "category": {}, "seller": {}, "variants": false, "related_products": [], "stock_warehouses": [], "default_variant": true, "metafields": {}, "by_business_gateways": true, "promotional_video": true, "customers_permissions": [], "welcome_email_message": "string" } }
Operations
Operations
Operations
Operations