Skip to main content

Propose Product Types

POST 

/api/v2/product-types/propose

Queue a background run that proposes a product type for up to 500 products from their names, brands and the existing type tree. Products that already carry a type are skipped unless include_typed is true. Nothing is written — poll poll_url (Get Product Type Proposal Run) until status is completed, review the proposals, then send the accepted ones to Apply Product Type Proposals.

Required scope: products:write

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

Authentication: Requires Bearer token.

Fields:

  • product_ids (required, array of integers, 1–500)
  • include_typed (nullable, boolean, default false) — also propose for products that already have a type

Returns 422 when AI features are disabled or the configured provider has no API key. Rate limited per user — 429 when exceeded.

Requires permission: product_types.update

Request

Responses

Accepted

Response Headers
    Content-Type