Skip to main content

List Etsy Inventory

GET 
/api/etsy/instances/:integrationInstance/inventory

Lists each mapped Etsy variation with the SKU.io quantity that should be on Etsy (sku_quantity) and the quantity last pushed to Etsy (sales_channel_quantity).

Not yet available to API tokens

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

Quantities: push_quantity is what the next push will send to Etsy — sku_quantity after the instance's minimum-stock threshold and the 999-per-variation cap (null when not yet computed).

Row status: synced (Etsy quantity equals push_quantity), variance (Etsy quantity differs from push_quantity), needs_recalc (SKU.io quantity is stale and will be recalculated), or not_managed (the instance's inventory.masterOfStock is not sku.io).

Pagination: page, per_page (default 10).

Filters:

  • filter[search] — Etsy SKU, title, or SKU.io product SKU.
  • filter[status] — Comma-separated statuses (also filter[status.is]).
  • filter[sku_quantity], filter[sales_channel_quantity] — Numeric, with operators: is, is_not, is_one_of, is_not_one_of, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_empty, is_not_empty.
  • filter[sales_channel_quantity_synced_at] — Date-time, with operators: is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, tomorrow, past_week, past_month, past_year, next_week, next_month, next_year.

Sort: sort — prefix with - for descending. Allowed: id, sku_quantity, sales_channel_quantity, sales_channel_quantity_synced_at, updated_at. Default: -id.

Authentication: Bearer token (Personal Access Token).

Request​

Responses​

OK

Response Headers
    Content-Type