Listings APIListings API
Accedi
POST/api/v4/connected-accounts/disconnect-listing

Scollegare una scheda da una sede

Scollega la scheda connessa sulla piattaforma di pubblicazione da una singola sede di Listings API.

Richiede una chiave API. Consulta Autenticazione per il formato dell’header e la rotazione delle chiavi.

Parametri

Corpo

NomeTipoObbligatorioDescrizione
inputobjectobbligatorioWrapper object. The entire request body must be nested under `input`.
input.locationIdstringobbligatorioBase64-encoded Relay ID of the one location to disconnect.
input.sitestringfacoltativoPublisher to disconnect from: `GOOGLE`, `FACEBOOK`, or `APPLE`. Required unless you send `providerId`.
input.providerIdstringfacoltativoThe publisher's own account identifier, as an alternative to `site`. Required unless you send `site`.

Richiesta di esempio

Corpo pronto da incollare. Sostituisci gli ID e i valori segnaposto con i tuoi.

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

Risposte

200Listing disconnected.
Response
{  "data": {    "disconnectConnectedAccountsLocations": {      "clientMutationId": null,      "success": true,      "errors": null    }  }}
401Unauthenticated, missing or invalid API key.

Rimuove il collegamento tra una sede di Listings API e la scheda sulla piattaforma di pubblicazione (Google Business Profile, Facebook Page o Apple Business Connect) a cui è attualmente connessa. Dopo la disconnessione, Listings API smette di inviare aggiornamenti a quella scheda. La sede rimane nel tuo account; viene rimosso solo il collegamento alla scheda.

Struttura della richiesta. Il corpo deve essere racchiuso in un oggetto input contenente un singolo locationId e uno tra site (GOOGLE, FACEBOOK o APPLE) e providerId per indicare quale connessione interrompere. Questo endpoint non supporta operazioni in blocco: gestisce una sede per chiamata, quindi usa un ciclo se devi gestirne diverse.

Se non invii né site né providerId, viene restituito SY10056 ("Site is not valid for the location disconnection"). Per una sede che non ha una connessione attiva per quel sito, viene restituito SY10057 ("Location is not connected for the site") anziché un esito positivo silenzioso, quindi un success: true indica effettivamente che un collegamento è stato rimosso.

Caso d'uso: ricollegare una sede a un altro account. Quando un cliente trasferisce un punto vendita da un account Google a un altro, scollega prima la scheda attuale della sede tramite questo endpoint con site: "GOOGLE", quindi usa trigger-matches e connect-listing sul nuovo account connesso per collegarla alla scheda corretta.

Caso d'uso: interrompere la gestione senza eliminare. Quando un cliente passa a un piano inferiore e non vuole più che Listings API gestisca la sua presenza su Google/Facebook, ma vuole conservare il record della sede e i relativi dati ospitati da Listings API, scollega la scheda anziché archiviare la sede. Questo interrompe la sincronizzazione in uscita, preservando la sede per altre piattaforme di pubblicazione.

Questo endpoint modifica una connessione attiva e invia la modifica alla piattaforma di pubblicazione. La richiesta e la risposta di esempio riportate sopra sono esempi.

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