Skip to main content

Update Etsy Integration Instance

PUT 
/api/etsy/instances/:integrationInstance

Partially updates an Etsy integration instance. Every field is optional — send only the fields you want to change. The nested tracking and inventory objects are merged into the stored values, so sending part of a block keeps the rest.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Request body:

  • name (string, optional, max 255) — Must be unique across all integration instances.
  • is_automatic_sync_enabled (boolean, optional) — Master switch for scheduled order import, listing import, and inventory push.
  • store_id (integer, optional, nullable) — SKU.io store for imported orders.
  • order_import_start_date (date, optional, nullable) — Earliest Etsy order date imported automatically.
  • import_delay_minutes (integer, optional, 0–1440) — Wait this many minutes after an Etsy order is paid before creating the SKU.io sales order.
  • auto_match_on_import (boolean, optional) — Map imported listings to SKU.io products with the same SKU.
  • include_draft_listings (boolean, optional) — Also import draft listings.
  • auto_create_products (boolean, optional) — Create SKU.io products for imported listings that have no SKU match.
  • tracking.send_bcc (boolean, optional) — Ask Etsy to BCC the seller on shipping notifications.
  • tracking.note_to_buyer (string, optional, nullable, max 500) — Note sent to the buyer with tracking.
  • inventory.masterOfStock (string, optional) — sku.io (SKU.io pushes quantities to Etsy) or Neither (no inventory push).
  • inventory.selectedWarehouses (array of integers, optional) — Warehouse IDs whose stock counts toward Etsy quantities.
  • inventory.inventoryModificationRules (object, optional, nullable) — Quantity adjustment rules:
    • maxRuleType (string, optional), maxRuleTypeValue (number, nullable)
    • minRuleType (string, optional), minRuleTypeValue (number, nullable)
    • subtractBufferStock (number, optional) — Units held back from Etsy.
  • inventory.minimumStockThreshold (integer, optional, min 0) — Report 0 to Etsy when available stock is at or below this.
  • inventory.maxQuantity (integer, optional, 1–999) — Cap on the quantity sent per variation (Etsy accepts at most 999).
  • inventory.autoReactivateSoldOut (boolean, optional) — Reactivate sold-out listings when stock returns.
  • inventory.autoReactivateExcludedListingIds (array of integers, optional) — Etsy listing IDs never auto-reactivated.

Authentication: Bearer token (Personal Access Token).

Request​

Responses​

OK

Response Headers
    Content-Type