Synup
Crear clave
v1Recursos/Locations/getObtener una ubicación

Obtener una ubicación

Devuelve el perfil de negocio completo de una ubicación: dirección, horario, categorías, atributos, servicios, medios y estado de verificación.

get/api/v1/locations/{id}
locations:read
Parámetros de consulta
idstringobligatorio
La ubicación a consultar.
Respuesta
dataobjectopcional
El perfil de negocio completo de una ubicación: dirección, horario, categorías, atributos, servicios, medios y estado — todo lo que update_location puede cambiar, además de lo que create devolvió.
idstringopcional
Identificador único de la ubicación.
namestringopcional
El nombre comercial de la ubicación.
descriptionstringopcional
Una descripción del negocio, o null.
taglinestringopcional
Un lema o eslogan breve del negocio, o null.
storeCodestringopcional
Su código o referencia interna de tienda para esta ubicación, o null.
logoUrlstringopcional
URL de la imagen del logo de la ubicación, o null.
streetstringopcional
Dirección postal, línea 1, o null.
street1stringopcional
Dirección postal, línea 2, o null.
citystringopcional
Ciudad.
statestringopcional
Estado o región.
postalCodestringopcional
Código postal, o null.
countrystringopcional
País, como código ISO-3166-1 alfa-2, o null.
latitudenumberopcional
Latitud, o null.
longitudenumberopcional
Longitud, o null.
phonestringopcional
Número de teléfono principal, o null.
additionalPhonesarray of stringopcional
Cualquier número de teléfono adicional además del principal.
websitestringopcional
La URL del sitio web de la ubicación, o null.
businessEmailstringopcional
Un correo electrónico de contacto público del negocio, o null.
categoryNamestringopcional
El nombre visible de la categoría general, o null.
primaryCategoryDisplaystringopcional
El nombre visible de la categoría principal efectiva — por publisher (Google) si está establecida, si no, la general — o null.
primaryCategoryGooglestringopcional
El id de la categoría principal de Google de la ubicación (gcid), o null.
additionalCategoriesarray of objectopcional
Hasta 9 categorías adicionales, cada una con un id (cuando se resuelve) y un nombre visible.
idstringopcional
namestringopcional
attributesarray of objectopcional
Atributos del perfil de Google Business, como la lista almacenada { id, value }.
idstringopcional
valueobjectopcional
El valor del atributo — un booleano para atributos de sí/no, una cadena para los de elección única, o un objeto con setValues/unsetValues para los de selección múltiple.
servicesarray of objectopcional
Los servicios o productos que ofrece esta ubicación.
namestringopcional
descriptionstringopcional
pricenumberopcional
currencystringopcional
googleServiceTypeIdstringopcional
ownerNamestringopcional
El nombre del propietario, o null.
menuUrlstringopcional
URL del menú del negocio, o null.
yearEstablishednumberopcional
El año en que se estableció el negocio, o null.
tagsarray of stringopcional
Etiquetas internas para su propia organización — no se muestran públicamente.
labelsarray of stringopcional
Rótulos internos para esta ubicación.
regularHoursarray of objectopcional
El horario semanal habitual, o null.
daystring (MONDAY | TUESDAY | WEDNESDAY | THURSDAY | FRIDAY | SATURDAY | SUNDAY)opcional
closedbooleanopcional
periodsarray of objectopcional
openstringopcional
closestringopcional
moreHoursarray of objectopcional
Tipos de horario adicionales más allá del horario habitual (entrega, para llevar, etc.), o null.
specialHoursarray of objectopcional
Anulaciones puntuales de fecha — cierres por festivo o el horario especial de un solo día — o null.
mediaByCategoryobjectopcional
Elementos multimedia agrupados por categoría (p. ej. EXTERIOR, INTERIOR, FOOD_AND_DRINK, LOGO, TEAMS). Cada elemento tiene una url y, opcionalmente, un label, un kind (PHOTO o VIDEO), una source, un indicador starred y un assetKey.
clientIdstringopcional
ID del cliente al que pertenece esta ubicación, o null.
archivedbooleanopcional
Si la ubicación está archivada.
scheduledArchiveAtstringopcional
Fecha en que se solicitó el archivado (también el token que usa cancel-archive para identificarlo), como marca de tiempo ISO 8601, o null si no hay ninguno pendiente.
verificationStatusstring (verified | pending | unverified | unknown)opcional
Estado de verificación de Google: verified, pending, unverified o unknown, o null.
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/locations/{id}
Su clave de API
id *
{
  "data": {
    "id": "loc_456",
    "name": "Acme Dental — Downtown",
    "description": null,
    "tagline": null,
    "storeCode": null,
    "logoUrl": null,
    "street": "123 Main St",
    "street1": null,
    "city": "Austin",
    "state": "TX",
    "postalCode": "78701",
    "country": "US",
    "latitude": 30.2672,
    "longitude": -97.7431,
    "phone": "+15125551234",
    "additionalPhones": [],
    "website": "https://acmedental.com",
    "businessEmail": null,
    "categoryName": "Dentist",
    "primaryCategoryDisplay": "Dentist",
    "primaryCategoryGoogle": "gcid:dentist",
    "additionalCategories": [],
    "attributes": [
      {
        "id": "attributes/wi_fi",
        "value": true
      }
    ],
    "services": [
      {
        "name": "Teeth Whitening",
        "description": null,
        "price": 150,
        "currency": "USD",
        "googleServiceTypeId": null
      }
    ],
    "ownerName": null,
    "menuUrl": null,
    "yearEstablished": null,
    "tags": [
      "vip"
    ],
    "labels": [],
    "regularHours": [
      {
        "day": "MONDAY",
        "closed": false,
        "periods": [
          {
            "openTime": "09:00",
            "closeTime": "17:00"
          }
        ]
      }
    ],
    "moreHours": [],
    "specialHours": [],
    "mediaByCategory": {
      "EXTERIOR": [
        {
          "url": "https://cdn.synup.com/media/1.jpg"
        }
      ]
    },
    "clientId": "cli_123",
    "archived": false,
    "scheduledArchiveAt": null,
    "verificationStatus": "verified"
  }
}

Guías que usan este endpoint