Skip to main content
POST
Create or edit a catalog product

Authorizations

token
string
header
required

Body

application/json
name
string
required
Maximum string length: 256
id
string

Omit to create; provide to edit

description
string
Maximum string length: 4096
currency
string
Pattern: ^[A-Z]{3}$
Example:

"BRL"

price
string

Price in thousandths of the currency

Pattern: ^\d{1,18}$
Example:

"19990"

sale_price
string

Promotional price in thousandths of the currency

Pattern: ^\d{1,18}$
url
string<uri>
Maximum string length: 2048
retailer_id
string
Maximum string length: 256
is_hidden
boolean
default:false
image_urls
string<uri>[]

HTTPS media URLs returned by WhatsApp/Meta; arbitrary hosts are not accepted.

Required array length: 1 - 10 elements
video_urls
string<uri>[]

URLs of videos already associated with the product

Maximum array length: 10
image_data
string

JPEG or PNG image in base64 or Data URL, up to 16 MB.

image_url
string<uri>

Public HTTPS URL of a JPEG or PNG image, up to 16 MB

Maximum string length: 2048
compliance_category
string
Maximum string length: 128
compliance_info
object
width
integer
Required range: 1 <= x <= 1024
height
integer
Required range: 1 <= x <= 1024

Response

Product updated successfully

response
object
required