/api/v4/connected-accounts/connected-account-listingsBuscar listagens de uma conta conectada
Retorna as listagens do Google Business Profile ou do Facebook acessíveis a uma conta conectada, com filtragem e paginação opcionais.
Parâmetros
Corpo
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| connectedAccountId | string | obrigatório | UUID of the connected account whose listings to fetch. Send this in the JSON body: as a query parameter it is ignored. |
| page | integer | opcional | Page number to fetch. Defaults to 1. |
| perPage | integer | opcional | Records per page. Defaults to 500, which is also the maximum. |
| locationInfo | string | opcional | Free-text search within the account's listings. Matches business name, address lines, locality, postal code, store code, and phone. |
Exemplo de requisição
Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.
{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50}Respostas
200List of listings accessible to the account, with pagination metadata.
{ "data": { "connectedAccountListings": { "pageInfo": { "hasNextPage": false, "hasPreviousPage": false, "totalPages": 1, "totalRecords": 60 }, "records": [ { "accountTypeName": "Google", "address": "123 William St, NY 10038, Manhattan, US", "id": "R21iQnVsa0RhdGFMYWtlOjA2MDQ4NmExLTA0NzQtNDc4NS1iMjNhLTBkOGM4MzhmNGQ5OA==", "liveLink": null, "locationName": "Trial", "phone": "(718) 667-7787" } ] } }}401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.
Retorna as listagens do Google Business Profile ou do Facebook às quais uma conta conectada tem acesso. Cada registro inclui o id da listagem (um ID em base64), locationName, address, phone e liveLink. Apesar de usar POST, esta é uma operação de leitura, mas as opções de conta e paginação devem ser enviadas no corpo JSON.
Caso de uso: criar um seletor de listagens. Depois que um cliente conectar uma conta do Google que possui dezenas de listagens, faça esta chamada para exibir uma lista com busca. Insira um termo de busca digitado pelo cliente em locationInfo (a busca encontra correspondências no nome, endereço, telefone, código postal e código da loja) para que ele encontre a loja certa rapidamente.
Caso de uso: fornecer dados para connect-listing. O id de cada registro é exatamente o connectedAccountListingId que connect-listing espera. Busque as listagens, deixe o cliente (ou sua lógica de correspondência) escolher uma e, em seguida, passe o id dela junto com o locationId de destino da Listings API para connect-listing para vinculá-los.
Faça a paginação usando as chaves page e perPage diretamente no corpo; o valor padrão de perPage é 500, que também é o máximo. Leia pageInfo.hasNextPage e pageInfo.totalPages da resposta para percorrer todas as páginas do conjunto completo. Este endpoint consome o limite de requisições da conta; uma resposta 429 inclui um cabeçalho Retry-After.
A estrutura da requisição acima foi verificada com a API em funcionamento. A resposta de exemplo é ilustrativa.
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/connected-account-listings' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "connectedAccountId": "4f712c17-4f95-42dd-90f4-97171a2e67b5", "perPage": 50 }'