Skip to main content

List Drafts

GET 

/api/v2/listing-drafts

Paginated listing drafts for the drafts list. Slim payload — the heavy fields[] array is only served by show/update/validate.

Required scope: products:read

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

Search covers draft ID, product name/SKU, and channel name (resolved through the channel's integration instance). Advanced filter_groups trees support nested AND/OR groups over the columns listed on the parameter.

Authentication: Requires Bearer token.

variant_context — describes whether this draft targets a single VARIANT of a matrix family rather than the family itself. When is_variant_child is true, parent_sku / parent_name identify the family and sibling_count is how many variants it has. Publishing a single child is permitted, but it creates a standalone channel item with no variant group — publish the parent to list the whole family as one grouped listing. null when the draft has no product.

Request

Responses

OK