Skip to main content
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The change ID, chn_….

Required string length: 1 - 64
Example:

"chn_1005"

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.change"
id
string
required

chn_ + the change's number (a change the app made), or chn_ + a write's 26-character ID (a change made through the API).

shop_id
string
required

The connected shop the changed listing belongs to.

target
object
required

What the change was made to.

source
string
required

Where the change came from: app (someone in Alura), automation (an Alura automation), ai_optimize (an AI optimization applied in Alura), ai_create (a listing created with AI in Alura), revert (a revert of an earlier change), and api (a write through the API). New values may be added.

actor
object | null
required

Who made the change; null when that user no longer exists.

write_id
string | null
required

The API write that made the change; null for a change made in the app.

outcome
string
required

succeeded, or partial when only some fields landed on Etsy. New values may be added.

fields
object[] | null
required

What changed, field by field. Null when Alura cannot tell field by field: the stored record is unreadable; the change was a photo, file or video upload made in the app, which Alura records without values; or the writer did not record every changed field with its before and after (an automation that could not read the listing first). Never an empty or shortened list.

before_source
string | null
required

Where before came from: live (read from Etsy during the write) or cache (Alura's copy); null when unknown, as for every change made in the app.

before_as_of
string | null
required

When before was current; null when unknown.

revertable
boolean
required

Whether Alura can undo the change; false for every change in this version (history only).

not_revertable_reason
string | null
required

Why it cannot be reverted: legacy_app_write for a change made in the app (history only). Null when it can. New values may be added.

created_at
string
required

When the change was made.

as_of
string
required

When this record was read.