Skip to main content
POST
Add Product

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
string<uuid>
required

Body

application/json
name
string
required
Required string length: 1 - 300
product_kind
enum<string>
default:other
Available options:
physical,
digital,
service,
subscription,
mobile_app,
marketplace,
other
canonical_url
string | null
Maximum string length: 2000
description
string | null
Maximum string length: 4000
categories
string[]
Maximum array length: 20
price_display
string | null
Maximum string length: 120
billing_period
string | null
Maximum string length: 50
cta_label
string | null
Maximum string length: 100
cta_url
string | null
Maximum string length: 2000
platforms
string[]
Maximum array length: 20
unique_selling_points
string[]
Maximum array length: 12
customer_awareness_levels
enum<string>[]
Maximum array length: 5
Available options:
L1,
L2,
L3,
L4,
L5
market_sophistication_levels
enum<string>[]
Maximum array length: 5
Available options:
L1,
L2,
L3,
L4,
L5
Maximum array length: 20
Maximum array length: 20
images
BrandProductImageInput · object[]
Maximum array length: 12

Response

Successful Response

id
string<uuid>
required
brand_id
string<uuid>
required
source
enum<string>
required
Available options:
scraped,
manual
product_kind
enum<string>
required
Available options:
physical,
digital,
service,
subscription,
mobile_app,
marketplace,
other
name
string
required
priority_score
number
required
catalog_status
enum<string>
required
Available options:
active,
inactive,
archived
created_at
string<date-time>
required
updated_at
string<date-time>
required
canonical_url
string | null
external_id
string | null
description
string | null
categories
string[]
price_amount
string | null
price_max_amount
string | null
currency
string | null
price_display
string | null
billing_period
string | null
cta_label
string | null
cta_url
string | null
platforms
string[]
unique_selling_points
string[]
customer_awareness_levels
enum<string>[]
Available options:
L1,
L2,
L3,
L4,
L5
market_sophistication_levels
enum<string>[]
Available options:
L1,
L2,
L3,
L4,
L5
market_sophistication_level
enum<string> | null
Available options:
L1,
L2,
L3,
L4,
L5
priority_reasons
string[]
badges
string[]
images
BrandProductImageResponse · object[]