Skip to main content
GET
Retrieve a catalog synchronization

Authorizations

x-api-key
string
header
required

Location/organization API key.

Path Parameters

location_id
string
required
catalog_id
string
required
sync_id
string
required

Response

The catalog synchronization.

id
string
required
Example:

"csync_123"

object
enum<string>
required
Available options:
catalog_sync
catalog_id
string
required
Example:

"delivery-menu"

status
enum<string>
required
Available options:
queued,
processing,
succeeded,
failed
created_at
string<date-time>
required
updated_at
string<date-time>
required
completed_at
string<date-time> | null
required
error
object | null
required