cURL
curl -X POST "https://api.alura.io/v1/workspace/changes/chn_01JMCK00000000000000000001/revert" \
-H "Authorization: Bearer $ALURA_API_KEY" \
-H "Idempotency-Key: 5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c"const res = await fetch('https://api.alura.io/v1/workspace/changes/chn_01JMCK00000000000000000001/revert', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.ALURA_API_KEY}`,
'Idempotency-Key': '5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c',
},
});
console.log(await res.json());import json
import os
import urllib.request
request = urllib.request.Request(
"https://api.alura.io/v1/workspace/changes/chn_01JMCK00000000000000000001/revert",
method="POST",
headers={
"Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
"Idempotency-Key": "5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c",
},
)
with urllib.request.urlopen(request) as response:
print(json.load(response)){
"object": "workspace.listing",
"id": "1834720561",
"shop_id": "22841907",
"title": "Personalized name mug, custom coffee mug with name, 11oz ceramic gift",
"description": "A personalized name mug printed with the name you choose. 11oz white ceramic, dishwasher and microwave safe. Made to order in 1-3 days and shipped in a protective box, ready to gift for birthdays, holidays and thank-yous.",
"url": "https://www.etsy.com/listing/1834720561",
"state": "active",
"price": {
"amount": "18.50",
"currency": "USD",
"usd": "18.50"
},
"quantity": 37,
"skus": [
"MUG-NAME-11"
],
"tags": [
"mug",
"name mug",
"custom mug",
"gift for her"
],
"materials": [
"ceramic"
],
"category": {
"id": "1062"
},
"section": {
"id": "3301"
},
"shipping_profile_id": "4401",
"return_policy_id": "4501",
"processing_profile_id": null,
"production_partner_ids": null,
"who_made": "i_did",
"when_made": "made_to_order",
"is_supply": false,
"should_auto_renew": true,
"updated_at": "2026-10-17T12:00:00.000Z",
"as_of": "2026-10-17T12:00:00.000Z",
"change": {
"id": "chn_01JMCK00000000000000000002",
"status": "succeeded",
"applied_fields": [
"title",
"tags"
],
"failed_fields": []
},
"notices": [],
"reverts": "chn_01JMCK00000000000000000001",
"restored": [
"title",
"tags"
],
"not_reverted": []
}{
"object": "workspace.change",
"id": "<string>",
"shop_id": "<string>",
"target": {
"type": "<string>",
"id": "<string>"
},
"source": "<string>",
"actor": {
"type": "<string>",
"id": "<string>"
},
"write_id": "<string>",
"outcome": "<string>",
"fields": [
{
"field": "<string>",
"before": "<unknown>",
"after": "<unknown>",
"unrecorded": [
"before"
],
"omitted": [
"before"
]
}
],
"applied_fields": [
"<string>"
],
"failed_fields": [
{
"field": "<string>",
"code": "<string>"
}
],
"before_source": "<string>",
"before_as_of": "<string>",
"event": "<string>",
"revertable": true,
"not_revertable_reason": "<string>",
"reverts": "<string>",
"created_at": "<string>",
"as_of": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "https://docs.alura.io/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "Unauthorized",
"suggestion": "Send a valid API key as `Authorization: Bearer alura_sk_...`.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "https://docs.alura.io/errors/method_not_allowed",
"title": "Method not allowed",
"status": 405,
"code": "method_not_allowed",
"detail": "Method not allowed",
"suggestion": "Use one of the methods in the Allow header.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
],
"not_reverted": [
{
"field": "<string>",
"reason": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}Changes
Revert change
Undo one change Alura made to a listing of your connected Etsy shops: the fields it changed go back to their values from before it, as read live from Etsy at the time.
cURL
curl -X POST "https://api.alura.io/v1/workspace/changes/chn_01JMCK00000000000000000001/revert" \
-H "Authorization: Bearer $ALURA_API_KEY" \
-H "Idempotency-Key: 5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c"const res = await fetch('https://api.alura.io/v1/workspace/changes/chn_01JMCK00000000000000000001/revert', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.ALURA_API_KEY}`,
'Idempotency-Key': '5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c',
},
});
console.log(await res.json());import json
import os
import urllib.request
request = urllib.request.Request(
"https://api.alura.io/v1/workspace/changes/chn_01JMCK00000000000000000001/revert",
method="POST",
headers={
"Authorization": f"Bearer {os.environ['ALURA_API_KEY']}",
"Idempotency-Key": "5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c",
},
)
with urllib.request.urlopen(request) as response:
print(json.load(response)){
"object": "workspace.listing",
"id": "1834720561",
"shop_id": "22841907",
"title": "Personalized name mug, custom coffee mug with name, 11oz ceramic gift",
"description": "A personalized name mug printed with the name you choose. 11oz white ceramic, dishwasher and microwave safe. Made to order in 1-3 days and shipped in a protective box, ready to gift for birthdays, holidays and thank-yous.",
"url": "https://www.etsy.com/listing/1834720561",
"state": "active",
"price": {
"amount": "18.50",
"currency": "USD",
"usd": "18.50"
},
"quantity": 37,
"skus": [
"MUG-NAME-11"
],
"tags": [
"mug",
"name mug",
"custom mug",
"gift for her"
],
"materials": [
"ceramic"
],
"category": {
"id": "1062"
},
"section": {
"id": "3301"
},
"shipping_profile_id": "4401",
"return_policy_id": "4501",
"processing_profile_id": null,
"production_partner_ids": null,
"who_made": "i_did",
"when_made": "made_to_order",
"is_supply": false,
"should_auto_renew": true,
"updated_at": "2026-10-17T12:00:00.000Z",
"as_of": "2026-10-17T12:00:00.000Z",
"change": {
"id": "chn_01JMCK00000000000000000002",
"status": "succeeded",
"applied_fields": [
"title",
"tags"
],
"failed_fields": []
},
"notices": [],
"reverts": "chn_01JMCK00000000000000000001",
"restored": [
"title",
"tags"
],
"not_reverted": []
}{
"object": "workspace.change",
"id": "<string>",
"shop_id": "<string>",
"target": {
"type": "<string>",
"id": "<string>"
},
"source": "<string>",
"actor": {
"type": "<string>",
"id": "<string>"
},
"write_id": "<string>",
"outcome": "<string>",
"fields": [
{
"field": "<string>",
"before": "<unknown>",
"after": "<unknown>",
"unrecorded": [
"before"
],
"omitted": [
"before"
]
}
],
"applied_fields": [
"<string>"
],
"failed_fields": [
{
"field": "<string>",
"code": "<string>"
}
],
"before_source": "<string>",
"before_as_of": "<string>",
"event": "<string>",
"revertable": true,
"not_revertable_reason": "<string>",
"reverts": "<string>",
"created_at": "<string>",
"as_of": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "https://docs.alura.io/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"code": "unauthorized",
"detail": "Unauthorized",
"suggestion": "Send a valid API key as `Authorization: Bearer alura_sk_...`.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "https://docs.alura.io/errors/method_not_allowed",
"title": "Method not allowed",
"status": 405,
"code": "method_not_allowed",
"detail": "Method not allowed",
"suggestion": "Use one of the methods in the Allow header.",
"retryable": false,
"request_id": "req_01JQ5W3H8M2N4P6R8T0V2X4Z6B"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
],
"not_reverted": [
{
"field": "<string>",
"reason": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"code": "<string>",
"detail": "<string>",
"suggestion": "<string>",
"retryable": true,
"request_id": "<string>",
"upgrade_url": "<string>",
"credits_needed": 123,
"credits_remaining": 123,
"resets_at": "2023-11-07T05:31:56Z",
"change_id": "<string>",
"budget": "<string>",
"reason": "<string>",
"changed": [
"<string>"
],
"missing": [
"<string>"
],
"reconnect_url": "<string>",
"missing_scopes": [
"<string>"
]
}Cost: 1 API credit per write.
Needs the
A change with some restorable fields and some not is reverted for the restorable ones.
A change that can’t be reverted at all answers
See Credits and limits for what a refused revert or a dry run costs.
curl -X POST "https://api.alura.io/v1/workspace/changes/chn_01JMCK00000000000000000001/revert?dry_run=true" \
-H "Authorization: Bearer $ALURA_API_KEY"
listings:write scope and the Listing optimization workspace permission. A change outside the workspace answers 404.
A revert writes to the live listing on Etsy. It overwrites what the listing holds now with the change’s earlier values.
Undo a change
- Find the change with List changes or Get a change.
revertablesays whether it can be undone, andnot_revertable_reasonwhy not. - Call with
dry_run=trueto see what would be restored and what not. Nothing is sent to Etsy. - Call again without
dry_run. Send anIdempotency-Keyso a retry is safe. See Idempotency.
200 with the listing as Etsy returned it, plus reverts, restored and not_reverted. While Etsy is still answering, it is 202 with the change instead: get the change until its outcome is final.
The revert is a new change with source: revert, and its reverts is the ID of the change it undid. It can itself be reverted.
What can be restored
Reverts are deny by default. Only a change made through Alura’s change log, with abefore read live from Etsy, that landed on Etsy, can be reverted. Each field goes back to its value in before.
| Restored | Details |
|---|---|
| Core fields | Title, description, tags, materials, category, maker fields, section, shipping profile, return policy, auto-renew, and an inactive state |
| Inventory | Each variant’s price, SKU and enabled flag |
| Attributes, translations, personalization questions | Each restored whole from its live before |
not_reverted lists the rest, each with its reason.
What is never restored
| Not restored | Reason |
|---|---|
| Quantity | quantity: never restored from a snapshot, because of the oversell risk. Etsy’s current quantities stay. |
| An inventory change that added or removed variants | variations_changed |
A change from draft, expired or sold_out | not_supported: Etsy’s listing update takes none of these states |
| Anything that would put the listing back on sale | reactivates_listing |
| A translation the change created | translation_added: Etsy has no translation delete |
| Production partners | not_supported |
who_made: someone_else | needs_production_partners: Etsy accepts it only with production partners |
| Images, videos and variation images | images |
| A digital file added or removed | files: the API keeps no copy of a file |
| A processing profile, and any other listing field | not_supported |
| A section, shipping profile or return policy deleted since the change | reference_deleted: Alura’s copy of the shop says it is gone. The change’s other fields are still restored. |
| A delete | delete |
| A publish | publish_fee: undoing it is not free on Etsy |
| A shipment | shipment_notified_buyer: Etsy already emailed the buyer |
| A change whose outcome isn’t known | outcome_unknown: it may have landed |
| A change without Etsy’s updated time recorded | etsy_updated_at_unrecorded |
| The app’s older history | legacy_app_write |
409 change_not_revertable, with reason and nothing written.
When the listing changed since
Before writing, Alura reads the listing on Etsy again. Every field to restore must still hold the change’safter. If one doesn’t, the revert answers 409 changed_since, changed names the fields that moved, and nothing is written.
- Fields the change didn’t touch are neither compared nor written.
- For the inventory, every variant’s price, SKU and enabled flag must still be the change’s. A sale moving a quantity is fine. Otherwise
changednamesinventory. - A category (
category_id) the change moved is also refused when the listing was edited on Etsy after the change: its updated time is more than 10 seconds from the change’s, or unknown. Putting the category back can make Etsy drop attributes set since.
Etsy has no conditional update. An edit made on Etsy between Alura’s read and its write can still be overwritten.
A listing in an A/B test
A listing in an A/B test
A change to a listing in a running Alura A/B test is reverted like any other. The test’s variant switches also write through Alura (changes with
source: automation), so its next switch may overwrite the fields its variants hold.Authorizations
An API key: Authorization: Bearer alura_sk_....
Headers
Makes a retry safe: the same key with the same request within 24 hours answers from the first write (with Idempotent-Replayed: true) and never writes to Etsy twice; a write that failed with nothing written (Retry-After set) is tried again under it. The same key with a different request is a 409 conflict; while the first request still runs, 409 idempotency_processing (or the same 202). Required for relative changes such as adjust_price, and to add a listing file, image or video, or to change the alt text of an image (each uploads to Etsy, so a blind retry would upload again); a dry_run=true needs none.
Required string length:
1 - 255Path Parameters
The change to revert, chn_… (GET /v1/workspace/changes shows which are revertable).
Required string length:
1 - 64Example:
"chn_01JMCK00000000000000000001"
Query Parameters
true: plan the write and send nothing: what it would change, the Etsy calls it would make, and nothing reserved, charged or recorded. Free; counts toward the per-minute write limit.
Response
OK: the write landed on Etsy (or, with dry_run=true, what it would do).
- Option 1
- Option 2
Allowed value:
"workspace.listing"Etsy ID, as a string.
Etsy ID, as a string.
The title as Etsy answered; null when Etsy did not say.
The description as Etsy answered; null when Etsy did not say.
The listing on Etsy.
Etsy's listing state, for example active, inactive or draft.
The listing's price as Etsy answered; usd is null unless the listing is priced in USD.
Show child attributes
Show child attributes
The listing's total quantity across its enabled offerings, as Etsy and get_my_listing count it (not the per-offering value a request sends: 3 on each of 2 variants is 6).
The SKUs of the listing's offerings as Etsy answered; null when Etsy did not say.
The tags as Etsy answered; null when Etsy did not say.
The materials as Etsy answered; null when Etsy did not say.
Etsy's category (category_id in the request).
Show child attributes
Show child attributes
The shop section; null when the listing is in none.
Show child attributes
Show child attributes
The listing's shipping profile; null when it has none or Etsy did not say.
The listing's return policy; null when it has none or Etsy did not say.
The processing profile every offering has; null when they differ or Etsy did not say.
The production partners as Etsy answered; null when Etsy did not say.
Etsy ID, as a string.
Etsy's who_made: i_did, someone_else or collective; null when Etsy did not say.
Etsy's when_made, for example made_to_order; null when Etsy did not say.
true: a craft supply or tool; false: a finished product; null when Etsy did not say.
true: Etsy renews the listing automatically when it expires; null when Etsy did not say.
When Etsy last changed the listing.
When Etsy answered the write.
The write: its change ID and what landed.
Show child attributes
Show child attributes
Why a part of the answer is unknown; empty when nothing is.
Show child attributes
Show child attributes
The change this revert undid (chn_...).
The fields restored to the change's before, named as in the listing's shapes.
The fields of the change this revert did not restore, each with its reason; empty when it restored every field.
Show child attributes
Show child attributes