Listings APIListings API
Iniciar sesión
POST/api/v4/locations/oauth-disconnect

Desconectar una ubicación de una plataforma de publicación

Desvincula una sola ubicación de una plataforma de publicación, como operación inversa a la URL de conexión OAuth por ubicación.

Requiere una clave de API. Consulta Autenticación para conocer el formato del encabezado y la rotación de claves.

Parámetros

Cuerpo

NombreTipoObligatorioDescripción
inputobjectobligatorioWrapper object. The entire request body must be nested under `input`.
input.locationIdstringobligatorioBase64-encoded Relay ID of the one location to disconnect.
input.sitestringopcionalPublisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`.
input.providerIdstringopcionalThe publisher's own account identifier, as an alternative to `site`. Required unless you send `site`.

Solicitud de ejemplo

Cuerpo listo para pegar. Sustituye los ID y valores de ejemplo por los tuyos.

Request body
{  "input": {    "locationId": "TG9jYXRpb246MTgwMDI4OQ==",    "site": "GOOGLE"  }}

Respuestas

200Connection removed. Response key `disconnectConnectedAccountsLocations`.
Response
{  "data": {    "disconnectConnectedAccountsLocations": {      "clientMutationId": null,      "success": true,      "errors": null    }  }}
401Unauthenticated, missing or invalid API key.
403The key is valid but not permitted to disconnect this location (`SY90003`).

Elimina la conexión de una sola ubicación con una plataforma de publicación. Es la parte de desconexión del flujo OAuth por ubicación iniciado mediante Crear una URL de conexión OAuth para una ubicación.

Esta ruta y Desconectar una ficha de una ubicación realizan la misma operación a través de dos rutas: ambas aceptan el mismo cuerpo input y devuelven su resultado bajo disconnectConnectedAccountsLocations, no bajo el nombre de ninguna de las dos rutas. Elige la ruta que resulte más clara en tu integración; no hay ninguna diferencia de comportamiento.

El cuerpo debe estar envuelto en input y contener un único locationId, además de uno de los dos campos, site o providerId, para indicar qué conexión eliminar. Si no envías ninguno de los dos, el endpoint devuelve SY10056 ("Site is not valid for the location disconnection"); si la ubicación no tiene ninguna conexión activa con ese sitio, devuelve SY10057 en lugar de indicar éxito sin haber realizado ningún cambio, por lo que success: true sí significa que se ha eliminado un vínculo. No es un endpoint de operaciones en lote, así que utiliza un bucle para varias ubicaciones. Para desconectar todas las ubicaciones de una cuenta a la vez, utiliza Desconectar cuentas de Google en lote.

Caso de uso: deshacer una conexión con la ficha equivocada

Cuando un usuario conecta la ficha equivocada de una plataforma de publicación a una tienda, desconéctala aquí con site establecido en esa plataforma de publicación y, después, vuelve a dirigirlo a la URL de conexión (o ejecuta trigger-matches y Conectar una ficha) para vincular la correcta. La desconexión deja intactas la ubicación y sus datos; solo se detiene la sincronización saliente con esa plataforma de publicación.

Caso de uso: un cliente se marcha y se lleva su cuenta de Apple Business

Con site: "APPLE", la ubicación deja de publicarse a través de la cuenta de Apple Business del propietario. Permanece en Apple Maps: las actualizaciones posteriores se publican a través de la cuenta de Apple Business Connect de ListingsAPI, y Apple verifica el envío antes de publicarlo. Para volver a publicar a través de la cuenta del propietario, envíale un nuevo enlace desde Crear una URL de conexión OAuth para una ubicación.

Este endpoint modifica una conexión activa. La solicitud y la respuesta de muestra anteriores son ejemplos.

Request
curl -X POST 'https://listingsapi.com/api/v4/locations/oauth-disconnect' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "locationId": "TG9jYXRpb246MTgwMDI4OQ==",      "site": "GOOGLE"    }  }'
Run in playground