Skip to main content
POST
Compare Product Market Prices

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Body

application/json
productIds
string<uuid>[]
required

OmniCommerce simple product or variant UUIDs. Deduplicated in first-requested order; maximum 50 input entries.

Required array length: 1 - 50 elements
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
organizationId
string
Required string length: 1 - 120
country
enum<string>
Available options:
Singapore,
Indonesia,
Malaysia,
Vietnam,
Thailand,
Philippines
gl
enum<string>

Optional shopping market restriction; overrides country. Omit to compare every listing market using its currency, or the catalog currency for unlisted products.

Available options:
sg,
id,
my,
vn,
th,
ph,
us,
hk,
tw
limit
integer
Required range: 1 <= x <= 15

Response

Batch accepted. jobId tracks durable progress; acceptance does not mean comparisons succeeded.

ok
boolean
required
apiVersion
string
required
operationId
string<uuid>
required
status
enum<string>
required
Available options:
accepted
jobId
string
required
data
object
required
warnings
string[]
required
recommendations
string[]
required