Skip to main content
cURL
Cost: 1 API credit per write.
Send at least one of readiness_state, min, max and unit, with the rules of Create processing profile. Fields you leave out stay as they are. A profile outside the workspace answers 404. Needs the shop:write scope and the owner or admin role in the workspace. REST only: there is no MCP tool for it. Send an Idempotency-Key so a retry never writes twice (Idempotency).
This changes the profile on your live Etsy shop, for every listing that uses it. The change is recorded but cannot be reverted through the API.

​
The answer

  • 200: the profile as Etsy returned it, with its change. A field Etsy’s answer lacked is null, and notices says so.
  • 202: the change, while Etsy is still answering. Follow it with Get change.
dry_run=true shows what the write would send and the Etsy calls it would make. It sends, charges and records nothing, but counts toward the per-minute write limit. A write that fails is not charged.
Alura checks that the profile is your shop’s before it writes. When Alura has never fetched the shop’s processing profiles completely, it cannot tell, sends nothing and answers 409 settings_not_fetched. Start a sync, then retry.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

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 - 255

Path Parameters

​
id
string
required

The Etsy processing profile ID. A profile outside the workspace is 404.

Pattern: ^[0-9]{1,20}$
Example:

"36001"

Query Parameters

​
dry_run
boolean

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.

Body

application/json
​
readiness_state
enum<string>

ready_to_ship or made_to_order.

Available options:
ready_to_ship,
made_to_order
​
min
integer

The fewest processing units, 1-10.

Required range: 1 <= x <= 10
​
max
integer

The most processing units, 1-10.

Required range: 1 <= x <= 10
​
unit
enum<string>

days (Etsy's default) or weeks.

Available options:
days,
weeks

Response

OK: the write landed on Etsy (or, with dry_run=true, what it would do).

​
object
string
required
Allowed value: "workspace.processing_profile"
​
id
string | null
required

The Etsy processing profile ID; null only when Etsy's answer to a create named none (a notice says so).

​
shop_id
string
required

The Etsy shop ID, as a string.

​
readiness_state
string | null
required

ready_to_ship or made_to_order; null when Etsy's answer lacked it. New values may be added.

​
min
integer | null
required

The fewest processing units (Etsy's min_processing_time).

​
max
integer | null
required

The most processing units (Etsy's max_processing_time).

​
unit
string | null
required

days or weeks; null when Etsy's answer lacked it.

​
fetched_at
string
required

When Etsy answered this write: the object is as of then.

​
as_of
string
required

Equal to fetched_at.

​
change
object
required

The write: its change ID and what landed.

​
notices
object[]
required

Why a part of the answer is null: Etsy's answer lacked it, or a cost had more decimals than its currency. Empty when nothing is.