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

Request

Retorna el listado paginado de eventos del negocio.

Security
ApiKeyAuth
curl -i -X GET \
  https://demo.public-api.tiendup.com/events \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Events list

Bodyapplication/json
statusstringrequired
Example: "OK"
dataArray of objects(EventListItem)required
data[].​idintegerrequired
Example: 101115
data[].​hashstring
Example: "W9LalX"
data[].​namestringrequired
data[].​short_descriptionstring or null
data[].​pricestring
Example: "10000"
data[].​price_minstring or null
data[].​price_maxstring or null
data[].​prices_list_keystring or null
data[].​base_pricestring
data[].​price_variesboolean
data[].​compare_at_pricestring or null
data[].​price_visibleboolean
data[].​subscription_onlyboolean
data[].​currencystring
Example: "ARS"
data[].​ecommerce_typestringrequired
Example: "event"
data[].​skustring or null
data[].​slugstringrequired
data[].​activebooleanrequired
data[].​ratingnumber
Example: 0
data[].​reviewsinteger
Example: 0
data[].​salesinteger
Example: 0
data[].​tagsstring
Example: ""
data[].​imageProductImage (object) or boolean
One of:
data[].​egiftboolean
data[].​is_variantboolean
data[].​has_variantsboolean
data[].​min_purchase_quantityinteger
Example: 1
data[].​max_purchase_quantityinteger or null
data[].​double_opt_inboolean
data[].​is_onlineboolean
data[].​location_typestring or null
Example: "physical"
data[].​schedule_typestring
Example: "daily"
data[].​timezonestring
Example: "America/Argentina/Buenos_Aires"
data[].​start_datestring
Example: "2022-10-13"
data[].​end_datestring
Example: "2022-10-20"
data[].​from_timestring
Example: "10:00"
data[].​to_timestring
Example: "12:00"
data[].​start_datetimestring
Example: "2022-10-13 10:00:00"
data[].​end_datetimestring
Example: "2022-10-20 12:00:00"
data[].​sales_startboolean or string or null
Example: false
One of:
boolean
data[].​sales_endboolean or string or null
Example: false
One of:
boolean
data[].​total_daysinteger
Example: 1
data[].​schedule_visibleboolean
data[].​instructionsstring or null
data[].​weekdaysArray of any
data[].​internal_versionstring
Example: "2"
data[].​capacityinteger or boolean or null
Example: false
One of:
integer
data[].​daysArray of any
data[].​has_different_schedulesboolean
data[].​locationEventLocationOnline (object) or EventLocationPhysical (object) or null
One of:
data[].​speakersArray of objects(EventSpeaker)
data[].​attendee_emailsstring or null
data[].​total_ticketsinteger
data[].​tickets_confirmedinteger
data[].​tickets_openinteger
data[].​tickets_cancelledinteger
data[].​tickets_pendinginteger
data[].​vendorstring or null
data[].​stock_managementboolean
data[].​stock_oversellingboolean or null
data[].​stock_availableinteger or null
data[].​stock_quantity_warninginteger or null
data[].​stock_onhandinteger or null
data[].​stock_committedinteger or null
data[].​stock_incominginteger or null
data[].​sales_channelobject or Array of any or null
One of:
data[].​is_buyableboolean
data[].​publishedbooleanrequired
data[].​categoriesArray of Category (objects) or null
One of:
data[].​property name*anyadditional property
countFilteredinteger or string
Example: "5"
One of:
integer
countinteger or string
Example: "5"
One of:
integer
previousinteger
Example: 1
currentinteger
Example: 1
pagesinteger
Example: 1
nextinteger
Example: 1
Response
application/json
{ "status": "OK", "data": [ { … } ], "countFiltered": "5", "count": "5", "previous": 1, "current": 1, "pages": 1, "next": 1 }

Request

Obtiene un evento por id o hash.

Security
ApiKeyAuth
Path
event_idstringrequired

ID numérico o hash del evento.

Example: 101115
curl -i -X GET \
  https://demo.public-api.tiendup.com/events/101115 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Event

Bodyapplication/json
statusstringrequired
Example: "OK"
dataobject(EventListItem)required
data.​idintegerrequired
Example: 101115
data.​hashstring
Example: "W9LalX"
data.​namestringrequired
data.​short_descriptionstring or null
data.​pricestring
Example: "10000"
data.​price_minstring or null
data.​price_maxstring or null
data.​prices_list_keystring or null
data.​base_pricestring
data.​price_variesboolean
data.​compare_at_pricestring or null
data.​price_visibleboolean
data.​subscription_onlyboolean
data.​currencystring
Example: "ARS"
data.​ecommerce_typestringrequired
Example: "event"
data.​skustring or null
data.​slugstringrequired
data.​activebooleanrequired
data.​ratingnumber
Example: 0
data.​reviewsinteger
Example: 0
data.​salesinteger
Example: 0
data.​tagsstring
Example: ""
data.​imageProductImage (object) or boolean
One of:
data.​egiftboolean
data.​is_variantboolean
data.​has_variantsboolean
data.​min_purchase_quantityinteger
Example: 1
data.​max_purchase_quantityinteger or null
data.​double_opt_inboolean
data.​is_onlineboolean
data.​location_typestring or null
Example: "physical"
data.​schedule_typestring
Example: "daily"
data.​timezonestring
Example: "America/Argentina/Buenos_Aires"
data.​start_datestring
Example: "2022-10-13"
data.​end_datestring
Example: "2022-10-20"
data.​from_timestring
Example: "10:00"
data.​to_timestring
Example: "12:00"
data.​start_datetimestring
Example: "2022-10-13 10:00:00"
data.​end_datetimestring
Example: "2022-10-20 12:00:00"
data.​sales_startboolean or string or null
Example: false
One of:
boolean
data.​sales_endboolean or string or null
Example: false
One of:
boolean
data.​total_daysinteger
Example: 1
data.​schedule_visibleboolean
data.​instructionsstring or null
data.​weekdaysArray of any
data.​internal_versionstring
Example: "2"
data.​capacityinteger or boolean or null
Example: false
One of:
integer
data.​daysArray of any
data.​has_different_schedulesboolean
data.​locationEventLocationOnline (object) or EventLocationPhysical (object) or null
One of:
data.​speakersArray of objects(EventSpeaker)
data.​attendee_emailsstring or null
data.​total_ticketsinteger
data.​tickets_confirmedinteger
data.​tickets_openinteger
data.​tickets_cancelledinteger
data.​tickets_pendinginteger
data.​vendorstring or null
data.​stock_managementboolean
data.​stock_oversellingboolean or null
data.​stock_availableinteger or null
data.​stock_quantity_warninginteger or null
data.​stock_onhandinteger or null
data.​stock_committedinteger or null
data.​stock_incominginteger or null
data.​sales_channelobject or Array of any or null
One of:
data.​is_buyableboolean
data.​publishedbooleanrequired
data.​categoriesArray of Category (objects) or null
One of:
data.​property name*anyadditional property
Response
application/json
{ "status": "OK", "data": { "id": 101115, "hash": "W9LalX", "name": "string", "short_description": "string", "price": "10000", "price_min": "string", "price_max": "string", "prices_list_key": "string", "base_price": "string", "price_varies": true, "compare_at_price": "string", "price_visible": true, "subscription_only": true, "currency": "ARS", "ecommerce_type": "event", "sku": "string", "slug": "string", "active": true, "rating": 0, "reviews": 0, "sales": 0, "tags": "", "image": { … }, "egift": true, "is_variant": true, "has_variants": true, "min_purchase_quantity": 1, "max_purchase_quantity": 0, "double_opt_in": true, "is_online": true, "location_type": "physical", "schedule_type": "daily", "timezone": "America/Argentina/Buenos_Aires", "start_date": "2022-10-13", "end_date": "2022-10-20", "from_time": "10:00", "to_time": "12:00", "start_datetime": "2022-10-13 10:00:00", "end_datetime": "2022-10-20 12:00:00", "sales_start": false, "sales_end": false, "total_days": 1, "schedule_visible": true, "instructions": "string", "weekdays": [ … ], "internal_version": "2", "capacity": false, "days": [ … ], "has_different_schedules": true, "location": { … }, "speakers": [ … ], "attendee_emails": "string", "total_tickets": 0, "tickets_confirmed": 0, "tickets_open": 0, "tickets_cancelled": 0, "tickets_pending": 0, "vendor": "string", "stock_management": true, "stock_overselling": true, "stock_available": 0, "stock_quantity_warning": 0, "stock_onhand": 0, "stock_committed": 0, "stock_incoming": 0, "sales_channel": { … }, "is_buyable": true, "published": true, "categories": [ … ] } }

Request

Retorna las ediciones (variants) de un evento.

Security
ApiKeyAuth
Path
event_idstringrequired

ID numérico o hash del evento.

Example: 101115
curl -i -X GET \
  https://demo.public-api.tiendup.com/events/101115/variants \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Event editions

Bodyapplication/json
statusstringrequired
Example: "OK"
dataArray of objects(EventVariant)required
data[].​idintegerrequired
Example: 109202
data[].​namestringrequired
Example: "Viernes 10 de Junio 2022 14:30 hs."
data[].​start_datestring
Example: "2022-06-10"
data[].​end_datestring
Example: "2022-06-11"
data[].​from_timestring
Example: "14:30"
data[].​to_timestring
Example: "17:00"
data[].​start_datetimestringrequired
Example: "2022-06-10 14:30:00"
data[].​end_datetimestringrequired
Example: "2022-06-11 17:00:00"
data[].​timezonestringrequired
Example: "America/Argentina/Buenos_Aires"
data[].​sales_startboolean or string or null
Example: false
One of:
boolean
data[].​sales_endboolean or string or null
Example: false
One of:
boolean
data[].​total_daysinteger
Example: 2
data[].​activebooleanrequired
Example: true
data[].​past_daysinteger
Example: 2
data[].​upcoming_daysinteger
Example: 0
data[].​last_day_datetimestring or null
data[].​next_day_datetimestring or null
data[].​stock_managementboolean
data[].​stock_availableinteger
data[].​event_statusstring
Example: "ended"
data[].​total_ticketsinteger
data[].​tickets_confirmedinteger
data[].​tickets_openinteger
data[].​tickets_cancelledinteger
data[].​tickets_pendinginteger
data[].​locationobject(EventLocationOnline)
data[].​property name*anyadditional property
Response
application/json
{ "status": "OK", "data": [ { … } ] }

Request

Inscribe un cliente a un evento.

  • Si event_id corresponde al ID del evento principal, se inscribirá en la primera edición disponible.
  • Si event_id corresponde al ID de una edición (variant), se inscribirá en esa edición específica.
Security
ApiKeyAuth
Path
event_idintegerrequired

ID del evento o ID de una edición.

Example: 101115
customer_idintegerrequired
Example: 42020
Bodyapplication/jsonrequired
enrollment_typestringrequired
Enum"paid""free"
Example: "paid"
curl -i -X PUT \
  https://demo.public-api.tiendup.com/events/101115/enrolled/42020 \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "enrollment_type": "paid"
  }'

Responses

Enrollment successful

Bodyapplication/json
statusstringrequired
Example: "OK"
Response
application/json
{ "status": "OK" }

Request

Inscribe una persona a un evento utilizando su email.

  • Si event_id corresponde al ID del evento principal, se inscribirá en la primera edición disponible.
  • Si event_id corresponde al ID de una edición (variant), se inscribirá en esa edición específica.
Security
ApiKeyAuth
Path
event_idintegerrequired

ID del evento o ID de una edición.

Example: 101115
Bodyapplication/jsonrequired
customerobjectrequired
customer.​emailstring(email)required
Example: "customer7@example.com"
customer.​namestring
Example: "DARRIO"
customer.​last_namestring or null
Example: "Perez"
enrollment_typestringrequired
Enum"paid""free"
Example: "paid"
curl -i -X POST \
  https://demo.public-api.tiendup.com/events/101115/enroll \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -d '{
    "customer": {
      "email": "customer7@example.com",
      "name": "DARRIO",
      "last_name": "Perez"
    },
    "enrollment_type": "paid"
  }'

Responses

Enrollment successful

Bodyapplication/json
statusstringrequired
Example: "OK"
Response
application/json
{ "status": "OK" }

Request

Retorna el listado de personas inscriptas (tickets) a un evento.

  • Si event_id corresponde al ID del evento principal, devuelve tickets de la primera edición disponible (según lógica interna).
  • Si event_id corresponde al ID de una edición (variant), devuelve tickets de esa edición.
Security
ApiKeyAuth
Path
event_idintegerrequired

ID del evento o de una edición.

Example: 101115
Query
pageinteger>= 1
Example: page=1
per_pageinteger[ 1 .. 200 ]
Example: per_page=50
curl -i -X GET \
  'https://demo.public-api.tiendup.com/events/101115/tickets?page=1&per_page=50' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Tickets list

Bodyapplication/json
statusstringrequired
Example: "OK"
dataArray of objects(EventTicket)required
data[].​idintegerrequired
Example: 2933925
data[].​numberstringrequired
Example: "1"
data[].​enrollment_typestringrequired

Tipo de inscripción en el evento.

Enum"free""paid""unenrolled"
Example: "free"
data[].​attendeeobject(EventTicketAttendee)required
data[].​attendee.​rolestringrequired
Example: "guest"
data[].​attendee.​customer_idinteger or null
Example: 280154
data[].​attendee.​namestringrequired
Example: "Euge"
data[].​attendee.​last_namestring or null
Example: "Chielli"
data[].​attendee.​emailstring(email)required
Example: "customer8@example.com"
data[].​attendee.​phonestring or null
Example: "+1 202 555 1004"
data[].​creation_datestringrequired
Example: "2024-02-06 14:47:26"
data[].​statusstringrequired

Estado del ticket.

Example: "confirmed"
data[].​data_source_typestring or null
Example: "api"
data[].​order_hashstring or null
Example: "JKpb92dwDo"
data[].​orderEventTicketOrder (object) or null
One of:
data[].​pricestring or null
Example: "10000"
data[].​base_pricestring or null
Example: "10000"
data[].​eventobject(EventTicketEvent)required
data[].​event.​idintegerrequired
Example: 223606
data[].​event.​namestringrequired
Example: "Workshop ... (Sábado 2 de Marzo 2024 09:30 hs.)"
data[].​event.​product_idintegerrequired
Example: 101115
data[].​event.​product_namestringrequired
Example: "Workshop de Marmolados..."
data[].​event.​variant_namestringrequired
Example: "Sábado 2 de Marzo 2024 09:30 hs."
data[].​event.​is_variantbooleanrequired
Example: true
countFilteredinteger or string
Example: 11
One of:
integer
countinteger or string
Example: 1
One of:
integer
previousinteger
Example: 1
currentinteger
Example: 1
pagesinteger
Example: 1
nextinteger
Example: 1
Response
application/json
{ "status": "OK", "data": [ { … } ], "countFiltered": 11, "count": 1, "previous": 1, "current": 1, "pages": 1, "next": 1 }

Request

Retorna un ticket (inscripción) individual por ticket_id.

Security
ApiKeyAuth
Path
ticket_idintegerrequired
Example: 4071000
curl -i -X GET \
  https://demo.public-api.tiendup.com/events/tickets/4071000 \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Ticket detail

Bodyapplication/json
statusstringrequired
Example: "OK"
dataobject(EventTicketDetail)required
data.​idintegerrequired
Example: 4071000
data.​numberstringrequired
Example: "2"
data.​enrollment_typestringrequired
Enum"free""paid""unenrolled"
Example: "paid"
data.​attendeeobject(EventTicketAttendeeDetail)required
data.​attendee.​rolestringrequired
Example: "guest"
data.​attendee.​customer_idinteger or null
Example: null
data.​attendee.​namestringrequired
Example: "Sophia"
data.​attendee.​last_namestring or null
Example: "Fay"
data.​attendee.​invited_byTicketInvitedBy (object) or null
One of:
data.​attendee.​emailstring(email)required
Example: "customer9@example.com"
data.​creation_datestringrequired
Example: "2024-11-09 08:34:27"
data.​statusstringrequired
Example: "confirmed"
data.​data_source_typestring or null
Example: "api"
data.​eventobject(EventListItem)required
data.​event.​idintegerrequired
Example: 101115
data.​event.​hashstring
Example: "W9LalX"
data.​event.​namestringrequired
data.​event.​short_descriptionstring or null
data.​event.​pricestring
Example: "10000"
data.​event.​price_minstring or null
data.​event.​price_maxstring or null
data.​event.​prices_list_keystring or null
data.​event.​base_pricestring
data.​event.​price_variesboolean
data.​event.​compare_at_pricestring or null
data.​event.​price_visibleboolean
data.​event.​subscription_onlyboolean
data.​event.​currencystring
Example: "ARS"
data.​event.​ecommerce_typestringrequired
Example: "event"
data.​event.​skustring or null
data.​event.​slugstringrequired
data.​event.​activebooleanrequired
data.​event.​ratingnumber
Example: 0
data.​event.​reviewsinteger
Example: 0
data.​event.​salesinteger
Example: 0
data.​event.​tagsstring
Example: ""
data.​event.​imageProductImage (object) or boolean
One of:
data.​event.​egiftboolean
data.​event.​is_variantboolean
data.​event.​has_variantsboolean
data.​event.​min_purchase_quantityinteger
Example: 1
data.​event.​max_purchase_quantityinteger or null
data.​event.​double_opt_inboolean
data.​event.​is_onlineboolean
data.​event.​location_typestring or null
Example: "physical"
data.​event.​schedule_typestring
Example: "daily"
data.​event.​timezonestring
Example: "America/Argentina/Buenos_Aires"
data.​event.​start_datestring
Example: "2022-10-13"
data.​event.​end_datestring
Example: "2022-10-20"
data.​event.​from_timestring
Example: "10:00"
data.​event.​to_timestring
Example: "12:00"
data.​event.​start_datetimestring
Example: "2022-10-13 10:00:00"
data.​event.​end_datetimestring
Example: "2022-10-20 12:00:00"
data.​event.​sales_startboolean or string or null
Example: false
One of:
boolean
data.​event.​sales_endboolean or string or null
Example: false
One of:
boolean
data.​event.​total_daysinteger
Example: 1
data.​event.​schedule_visibleboolean
data.​event.​instructionsstring or null
data.​event.​weekdaysArray of any
data.​event.​internal_versionstring
Example: "2"
data.​event.​capacityinteger or boolean or null
Example: false
One of:
integer
data.​event.​daysArray of any
data.​event.​has_different_schedulesboolean
data.​event.​locationEventLocationOnline (object) or EventLocationPhysical (object) or null
One of:
data.​event.​speakersArray of objects(EventSpeaker)
data.​event.​attendee_emailsstring or null
data.​event.​total_ticketsinteger
data.​event.​tickets_confirmedinteger
data.​event.​tickets_openinteger
data.​event.​tickets_cancelledinteger
data.​event.​tickets_pendinginteger
data.​event.​vendorstring or null
data.​event.​stock_managementboolean
data.​event.​stock_oversellingboolean or null
data.​event.​stock_availableinteger or null
data.​event.​stock_quantity_warninginteger or null
data.​event.​stock_onhandinteger or null
data.​event.​stock_committedinteger or null
data.​event.​stock_incominginteger or null
data.​event.​sales_channelobject or Array of any or null
One of:
data.​event.​is_buyableboolean
data.​event.​publishedbooleanrequired
data.​event.​categoriesArray of Category (objects) or null
One of:
data.​event.​property name*anyadditional property
data.​sourceSalesChannelSource (object) or null
One of:
data.​orderEventTicketOrderDetail (object) or null
One of:
data.​pricestring or null
Example: "10000"
data.​base_pricestring or null
Example: "10000"
data.​total_ticketsinteger or string
Example: "2"
One of:
integer
Response
application/json
{ "status": "OK", "data": { "id": 4071000, "number": "2", "enrollment_type": "paid", "attendee": { … }, "creation_date": "2024-11-09 08:34:27", "status": "confirmed", "data_source_type": "api", "event": { … }, "source": { … }, "order": { … }, "price": "10000", "base_price": "10000", "total_tickets": "2" } }

Request

Revoca (cancela) la inscripción a un evento a partir del enrollment_id.

El ticket pasará a estado unenrolled según la lógica interna.

Security
ApiKeyAuth
Path
enrollment_idintegerrequired

ID de la inscripción (ticket).

Example: 4071000
curl -i -X PUT \
  https://demo.public-api.tiendup.com/events/enrollments/4071000/revoke \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Enrollment revoked successfully

Bodyapplication/json
statusstringrequired
Example: "OK"
Response
application/json
{ "status": "OK" }