Skip to main content
POST
/
generic
/
data
/
generate
/
commerce
Generate synthetic commerce data
curl --request POST \
  --url https://apix.spotzee.com/api/ext/generic/data/generate/commerce \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data count=10 \
  --data locale=en \
  --data seed=12345 \
  --data method=profile \
  --data priceMin=1 \
  --data priceMax=1000 \
  --data priceDecimalPlaces=2 \
  --data 'priceSymbol=$' \
  --data isbnVariant=13 \
  --data isbnSeparator=-
{
  "status": "success",
  "data": {
    "commerce": [
      {
        "method": "profile",
        "value": "Handcrafted Steel Chair",
        "productName": "Handcrafted Steel Chair",
        "product": "Chair",
        "productAdjective": "Handcrafted",
        "productMaterial": "Steel",
        "productDescription": "A durable chair designed for everyday testing scenarios.",
        "department": "Home",
        "price": "$154.55",
        "priceMin": 100,
        "priceMax": 200,
        "priceDecimalPlaces": 2,
        "priceSymbol": "$",
        "isbn": "978-1-60808-867-6",
        "isbnVariant": 13,
        "isbnSeparator": "-"
      }
    ],
    "generated": 1,
    "locale": "en",
    "seed": 12345,
    "method": "profile"
  },
  "performance": {
    "generationTime": 2,
    "itemsGenerated": 1,
    "locale": "en"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

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