Skip to main content
POST
Create Products

Authorizations

REFINE_API_KEY
string
header
required

API key for authentication

Path Parameters

orgId
string<uuid>
required

Organization ID (UUID)

catalogId
string<uuid>
required

Catalog ID (UUID)

Body

application/json
id
string
required

Product ID (SKU)

Example:

"sku001"

catalogId
string<uuid>
required

Catalog ID (must match path parameter)

imageUrl
string<uri>
required

Product image URL

Example:

"https://cdn.site.com/p/sku001.jpg"

descriptor
string
required

Product description (will be converted to lowercase)

Example:

"Red Linen Dress"

metadata
object

Additional product metadata

Example:

Response

Products created successfully

status
enum<string>
Available options:
success
Example:

"success"

message
string
Example:

"products uploaded"

count
integer

Number of products affected

Example:

2