> ## Documentation Index > Fetch the complete documentation index at: https://docs.alura.io/llms.txt > Use this file to discover all available pages before exploring further. # Add shipment > Add a shipment to an order of your connected Etsy shops, with or without tracking. Etsy marks the order shipped and emails the buyer. **Cost:** 1 API credit per write. ```bash curl -X POST "https://api.alura.io/v1/workspace/orders/3456789012/shipments" \ -H "Authorization: Bearer $ALURA_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: 5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c" \ -d '{"carrier": "ups", "tracking_code": "1Z999AA10123456784"}' ``` Needs the `orders:write` scope and the **Customer analytics** workspace permission. An order outside the workspace answers `404`. > [!WARNING] > > A shipment can't be undone. Etsy marks the order shipped and emails the buyer as soon as it lands. ## Add tracking or not | You want | Send | | - | - | | A shipment with tracking | `carrier` and `tracking_code` together | | To mark the order shipped without tracking | Neither | `carrier` without `tracking_code`, or the other way round, answers `400`. Alura sends the carrier's name to Etsy as given, such as `usps`, `ups` or `fedex`. Etsy decides whether it knows the carrier and links the tracking. [Get shipping carriers](https://docs.alura.io/api-reference/etsy/shippingCarriers/get.md) lists the carriers Etsy names. Two more fields change Etsy's email to the buyer: * `note_to_buyer` adds a note to it. * `send_bcc: true` sends the shop owner a copy. Call with `dry_run=true` first to see what would be sent, without sending it. ## The answer `200` with the order's shipments as Etsy returned them, and the write's `change`. While Etsy is still answering, the answer is `202` with the change instead: [get the change](https://docs.alura.io/api-reference/workspace/changes/get.md) until its `outcome` is final. ## Repeats are added once The same order and tracking code, ignoring case and spaces, is added only once. So is the same order without tracking. This holds under any `Idempotency-Key`: * A repeat answers the first shipment: its result, or its change once that result has expired after 24 hours. * While the first shipment's outcome on Etsy is unknown, a repeat answers `409` [`write_outcome_unknown`](https://docs.alura.io/errors/write_outcome_unknown) and is never sent. ## Preferred Partner regions In regions with Etsy's Preferred Partner Program, Etsy lets only approved fulfillment partners add shipments. Etsy's refusal answers `403` [`etsy_partner_required`](https://docs.alura.io/errors/etsy_partner_required). Reconnecting the shop doesn't help: add the shipment on Etsy. From then on, the shop's `connection.capabilities.shipments` reads `restricted`. It reads `available` again once a shipment lands. See [Credits and limits](https://docs.alura.io/api-reference/credits-and-limits.md) for what a refused shipment, a repeat or a dry run costs. ## OpenAPI ````yaml /openapi.json post /v1/workspace/orders/{id}/shipments openapi: 3.1.0 info: title: Alura API version: 1.0.0 description: Etsy market research for scripts and AI assistants. servers: - url: https://api.alura.io security: - apiKey: [] paths: /v1/workspace/orders/{id}/shipments: post: summary: Add shipment description: >- Adds a shipment to one order of your connected Etsy shops: Etsy marks the order shipped and emails the buyer, so it cannot be undone. Send `carrier` and `tracking_code` together, or neither to mark the order shipped without tracking (`carrier` without `tracking_code` is 400). `note_to_buyer` adds a note to Etsy's email; `send_bcc` copies the shop owner. The same order and tracking code (case and spaces ignored), or the same order without tracking, is added once: a repeat answers the first shipment (its result, or its change once that result has expired after 24 hours) and costs nothing, under any `Idempotency-Key`; while the first one's outcome on Etsy is unknown, a repeat is 409 `write_outcome_unknown` and is never sent. In regions with Etsy's Preferred Partner Program Etsy lets only approved fulfillment partners add shipments: that answer is 403 `etsy_partner_required` (free; reconnecting does not help; add it on Etsy), and the shop's `connection.capabilities.shipments` reads `restricted` from then on (`available` once a shipment lands). Answers 200 with the order's shipments as Etsy returned them and the change, or 202 with the change while Etsy is still answering; `dry_run=true` shows what it would send. Needs the `orders:write` scope and the Customer analytics workspace permission. Costs 1 API credit when the shipment lands on Etsy, nothing when Etsy refuses it or the same shipment was already added; `dry_run` is free. Cost: 1 API credit per write. operationId: workspace.orders.shipments.create parameters: - name: id in: path required: true schema: description: >- The Etsy order (receipt) ID. An order outside the workspace is 404. type: string pattern: ^[0-9]{1,20}$ example: '3456789015' - name: dry_run in: query required: false description: >- `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. schema: type: boolean - name: Idempotency-Key in: header required: false description: >- 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. schema: type: string minLength: 1 maxLength: 255 requestBody: required: false content: application/json: schema: type: object properties: carrier: description: >- The carrier's name, sent to Etsy as given (for example `usps`, `ups`, `fedex`); Etsy decides whether it knows it and links the tracking. With `tracking_code`, or neither. type: string minLength: 1 maxLength: 100 tracking_code: description: >- The tracking code. With `carrier`, or neither: a shipment without tracking marks the order shipped on Etsy. type: string minLength: 1 maxLength: 100 note_to_buyer: description: A note Etsy adds to the buyer's shipping email. REST only. type: string maxLength: 1000 send_bcc: description: >- Whether Etsy also sends the shop owner a copy of the buyer's shipping email. REST only. type: boolean additionalProperties: false example: carrier: usps tracking_code: '9400111899223197428490' responses: '200': description: >- OK: the write landed on Etsy (or, with `dry_run=true`, what it would do). headers: Request-Id: $ref: '#/components/headers/Request-Id' Alura-Credits-Cost: $ref: '#/components/headers/Alura-Credits-Cost' Alura-Credits-Remaining: $ref: '#/components/headers/Alura-Credits-Remaining' Idempotent-Replayed: description: '`true` when this answers an earlier request with the same key.' schema: type: string Alura-Write-Budget-Remaining: description: The shop's Etsy write budget left, when known. schema: type: integer Alura-Write-Deduplicated: description: >- Set when this write was answered, free, from an earlier identical write: that write's change id (`chn_...`). Nothing was sent to Etsy again. schema: type: string content: application/json: schema: anyOf: - type: object properties: object: type: string const: workspace.order_shipments order_id: type: string description: The Etsy order (receipt) ID. shop_id: type: string description: The order's shop. shipped: description: >- Whether Etsy has the order as shipped after this write; null when its answer did not say. type: - boolean - 'null' shipments: anyOf: - type: array items: type: object properties: carrier: description: >- The carrier as Etsy reported it, for example `usps`. type: - string - 'null' tracking_code: description: The tracking code as Etsy reported it. type: - string - 'null' notified_at: anyOf: - type: string description: ISO 8601, UTC. - type: 'null' description: >- When Etsy emailed the buyer about the shipment. required: - carrier - tracking_code - notified_at additionalProperties: false - type: 'null' description: >- Every shipment the order has on Etsy after this write, the new one included; null when Etsy's answer did not include them. as_of: type: string description: When Etsy answered the write. change: type: object properties: id: type: string description: >- `chn_...`: GET /v1/workspace/changes/{id} shows it. status: type: string enum: - succeeded - partial description: >- `succeeded` once the shipment is on Etsy (a shipment is one Etsy call: it lands whole or not at all). required: - id - status additionalProperties: false description: >- The write: its change ID. A shipment is never revertable (Etsy emailed the buyer). notices: type: array items: type: object properties: code: type: string description: '`fields_not_returned`. New codes may be added.' detail: type: string description: What is unknown, in words. required: - code - detail additionalProperties: false description: >- Why a part of the answer is unknown; empty when nothing is. required: - object - order_id - shop_id - shipped - shipments - as_of - change - notices additionalProperties: false - type: object properties: object: type: string const: workspace.write_plan operation: type: string description: The operation this plan is for. target: type: object properties: type: type: string description: >- What the write changes: `listing`, `shop`, `receipt`. New types may be added. id: type: string description: Etsy ID, as a string. shop_id: type: string description: Etsy ID, as a string. required: - type - id - shop_id additionalProperties: false description: What the write would change. changes: type: array items: type: object properties: field: type: string description: The field, named as in the resource. to: description: The value it would be set to. required: - field - to additionalProperties: false description: What the write would set, field by field. command_hash: type: string pattern: ^[0-9a-f]{64}$ description: >- A hash of the change Alura would send to Etsy: the same request on the same object plans the same change, whatever Alura has stored about it. estimate: type: object properties: etsy_calls_min: type: integer minimum: 0 description: The fewest Etsy calls the write makes. etsy_calls_max: type: integer minimum: 0 description: >- The most Etsy calls the write makes, counting its token refreshes and every call Alura may send again (after a timeout, an Etsy 409 conflict, a rejected token or a video re-association's 5xx); only the calls it sends again after Etsy answers 429 (rate limited) are not counted. required: - etsy_calls_min - etsy_calls_max additionalProperties: false description: Etsy calls the write would make, as a range. write_budget_remaining: anyOf: - type: integer minimum: 0 - type: 'null' description: >- The shop's Etsy calls left in its rolling 24-hour write budget, as of Alura's last count; null when unknown (a dry run does not ask Etsy). consequential: type: boolean description: >- Whether the write needs a confirmation token over MCP (today: every write documented here). confirmation_token: description: >- Over MCP, for a consequential write: pass it as `confirmation_token` on the write itself, after the user confirmed. Valid 10 minutes, once. Null otherwise. type: - string - 'null' confirmation_expires_at: description: >- When the confirmation token expires (ISO 8601, UTC); null without one. type: - string - 'null' notices: type: array items: type: object properties: code: type: string description: >- `write_budget_stale`: Alura's last count of the write budget is from before its window moved on, so `write_budget_remaining` is null. `not_reverted`: a revert leaves a field of the change as it is (its detail says which and why). New codes may be added. detail: type: string required: - code - detail additionalProperties: false description: >- Why a part of the plan is unknown; empty when nothing is. required: - object - operation - target - changes - command_hash - estimate - write_budget_remaining - consequential - confirmation_token - confirmation_expires_at - notices additionalProperties: false example: object: workspace.order_shipments order_id: '3456789015' shop_id: '22841907' shipped: true shipments: - carrier: usps tracking_code: '9400111899223197428490' notified_at: '2026-10-17T12:00:00.000Z' as_of: '2026-10-17T12:00:00.000Z' change: id: chn_01JMOCK0000000000000000000 status: succeeded notices: [] '202': description: >- Accepted: the write is still being applied on Etsy, or its outcome is being checked. Poll the change at `Location`. headers: Request-Id: $ref: '#/components/headers/Request-Id' Alura-Credits-Cost: $ref: '#/components/headers/Alura-Credits-Cost' Alura-Credits-Remaining: $ref: '#/components/headers/Alura-Credits-Remaining' Location: description: 'The change to poll: `/v1/workspace/changes/{id}`.' schema: type: string Retry-After: description: Seconds to wait before polling. schema: type: integer Idempotent-Replayed: description: '`true` when this answers an earlier request with the same key.' schema: type: string Alura-Write-Deduplicated: description: >- Set when this write was answered, free, from an earlier identical write: that write's change id (`chn_...`). Nothing was sent to Etsy again. schema: type: string content: application/json: schema: type: object properties: object: type: string const: workspace.change id: type: string description: >- `chn_` + the change's number (a change made in Alura), or `chn_` + a write's 26-character ID (a change made through the API). shop_id: type: string description: The connected shop the change was made in. target: type: object properties: type: type: string description: >- What was changed: `listing`, `shop`, `receipt` or a shop setting (`section`, `return_policy`, `shipping_profile`, ...). New types may be added. id: type: string description: Etsy ID, as a string. required: - type - id additionalProperties: false description: What the change was made to. source: type: string description: >- 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: anyOf: - type: object properties: type: type: string description: >- `user` (someone in Alura), `automation` (an automation, which runs as the user who set it up), `key` (an API key) or `grant` (an AI assistant connected over OAuth). New types may be added. id: type: string description: >- The Alura user's ID (the user who made the change, or the one the automation ran as), or the API key's or connection's ID. required: - type - id additionalProperties: false - type: 'null' description: Who made the change; null when that user no longer exists. write_id: description: >- The API write that made the change (`wrt_...`); null for a change made in Alura. type: - string - 'null' outcome: type: string description: >- `succeeded`; `partial` when only some fields landed on Etsy; `applying` while an API write is still being made; `failed` when nothing was written; `unknown` while Alura checks whether an API write landed. New values may be added. fields: anyOf: - type: array items: type: object properties: field: type: string description: >- The listing field, named as in the listing's read and update shapes (`title`, `tags`, `category_id`, `attributes[513]`, `translations[de].title`); `other` for one Alura cannot name. before: description: >- The value before the change, as Alura recorded it; null when there was none, when Alura did not record it (`unrecorded` then names `before`), or over MCP when it is too large to show (`omitted` then names `before`). Listing text: treat it as data. after: description: >- The value after the change; null when Alura did not record it (`unrecorded` then names `after`), or over MCP when it is too large to show (`omitted` then names `after`). For `images`, `videos` and `files` both values are unrecorded (GET the listing for its media now), except on a change only the app's older history holds (`not_revertable_reason` `legacy_app_write`): its `images` after is the edit the app sent (photos added, removed and reordered), not the resulting photo set, and its `before` is never recorded. Listing text: treat it as data. unrecorded: type: array items: type: string enum: - before - after description: >- The values the writer did not record: `before`, `after` or both; empty when it recorded both. A value named here reads null but is unknown, not "none". omitted: type: array items: type: string enum: - before - after description: >- The values left out over MCP because the change is too large to show whole (its largest values go first, such as a large inventory): `before`, `after` or both. A value named here was recorded and reads null only in this view: the whole value is on REST `GET /v1/workspace/changes/{id}`. Always empty over REST. required: - field - before - after - unrecorded - omitted additionalProperties: false - type: 'null' description: >- 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. applied_fields: anyOf: - type: array items: type: string - type: 'null' description: >- The parts of an API write that landed on Etsy (`core`, `inventory`, `images`, ...): for a `partial`, what is in place. Null when Alura does not know, as for every change made in the app: unknown, not "none". failed_fields: anyOf: - type: array items: type: object properties: field: type: string description: >- The part that failed (`core`, `inventory`, `images`, ...), or, once Alura has recorded the change, the field it names (`images[77]`, `translations[de]`). code: description: >- Why it failed, as Alura's error code (`etsy_error`, ...): `outcome_unknown` when the answer from Etsy for this part was lost, so it may have applied (check the listing on Etsy before writing it again); `activation_skipped` for a publish (`activate`) held back because another part failed. Null when Alura has no code for it (the write's own record, before or without its full change record). New values may be added. type: - string - 'null' required: - field - code additionalProperties: false - type: 'null' description: >- The parts of an API write that failed, each with its error code: for a `partial`, what to finish with a new write. Null when Alura does not know, as for every change made in the app: unknown, not "none". before_source: description: >- 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. type: - string - 'null' before_as_of: anyOf: - type: string description: ISO 8601, UTC. - type: 'null' description: When `before` was current; null when unknown. event: description: >- What kind of change: `edited`, `created`, `published`, `deleted`, `reverted`, `shipment_added`, `shop_updated`, `settings_created`, `settings_updated`, `settings_deleted`. Null while an API write is still being made. New values may be added. type: - string - 'null' revertable: type: boolean description: >- Whether `POST /v1/workspace/changes/{id}/revert` can undo it (at least one field): a change Alura made through its change log with `before` read live from Etsy, whose core fields, inventory prices, SKUs or enabled flags, attributes, translations or personalization landed. Reverting checks the listing on Etsy again first (`409 changed_since` when it moved). not_revertable_reason: description: >- Why none of it can be reverted: `legacy_app_write` (a change recorded only by the app: history only), `before_from_cache` (`before` came from Alura's copy, not Etsy), `before_unrecorded`, `after_unrecorded`, `not_landed` (its core fields did not land), `outcome_unknown` (whether it landed is not known: its outcome is `unknown` or `applying`, or a `partial` without its applied parts recorded; it may have), `delete`, `publish_fee` (undoing a publish is not free on Etsy), `shipment_notified_buyer` (Etsy emailed the buyer), `images`, `files` (a digital file added or removed: the API keeps no copy of a file), `quantity` (never restored from a snapshot: oversell risk), `reactivates_listing` (it would put the listing back on sale), `target_not_listing` (shop changes; a shop setting's change is `delete` once Alura has recorded that it deleted the setting, else `not_supported`), `not_supported` (a field or part the API cannot restore yet), `etsy_updated_at_unrecorded` (the updated time of the listing on Etsy after the change was not recorded, so Alura's record of it is incomplete), `needs_production_partners` (`who_made: someone_else` cannot be restored without production partners, which a revert never restores), `field_unrecorded` (the change did not record a value it wrote), `translation_added` (the change created a translation, and Etsy has no translation delete), `variations_changed` (an inventory change that added or removed variants, or moved which property sets the price or SKU), `reference_deleted` (the section, shipping profile or return policy it would put back has been deleted since), `revertability_unknown` (on a write's own answer only, when Alura could not read its change record just then: GET /v1/workspace/changes/{id} answers it). Null when it can. New values may be added. type: - string - 'null' reverts: description: >- For a change with `source: revert`: the id of the change it undid (`chn_...`). Null otherwise, and on the `workspace.change` a revert answers with while Etsy is still answering (GET /v1/workspace/changes/{id} has it once the revert is recorded). type: - string - 'null' created_at: type: string description: When the change was made. as_of: type: string description: When this record was read. required: - object - id - shop_id - target - source - actor - write_id - outcome - fields - applied_fields - failed_fields - before_source - before_as_of - event - revertable - not_revertable_reason - reverts - created_at - as_of additionalProperties: false '400': $ref: '#/components/responses/WriteProblem400' '401': $ref: '#/components/responses/Problem401' '402': $ref: '#/components/responses/WriteProblem402' '403': $ref: '#/components/responses/WriteProblem403' '404': $ref: '#/components/responses/WriteProblem404' '405': $ref: '#/components/responses/Problem405' '409': $ref: '#/components/responses/WriteProblem409' '410': $ref: '#/components/responses/WriteProblem410' '422': $ref: '#/components/responses/WriteProblem422' '429': $ref: '#/components/responses/WriteProblem429' '500': $ref: '#/components/responses/WriteProblem500' '502': $ref: '#/components/responses/WriteProblem502' '503': $ref: '#/components/responses/WriteProblem503' x-codeSamples: - lang: bash label: cURL source: >- curl -X POST "https://api.alura.io/v1/workspace/orders/3456789015/shipments" \ -H "Authorization: Bearer $ALURA_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: 5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c" \ -d '{"carrier":"usps","tracking_code":"9400111899223197428490"}' - lang: typescript label: TypeScript source: >- const res = await fetch('https://api.alura.io/v1/workspace/orders/3456789015/shipments', { method: 'POST', headers: { Authorization: `Bearer ${process.env.ALURA_API_KEY}`, 'Content-Type': 'application/json', 'Idempotency-Key': '5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c', }, body: JSON.stringify({ "carrier": "usps", "tracking_code": "9400111899223197428490" }), }); console.log(await res.json()); - lang: python label: Python source: |- import json import os import urllib.request request = urllib.request.Request( "https://api.alura.io/v1/workspace/orders/3456789015/shipments", method="POST", data=json.dumps({ "carrier": "usps", "tracking_code": "9400111899223197428490" }).encode(), headers={ "Authorization": f"Bearer {os.environ['ALURA_API_KEY']}", "Content-Type": "application/json", "Idempotency-Key": "5f0c8e2a-4b1d-4c3e-9a7f-2b5d6e8f0a1c", }, ) with urllib.request.urlopen(request) as response: print(json.load(response)) components: headers: Request-Id: description: '`req_` + ULID; quote it when reporting a problem.' schema: type: string Alura-Credits-Cost: description: API credits this call cost. schema: type: integer Alura-Credits-Remaining: description: >- API credits left in the workspace's monthly allowance, counting calls still in flight. Absent when it cannot be read right now. schema: type: integer responses: WriteProblem400: description: >- Error. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. content: application/problem+json: schema: $ref: '#/components/schemas/WriteProblem' Problem401: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: 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 WriteProblem402: description: >- Error. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. content: application/problem+json: schema: $ref: '#/components/schemas/WriteProblem' WriteProblem403: description: >- Error. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. content: application/problem+json: schema: $ref: '#/components/schemas/WriteProblem' WriteProblem404: description: >- Error. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. content: application/problem+json: schema: $ref: '#/components/schemas/WriteProblem' Problem405: description: Error content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: 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 WriteProblem409: description: >- Error. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. content: application/problem+json: schema: $ref: '#/components/schemas/WriteProblem' WriteProblem410: description: >- Error. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. content: application/problem+json: schema: $ref: '#/components/schemas/WriteProblem' WriteProblem422: description: >- Error. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. content: application/problem+json: schema: $ref: '#/components/schemas/WriteProblem' WriteProblem429: description: >- Error. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. content: application/problem+json: schema: $ref: '#/components/schemas/WriteProblem' WriteProblem500: description: >- Error. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. content: application/problem+json: schema: $ref: '#/components/schemas/WriteProblem' WriteProblem502: description: >- Error. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. content: application/problem+json: schema: $ref: '#/components/schemas/WriteProblem' WriteProblem503: description: >- Error. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. content: application/problem+json: schema: $ref: '#/components/schemas/WriteProblem' schemas: WriteProblem: type: object description: >- RFC 9457 problem details. A refusal of a write Alura recorded carries its `change_id`, and by code `budget`, `reason`, `changed`, `missing`, `reconnect_url` or `missing_scopes`. properties: type: type: string format: uri title: type: string status: type: integer code: type: string description: A code from the error catalog; new codes may be added. x-extensible-enum: - invalid_request - unknown_parameter - invalid_cursor - cursor_window_exceeded - invalid_reference - id_type_mismatch - invalid_keyword - shop_id_required - listing_not_publishable - sales_window_not_covered - unauthorized - credits_exhausted - plan_required - insufficient_scope - workspace_required - workspace_locked - your_shop_unavailable - writes_suspended - browser_refused - role_required - impersonation_refused - recent_sign_in_required - etsy_scope_required - etsy_partner_required - not_found - not_collected - not_found_on_etsy - shop_opted_out - method_not_allowed - conflict - key_limit_reached - reconnect_required - settings_not_fetched - listing_busy - settings_busy - shop_create_busy - idempotency_partial_unverifiable - listing_has_variations - changed_since - change_not_revertable - listing_in_ab_test - activation_skipped - idempotency_processing - confirmation_required - test_shop_active_cap - write_outcome_unknown - unprocessable - listing_removed_on_etsy - endpoint_removed - rate_limited - throttled - daily_credit_cap_exceeded - credits_reserved - fetch_limit_reached - write_rate_limited - sync_cooldown - shop_write_budget_exhausted - internal_error - write_misconfigured - upstream_unavailable - credits_unavailable - service_unavailable - fetch_unavailable - create_lock_unavailable - writes_paused - etsy_capacity - upstream_timeout detail: type: string suggestion: type: string retryable: type: boolean request_id: type: string upgrade_url: type: string format: uri description: 'credits_exhausted and plan_required: where to upgrade the plan.' credits_needed: type: integer description: 'API credit refusals: what the call needed.' credits_remaining: type: integer description: >- API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded). resets_at: type: string format: date-time description: >- credits_exhausted and daily_credit_cap_exceeded: when the limit resets. change_id: type: string description: >- The recorded write this refusal answers, as its change (`chn_...`): read it (`GET /v1/workspace/changes/{id}`) before writing again. budget: type: string description: >- `shop_write_budget_exhausted`: which of the shop's Etsy write budgets ran out (`creates`, `activations`, `etsy_calls`). reason: description: >- Why, as an identifier: for `change_not_revertable`, why the revert was refused; null when none was named. type: - string - 'null' changed: anyOf: - type: array items: type: string - type: 'null' description: >- `changed_since`: the fields that changed on Etsy since the change; null when none was named. missing: anyOf: - type: array items: type: string - type: 'null' description: >- `listing_not_publishable`: what Etsy said the listing lacks to publish; null when it named none. reconnect_url: type: string description: >- `reconnect_required` and `etsy_scope_required`: where the shop is reconnected in Alura. missing_scopes: anyOf: - type: array items: type: string - type: 'null' description: >- `etsy_scope_required`: the Etsy scopes the shop's connection lacks; null when none was named. required: - type - title - status - code - detail - suggestion - retryable - request_id Problem: type: object description: RFC 9457 problem details. properties: type: type: string format: uri title: type: string status: type: integer code: type: string description: A code from the error catalog; new codes may be added. x-extensible-enum: - invalid_request - unknown_parameter - invalid_cursor - cursor_window_exceeded - invalid_reference - id_type_mismatch - invalid_keyword - shop_id_required - listing_not_publishable - sales_window_not_covered - unauthorized - credits_exhausted - plan_required - insufficient_scope - workspace_required - workspace_locked - your_shop_unavailable - writes_suspended - browser_refused - role_required - impersonation_refused - recent_sign_in_required - etsy_scope_required - etsy_partner_required - not_found - not_collected - not_found_on_etsy - shop_opted_out - method_not_allowed - conflict - key_limit_reached - reconnect_required - settings_not_fetched - listing_busy - settings_busy - shop_create_busy - idempotency_partial_unverifiable - listing_has_variations - changed_since - change_not_revertable - listing_in_ab_test - activation_skipped - idempotency_processing - confirmation_required - test_shop_active_cap - write_outcome_unknown - unprocessable - listing_removed_on_etsy - endpoint_removed - rate_limited - throttled - daily_credit_cap_exceeded - credits_reserved - fetch_limit_reached - write_rate_limited - sync_cooldown - shop_write_budget_exhausted - internal_error - write_misconfigured - upstream_unavailable - credits_unavailable - service_unavailable - fetch_unavailable - create_lock_unavailable - writes_paused - etsy_capacity - upstream_timeout detail: type: string suggestion: type: string retryable: type: boolean request_id: type: string upgrade_url: type: string format: uri description: 'credits_exhausted and plan_required: where to upgrade the plan.' credits_needed: type: integer description: 'API credit refusals: what the call needed.' credits_remaining: type: integer description: >- API credit refusals: what is left (of the month, or of the day for daily_credit_cap_exceeded). resets_at: type: string format: date-time description: >- credits_exhausted and daily_credit_cap_exceeded: when the limit resets. required: - type - title - status - code - detail - suggestion - retryable - request_id securitySchemes: apiKey: type: http scheme: bearer description: 'An API key: `Authorization: Bearer alura_sk_...`.' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.