Skip to main content
POST
Recommend Marketplace Product Categories

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

application/json
productId
string
required

OmniCommerce product ID. The API key must belong to the organization that owns this product.

targets
object[]
required

Marketplace/country targets to recommend categories for.

organizationId
string

Optional for API-key requests; required for session-authenticated requests across multiple organizations.

query
string

Optional product-context query. When omitted, OmniCommerce derives it from product title, brand, SKU, highlights, tags, and description.

Required string length: 2 - 4000
limit
integer
default:5

Maximum category candidates per marketplace.

Required range: 1 <= x <= 20
includeAttributeAutoValues
boolean
default:true

When true, uses product context and category attribute metadata to suggest autofill values.

model
string

Optional model override for attribute autofill suggestions.

Maximum string length: 100

Response

Semantic category recommendations with attribute metadata and suggested attribute values.

ok
boolean
required
apiVersion
string
default:developer_v1
required
operationId
string
required
status
enum<string>
required
Available options:
completed
productId
string
required
success
boolean
required
marketplaces
object[]
required
warnings
string[]
recommendations
string[]