Skip to main content

Prepare Ready-to-List Drafts

POST 

/api/v2/listing-drafts/prepare-ready

Seed a draft for every "ready to list" product on a sales channel — products that are data-complete and routed to a template by their product type, but do not yet have a draft or a live listing. Each product's own template (and its category and listing profile) is resolved and applied automatically, so no template needs to be chosen. Runs as one background job and returns its id; the seeded drafts move to ready (or draft if a field still needs attention) as the job progresses — read the drafts to follow it, then publish them with Bulk Publish Drafts.

Required scope: products:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Omit product_ids to prepare the channel's entire ready-to-list set (resolved server-side); pass it to prepare only a chosen subset. It is safe to re-run — a product that already has a draft is skipped.

Authentication: Requires Bearer token.

Fields:

  • sales_channel_id (required, integer) — the channel to prepare drafts on
  • product_ids (nullable, array of integers, max 5000) — a subset to prepare; omit for the whole ready-to-list set
  • channel_label (nullable, string, max 120) — a name for the job

Requires permission: listings.create

Request

Responses

Accepted

Response Headers
    Content-Type