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
openapi.json
openapi.yaml
Overview
Tiendup
soporte@tiendup.com
Languages
Servers
https://{business_slug}.public-api.tiendup.com

Orders

Operations

Customers

Operations

Listado de clientes

Request

Retorna el listado de clientes del negocio. Paginación por query string (page y limit).

Security
ApiKeyAuth
Query
pageinteger>= 1

Número de página (empieza en 1).

Default 1
limitinteger>= 1

Cantidad de resultados por página (default 25).

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

Responses

OK

Bodyapplication/json
statusstringrequired
Example: "OK"
dataArray of objects(CustomerSummary)required
data[].​idintegerrequired
Example: 41974
data[].​namestring
Example: "Roberta"
data[].​last_namestring
Example: "Fernandez"
data[].​emailstring(email)required
Example: "customer2@example.com"
data[].​phonestring
Example: "+1 202 555 1001"
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
}

Obtener cliente

Request

Devuelve la información de un cliente y datos relacionados (contacts, addresses, orders, etc.).

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

Responses

OK

Bodyapplication/json
statusstringrequired
Example: "OK"
dataobject(Customer)required
data.​idintegerrequired
Example: 41974
data.​namestring
Example: "Roberta"
data.​last_namestring
Example: "Fernandez"
data.​emailstring(email)required
Example: "customer2@example.com"
data.​phonestring
Example: "+1 202 555 1001"
data.​identificationstring or null
One of:
string
data.​identification_typestring or null
One of:
string
data.​companystring or null
One of:
string
data.​tax_treatmentstring or null
One of:
string
data.​tax_id_typestring or null
One of:
string
data.​tax_id_numberstring or null
One of:
string
data.​languagestring
Example: ""
data.​member_idinteger or string or null
Example: 5783
One of:
integer
data.​autologin_hashstring or null
One of:
string
data.​is_sellerboolean
Example: false
data.​contactsArray of objects(CustomerContact)
data.​addressesArray of objects(CustomerAddress)
data.​ordersArray of objects(Order)

Órdenes asociadas al cliente (puede venir vacío).

data.​categoriesArray of any
Example: []
data.​metafieldsArray of arrays or object
Example: []
One of:
arrays
data.​sellerobject or null

Información de vendedor si aplica.

One of:

Información de vendedor si aplica.

object
data.​subscriptionsArray of any

Suscripciones asociadas (si aplica).

Example: []
data.​property name*anyadditional property
property name*anyadditional property
Response
application/json
{
  "status": "OK",
  "data": {
    "id": 41974,
    "name": "Roberta",
    "last_name": "Fernandez",
    "email": "customer2@example.com",
    "phone": "+1 202 555 1001",
    "identification": "string",
    "identification_type": "string",
    "company": "string",
    "tax_treatment": "string",
    "tax_id_type": "string",
    "tax_id_number": "string",
    "language": "",
    "member_id": 5783,
    "autologin_hash": "string",
    "is_seller": false,
    "contacts": [ … ],
    "addresses": [ … ],
    "orders": [ … ],
    "categories": [],
    "metafields": [],
    "seller": {},
    "subscriptions": []
  }
}

Physical Products

Operations

Courses

Operations

Downloadables

Operations

Sessions

Operations

Subscriptions

Operations

Events

Operations