Locales
Locales de la tienda: tiendas, depósitos, cocinas y puntos de retiro. El stock, los pedidos y los retiros los nombran.
Locales
Objetos
Location
idintegerobligatorioID del registro, único entre los registros de su tipo en la tienda.
namemapa de stringobligatorioNombre por idioma: un objeto con los idiomas completados, por ejemplo {"es": "Café", "en": "Coffee"}.
addressstringobligatorioDirección del local en una línea.
coordinatesobject o nullobligatorioUbicación del local en el mapa; null si no está definida. Un local sin ella no se muestra en el mapa de la tienda online.
Campos · 2
latnumberobligatorioLatitud en grados.
lngnumberobligatorioLongitud en grados.
phonestring o nullobligatorioTeléfono del local; null si no está definido.
is_activebooleanobligatoriofalse si la tienda desactivó el local.
is_defaultbooleanobligatorioEl local principal de la tienda: los pedidos con envío toman stock de él si no se eligió otro local. La tienda tiene uno.
is_pickup_pointbooleanobligatorioLos clientes pueden retirar pedidos en el local.
is_stock_sourcebooleanobligatorioEl local guarda mercadería: tiene stock, recibe entregas, hace inventarios y transferencias.
fulfills_online_ordersbooleanobligatorioEl stock del local se vende a los clientes online. Tiene sentido solo con is_stock_source en true: una cocina guarda mercadería pero no la vende.
price_list_idinteger o nullobligatorioLista de precios del local: sus precios de venta sobre los precios base. null — el local vende a precios base. Una lista puede servir a varios locales.
working_hoursmapa de array de objectobligatorioHorario de atención: día de la semana (mon, tue, wed, thu, fri, sat, sun) → lista de intervalos en la zona horaria de la tienda. Un día sin intervalos está cerrado.
Campos · 2
fromstringobligatorioInicio del intervalo, HH:MM.
tostringobligatorioFin del intervalo, HH:MM. Un fin anterior al inicio significa que el intervalo pasa la medianoche.
temporarily_closed_atstring (date-time) o nullobligatorioCuándo el local cerró temporalmente; null si está abierto.
reopens_onstring (date) o nullobligatorioFecha en que el local cerrado temporalmente vuelve a abrir, en la zona horaria de la tienda; null si está abierto o la fecha no se conoce.
created_atstring (date-time)obligatorioCuándo se creó el registro.
updated_atstring (date-time)obligatorioCuándo cambió el registro por última vez.
Endpoints
Listar los locales de la tienda disponibles para la aplicación
get/locations
Scope: locations:read
Parámetros
Query
limitintegerTamaño de página: hasta 250 registros; 50 por defecto.
- Mínimo:
- 1
- Máximo:
- 250
cursorstringCursor opaco: next_cursor de la página anterior, o sync_cursor de la última página guardado por la sincronización anterior. El listado va en orden de confirmación, así que el cursor de sincronización devuelve luego solo lo que cambió después de él.
- Largo máximo:
- 4096
updated_sincestring (date-time)Solo los registros cambiados después de este momento, ISO 8601 con zona horaria. Un filtro de la primera sincronización; después se sigue con el cursor.
- Patrón:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — devolver también los registros eliminados: los archivados con deleted_at y los borrados de la base como marcas de eliminación {id, deleted_at} en la continuación por el cursor de sincronización. Activalo para sincronizar.
Respuestas
200Éxito
application/json
Registros de la página.
deletedarray de objectobligatorioRegistros borrados de la base desde el cursor, como marcas de eliminación: solo con include_deleted=true en la continuación por el cursor de sincronización.
Campos · 2
idintegerobligatorioID del registro borrado.
deleted_atstring (date-time)obligatorioCuándo se borró el registro.
next_cursorstring o nullobligatorioCursor de la página siguiente; null en la última.
has_morebooleanobligatoriotrue si hay una página siguiente.
sync_cursorstring o nullobligatorioEn la última página — el cursor desde el que continuar más tarde: con él llega solo lo que cambió después de esta página. null en las demás.
401Falta el token, es inválido, venció o fue revocado
Encabezados
WWW-AuthenticatestringobligatorioEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer
application/problem+json
Devuelve Problem
403El plan, la dirección IP o los scopes del token no permiten la solicitud
Encabezados
WWW-AuthenticatestringEsquema de autenticación (RFC 6750).
- Ejemplo:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Devuelve ForbiddenProblem
410El cursor de sincronización supera el plazo de conservación de eliminaciones o se emitió antes de restaurar la base de datos
application/problem+json
Devuelve Problem
422Un parámetro es inválido o desconocido
application/problem+json
Devuelve ValidationProblem
429Se agotó el límite de solicitudes
Encabezados
Retry-AfterintegerobligatorioSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve RateLimitProblem
503La tienda no está disponible por ahora
Encabezados
Retry-AfterintegerSegundos de espera antes de reintentar.
- Mínimo:
- 0
application/problem+json
Devuelve Problem
Errores de este endpoint
Los errores comunes, como token, acceso, validación de la entrada y límite de solicitudes, pueden venir de cualquier endpoint; están en el catálogo: Errores
curl "https://api.saleya.app/v1/locations" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"name": {
"key": "string"
},
"address": "string",
"coordinates": {
"lat": 0,
"lng": 0
},
"phone": "string",
"is_active": true,
"is_default": true,
"is_pickup_point": true,
"is_stock_source": true,
"fulfills_online_orders": true,
"price_list_id": 0,
"working_hours": {
"key": [
{
"from": "string",
"to": "string"
}
]
},
"temporarily_closed_at": "2026-01-15T12:00:00Z",
"reopens_on": "2026-01-15",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}