Skip to main content
POST
Generate synthetic commerce data

Authorizations

Authorization
string
header
required

Bearer token authentication. Use format: Bearer YOUR_API_KEY

Body

application/x-www-form-urlencoded
count
string

Number of commerce records to generate (1-100). Passed as string but must be numeric.

Pattern: ^[1-9]\d?$|^100$
Example:

"10"

locale
string

Locale for generated data (e.g., en, es, fr, de, pt_BR, zh_CN)

Example:

"en"

seed
string

Seed for deterministic generation. Same seed produces same results.

Example:

"12345"

method
enum<string>

Commerce generation method. Defaults to profile.

Available options:
profile,
department,
isbn,
price,
product,
productAdjective,
productDescription,
productMaterial,
productName
Example:

"profile"

priceMin
string

Minimum generated price when method=price or profile. Defaults to 1.

Pattern: ^-?(?:\d+|\d*\.\d+)$
Example:

"1"

priceMax
string

Maximum generated price when method=price or profile. Defaults to 1000.

Pattern: ^-?(?:\d+|\d*\.\d+)$
Example:

"1000"

priceDecimalPlaces
string

Number of decimal places for generated prices when method=price or profile. Defaults to 2.

Pattern: ^\d+$
Example:

"2"

priceSymbol
string

Optional currency symbol or prefix for generated prices. Maximum 8 characters.

Maximum string length: 8
Example:

"$"

isbnVariant
enum<string>

ISBN variant when method=isbn or profile. Defaults to 13.

Available options:
10,
13
Example:

"13"

isbnSeparator
string

Separator for generated ISBN values. Maximum 3 printable ASCII characters.

Maximum string length: 3
Example:

"-"

Response

Successfully generated commerce data

status
enum<string>
required
Available options:
success
data
object
required
performance
object