v1Resources/Connections/postGet Google listing creation status

Get Google listing creation status

Returns where Google listing creation stands for each location, read from the location's Google connection and its latest Google create order. Call it after create and poll until each location reaches created or failed. Location ids you can't access come back in unavailableIds. Up to 200 locations per request.

post/api/v1/connections/google-listing-create/status
connections:read
Request body
locationIdsarray of stringrequired
The ids of the locations to work on, up to 200. Duplicates are ignored.
Response
dataobjectoptional
statusesarray of objectoptional
One entry for each requested location you can access.
locationIdstringoptional
The location's id.
statestring (none | queued | creating | retrying | failed | created)optional
none (no Google create for this location), queued (waiting to start), creating (in progress), retrying (the last attempt failed and will run again), failed (stopped and won't finish on its own) or created (the location is linked to a Google listing).
orderItemIdstringoptional
The location's latest Google create order. Absent when there isn't one.
orderItemStatusstring (PENDING | IN_PROGRESS | COMPLETED | FAILED | CANCELED | AUTO_FAILED | SKIPPED)optional
The raw status of that order. Absent when there isn't one or when state is created.
issueCategorystringoptional
A category code for what went wrong on the latest attempt, or null. Absent when state is none or created.
reasonstringoptional
A readable explanation of why the latest attempt failed, or null. Absent when state is none or created.
unavailableIdsarray of stringoptional
Requested location ids that weren't found or that you can't access. They are listed here instead of failing the request.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/connections/google-listing-create/status
Your API key
Request body*
{}

Guides that use this resource