Skip to main content
cURL

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Path Parameters

id
string
required

The sync ID, syn_….

Required string length: 1 - 64
Example:

"syn_9004"

Query Parameters

fields
string

Comma-separated dotted paths to return; id, object and as_of always come back.

Response

OK

object
string
required
Allowed value: "workspace.sync"
id
string
required

syn_ + the sync's number.

shop_id
string
required

The connected shop it syncs.

status
string
required

queued, running, succeeded, failed, skipped, or unknown (a status Alura does not know yet). New values may be added.

trigger
string
required

Who started it: api (the API or an AI agent through Alura), app (someone clicking Update in Alura), scheduled (Alura's regular syncs), webhook (an Etsy notification), or other. New values may be added.

progress
number | null
required

The share of its steps that have ended, 0 to 1: 0 while queued, 1 once it ended; null while running when Alura has no progress for it, and when its status is unknown.

Required range: 0 <= x <= 1
steps
object[]
required

Each step and how far it got.

requested_at
string
required

When it was asked for.

started_at
string | null
required

When it started; null while queued.

completed_at
string | null
required

When it ended; null until then.

estimated_ready_at
string | null
required

When it is expected to end; null when unknown (always, for now).

error
object | null
required

Why it failed; null unless it failed or was skipped.