Locales

Locales de la tienda: tiendas, depósitos, cocinas y puntos de retiro. El stock, los pedidos y los retiros los nombran.

Cargando el índice de búsqueda…

Locales

Objetos

Location

  • idintegerobligatorio

    ID del registro, único entre los registros de su tipo en la tienda.

  • namemapa de stringobligatorio

    Nombre por idioma: un objeto con los idiomas completados, por ejemplo {"es": "Café", "en": "Coffee"}.

  • addressstringobligatorio

    Dirección del local en una línea.

  • coordinatesobject o nullobligatorio

    Ubicació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
    • latnumberobligatorio

      Latitud en grados.

    • lngnumberobligatorio

      Longitud en grados.

  • phonestring o nullobligatorio

    Teléfono del local; null si no está definido.

  • is_activebooleanobligatorio

    false si la tienda desactivó el local.

  • is_defaultbooleanobligatorio

    El 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_pointbooleanobligatorio

    Los clientes pueden retirar pedidos en el local.

  • is_stock_sourcebooleanobligatorio

    El local guarda mercadería: tiene stock, recibe entregas, hace inventarios y transferencias.

  • fulfills_online_ordersbooleanobligatorio

    El 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 nullobligatorio

    Lista 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 objectobligatorio

    Horario 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
    • fromstringobligatorio

      Inicio del intervalo, HH:MM.

    • tostringobligatorio

      Fin del intervalo, HH:MM. Un fin anterior al inicio significa que el intervalo pasa la medianoche.

  • temporarily_closed_atstring (date-time) o nullobligatorio

    Cuándo el local cerró temporalmente; null si está abierto.

  • reopens_onstring (date) o nullobligatorio

    Fecha 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)obligatorio

    Cuándo se creó el registro.

  • updated_atstring (date-time)obligatorio

    Cuá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

  • limitinteger

    Tamaño de página: hasta 250 registros; 50 por defecto.

    Mínimo:
    1
    Máximo:
    250
  • cursorstring

    Cursor 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_deletedboolean

    true — 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

  • dataarray de Locationobligatorio

    Registros de la página.

  • deletedarray de objectobligatorio

    Registros 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
    • idintegerobligatorio

      ID del registro borrado.

    • deleted_atstring (date-time)obligatorio

      Cuándo se borró el registro.

  • next_cursorstring o nullobligatorio

    Cursor de la página siguiente; null en la última.

  • has_morebooleanobligatorio

    true si hay una página siguiente.

  • sync_cursorstring o nullobligatorio

    En 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-Authenticatestringobligatorio

    Esquema 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-Authenticatestring

    Esquema 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-Afterintegerobligatorio

    Segundos de espera antes de reintentar.

    Mínimo:
    0

application/problem+json

Devuelve RateLimitProblem

503La tienda no está disponible por ahora

Encabezados

  • Retry-Afterinteger

    Segundos 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

Ejemplo de solicitud
curl "https://api.saleya.app/v1/locations" \
  -H "Authorization: Bearer $SALEYA_API_TOKEN"
Ejemplo de respuesta · 200
{
  "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"
}